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
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.
client = boto3.client("config")
try:
do_something(client)
except (
client.ClientError,
client.ConformancePackTemplateValidationException,
client.IdempotentParameterMismatch,
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)
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
def batch_get_aggregate_resource_config(
self,
*,
ConfigurationAggregatorName: str,
ResourceIdentifiers: Sequence[AggregateResourceIdentifierTypeDef], # (1)
) -> BatchGetAggregateResourceConfigResponseTypeDef: # (2)
...
kwargs: BatchGetAggregateResourceConfigRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ResourceIdentifiers": ...,
}
parent.batch_get_aggregate_resource_config(**kwargs)
batch_get_resource_config
Returns the BaseConfigurationItem
for one or more requested resources.
Type annotations and code completion for boto3.client("config").batch_get_resource_config
method.
boto3 documentation
def batch_get_resource_config(
self,
*,
resourceKeys: Sequence[ResourceKeyTypeDef], # (1)
) -> BatchGetResourceConfigResponseTypeDef: # (2)
...
kwargs: BatchGetResourceConfigRequestRequestTypeDef = { # (1)
"resourceKeys": ...,
}
parent.batch_get_resource_config(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("config").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("config").close
method.
boto3 documentation
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
def delete_aggregation_authorization(
self,
*,
AuthorizedAccountId: str,
AuthorizedAwsRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteAggregationAuthorizationRequestRequestTypeDef = { # (1)
"AuthorizedAccountId": ...,
"AuthorizedAwsRegion": ...,
}
parent.delete_aggregation_authorization(**kwargs)
delete_config_rule
Deletes the specified Config rule and all of its evaluation results.
Type annotations and code completion for boto3.client("config").delete_config_rule
method.
boto3 documentation
def delete_config_rule(
self,
*,
ConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_config_rule(**kwargs)
delete_configuration_aggregator
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
Type annotations and code completion for boto3.client("config").delete_configuration_aggregator
method.
boto3 documentation
def delete_configuration_aggregator(
self,
*,
ConfigurationAggregatorName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConfigurationAggregatorRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.delete_configuration_aggregator(**kwargs)
delete_configuration_recorder
Deletes the configuration recorder.
Type annotations and code completion for boto3.client("config").delete_configuration_recorder
method.
boto3 documentation
def delete_configuration_recorder(
self,
*,
ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConfigurationRecorderRequestRequestTypeDef = { # (1)
"ConfigurationRecorderName": ...,
}
parent.delete_configuration_recorder(**kwargs)
delete_conformance_pack
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Type annotations and code completion for boto3.client("config").delete_conformance_pack
method.
boto3 documentation
def delete_conformance_pack(
self,
*,
ConformancePackName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteConformancePackRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.delete_conformance_pack(**kwargs)
delete_delivery_channel
Deletes the delivery channel.
Type annotations and code completion for boto3.client("config").delete_delivery_channel
method.
boto3 documentation
def delete_delivery_channel(
self,
*,
DeliveryChannelName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteDeliveryChannelRequestRequestTypeDef = { # (1)
"DeliveryChannelName": ...,
}
parent.delete_delivery_channel(**kwargs)
delete_evaluation_results
Deletes the evaluation results for the specified Config rule.
Type annotations and code completion for boto3.client("config").delete_evaluation_results
method.
boto3 documentation
def delete_evaluation_results(
self,
*,
ConfigRuleName: str,
) -> Dict[str, Any]:
...
kwargs: DeleteEvaluationResultsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_evaluation_results(**kwargs)
delete_organization_config_rule
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Type annotations and code completion for boto3.client("config").delete_organization_config_rule
method.
boto3 documentation
def delete_organization_config_rule(
self,
*,
OrganizationConfigRuleName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteOrganizationConfigRuleRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.delete_organization_config_rule(**kwargs)
delete_organization_conformance_pack
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Type annotations and code completion for boto3.client("config").delete_organization_conformance_pack
method.
boto3 documentation
def delete_organization_conformance_pack(
self,
*,
OrganizationConformancePackName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteOrganizationConformancePackRequestRequestTypeDef = { # (1)
"OrganizationConformancePackName": ...,
}
parent.delete_organization_conformance_pack(**kwargs)
delete_pending_aggregation_request
Deletes pending authorization requests for a specified aggregator account in a specified region.
Type annotations and code completion for boto3.client("config").delete_pending_aggregation_request
method.
boto3 documentation
def delete_pending_aggregation_request(
self,
*,
RequesterAccountId: str,
RequesterAwsRegion: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeletePendingAggregationRequestRequestRequestTypeDef = { # (1)
"RequesterAccountId": ...,
"RequesterAwsRegion": ...,
}
parent.delete_pending_aggregation_request(**kwargs)
delete_remediation_configuration
Deletes the remediation configuration.
Type annotations and code completion for boto3.client("config").delete_remediation_configuration
method.
boto3 documentation
def delete_remediation_configuration(
self,
*,
ConfigRuleName: str,
ResourceType: str = ...,
) -> Dict[str, Any]:
...
kwargs: DeleteRemediationConfigurationRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.delete_remediation_configuration(**kwargs)
delete_remediation_exceptions
Deletes one or more remediation exceptions mentioned in the resource keys.
Type annotations and code completion for boto3.client("config").delete_remediation_exceptions
method.
boto3 documentation
def delete_remediation_exceptions(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef], # (1)
) -> DeleteRemediationExceptionsResponseTypeDef: # (2)
...
kwargs: DeleteRemediationExceptionsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
"ResourceKeys": ...,
}
parent.delete_remediation_exceptions(**kwargs)
delete_resource_config
Records the configuration state for a custom resource that has been deleted.
Type annotations and code completion for boto3.client("config").delete_resource_config
method.
boto3 documentation
def delete_resource_config(
self,
*,
ResourceType: str,
ResourceId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteResourceConfigRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"ResourceId": ...,
}
parent.delete_resource_config(**kwargs)
delete_retention_configuration
Deletes the retention configuration.
Type annotations and code completion for boto3.client("config").delete_retention_configuration
method.
boto3 documentation
def delete_retention_configuration(
self,
*,
RetentionConfigurationName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: DeleteRetentionConfigurationRequestRequestTypeDef = { # (1)
"RetentionConfigurationName": ...,
}
parent.delete_retention_configuration(**kwargs)
delete_stored_query
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
Type annotations and code completion for boto3.client("config").delete_stored_query
method.
boto3 documentation
kwargs: DeleteStoredQueryRequestRequestTypeDef = { # (1)
"QueryName": ...,
}
parent.delete_stored_query(**kwargs)
deliver_config_snapshot
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
Type annotations and code completion for boto3.client("config").deliver_config_snapshot
method.
boto3 documentation
def deliver_config_snapshot(
self,
*,
deliveryChannelName: str,
) -> DeliverConfigSnapshotResponseTypeDef: # (1)
...
kwargs: DeliverConfigSnapshotRequestRequestTypeDef = { # (1)
"deliveryChannelName": ...,
}
parent.deliver_config_snapshot(**kwargs)
describe_aggregate_compliance_by_config_rules
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
Type annotations and code completion for boto3.client("config").describe_aggregate_compliance_by_config_rules
method.
boto3 documentation
def describe_aggregate_compliance_by_config_rules(
self,
*,
ConfigurationAggregatorName: str,
Filters: ConfigRuleComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregateComplianceByConfigRulesResponseTypeDef: # (2)
...
kwargs: DescribeAggregateComplianceByConfigRulesRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_aggregate_compliance_by_config_rules(**kwargs)
describe_aggregate_compliance_by_conformance_packs
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
Type annotations and code completion for boto3.client("config").describe_aggregate_compliance_by_conformance_packs
method.
boto3 documentation
def describe_aggregate_compliance_by_conformance_packs(
self,
*,
ConfigurationAggregatorName: str,
Filters: AggregateConformancePackComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregateComplianceByConformancePacksResponseTypeDef: # (2)
...
- See AggregateConformancePackComplianceFiltersTypeDef
- See DescribeAggregateComplianceByConformancePacksResponseTypeDef
kwargs: DescribeAggregateComplianceByConformancePacksRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_aggregate_compliance_by_conformance_packs(**kwargs)
describe_aggregation_authorizations
Returns a list of authorizations granted to various aggregator accounts and regions.
Type annotations and code completion for boto3.client("config").describe_aggregation_authorizations
method.
boto3 documentation
def describe_aggregation_authorizations(
self,
*,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeAggregationAuthorizationsResponseTypeDef: # (1)
...
kwargs: DescribeAggregationAuthorizationsRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.describe_aggregation_authorizations(**kwargs)
describe_compliance_by_config_rule
Indicates whether the specified Config rules are compliant.
Type annotations and code completion for boto3.client("config").describe_compliance_by_config_rule
method.
boto3 documentation
def describe_compliance_by_config_rule(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
NextToken: str = ...,
) -> DescribeComplianceByConfigRuleResponseTypeDef: # (2)
...
kwargs: DescribeComplianceByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_compliance_by_config_rule(**kwargs)
describe_compliance_by_resource
Indicates whether the specified Amazon Web Services resources are compliant.
Type annotations and code completion for boto3.client("config").describe_compliance_by_resource
method.
boto3 documentation
def describe_compliance_by_resource(
self,
*,
ResourceType: str = ...,
ResourceId: str = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeComplianceByResourceResponseTypeDef: # (2)
...
kwargs: DescribeComplianceByResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
}
parent.describe_compliance_by_resource(**kwargs)
describe_config_rule_evaluation_status
Returns status information for each of your Config managed rules.
Type annotations and code completion for boto3.client("config").describe_config_rule_evaluation_status
method.
boto3 documentation
def describe_config_rule_evaluation_status(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigRuleEvaluationStatusResponseTypeDef: # (1)
...
kwargs: DescribeConfigRuleEvaluationStatusRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_config_rule_evaluation_status(**kwargs)
describe_config_rules
Returns details about your Config rules.
Type annotations and code completion for boto3.client("config").describe_config_rules
method.
boto3 documentation
def describe_config_rules(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
NextToken: str = ...,
Filters: DescribeConfigRulesFiltersTypeDef = ..., # (1)
) -> DescribeConfigRulesResponseTypeDef: # (2)
...
kwargs: DescribeConfigRulesRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_config_rules(**kwargs)
describe_configuration_aggregator_sources_status
Returns status information for sources within an aggregator.
Type annotations and code completion for boto3.client("config").describe_configuration_aggregator_sources_status
method.
boto3 documentation
def describe_configuration_aggregator_sources_status(
self,
*,
ConfigurationAggregatorName: str,
UpdateStatus: Sequence[AggregatedSourceStatusTypeType] = ..., # (1)
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigurationAggregatorSourcesStatusResponseTypeDef: # (2)
...
kwargs: DescribeConfigurationAggregatorSourcesStatusRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.describe_configuration_aggregator_sources_status(**kwargs)
describe_configuration_aggregators
Returns the details of one or more configuration aggregators.
Type annotations and code completion for boto3.client("config").describe_configuration_aggregators
method.
boto3 documentation
def describe_configuration_aggregators(
self,
*,
ConfigurationAggregatorNames: Sequence[str] = ...,
NextToken: str = ...,
Limit: int = ...,
) -> DescribeConfigurationAggregatorsResponseTypeDef: # (1)
...
kwargs: DescribeConfigurationAggregatorsRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorNames": ...,
}
parent.describe_configuration_aggregators(**kwargs)
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
def describe_configuration_recorder_status(
self,
*,
ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecorderStatusResponseTypeDef: # (1)
...
kwargs: DescribeConfigurationRecorderStatusRequestRequestTypeDef = { # (1)
"ConfigurationRecorderNames": ...,
}
parent.describe_configuration_recorder_status(**kwargs)
describe_configuration_recorders
Returns the details for the specified configuration recorders.
Type annotations and code completion for boto3.client("config").describe_configuration_recorders
method.
boto3 documentation
def describe_configuration_recorders(
self,
*,
ConfigurationRecorderNames: Sequence[str] = ...,
) -> DescribeConfigurationRecordersResponseTypeDef: # (1)
...
kwargs: DescribeConfigurationRecordersRequestRequestTypeDef = { # (1)
"ConfigurationRecorderNames": ...,
}
parent.describe_configuration_recorders(**kwargs)
describe_conformance_pack_compliance
Returns compliance details for each rule in that conformance pack.
Type annotations and code completion for boto3.client("config").describe_conformance_pack_compliance
method.
boto3 documentation
def describe_conformance_pack_compliance(
self,
*,
ConformancePackName: str,
Filters: ConformancePackComplianceFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePackComplianceResponseTypeDef: # (2)
...
kwargs: DescribeConformancePackComplianceRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.describe_conformance_pack_compliance(**kwargs)
describe_conformance_pack_status
Provides one or more conformance packs deployment status.
Type annotations and code completion for boto3.client("config").describe_conformance_pack_status
method.
boto3 documentation
def describe_conformance_pack_status(
self,
*,
ConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePackStatusResponseTypeDef: # (1)
...
kwargs: DescribeConformancePackStatusRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.describe_conformance_pack_status(**kwargs)
describe_conformance_packs
Returns a list of one or more conformance packs.
Type annotations and code completion for boto3.client("config").describe_conformance_packs
method.
boto3 documentation
def describe_conformance_packs(
self,
*,
ConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeConformancePacksResponseTypeDef: # (1)
...
kwargs: DescribeConformancePacksRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.describe_conformance_packs(**kwargs)
describe_delivery_channel_status
Returns the current status of the specified delivery channel.
Type annotations and code completion for boto3.client("config").describe_delivery_channel_status
method.
boto3 documentation
def describe_delivery_channel_status(
self,
*,
DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelStatusResponseTypeDef: # (1)
...
kwargs: DescribeDeliveryChannelStatusRequestRequestTypeDef = { # (1)
"DeliveryChannelNames": ...,
}
parent.describe_delivery_channel_status(**kwargs)
describe_delivery_channels
Returns details about the specified delivery channel.
Type annotations and code completion for boto3.client("config").describe_delivery_channels
method.
boto3 documentation
def describe_delivery_channels(
self,
*,
DeliveryChannelNames: Sequence[str] = ...,
) -> DescribeDeliveryChannelsResponseTypeDef: # (1)
...
kwargs: DescribeDeliveryChannelsRequestRequestTypeDef = { # (1)
"DeliveryChannelNames": ...,
}
parent.describe_delivery_channels(**kwargs)
describe_organization_config_rule_statuses
Provides organization Config rule deployment status for an organization.
Type annotations and code completion for boto3.client("config").describe_organization_config_rule_statuses
method.
boto3 documentation
def describe_organization_config_rule_statuses(
self,
*,
OrganizationConfigRuleNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConfigRuleStatusesResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationConfigRuleStatusesRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleNames": ...,
}
parent.describe_organization_config_rule_statuses(**kwargs)
describe_organization_config_rules
Returns a list of organization Config rules.
Type annotations and code completion for boto3.client("config").describe_organization_config_rules
method.
boto3 documentation
def describe_organization_config_rules(
self,
*,
OrganizationConfigRuleNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConfigRulesResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationConfigRulesRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleNames": ...,
}
parent.describe_organization_config_rules(**kwargs)
describe_organization_conformance_pack_statuses
Provides organization conformance pack deployment status for an organization.
Type annotations and code completion for boto3.client("config").describe_organization_conformance_pack_statuses
method.
boto3 documentation
def describe_organization_conformance_pack_statuses(
self,
*,
OrganizationConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConformancePackStatusesResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationConformancePackStatusesRequestRequestTypeDef = { # (1)
"OrganizationConformancePackNames": ...,
}
parent.describe_organization_conformance_pack_statuses(**kwargs)
describe_organization_conformance_packs
Returns a list of organization conformance packs.
Type annotations and code completion for boto3.client("config").describe_organization_conformance_packs
method.
boto3 documentation
def describe_organization_conformance_packs(
self,
*,
OrganizationConformancePackNames: Sequence[str] = ...,
Limit: int = ...,
NextToken: str = ...,
) -> DescribeOrganizationConformancePacksResponseTypeDef: # (1)
...
kwargs: DescribeOrganizationConformancePacksRequestRequestTypeDef = { # (1)
"OrganizationConformancePackNames": ...,
}
parent.describe_organization_conformance_packs(**kwargs)
describe_pending_aggregation_requests
Returns a list of all pending aggregation requests.
Type annotations and code completion for boto3.client("config").describe_pending_aggregation_requests
method.
boto3 documentation
def describe_pending_aggregation_requests(
self,
*,
Limit: int = ...,
NextToken: str = ...,
) -> DescribePendingAggregationRequestsResponseTypeDef: # (1)
...
kwargs: DescribePendingAggregationRequestsRequestRequestTypeDef = { # (1)
"Limit": ...,
}
parent.describe_pending_aggregation_requests(**kwargs)
describe_remediation_configurations
Returns the details of one or more remediation configurations.
Type annotations and code completion for boto3.client("config").describe_remediation_configurations
method.
boto3 documentation
def describe_remediation_configurations(
self,
*,
ConfigRuleNames: Sequence[str],
) -> DescribeRemediationConfigurationsResponseTypeDef: # (1)
...
kwargs: DescribeRemediationConfigurationsRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.describe_remediation_configurations(**kwargs)
describe_remediation_exceptions
Returns the details of one or more remediation exceptions.
Type annotations and code completion for boto3.client("config").describe_remediation_exceptions
method.
boto3 documentation
def describe_remediation_exceptions(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeRemediationExceptionsResponseTypeDef: # (2)
...
kwargs: DescribeRemediationExceptionsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.describe_remediation_exceptions(**kwargs)
describe_remediation_execution_status
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
Type annotations and code completion for boto3.client("config").describe_remediation_execution_status
method.
boto3 documentation
def describe_remediation_execution_status(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[ResourceKeyTypeDef] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> DescribeRemediationExecutionStatusResponseTypeDef: # (2)
...
kwargs: DescribeRemediationExecutionStatusRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.describe_remediation_execution_status(**kwargs)
describe_retention_configurations
Returns the details of one or more retention configurations.
Type annotations and code completion for boto3.client("config").describe_retention_configurations
method.
boto3 documentation
def describe_retention_configurations(
self,
*,
RetentionConfigurationNames: Sequence[str] = ...,
NextToken: str = ...,
) -> DescribeRetentionConfigurationsResponseTypeDef: # (1)
...
kwargs: DescribeRetentionConfigurationsRequestRequestTypeDef = { # (1)
"RetentionConfigurationNames": ...,
}
parent.describe_retention_configurations(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("config").generate_presigned_url
method.
boto3 documentation
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
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)
...
kwargs: GetAggregateComplianceDetailsByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ConfigRuleName": ...,
"AccountId": ...,
"AwsRegion": ...,
}
parent.get_aggregate_compliance_details_by_config_rule(**kwargs)
get_aggregate_config_rule_compliance_summary
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_config_rule_compliance_summary
method.
boto3 documentation
def get_aggregate_config_rule_compliance_summary(
self,
*,
ConfigurationAggregatorName: str,
Filters: ConfigRuleComplianceSummaryFiltersTypeDef = ..., # (1)
GroupByKey: ConfigRuleComplianceSummaryGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateConfigRuleComplianceSummaryResponseTypeDef: # (3)
...
- See ConfigRuleComplianceSummaryFiltersTypeDef
- See ConfigRuleComplianceSummaryGroupKeyType
- See GetAggregateConfigRuleComplianceSummaryResponseTypeDef
kwargs: GetAggregateConfigRuleComplianceSummaryRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_config_rule_compliance_summary(**kwargs)
get_aggregate_conformance_pack_compliance_summary
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_conformance_pack_compliance_summary
method.
boto3 documentation
def get_aggregate_conformance_pack_compliance_summary(
self,
*,
ConfigurationAggregatorName: str,
Filters: AggregateConformancePackComplianceSummaryFiltersTypeDef = ..., # (1)
GroupByKey: AggregateConformancePackComplianceSummaryGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateConformancePackComplianceSummaryResponseTypeDef: # (3)
...
- See AggregateConformancePackComplianceSummaryFiltersTypeDef
- See AggregateConformancePackComplianceSummaryGroupKeyType
- See GetAggregateConformancePackComplianceSummaryResponseTypeDef
kwargs: GetAggregateConformancePackComplianceSummaryRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_conformance_pack_compliance_summary(**kwargs)
get_aggregate_discovered_resource_counts
Returns the resource counts across accounts and regions that are present in your Config aggregator.
Type annotations and code completion for boto3.client("config").get_aggregate_discovered_resource_counts
method.
boto3 documentation
def get_aggregate_discovered_resource_counts(
self,
*,
ConfigurationAggregatorName: str,
Filters: ResourceCountFiltersTypeDef = ..., # (1)
GroupByKey: ResourceCountGroupKeyType = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> GetAggregateDiscoveredResourceCountsResponseTypeDef: # (3)
...
- See ResourceCountFiltersTypeDef
- See ResourceCountGroupKeyType
- See GetAggregateDiscoveredResourceCountsResponseTypeDef
kwargs: GetAggregateDiscoveredResourceCountsRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.get_aggregate_discovered_resource_counts(**kwargs)
get_aggregate_resource_config
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
Type annotations and code completion for boto3.client("config").get_aggregate_resource_config
method.
boto3 documentation
def get_aggregate_resource_config(
self,
*,
ConfigurationAggregatorName: str,
ResourceIdentifier: AggregateResourceIdentifierTypeDef, # (1)
) -> GetAggregateResourceConfigResponseTypeDef: # (2)
...
kwargs: GetAggregateResourceConfigRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ResourceIdentifier": ...,
}
parent.get_aggregate_resource_config(**kwargs)
get_compliance_details_by_config_rule
Returns the evaluation results for the specified Config rule.
Type annotations and code completion for boto3.client("config").get_compliance_details_by_config_rule
method.
boto3 documentation
def get_compliance_details_by_config_rule(
self,
*,
ConfigRuleName: str,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetComplianceDetailsByConfigRuleResponseTypeDef: # (2)
...
kwargs: GetComplianceDetailsByConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.get_compliance_details_by_config_rule(**kwargs)
get_compliance_details_by_resource
Returns the evaluation results for the specified Amazon Web Services resource.
Type annotations and code completion for boto3.client("config").get_compliance_details_by_resource
method.
boto3 documentation
def get_compliance_details_by_resource(
self,
*,
ResourceType: str = ...,
ResourceId: str = ...,
ComplianceTypes: Sequence[ComplianceTypeType] = ..., # (1)
NextToken: str = ...,
ResourceEvaluationId: str = ...,
) -> GetComplianceDetailsByResourceResponseTypeDef: # (2)
...
kwargs: GetComplianceDetailsByResourceRequestRequestTypeDef = { # (1)
"ResourceType": ...,
}
parent.get_compliance_details_by_resource(**kwargs)
get_compliance_summary_by_config_rule
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Type annotations and code completion for boto3.client("config").get_compliance_summary_by_config_rule
method.
boto3 documentation
def get_compliance_summary_by_config_rule(
self,
) -> GetComplianceSummaryByConfigRuleResponseTypeDef: # (1)
...
get_compliance_summary_by_resource_type
Returns the number of resources that are compliant and the number that are noncompliant.
Type annotations and code completion for boto3.client("config").get_compliance_summary_by_resource_type
method.
boto3 documentation
def get_compliance_summary_by_resource_type(
self,
*,
ResourceTypes: Sequence[str] = ...,
) -> GetComplianceSummaryByResourceTypeResponseTypeDef: # (1)
...
kwargs: GetComplianceSummaryByResourceTypeRequestRequestTypeDef = { # (1)
"ResourceTypes": ...,
}
parent.get_compliance_summary_by_resource_type(**kwargs)
get_conformance_pack_compliance_details
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Type annotations and code completion for boto3.client("config").get_conformance_pack_compliance_details
method.
boto3 documentation
def get_conformance_pack_compliance_details(
self,
*,
ConformancePackName: str,
Filters: ConformancePackEvaluationFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetConformancePackComplianceDetailsResponseTypeDef: # (2)
...
kwargs: GetConformancePackComplianceDetailsRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.get_conformance_pack_compliance_details(**kwargs)
get_conformance_pack_compliance_summary
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Type annotations and code completion for boto3.client("config").get_conformance_pack_compliance_summary
method.
boto3 documentation
def get_conformance_pack_compliance_summary(
self,
*,
ConformancePackNames: Sequence[str],
Limit: int = ...,
NextToken: str = ...,
) -> GetConformancePackComplianceSummaryResponseTypeDef: # (1)
...
kwargs: GetConformancePackComplianceSummaryRequestRequestTypeDef = { # (1)
"ConformancePackNames": ...,
}
parent.get_conformance_pack_compliance_summary(**kwargs)
get_custom_rule_policy
Returns the policy definition containing the logic for your Config Custom Policy rule.
Type annotations and code completion for boto3.client("config").get_custom_rule_policy
method.
boto3 documentation
def get_custom_rule_policy(
self,
*,
ConfigRuleName: str = ...,
) -> GetCustomRulePolicyResponseTypeDef: # (1)
...
kwargs: GetCustomRulePolicyRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
}
parent.get_custom_rule_policy(**kwargs)
get_discovered_resource_counts
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Type annotations and code completion for boto3.client("config").get_discovered_resource_counts
method.
boto3 documentation
def get_discovered_resource_counts(
self,
*,
resourceTypes: Sequence[str] = ...,
limit: int = ...,
nextToken: str = ...,
) -> GetDiscoveredResourceCountsResponseTypeDef: # (1)
...
kwargs: GetDiscoveredResourceCountsRequestRequestTypeDef = { # (1)
"resourceTypes": ...,
}
parent.get_discovered_resource_counts(**kwargs)
get_organization_config_rule_detailed_status
Returns detailed status for each member account within an organization for a given organization Config rule.
Type annotations and code completion for boto3.client("config").get_organization_config_rule_detailed_status
method.
boto3 documentation
def get_organization_config_rule_detailed_status(
self,
*,
OrganizationConfigRuleName: str,
Filters: StatusDetailFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetOrganizationConfigRuleDetailedStatusResponseTypeDef: # (2)
...
kwargs: GetOrganizationConfigRuleDetailedStatusRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.get_organization_config_rule_detailed_status(**kwargs)
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
def get_organization_conformance_pack_detailed_status(
self,
*,
OrganizationConformancePackName: str,
Filters: OrganizationResourceDetailedStatusFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> GetOrganizationConformancePackDetailedStatusResponseTypeDef: # (2)
...
- See OrganizationResourceDetailedStatusFiltersTypeDef
- See GetOrganizationConformancePackDetailedStatusResponseTypeDef
kwargs: GetOrganizationConformancePackDetailedStatusRequestRequestTypeDef = { # (1)
"OrganizationConformancePackName": ...,
}
parent.get_organization_conformance_pack_detailed_status(**kwargs)
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
def get_organization_custom_rule_policy(
self,
*,
OrganizationConfigRuleName: str,
) -> GetOrganizationCustomRulePolicyResponseTypeDef: # (1)
...
kwargs: GetOrganizationCustomRulePolicyRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.get_organization_custom_rule_policy(**kwargs)
get_resource_config_history
Returns a list of ConfigurationItems
for the specified resource.
Type annotations and code completion for boto3.client("config").get_resource_config_history
method.
boto3 documentation
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)
...
kwargs: GetResourceConfigHistoryRequestRequestTypeDef = { # (1)
"resourceType": ...,
"resourceId": ...,
}
parent.get_resource_config_history(**kwargs)
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
def get_resource_evaluation_summary(
self,
*,
ResourceEvaluationId: str,
) -> GetResourceEvaluationSummaryResponseTypeDef: # (1)
...
kwargs: GetResourceEvaluationSummaryRequestRequestTypeDef = { # (1)
"ResourceEvaluationId": ...,
}
parent.get_resource_evaluation_summary(**kwargs)
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
def get_stored_query(
self,
*,
QueryName: str,
) -> GetStoredQueryResponseTypeDef: # (1)
...
kwargs: GetStoredQueryRequestRequestTypeDef = { # (1)
"QueryName": ...,
}
parent.get_stored_query(**kwargs)
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
def list_aggregate_discovered_resources(
self,
*,
ConfigurationAggregatorName: str,
ResourceType: ResourceTypeType, # (1)
Filters: ResourceFiltersTypeDef = ..., # (2)
Limit: int = ...,
NextToken: str = ...,
) -> ListAggregateDiscoveredResourcesResponseTypeDef: # (3)
...
kwargs: ListAggregateDiscoveredResourcesRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
"ResourceType": ...,
}
parent.list_aggregate_discovered_resources(**kwargs)
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
def list_conformance_pack_compliance_scores(
self,
*,
Filters: ConformancePackComplianceScoresFiltersTypeDef = ..., # (1)
SortOrder: SortOrderType = ..., # (2)
SortBy: SortByType = ..., # (3)
Limit: int = ...,
NextToken: str = ...,
) -> ListConformancePackComplianceScoresResponseTypeDef: # (4)
...
- See ConformancePackComplianceScoresFiltersTypeDef
- See SortOrderType
- See SortByType
- See ListConformancePackComplianceScoresResponseTypeDef
kwargs: ListConformancePackComplianceScoresRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_conformance_pack_compliance_scores(**kwargs)
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
def list_discovered_resources(
self,
*,
resourceType: ResourceTypeType, # (1)
resourceIds: Sequence[str] = ...,
resourceName: str = ...,
limit: int = ...,
includeDeletedResources: bool = ...,
nextToken: str = ...,
) -> ListDiscoveredResourcesResponseTypeDef: # (2)
...
kwargs: ListDiscoveredResourcesRequestRequestTypeDef = { # (1)
"resourceType": ...,
}
parent.list_discovered_resources(**kwargs)
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
def list_resource_evaluations(
self,
*,
Filters: ResourceEvaluationFiltersTypeDef = ..., # (1)
Limit: int = ...,
NextToken: str = ...,
) -> ListResourceEvaluationsResponseTypeDef: # (2)
...
kwargs: ListResourceEvaluationsRequestRequestTypeDef = { # (1)
"Filters": ...,
}
parent.list_resource_evaluations(**kwargs)
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
def list_stored_queries(
self,
*,
NextToken: str = ...,
MaxResults: int = ...,
) -> ListStoredQueriesResponseTypeDef: # (1)
...
kwargs: ListStoredQueriesRequestRequestTypeDef = { # (1)
"NextToken": ...,
}
parent.list_stored_queries(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
Limit: int = ...,
NextToken: str = ...,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def put_aggregation_authorization(
self,
*,
AuthorizedAccountId: str,
AuthorizedAwsRegion: str,
Tags: Sequence[TagTypeDef] = ..., # (1)
) -> PutAggregationAuthorizationResponseTypeDef: # (2)
...
kwargs: PutAggregationAuthorizationRequestRequestTypeDef = { # (1)
"AuthorizedAccountId": ...,
"AuthorizedAwsRegion": ...,
}
parent.put_aggregation_authorization(**kwargs)
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
def put_config_rule(
self,
*,
ConfigRule: ConfigRuleTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> EmptyResponseMetadataTypeDef: # (3)
...
- See ConfigRuleTypeDef
- See TagTypeDef
- See EmptyResponseMetadataTypeDef
kwargs: PutConfigRuleRequestRequestTypeDef = { # (1)
"ConfigRule": ...,
}
parent.put_config_rule(**kwargs)
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
def put_configuration_aggregator(
self,
*,
ConfigurationAggregatorName: str,
AccountAggregationSources: Sequence[AccountAggregationSourceTypeDef] = ..., # (1)
OrganizationAggregationSource: OrganizationAggregationSourceTypeDef = ..., # (2)
Tags: Sequence[TagTypeDef] = ..., # (3)
) -> PutConfigurationAggregatorResponseTypeDef: # (4)
...
- See AccountAggregationSourceTypeDef
- See OrganizationAggregationSourceTypeDef
- See TagTypeDef
- See PutConfigurationAggregatorResponseTypeDef
kwargs: PutConfigurationAggregatorRequestRequestTypeDef = { # (1)
"ConfigurationAggregatorName": ...,
}
parent.put_configuration_aggregator(**kwargs)
put_configuration_recorder
Creates a new configuration recorder to record the selected resource configurations.
Type annotations and code completion for boto3.client("config").put_configuration_recorder
method.
boto3 documentation
def put_configuration_recorder(
self,
*,
ConfigurationRecorder: ConfigurationRecorderTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutConfigurationRecorderRequestRequestTypeDef = { # (1)
"ConfigurationRecorder": ...,
}
parent.put_configuration_recorder(**kwargs)
put_conformance_pack
Creates or updates a conformance pack.
Type annotations and code completion for boto3.client("config").put_conformance_pack
method.
boto3 documentation
def put_conformance_pack(
self,
*,
ConformancePackName: str,
TemplateS3Uri: str = ...,
TemplateBody: str = ...,
DeliveryS3Bucket: str = ...,
DeliveryS3KeyPrefix: str = ...,
ConformancePackInputParameters: Sequence[ConformancePackInputParameterTypeDef] = ..., # (1)
TemplateSSMDocumentDetails: TemplateSSMDocumentDetailsTypeDef = ..., # (2)
) -> PutConformancePackResponseTypeDef: # (3)
...
- See ConformancePackInputParameterTypeDef
- See TemplateSSMDocumentDetailsTypeDef
- See PutConformancePackResponseTypeDef
kwargs: PutConformancePackRequestRequestTypeDef = { # (1)
"ConformancePackName": ...,
}
parent.put_conformance_pack(**kwargs)
put_delivery_channel
Creates a delivery channel object to deliver configuration 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
def put_delivery_channel(
self,
*,
DeliveryChannel: DeliveryChannelTypeDef, # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: PutDeliveryChannelRequestRequestTypeDef = { # (1)
"DeliveryChannel": ...,
}
parent.put_delivery_channel(**kwargs)
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
def put_evaluations(
self,
*,
ResultToken: str,
Evaluations: Sequence[EvaluationTypeDef] = ..., # (1)
TestMode: bool = ...,
) -> PutEvaluationsResponseTypeDef: # (2)
...
kwargs: PutEvaluationsRequestRequestTypeDef = { # (1)
"ResultToken": ...,
}
parent.put_evaluations(**kwargs)
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
def put_external_evaluation(
self,
*,
ConfigRuleName: str,
ExternalEvaluation: ExternalEvaluationTypeDef, # (1)
) -> Dict[str, Any]:
...
kwargs: PutExternalEvaluationRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
"ExternalEvaluation": ...,
}
parent.put_external_evaluation(**kwargs)
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
def put_organization_config_rule(
self,
*,
OrganizationConfigRuleName: str,
OrganizationManagedRuleMetadata: OrganizationManagedRuleMetadataTypeDef = ..., # (1)
OrganizationCustomRuleMetadata: OrganizationCustomRuleMetadataTypeDef = ..., # (2)
ExcludedAccounts: Sequence[str] = ...,
OrganizationCustomPolicyRuleMetadata: OrganizationCustomPolicyRuleMetadataTypeDef = ..., # (3)
) -> PutOrganizationConfigRuleResponseTypeDef: # (4)
...
- See OrganizationManagedRuleMetadataTypeDef
- See OrganizationCustomRuleMetadataTypeDef
- See OrganizationCustomPolicyRuleMetadataTypeDef
- See PutOrganizationConfigRuleResponseTypeDef
kwargs: PutOrganizationConfigRuleRequestRequestTypeDef = { # (1)
"OrganizationConfigRuleName": ...,
}
parent.put_organization_config_rule(**kwargs)
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
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)
...
kwargs: PutOrganizationConformancePackRequestRequestTypeDef = { # (1)
"OrganizationConformancePackName": ...,
}
parent.put_organization_conformance_pack(**kwargs)
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
def put_remediation_configurations(
self,
*,
RemediationConfigurations: Sequence[RemediationConfigurationTypeDef], # (1)
) -> PutRemediationConfigurationsResponseTypeDef: # (2)
...
kwargs: PutRemediationConfigurationsRequestRequestTypeDef = { # (1)
"RemediationConfigurations": ...,
}
parent.put_remediation_configurations(**kwargs)
put_remediation_exceptions
A remediation exception is when a specific resource is no longer considered for auto-remediation.
Type annotations and code completion for boto3.client("config").put_remediation_exceptions
method.
boto3 documentation
def put_remediation_exceptions(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[RemediationExceptionResourceKeyTypeDef], # (1)
Message: str = ...,
ExpirationTime: Union[datetime, str] = ...,
) -> PutRemediationExceptionsResponseTypeDef: # (2)
...
kwargs: PutRemediationExceptionsRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
"ResourceKeys": ...,
}
parent.put_remediation_exceptions(**kwargs)
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
def put_resource_config(
self,
*,
ResourceType: str,
SchemaVersionId: str,
ResourceId: str,
Configuration: str,
ResourceName: str = ...,
Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: PutResourceConfigRequestRequestTypeDef = { # (1)
"ResourceType": ...,
"SchemaVersionId": ...,
"ResourceId": ...,
"Configuration": ...,
}
parent.put_resource_config(**kwargs)
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
def put_retention_configuration(
self,
*,
RetentionPeriodInDays: int,
) -> PutRetentionConfigurationResponseTypeDef: # (1)
...
kwargs: PutRetentionConfigurationRequestRequestTypeDef = { # (1)
"RetentionPeriodInDays": ...,
}
parent.put_retention_configuration(**kwargs)
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
def put_stored_query(
self,
*,
StoredQuery: StoredQueryTypeDef, # (1)
Tags: Sequence[TagTypeDef] = ..., # (2)
) -> PutStoredQueryResponseTypeDef: # (3)
...
kwargs: PutStoredQueryRequestRequestTypeDef = { # (1)
"StoredQuery": ...,
}
parent.put_stored_query(**kwargs)
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
def select_aggregate_resource_config(
self,
*,
Expression: str,
ConfigurationAggregatorName: str,
Limit: int = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> SelectAggregateResourceConfigResponseTypeDef: # (1)
...
kwargs: SelectAggregateResourceConfigRequestRequestTypeDef = { # (1)
"Expression": ...,
"ConfigurationAggregatorName": ...,
}
parent.select_aggregate_resource_config(**kwargs)
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
def select_resource_config(
self,
*,
Expression: str,
Limit: int = ...,
NextToken: str = ...,
) -> SelectResourceConfigResponseTypeDef: # (1)
...
kwargs: SelectResourceConfigRequestRequestTypeDef = { # (1)
"Expression": ...,
}
parent.select_resource_config(**kwargs)
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
def start_config_rules_evaluation(
self,
*,
ConfigRuleNames: Sequence[str] = ...,
) -> Dict[str, Any]:
...
kwargs: StartConfigRulesEvaluationRequestRequestTypeDef = { # (1)
"ConfigRuleNames": ...,
}
parent.start_config_rules_evaluation(**kwargs)
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
def start_configuration_recorder(
self,
*,
ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StartConfigurationRecorderRequestRequestTypeDef = { # (1)
"ConfigurationRecorderName": ...,
}
parent.start_configuration_recorder(**kwargs)
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
def start_remediation_execution(
self,
*,
ConfigRuleName: str,
ResourceKeys: Sequence[ResourceKeyTypeDef], # (1)
) -> StartRemediationExecutionResponseTypeDef: # (2)
...
kwargs: StartRemediationExecutionRequestRequestTypeDef = { # (1)
"ConfigRuleName": ...,
"ResourceKeys": ...,
}
parent.start_remediation_execution(**kwargs)
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
def start_resource_evaluation(
self,
*,
ResourceDetails: ResourceDetailsTypeDef, # (1)
EvaluationMode: EvaluationModeType, # (2)
EvaluationContext: EvaluationContextTypeDef = ..., # (3)
EvaluationTimeout: int = ...,
ClientToken: str = ...,
) -> StartResourceEvaluationResponseTypeDef: # (4)
...
- See ResourceDetailsTypeDef
- See EvaluationModeType
- See EvaluationContextTypeDef
- See StartResourceEvaluationResponseTypeDef
kwargs: StartResourceEvaluationRequestRequestTypeDef = { # (1)
"ResourceDetails": ...,
"EvaluationMode": ...,
}
parent.start_resource_evaluation(**kwargs)
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
def stop_configuration_recorder(
self,
*,
ConfigurationRecorderName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: StopConfigurationRecorderRequestRequestTypeDef = { # (1)
"ConfigurationRecorderName": ...,
}
parent.stop_configuration_recorder(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Deletes specified tags from a resource.
Type annotations and code completion for boto3.client("config").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("config").get_paginator
method with overloads.
client.get_paginator("describe_aggregate_compliance_by_config_rules")
-> DescribeAggregateComplianceByConfigRulesPaginatorclient.get_paginator("describe_aggregate_compliance_by_conformance_packs")
-> DescribeAggregateComplianceByConformancePacksPaginatorclient.get_paginator("describe_aggregation_authorizations")
-> DescribeAggregationAuthorizationsPaginatorclient.get_paginator("describe_compliance_by_config_rule")
-> DescribeComplianceByConfigRulePaginatorclient.get_paginator("describe_compliance_by_resource")
-> DescribeComplianceByResourcePaginatorclient.get_paginator("describe_config_rule_evaluation_status")
-> DescribeConfigRuleEvaluationStatusPaginatorclient.get_paginator("describe_config_rules")
-> DescribeConfigRulesPaginatorclient.get_paginator("describe_configuration_aggregator_sources_status")
-> DescribeConfigurationAggregatorSourcesStatusPaginatorclient.get_paginator("describe_configuration_aggregators")
-> DescribeConfigurationAggregatorsPaginatorclient.get_paginator("describe_conformance_pack_status")
-> DescribeConformancePackStatusPaginatorclient.get_paginator("describe_conformance_packs")
-> DescribeConformancePacksPaginatorclient.get_paginator("describe_organization_config_rule_statuses")
-> DescribeOrganizationConfigRuleStatusesPaginatorclient.get_paginator("describe_organization_config_rules")
-> DescribeOrganizationConfigRulesPaginatorclient.get_paginator("describe_organization_conformance_pack_statuses")
-> DescribeOrganizationConformancePackStatusesPaginatorclient.get_paginator("describe_organization_conformance_packs")
-> DescribeOrganizationConformancePacksPaginatorclient.get_paginator("describe_pending_aggregation_requests")
-> DescribePendingAggregationRequestsPaginatorclient.get_paginator("describe_remediation_execution_status")
-> DescribeRemediationExecutionStatusPaginatorclient.get_paginator("describe_retention_configurations")
-> DescribeRetentionConfigurationsPaginatorclient.get_paginator("get_aggregate_compliance_details_by_config_rule")
-> GetAggregateComplianceDetailsByConfigRulePaginatorclient.get_paginator("get_compliance_details_by_config_rule")
-> GetComplianceDetailsByConfigRulePaginatorclient.get_paginator("get_compliance_details_by_resource")
-> GetComplianceDetailsByResourcePaginatorclient.get_paginator("get_conformance_pack_compliance_summary")
-> GetConformancePackComplianceSummaryPaginatorclient.get_paginator("get_organization_config_rule_detailed_status")
-> GetOrganizationConfigRuleDetailedStatusPaginatorclient.get_paginator("get_organization_conformance_pack_detailed_status")
-> GetOrganizationConformancePackDetailedStatusPaginatorclient.get_paginator("get_resource_config_history")
-> GetResourceConfigHistoryPaginatorclient.get_paginator("list_aggregate_discovered_resources")
-> ListAggregateDiscoveredResourcesPaginatorclient.get_paginator("list_discovered_resources")
-> ListDiscoveredResourcesPaginatorclient.get_paginator("list_resource_evaluations")
-> ListResourceEvaluationsPaginatorclient.get_paginator("list_tags_for_resource")
-> ListTagsForResourcePaginatorclient.get_paginator("select_aggregate_resource_config")
-> SelectAggregateResourceConfigPaginatorclient.get_paginator("select_resource_config")
-> SelectResourceConfigPaginator