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 EmptyResponseMetadataTypeDef
# delete_configuration_aggregator method usage example with argument unpacking

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

parent.delete_configuration_aggregator(**kwargs)
  1. See DeleteConfigurationAggregatorRequestRequestTypeDef

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

kwargs: DeleteConfigurationRecorderRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorderName": ...,
}

parent.delete_configuration_recorder(**kwargs)
  1. See DeleteConfigurationRecorderRequestRequestTypeDef

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

kwargs: DeleteConformancePackRequestRequestTypeDef = {  # (1)
    "ConformancePackName": ...,
}

parent.delete_conformance_pack(**kwargs)
  1. See DeleteConformancePackRequestRequestTypeDef

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

kwargs: DeleteDeliveryChannelRequestRequestTypeDef = {  # (1)
    "DeliveryChannelName": ...,
}

parent.delete_delivery_channel(**kwargs)
  1. See DeleteDeliveryChannelRequestRequestTypeDef

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

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

kwargs: DeleteOrganizationConfigRuleRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleName": ...,
}

parent.delete_organization_config_rule(**kwargs)
  1. See DeleteOrganizationConfigRuleRequestRequestTypeDef

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

kwargs: DeleteOrganizationConformancePackRequestRequestTypeDef = {  # (1)
    "OrganizationConformancePackName": ...,
}

parent.delete_organization_conformance_pack(**kwargs)
  1. See DeleteOrganizationConformancePackRequestRequestTypeDef

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

kwargs: DeletePendingAggregationRequestRequestRequestTypeDef = {  # (1)
    "RequesterAccountId": ...,
    "RequesterAwsRegion": ...,
}

parent.delete_pending_aggregation_request(**kwargs)
  1. See DeletePendingAggregationRequestRequestRequestTypeDef

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

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)
    ...
  1. See RemediationExceptionResourceKeyTypeDef
  2. See DeleteRemediationExceptionsResponseTypeDef
# delete_remediation_exceptions method usage example with argument unpacking

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

parent.delete_remediation_exceptions(**kwargs)
  1. See DeleteRemediationExceptionsRequestRequestTypeDef

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

kwargs: DeleteResourceConfigRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "ResourceId": ...,
}

parent.delete_resource_config(**kwargs)
  1. See DeleteResourceConfigRequestRequestTypeDef

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

kwargs: DeleteRetentionConfigurationRequestRequestTypeDef = {  # (1)
    "RetentionConfigurationName": ...,
}

parent.delete_retention_configuration(**kwargs)
  1. See DeleteRetentionConfigurationRequestRequestTypeDef

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

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

kwargs: DeliverConfigSnapshotRequestRequestTypeDef = {  # (1)
    "deliveryChannelName": ...,
}

parent.deliver_config_snapshot(**kwargs)
  1. See DeliverConfigSnapshotRequestRequestTypeDef

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)
    ...
  1. See ConfigRuleComplianceFiltersTypeDef
  2. See DescribeAggregateComplianceByConfigRulesResponseTypeDef
# describe_aggregate_compliance_by_config_rules method usage example with argument unpacking

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

parent.describe_aggregate_compliance_by_config_rules(**kwargs)
  1. See DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef

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

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

kwargs: DescribeAggregationAuthorizationsRequestRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.describe_aggregation_authorizations(**kwargs)
  1. See DescribeAggregationAuthorizationsRequestRequestTypeDef

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)
    ...
  1. See ComplianceTypeType
  2. See DescribeComplianceByConfigRuleResponseTypeDef
# describe_compliance_by_config_rule method usage example with argument unpacking

kwargs: DescribeComplianceByConfigRuleRequestRequestTypeDef = {  # (1)
    "ConfigRuleNames": ...,
}

parent.describe_compliance_by_config_rule(**kwargs)
  1. See DescribeComplianceByConfigRuleRequestRequestTypeDef

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)
    ...
  1. See ComplianceTypeType
  2. See DescribeComplianceByResourceResponseTypeDef
# describe_compliance_by_resource method usage example with argument unpacking

kwargs: DescribeComplianceByResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
}

parent.describe_compliance_by_resource(**kwargs)
  1. See DescribeComplianceByResourceRequestRequestTypeDef

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

kwargs: DescribeConfigRuleEvaluationStatusRequestRequestTypeDef = {  # (1)
    "ConfigRuleNames": ...,
}

parent.describe_config_rule_evaluation_status(**kwargs)
  1. See DescribeConfigRuleEvaluationStatusRequestRequestTypeDef

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)
    ...
  1. See DescribeConfigRulesFiltersTypeDef
  2. See DescribeConfigRulesResponseTypeDef
# describe_config_rules method usage example with argument unpacking

kwargs: DescribeConfigRulesRequestRequestTypeDef = {  # (1)
    "ConfigRuleNames": ...,
}

parent.describe_config_rules(**kwargs)
  1. See DescribeConfigRulesRequestRequestTypeDef

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)
    ...
  1. See AggregatedSourceStatusTypeType
  2. See DescribeConfigurationAggregatorSourcesStatusResponseTypeDef
# describe_configuration_aggregator_sources_status method usage example with argument unpacking

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

parent.describe_configuration_aggregator_sources_status(**kwargs)
  1. See DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef

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

kwargs: DescribeConfigurationAggregatorsRequestRequestTypeDef = {  # (1)
    "ConfigurationAggregatorNames": ...,
}

parent.describe_configuration_aggregators(**kwargs)
  1. See DescribeConfigurationAggregatorsRequestRequestTypeDef

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

kwargs: DescribeConfigurationRecorderStatusRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorderNames": ...,
}

parent.describe_configuration_recorder_status(**kwargs)
  1. See DescribeConfigurationRecorderStatusRequestRequestTypeDef

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

kwargs: DescribeConfigurationRecordersRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorderNames": ...,
}

parent.describe_configuration_recorders(**kwargs)
  1. See DescribeConfigurationRecordersRequestRequestTypeDef

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)
    ...
  1. See ConformancePackComplianceFiltersTypeDef
  2. See DescribeConformancePackComplianceResponseTypeDef
# describe_conformance_pack_compliance method usage example with argument unpacking

kwargs: DescribeConformancePackComplianceRequestRequestTypeDef = {  # (1)
    "ConformancePackName": ...,
}

parent.describe_conformance_pack_compliance(**kwargs)
  1. See DescribeConformancePackComplianceRequestRequestTypeDef

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

kwargs: DescribeConformancePackStatusRequestRequestTypeDef = {  # (1)
    "ConformancePackNames": ...,
}

parent.describe_conformance_pack_status(**kwargs)
  1. See DescribeConformancePackStatusRequestRequestTypeDef

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

kwargs: DescribeConformancePacksRequestRequestTypeDef = {  # (1)
    "ConformancePackNames": ...,
}

parent.describe_conformance_packs(**kwargs)
  1. See DescribeConformancePacksRequestRequestTypeDef

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

kwargs: DescribeDeliveryChannelStatusRequestRequestTypeDef = {  # (1)
    "DeliveryChannelNames": ...,
}

parent.describe_delivery_channel_status(**kwargs)
  1. See DescribeDeliveryChannelStatusRequestRequestTypeDef

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

kwargs: DescribeDeliveryChannelsRequestRequestTypeDef = {  # (1)
    "DeliveryChannelNames": ...,
}

parent.describe_delivery_channels(**kwargs)
  1. See DescribeDeliveryChannelsRequestRequestTypeDef

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

kwargs: DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleNames": ...,
}

parent.describe_organization_config_rule_statuses(**kwargs)
  1. See DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef

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

kwargs: DescribeOrganizationConfigRulesRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleNames": ...,
}

parent.describe_organization_config_rules(**kwargs)
  1. See DescribeOrganizationConfigRulesRequestRequestTypeDef

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

kwargs: DescribeOrganizationConformancePackStatusesRequestRequestTypeDef = {  # (1)
    "OrganizationConformancePackNames": ...,
}

parent.describe_organization_conformance_pack_statuses(**kwargs)
  1. See DescribeOrganizationConformancePackStatusesRequestRequestTypeDef

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

kwargs: DescribeOrganizationConformancePacksRequestRequestTypeDef = {  # (1)
    "OrganizationConformancePackNames": ...,
}

parent.describe_organization_conformance_packs(**kwargs)
  1. See DescribeOrganizationConformancePacksRequestRequestTypeDef

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

kwargs: DescribePendingAggregationRequestsRequestRequestTypeDef = {  # (1)
    "Limit": ...,
}

parent.describe_pending_aggregation_requests(**kwargs)
  1. See DescribePendingAggregationRequestsRequestRequestTypeDef

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

kwargs: DescribeRemediationConfigurationsRequestRequestTypeDef = {  # (1)
    "ConfigRuleNames": ...,
}

parent.describe_remediation_configurations(**kwargs)
  1. See DescribeRemediationConfigurationsRequestRequestTypeDef

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)
    ...
  1. See RemediationExceptionResourceKeyTypeDef
  2. See DescribeRemediationExceptionsResponseTypeDef
# describe_remediation_exceptions method usage example with argument unpacking

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

parent.describe_remediation_exceptions(**kwargs)
  1. See DescribeRemediationExceptionsRequestRequestTypeDef

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

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

parent.describe_remediation_execution_status(**kwargs)
  1. See DescribeRemediationExecutionStatusRequestRequestTypeDef

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

kwargs: DescribeRetentionConfigurationsRequestRequestTypeDef = {  # (1)
    "RetentionConfigurationNames": ...,
}

parent.describe_retention_configurations(**kwargs)
  1. See DescribeRetentionConfigurationsRequestRequestTypeDef

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)
    ...
  1. See ComplianceTypeType
  2. See GetAggregateComplianceDetailsByConfigRuleResponseTypeDef
# 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)
  1. See GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef

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)
    ...
  1. See ConfigRuleComplianceSummaryFiltersTypeDef
  2. See ConfigRuleComplianceSummaryGroupKeyType
  3. 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)
  1. See GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef

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)
    ...
  1. See AggregateConformancePackComplianceSummaryFiltersTypeDef
  2. See AggregateConformancePackComplianceSummaryGroupKeyType
  3. 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)
  1. See GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef

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)
    ...
  1. See ResourceCountFiltersTypeDef
  2. See ResourceCountGroupKeyType
  3. See GetAggregateDiscoveredResourceCountsResponseTypeDef
# get_aggregate_discovered_resource_counts method usage example with argument unpacking

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

parent.get_aggregate_discovered_resource_counts(**kwargs)
  1. See GetAggregateDiscoveredResourceCountsRequestRequestTypeDef

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

kwargs: GetAggregateResourceConfigRequestRequestTypeDef = {  # (1)
    "ConfigurationAggregatorName": ...,
    "ResourceIdentifier": ...,
}

parent.get_aggregate_resource_config(**kwargs)
  1. See GetAggregateResourceConfigRequestRequestTypeDef

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)
    ...
  1. See ComplianceTypeType
  2. See GetComplianceDetailsByConfigRuleResponseTypeDef
# get_compliance_details_by_config_rule method usage example with argument unpacking

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

parent.get_compliance_details_by_config_rule(**kwargs)
  1. See GetComplianceDetailsByConfigRuleRequestRequestTypeDef

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)
    ...
  1. See ComplianceTypeType
  2. See GetComplianceDetailsByResourceResponseTypeDef
# get_compliance_details_by_resource method usage example with argument unpacking

kwargs: GetComplianceDetailsByResourceRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
}

parent.get_compliance_details_by_resource(**kwargs)
  1. See GetComplianceDetailsByResourceRequestRequestTypeDef

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

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

kwargs: GetComplianceSummaryByResourceTypeRequestRequestTypeDef = {  # (1)
    "ResourceTypes": ...,
}

parent.get_compliance_summary_by_resource_type(**kwargs)
  1. See GetComplianceSummaryByResourceTypeRequestRequestTypeDef

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)
    ...
  1. See ConformancePackEvaluationFiltersTypeDef
  2. See GetConformancePackComplianceDetailsResponseTypeDef
# get_conformance_pack_compliance_details method usage example with argument unpacking

kwargs: GetConformancePackComplianceDetailsRequestRequestTypeDef = {  # (1)
    "ConformancePackName": ...,
}

parent.get_conformance_pack_compliance_details(**kwargs)
  1. See GetConformancePackComplianceDetailsRequestRequestTypeDef

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

kwargs: GetConformancePackComplianceSummaryRequestRequestTypeDef = {  # (1)
    "ConformancePackNames": ...,
}

parent.get_conformance_pack_compliance_summary(**kwargs)
  1. See GetConformancePackComplianceSummaryRequestRequestTypeDef

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

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

parent.get_custom_rule_policy(**kwargs)
  1. See GetCustomRulePolicyRequestRequestTypeDef

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

kwargs: GetDiscoveredResourceCountsRequestRequestTypeDef = {  # (1)
    "resourceTypes": ...,
}

parent.get_discovered_resource_counts(**kwargs)
  1. See GetDiscoveredResourceCountsRequestRequestTypeDef

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)
    ...
  1. See StatusDetailFiltersTypeDef
  2. See GetOrganizationConfigRuleDetailedStatusResponseTypeDef
# get_organization_config_rule_detailed_status method usage example with argument unpacking

kwargs: GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleName": ...,
}

parent.get_organization_config_rule_detailed_status(**kwargs)
  1. See GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef

get_organization_conformance_pack_detailed_status#

Returns detailed status for each member account within an organization for a given organization conformance pack.

Type annotations and code completion for boto3.client("config").get_organization_conformance_pack_detailed_status method. boto3 documentation

# get_organization_conformance_pack_detailed_status method definition

def get_organization_conformance_pack_detailed_status(
    self,
    *,
    OrganizationConformancePackName: str,
    Filters: OrganizationResourceDetailedStatusFiltersTypeDef = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> GetOrganizationConformancePackDetailedStatusResponseTypeDef:  # (2)
    ...
  1. See OrganizationResourceDetailedStatusFiltersTypeDef
  2. See GetOrganizationConformancePackDetailedStatusResponseTypeDef
# get_organization_conformance_pack_detailed_status method usage example with argument unpacking

kwargs: GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef = {  # (1)
    "OrganizationConformancePackName": ...,
}

parent.get_organization_conformance_pack_detailed_status(**kwargs)
  1. See GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef

get_organization_custom_rule_policy#

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

Type annotations and code completion for boto3.client("config").get_organization_custom_rule_policy method. boto3 documentation

# get_organization_custom_rule_policy method definition

def get_organization_custom_rule_policy(
    self,
    *,
    OrganizationConfigRuleName: str,
) -> GetOrganizationCustomRulePolicyResponseTypeDef:  # (1)
    ...
  1. See GetOrganizationCustomRulePolicyResponseTypeDef
# get_organization_custom_rule_policy method usage example with argument unpacking

kwargs: GetOrganizationCustomRulePolicyRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleName": ...,
}

parent.get_organization_custom_rule_policy(**kwargs)
  1. See GetOrganizationCustomRulePolicyRequestRequestTypeDef

get_resource_config_history#

.

Type annotations and code completion for boto3.client("config").get_resource_config_history method. boto3 documentation

# get_resource_config_history method definition

def get_resource_config_history(
    self,
    *,
    resourceType: ResourceTypeType,  # (1)
    resourceId: str,
    laterTime: Union[datetime, str] = ...,
    earlierTime: Union[datetime, str] = ...,
    chronologicalOrder: ChronologicalOrderType = ...,  # (2)
    limit: int = ...,
    nextToken: str = ...,
) -> GetResourceConfigHistoryResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeType
  2. See ChronologicalOrderType
  3. See GetResourceConfigHistoryResponseTypeDef
# get_resource_config_history method usage example with argument unpacking

kwargs: GetResourceConfigHistoryRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
    "resourceId": ...,
}

parent.get_resource_config_history(**kwargs)
  1. See GetResourceConfigHistoryRequestRequestTypeDef

get_resource_evaluation_summary#

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.

Type annotations and code completion for boto3.client("config").get_resource_evaluation_summary method. boto3 documentation

# get_resource_evaluation_summary method definition

def get_resource_evaluation_summary(
    self,
    *,
    ResourceEvaluationId: str,
) -> GetResourceEvaluationSummaryResponseTypeDef:  # (1)
    ...
  1. See GetResourceEvaluationSummaryResponseTypeDef
# get_resource_evaluation_summary method usage example with argument unpacking

kwargs: GetResourceEvaluationSummaryRequestRequestTypeDef = {  # (1)
    "ResourceEvaluationId": ...,
}

parent.get_resource_evaluation_summary(**kwargs)
  1. See GetResourceEvaluationSummaryRequestRequestTypeDef

get_stored_query#

Returns the details of a specific stored query.

Type annotations and code completion for boto3.client("config").get_stored_query method. boto3 documentation

# get_stored_query method definition

def get_stored_query(
    self,
    *,
    QueryName: str,
) -> GetStoredQueryResponseTypeDef:  # (1)
    ...
  1. See GetStoredQueryResponseTypeDef
# get_stored_query method usage example with argument unpacking

kwargs: GetStoredQueryRequestRequestTypeDef = {  # (1)
    "QueryName": ...,
}

parent.get_stored_query(**kwargs)
  1. See GetStoredQueryRequestRequestTypeDef

list_aggregate_discovered_resources#

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.

Type annotations and code completion for boto3.client("config").list_aggregate_discovered_resources method. boto3 documentation

# list_aggregate_discovered_resources method definition

def list_aggregate_discovered_resources(
    self,
    *,
    ConfigurationAggregatorName: str,
    ResourceType: ResourceTypeType,  # (1)
    Filters: ResourceFiltersTypeDef = ...,  # (2)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListAggregateDiscoveredResourcesResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeType
  2. See ResourceFiltersTypeDef
  3. See ListAggregateDiscoveredResourcesResponseTypeDef
# list_aggregate_discovered_resources method usage example with argument unpacking

kwargs: ListAggregateDiscoveredResourcesRequestRequestTypeDef = {  # (1)
    "ConfigurationAggregatorName": ...,
    "ResourceType": ...,
}

parent.list_aggregate_discovered_resources(**kwargs)
  1. See ListAggregateDiscoveredResourcesRequestRequestTypeDef

list_conformance_pack_compliance_scores#

Returns a list of conformance pack compliance scores.

Type annotations and code completion for boto3.client("config").list_conformance_pack_compliance_scores method. boto3 documentation

# list_conformance_pack_compliance_scores method definition

def list_conformance_pack_compliance_scores(
    self,
    *,
    Filters: ConformancePackComplianceScoresFiltersTypeDef = ...,  # (1)
    SortOrder: SortOrderType = ...,  # (2)
    SortBy: SortByType = ...,  # (3)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListConformancePackComplianceScoresResponseTypeDef:  # (4)
    ...
  1. See ConformancePackComplianceScoresFiltersTypeDef
  2. See SortOrderType
  3. See SortByType
  4. See ListConformancePackComplianceScoresResponseTypeDef
# list_conformance_pack_compliance_scores method usage example with argument unpacking

kwargs: ListConformancePackComplianceScoresRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_conformance_pack_compliance_scores(**kwargs)
  1. See ListConformancePackComplianceScoresRequestRequestTypeDef

list_discovered_resources#

Accepts a resource type and returns a list of resource identifiers for the resources of that type.

Type annotations and code completion for boto3.client("config").list_discovered_resources method. boto3 documentation

# list_discovered_resources method definition

def list_discovered_resources(
    self,
    *,
    resourceType: ResourceTypeType,  # (1)
    resourceIds: Sequence[str] = ...,
    resourceName: str = ...,
    limit: int = ...,
    includeDeletedResources: bool = ...,
    nextToken: str = ...,
) -> ListDiscoveredResourcesResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See ListDiscoveredResourcesResponseTypeDef
# list_discovered_resources method usage example with argument unpacking

kwargs: ListDiscoveredResourcesRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
}

parent.list_discovered_resources(**kwargs)
  1. See ListDiscoveredResourcesRequestRequestTypeDef

list_resource_evaluations#

Returns a list of proactive resource evaluations.

Type annotations and code completion for boto3.client("config").list_resource_evaluations method. boto3 documentation

# list_resource_evaluations method definition

def list_resource_evaluations(
    self,
    *,
    Filters: ResourceEvaluationFiltersTypeDef = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> ListResourceEvaluationsResponseTypeDef:  # (2)
    ...
  1. See ResourceEvaluationFiltersTypeDef
  2. See ListResourceEvaluationsResponseTypeDef
# list_resource_evaluations method usage example with argument unpacking

kwargs: ListResourceEvaluationsRequestRequestTypeDef = {  # (1)
    "Filters": ...,
}

parent.list_resource_evaluations(**kwargs)
  1. See ListResourceEvaluationsRequestRequestTypeDef

list_stored_queries#

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.

Type annotations and code completion for boto3.client("config").list_stored_queries method. boto3 documentation

# list_stored_queries method definition

def list_stored_queries(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStoredQueriesResponseTypeDef:  # (1)
    ...
  1. See ListStoredQueriesResponseTypeDef
# list_stored_queries method usage example with argument unpacking

kwargs: ListStoredQueriesRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stored_queries(**kwargs)
  1. See ListStoredQueriesRequestRequestTypeDef

list_tags_for_resource#

List the tags for Config resource.

Type annotations and code completion for boto3.client("config").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

put_aggregation_authorization#

Authorizes the aggregator account and region to collect data from the source account and region.

Type annotations and code completion for boto3.client("config").put_aggregation_authorization method. boto3 documentation

# put_aggregation_authorization method definition

def put_aggregation_authorization(
    self,
    *,
    AuthorizedAccountId: str,
    AuthorizedAwsRegion: str,
    Tags: Sequence[TagTypeDef] = ...,  # (1)
) -> PutAggregationAuthorizationResponseTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See PutAggregationAuthorizationResponseTypeDef
# put_aggregation_authorization method usage example with argument unpacking

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

parent.put_aggregation_authorization(**kwargs)
  1. See PutAggregationAuthorizationRequestRequestTypeDef

put_config_rule#

Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.

Type annotations and code completion for boto3.client("config").put_config_rule method. boto3 documentation

# put_config_rule method definition

def put_config_rule(
    self,
    *,
    ConfigRule: Union[ConfigRuleTypeDef, ConfigRuleExtraOutputTypeDef],  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> EmptyResponseMetadataTypeDef:  # (3)
    ...
  1. See ConfigRuleTypeDef ConfigRuleExtraOutputTypeDef
  2. See TagTypeDef
  3. See EmptyResponseMetadataTypeDef
# put_config_rule method usage example with argument unpacking

kwargs: PutConfigRuleRequestRequestTypeDef = {  # (1)
    "ConfigRule": ...,
}

parent.put_config_rule(**kwargs)
  1. See PutConfigRuleRequestRequestTypeDef

put_configuration_aggregator#

Creates and updates the configuration aggregator with the selected source accounts and regions.

Type annotations and code completion for boto3.client("config").put_configuration_aggregator method. boto3 documentation

# put_configuration_aggregator method definition

def put_configuration_aggregator(
    self,
    *,
    ConfigurationAggregatorName: str,
    AccountAggregationSources: Sequence[Union[AccountAggregationSourceTypeDef, AccountAggregationSourceExtraOutputTypeDef]] = ...,  # (1)
    OrganizationAggregationSource: Union[OrganizationAggregationSourceTypeDef, OrganizationAggregationSourceExtraOutputTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> PutConfigurationAggregatorResponseTypeDef:  # (4)
    ...
  1. See AccountAggregationSourceTypeDef AccountAggregationSourceExtraOutputTypeDef
  2. See OrganizationAggregationSourceTypeDef OrganizationAggregationSourceExtraOutputTypeDef
  3. See TagTypeDef
  4. See PutConfigurationAggregatorResponseTypeDef
# put_configuration_aggregator method usage example with argument unpacking

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

parent.put_configuration_aggregator(**kwargs)
  1. See PutConfigurationAggregatorRequestRequestTypeDef

put_configuration_recorder#

Creates a new configuration recorder to record configuration changes for specified resource types.

Type annotations and code completion for boto3.client("config").put_configuration_recorder method. boto3 documentation

# put_configuration_recorder method definition

def put_configuration_recorder(
    self,
    *,
    ConfigurationRecorder: Union[ConfigurationRecorderTypeDef, ConfigurationRecorderOutputTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See ConfigurationRecorderTypeDef ConfigurationRecorderOutputTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_configuration_recorder method usage example with argument unpacking

kwargs: PutConfigurationRecorderRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorder": ...,
}

parent.put_configuration_recorder(**kwargs)
  1. See PutConfigurationRecorderRequestRequestTypeDef

put_conformance_pack#

Creates or updates a conformance pack.

Type annotations and code completion for boto3.client("config").put_conformance_pack method. boto3 documentation

# put_conformance_pack method definition

def put_conformance_pack(
    self,
    *,
    ConformancePackName: str,
    TemplateS3Uri: str = ...,
    TemplateBody: str = ...,
    DeliveryS3Bucket: str = ...,
    DeliveryS3KeyPrefix: str = ...,
    ConformancePackInputParameters: Sequence[ConformancePackInputParameterTypeDef] = ...,  # (1)
    TemplateSSMDocumentDetails: TemplateSSMDocumentDetailsTypeDef = ...,  # (2)
) -> PutConformancePackResponseTypeDef:  # (3)
    ...
  1. See ConformancePackInputParameterTypeDef
  2. See TemplateSSMDocumentDetailsTypeDef
  3. See PutConformancePackResponseTypeDef
# put_conformance_pack method usage example with argument unpacking

kwargs: PutConformancePackRequestRequestTypeDef = {  # (1)
    "ConformancePackName": ...,
}

parent.put_conformance_pack(**kwargs)
  1. See PutConformancePackRequestRequestTypeDef

put_delivery_channel#

Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.

Type annotations and code completion for boto3.client("config").put_delivery_channel method. boto3 documentation

# put_delivery_channel method definition

def put_delivery_channel(
    self,
    *,
    DeliveryChannel: DeliveryChannelTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See DeliveryChannelTypeDef
  2. See EmptyResponseMetadataTypeDef
# put_delivery_channel method usage example with argument unpacking

kwargs: PutDeliveryChannelRequestRequestTypeDef = {  # (1)
    "DeliveryChannel": ...,
}

parent.put_delivery_channel(**kwargs)
  1. See PutDeliveryChannelRequestRequestTypeDef

put_evaluations#

Used by an Lambda function to deliver evaluation results to Config.

Type annotations and code completion for boto3.client("config").put_evaluations method. boto3 documentation

# put_evaluations method definition

def put_evaluations(
    self,
    *,
    ResultToken: str,
    Evaluations: Sequence[Union[EvaluationTypeDef, EvaluationOutputTypeDef]] = ...,  # (1)
    TestMode: bool = ...,
) -> PutEvaluationsResponseTypeDef:  # (2)
    ...
  1. See EvaluationTypeDef EvaluationOutputTypeDef
  2. See PutEvaluationsResponseTypeDef
# put_evaluations method usage example with argument unpacking

kwargs: PutEvaluationsRequestRequestTypeDef = {  # (1)
    "ResultToken": ...,
}

parent.put_evaluations(**kwargs)
  1. See PutEvaluationsRequestRequestTypeDef

put_external_evaluation#

Add or updates the evaluations for process checks.

Type annotations and code completion for boto3.client("config").put_external_evaluation method. boto3 documentation

# put_external_evaluation method definition

def put_external_evaluation(
    self,
    *,
    ConfigRuleName: str,
    ExternalEvaluation: ExternalEvaluationTypeDef,  # (1)
) -> Dict[str, Any]:
    ...
  1. See ExternalEvaluationTypeDef
# put_external_evaluation method usage example with argument unpacking

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

parent.put_external_evaluation(**kwargs)
  1. See PutExternalEvaluationRequestRequestTypeDef

put_organization_config_rule#

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.

Type annotations and code completion for boto3.client("config").put_organization_config_rule method. boto3 documentation

# put_organization_config_rule method definition

def put_organization_config_rule(
    self,
    *,
    OrganizationConfigRuleName: str,
    OrganizationManagedRuleMetadata: Union[OrganizationManagedRuleMetadataTypeDef, OrganizationManagedRuleMetadataExtraOutputTypeDef] = ...,  # (1)
    OrganizationCustomRuleMetadata: Union[OrganizationCustomRuleMetadataTypeDef, OrganizationCustomRuleMetadataExtraOutputTypeDef] = ...,  # (2)
    ExcludedAccounts: Sequence[str] = ...,
    OrganizationCustomPolicyRuleMetadata: OrganizationCustomPolicyRuleMetadataTypeDef = ...,  # (3)
) -> PutOrganizationConfigRuleResponseTypeDef:  # (4)
    ...
  1. See OrganizationManagedRuleMetadataTypeDef OrganizationManagedRuleMetadataExtraOutputTypeDef
  2. See OrganizationCustomRuleMetadataTypeDef OrganizationCustomRuleMetadataExtraOutputTypeDef
  3. See OrganizationCustomPolicyRuleMetadataTypeDef
  4. See PutOrganizationConfigRuleResponseTypeDef
# put_organization_config_rule method usage example with argument unpacking

kwargs: PutOrganizationConfigRuleRequestRequestTypeDef = {  # (1)
    "OrganizationConfigRuleName": ...,
}

parent.put_organization_config_rule(**kwargs)
  1. See PutOrganizationConfigRuleRequestRequestTypeDef

put_organization_conformance_pack#

Deploys conformance packs across member accounts in an Amazon Web Services Organization.

Type annotations and code completion for boto3.client("config").put_organization_conformance_pack method. boto3 documentation

# put_organization_conformance_pack method definition

def put_organization_conformance_pack(
    self,
    *,
    OrganizationConformancePackName: str,
    TemplateS3Uri: str = ...,
    TemplateBody: str = ...,
    DeliveryS3Bucket: str = ...,
    DeliveryS3KeyPrefix: str = ...,
    ConformancePackInputParameters: Sequence[ConformancePackInputParameterTypeDef] = ...,  # (1)
    ExcludedAccounts: Sequence[str] = ...,
) -> PutOrganizationConformancePackResponseTypeDef:  # (2)
    ...
  1. See ConformancePackInputParameterTypeDef
  2. See PutOrganizationConformancePackResponseTypeDef
# put_organization_conformance_pack method usage example with argument unpacking

kwargs: PutOrganizationConformancePackRequestRequestTypeDef = {  # (1)
    "OrganizationConformancePackName": ...,
}

parent.put_organization_conformance_pack(**kwargs)
  1. See PutOrganizationConformancePackRequestRequestTypeDef

put_remediation_configurations#

Adds or updates the remediation configuration with a specific Config rule with the selected target or action.

Type annotations and code completion for boto3.client("config").put_remediation_configurations method. boto3 documentation

# put_remediation_configurations method definition

def put_remediation_configurations(
    self,
    *,
    RemediationConfigurations: Sequence[Union[RemediationConfigurationTypeDef, RemediationConfigurationOutputTypeDef]],  # (1)
) -> PutRemediationConfigurationsResponseTypeDef:  # (2)
    ...
  1. See RemediationConfigurationTypeDef RemediationConfigurationOutputTypeDef
  2. See PutRemediationConfigurationsResponseTypeDef
# put_remediation_configurations method usage example with argument unpacking

kwargs: PutRemediationConfigurationsRequestRequestTypeDef = {  # (1)
    "RemediationConfigurations": ...,
}

parent.put_remediation_configurations(**kwargs)
  1. See PutRemediationConfigurationsRequestRequestTypeDef

put_remediation_exceptions#

A remediation exception is when a specified resource is no longer considered for auto-remediation.

Type annotations and code completion for boto3.client("config").put_remediation_exceptions method. boto3 documentation

# put_remediation_exceptions method definition

def put_remediation_exceptions(
    self,
    *,
    ConfigRuleName: str,
    ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef],  # (1)
    Message: str = ...,
    ExpirationTime: Union[datetime, str] = ...,
) -> PutRemediationExceptionsResponseTypeDef:  # (2)
    ...
  1. See RemediationExceptionResourceKeyTypeDef
  2. See PutRemediationExceptionsResponseTypeDef
# put_remediation_exceptions method usage example with argument unpacking

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

parent.put_remediation_exceptions(**kwargs)
  1. See PutRemediationExceptionsRequestRequestTypeDef

put_resource_config#

Records the configuration state for the resource provided in the request.

Type annotations and code completion for boto3.client("config").put_resource_config method. boto3 documentation

# put_resource_config method definition

def put_resource_config(
    self,
    *,
    ResourceType: str,
    SchemaVersionId: str,
    ResourceId: str,
    Configuration: str,
    ResourceName: str = ...,
    Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# put_resource_config method usage example with argument unpacking

kwargs: PutResourceConfigRequestRequestTypeDef = {  # (1)
    "ResourceType": ...,
    "SchemaVersionId": ...,
    "ResourceId": ...,
    "Configuration": ...,
}

parent.put_resource_config(**kwargs)
  1. See PutResourceConfigRequestRequestTypeDef

put_retention_configuration#

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.

Type annotations and code completion for boto3.client("config").put_retention_configuration method. boto3 documentation

# put_retention_configuration method definition

def put_retention_configuration(
    self,
    *,
    RetentionPeriodInDays: int,
) -> PutRetentionConfigurationResponseTypeDef:  # (1)
    ...
  1. See PutRetentionConfigurationResponseTypeDef
# put_retention_configuration method usage example with argument unpacking

kwargs: PutRetentionConfigurationRequestRequestTypeDef = {  # (1)
    "RetentionPeriodInDays": ...,
}

parent.put_retention_configuration(**kwargs)
  1. See PutRetentionConfigurationRequestRequestTypeDef

put_stored_query#

Saves a new query or updates an existing saved query.

Type annotations and code completion for boto3.client("config").put_stored_query method. boto3 documentation

# put_stored_query method definition

def put_stored_query(
    self,
    *,
    StoredQuery: StoredQueryTypeDef,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> PutStoredQueryResponseTypeDef:  # (3)
    ...
  1. See StoredQueryTypeDef
  2. See TagTypeDef
  3. See PutStoredQueryResponseTypeDef
# put_stored_query method usage example with argument unpacking

kwargs: PutStoredQueryRequestRequestTypeDef = {  # (1)
    "StoredQuery": ...,
}

parent.put_stored_query(**kwargs)
  1. See PutStoredQueryRequestRequestTypeDef

select_aggregate_resource_config#

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.

Type annotations and code completion for boto3.client("config").select_aggregate_resource_config method. boto3 documentation

# select_aggregate_resource_config method definition

def select_aggregate_resource_config(
    self,
    *,
    Expression: str,
    ConfigurationAggregatorName: str,
    Limit: int = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> SelectAggregateResourceConfigResponseTypeDef:  # (1)
    ...
  1. See SelectAggregateResourceConfigResponseTypeDef
# select_aggregate_resource_config method usage example with argument unpacking

kwargs: SelectAggregateResourceConfigRequestRequestTypeDef = {  # (1)
    "Expression": ...,
    "ConfigurationAggregatorName": ...,
}

parent.select_aggregate_resource_config(**kwargs)
  1. See SelectAggregateResourceConfigRequestRequestTypeDef

select_resource_config#

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

Type annotations and code completion for boto3.client("config").select_resource_config method. boto3 documentation

# select_resource_config method definition

def select_resource_config(
    self,
    *,
    Expression: str,
    Limit: int = ...,
    NextToken: str = ...,
) -> SelectResourceConfigResponseTypeDef:  # (1)
    ...
  1. See SelectResourceConfigResponseTypeDef
# select_resource_config method usage example with argument unpacking

kwargs: SelectResourceConfigRequestRequestTypeDef = {  # (1)
    "Expression": ...,
}

parent.select_resource_config(**kwargs)
  1. See SelectResourceConfigRequestRequestTypeDef

start_config_rules_evaluation#

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.

Type annotations and code completion for boto3.client("config").start_config_rules_evaluation method. boto3 documentation

# start_config_rules_evaluation method definition

def start_config_rules_evaluation(
    self,
    *,
    ConfigRuleNames: Sequence[str] = ...,
) -> Dict[str, Any]:
    ...
# start_config_rules_evaluation method usage example with argument unpacking

kwargs: StartConfigRulesEvaluationRequestRequestTypeDef = {  # (1)
    "ConfigRuleNames": ...,
}

parent.start_config_rules_evaluation(**kwargs)
  1. See StartConfigRulesEvaluationRequestRequestTypeDef

start_configuration_recorder#

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Type annotations and code completion for boto3.client("config").start_configuration_recorder method. boto3 documentation

# start_configuration_recorder method definition

def start_configuration_recorder(
    self,
    *,
    ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# start_configuration_recorder method usage example with argument unpacking

kwargs: StartConfigurationRecorderRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorderName": ...,
}

parent.start_configuration_recorder(**kwargs)
  1. See StartConfigurationRecorderRequestRequestTypeDef

start_remediation_execution#

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.

Type annotations and code completion for boto3.client("config").start_remediation_execution method. boto3 documentation

# start_remediation_execution method definition

def start_remediation_execution(
    self,
    *,
    ConfigRuleName: str,
    ResourceKeys: Sequence[ResourceKeyTypeDef],  # (1)
) -> StartRemediationExecutionResponseTypeDef:  # (2)
    ...
  1. See ResourceKeyTypeDef
  2. See StartRemediationExecutionResponseTypeDef
# start_remediation_execution method usage example with argument unpacking

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

parent.start_remediation_execution(**kwargs)
  1. See StartRemediationExecutionRequestRequestTypeDef

start_resource_evaluation#

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.

Type annotations and code completion for boto3.client("config").start_resource_evaluation method. boto3 documentation

# start_resource_evaluation method definition

def start_resource_evaluation(
    self,
    *,
    ResourceDetails: ResourceDetailsTypeDef,  # (1)
    EvaluationMode: EvaluationModeType,  # (2)
    EvaluationContext: EvaluationContextTypeDef = ...,  # (3)
    EvaluationTimeout: int = ...,
    ClientToken: str = ...,
) -> StartResourceEvaluationResponseTypeDef:  # (4)
    ...
  1. See ResourceDetailsTypeDef
  2. See EvaluationModeType
  3. See EvaluationContextTypeDef
  4. See StartResourceEvaluationResponseTypeDef
# start_resource_evaluation method usage example with argument unpacking

kwargs: StartResourceEvaluationRequestRequestTypeDef = {  # (1)
    "ResourceDetails": ...,
    "EvaluationMode": ...,
}

parent.start_resource_evaluation(**kwargs)
  1. See StartResourceEvaluationRequestRequestTypeDef

stop_configuration_recorder#

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Type annotations and code completion for boto3.client("config").stop_configuration_recorder method. boto3 documentation

# stop_configuration_recorder method definition

def stop_configuration_recorder(
    self,
    *,
    ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# stop_configuration_recorder method usage example with argument unpacking

kwargs: StopConfigurationRecorderRequestRequestTypeDef = {  # (1)
    "ConfigurationRecorderName": ...,
}

parent.stop_configuration_recorder(**kwargs)
  1. See StopConfigurationRecorderRequestRequestTypeDef

tag_resource#

Associates the specified tags to a resource with the specified resourceArn.

Type annotations and code completion for boto3.client("config").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See TagTypeDef
  2. See EmptyResponseMetadataTypeDef
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Deletes specified tags from a resource.

Type annotations and code completion for boto3.client("config").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("config").get_paginator method with overloads.