ConfigService module#
Index > ConfigService
Auto-generated documentation for ConfigService type annotations stubs module mypy-boto3-config.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and ConfigService
.
From PyPI with pip#
Install boto3-stubs
for ConfigService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[config]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[config]'
# standalone installation
python -m pip install mypy-boto3-config
How to uninstall#
python -m pip uninstall -y mypy-boto3-config
Usage#
Code samples can be found in Examples.
ConfigServiceClient#
Type annotations and code completion for boto3.client("config")
as ConfigServiceClient
boto3 documentation
# ConfigServiceClient usage example
from boto3.session import Session
from mypy_boto3_config.client import ConfigServiceClient
def get_client() -> ConfigServiceClient:
return Session().client("config")
Paginators#
Type annotations and code completion for paginators
from boto3.client("config").get_paginator("...")
.
# DescribeAggregateComplianceByConfigRulesPaginator usage example
from boto3.session import Session
from mypy_boto3_config.paginator import DescribeAggregateComplianceByConfigRulesPaginator
def get_describe_aggregate_compliance_by_config_rules_paginator() -> DescribeAggregateComplianceByConfigRulesPaginator:
return Session().client("config").get_paginator("describe_aggregate_compliance_by_config_rules"))
- DescribeAggregateComplianceByConfigRulesPaginator
- DescribeAggregateComplianceByConformancePacksPaginator
- DescribeAggregationAuthorizationsPaginator
- DescribeComplianceByConfigRulePaginator
- DescribeComplianceByResourcePaginator
- DescribeConfigRuleEvaluationStatusPaginator
- DescribeConfigRulesPaginator
- DescribeConfigurationAggregatorSourcesStatusPaginator
- DescribeConfigurationAggregatorsPaginator
- DescribeConformancePackStatusPaginator
- DescribeConformancePacksPaginator
- DescribeOrganizationConfigRuleStatusesPaginator
- DescribeOrganizationConfigRulesPaginator
- DescribeOrganizationConformancePackStatusesPaginator
- DescribeOrganizationConformancePacksPaginator
- DescribePendingAggregationRequestsPaginator
- DescribeRemediationExecutionStatusPaginator
- DescribeRetentionConfigurationsPaginator
- GetAggregateComplianceDetailsByConfigRulePaginator
- GetComplianceDetailsByConfigRulePaginator
- GetComplianceDetailsByResourcePaginator
- GetConformancePackComplianceSummaryPaginator
- GetOrganizationConfigRuleDetailedStatusPaginator
- GetOrganizationConformancePackDetailedStatusPaginator
- GetResourceConfigHistoryPaginator
- ListAggregateDiscoveredResourcesPaginator
- ListDiscoveredResourcesPaginator
- ListResourceEvaluationsPaginator
- ListTagsForResourcePaginator
- SelectAggregateResourceConfigPaginator
- SelectResourceConfigPaginator
Literals#
Type annotations for literals used in methods and schemas.
# AggregateConformancePackComplianceSummaryGroupKeyType usage example
from mypy_boto3_config.literals import AggregateConformancePackComplianceSummaryGroupKeyType
def get_value() -> AggregateConformancePackComplianceSummaryGroupKeyType:
return "ACCOUNT_ID"
- AggregateConformancePackComplianceSummaryGroupKeyType
- AggregatedSourceStatusTypeType
- AggregatedSourceTypeType
- ChronologicalOrderType
- ComplianceTypeType
- ConfigRuleComplianceSummaryGroupKeyType
- ConfigRuleStateType
- ConfigurationItemStatusType
- ConformancePackComplianceTypeType
- ConformancePackStateType
- DeliveryStatusType
- DescribeAggregateComplianceByConfigRulesPaginatorName
- DescribeAggregateComplianceByConformancePacksPaginatorName
- DescribeAggregationAuthorizationsPaginatorName
- DescribeComplianceByConfigRulePaginatorName
- DescribeComplianceByResourcePaginatorName
- DescribeConfigRuleEvaluationStatusPaginatorName
- DescribeConfigRulesPaginatorName
- DescribeConfigurationAggregatorSourcesStatusPaginatorName
- DescribeConfigurationAggregatorsPaginatorName
- DescribeConformancePackStatusPaginatorName
- DescribeConformancePacksPaginatorName
- DescribeOrganizationConfigRuleStatusesPaginatorName
- DescribeOrganizationConfigRulesPaginatorName
- DescribeOrganizationConformancePackStatusesPaginatorName
- DescribeOrganizationConformancePacksPaginatorName
- DescribePendingAggregationRequestsPaginatorName
- DescribeRemediationExecutionStatusPaginatorName
- DescribeRetentionConfigurationsPaginatorName
- EvaluationModeType
- EventSourceType
- GetAggregateComplianceDetailsByConfigRulePaginatorName
- GetComplianceDetailsByConfigRulePaginatorName
- GetComplianceDetailsByResourcePaginatorName
- GetConformancePackComplianceSummaryPaginatorName
- GetOrganizationConfigRuleDetailedStatusPaginatorName
- GetOrganizationConformancePackDetailedStatusPaginatorName
- GetResourceConfigHistoryPaginatorName
- ListAggregateDiscoveredResourcesPaginatorName
- ListDiscoveredResourcesPaginatorName
- ListResourceEvaluationsPaginatorName
- ListTagsForResourcePaginatorName
- MaximumExecutionFrequencyType
- MemberAccountRuleStatusType
- MessageTypeType
- OrganizationConfigRuleTriggerTypeNoSNType
- OrganizationConfigRuleTriggerTypeType
- OrganizationResourceDetailedStatusType
- OrganizationResourceStatusType
- OrganizationRuleStatusType
- OwnerType
- RecorderStatusType
- RecordingStrategyTypeType
- RemediationExecutionStateType
- RemediationExecutionStepStateType
- RemediationTargetTypeType
- ResourceConfigurationSchemaTypeType
- ResourceCountGroupKeyType
- ResourceEvaluationStatusType
- ResourceTypeType
- ResourceValueTypeType
- SelectAggregateResourceConfigPaginatorName
- SelectResourceConfigPaginatorName
- SortByType
- SortOrderType
- ConfigServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Typed dictionaries#
Type annotations for typed dictionaries used in methods and schema.
# AccountAggregationSourceTypeDef usage example
from mypy_boto3_config.type_defs import AccountAggregationSourceTypeDef
def get_value() -> AccountAggregationSourceTypeDef:
return {
"AccountIds": ...,
}
- AccountAggregationSourceTypeDef
- AggregateConformancePackComplianceTypeDef
- AggregateConformancePackComplianceCountTypeDef
- AggregateConformancePackComplianceFiltersTypeDef
- AggregateConformancePackComplianceSummaryFiltersTypeDef
- AggregateResourceIdentifierTypeDef
- AggregatedSourceStatusTypeDef
- AggregationAuthorizationTypeDef
- BaseConfigurationItemTypeDef
- ResourceKeyTypeDef
- ComplianceContributorCountTypeDef
- ConfigExportDeliveryInfoTypeDef
- ConfigRuleComplianceFiltersTypeDef
- ConfigRuleComplianceSummaryFiltersTypeDef
- ConfigRuleEvaluationStatusTypeDef
- EvaluationModeConfigurationTypeDef
- ScopeTypeDef
- ConfigSnapshotDeliveryPropertiesTypeDef
- ConfigStreamDeliveryInfoTypeDef
- OrganizationAggregationSourceTypeDef
- RelationshipTypeDef
- ConfigurationRecorderStatusTypeDef
- ConformancePackComplianceFiltersTypeDef
- ConformancePackComplianceScoreTypeDef
- ConformancePackComplianceScoresFiltersTypeDef
- ConformancePackComplianceSummaryTypeDef
- ConformancePackInputParameterTypeDef
- TemplateSSMDocumentDetailsTypeDef
- ConformancePackEvaluationFiltersTypeDef
- ConformancePackRuleComplianceTypeDef
- ConformancePackStatusDetailTypeDef
- CustomPolicyDetailsTypeDef
- DeleteAggregationAuthorizationRequestRequestTypeDef
- DeleteConfigRuleRequestRequestTypeDef
- DeleteConfigurationAggregatorRequestRequestTypeDef
- DeleteConfigurationRecorderRequestRequestTypeDef
- DeleteConformancePackRequestRequestTypeDef
- DeleteDeliveryChannelRequestRequestTypeDef
- DeleteEvaluationResultsRequestRequestTypeDef
- DeleteOrganizationConfigRuleRequestRequestTypeDef
- DeleteOrganizationConformancePackRequestRequestTypeDef
- DeletePendingAggregationRequestRequestRequestTypeDef
- DeleteRemediationConfigurationRequestRequestTypeDef
- RemediationExceptionResourceKeyTypeDef
- DeleteResourceConfigRequestRequestTypeDef
- DeleteRetentionConfigurationRequestRequestTypeDef
- DeleteStoredQueryRequestRequestTypeDef
- DeliverConfigSnapshotRequestRequestTypeDef
- DeliverConfigSnapshotResponseTypeDef
- DescribeAggregationAuthorizationsRequestDescribeAggregationAuthorizationsPaginateTypeDef
- DescribeAggregationAuthorizationsRequestRequestTypeDef
- DescribeComplianceByConfigRuleRequestDescribeComplianceByConfigRulePaginateTypeDef
- DescribeComplianceByConfigRuleRequestRequestTypeDef
- DescribeComplianceByResourceRequestDescribeComplianceByResourcePaginateTypeDef
- DescribeComplianceByResourceRequestRequestTypeDef
- DescribeConfigRuleEvaluationStatusRequestDescribeConfigRuleEvaluationStatusPaginateTypeDef
- DescribeConfigRuleEvaluationStatusRequestRequestTypeDef
- DescribeConfigRulesFiltersTypeDef
- DescribeConfigurationAggregatorSourcesStatusRequestDescribeConfigurationAggregatorSourcesStatusPaginateTypeDef
- DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef
- DescribeConfigurationAggregatorsRequestDescribeConfigurationAggregatorsPaginateTypeDef
- DescribeConfigurationAggregatorsRequestRequestTypeDef
- DescribeConfigurationRecorderStatusRequestRequestTypeDef
- DescribeConfigurationRecordersRequestRequestTypeDef
- DescribeConformancePackStatusRequestDescribeConformancePackStatusPaginateTypeDef
- DescribeConformancePackStatusRequestRequestTypeDef
- DescribeConformancePacksRequestDescribeConformancePacksPaginateTypeDef
- DescribeConformancePacksRequestRequestTypeDef
- DescribeDeliveryChannelStatusRequestRequestTypeDef
- DescribeDeliveryChannelsRequestRequestTypeDef
- DescribeOrganizationConfigRuleStatusesRequestDescribeOrganizationConfigRuleStatusesPaginateTypeDef
- DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef
- OrganizationConfigRuleStatusTypeDef
- DescribeOrganizationConfigRulesRequestDescribeOrganizationConfigRulesPaginateTypeDef
- DescribeOrganizationConfigRulesRequestRequestTypeDef
- DescribeOrganizationConformancePackStatusesRequestDescribeOrganizationConformancePackStatusesPaginateTypeDef
- DescribeOrganizationConformancePackStatusesRequestRequestTypeDef
- OrganizationConformancePackStatusTypeDef
- DescribeOrganizationConformancePacksRequestDescribeOrganizationConformancePacksPaginateTypeDef
- DescribeOrganizationConformancePacksRequestRequestTypeDef
- DescribePendingAggregationRequestsRequestDescribePendingAggregationRequestsPaginateTypeDef
- DescribePendingAggregationRequestsRequestRequestTypeDef
- PendingAggregationRequestTypeDef
- DescribeRemediationConfigurationsRequestRequestTypeDef
- RemediationExceptionTypeDef
- DescribeRetentionConfigurationsRequestDescribeRetentionConfigurationsPaginateTypeDef
- DescribeRetentionConfigurationsRequestRequestTypeDef
- RetentionConfigurationTypeDef
- EmptyResponseMetadataTypeDef
- EvaluationContextTypeDef
- EvaluationResultQualifierTypeDef
- EvaluationStatusTypeDef
- EvaluationTypeDef
- ExclusionByResourceTypesTypeDef
- SsmControlsTypeDef
- ExternalEvaluationTypeDef
- FieldInfoTypeDef
- GetAggregateComplianceDetailsByConfigRuleRequestGetAggregateComplianceDetailsByConfigRulePaginateTypeDef
- GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef
- ResourceCountFiltersTypeDef
- GroupedResourceCountTypeDef
- GetComplianceDetailsByConfigRuleRequestGetComplianceDetailsByConfigRulePaginateTypeDef
- GetComplianceDetailsByConfigRuleRequestRequestTypeDef
- GetComplianceDetailsByResourceRequestGetComplianceDetailsByResourcePaginateTypeDef
- GetComplianceDetailsByResourceRequestRequestTypeDef
- GetComplianceSummaryByResourceTypeRequestRequestTypeDef
- GetConformancePackComplianceSummaryRequestGetConformancePackComplianceSummaryPaginateTypeDef
- GetConformancePackComplianceSummaryRequestRequestTypeDef
- GetCustomRulePolicyRequestRequestTypeDef
- GetCustomRulePolicyResponseTypeDef
- GetDiscoveredResourceCountsRequestRequestTypeDef
- ResourceCountTypeDef
- StatusDetailFiltersTypeDef
- MemberAccountStatusTypeDef
- OrganizationResourceDetailedStatusFiltersTypeDef
- OrganizationConformancePackDetailedStatusTypeDef
- GetOrganizationCustomRulePolicyRequestRequestTypeDef
- GetOrganizationCustomRulePolicyResponseTypeDef
- GetResourceConfigHistoryRequestGetResourceConfigHistoryPaginateTypeDef
- GetResourceConfigHistoryRequestRequestTypeDef
- GetResourceEvaluationSummaryRequestRequestTypeDef
- ResourceDetailsTypeDef
- GetStoredQueryRequestRequestTypeDef
- StoredQueryTypeDef
- ResourceFiltersTypeDef
- ListDiscoveredResourcesRequestListDiscoveredResourcesPaginateTypeDef
- ListDiscoveredResourcesRequestRequestTypeDef
- ResourceIdentifierTypeDef
- ResourceEvaluationTypeDef
- ListStoredQueriesRequestRequestTypeDef
- StoredQueryMetadataTypeDef
- ListTagsForResourceRequestListTagsForResourcePaginateTypeDef
- ListTagsForResourceRequestRequestTypeDef
- TagTypeDef
- OrganizationCustomPolicyRuleMetadataNoPolicyTypeDef
- OrganizationCustomRuleMetadataTypeDef
- OrganizationManagedRuleMetadataTypeDef
- OrganizationCustomPolicyRuleMetadataTypeDef
- PaginatorConfigTypeDef
- PutConformancePackResponseTypeDef
- PutOrganizationConfigRuleResponseTypeDef
- PutOrganizationConformancePackResponseTypeDef
- PutResourceConfigRequestRequestTypeDef
- PutRetentionConfigurationRequestRequestTypeDef
- PutStoredQueryResponseTypeDef
- RecordingStrategyTypeDef
- RemediationExecutionStepTypeDef
- ResourceValueTypeDef
- StaticValueTypeDef
- TimeWindowTypeDef
- ResponseMetadataTypeDef
- SelectAggregateResourceConfigRequestRequestTypeDef
- SelectAggregateResourceConfigRequestSelectAggregateResourceConfigPaginateTypeDef
- SelectResourceConfigRequestRequestTypeDef
- SelectResourceConfigRequestSelectResourceConfigPaginateTypeDef
- SourceDetailTypeDef
- StartConfigRulesEvaluationRequestRequestTypeDef
- StartConfigurationRecorderRequestRequestTypeDef
- StartResourceEvaluationResponseTypeDef
- StopConfigurationRecorderRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- AggregateComplianceByConformancePackTypeDef
- AggregateConformancePackComplianceSummaryTypeDef
- DescribeAggregateComplianceByConformancePacksRequestDescribeAggregateComplianceByConformancePacksPaginateTypeDef
- DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef
- GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef
- BatchGetAggregateResourceConfigRequestRequestTypeDef
- GetAggregateResourceConfigRequestRequestTypeDef
- ListAggregateDiscoveredResourcesResponseTypeDef
- DescribeConfigurationAggregatorSourcesStatusResponseTypeDef
- DescribeAggregationAuthorizationsResponseTypeDef
- PutAggregationAuthorizationResponseTypeDef
- BatchGetAggregateResourceConfigResponseTypeDef
- BatchGetResourceConfigRequestRequestTypeDef
- BatchGetResourceConfigResponseTypeDef
- DescribeRemediationExecutionStatusRequestDescribeRemediationExecutionStatusPaginateTypeDef
- DescribeRemediationExecutionStatusRequestRequestTypeDef
- StartRemediationExecutionRequestRequestTypeDef
- StartRemediationExecutionResponseTypeDef
- ComplianceSummaryTypeDef
- ComplianceTypeDef
- DescribeAggregateComplianceByConfigRulesRequestDescribeAggregateComplianceByConfigRulesPaginateTypeDef
- DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef
- GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef
- DescribeConfigRuleEvaluationStatusResponseTypeDef
- DeliveryChannelTypeDef
- DeliveryChannelStatusTypeDef
- ConfigurationAggregatorTypeDef
- ConfigurationItemTypeDef
- DescribeConfigurationRecorderStatusResponseTypeDef
- DescribeConformancePackComplianceRequestRequestTypeDef
- ListConformancePackComplianceScoresResponseTypeDef
- ListConformancePackComplianceScoresRequestRequestTypeDef
- GetConformancePackComplianceSummaryResponseTypeDef
- OrganizationConformancePackTypeDef
- PutOrganizationConformancePackRequestRequestTypeDef
- ConformancePackDetailTypeDef
- PutConformancePackRequestRequestTypeDef
- GetConformancePackComplianceDetailsRequestRequestTypeDef
- DescribeConformancePackComplianceResponseTypeDef
- DescribeConformancePackStatusResponseTypeDef
- DeleteRemediationExceptionsRequestRequestTypeDef
- DescribeRemediationExceptionsRequestRequestTypeDef
- FailedDeleteRemediationExceptionsBatchTypeDef
- PutRemediationExceptionsRequestRequestTypeDef
- DescribeConfigRulesRequestDescribeConfigRulesPaginateTypeDef
- DescribeConfigRulesRequestRequestTypeDef
- DescribeOrganizationConfigRuleStatusesResponseTypeDef
- DescribeOrganizationConformancePackStatusesResponseTypeDef
- DescribePendingAggregationRequestsResponseTypeDef
- DescribeRemediationExceptionsResponseTypeDef
- FailedRemediationExceptionBatchTypeDef
- DescribeRetentionConfigurationsResponseTypeDef
- PutRetentionConfigurationResponseTypeDef
- EvaluationResultIdentifierTypeDef
- PutEvaluationsRequestRequestTypeDef
- PutEvaluationsResponseTypeDef
- ExecutionControlsTypeDef
- PutExternalEvaluationRequestRequestTypeDef
- QueryInfoTypeDef
- GetAggregateDiscoveredResourceCountsRequestRequestTypeDef
- GetAggregateDiscoveredResourceCountsResponseTypeDef
- GetDiscoveredResourceCountsResponseTypeDef
- GetOrganizationConfigRuleDetailedStatusRequestGetOrganizationConfigRuleDetailedStatusPaginateTypeDef
- GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef
- GetOrganizationConfigRuleDetailedStatusResponseTypeDef
- GetOrganizationConformancePackDetailedStatusRequestGetOrganizationConformancePackDetailedStatusPaginateTypeDef
- GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef
- GetOrganizationConformancePackDetailedStatusResponseTypeDef
- GetResourceEvaluationSummaryResponseTypeDef
- StartResourceEvaluationRequestRequestTypeDef
- GetStoredQueryResponseTypeDef
- ListAggregateDiscoveredResourcesRequestListAggregateDiscoveredResourcesPaginateTypeDef
- ListAggregateDiscoveredResourcesRequestRequestTypeDef
- ListDiscoveredResourcesResponseTypeDef
- ListResourceEvaluationsResponseTypeDef
- ListStoredQueriesResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutAggregationAuthorizationRequestRequestTypeDef
- PutConfigurationAggregatorRequestRequestTypeDef
- PutStoredQueryRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- OrganizationConfigRuleTypeDef
- PutOrganizationConfigRuleRequestRequestTypeDef
- RecordingGroupTypeDef
- RemediationExecutionStatusTypeDef
- RemediationParameterValueTypeDef
- ResourceEvaluationFiltersTypeDef
- SourceTypeDef
- DescribeAggregateComplianceByConformancePacksResponseTypeDef
- GetAggregateConformancePackComplianceSummaryResponseTypeDef
- AggregateComplianceCountTypeDef
- ComplianceSummaryByResourceTypeTypeDef
- GetComplianceSummaryByConfigRuleResponseTypeDef
- AggregateComplianceByConfigRuleTypeDef
- ComplianceByConfigRuleTypeDef
- ComplianceByResourceTypeDef
- DescribeDeliveryChannelsResponseTypeDef
- PutDeliveryChannelRequestRequestTypeDef
- DescribeDeliveryChannelStatusResponseTypeDef
- DescribeConfigurationAggregatorsResponseTypeDef
- PutConfigurationAggregatorResponseTypeDef
- GetAggregateResourceConfigResponseTypeDef
- GetResourceConfigHistoryResponseTypeDef
- DescribeOrganizationConformancePacksResponseTypeDef
- DescribeConformancePacksResponseTypeDef
- DeleteRemediationExceptionsResponseTypeDef
- PutRemediationExceptionsResponseTypeDef
- AggregateEvaluationResultTypeDef
- ConformancePackEvaluationResultTypeDef
- EvaluationResultTypeDef
- SelectAggregateResourceConfigResponseTypeDef
- SelectResourceConfigResponseTypeDef
- DescribeOrganizationConfigRulesResponseTypeDef
- ConfigurationRecorderTypeDef
- DescribeRemediationExecutionStatusResponseTypeDef
- RemediationConfigurationTypeDef
- ListResourceEvaluationsRequestListResourceEvaluationsPaginateTypeDef
- ListResourceEvaluationsRequestRequestTypeDef
- ConfigRuleTypeDef
- GetAggregateConfigRuleComplianceSummaryResponseTypeDef
- GetComplianceSummaryByResourceTypeResponseTypeDef
- DescribeAggregateComplianceByConfigRulesResponseTypeDef
- DescribeComplianceByConfigRuleResponseTypeDef
- DescribeComplianceByResourceResponseTypeDef
- GetAggregateComplianceDetailsByConfigRuleResponseTypeDef
- GetConformancePackComplianceDetailsResponseTypeDef
- GetComplianceDetailsByConfigRuleResponseTypeDef
- GetComplianceDetailsByResourceResponseTypeDef
- DescribeConfigurationRecordersResponseTypeDef
- PutConfigurationRecorderRequestRequestTypeDef
- DescribeRemediationConfigurationsResponseTypeDef
- FailedRemediationBatchTypeDef
- PutRemediationConfigurationsRequestRequestTypeDef
- DescribeConfigRulesResponseTypeDef
- PutConfigRuleRequestRequestTypeDef
- PutRemediationConfigurationsResponseTypeDef