Skip to content

Type definitions#

Index > ConfigService > Type definitions

Auto-generated documentation for ConfigService type annotations stubs module mypy-boto3-config.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AccountAggregationSourceTypeDef#

# AccountAggregationSourceTypeDef definition

class AccountAggregationSourceTypeDef(TypedDict):
    AccountIds: List[str],
    AllAwsRegions: NotRequired[bool],
    AwsRegions: NotRequired[List[str]],

AggregateConformancePackComplianceTypeDef#

# AggregateConformancePackComplianceTypeDef definition

class AggregateConformancePackComplianceTypeDef(TypedDict):
    ComplianceType: NotRequired[ConformancePackComplianceTypeType],  # (1)
    CompliantRuleCount: NotRequired[int],
    NonCompliantRuleCount: NotRequired[int],
    TotalRuleCount: NotRequired[int],
  1. See ConformancePackComplianceTypeType

AggregateConformancePackComplianceCountTypeDef#

# AggregateConformancePackComplianceCountTypeDef definition

class AggregateConformancePackComplianceCountTypeDef(TypedDict):
    CompliantConformancePackCount: NotRequired[int],
    NonCompliantConformancePackCount: NotRequired[int],

AggregateConformancePackComplianceFiltersTypeDef#

# AggregateConformancePackComplianceFiltersTypeDef definition

class AggregateConformancePackComplianceFiltersTypeDef(TypedDict):
    ConformancePackName: NotRequired[str],
    ComplianceType: NotRequired[ConformancePackComplianceTypeType],  # (1)
    AccountId: NotRequired[str],
    AwsRegion: NotRequired[str],
  1. See ConformancePackComplianceTypeType

AggregateConformancePackComplianceSummaryFiltersTypeDef#

# AggregateConformancePackComplianceSummaryFiltersTypeDef definition

class AggregateConformancePackComplianceSummaryFiltersTypeDef(TypedDict):
    AccountId: NotRequired[str],
    AwsRegion: NotRequired[str],

AggregateResourceIdentifierTypeDef#

# AggregateResourceIdentifierTypeDef definition

class AggregateResourceIdentifierTypeDef(TypedDict):
    SourceAccountId: str,
    SourceRegion: str,
    ResourceId: str,
    ResourceType: ResourceTypeType,  # (1)
    ResourceName: NotRequired[str],
  1. See ResourceTypeType

AggregatedSourceStatusTypeDef#

# AggregatedSourceStatusTypeDef definition

class AggregatedSourceStatusTypeDef(TypedDict):
    SourceId: NotRequired[str],
    SourceType: NotRequired[AggregatedSourceTypeType],  # (1)
    AwsRegion: NotRequired[str],
    LastUpdateStatus: NotRequired[AggregatedSourceStatusTypeType],  # (2)
    LastUpdateTime: NotRequired[datetime],
    LastErrorCode: NotRequired[str],
    LastErrorMessage: NotRequired[str],
  1. See AggregatedSourceTypeType
  2. See AggregatedSourceStatusTypeType

AggregationAuthorizationTypeDef#

# AggregationAuthorizationTypeDef definition

class AggregationAuthorizationTypeDef(TypedDict):
    AggregationAuthorizationArn: NotRequired[str],
    AuthorizedAccountId: NotRequired[str],
    AuthorizedAwsRegion: NotRequired[str],
    CreationTime: NotRequired[datetime],

BaseConfigurationItemTypeDef#

# BaseConfigurationItemTypeDef definition

class BaseConfigurationItemTypeDef(TypedDict):
    version: NotRequired[str],
    accountId: NotRequired[str],
    configurationItemCaptureTime: NotRequired[datetime],
    configurationItemStatus: NotRequired[ConfigurationItemStatusType],  # (1)
    configurationStateId: NotRequired[str],
    arn: NotRequired[str],
    resourceType: NotRequired[ResourceTypeType],  # (2)
    resourceId: NotRequired[str],
    resourceName: NotRequired[str],
    awsRegion: NotRequired[str],
    availabilityZone: NotRequired[str],
    resourceCreationTime: NotRequired[datetime],
    configuration: NotRequired[str],
    supplementaryConfiguration: NotRequired[Dict[str, str]],
  1. See ConfigurationItemStatusType
  2. See ResourceTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

ResourceKeyTypeDef#

# ResourceKeyTypeDef definition

class ResourceKeyTypeDef(TypedDict):
    resourceType: ResourceTypeType,  # (1)
    resourceId: str,
  1. See ResourceTypeType

ComplianceContributorCountTypeDef#

# ComplianceContributorCountTypeDef definition

class ComplianceContributorCountTypeDef(TypedDict):
    CappedCount: NotRequired[int],
    CapExceeded: NotRequired[bool],

ConfigExportDeliveryInfoTypeDef#

# ConfigExportDeliveryInfoTypeDef definition

class ConfigExportDeliveryInfoTypeDef(TypedDict):
    lastStatus: NotRequired[DeliveryStatusType],  # (1)
    lastErrorCode: NotRequired[str],
    lastErrorMessage: NotRequired[str],
    lastAttemptTime: NotRequired[datetime],
    lastSuccessfulTime: NotRequired[datetime],
    nextDeliveryTime: NotRequired[datetime],
  1. See DeliveryStatusType

ConfigRuleComplianceFiltersTypeDef#

# ConfigRuleComplianceFiltersTypeDef definition

class ConfigRuleComplianceFiltersTypeDef(TypedDict):
    ConfigRuleName: NotRequired[str],
    ComplianceType: NotRequired[ComplianceTypeType],  # (1)
    AccountId: NotRequired[str],
    AwsRegion: NotRequired[str],
  1. See ComplianceTypeType

ConfigRuleComplianceSummaryFiltersTypeDef#

# ConfigRuleComplianceSummaryFiltersTypeDef definition

class ConfigRuleComplianceSummaryFiltersTypeDef(TypedDict):
    AccountId: NotRequired[str],
    AwsRegion: NotRequired[str],

ConfigRuleEvaluationStatusTypeDef#

# ConfigRuleEvaluationStatusTypeDef definition

class ConfigRuleEvaluationStatusTypeDef(TypedDict):
    ConfigRuleName: NotRequired[str],
    ConfigRuleArn: NotRequired[str],
    ConfigRuleId: NotRequired[str],
    LastSuccessfulInvocationTime: NotRequired[datetime],
    LastFailedInvocationTime: NotRequired[datetime],
    LastSuccessfulEvaluationTime: NotRequired[datetime],
    LastFailedEvaluationTime: NotRequired[datetime],
    FirstActivatedTime: NotRequired[datetime],
    LastDeactivatedTime: NotRequired[datetime],
    LastErrorCode: NotRequired[str],
    LastErrorMessage: NotRequired[str],
    FirstEvaluationStarted: NotRequired[bool],
    LastDebugLogDeliveryStatus: NotRequired[str],
    LastDebugLogDeliveryStatusReason: NotRequired[str],
    LastDebugLogDeliveryTime: NotRequired[datetime],

EvaluationModeConfigurationTypeDef#

# EvaluationModeConfigurationTypeDef definition

class EvaluationModeConfigurationTypeDef(TypedDict):
    Mode: NotRequired[EvaluationModeType],  # (1)
  1. See EvaluationModeType

ScopeTypeDef#

# ScopeTypeDef definition

class ScopeTypeDef(TypedDict):
    ComplianceResourceTypes: NotRequired[List[str]],
    TagKey: NotRequired[str],
    TagValue: NotRequired[str],
    ComplianceResourceId: NotRequired[str],

ConfigSnapshotDeliveryPropertiesTypeDef#

# ConfigSnapshotDeliveryPropertiesTypeDef definition

class ConfigSnapshotDeliveryPropertiesTypeDef(TypedDict):
    deliveryFrequency: NotRequired[MaximumExecutionFrequencyType],  # (1)
  1. See MaximumExecutionFrequencyType

ConfigStreamDeliveryInfoTypeDef#

# ConfigStreamDeliveryInfoTypeDef definition

class ConfigStreamDeliveryInfoTypeDef(TypedDict):
    lastStatus: NotRequired[DeliveryStatusType],  # (1)
    lastErrorCode: NotRequired[str],
    lastErrorMessage: NotRequired[str],
    lastStatusChangeTime: NotRequired[datetime],
  1. See DeliveryStatusType

OrganizationAggregationSourceTypeDef#

# OrganizationAggregationSourceTypeDef definition

class OrganizationAggregationSourceTypeDef(TypedDict):
    RoleArn: str,
    AwsRegions: NotRequired[List[str]],
    AllAwsRegions: NotRequired[bool],

RelationshipTypeDef#

# RelationshipTypeDef definition

class RelationshipTypeDef(TypedDict):
    resourceType: NotRequired[ResourceTypeType],  # (1)
    resourceId: NotRequired[str],
    resourceName: NotRequired[str],
    relationshipName: NotRequired[str],
  1. See ResourceTypeType

ConfigurationRecorderStatusTypeDef#

# ConfigurationRecorderStatusTypeDef definition

class ConfigurationRecorderStatusTypeDef(TypedDict):
    name: NotRequired[str],
    lastStartTime: NotRequired[datetime],
    lastStopTime: NotRequired[datetime],
    recording: NotRequired[bool],
    lastStatus: NotRequired[RecorderStatusType],  # (1)
    lastErrorCode: NotRequired[str],
    lastErrorMessage: NotRequired[str],
    lastStatusChangeTime: NotRequired[datetime],
  1. See RecorderStatusType

ConformancePackComplianceFiltersTypeDef#

# ConformancePackComplianceFiltersTypeDef definition

class ConformancePackComplianceFiltersTypeDef(TypedDict):
    ConfigRuleNames: NotRequired[Sequence[str]],
    ComplianceType: NotRequired[ConformancePackComplianceTypeType],  # (1)
  1. See ConformancePackComplianceTypeType

ConformancePackComplianceScoreTypeDef#

# ConformancePackComplianceScoreTypeDef definition

class ConformancePackComplianceScoreTypeDef(TypedDict):
    Score: NotRequired[str],
    ConformancePackName: NotRequired[str],
    LastUpdatedTime: NotRequired[datetime],

ConformancePackComplianceScoresFiltersTypeDef#

# ConformancePackComplianceScoresFiltersTypeDef definition

class ConformancePackComplianceScoresFiltersTypeDef(TypedDict):
    ConformancePackNames: Sequence[str],

ConformancePackComplianceSummaryTypeDef#

# ConformancePackComplianceSummaryTypeDef definition

class ConformancePackComplianceSummaryTypeDef(TypedDict):
    ConformancePackName: str,
    ConformancePackComplianceStatus: ConformancePackComplianceTypeType,  # (1)
  1. See ConformancePackComplianceTypeType

ConformancePackInputParameterTypeDef#

# ConformancePackInputParameterTypeDef definition

class ConformancePackInputParameterTypeDef(TypedDict):
    ParameterName: str,
    ParameterValue: str,

TemplateSSMDocumentDetailsTypeDef#

# TemplateSSMDocumentDetailsTypeDef definition

class TemplateSSMDocumentDetailsTypeDef(TypedDict):
    DocumentName: str,
    DocumentVersion: NotRequired[str],

ConformancePackEvaluationFiltersTypeDef#

# ConformancePackEvaluationFiltersTypeDef definition

class ConformancePackEvaluationFiltersTypeDef(TypedDict):
    ConfigRuleNames: NotRequired[Sequence[str]],
    ComplianceType: NotRequired[ConformancePackComplianceTypeType],  # (1)
    ResourceType: NotRequired[str],
    ResourceIds: NotRequired[Sequence[str]],
  1. See ConformancePackComplianceTypeType

ConformancePackRuleComplianceTypeDef#

# ConformancePackRuleComplianceTypeDef definition

class ConformancePackRuleComplianceTypeDef(TypedDict):
    ConfigRuleName: NotRequired[str],
    ComplianceType: NotRequired[ConformancePackComplianceTypeType],  # (1)
    Controls: NotRequired[List[str]],
  1. See ConformancePackComplianceTypeType

ConformancePackStatusDetailTypeDef#

# ConformancePackStatusDetailTypeDef definition

class ConformancePackStatusDetailTypeDef(TypedDict):
    ConformancePackName: str,
    ConformancePackId: str,
    ConformancePackArn: str,
    ConformancePackState: ConformancePackStateType,  # (1)
    StackArn: str,
    LastUpdateRequestedTime: datetime,
    ConformancePackStatusReason: NotRequired[str],
    LastUpdateCompletedTime: NotRequired[datetime],
  1. See ConformancePackStateType

CustomPolicyDetailsTypeDef#

# CustomPolicyDetailsTypeDef definition

class CustomPolicyDetailsTypeDef(TypedDict):
    PolicyRuntime: str,
    PolicyText: str,
    EnableDebugLogDelivery: NotRequired[bool],

DeleteAggregationAuthorizationRequestRequestTypeDef#

# DeleteAggregationAuthorizationRequestRequestTypeDef definition

class DeleteAggregationAuthorizationRequestRequestTypeDef(TypedDict):
    AuthorizedAccountId: str,
    AuthorizedAwsRegion: str,

DeleteConfigRuleRequestRequestTypeDef#

# DeleteConfigRuleRequestRequestTypeDef definition

class DeleteConfigRuleRequestRequestTypeDef(TypedDict):
    ConfigRuleName: str,

DeleteConfigurationAggregatorRequestRequestTypeDef#

# DeleteConfigurationAggregatorRequestRequestTypeDef definition

class DeleteConfigurationAggregatorRequestRequestTypeDef(TypedDict):
    ConfigurationAggregatorName: str,

DeleteConfigurationRecorderRequestRequestTypeDef#

# DeleteConfigurationRecorderRequestRequestTypeDef definition

class DeleteConfigurationRecorderRequestRequestTypeDef(TypedDict):
    ConfigurationRecorderName: str,

DeleteConformancePackRequestRequestTypeDef#

# DeleteConformancePackRequestRequestTypeDef definition

class DeleteConformancePackRequestRequestTypeDef(TypedDict):
    ConformancePackName: str,

DeleteDeliveryChannelRequestRequestTypeDef#

# DeleteDeliveryChannelRequestRequestTypeDef definition

class DeleteDeliveryChannelRequestRequestTypeDef(TypedDict):
    DeliveryChannelName: str,

DeleteEvaluationResultsRequestRequestTypeDef#

# DeleteEvaluationResultsRequestRequestTypeDef definition

class DeleteEvaluationResultsRequestRequestTypeDef(TypedDict):
    ConfigRuleName: str,

DeleteOrganizationConfigRuleRequestRequestTypeDef#

# DeleteOrganizationConfigRuleRequestRequestTypeDef definition

class DeleteOrganizationConfigRuleRequestRequestTypeDef(TypedDict):
    OrganizationConfigRuleName: str,

DeleteOrganizationConformancePackRequestRequestTypeDef#

# DeleteOrganizationConformancePackRequestRequestTypeDef definition

class DeleteOrganizationConformancePackRequestRequestTypeDef(TypedDict):
    OrganizationConformancePackName: str,

DeletePendingAggregationRequestRequestRequestTypeDef#

# DeletePendingAggregationRequestRequestRequestTypeDef definition

class DeletePendingAggregationRequestRequestRequestTypeDef(TypedDict):
    RequesterAccountId: str,
    RequesterAwsRegion: str,

DeleteRemediationConfigurationRequestRequestTypeDef#

# DeleteRemediationConfigurationRequestRequestTypeDef definition

class DeleteRemediationConfigurationRequestRequestTypeDef(TypedDict):
    ConfigRuleName: str,
    ResourceType: NotRequired[str],

RemediationExceptionResourceKeyTypeDef#

# RemediationExceptionResourceKeyTypeDef definition

class RemediationExceptionResourceKeyTypeDef(TypedDict):
    ResourceType: NotRequired[str],
    ResourceId: NotRequired[str],

DeleteResourceConfigRequestRequestTypeDef#

# DeleteResourceConfigRequestRequestTypeDef definition

class DeleteResourceConfigRequestRequestTypeDef(TypedDict):
    ResourceType: str,
    ResourceId: str,

DeleteRetentionConfigurationRequestRequestTypeDef#

# DeleteRetentionConfigurationRequestRequestTypeDef definition

class DeleteRetentionConfigurationRequestRequestTypeDef(TypedDict):
    RetentionConfigurationName: str,

DeleteStoredQueryRequestRequestTypeDef#

# DeleteStoredQueryRequestRequestTypeDef definition

class DeleteStoredQueryRequestRequestTypeDef(TypedDict):
    QueryName: str,

DeliverConfigSnapshotRequestRequestTypeDef#

# DeliverConfigSnapshotRequestRequestTypeDef definition

class DeliverConfigSnapshotRequestRequestTypeDef(TypedDict):
    deliveryChannelName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeAggregationAuthorizationsRequestRequestTypeDef#

# DescribeAggregationAuthorizationsRequestRequestTypeDef definition

class DescribeAggregationAuthorizationsRequestRequestTypeDef(TypedDict):
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeComplianceByConfigRuleRequestRequestTypeDef#

# DescribeComplianceByConfigRuleRequestRequestTypeDef definition

class DescribeComplianceByConfigRuleRequestRequestTypeDef(TypedDict):
    ConfigRuleNames: NotRequired[Sequence[str]],
    ComplianceTypes: NotRequired[Sequence[ComplianceTypeType]],  # (1)
    NextToken: NotRequired[str],
  1. See ComplianceTypeType

DescribeComplianceByResourceRequestRequestTypeDef#

# DescribeComplianceByResourceRequestRequestTypeDef definition

class DescribeComplianceByResourceRequestRequestTypeDef(TypedDict):
    ResourceType: NotRequired[str],
    ResourceId: NotRequired[str],
    ComplianceTypes: NotRequired[Sequence[ComplianceTypeType]],  # (1)
    Limit: NotRequired[int],
    NextToken: NotRequired[str],
  1. See ComplianceTypeType

DescribeConfigRuleEvaluationStatusRequestRequestTypeDef#

# DescribeConfigRuleEvaluationStatusRequestRequestTypeDef definition

class DescribeConfigRuleEvaluationStatusRequestRequestTypeDef(TypedDict):
    ConfigRuleNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

DescribeConfigRulesFiltersTypeDef#

# DescribeConfigRulesFiltersTypeDef definition

class DescribeConfigRulesFiltersTypeDef(TypedDict):
    EvaluationMode: NotRequired[EvaluationModeType],  # (1)
  1. See EvaluationModeType

DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef#

# DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef definition

class DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef(TypedDict):
    ConfigurationAggregatorName: str,
    UpdateStatus: NotRequired[Sequence[AggregatedSourceStatusTypeType]],  # (1)
    NextToken: NotRequired[str],
    Limit: NotRequired[int],
  1. See AggregatedSourceStatusTypeType

DescribeConfigurationAggregatorsRequestRequestTypeDef#

# DescribeConfigurationAggregatorsRequestRequestTypeDef definition

class DescribeConfigurationAggregatorsRequestRequestTypeDef(TypedDict):
    ConfigurationAggregatorNames: NotRequired[Sequence[str]],
    NextToken: NotRequired[str],
    Limit: NotRequired[int],

DescribeConfigurationRecorderStatusRequestRequestTypeDef#

# DescribeConfigurationRecorderStatusRequestRequestTypeDef definition

class DescribeConfigurationRecorderStatusRequestRequestTypeDef(TypedDict):
    ConfigurationRecorderNames: NotRequired[Sequence[str]],

DescribeConfigurationRecordersRequestRequestTypeDef#

# DescribeConfigurationRecordersRequestRequestTypeDef definition

class DescribeConfigurationRecordersRequestRequestTypeDef(TypedDict):
    ConfigurationRecorderNames: NotRequired[Sequence[str]],

DescribeConformancePackStatusRequestRequestTypeDef#

# DescribeConformancePackStatusRequestRequestTypeDef definition

class DescribeConformancePackStatusRequestRequestTypeDef(TypedDict):
    ConformancePackNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeConformancePacksRequestRequestTypeDef#

# DescribeConformancePacksRequestRequestTypeDef definition

class DescribeConformancePacksRequestRequestTypeDef(TypedDict):
    ConformancePackNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeDeliveryChannelStatusRequestRequestTypeDef#

# DescribeDeliveryChannelStatusRequestRequestTypeDef definition

class DescribeDeliveryChannelStatusRequestRequestTypeDef(TypedDict):
    DeliveryChannelNames: NotRequired[Sequence[str]],

DescribeDeliveryChannelsRequestRequestTypeDef#

# DescribeDeliveryChannelsRequestRequestTypeDef definition

class DescribeDeliveryChannelsRequestRequestTypeDef(TypedDict):
    DeliveryChannelNames: NotRequired[Sequence[str]],

DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef#

# DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef definition

class DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef(TypedDict):
    OrganizationConfigRuleNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

OrganizationConfigRuleStatusTypeDef#

# OrganizationConfigRuleStatusTypeDef definition

class OrganizationConfigRuleStatusTypeDef(TypedDict):
    OrganizationConfigRuleName: str,
    OrganizationRuleStatus: OrganizationRuleStatusType,  # (1)
    ErrorCode: NotRequired[str],
    ErrorMessage: NotRequired[str],
    LastUpdateTime: NotRequired[datetime],
  1. See OrganizationRuleStatusType

DescribeOrganizationConfigRulesRequestRequestTypeDef#

# DescribeOrganizationConfigRulesRequestRequestTypeDef definition

class DescribeOrganizationConfigRulesRequestRequestTypeDef(TypedDict):
    OrganizationConfigRuleNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

DescribeOrganizationConformancePackStatusesRequestRequestTypeDef#

# DescribeOrganizationConformancePackStatusesRequestRequestTypeDef definition

class DescribeOrganizationConformancePackStatusesRequestRequestTypeDef(TypedDict):
    OrganizationConformancePackNames: NotRequired[Sequence[str]],
    Limit: NotRequired[int],
    NextToken: NotRequired[str],

OrganizationConformancePackStatusTypeDef#

# OrganizationConformancePackStatusTypeDef definition

class OrganizationConformancePackStatusTypeDef(TypedDict):
    OrganizationConformancePackName: str,