Skip to content

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)
    ...
  1. See AggregateResourceIdentifierTypeDef
  2. See BatchGetAggregateResourceConfigResponseTypeDef
# batch_get_aggregate_resource_config method usage example with argument unpacking

kwargs: BatchGetAggregateResourceConfigRequestRequestTypeDef = {  # (1)
    "ConfigurationAggregatorName": ...,
    "ResourceIdentifiers": ...,
}

parent.batch_get_aggregate_resource_config(**kwargs)
  1. See BatchGetAggregateResourceConfigRequestRequestTypeDef

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)
    ...
  1. See ResourceKeyTypeDef
  2. See BatchGetResourceConfigResponseTypeDef
# batch_get_resource_config method usage example with argument unpacking

kwargs: BatchGetResourceConfigRequestRequestTypeDef = {  # (1)
    "resourceKeys": ...,
}

parent.batch_get_resource_config(**kwargs)
  1. See BatchGetResourceConfigRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_aggregation_authorization method usage example with argument unpacking

kwargs: DeleteAggregationAuthorizationRequestRequestTypeDef = {  # (1)
    "AuthorizedAccountId": ...,
    "AuthorizedAwsRegion": ...,
}

parent.delete_aggregation_authorization(**kwargs)
  1. See DeleteAggregationAuthorizationRequestRequestTypeDef

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_config_rule method usage example with argument unpacking

kwargs: DeleteConfigRuleRequestRequestTypeDef = {  # (1)
    "ConfigRuleName": ...,
}

parent.delete_config_rule(**kwargs)
  1. See DeleteConfigRuleRequestRequestTypeDef

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)
    ...
  1. See