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

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.

Usage example

client = boto3.client("config")

try:
    do_something(client)
except (
    client.ClientError,
    client.ConformancePackTemplateValidationException,
    client.InsufficientDeliveryPolicyException,
    client.InsufficientPermissionsException,
    client.InvalidConfigurationRecorderNameException,
    client.InvalidDeliveryChannelNameException,
    client.InvalidExpressionException,
    client.InvalidLimitException,
    client.InvalidNextTokenException,
    client.InvalidParameterValueException,
    client.InvalidRecordingGroupException,
    client.InvalidResultTokenException,
    client.InvalidRoleException,
    client.InvalidS3KeyPrefixException,
    client.InvalidS3KmsKeyArnException,
    client.InvalidSNSTopicARNException,
    client.InvalidTimeRangeException,
    client.LastDeliveryChannelDeleteFailedException,
    client.LimitExceededException,
    client.MaxActiveResourcesExceededException,
    client.MaxNumberOfConfigRulesExceededException,
    client.MaxNumberOfConfigurationRecordersExceededException,
    client.MaxNumberOfConformancePacksExceededException,
    client.MaxNumberOfDeliveryChannelsExceededException,
    client.MaxNumberOfOrganizationConfigRulesExceededException,
    client.MaxNumberOfOrganizationConformancePacksExceededException,
    client.MaxNumberOfRetentionConfigurationsExceededException,
    client.NoAvailableConfigurationRecorderException,
    client.NoAvailableDeliveryChannelException,
    client.NoAvailableOrganizationException,
    client.NoRunningConfigurationRecorderException,
    client.NoSuchBucketException,
    client.NoSuchConfigRuleException,
    client.NoSuchConfigRuleInConformancePackException,
    client.NoSuchConfigurationAggregatorException,
    client.NoSuchConfigurationRecorderException,
    client.NoSuchConformancePackException,
    client.NoSuchDeliveryChannelException,
    client.NoSuchOrganizationConfigRuleException,
    client.NoSuchOrganizationConformancePackException,
    client.NoSuchRemediationConfigurationException,
    client.NoSuchRemediationExceptionException,
    client.NoSuchRetentionConfigurationException,
    client.OrganizationAccessDeniedException,
    client.OrganizationAllFeaturesNotEnabledException,
    client.OrganizationConformancePackTemplateValidationException,
    client.OversizedConfigurationItemException,
    client.RemediationInProgressException,
    client.ResourceConcurrentModificationException,
    client.ResourceInUseException,
    client.ResourceNotDiscoveredException,
    client.ResourceNotFoundException,
    client.TooManyTagsException,
    client.ValidationException,
) as e:
    print(e)

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

Method definition

def batch_get_aggregate_resource_config(
    self,
    *,
    ConfigurationAggregatorName: str,
    ResourceIdentifiers: Sequence[AggregateResourceIdentifierTypeDef],  # (1)
) -> BatchGetAggregateResourceConfigResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.batch_get_aggregate_resource_config(**kwargs)

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

Method definition

def batch_get_resource_config(
    self,
    *,
    resourceKeys: Sequence[ResourceKeyTypeDef],  # (1)
) -> BatchGetResourceConfigResponseTypeDef:  # (2)
    ...

See ResourceKeyTypeDef
See BatchGetResourceConfigResponseTypeDef

Usage example with kwargs

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

parent.batch_get_resource_config(**kwargs)

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

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

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

Method definition

def delete_aggregation_authorization(
    self,
    *,
    AuthorizedAccountId: str,
    AuthorizedAwsRegion: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_aggregation_authorization(**kwargs)

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

Method definition

def delete_config_rule(
    self,
    *,
    ConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_config_rule(**kwargs)

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

Method definition

def delete_configuration_aggregator(
    self,
    *,
    ConfigurationAggregatorName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_configuration_aggregator(**kwargs)

See DeleteConfigurationAggregatorRequestRequestTypeDef

delete_configuration_recorder

Deletes the configuration recorder.

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

Method definition

def delete_configuration_recorder(
    self,
    *,
    ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_configuration_recorder(**kwargs)

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

Method definition

def delete_conformance_pack(
    self,
    *,
    ConformancePackName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_conformance_pack(**kwargs)

See DeleteConformancePackRequestRequestTypeDef

delete_delivery_channel

Deletes the delivery channel.

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

Method definition

def delete_delivery_channel(
    self,
    *,
    DeliveryChannelName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_delivery_channel(**kwargs)

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

Method definition

def delete_evaluation_results(
    self,
    *,
    ConfigRuleName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_evaluation_results(**kwargs)

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

Method definition

def delete_organization_config_rule(
    self,
    *,
    OrganizationConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_organization_config_rule(**kwargs)

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

Method definition

def delete_organization_conformance_pack(
    self,
    *,
    OrganizationConformancePackName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_organization_conformance_pack(**kwargs)

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

Method definition

def delete_pending_aggregation_request(
    self,
    *,
    RequesterAccountId: str,
    RequesterAwsRegion: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_pending_aggregation_request(**kwargs)

See DeletePendingAggregationRequestRequestRequestTypeDef

delete_remediation_configuration

Deletes the remediation configuration.

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

Method definition

def delete_remediation_configuration(
    self,
    *,
    ConfigRuleName: str,
    ResourceType: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_remediation_configuration(**kwargs)

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

Method definition

def delete_remediation_exceptions(
    self,
    *,
    ConfigRuleName: str,
    ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef],  # (1)
) -> DeleteRemediationExceptionsResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.delete_remediation_exceptions(**kwargs)

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

Method definition

def delete_resource_config(
    self,
    *,
    ResourceType: str,
    ResourceId: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_resource_config(**kwargs)

See DeleteResourceConfigRequestRequestTypeDef

delete_retention_configuration

Deletes the retention configuration.

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

Method definition

def delete_retention_configuration(
    self,
    *,
    RetentionConfigurationName: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

See EmptyResponseMetadataTypeDef

Usage example with kwargs

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

parent.delete_retention_configuration(**kwargs)

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

Method definition

def delete_stored_query(
    self,
    *,
    QueryName: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_stored_query(**kwargs)

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

Method definition

def deliver_config_snapshot(
    self,
    *,
    deliveryChannelName: str,
) -> DeliverConfigSnapshotResponseTypeDef:  # (1)
    ...

See DeliverConfigSnapshotResponseTypeDef

Usage example with kwargs

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

parent.deliver_config_snapshot(**kwargs)

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

Method definition

def describe_aggregate_compliance_by_config_rules(
    self,
    *,
    ConfigurationAggregatorName: str,
    Filters: ConfigRuleComplianceFiltersTypeDef = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeAggregateComplianceByConfigRulesResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_aggregate_compliance_by_config_rules(**kwargs)

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

Method definition

def describe_aggregate_compliance_by_conformance_packs(
    self,
    *,
    ConfigurationAggregatorName: str,
    Filters: AggregateConformancePackComplianceFiltersTypeDef = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeAggregateComplianceByConformancePacksResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_aggregate_compliance_by_conformance_packs(**kwargs)

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

Method definition

def describe_aggregation_authorizations(
    self,
    *,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeAggregationAuthorizationsResponseTypeDef:  # (1)
    ...

See DescribeAggregationAuthorizationsResponseTypeDef

Usage example with kwargs

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

parent.describe_aggregation_authorizations(**kwargs)

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

Method definition

def describe_compliance_by_config_rule(
    self,
    *,
    ConfigRuleNames: Sequence[str] = ...,
    ComplianceTypes: Sequence[ComplianceTypeType] = ...,  # (1)
    NextToken: str = ...,
) -> DescribeComplianceByConfigRuleResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_compliance_by_config_rule(**kwargs)

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

Method definition

def describe_compliance_by_resource(
    self,
    *,
    ResourceType: str = ...,
    ResourceId: str = ...,
    ComplianceTypes: Sequence[ComplianceTypeType] = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeComplianceByResourceResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_compliance_by_resource(**kwargs)

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

Method definition

def describe_config_rule_evaluation_status(
    self,
    *,
    ConfigRuleNames: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeConfigRuleEvaluationStatusResponseTypeDef:  # (1)
    ...

See DescribeConfigRuleEvaluationStatusResponseTypeDef

Usage example with kwargs

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

parent.describe_config_rule_evaluation_status(**kwargs)

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

Method definition

def describe_config_rules(
    self,
    *,
    ConfigRuleNames: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeConfigRulesResponseTypeDef:  # (1)
    ...

See DescribeConfigRulesResponseTypeDef

Usage example with kwargs

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

parent.describe_config_rules(**kwargs)

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

Method definition

def describe_configuration_aggregator_sources_status(
    self,
    *,
    ConfigurationAggregatorName: str,
    UpdateStatus: Sequence[AggregatedSourceStatusTypeType] = ...,  # (1)
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeConfigurationAggregatorSourcesStatusResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_configuration_aggregator_sources_status(**kwargs)

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

Method definition

def describe_configuration_aggregators(
    self,
    *,
    ConfigurationAggregatorNames: Sequence[str] = ...,
    NextToken: str = ...,
    Limit: int = ...,
) -> DescribeConfigurationAggregatorsResponseTypeDef:  # (1)
    ...

See DescribeConfigurationAggregatorsResponseTypeDef

Usage example with kwargs

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

parent.describe_configuration_aggregators(**kwargs)

See DescribeConfigurationAggregatorsRequestRequestTypeDef

describe_configuration_recorder_status

Returns the current status of the specified configuration recorder.

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

Method definition

def describe_configuration_recorder_status(
    self,
    *,
    ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecorderStatusResponseTypeDef:  # (1)
    ...

See DescribeConfigurationRecorderStatusResponseTypeDef

Usage example with kwargs

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

parent.describe_configuration_recorder_status(**kwargs)

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

Method definition

def describe_configuration_recorders(
    self,
    *,
    ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecordersResponseTypeDef:  # (1)
    ...

See DescribeConfigurationRecordersResponseTypeDef

Usage example with kwargs

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

parent.describe_configuration_recorders(**kwargs)

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

Method definition

def describe_conformance_pack_compliance(
    self,
    *,
    ConformancePackName: str,
    Filters: ConformancePackComplianceFiltersTypeDef = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeConformancePackComplianceResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_conformance_pack_compliance(**kwargs)

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

Method definition

def describe_conformance_pack_status(
    self,
    *,
    ConformancePackNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeConformancePackStatusResponseTypeDef:  # (1)
    ...

See DescribeConformancePackStatusResponseTypeDef

Usage example with kwargs

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

parent.describe_conformance_pack_status(**kwargs)

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

Method definition

def describe_conformance_packs(
    self,
    *,
    ConformancePackNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeConformancePacksResponseTypeDef:  # (1)
    ...

See DescribeConformancePacksResponseTypeDef

Usage example with kwargs

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

parent.describe_conformance_packs(**kwargs)

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

Method definition

def describe_delivery_channel_status(
    self,
    *,
    DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelStatusResponseTypeDef:  # (1)
    ...

See DescribeDeliveryChannelStatusResponseTypeDef

Usage example with kwargs

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

parent.describe_delivery_channel_status(**kwargs)

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

Method definition

def describe_delivery_channels(
    self,
    *,
    DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelsResponseTypeDef:  # (1)
    ...

See DescribeDeliveryChannelsResponseTypeDef

Usage example with kwargs

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

parent.describe_delivery_channels(**kwargs)

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

Method definition

def describe_organization_config_rule_statuses(
    self,
    *,
    OrganizationConfigRuleNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeOrganizationConfigRuleStatusesResponseTypeDef:  # (1)
    ...

See DescribeOrganizationConfigRuleStatusesResponseTypeDef

Usage example with kwargs

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

parent.describe_organization_config_rule_statuses(**kwargs)

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

Method definition

def describe_organization_config_rules(
    self,
    *,
    OrganizationConfigRuleNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeOrganizationConfigRulesResponseTypeDef:  # (1)
    ...

See DescribeOrganizationConfigRulesResponseTypeDef

Usage example with kwargs

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

parent.describe_organization_config_rules(**kwargs)

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

Method definition

def describe_organization_conformance_pack_statuses(
    self,
    *,
    OrganizationConformancePackNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeOrganizationConformancePackStatusesResponseTypeDef:  # (1)
    ...

See DescribeOrganizationConformancePackStatusesResponseTypeDef

Usage example with kwargs

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

parent.describe_organization_conformance_pack_statuses(**kwargs)

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

Method definition

def describe_organization_conformance_packs(
    self,
    *,
    OrganizationConformancePackNames: Sequence[str] = ...,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeOrganizationConformancePacksResponseTypeDef:  # (1)
    ...

See DescribeOrganizationConformancePacksResponseTypeDef

Usage example with kwargs

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

parent.describe_organization_conformance_packs(**kwargs)

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

Method definition

def describe_pending_aggregation_requests(
    self,
    *,
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribePendingAggregationRequestsResponseTypeDef:  # (1)
    ...

See DescribePendingAggregationRequestsResponseTypeDef

Usage example with kwargs

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

parent.describe_pending_aggregation_requests(**kwargs)

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

Method definition

def describe_remediation_configurations(
    self,
    *,
    ConfigRuleNames: Sequence[str],
) -> DescribeRemediationConfigurationsResponseTypeDef:  # (1)
    ...

See DescribeRemediationConfigurationsResponseTypeDef

Usage example with kwargs

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

parent.describe_remediation_configurations(**kwargs)

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

Method definition

def describe_remediation_exceptions(
    self,
    *,
    ConfigRuleName: str,
    ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef] = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeRemediationExceptionsResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_remediation_exceptions(**kwargs)

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

Method definition

def describe_remediation_execution_status(
    self,
    *,
    ConfigRuleName: str,
    ResourceKeys: Sequence[ResourceKeyTypeDef] = ...,  # (1)
    Limit: int = ...,
    NextToken: str = ...,
) -> DescribeRemediationExecutionStatusResponseTypeDef:  # (2)
    ...

Usage example with kwargs

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

parent.describe_remediation_execution_status(**kwargs)

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

Method definition

def describe_retention_configurations(
    self,
    *,
    RetentionConfigurationNames: Sequence[str] = ...,
    NextToken: str = ...,
) -> DescribeRetentionConfigurationsResponseTypeDef:  # (1)
    ...

See DescribeRetentionConfigurationsResponseTypeDef

Usage example with kwargs

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

parent.describe_retention_configurations(**kwargs)

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

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

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

Usage example with kwargs

kwargs: GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef = {  # (1)
    "ConfigurationAggregatorName": ...,
    "ConfigRuleName": ...,
    "AccountId": ...,
    "AwsRegion": ...,
}

parent.get_aggregate_compliance_details_by_config_rule(**kwargs)

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

Method definition

def get_aggregate_config_rule_compliance_summary(
    self,
    *,
    ConfigurationAggregatorName: str,
    Filters: ConfigRuleComplianceSummaryFiltersTypeDef = ...,  # (1)
    GroupByKey: ConfigRuleComplianceSummaryGroupKeyType = ...,  # (2)
    Limit: int = ...,
    NextToken: str = ...,
) -> GetAggregateConfigRuleComplianceSummaryResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.get_aggregate_config_rule_compliance_summary(**kwargs)

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

Method definition

def get_aggregate_conformance_pack_compliance_summary(
    self,
    *,
    ConfigurationAggregatorName: str,
    Filters: AggregateConformancePackComplianceSummaryFiltersTypeDef = ...,  # (1)
    GroupByKey: AggregateConformancePackComplianceSummaryGroupKeyType = ...,  # (2)
    Limit: int = ...,
    NextToken: str = ...,
) -> GetAggregateConformancePackComplianceSummaryResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.get_aggregate_conformance_pack_compliance_summary(**kwargs)

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

Method definition

def get_aggregate_discovered_resource_counts(
    self,
    *,
    ConfigurationAggregatorName: str,
    Filters: ResourceCountFiltersTypeDef = ...,  # (1)
    GroupByKey: ResourceCountGroupKeyType = ...,  # (2)
    Limit: int = ...,
    NextToken: str = ...,
) -> GetAggregateDiscoveredResourceCountsResponseTypeDef:  # (3)
    ...

Usage example with kwargs

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

parent.get_aggregate_discovered_resource_counts(**kwargs)

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

Method definition

def get_aggregate_resource_config(
    self,
    *,
    ConfigurationAggregatorName: