ConfigServiceClient#
Index > ConfigService > ConfigServiceClient
Auto-generated documentation for ConfigService type annotations stubs module mypy-boto3-config.
ConfigServiceClient#
Type annotations and code completion for boto3.client("config").
boto3 documentation
# ConfigServiceClient usage example
from boto3.session import Session
from mypy_boto3_config.client import ConfigServiceClient
def get_config_client() -> ConfigServiceClient:
return Session().client("config")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("config").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("config")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ConformancePackTemplateValidationException,
client.exceptions.IdempotentParameterMismatch,
client.exceptions.InsufficientDeliveryPolicyException,
client.exceptions.InsufficientPermissionsException,
client.exceptions.InvalidConfigurationRecorderNameException,
client.exceptions.InvalidDeliveryChannelNameException,
client.exceptions.InvalidExpressionException,
client.exceptions.InvalidLimitException,
client.exceptions.InvalidNextTokenException,
client.exceptions.InvalidParameterValueException,
client.exceptions.InvalidRecordingGroupException,
client.exceptions.InvalidResultTokenException,
client.exceptions.InvalidRoleException,
client.exceptions.InvalidS3KeyPrefixException,
client.exceptions.InvalidS3KmsKeyArnException,
client.exceptions.InvalidSNSTopicARNException,
client.exceptions.InvalidTimeRangeException,
client.exceptions.LastDeliveryChannelDeleteFailedException,
client.exceptions.LimitExceededException,
client.exceptions.MaxActiveResourcesExceededException,
client.exceptions.MaxNumberOfConfigRulesExceededException,
client.exceptions.MaxNumberOfConfigurationRecordersExceededException,
client.exceptions.MaxNumberOfConformancePacksExceededException,
client.exceptions.MaxNumberOfDeliveryChannelsExceededException,
client.exceptions.MaxNumberOfOrganizationConfigRulesExceededException,
client.exceptions.MaxNumberOfOrganizationConformancePacksExceededException,
client.exceptions.MaxNumberOfRetentionConfigurationsExceededException,
client.exceptions.NoAvailableConfigurationRecorderException,
client.exceptions.NoAvailableDeliveryChannelException,
client.exceptions.NoAvailableOrganizationException,
client.exceptions.NoRunningConfigurationRecorderException,
client.exceptions.NoSuchBucketException,
client.exceptions.NoSuchConfigRuleException,
client.exceptions.NoSuchConfigRuleInConformancePackException,
client.exceptions.NoSuchConfigurationAggregatorException,
client.exceptions.NoSuchConfigurationRecorderException,
client.exceptions.NoSuchConformancePackException,
client.exceptions.NoSuchDeliveryChannelException,
client.exceptions.NoSuchOrganizationConfigRuleException,
client.exceptions.NoSuchOrganizationConformancePackException,
client.exceptions.NoSuchRemediationConfigurationException,
client.exceptions.NoSuchRemediationExceptionException,
client.exceptions.NoSuchRetentionConfigurationException,
client.exceptions.OrganizationAccessDeniedException,
client.exceptions.OrganizationAllFeaturesNotEnabledException,
client.exceptions.OrganizationConformancePackTemplateValidationException,
client.exceptions.OversizedConfigurationItemException,
client.exceptions.RemediationInProgressException,
client.exceptions.ResourceConcurrentModificationException,
client.exceptions.ResourceInUseException,
client.exceptions.ResourceNotDiscoveredException,
client.exceptions.ResourceNotFoundException,
client.exceptions.TooManyTagsException,
client.exceptions.ValidationException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_config.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...Methods#
batch_get_aggregate_resource_config#
Returns the current configuration items for resources that are present in your Config aggregator.
Type annotations and code completion for boto3.client("config").batch_get_aggregate_resource_config method.
boto3 documentation
# batch_get_aggregate_resource_config method definition
def batch_get_aggregate_resource_config(
self,
*,
ConfigurationAggregatorName: str,
ResourceIdentifiers: Sequence[AggregateResourceIdentifierTypeDef], # (1)
) -> BatchGetAggregateResourceConfigResponseTypeDef: # (2)
...# batch_get_aggregate_resource_config method usage example with argument unpacking
kwargs: BatchGetAggregateResourceConfigRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ResourceIdentifiers": ...,
}
parent.batch_get_aggregate_resource_config(**kwargs)batch_get_resource_config#
Returns the BaseConfigurationItem for one or more requested resources.
Type annotations and code completion for boto3.client("config").batch_get_resource_config method.
boto3 documentation
# batch_get_resource_config method definition
def batch_get_resource_config(
self,
*,
resourceKeys: Sequence[ResourceKeyTypeDef], # (1)
) -> BatchGetResourceConfigResponseTypeDef: # (2)
...# batch_get_resource_config method usage example with argument unpacking
kwargs: BatchGetResourceConfigRequestRequestTypeDef = { # (1)
"resourceKeys": ...,
}
parent.batch_get_resource_config(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("config").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("config").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...delete_aggregation_authorization#
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
Type annotations and code completion for boto3.client("config").delete_aggregation_authorization method.
boto3 documentation
# delete_aggregation_authorization method definition
def delete_aggregation_authorization(
self,
*,
AuthorizedAccountId: str,
AuthorizedAwsRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_aggregation_authorization method usage example with argument unpacking
kwargs: DeleteAggregationAuthorizationRequestRequestTypeDef = { # (1)
"AuthorizedAccountId": ...,
"AuthorizedAwsRegion": ...,
}
parent.delete_aggregation_authorization(**kwargs)delete_config_rule#
Deletes the specified Config rule and all of its evaluation results.
Type annotations and code completion for boto3.client("config").delete_config_rule method.
boto3 documentation
# delete_config_rule method definition
def delete_config_rule(
self,
*,
ConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_config_rule method usage example with argument unpacking
kwargs: DeleteConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_config_rule(**kwargs)delete_configuration_aggregator#
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
Type annotations and code completion for boto3.client("config").delete_configuration_aggregator method.
boto3 documentation
# delete_configuration_aggregator method definition
def delete_configuration_aggregator(
self,
*,
ConfigurationAggregatorName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_configuration_aggregator method usage example with argument unpacking
kwargs: DeleteConfigurationAggregatorRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.delete_configuration_aggregator(**kwargs)delete_configuration_recorder#
Deletes the configuration recorder.
Type annotations and code completion for boto3.client("config").delete_configuration_recorder method.
boto3 documentation
# delete_configuration_recorder method definition
def delete_configuration_recorder(
self,
*,
ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_configuration_recorder method usage example with argument unpacking
kwargs: DeleteConfigurationRecorderRequestRequestTypeDef = { # (1)
"ConfigurationRecorderName": ...,
}
parent.delete_configuration_recorder(**kwargs)delete_conformance_pack#
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Type annotations and code completion for boto3.client("config").delete_conformance_pack method.
boto3 documentation
# delete_conformance_pack method definition
def delete_conformance_pack(
self,
*,
ConformancePackName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_conformance_pack method usage example with argument unpacking
kwargs: DeleteConformancePackRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.delete_conformance_pack(**kwargs)delete_delivery_channel#
Deletes the delivery channel.
Type annotations and code completion for boto3.client("config").delete_delivery_channel method.
boto3 documentation
# delete_delivery_channel method definition
def delete_delivery_channel(
self,
*,
DeliveryChannelName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_delivery_channel method usage example with argument unpacking
kwargs: DeleteDeliveryChannelRequestRequestTypeDef = { # (1)
"DeliveryChannelName": ...,
}
parent.delete_delivery_channel(**kwargs)delete_evaluation_results#
Deletes the evaluation results for the specified Config rule.
Type annotations and code completion for boto3.client("config").delete_evaluation_results method.
boto3 documentation
# delete_evaluation_results method definition
def delete_evaluation_results(
self,
*,
ConfigRuleName: str,
) -> Dict[str, Any]:
...# delete_evaluation_results method usage example with argument unpacking
kwargs: DeleteEvaluationResultsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_evaluation_results(**kwargs)delete_organization_config_rule#
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Type annotations and code completion for boto3.client("config").delete_organization_config_rule method.
boto3 documentation
# delete_organization_config_rule method definition
def delete_organization_config_rule(
self,
*,
OrganizationConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_organization_config_rule method usage example with argument unpacking
kwargs: DeleteOrganizationConfigRuleRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.delete_organization_config_rule(**kwargs)delete_organization_conformance_pack#
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Type annotations and code completion for boto3.client("config").delete_organization_conformance_pack method.
boto3 documentation
# delete_organization_conformance_pack method definition
def delete_organization_conformance_pack(
self,
*,
OrganizationConformancePackName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_organization_conformance_pack method usage example with argument unpacking
kwargs: DeleteOrganizationConformancePackRequestRequestTypeDef = { # (1)
"OrganizationConformancePackName": ...,
}
parent.delete_organization_conformance_pack(**kwargs)delete_pending_aggregation_request#
Deletes pending authorization requests for a specified aggregator account in a specified region.
Type annotations and code completion for boto3.client("config").delete_pending_aggregation_request method.
boto3 documentation
# delete_pending_aggregation_request method definition
def delete_pending_aggregation_request(
self,
*,
RequesterAccountId: str,
RequesterAwsRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_pending_aggregation_request method usage example with argument unpacking
kwargs: DeletePendingAggregationRequestRequestRequestTypeDef = { # (1)
"RequesterAccountId": ...,
"RequesterAwsRegion": ...,
}
parent.delete_pending_aggregation_request(**kwargs)delete_remediation_configuration#
Deletes the remediation configuration.
Type annotations and code completion for boto3.client("config").delete_remediation_configuration method.
boto3 documentation
# delete_remediation_configuration method definition
def delete_remediation_configuration(
self,
*,
ConfigRuleName: str,
ResourceType: str = ...,
) -> Dict[str, Any]:
...# delete_remediation_configuration method usage example with argument unpacking
kwargs: DeleteRemediationConfigurationRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_remediation_configuration(**kwargs)delete_remediation_exceptions#
Deletes one or more remediation exceptions mentioned in the resource keys.
Type annotations and code completion for boto3.client("config").delete_remediation_exceptions method.
boto3 documentation
# delete_remediation_exceptions method definition
def delete_remediation_exceptions(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef], # (1)
) -> DeleteRemediationExceptionsResponseTypeDef: # (2)
...# delete_remediation_exceptions method usage example with argument unpacking
kwargs: DeleteRemediationExceptionsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
"ResourceKeys": ...,
}
parent.delete_remediation_exceptions(**kwargs)delete_resource_config#
Records the configuration state for a custom resource that has been deleted.
Type annotations and code completion for boto3.client("config").delete_resource_config method.
boto3 documentation
# delete_resource_config method definition
def delete_resource_config(
self,
*,
ResourceType: str,
ResourceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_resource_config method usage example with argument unpacking
kwargs: DeleteResourceConfigRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
}
parent.delete_resource_config(**kwargs)delete_retention_configuration#
Deletes the retention configuration.
Type annotations and code completion for boto3.client("config").delete_retention_configuration method.
boto3 documentation
# delete_retention_configuration method definition
def delete_retention_configuration(
self,
*,
RetentionConfigurationName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_retention_configuration method usage example with argument unpacking
kwargs: DeleteRetentionConfigurationRequestRequestTypeDef = { # (1)
"RetentionConfigurationName": ...,
}
parent.delete_retention_configuration(**kwargs)delete_stored_query#
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
Type annotations and code completion for boto3.client("config").delete_stored_query method.
boto3 documentation
# delete_stored_query method definition
def delete_stored_query(
self,
*,
QueryName: str,
) -> Dict[str, Any]:
...# delete_stored_query method usage example with argument unpacking
kwargs: DeleteStoredQueryRequestRequestTypeDef = { # (1)
"QueryName": ...,
}
parent.delete_stored_query(**kwargs)deliver_config_snapshot#
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
Type annotations and code completion for boto3.client("config").deliver_config_snapshot method.
boto3 documentation
# deliver_config_snapshot method definition
def deliver_config_snapshot(
self,
*,
deliveryChannelName: str,
) -> DeliverConfigSnapshotResponseTypeDef: # (1)
...# deliver_config_snapshot method usage example with argument unpacking
kwargs: DeliverConfigSnapshotRequestRequestTypeDef = { # (1)
"deliveryChannelName": ...,
}
parent.deliver_config_snapshot(**kwargs)describe_aggregate_compliance_by_config_rules#
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
Type annotations and code completion for boto3.client("config").describe_aggregate_compliance_by_config_rules method.
boto3 documentation
# describe_aggregate_compliance_by_config_rules method definition
def describe_aggregate_compliance_by_config_rules(
self,
*,
ConfigurationAggregatorName: str,
Filters: ConfigRuleComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregateComplianceByConfigRulesResponseTypeDef: # (2)
...# describe_aggregate_compliance_by_config_rules method usage example with argument unpacking
kwargs: DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_aggregate_compliance_by_config_rules(**kwargs)describe_aggregate_compliance_by_conformance_packs#
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
Type annotations and code completion for boto3.client("config").describe_aggregate_compliance_by_conformance_packs method.
boto3 documentation
# describe_aggregate_compliance_by_conformance_packs method definition
def describe_aggregate_compliance_by_conformance_packs(
self,
*,
ConfigurationAggregatorName: str,
Filters: AggregateConformancePackComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregateComplianceByConformancePacksResponseTypeDef: # (2)
...- See AggregateConformancePackComplianceFiltersTypeDef
- See DescribeAggregateComplianceByConformancePacksResponseTypeDef
# describe_aggregate_compliance_by_conformance_packs method usage example with argument unpacking
kwargs: DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_aggregate_compliance_by_conformance_packs(**kwargs)describe_aggregation_authorizations#
Returns a list of authorizations granted to various aggregator accounts and regions.
Type annotations and code completion for boto3.client("config").describe_aggregation_authorizations method.
boto3 documentation
# describe_aggregation_authorizations method definition
def describe_aggregation_authorizations(
self,
*,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregationAuthorizationsResponseTypeDef: # (1)
...# describe_aggregation_authorizations method usage example with argument unpacking
kwargs: DescribeAggregationAuthorizationsRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.describe_aggregation_authorizations(**kwargs)describe_compliance_by_config_rule#
Indicates whether the specified Config rules are compliant.
Type annotations and code completion for boto3.client("config").describe_compliance_by_config_rule method.
boto3 documentation
# describe_compliance_by_config_rule method definition
def describe_compliance_by_config_rule(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
NextToken: str = ...,
) -> DescribeComplianceByConfigRuleResponseTypeDef: # (2)
...# describe_compliance_by_config_rule method usage example with argument unpacking
kwargs: DescribeComplianceByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_compliance_by_config_rule(**kwargs)describe_compliance_by_resource#
Indicates whether the specified Amazon Web Services resources are compliant.
Type annotations and code completion for boto3.client("config").describe_compliance_by_resource method.
boto3 documentation
# describe_compliance_by_resource method definition
def describe_compliance_by_resource(
self,
*,
ResourceType: str = ...,
ResourceId: str = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeComplianceByResourceResponseTypeDef: # (2)
...# describe_compliance_by_resource method usage example with argument unpacking
kwargs: DescribeComplianceByResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
}
parent.describe_compliance_by_resource(**kwargs)describe_config_rule_evaluation_status#
Returns status information for each of your Config managed rules.
Type annotations and code completion for boto3.client("config").describe_config_rule_evaluation_status method.
boto3 documentation
# describe_config_rule_evaluation_status method definition
def describe_config_rule_evaluation_status(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigRuleEvaluationStatusResponseTypeDef: # (1)
...# describe_config_rule_evaluation_status method usage example with argument unpacking
kwargs: DescribeConfigRuleEvaluationStatusRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_config_rule_evaluation_status(**kwargs)describe_config_rules#
Returns details about your Config rules.
Type annotations and code completion for boto3.client("config").describe_config_rules method.
boto3 documentation
# describe_config_rules method definition
def describe_config_rules(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
NextToken: str = ...,
Filters: DescribeConfigRulesFiltersTypeDef = ..., # (1)
) -> DescribeConfigRulesResponseTypeDef: # (2)
...# describe_config_rules method usage example with argument unpacking
kwargs: DescribeConfigRulesRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_config_rules(**kwargs)describe_configuration_aggregator_sources_status#
Returns status information for sources within an aggregator.
Type annotations and code completion for boto3.client("config").describe_configuration_aggregator_sources_status method.
boto3 documentation
# describe_configuration_aggregator_sources_status method definition
def describe_configuration_aggregator_sources_status(
self,
*,
ConfigurationAggregatorName: str,
UpdateStatus: Sequence[AggregatedSourceStatusTypeType] = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigurationAggregatorSourcesStatusResponseTypeDef: # (2)
...# describe_configuration_aggregator_sources_status method usage example with argument unpacking
kwargs: DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_configuration_aggregator_sources_status(**kwargs)describe_configuration_aggregators#
Returns the details of one or more configuration aggregators.
Type annotations and code completion for boto3.client("config").describe_configuration_aggregators method.
boto3 documentation
# describe_configuration_aggregators method definition
def describe_configuration_aggregators(
self,
*,
ConfigurationAggregatorNames: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigurationAggregatorsResponseTypeDef: # (1)
...# describe_configuration_aggregators method usage example with argument unpacking
kwargs: DescribeConfigurationAggregatorsRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorNames": ...,
}
parent.describe_configuration_aggregators(**kwargs)describe_configuration_recorder_status#
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.
Type annotations and code completion for boto3.client("config").describe_configuration_recorder_status method.
boto3 documentation
# describe_configuration_recorder_status method definition
def describe_configuration_recorder_status(
self,
*,
ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecorderStatusResponseTypeDef: # (1)
...# describe_configuration_recorder_status method usage example with argument unpacking
kwargs: DescribeConfigurationRecorderStatusRequestRequestTypeDef = { # (1)
"ConfigurationRecorderNames": ...,
}
parent.describe_configuration_recorder_status(**kwargs)describe_configuration_recorders#
Returns the details for the specified configuration recorders.
Type annotations and code completion for boto3.client("config").describe_configuration_recorders method.
boto3 documentation
# describe_configuration_recorders method definition
def describe_configuration_recorders(
self,
*,
ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecordersResponseTypeDef: # (1)
...# describe_configuration_recorders method usage example with argument unpacking
kwargs: DescribeConfigurationRecordersRequestRequestTypeDef = { # (1)
"ConfigurationRecorderNames": ...,
}
parent.describe_configuration_recorders(**kwargs)describe_conformance_pack_compliance#
Returns compliance details for each rule in that conformance pack.
Type annotations and code completion for boto3.client("config").describe_conformance_pack_compliance method.
boto3 documentation
# describe_conformance_pack_compliance method definition
def describe_conformance_pack_compliance(
self,
*,
ConformancePackName: str,
Filters: ConformancePackComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePackComplianceResponseTypeDef: # (2)
...# describe_conformance_pack_compliance method usage example with argument unpacking
kwargs: DescribeConformancePackComplianceRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.describe_conformance_pack_compliance(**kwargs)describe_conformance_pack_status#
Provides one or more conformance packs deployment status.
Type annotations and code completion for boto3.client("config").describe_conformance_pack_status method.
boto3 documentation
# describe_conformance_pack_status method definition
def describe_conformance_pack_status(
self,
*,
ConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePackStatusResponseTypeDef: # (1)
...# describe_conformance_pack_status method usage example with argument unpacking
kwargs: DescribeConformancePackStatusRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.describe_conformance_pack_status(**kwargs)describe_conformance_packs#
Returns a list of one or more conformance packs.
Type annotations and code completion for boto3.client("config").describe_conformance_packs method.
boto3 documentation
# describe_conformance_packs method definition
def describe_conformance_packs(
self,
*,
ConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePacksResponseTypeDef: # (1)
...# describe_conformance_packs method usage example with argument unpacking
kwargs: DescribeConformancePacksRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.describe_conformance_packs(**kwargs)describe_delivery_channel_status#
Returns the current status of the specified delivery channel.
Type annotations and code completion for boto3.client("config").describe_delivery_channel_status method.
boto3 documentation
# describe_delivery_channel_status method definition
def describe_delivery_channel_status(
self,
*,
DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelStatusResponseTypeDef: # (1)
...# describe_delivery_channel_status method usage example with argument unpacking
kwargs: DescribeDeliveryChannelStatusRequestRequestTypeDef = { # (1)
"DeliveryChannelNames": ...,
}
parent.describe_delivery_channel_status(**kwargs)describe_delivery_channels#
Returns details about the specified delivery channel.
Type annotations and code completion for boto3.client("config").describe_delivery_channels method.
boto3 documentation
# describe_delivery_channels method definition
def describe_delivery_channels(
self,
*,
DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelsResponseTypeDef: # (1)
...# describe_delivery_channels method usage example with argument unpacking
kwargs: DescribeDeliveryChannelsRequestRequestTypeDef = { # (1)
"DeliveryChannelNames": ...,
}
parent.describe_delivery_channels(**kwargs)describe_organization_config_rule_statuses#
Provides organization Config rule deployment status for an organization.
Type annotations and code completion for boto3.client("config").describe_organization_config_rule_statuses method.
boto3 documentation
# describe_organization_config_rule_statuses method definition
def describe_organization_config_rule_statuses(
self,
*,
OrganizationConfigRuleNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConfigRuleStatusesResponseTypeDef: # (1)
...# describe_organization_config_rule_statuses method usage example with argument unpacking
kwargs: DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleNames": ...,
}
parent.describe_organization_config_rule_statuses(**kwargs)describe_organization_config_rules#
Returns a list of organization Config rules.
Type annotations and code completion for boto3.client("config").describe_organization_config_rules method.
boto3 documentation
# describe_organization_config_rules method definition
def describe_organization_config_rules(
self,
*,
OrganizationConfigRuleNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConfigRulesResponseTypeDef: # (1)
...# describe_organization_config_rules method usage example with argument unpacking
kwargs: DescribeOrganizationConfigRulesRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleNames": ...,
}
parent.describe_organization_config_rules(**kwargs)describe_organization_conformance_pack_statuses#
Provides organization conformance pack deployment status for an organization.
Type annotations and code completion for boto3.client("config").describe_organization_conformance_pack_statuses method.
boto3 documentation
# describe_organization_conformance_pack_statuses method definition
def describe_organization_conformance_pack_statuses(
self,
*,
OrganizationConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConformancePackStatusesResponseTypeDef: # (1)
...# describe_organization_conformance_pack_statuses method usage example with argument unpacking
kwargs: DescribeOrganizationConformancePackStatusesRequestRequestTypeDef = { # (1)
"OrganizationConformancePackNames": ...,
}
parent.describe_organization_conformance_pack_statuses(**kwargs)describe_organization_conformance_packs#
Returns a list of organization conformance packs.
Type annotations and code completion for boto3.client("config").describe_organization_conformance_packs method.
boto3 documentation
# describe_organization_conformance_packs method definition
def describe_organization_conformance_packs(
self,
*,
OrganizationConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConformancePacksResponseTypeDef: # (1)
...# describe_organization_conformance_packs method usage example with argument unpacking
kwargs: DescribeOrganizationConformancePacksRequestRequestTypeDef = { # (1)
"OrganizationConformancePackNames": ...,
}
parent.describe_organization_conformance_packs(**kwargs)describe_pending_aggregation_requests#
Returns a list of all pending aggregation requests.
Type annotations and code completion for boto3.client("config").describe_pending_aggregation_requests method.
boto3 documentation
# describe_pending_aggregation_requests method definition
def describe_pending_aggregation_requests(
self,
*,
Limit: int = ...,
NextToken: str = ...,
) -> DescribePendingAggregationRequestsResponseTypeDef: # (1)
...# describe_pending_aggregation_requests method usage example with argument unpacking
kwargs: DescribePendingAggregationRequestsRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.describe_pending_aggregation_requests(**kwargs)describe_remediation_configurations#
Returns the details of one or more remediation configurations.
Type annotations and code completion for boto3.client("config").describe_remediation_configurations method.
boto3 documentation
# describe_remediation_configurations method definition
def describe_remediation_configurations(
self,
*,
ConfigRuleNames: Sequence[str],
) -> DescribeRemediationConfigurationsResponseTypeDef: # (1)
...# describe_remediation_configurations method usage example with argument unpacking
kwargs: DescribeRemediationConfigurationsRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_remediation_configurations(**kwargs)describe_remediation_exceptions#
Returns the details of one or more remediation exceptions.
Type annotations and code completion for boto3.client("config").describe_remediation_exceptions method.
boto3 documentation
# describe_remediation_exceptions method definition
def describe_remediation_exceptions(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeRemediationExceptionsResponseTypeDef: # (2)
...# describe_remediation_exceptions method usage example with argument unpacking
kwargs: DescribeRemediationExceptionsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.describe_remediation_exceptions(**kwargs)describe_remediation_execution_status#
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
Type annotations and code completion for boto3.client("config").describe_remediation_execution_status method.
boto3 documentation
# describe_remediation_execution_status method definition
def describe_remediation_execution_status(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[ResourceKeyTypeDef] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeRemediationExecutionStatusResponseTypeDef: # (2)
...# describe_remediation_execution_status method usage example with argument unpacking
kwargs: DescribeRemediationExecutionStatusRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.describe_remediation_execution_status(**kwargs)describe_retention_configurations#
Returns the details of one or more retention configurations.
Type annotations and code completion for boto3.client("config").describe_retention_configurations method.
boto3 documentation
# describe_retention_configurations method definition
def describe_retention_configurations(
self,
*,
RetentionConfigurationNames: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeRetentionConfigurationsResponseTypeDef: # (1)
...# describe_retention_configurations method usage example with argument unpacking
kwargs: DescribeRetentionConfigurationsRequestRequestTypeDef = { # (1)
"RetentionConfigurationNames": ...,
}
parent.describe_retention_configurations(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("config").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_aggregate_compliance_details_by_config_rule#
Returns the evaluation results for the specified Config rule for a specific resource in a rule.
Type annotations and code completion for boto3.client("config").get_aggregate_compliance_details_by_config_rule method.
boto3 documentation
# get_aggregate_compliance_details_by_config_rule method definition
def get_aggregate_compliance_details_by_config_rule(
self,
*,
ConfigurationAggregatorName: str,
ConfigRuleName: str,
AccountId: str,
AwsRegion: str,
ComplianceType: ComplianceTypeType = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateComplianceDetailsByConfigRuleResponseTypeDef: # (2)
...# get_aggregate_compliance_details_by_config_rule method usage example with argument unpacking
kwargs: GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ConfigRuleName": ...,
"AccountId": ...,
"AwsRegion": ...,
}
parent.get_aggregate_compliance_details_by_config_rule(**kwargs)get_aggregate_config_rule_compliance_summary#
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_config_rule_compliance_summary method.
boto3 documentation
# get_aggregate_config_rule_compliance_summary method definition
def get_aggregate_config_rule_compliance_summary(
self,
*,
ConfigurationAggregatorName: str,
Filters: ConfigRuleComplianceSummaryFiltersTypeDef = ..., # (1)
GroupByKey: ConfigRuleComplianceSummaryGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateConfigRuleComplianceSummaryResponseTypeDef: # (3)
...- See ConfigRuleComplianceSummaryFiltersTypeDef
- See ConfigRuleComplianceSummaryGroupKeyType
- See GetAggregateConfigRuleComplianceSummaryResponseTypeDef
# get_aggregate_config_rule_compliance_summary method usage example with argument unpacking
kwargs: GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_config_rule_compliance_summary(**kwargs)get_aggregate_conformance_pack_compliance_summary#
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_conformance_pack_compliance_summary method.
boto3 documentation
# get_aggregate_conformance_pack_compliance_summary method definition
def get_aggregate_conformance_pack_compliance_summary(
self,
*,
ConfigurationAggregatorName: str,
Filters: AggregateConformancePackComplianceSummaryFiltersTypeDef = ..., # (1)
GroupByKey: AggregateConformancePackComplianceSummaryGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateConformancePackComplianceSummaryResponseTypeDef: # (3)
...- See AggregateConformancePackComplianceSummaryFiltersTypeDef
- See AggregateConformancePackComplianceSummaryGroupKeyType
- See GetAggregateConformancePackComplianceSummaryResponseTypeDef
# get_aggregate_conformance_pack_compliance_summary method usage example with argument unpacking
kwargs: GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_conformance_pack_compliance_summary(**kwargs)get_aggregate_discovered_resource_counts#
Returns the resource counts across accounts and regions that are present in your Config aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_discovered_resource_counts method.
boto3 documentation
# get_aggregate_discovered_resource_counts method definition
def get_aggregate_discovered_resource_counts(
self,
*,
ConfigurationAggregatorName: str,
Filters: ResourceCountFiltersTypeDef = ..., # (1)
GroupByKey: ResourceCountGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateDiscoveredResourceCountsResponseTypeDef: # (3)
...- See ResourceCountFiltersTypeDef
- See ResourceCountGroupKeyType
- See GetAggregateDiscoveredResourceCountsResponseTypeDef
# get_aggregate_discovered_resource_counts method usage example with argument unpacking
kwargs: GetAggregateDiscoveredResourceCountsRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_discovered_resource_counts(**kwargs)get_aggregate_resource_config#
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
Type annotations and code completion for boto3.client("config").get_aggregate_resource_config method.
boto3 documentation
# get_aggregate_resource_config method definition
def get_aggregate_resource_config(
self,
*,
ConfigurationAggregatorName: str,
ResourceIdentifier: AggregateResourceIdentifierTypeDef, # (1)
) -> GetAggregateResourceConfigResponseTypeDef: # (2)
...# get_aggregate_resource_config method usage example with argument unpacking
kwargs: GetAggregateResourceConfigRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ResourceIdentifier": ...,
}
parent.get_aggregate_resource_config(**kwargs)get_compliance_details_by_config_rule#
Returns the evaluation results for the specified Config rule.
Type annotations and code completion for boto3.client("config").get_compliance_details_by_config_rule method.
boto3 documentation
# get_compliance_details_by_config_rule method definition
def get_compliance_details_by_config_rule(
self,
*,
ConfigRuleName: str,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetComplianceDetailsByConfigRuleResponseTypeDef: # (2)
...# get_compliance_details_by_config_rule method usage example with argument unpacking
kwargs: GetComplianceDetailsByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.get_compliance_details_by_config_rule(**kwargs)get_compliance_details_by_resource#
Returns the evaluation results for the specified Amazon Web Services resource.
Type annotations and code completion for boto3.client("config").get_compliance_details_by_resource method.
boto3 documentation
# get_compliance_details_by_resource method definition
def get_compliance_details_by_resource(
self,
*,
ResourceType: str = ...,
ResourceId: str = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
NextToken: str = ...,
ResourceEvaluationId: str = ...,
) -> GetComplianceDetailsByResourceResponseTypeDef: # (2)
...# get_compliance_details_by_resource method usage example with argument unpacking
kwargs: GetComplianceDetailsByResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
}
parent.get_compliance_details_by_resource(**kwargs)get_compliance_summary_by_config_rule#
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Type annotations and code completion for boto3.client("config").get_compliance_summary_by_config_rule method.
boto3 documentation
# get_compliance_summary_by_config_rule method definition
def get_compliance_summary_by_config_rule(
self,
) -> GetComplianceSummaryByConfigRuleResponseTypeDef: # (1)
...get_compliance_summary_by_resource_type#
Returns the number of resources that are compliant and the number that are noncompliant.
Type annotations and code completion for boto3.client("config").get_compliance_summary_by_resource_type method.
boto3 documentation
# get_compliance_summary_by_resource_type method definition
def get_compliance_summary_by_resource_type(
self,
*,
ResourceTypes: Sequence[str] = ...,
) -> GetComplianceSummaryByResourceTypeResponseTypeDef: # (1)
...# get_compliance_summary_by_resource_type method usage example with argument unpacking
kwargs: GetComplianceSummaryByResourceTypeRequestRequestTypeDef = { # (1)
"ResourceTypes": ...,
}
parent.get_compliance_summary_by_resource_type(**kwargs)get_conformance_pack_compliance_details#
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Type annotations and code completion for boto3.client("config").get_conformance_pack_compliance_details method.
boto3 documentation
# get_conformance_pack_compliance_details method definition
def get_conformance_pack_compliance_details(
self,
*,
ConformancePackName: str,
Filters: ConformancePackEvaluationFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetConformancePackComplianceDetailsResponseTypeDef: # (2)
...# get_conformance_pack_compliance_details method usage example with argument unpacking
kwargs: GetConformancePackComplianceDetailsRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.get_conformance_pack_compliance_details(**kwargs)get_conformance_pack_compliance_summary#
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Type annotations and code completion for boto3.client("config").get_conformance_pack_compliance_summary method.
boto3 documentation
# get_conformance_pack_compliance_summary method definition
def get_conformance_pack_compliance_summary(
self,
*,
ConformancePackNames: Sequence[str],
Limit: int = ...,
NextToken: str = ...,
) -> GetConformancePackComplianceSummaryResponseTypeDef: # (1)
...# get_conformance_pack_compliance_summary method usage example with argument unpacking
kwargs: GetConformancePackComplianceSummaryRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.get_conformance_pack_compliance_summary(**kwargs)get_custom_rule_policy#
Returns the policy definition containing the logic for your Config Custom Policy rule.
Type annotations and code completion for boto3.client("config").get_custom_rule_policy method.
boto3 documentation
# get_custom_rule_policy method definition
def get_custom_rule_policy(
self,
*,
ConfigRuleName: str = ...,
) -> GetCustomRulePolicyResponseTypeDef: # (1)
...# get_custom_rule_policy method usage example with argument unpacking
kwargs: GetCustomRulePolicyRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.get_custom_rule_policy(**kwargs)get_discovered_resource_counts#
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Type annotations and code completion for boto3.client("config").get_discovered_resource_counts method.
boto3 documentation
# get_discovered_resource_counts method definition
def get_discovered_resource_counts(
self,
*,
resourceTypes: Sequence[str] = ...,
limit: int = ...,
nextToken: str = ...,
) -> GetDiscoveredResourceCountsResponseTypeDef: # (1)
...# get_discovered_resource_counts method usage example with argument unpacking
kwargs: GetDiscoveredResourceCountsRequestRequestTypeDef = { # (1)
"resourceTypes": ...,
}
parent.get_discovered_resource_counts(**kwargs)get_organization_config_rule_detailed_status#
Returns detailed status for each member account within an organization for a given organization Config rule.
Type annotations and code completion for boto3.client("config").get_organization_config_rule_detailed_status method.
boto3 documentation
# get_organization_config_rule_detailed_status method definition
def get_organization_config_rule_detailed_status(
self,
*,
OrganizationConfigRuleName: str,
Filters: StatusDetailFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetOrganizationConfigRuleDetailedStatusResponseTypeDef: # (2)
...# get_organization_config_rule_detailed_status method usage example with argument unpacking
kwargs: GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.get_organization_config_rule_detailed_status(**kwargs)