Table of Contents
A low-level client representing AWS Config (Config Service)
Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources .
You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process . For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide .
import boto3
client = boto3.client('config')
These are the available methods:
Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list.
Note
See also: AWS API Documentation
Request Syntax
response = client.batch_get_aggregate_resource_config(
ConfigurationAggregatorName='string',
ResourceIdentifiers=[
{
'SourceAccountId': 'string',
'SourceRegion': 'string',
'ResourceId': 'string',
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'ResourceName': 'string'
},
]
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
A list of aggregate ResourceIdentifiers objects.
The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.
The 12-digit account ID of the source account.
The source region where data is aggregated.
The ID of the Amazon Web Services resource.
The type of the Amazon Web Services resource.
The name of the Amazon Web Services resource.
dict
Response Syntax
{
'BaseConfigurationItems': [
{
'version': 'string',
'accountId': 'string',
'configurationItemCaptureTime': datetime(2015, 1, 1),
'configurationItemStatus': 'OK'|'ResourceDiscovered'|'ResourceNotRecorded'|'ResourceDeleted'|'ResourceDeletedNotRecorded',
'configurationStateId': 'string',
'arn': 'string',
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'awsRegion': 'string',
'availabilityZone': 'string',
'resourceCreationTime': datetime(2015, 1, 1),
'configuration': 'string',
'supplementaryConfiguration': {
'string': 'string'
}
},
],
'UnprocessedResourceIdentifiers': [
{
'SourceAccountId': 'string',
'SourceRegion': 'string',
'ResourceId': 'string',
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'ResourceName': 'string'
},
]
}
Response Structure
(dict) --
BaseConfigurationItems (list) --
A list that contains the current configuration of one or more resources.
(dict) --
The detailed configuration of a specified resource.
version (string) --
The version number of the resource configuration.
accountId (string) --
The 12-digit Amazon Web Services account ID associated with the resource.
configurationItemCaptureTime (datetime) --
The time when the configuration recording was initiated.
configurationItemStatus (string) --
The configuration item status. The valid values are:
Note
The CIs do not incur any cost.
configurationStateId (string) --
An identifier that indicates the ordering of the configuration items of a resource.
arn (string) --
The Amazon Resource Name (ARN) of the resource.
resourceType (string) --
The type of Amazon Web Services resource.
resourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
resourceName (string) --
The custom name of the resource, if available.
awsRegion (string) --
The region where the resource resides.
availabilityZone (string) --
The Availability Zone associated with the resource.
resourceCreationTime (datetime) --
The time stamp when the resource was created.
configuration (string) --
The description of the resource configuration.
supplementaryConfiguration (dict) --
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
UnprocessedResourceIdentifiers (list) --
A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.
(dict) --
The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.
SourceAccountId (string) --
The 12-digit account ID of the source account.
SourceRegion (string) --
The source region where data is aggregated.
ResourceId (string) --
The ID of the Amazon Web Services resource.
ResourceType (string) --
The type of the Amazon Web Services resource.
ResourceName (string) --
The name of the Amazon Web Services resource.
Exceptions
Returns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
Note
See also: AWS API Documentation
Request Syntax
response = client.batch_get_resource_config(
resourceKeys=[
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
]
)
[REQUIRED]
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
The details that identify a resource within Config, including the resource type and resource ID.
The resource type.
The ID of the resource (for example., sg-xxxxxx).
{
'baseConfigurationItems': [
{
'version': 'string',
'accountId': 'string',
'configurationItemCaptureTime': datetime(2015, 1, 1),
'configurationItemStatus': 'OK'|'ResourceDiscovered'|'ResourceNotRecorded'|'ResourceDeleted'|'ResourceDeletedNotRecorded',
'configurationStateId': 'string',
'arn': 'string',
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'awsRegion': 'string',
'availabilityZone': 'string',
'resourceCreationTime': datetime(2015, 1, 1),
'configuration': 'string',
'supplementaryConfiguration': {
'string': 'string'
}
},
],
'unprocessedResourceKeys': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
]
}
Response Structure
A list that contains the current configuration of one or more resources.
The detailed configuration of a specified resource.
The version number of the resource configuration.
The 12-digit Amazon Web Services account ID associated with the resource.
The time when the configuration recording was initiated.
The configuration item status. The valid values are:
Note
The CIs do not incur any cost.
An identifier that indicates the ordering of the configuration items of a resource.
The Amazon Resource Name (ARN) of the resource.
The type of Amazon Web Services resource.
The ID of the resource (for example., sg-xxxxxx).
The custom name of the resource, if available.
The region where the resource resides.
The Availability Zone associated with the resource.
The time stamp when the resource was created.
The description of the resource configuration.
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.
The details that identify a resource within Config, including the resource type and resource ID.
The resource type.
The ID of the resource (for example., sg-xxxxxx).
Exceptions
Check if an operation can be paginated.
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
See also: AWS API Documentation
Request Syntax
response = client.delete_aggregation_authorization(
AuthorizedAccountId='string',
AuthorizedAwsRegion='string'
)
[REQUIRED]
The 12-digit account ID of the account authorized to aggregate data.
[REQUIRED]
The region authorized to collect aggregated data.
None
Exceptions
Deletes the specified Config rule and all of its evaluation results.
Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException .
You can check the state of a rule by using the DescribeConfigRules request.
See also: AWS API Documentation
Request Syntax
response = client.delete_config_rule(
ConfigRuleName='string'
)
[REQUIRED]
The name of the Config rule that you want to delete.
Exceptions
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_aggregator(
ConfigurationAggregatorName='string'
)
[REQUIRED]
The name of the configuration aggregator.
Exceptions
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder.
See also: AWS API Documentation
Request Syntax
response = client.delete_configuration_recorder(
ConfigurationRecorderName='string'
)
[REQUIRED]
The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.
Exceptions
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
See also: AWS API Documentation
Request Syntax
response = client.delete_conformance_pack(
ConformancePackName='string'
)
[REQUIRED]
Name of the conformance pack you want to delete.
Exceptions
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
See also: AWS API Documentation
Request Syntax
response = client.delete_delivery_channel(
DeliveryChannelName='string'
)
[REQUIRED]
The name of the delivery channel to delete.
Exceptions
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
See also: AWS API Documentation
Request Syntax
response = client.delete_evaluation_results(
ConfigRuleName='string'
)
[REQUIRED]
The name of the Config rule for which you want to delete the evaluation results.
{}
Response Structure
The output when you delete the evaluation results for the specified Config rule.
Exceptions
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a master account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.
Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
See also: AWS API Documentation
Request Syntax
response = client.delete_organization_config_rule(
OrganizationConfigRuleName='string'
)
[REQUIRED]
The name of organization Config rule that you want to delete.
Exceptions
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.
Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
See also: AWS API Documentation
Request Syntax
response = client.delete_organization_conformance_pack(
OrganizationConformancePackName='string'
)
[REQUIRED]
The name of organization conformance pack that you want to delete.
Exceptions
Deletes pending authorization requests for a specified aggregator account in a specified region.
See also: AWS API Documentation
Request Syntax
response = client.delete_pending_aggregation_request(
RequesterAccountId='string',
RequesterAwsRegion='string'
)
[REQUIRED]
The 12-digit account ID of the account requesting to aggregate data.
[REQUIRED]
The region requesting to aggregate data.
None
Exceptions
Deletes the remediation configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_remediation_configuration(
ConfigRuleName='string',
ResourceType='string'
)
[REQUIRED]
The name of the Config rule for which you want to delete remediation configuration.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes one or more remediation exceptions mentioned in the resource keys.
Note
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
See also: AWS API Documentation
Request Syntax
response = client.delete_remediation_exceptions(
ConfigRuleName='string',
ResourceKeys=[
{
'ResourceType': 'string',
'ResourceId': 'string'
},
]
)
[REQUIRED]
The name of the Config rule for which you want to delete remediation exception configuration.
[REQUIRED]
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
The details that identify a resource within Config, including the resource type and resource ID.
The type of a resource.
The ID of the resource (for example., sg-xxxxxx).
dict
Response Syntax
{
'FailedBatches': [
{
'FailureMessage': 'string',
'FailedItems': [
{
'ResourceType': 'string',
'ResourceId': 'string'
},
]
},
]
}
Response Structure
(dict) --
FailedBatches (list) --
Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
(dict) --
List of each of the failed delete remediation exceptions with specific reasons.
FailureMessage (string) --
Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.
FailedItems (list) --
Returns remediation exception resource key object of the failed items.
(dict) --
The details that identify a resource within Config, including the resource type and resource ID.
ResourceType (string) --
The type of a resource.
ResourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
Exceptions
Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
See also: AWS API Documentation
Request Syntax
response = client.delete_resource_config(
ResourceType='string',
ResourceId='string'
)
[REQUIRED]
The type of the resource.
[REQUIRED]
Unique identifier of the resource.
None
Exceptions
Deletes the retention configuration.
See also: AWS API Documentation
Request Syntax
response = client.delete_retention_configuration(
RetentionConfigurationName='string'
)
[REQUIRED]
The name of the retention configuration to delete.
Exceptions
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.delete_stored_query(
QueryName='string'
)
[REQUIRED]
The name of the query that you want to delete.
{}
Response Structure
Exceptions
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
See also: AWS API Documentation
Request Syntax
response = client.deliver_config_snapshot(
deliveryChannelName='string'
)
[REQUIRED]
The name of the delivery channel through which the snapshot is delivered.
{
'configSnapshotId': 'string'
}
Response Structure
The output for the DeliverConfigSnapshot action, in JSON format.
The ID of the snapshot that is being created.
Exceptions
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
Note
The results can return an empty result page, but if you have a nextToken , the results are displayed on the next page.
See also: AWS API Documentation
Request Syntax
response = client.describe_aggregate_compliance_by_config_rules(
ConfigurationAggregatorName='string',
Filters={
'ConfigRuleName': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'AccountId': 'string',
'AwsRegion': 'string'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
Filters the results by ConfigRuleComplianceFilters object.
The name of the Config rule.
The rule compliance status.
For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.
The 12-digit account ID of the source account.
The source region where the data is aggregated.
dict
Response Syntax
{
'AggregateComplianceByConfigRules': [
{
'ConfigRuleName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
},
'AccountId': 'string',
'AwsRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AggregateComplianceByConfigRules (list) --
Returns a list of AggregateComplianceByConfigRule object.
(dict) --
Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.
A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.
ConfigRuleName (string) --
The name of the Config rule.
Compliance (dict) --
Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
AccountId (string) --
The 12-digit account ID of the source account.
AwsRegion (string) --
The source region from where the data is aggregated.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
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. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
Note
The results can return an empty result page, but if you have a nextToken , the results are displayed on the next page.
See also: AWS API Documentation
Request Syntax
response = client.describe_aggregate_compliance_by_conformance_packs(
ConfigurationAggregatorName='string',
Filters={
'ConformancePackName': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'AccountId': 'string',
'AwsRegion': 'string'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
Filters the result by AggregateConformancePackComplianceFilters object.
The name of the conformance pack.
The compliance status of the conformance pack.
The 12-digit Amazon Web Services account ID of the source account.
The source Amazon Web Services Region from where the data is aggregated.
dict
Response Syntax
{
'AggregateComplianceByConformancePacks': [
{
'ConformancePackName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'CompliantRuleCount': 123,
'NonCompliantRuleCount': 123,
'TotalRuleCount': 123
},
'AccountId': 'string',
'AwsRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AggregateComplianceByConformancePacks (list) --
Returns the AggregateComplianceByConformancePack object.
(dict) --
Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
ConformancePackName (string) --
The name of the conformance pack.
Compliance (dict) --
The compliance status of the conformance pack.
ComplianceType (string) --
The compliance status of the conformance pack.
CompliantRuleCount (integer) --
The number of compliant Config Rules.
NonCompliantRuleCount (integer) --
The number of noncompliant Config Rules.
TotalRuleCount (integer) --
Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.
AccountId (string) --
The 12-digit Amazon Web Services account ID of the source account.
AwsRegion (string) --
The source Amazon Web Services Region from where the data is aggregated.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns a list of authorizations granted to various aggregator accounts and regions.
See also: AWS API Documentation
Request Syntax
response = client.describe_aggregation_authorizations(
Limit=123,
NextToken='string'
)
dict
Response Syntax
{
'AggregationAuthorizations': [
{
'AggregationAuthorizationArn': 'string',
'AuthorizedAccountId': 'string',
'AuthorizedAwsRegion': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AggregationAuthorizations (list) --
Returns a list of authorizations granted to various aggregator accounts and regions.
(dict) --
An object that represents the authorizations granted to aggregator accounts and regions.
AggregationAuthorizationArn (string) --
The Amazon Resource Name (ARN) of the aggregation object.
AuthorizedAccountId (string) --
The 12-digit account ID of the account authorized to aggregate data.
AuthorizedAwsRegion (string) --
The region authorized to collect aggregated data.
CreationTime (datetime) --
The time stamp when the aggregation authorization was created.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA . This result might indicate one of the following conditions:
See also: AWS API Documentation
Request Syntax
response = client.describe_compliance_by_config_rule(
ConfigRuleNames=[
'string',
],
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
NextToken='string'
)
Specify one or more Config rule names to filter the results by rule.
Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT .
dict
Response Syntax
{
'ComplianceByConfigRules': [
{
'ConfigRuleName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComplianceByConfigRules (list) --
Indicates whether each of the specified Config rules is compliant.
(dict) --
Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.
ConfigRuleName (string) --
The name of the Config rule.
Compliance (dict) --
Indicates whether the Config rule is compliant.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA . This result might indicate one of the following conditions about the rules that evaluate the resource:
See also: AWS API Documentation
Request Syntax
response = client.describe_compliance_by_resource(
ResourceType='string',
ResourceId='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
Limit=123,
NextToken='string'
)
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA .
dict
Response Syntax
{
'ComplianceByResources': [
{
'ResourceType': 'string',
'ResourceId': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ComplianceByResources (list) --
Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.
(dict) --
Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
ResourceType (string) --
The type of the Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the Amazon Web Services resource that was evaluated.
Compliance (dict) --
Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
See also: AWS API Documentation
Request Syntax
response = client.describe_config_rule_evaluation_status(
ConfigRuleNames=[
'string',
],
NextToken='string',
Limit=123
)
The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.
The number of rule evaluation results that you want returned.
This parameter is required if the rule limit for your account is more than the default of 150 rules.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide .
dict
Response Syntax
{
'ConfigRulesEvaluationStatus': [
{
'ConfigRuleName': 'string',
'ConfigRuleArn': 'string',
'ConfigRuleId': 'string',
'LastSuccessfulInvocationTime': datetime(2015, 1, 1),
'LastFailedInvocationTime': datetime(2015, 1, 1),
'LastSuccessfulEvaluationTime': datetime(2015, 1, 1),
'LastFailedEvaluationTime': datetime(2015, 1, 1),
'FirstActivatedTime': datetime(2015, 1, 1),
'LastDeactivatedTime': datetime(2015, 1, 1),
'LastErrorCode': 'string',
'LastErrorMessage': 'string',
'FirstEvaluationStarted': True|False,
'LastDebugLogDeliveryStatus': 'string',
'LastDebugLogDeliveryStatusReason': 'string',
'LastDebugLogDeliveryTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConfigRulesEvaluationStatus (list) --
Status information about your Config managed rules.
(dict) --
Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.
This action does not return status information about Config Custom Lambda rules.
ConfigRuleName (string) --
The name of the Config rule.
ConfigRuleArn (string) --
The Amazon Resource Name (ARN) of the Config rule.
ConfigRuleId (string) --
The ID of the Config rule.
LastSuccessfulInvocationTime (datetime) --
The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.
LastFailedInvocationTime (datetime) --
The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.
LastSuccessfulEvaluationTime (datetime) --
The time that Config last successfully evaluated your Amazon Web Services resources against the rule.
LastFailedEvaluationTime (datetime) --
The time that Config last failed to evaluate your Amazon Web Services resources against the rule.
FirstActivatedTime (datetime) --
The time that you first activated the Config rule.
LastDeactivatedTime (datetime) --
The time that you last turned off the Config rule.
LastErrorCode (string) --
The error code that Config returned when the rule last failed.
LastErrorMessage (string) --
The error message that Config returned when the rule last failed.
FirstEvaluationStarted (boolean) --
Indicates whether Config has evaluated your resources against the rule at least once.
LastDebugLogDeliveryStatus (string) --
The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed .
LastDebugLogDeliveryStatusReason (string) --
The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.
LastDebugLogDeliveryTime (datetime) --
The time Config last attempted to deliver a debug log for your Config Custom Policy rules.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns details about your Config rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_config_rules(
ConfigRuleNames=[
'string',
],
NextToken='string'
)
The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.
dict
Response Syntax
{
'ConfigRules': [
{
'ConfigRuleName': 'string',
'ConfigRuleArn': 'string',
'ConfigRuleId': 'string',
'Description': 'string',
'Scope': {
'ComplianceResourceTypes': [
'string',
],
'TagKey': 'string',
'TagValue': 'string',
'ComplianceResourceId': 'string'
},
'Source': {
'Owner': 'CUSTOM_LAMBDA'|'AWS'|'CUSTOM_POLICY',
'SourceIdentifier': 'string',
'SourceDetails': [
{
'EventSource': 'aws.config',
'MessageType': 'ConfigurationItemChangeNotification'|'ConfigurationSnapshotDeliveryCompleted'|'ScheduledNotification'|'OversizedConfigurationItemChangeNotification',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
},
],
'CustomPolicyDetails': {
'PolicyRuntime': 'string',
'PolicyText': 'string',
'EnableDebugLogDelivery': True|False
}
},
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ConfigRuleState': 'ACTIVE'|'DELETING'|'DELETING_RESULTS'|'EVALUATING',
'CreatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConfigRules (list) --
The details about your Config rules.
(dict) --
An Config rule represents an Lambda function that you create for a custom rule or a predefined function for an Config managed rule. The function evaluates configuration items to assess whether your Amazon Web Services resources comply with your desired configurations. This function can run when Config detects a configuration change to an Amazon Web Services resource and at a periodic frequency that you choose (for example, every 24 hours).
Note
You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide .
ConfigRuleName (string) --
The name that you assign to the Config rule. The name is required if you are adding a new rule.
ConfigRuleArn (string) --
The Amazon Resource Name (ARN) of the Config rule.
ConfigRuleId (string) --
The ID of the Config rule.
Description (string) --
The description that you provide for the Config rule.
Scope (dict) --
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
Note
The scope can be empty.
ComplianceResourceTypes (list) --
The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId .
TagKey (string) --
The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
TagValue (string) --
The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue , you must also specify a value for TagKey .
ComplianceResourceId (string) --
The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .
Source (dict) --
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Owner (string) --
Indicates whether Amazon Web Services or the customer owns and manages the Config rule.
Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.
Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY ) or Lambda (CUSTOM_LAMBDA ). For more information, see Config Custom Rules in the Config developer guide.
SourceIdentifier (string) --
For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules .
For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name .
For Config Custom Policy rules, this field will be ignored.
SourceDetails (list) --
Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
If the owner is set to CUSTOM_POLICY , the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification .
(dict) --
Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.
EventSource (string) --
The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.
MessageType (string) --
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification .
MaximumExecutionFrequency (string) --
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency , then MessageType must use the ScheduledNotification value.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours , Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
CustomPolicyDetails (dict) --
Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY .
PolicyRuntime (string) --
The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
PolicyText (string) --
The policy definition containing the logic for your Config Custom Policy rule.
EnableDebugLogDelivery (boolean) --
The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false .
InputParameters (string) --
A string, in JSON format, that is passed to the Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ConfigRuleState (string) --
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
CreatedBy (string) --
Service principal name of the service that created the rule.
Note
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration_aggregator_sources_status(
ConfigurationAggregatorName='string',
UpdateStatus=[
'FAILED'|'SUCCEEDED'|'OUTDATED',
],
NextToken='string',
Limit=123
)
[REQUIRED]
The name of the configuration aggregator.
Filters the status type.
dict
Response Syntax
{
'AggregatedSourceStatusList': [
{
'SourceId': 'string',
'SourceType': 'ACCOUNT'|'ORGANIZATION',
'AwsRegion': 'string',
'LastUpdateStatus': 'FAILED'|'SUCCEEDED'|'OUTDATED',
'LastUpdateTime': datetime(2015, 1, 1),
'LastErrorCode': 'string',
'LastErrorMessage': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AggregatedSourceStatusList (list) --
Returns an AggregatedSourceStatus object.
(dict) --
The current sync status between the source and the aggregator account.
SourceId (string) --
The source account ID or an organization.
SourceType (string) --
The source account or an organization.
AwsRegion (string) --
The region authorized to collect aggregated data.
LastUpdateStatus (string) --
Filters the last updated status type.
LastUpdateTime (datetime) --
The time of the last update.
LastErrorCode (string) --
The error code that Config returned when the source account aggregation last failed.
LastErrorMessage (string) --
The message indicating that the source account aggregation failed due to an error.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration_aggregators(
ConfigurationAggregatorNames=[
'string',
],
NextToken='string',
Limit=123
)
The name of the configuration aggregators.
dict
Response Syntax
{
'ConfigurationAggregators': [
{
'ConfigurationAggregatorName': 'string',
'ConfigurationAggregatorArn': 'string',
'AccountAggregationSources': [
{
'AccountIds': [
'string',
],
'AllAwsRegions': True|False,
'AwsRegions': [
'string',
]
},
],
'OrganizationAggregationSource': {
'RoleArn': 'string',
'AwsRegions': [
'string',
],
'AllAwsRegions': True|False
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConfigurationAggregators (list) --
Returns a ConfigurationAggregators object.
(dict) --
The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.
ConfigurationAggregatorName (string) --
The name of the aggregator.
ConfigurationAggregatorArn (string) --
The Amazon Resource Name (ARN) of the aggregator.
AccountAggregationSources (list) --
Provides a list of source accounts and regions to be aggregated.
(dict) --
A collection of accounts and regions.
AccountIds (list) --
The 12-digit account ID of the account being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
AwsRegions (list) --
The source regions being aggregated.
OrganizationAggregationSource (dict) --
Provides an organization and list of regions to be aggregated.
RoleArn (string) --
ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
AwsRegions (list) --
The source regions being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
CreationTime (datetime) --
The time stamp when the configuration aggregator was created.
LastUpdatedTime (datetime) --
The time of the last update.
CreatedBy (string) --
Amazon Web Services service that created the configuration aggregator.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Note
Currently, you can specify only one configuration recorder per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration_recorder_status(
ConfigurationRecorderNames=[
'string',
]
)
The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
{
'ConfigurationRecordersStatus': [
{
'name': 'string',
'lastStartTime': datetime(2015, 1, 1),
'lastStopTime': datetime(2015, 1, 1),
'recording': True|False,
'lastStatus': 'Pending'|'Success'|'Failure',
'lastErrorCode': 'string',
'lastErrorMessage': 'string',
'lastStatusChangeTime': datetime(2015, 1, 1)
},
]
}
Response Structure
The output for the DescribeConfigurationRecorderStatus action, in JSON format.
A list that contains status of the specified recorders.
The current status of the configuration recorder.
The name of the configuration recorder.
The time the recorder was last started.
The time the recorder was last stopped.
Specifies whether or not the recorder is currently recording.
The last (previous) status of the recorder.
The error code indicating that the recording failed.
The message indicating that the recording failed due to an error.
The time when the status was last changed.
Exceptions
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
Note
Currently, you can specify only one configuration recorder per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_configuration_recorders(
ConfigurationRecorderNames=[
'string',
]
)
A list of configuration recorder names.
{
'ConfigurationRecorders': [
{
'name': 'string',
'roleARN': 'string',
'recordingGroup': {
'allSupported': True|False,
'includeGlobalResourceTypes': True|False,
'resourceTypes': [
'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
]
}
},
]
}
Response Structure
The output for the DescribeConfigurationRecorders action.
A list that contains the descriptions of the specified configuration recorders.
An object that represents the recording of configuration changes of an Amazon Web Services resource.
The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.
Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.
Specifies the types of Amazon Web Services resources for which Config records configuration changes.
Specifies whether Config records configuration changes for every supported type of regional resource.
If you set this option to true , when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
If you set this option to true , you cannot enumerate a list of resourceTypes .
Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
Before you can set this option to true , you must set the allSupported option to true .
If you set this option to true , when Config adds support for a new type of global resource, it starts recording resources of that type automatically.
The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail ).
To record all configuration changes, you must set the allSupported option to true .
If you set this option to false , when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types .
Exceptions
Returns compliance details for each rule in that conformance pack.
Note
You must provide exact rule names.
See also: AWS API Documentation
Request Syntax
response = client.describe_conformance_pack_compliance(
ConformancePackName='string',
Filters={
'ConfigRuleNames': [
'string',
],
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
Name of the conformance pack.
A ConformancePackComplianceFilters object.
Filters the results by Config rule names.
Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not supported.
dict
Response Syntax
{
'ConformancePackName': 'string',
'ConformancePackRuleComplianceList': [
{
'ConfigRuleName': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'Controls': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackRuleComplianceList (list) --
Returns a list of ConformancePackRuleCompliance objects.
(dict) --
Compliance information of one or more Config rules within a conformance pack. You can filter using Config rule names and compliance types.
ConfigRuleName (string) --
Name of the Config rule.
ComplianceType (string) --
Compliance of the Config rule.
The allowed values are COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA .
Controls (list) --
Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Provides one or more conformance packs deployment status.
Note
If there are no conformance packs then you will see an empty result.
See also: AWS API Documentation
Request Syntax
response = client.describe_conformance_pack_status(
ConformancePackNames=[
'string',
],
Limit=123,
NextToken='string'
)
Comma-separated list of conformance pack names.
dict
Response Syntax
{
'ConformancePackStatusDetails': [
{
'ConformancePackName': 'string',
'ConformancePackId': 'string',
'ConformancePackArn': 'string',
'ConformancePackState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'StackArn': 'string',
'ConformancePackStatusReason': 'string',
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'LastUpdateCompletedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackStatusDetails (list) --
A list of ConformancePackStatusDetail objects.
(dict) --
Status details of a conformance pack.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of comformance pack.
ConformancePackState (string) --
Indicates deployment status of conformance pack.
Config sets the state of the conformance pack to:
StackArn (string) --
Amazon Resource Name (ARN) of CloudFormation stack.
ConformancePackStatusReason (string) --
The reason of conformance pack creation failure.
LastUpdateRequestedTime (datetime) --
Last time when conformation pack creation and update was requested.
LastUpdateCompletedTime (datetime) --
Last time when conformation pack creation and update was successful.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Returns a list of one or more conformance packs.
See also: AWS API Documentation
Request Syntax
response = client.describe_conformance_packs(
ConformancePackNames=[
'string',
],
Limit=123,
NextToken='string'
)
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.
dict
Response Syntax
{
'ConformancePackDetails': [
{
'ConformancePackName': 'string',
'ConformancePackArn': 'string',
'ConformancePackId': 'string',
'DeliveryS3Bucket': 'string',
'DeliveryS3KeyPrefix': 'string',
'ConformancePackInputParameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackDetails (list) --
Returns a list of ConformancePackDetail objects.
(dict) --
Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
DeliveryS3Bucket (string) --
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional.
DeliveryS3KeyPrefix (string) --
The prefix for the Amazon S3 bucket.
Note
This field is optional.
ConformancePackInputParameters (list) --
A list of ConformancePackInputParameter objects.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) --
One part of a key-value pair.
ParameterValue (string) --
Another part of the key-value pair.
LastUpdateRequestedTime (datetime) --
Last time when conformation pack update was requested.
CreatedBy (string) --
Amazon Web Services service that created the conformance pack.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
Note
Currently, you can specify only one delivery channel per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_delivery_channel_status(
DeliveryChannelNames=[
'string',
]
)
A list of delivery channel names.
{
'DeliveryChannelsStatus': [
{
'name': 'string',
'configSnapshotDeliveryInfo': {
'lastStatus': 'Success'|'Failure'|'Not_Applicable',
'lastErrorCode': 'string',
'lastErrorMessage': 'string',
'lastAttemptTime': datetime(2015, 1, 1),
'lastSuccessfulTime': datetime(2015, 1, 1),
'nextDeliveryTime': datetime(2015, 1, 1)
},
'configHistoryDeliveryInfo': {
'lastStatus': 'Success'|'Failure'|'Not_Applicable',
'lastErrorCode': 'string',
'lastErrorMessage': 'string',
'lastAttemptTime': datetime(2015, 1, 1),
'lastSuccessfulTime': datetime(2015, 1, 1),
'nextDeliveryTime': datetime(2015, 1, 1)
},
'configStreamDeliveryInfo': {
'lastStatus': 'Success'|'Failure'|'Not_Applicable',
'lastErrorCode': 'string',
'lastErrorMessage': 'string',
'lastStatusChangeTime': datetime(2015, 1, 1)
}
},
]
}
Response Structure
The output for the DescribeDeliveryChannelStatus action.
A list that contains the status of a specified delivery channel.
The status of a specified delivery channel.
Valid values: Success | Failure
The name of the delivery channel.
A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
Status of the last attempted delivery.
The error code from the last attempted delivery.
The error message from the last attempted delivery.
The time of the last attempted delivery.
The time of the last successful delivery.
The time that the next delivery occurs.
A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
Status of the last attempted delivery.
The error code from the last attempted delivery.
The error message from the last attempted delivery.
The time of the last attempted delivery.
The time of the last successful delivery.
The time that the next delivery occurs.
A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
Status of the last attempted delivery.
Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable .
The error code from the last attempted delivery.
The error message from the last attempted delivery.
The time from the last status change.
Exceptions
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Note
Currently, you can specify only one delivery channel per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_delivery_channels(
DeliveryChannelNames=[
'string',
]
)
A list of delivery channel names.
{
'DeliveryChannels': [
{
'name': 'string',
's3BucketName': 'string',
's3KeyPrefix': 'string',
's3KmsKeyArn': 'string',
'snsTopicARN': 'string',
'configSnapshotDeliveryProperties': {
'deliveryFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
}
},
]
}
Response Structure
The output for the DescribeDeliveryChannels action.
A list that contains the descriptions of the specified delivery channel.
The channel through which Config delivers notifications and updated configuration states.
The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.
If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.
The prefix for the specified Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.
The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.
If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.
The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.
The frequency with which Config delivers configuration snapshots.
Exceptions
Provides organization Config rule deployment status for an organization.
Note
The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization_config_rule_statuses(
OrganizationConfigRuleNames=[
'string',
],
Limit=123,
NextToken='string'
)
The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.
dict
Response Syntax
{
'OrganizationConfigRuleStatuses': [
{
'OrganizationConfigRuleName': 'string',
'OrganizationRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConfigRuleStatuses (list) --
A list of OrganizationConfigRuleStatus objects.
(dict) --
Returns the status for an organization Config rule in an organization.
OrganizationConfigRuleName (string) --
The name that you assign to organization Config rule.
OrganizationRuleStatus (string) --
Indicates deployment status of an organization Config rule. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
ErrorCode (string) --
An error code that is returned when organization Config rule creation or deletion has failed.
ErrorMessage (string) --
An error message indicating that organization Config rule creation or deletion failed due to an error.
LastUpdateTime (datetime) --
The timestamp of the last update.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns a list of organization Config rules.
Note
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization_config_rules(
OrganizationConfigRuleNames=[
'string',
],
Limit=123,
NextToken='string'
)
The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.
dict
Response Syntax
{
'OrganizationConfigRules': [
{
'OrganizationConfigRuleName': 'string',
'OrganizationConfigRuleArn': 'string',
'OrganizationManagedRuleMetadata': {
'Description': 'string',
'RuleIdentifier': 'string',
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
'OrganizationCustomRuleMetadata': {
'Description': 'string',
'LambdaFunctionArn': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification'|'ScheduledNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
'ExcludedAccounts': [
'string',
],
'LastUpdateTime': datetime(2015, 1, 1),
'OrganizationCustomPolicyRuleMetadata': {
'Description': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string',
'PolicyRuntime': 'string',
'DebugLogDeliveryAccounts': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConfigRules (list) --
Returns a list of OrganizationConfigRule objects.
(dict) --
An organization Config rule that has information about Config rules that Config creates in member accounts.
OrganizationConfigRuleName (string) --
The name that you assign to organization Config rule.
OrganizationConfigRuleArn (string) --
Amazon Resource Name (ARN) of organization Config rule.
OrganizationManagedRuleMetadata (dict) --
An OrganizationManagedRuleMetadata object.
Description (string) --
The description that you provide for your organization Config rule.
RuleIdentifier (string) --
For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules .
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
OrganizationCustomRuleMetadata (dict) --
An OrganizationCustomRuleMetadata object.
Description (string) --
The description that you provide for your organization Config rule.
LambdaFunctionArn (string) --
The lambda function ARN.
OrganizationConfigRuleTriggerTypes (list) --
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
ExcludedAccounts (list) --
A comma-separated list of accounts excluded from organization Config rule.
LastUpdateTime (datetime) --
The timestamp of the last update.
OrganizationCustomPolicyRuleMetadata (dict) --
An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.
Description (string) --
The description that you provide for your organization Config Custom Policy rule.
OrganizationConfigRuleTriggerTypes (list) --
The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
PolicyRuntime (string) --
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
DebugLogDeliveryAccounts (list) --
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Provides organization conformance pack deployment status for an organization.
Note
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization_conformance_pack_statuses(
OrganizationConformancePackNames=[
'string',
],
Limit=123,
NextToken='string'
)
The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.
dict
Response Syntax
{
'OrganizationConformancePackStatuses': [
{
'OrganizationConformancePackName': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConformancePackStatuses (list) --
A list of OrganizationConformancePackStatus objects.
(dict) --
Returns the status for an organization conformance pack in an organization.
OrganizationConformancePackName (string) --
The name that you assign to organization conformance pack.
Status (string) --
Indicates deployment status of an organization conformance pack. When master account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When master account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the master account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
ErrorCode (string) --
An error code that is returned when organization conformance pack creation or deletion has failed in a member account.
ErrorMessage (string) --
An error message indicating that organization conformance pack creation or deletion failed due to an error.
LastUpdateTime (datetime) --
The timestamp of the last update.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns a list of organization conformance packs.
Note
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
See also: AWS API Documentation
Request Syntax
response = client.describe_organization_conformance_packs(
OrganizationConformancePackNames=[
'string',
],
Limit=123,
NextToken='string'
)
The name that you assign to an organization conformance pack.
dict
Response Syntax
{
'OrganizationConformancePacks': [
{
'OrganizationConformancePackName': 'string',
'OrganizationConformancePackArn': 'string',
'DeliveryS3Bucket': 'string',
'DeliveryS3KeyPrefix': 'string',
'ConformancePackInputParameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
'ExcludedAccounts': [
'string',
],
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConformancePacks (list) --
Returns a list of OrganizationConformancePacks objects.
(dict) --
An organization conformance pack that has information about conformance packs that Config creates in member accounts.
OrganizationConformancePackName (string) --
The name you assign to an organization conformance pack.
OrganizationConformancePackArn (string) --
Amazon Resource Name (ARN) of organization conformance pack.
DeliveryS3Bucket (string) --
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional.
DeliveryS3KeyPrefix (string) --
Any folder structure you want to add to an Amazon S3 bucket.
Note
This field is optional.
ConformancePackInputParameters (list) --
A list of ConformancePackInputParameter objects.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) --
One part of a key-value pair.
ParameterValue (string) --
Another part of the key-value pair.
ExcludedAccounts (list) --
A comma-separated list of accounts excluded from organization conformance pack.
LastUpdateTime (datetime) --
Last time when organization conformation pack was updated.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns a list of all pending aggregation requests.
See also: AWS API Documentation
Request Syntax
response = client.describe_pending_aggregation_requests(
Limit=123,
NextToken='string'
)
dict
Response Syntax
{
'PendingAggregationRequests': [
{
'RequesterAccountId': 'string',
'RequesterAwsRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
PendingAggregationRequests (list) --
Returns a PendingAggregationRequests object.
(dict) --
An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.
RequesterAccountId (string) --
The 12-digit account ID of the account requesting to aggregate data.
RequesterAwsRegion (string) --
The region requesting to aggregate data.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the details of one or more remediation configurations.
See also: AWS API Documentation
Request Syntax
response = client.describe_remediation_configurations(
ConfigRuleNames=[
'string',
]
)
[REQUIRED]
A list of Config rule names of remediation configurations for which you want details.
{
'RemediationConfigurations': [
{
'ConfigRuleName': 'string',
'TargetType': 'SSM_DOCUMENT',
'TargetId': 'string',
'TargetVersion': 'string',
'Parameters': {
'string': {
'ResourceValue': {
'Value': 'RESOURCE_ID'
},
'StaticValue': {
'Values': [
'string',
]
}
}
},
'ResourceType': 'string',
'Automatic': True|False,
'ExecutionControls': {
'SsmControls': {
'ConcurrentExecutionRatePercentage': 123,
'ErrorPercentage': 123
}
},
'MaximumAutomaticAttempts': 123,
'RetryAttemptSeconds': 123,
'Arn': 'string',
'CreatedByService': 'string'
},
]
}
Response Structure
Returns a remediation configuration object.
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
The name of the Config rule.
The type of the target. Target executes remediation. For example, SSM document.
Target ID is the name of the public document.
Version of the target. For example, version of the SSM document.
Note
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
An object of the RemediationParameterValue.
The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.
The value is dynamic and changes at run-time.
The value is a resource ID.
The value is static and does not change at run-time.
A list of values. For example, the ARN of the assumed role.
The type of a resource.
The remediation is triggered automatically.
An ExecutionControls object.
A SsmControls object.
The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.
The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
Amazon Resource Name (ARN) of remediation configuration.
Name of the service that owns the service linked rule, if applicable.
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Note
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
See also: AWS API Documentation
Request Syntax
response = client.describe_remediation_exceptions(
ConfigRuleName='string',
ResourceKeys=[
{
'ResourceType': 'string',
'ResourceId': 'string'
},
],
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the Config rule.
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
The details that identify a resource within Config, including the resource type and resource ID.
The type of a resource.
The ID of the resource (for example., sg-xxxxxx).
dict
Response Syntax
{
'RemediationExceptions': [
{
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'Message': 'string',
'ExpirationTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RemediationExceptions (list) --
Returns a list of remediation exception objects.
(dict) --
An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.
ConfigRuleName (string) --
The name of the Config rule.
ResourceType (string) --
The type of a resource.
ResourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
Message (string) --
An explanation of an remediation exception.
ExpirationTime (datetime) --
The time when the remediation exception will be deleted.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
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. When you specify the limit and the next token, you receive a paginated response.
See also: AWS API Documentation
Request Syntax
response = client.describe_remediation_execution_status(
ConfigRuleName='string',
ResourceKeys=[
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
],
Limit=123,
NextToken='string'
)
[REQUIRED]
A list of Config rule names.
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
The details that identify a resource within Config, including the resource type and resource ID.
The resource type.
The ID of the resource (for example., sg-xxxxxx).
dict
Response Syntax
{
'RemediationExecutionStatuses': [
{
'ResourceKey': {
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'StepDetails': [
{
'Name': 'string',
'State': 'SUCCEEDED'|'PENDING'|'FAILED',
'ErrorMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
},
],
'InvocationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RemediationExecutionStatuses (list) --
Returns a list of remediation execution statuses objects.
(dict) --
Provides details of the current status of the invoked remediation action for that resource.
ResourceKey (dict) --
The details that identify a resource within Config, including the resource type and resource ID.
resourceType (string) --
The resource type.
resourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
State (string) --
ENUM of the values.
StepDetails (list) --
Details of every step.
(dict) --
Name of the step from the SSM document.
Name (string) --
The details of the step.
State (string) --
The valid status of the step.
ErrorMessage (string) --
An error message if the step was interrupted during execution.
StartTime (datetime) --
The time when the step started.
StopTime (datetime) --
The time when the step stopped.
InvocationTime (datetime) --
Start time when the remediation was executed.
LastUpdatedTime (datetime) --
The time when the remediation execution was last updated.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Note
Currently, Config supports only one retention configuration per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.describe_retention_configurations(
RetentionConfigurationNames=[
'string',
],
NextToken='string'
)
A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.
Note
Currently, Config supports only one retention configuration per region in your account.
dict
Response Syntax
{
'RetentionConfigurations': [
{
'Name': 'string',
'RetentionPeriodInDays': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
RetentionConfigurations (list) --
Returns a retention configuration object.
(dict) --
An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.
Name (string) --
The name of the retention configuration object.
RetentionPeriodInDays (integer) --
Number of days Config stores your historical information.
Note
Currently, only applicable to the configuration item history.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
Note
The results can return an empty result page. But if you have a nextToken , the results are displayed on the next page.
See also: AWS API Documentation
Request Syntax
response = client.get_aggregate_compliance_details_by_config_rule(
ConfigurationAggregatorName='string',
ConfigRuleName='string',
AccountId='string',
AwsRegion='string',
ComplianceType='COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
The name of the Config rule for which you want compliance information.
[REQUIRED]
The 12-digit account ID of the source account.
[REQUIRED]
The source region from where the data is aggregated.
The resource compliance status.
Note
For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.
dict
Response Syntax
{
'AggregateEvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'AccountId': 'string',
'AwsRegion': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
AggregateEvaluationResults (list) --
Returns an AggregateEvaluationResults object.
(dict) --
The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
The resource compliance status.
For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.
ResultRecordedTime (datetime) --
The time when Config recorded the aggregate evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the agrregate evaluation determined the compliance.
AccountId (string) --
The 12-digit account ID of the source account.
AwsRegion (string) --
The source region from where the data is aggregated.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
Note
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
See also: AWS API Documentation
Request Syntax
response = client.get_aggregate_config_rule_compliance_summary(
ConfigurationAggregatorName='string',
Filters={
'AccountId': 'string',
'AwsRegion': 'string'
},
GroupByKey='ACCOUNT_ID'|'AWS_REGION',
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
Filters the results based on the ConfigRuleComplianceSummaryFilters object.
The 12-digit account ID of the source account.
The source region where the data is aggregated.
dict
Response Syntax
{
'GroupByKey': 'string',
'AggregateComplianceCounts': [
{
'GroupName': 'string',
'ComplianceSummary': {
'CompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'NonCompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
GroupByKey (string) --
Groups the result based on ACCOUNT_ID or AWS_REGION.
AggregateComplianceCounts (list) --
Returns a list of AggregateComplianceCounts object.
(dict) --
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
GroupName (string) --
The 12-digit account ID or region based on the GroupByKey value.
ComplianceSummary (dict) --
The number of compliant and noncompliant Config rules.
CompliantResourceCount (dict) --
The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
NonCompliantResourceCount (dict) --
The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
ComplianceSummaryTimestamp (datetime) --
The time that Config created the compliance summary.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
Note
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
See also: AWS API Documentation
Request Syntax
response = client.get_aggregate_conformance_pack_compliance_summary(
ConfigurationAggregatorName='string',
Filters={
'AccountId': 'string',
'AwsRegion': 'string'
},
GroupByKey='ACCOUNT_ID'|'AWS_REGION',
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.
The 12-digit Amazon Web Services account ID of the source account.
The source Amazon Web Services Region from where the data is aggregated.
dict
Response Syntax
{
'AggregateConformancePackComplianceSummaries': [
{
'ComplianceSummary': {
'CompliantConformancePackCount': 123,
'NonCompliantConformancePackCount': 123
},
'GroupName': 'string'
},
],
'GroupByKey': 'string',
'NextToken': 'string'
}
Response Structure
(dict) --
AggregateConformancePackComplianceSummaries (list) --
Returns a list of AggregateConformancePackComplianceSummary object.
(dict) --
Provides a summary of compliance based on either account ID or region.
ComplianceSummary (dict) --
Returns an AggregateConformancePackComplianceCount object.
CompliantConformancePackCount (integer) --
Number of compliant conformance packs.
NonCompliantConformancePackCount (integer) --
Number of noncompliant conformance packs.
GroupName (string) --
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
GroupByKey (string) --
Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
See also: AWS API Documentation
Request Syntax
response = client.get_aggregate_discovered_resource_counts(
ConfigurationAggregatorName='string',
Filters={
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'AccountId': 'string',
'Region': 'string'
},
GroupByKey='RESOURCE_TYPE'|'ACCOUNT_ID'|'AWS_REGION',
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
Filters the results based on the ResourceCountFilters object.
The type of the Amazon Web Services resource.
The 12-digit ID of the account.
The region where the account is located.
dict
Response Syntax
{
'TotalDiscoveredResources': 123,
'GroupByKey': 'string',
'GroupedResourceCounts': [
{
'GroupName': 'string',
'ResourceCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
TotalDiscoveredResources (integer) --
The total number of resources that are present in an aggregator with the filters that you provide.
GroupByKey (string) --
The key passed into the request object. If GroupByKey is not provided, the result will be empty.
GroupedResourceCounts (list) --
Returns a list of GroupedResourceCount objects.
(dict) --
The count of resources that are grouped by the group name.
GroupName (string) --
The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey .
ResourceCount (integer) --
The number of resources in the group.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
See also: AWS API Documentation
Request Syntax
response = client.get_aggregate_resource_config(
ConfigurationAggregatorName='string',
ResourceIdentifier={
'SourceAccountId': 'string',
'SourceRegion': 'string',
'ResourceId': 'string',
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'ResourceName': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
An object that identifies aggregate resource.
The 12-digit account ID of the source account.
The source region where data is aggregated.
The ID of the Amazon Web Services resource.
The type of the Amazon Web Services resource.
The name of the Amazon Web Services resource.
dict
Response Syntax
{
'ConfigurationItem': {
'version': 'string',
'accountId': 'string',
'configurationItemCaptureTime': datetime(2015, 1, 1),
'configurationItemStatus': 'OK'|'ResourceDiscovered'|'ResourceNotRecorded'|'ResourceDeleted'|'ResourceDeletedNotRecorded',
'configurationStateId': 'string',
'configurationItemMD5Hash': 'string',
'arn': 'string',
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'awsRegion': 'string',
'availabilityZone': 'string',
'resourceCreationTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'relatedEvents': [
'string',
],
'relationships': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'relationshipName': 'string'
},
],
'configuration': 'string',
'supplementaryConfiguration': {
'string': 'string'
}
}
}
Response Structure
(dict) --
ConfigurationItem (dict) --
Returns a ConfigurationItem object.
version (string) --
The version number of the resource configuration.
accountId (string) --
The 12-digit Amazon Web Services account ID associated with the resource.
configurationItemCaptureTime (datetime) --
The time when the configuration recording was initiated.
configurationItemStatus (string) --
The configuration item status. The valid values are:
Note
The CIs do not incur any cost.
configurationStateId (string) --
An identifier that indicates the ordering of the configuration items of a resource.
configurationItemMD5Hash (string) --
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
arn (string) --
Amazon Resource Name (ARN) associated with the resource.
resourceType (string) --
The type of Amazon Web Services resource.
resourceId (string) --
The ID of the resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the resource, if available.
awsRegion (string) --
The region where the resource resides.
availabilityZone (string) --
The Availability Zone associated with the resource.
resourceCreationTime (datetime) --
The time stamp when the resource was created.
tags (dict) --
A mapping of key value tags associated with the resource.
relatedEvents (list) --
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail .
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
relationships (list) --
A list of related Amazon Web Services resources.
(dict) --
The relationship of the related resource to the main resource.
resourceType (string) --
The resource type of the related resource.
resourceId (string) --
The ID of the related resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the related resource, if available.
relationshipName (string) --
The type of relationship with the related resource.
configuration (string) --
The description of the resource configuration.
supplementaryConfiguration (dict) --
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
Exceptions
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
See also: AWS API Documentation
Request Syntax
response = client.get_compliance_details_by_config_rule(
ConfigRuleName='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the Config rule for which you want compliance information.
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE .
dict
Response Syntax
{
'EvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'ResultToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationResults (list) --
Indicates whether the Amazon Web Services resource complies with the specified Config rule.
(dict) --
The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the EvaluationResult data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.
ResultRecordedTime (datetime) --
The time when Config recorded the evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
ResultToken (string) --
An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
See also: AWS API Documentation
Request Syntax
response = client.get_compliance_details_by_resource(
ResourceType='string',
ResourceId='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
NextToken='string'
)
[REQUIRED]
The type of the Amazon Web Services resource for which you want compliance information.
[REQUIRED]
The ID of the Amazon Web Services resource for which you want compliance information.
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE .
dict
Response Syntax
{
'EvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'ResultToken': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
EvaluationResults (list) --
Indicates whether the specified Amazon Web Services resource complies each Config rule.
(dict) --
The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the EvaluationResult data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.
ResultRecordedTime (datetime) --
The time when Config recorded the evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
ResultToken (string) --
An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
NextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
See also: AWS API Documentation
Request Syntax
response = client.get_compliance_summary_by_config_rule()
{
'ComplianceSummary': {
'CompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'NonCompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
}
}
Response Structure
The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.
The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
Indicates whether the maximum count is reached.
The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
Indicates whether the maximum count is reached.
The time that Config created the compliance summary.
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
See also: AWS API Documentation
Request Syntax
response = client.get_compliance_summary_by_resource_type(
ResourceTypes=[
'string',
]
)
Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance . You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account .
{
'ComplianceSummariesByResourceType': [
{
'ResourceType': 'string',
'ComplianceSummary': {
'CompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'NonCompliantResourceCount': {
'CappedCount': 123,
'CapExceeded': True|False
},
'ComplianceSummaryTimestamp': datetime(2015, 1, 1)
}
},
]
}
Response Structure
The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.
The number of Amazon Web Services resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each.
The type of Amazon Web Services resource.
The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.
The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
Indicates whether the maximum count is reached.
The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
Indicates whether the maximum count is reached.
The time that Config created the compliance summary.
Exceptions
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
See also: AWS API Documentation
Request Syntax
response = client.get_conformance_pack_compliance_details(
ConformancePackName='string',
Filters={
'ConfigRuleNames': [
'string',
],
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'ResourceType': 'string',
'ResourceIds': [
'string',
]
},
Limit=123,
NextToken='string'
)
[REQUIRED]
Name of the conformance pack.
A ConformancePackEvaluationFilters object.
Filters the results by Config rule names.
Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not supported.
Filters the results by the resource type (for example, "AWS::EC2::Instance" ).
Filters the results by resource IDs.
Note
This is valid only when you provide resource type. If there is no resource type, you will see an error.
dict
Response Syntax
{
'ConformancePackName': 'string',
'ConformancePackRuleEvaluationResults': [
{
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'ResultRecordedTime': datetime(2015, 1, 1),
'Annotation': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackRuleEvaluationResults (list) --
Returns a list of ConformancePackEvaluationResult objects.
(dict) --
The details of a conformance pack evaluation. Provides Config rule and Amazon Web Services resource type that was evaluated, the compliance of the conformance pack, related time stamps, and supplementary information.
ComplianceType (string) --
The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT . INSUFFICIENT_DATA is not supported.
EvaluationResultIdentifier (dict) --
Uniquely identifies an evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ConfigRuleInvokedTime (datetime) --
The time when Config rule evaluated Amazon Web Services resource.
ResultRecordedTime (datetime) --
The time when Config recorded the evaluation result.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
See also: AWS API Documentation
Request Syntax
response = client.get_conformance_pack_compliance_summary(
ConformancePackNames=[
'string',
],
Limit=123,
NextToken='string'
)
[REQUIRED]
Names of conformance packs.
dict
Response Syntax
{
'ConformancePackComplianceSummaryList': [
{
'ConformancePackName': 'string',
'ConformancePackComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ConformancePackComplianceSummaryList (list) --
A list of ConformancePackComplianceSummary objects.
(dict) --
Summary includes the name and status of the conformance pack.
ConformancePackName (string) --
The name of the conformance pack name.
ConformancePackComplianceStatus (string) --
The status of the conformance pack. The allowed values are COMPLIANT , NON_COMPLIANT and INSUFFICIENT_DATA .
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the policy definition containing the logic for your Config Custom Policy rule.
See also: AWS API Documentation
Request Syntax
response = client.get_custom_rule_policy(
ConfigRuleName='string'
)
{
'PolicyText': 'string'
}
Response Structure
The policy definition containing the logic for your Config Custom Policy rule.
Exceptions
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.
Example
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.
Note
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
See also: AWS API Documentation
Request Syntax
response = client.get_discovered_resource_counts(
resourceTypes=[
'string',
],
limit=123,
nextToken='string'
)
The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance" , "AWS::IAM::User" ).
If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.
Note
If the configuration recorder is turned off, Config returns an empty list of ResourceCount objects. If the configuration recorder is not recording a specific resource type (for example, S3 buckets), that resource type is not returned in the list of ResourceCount objects.
dict
Response Syntax
{
'totalDiscoveredResources': 123,
'resourceCounts': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'count': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
totalDiscoveredResources (integer) --
The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.
Example
resourceCounts (list) --
The list of ResourceCount objects. Each object is listed in descending order by the number of resources.
(dict) --
An object that contains the resource type and the number of resources.
resourceType (string) --
The resource type (for example, "AWS::EC2::Instance" ).
count (integer) --
The number of resources.
nextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns detailed status for each member account within an organization for a given organization Config rule.
See also: AWS API Documentation
Request Syntax
response = client.get_organization_config_rule_detailed_status(
OrganizationConfigRuleName='string',
Filters={
'AccountId': 'string',
'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of your organization Config rule for which you want status details for member accounts.
A StatusDetailFilters object.
The 12-digit account ID of the member account within an organization.
Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
dict
Response Syntax
{
'OrganizationConfigRuleDetailedStatus': [
{
'AccountId': 'string',
'ConfigRuleName': 'string',
'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConfigRuleDetailedStatus (list) --
A list of MemberAccountStatus objects.
(dict) --
Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.
AccountId (string) --
The 12-digit account ID of a member account.
ConfigRuleName (string) --
The name of Config rule deployed in the member account.
MemberAccountRuleStatus (string) --
Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
ErrorCode (string) --
An error code that is returned when Config rule creation or deletion failed in the member account.
ErrorMessage (string) --
An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.
LastUpdateTime (datetime) --
The timestamp of the last status update.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns detailed status for each member account within an organization for a given organization conformance pack.
See also: AWS API Documentation
Request Syntax
response = client.get_organization_conformance_pack_detailed_status(
OrganizationConformancePackName='string',
Filters={
'AccountId': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of organization conformance pack for which you want status details for member accounts.
An OrganizationResourceDetailedStatusFilters object.
The 12-digit account ID of the member account within an organization.
Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
dict
Response Syntax
{
'OrganizationConformancePackDetailedStatuses': [
{
'AccountId': 'string',
'ConformancePackName': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
OrganizationConformancePackDetailedStatuses (list) --
A list of OrganizationConformancePackDetailedStatus objects.
(dict) --
Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.
AccountId (string) --
The 12-digit account ID of a member account.
ConformancePackName (string) --
The name of conformance pack deployed in the member account.
Status (string) --
Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
ErrorCode (string) --
An error code that is returned when conformance pack creation or deletion failed in the member account.
ErrorMessage (string) --
An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.
LastUpdateTime (datetime) --
The timestamp of the last status update.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
See also: AWS API Documentation
Request Syntax
response = client.get_organization_custom_rule_policy(
OrganizationConfigRuleName='string'
)
[REQUIRED]
The name of your organization Config Custom Policy rule.
{
'PolicyText': 'string'
}
Response Structure
The policy definition containing the logic for your organization Config Custom Policy rule.
Exceptions
Create a paginator for an operation.
Returns a list of ConfigurationItems for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems for the specified retention period.
The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.
Note
Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit . In such cases, you can make another call, using the nextToken .
See also: AWS API Documentation
Request Syntax
response = client.get_resource_config_history(
resourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
resourceId='string',
laterTime=datetime(2015, 1, 1),
earlierTime=datetime(2015, 1, 1),
chronologicalOrder='Reverse'|'Forward',
limit=123,
nextToken='string'
)
[REQUIRED]
The resource type.
[REQUIRED]
The ID of the resource (for example., sg-xxxxxx ).
dict
Response Syntax
{
'configurationItems': [
{
'version': 'string',
'accountId': 'string',
'configurationItemCaptureTime': datetime(2015, 1, 1),
'configurationItemStatus': 'OK'|'ResourceDiscovered'|'ResourceNotRecorded'|'ResourceDeleted'|'ResourceDeletedNotRecorded',
'configurationStateId': 'string',
'configurationItemMD5Hash': 'string',
'arn': 'string',
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'awsRegion': 'string',
'availabilityZone': 'string',
'resourceCreationTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'relatedEvents': [
'string',
],
'relationships': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'relationshipName': 'string'
},
],
'configuration': 'string',
'supplementaryConfiguration': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The output for the GetResourceConfigHistory action.
configurationItems (list) --
A list that contains the configuration history of one or more resources.
(dict) --
A list that contains detailed configurations of a specified resource.
version (string) --
The version number of the resource configuration.
accountId (string) --
The 12-digit Amazon Web Services account ID associated with the resource.
configurationItemCaptureTime (datetime) --
The time when the configuration recording was initiated.
configurationItemStatus (string) --
The configuration item status. The valid values are:
Note
The CIs do not incur any cost.
configurationStateId (string) --
An identifier that indicates the ordering of the configuration items of a resource.
configurationItemMD5Hash (string) --
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
arn (string) --
Amazon Resource Name (ARN) associated with the resource.
resourceType (string) --
The type of Amazon Web Services resource.
resourceId (string) --
The ID of the resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the resource, if available.
awsRegion (string) --
The region where the resource resides.
availabilityZone (string) --
The Availability Zone associated with the resource.
resourceCreationTime (datetime) --
The time stamp when the resource was created.
tags (dict) --
A mapping of key value tags associated with the resource.
relatedEvents (list) --
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail .
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
relationships (list) --
A list of related Amazon Web Services resources.
(dict) --
The relationship of the related resource to the main resource.
resourceType (string) --
The resource type of the related resource.
resourceId (string) --
The ID of the related resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the related resource, if available.
relationshipName (string) --
The type of relationship with the related resource.
configuration (string) --
The description of the resource configuration.
supplementaryConfiguration (dict) --
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
nextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Returns the details of a specific stored query.
See also: AWS API Documentation
Request Syntax
response = client.get_stored_query(
QueryName='string'
)
[REQUIRED]
The name of the query.
{
'StoredQuery': {
'QueryId': 'string',
'QueryArn': 'string',
'QueryName': 'string',
'Description': 'string',
'Expression': 'string'
}
}
Response Structure
Returns a StoredQuery object.
The ID of the query.
Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
The name of the query.
A unique description for the query.
The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.
Exceptions
Returns an object that can wait for some condition.
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
See also: AWS API Documentation
Request Syntax
response = client.list_aggregate_discovered_resources(
ConfigurationAggregatorName='string',
ResourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
Filters={
'AccountId': 'string',
'ResourceId': 'string',
'ResourceName': 'string',
'Region': 'string'
},
Limit=123,
NextToken='string'
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
The type of resources that you want Config to list in the response.
Filters the results based on the ResourceFilters object.
The 12-digit source account ID.
The ID of the resource.
The name of the resource.
The source region.
dict
Response Syntax
{
'ResourceIdentifiers': [
{
'SourceAccountId': 'string',
'SourceRegion': 'string',
'ResourceId': 'string',
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'ResourceName': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
Returns a list of ResourceIdentifiers objects.
(dict) --
The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.
SourceAccountId (string) --
The 12-digit account ID of the source account.
SourceRegion (string) --
The source region where data is aggregated.
ResourceId (string) --
The ID of the Amazon Web Services resource.
ResourceType (string) --
The type of the Amazon Web Services resource.
ResourceName (string) --
The name of the Amazon Web Services resource.
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
Note
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.
See also: AWS API Documentation
Request Syntax
response = client.list_discovered_resources(
resourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
resourceIds=[
'string',
],
resourceName='string',
limit=123,
includeDeletedResources=True|False,
nextToken='string'
)
[REQUIRED]
The type of resources that you want Config to list in the response.
The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
dict
Response Syntax
{
'resourceIdentifiers': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'resourceDeletionTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
resourceIdentifiers (list) --
The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
(dict) --
The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
resourceType (string) --
The type of resource.
resourceId (string) --
The ID of the resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the resource (if available).
resourceDeletionTime (datetime) --
The time that the resource was deleted.
nextToken (string) --
The string that you use in a subsequent request to get the next page of results in a paginated response.
Exceptions
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
See also: AWS API Documentation
Request Syntax
response = client.list_stored_queries(
NextToken='string',
MaxResults=123
)
dict
Response Syntax
{
'StoredQueryMetadata': [
{
'QueryId': 'string',
'QueryArn': 'string',
'QueryName': 'string',
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StoredQueryMetadata (list) --
A list of StoredQueryMetadata objects.
(dict) --
Returns details of a specific query.
QueryId (string) --
The ID of the query.
QueryArn (string) --
Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
QueryName (string) --
The name of the query.
Description (string) --
A unique description for the query.
NextToken (string) --
If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null .
Exceptions
List the tags for Config resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
ResourceArn='string',
Limit=123,
NextToken='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule , ConfigurationAggregator and AggregatorAuthorization .
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Tags (list) --
The tags for the resource.
(dict) --
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
NextToken (string) --
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Exceptions
Authorizes the aggregator account and region to collect data from the source account and region.
See also: AWS API Documentation
Request Syntax
response = client.put_aggregation_authorization(
AuthorizedAccountId='string',
AuthorizedAwsRegion='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The 12-digit account ID of the account authorized to aggregate data.
[REQUIRED]
The region authorized to collect aggregated data.
An array of tag object.
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'AggregationAuthorization': {
'AggregationAuthorizationArn': 'string',
'AuthorizedAccountId': 'string',
'AuthorizedAwsRegion': 'string',
'CreationTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
AggregationAuthorization (dict) --
Returns an AggregationAuthorization object.
AggregationAuthorizationArn (string) --
The Amazon Resource Name (ARN) of the aggregation object.
AuthorizedAccountId (string) --
The 12-digit account ID of the account authorized to aggregate data.
AuthorizedAwsRegion (string) --
The region authorized to collect aggregated data.
CreationTime (datetime) --
The time stamp when the aggregation authorization was created.
Exceptions
Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.
You can use this action for custom Config rules and Config managed rules. A custom Config rule is a rule that you develop and maintain. An Config managed rule is a customizable, predefined rule that Config provides.
If you are adding a new custom Config rule, you must first create the Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.
If you are adding an Config managed rule, specify the rule's identifier for the SourceIdentifier key. To reference Config managed rule identifiers, see About Config managed rules .
For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId . These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName , ConfigRuleId , or ConfigRuleArn in the ConfigRule data type that you use in this request.
The maximum number of rules that Config supports is 150.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide .
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_config_rule(
ConfigRule={
'ConfigRuleName': 'string',
'ConfigRuleArn': 'string',
'ConfigRuleId': 'string',
'Description': 'string',
'Scope': {
'ComplianceResourceTypes': [
'string',
],
'TagKey': 'string',
'TagValue': 'string',
'ComplianceResourceId': 'string'
},
'Source': {
'Owner': 'CUSTOM_LAMBDA'|'AWS'|'CUSTOM_POLICY',
'SourceIdentifier': 'string',
'SourceDetails': [
{
'EventSource': 'aws.config',
'MessageType': 'ConfigurationItemChangeNotification'|'ConfigurationSnapshotDeliveryCompleted'|'ScheduledNotification'|'OversizedConfigurationItemChangeNotification',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
},
],
'CustomPolicyDetails': {
'PolicyRuntime': 'string',
'PolicyText': 'string',
'EnableDebugLogDelivery': True|False
}
},
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ConfigRuleState': 'ACTIVE'|'DELETING'|'DELETING_RESULTS'|'EVALUATING',
'CreatedBy': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The rule that you want to add to your account.
The name that you assign to the Config rule. The name is required if you are adding a new rule.
The Amazon Resource Name (ARN) of the Config rule.
The ID of the Config rule.
The description that you provide for the Config rule.
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
Note
The scope can be empty.
The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId .
The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue , you must also specify a value for TagKey .
The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Indicates whether Amazon Web Services or the customer owns and manages the Config rule.
Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.
Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY ) or Lambda (CUSTOM_LAMBDA ). For more information, see Config Custom Rules in the Config developer guide.
For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules .
For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name .
For Config Custom Policy rules, this field will be ignored.
Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
If the owner is set to CUSTOM_POLICY , the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification .
Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.
The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification .
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency , then MessageType must use the ScheduledNotification value.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours , Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY .
The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
The policy definition containing the logic for your Config Custom Policy rule.
The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false .
A string, in JSON format, that is passed to the Config rule Lambda function.
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
Service principal name of the service that created the rule.
Note
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
An array of tag object.
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
None
Exceptions
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeConfigurationAggregators to get the previous accounts and then append new ones.
Note
Config should be enabled in source accounts and regions you want to aggregate.
If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.
To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_aggregator(
ConfigurationAggregatorName='string',
AccountAggregationSources=[
{
'AccountIds': [
'string',
],
'AllAwsRegions': True|False,
'AwsRegions': [
'string',
]
},
],
OrganizationAggregationSource={
'RoleArn': 'string',
'AwsRegions': [
'string',
],
'AllAwsRegions': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The name of the configuration aggregator.
A list of AccountAggregationSource object.
A collection of accounts and regions.
The 12-digit account ID of the account being aggregated.
If true, aggregate existing Config regions and future regions.
The source regions being aggregated.
An OrganizationAggregationSource object.
ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
The source regions being aggregated.
If true, aggregate existing Config regions and future regions.
An array of tag object.
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'ConfigurationAggregator': {
'ConfigurationAggregatorName': 'string',
'ConfigurationAggregatorArn': 'string',
'AccountAggregationSources': [
{
'AccountIds': [
'string',
],
'AllAwsRegions': True|False,
'AwsRegions': [
'string',
]
},
],
'OrganizationAggregationSource': {
'RoleArn': 'string',
'AwsRegions': [
'string',
],
'AllAwsRegions': True|False
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
}
}
Response Structure
(dict) --
ConfigurationAggregator (dict) --
Returns a ConfigurationAggregator object.
ConfigurationAggregatorName (string) --
The name of the aggregator.
ConfigurationAggregatorArn (string) --
The Amazon Resource Name (ARN) of the aggregator.
AccountAggregationSources (list) --
Provides a list of source accounts and regions to be aggregated.
(dict) --
A collection of accounts and regions.
AccountIds (list) --
The 12-digit account ID of the account being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
AwsRegions (list) --
The source regions being aggregated.
OrganizationAggregationSource (dict) --
Provides an organization and list of regions to be aggregated.
RoleArn (string) --
ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
AwsRegions (list) --
The source regions being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
CreationTime (datetime) --
The time stamp when the configuration aggregator was created.
LastUpdatedTime (datetime) --
The time of the last update.
CreatedBy (string) --
Amazon Web Services service that created the configuration aggregator.
Exceptions
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
Note
Currently, you can specify only one configuration recorder per region in your account.
If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.
See also: AWS API Documentation
Request Syntax
response = client.put_configuration_recorder(
ConfigurationRecorder={
'name': 'string',
'roleARN': 'string',
'recordingGroup': {
'allSupported': True|False,
'includeGlobalResourceTypes': True|False,
'resourceTypes': [
'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
]
}
}
)
[REQUIRED]
The configuration recorder object that records each configuration change made to the resources.
The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.
Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.
Specifies the types of Amazon Web Services resources for which Config records configuration changes.
Specifies whether Config records configuration changes for every supported type of regional resource.
If you set this option to true , when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.
If you set this option to true , you cannot enumerate a list of resourceTypes .
Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
Before you can set this option to true , you must set the allSupported option to true .
If you set this option to true , when Config adds support for a new type of global resource, it starts recording resources of that type automatically.
The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.
A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail ).
To record all configuration changes, you must set the allSupported option to true .
If you set this option to false , when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
For a list of valid resourceTypes values, see the resourceType Value column in Supported Amazon Web Services resource Types .
Exceptions
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across Amazon Web Services Organization.
This API creates a service linked role AWSServiceRoleForConfigConforms in your account. The service linked role is created only when the role does not exist in your account.
Note
You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.
See also: AWS API Documentation
Request Syntax
response = client.put_conformance_pack(
ConformancePackName='string',
TemplateS3Uri='string',
TemplateBody='string',
DeliveryS3Bucket='string',
DeliveryS3KeyPrefix='string',
ConformancePackInputParameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
]
)
[REQUIRED]
Name of the conformance pack you want to create.
Location of file containing the template body (s3://bucketname/prefix ). The uri must point to the conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same region as the conformance pack.
Note
You must have access to read Amazon S3 bucket.
A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
Note
You can only use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule ) and a remediation action (AWS::Config::RemediationConfiguration ).
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional.
The prefix for the Amazon S3 bucket.
Note
This field is optional.
A list of ConformancePackInputParameter objects.
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
One part of a key-value pair.
Another part of the key-value pair.
dict
Response Syntax
{
'ConformancePackArn': 'string'
}
Response Structure
(dict) --
ConformancePackArn (string) --
ARN of the conformance pack.
Exceptions
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
Note
You can have only one delivery channel per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.put_delivery_channel(
DeliveryChannel={
'name': 'string',
's3BucketName': 'string',
's3KeyPrefix': 'string',
's3KmsKeyArn': 'string',
'snsTopicARN': 'string',
'configSnapshotDeliveryProperties': {
'deliveryFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
}
}
)
[REQUIRED]
The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.
The name of the delivery channel. By default, Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.
If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.
The prefix for the specified Amazon S3 bucket.
The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.
The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.
If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.
The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.
The frequency with which Config delivers configuration snapshots.
Exceptions
Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
See also: AWS API Documentation
Request Syntax
response = client.put_evaluations(
Evaluations=[
{
'ComplianceResourceType': 'string',
'ComplianceResourceId': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'Annotation': 'string',
'OrderingTimestamp': datetime(2015, 1, 1)
},
],
ResultToken='string',
TestMode=True|False
)
The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.
Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.
The type of Amazon Web Services resource that was evaluated.
The ID of the Amazon Web Services resource that was evaluated.
Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
For the Evaluation data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.
Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.
Supplementary information about how the evaluation determined the compliance.
The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).
[REQUIRED]
An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.
Use this parameter to specify a test run for PutEvaluations . You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.
Note
When TestMode is true , PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.
dict
Response Syntax
{
'FailedEvaluations': [
{
'ComplianceResourceType': 'string',
'ComplianceResourceId': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'Annotation': 'string',
'OrderingTimestamp': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
FailedEvaluations (list) --
Requests that failed because of a client or server error.
(dict) --
Identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that it was evaluated against.
ComplianceResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ComplianceResourceId (string) --
The ID of the Amazon Web Services resource that was evaluated.
ComplianceType (string) --
Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.
For the Evaluation data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.
Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
OrderingTimestamp (datetime) --
The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).
Exceptions
Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
See also: AWS API Documentation
Request Syntax
response = client.put_external_evaluation(
ConfigRuleName='string',
ExternalEvaluation={
'ComplianceResourceType': 'string',
'ComplianceResourceId': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'Annotation': 'string',
'OrderingTimestamp': datetime(2015, 1, 1)
}
)
[REQUIRED]
The name of the Config rule.
[REQUIRED]
An ExternalEvaluation object that provides details about compliance.
The evaluated compliance resource type. Config accepts AWS::::Account resource type.
The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.
The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE .
Supplementary information about the reason of compliance. For example, this task was completed on a specific date.
The time when the compliance was recorded.
dict
Response Syntax
{}
Response Structure
Exceptions
Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.
Only a master account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.
This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with GetRole action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com .
You can use this action to create both custom Config rules and Config managed rules. If you are adding a new custom Config rule, you must first create Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function. When you use the PutOrganizationConfigRule action to add the rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. If you are adding an Config managed rule, specify the rule's identifier for the RuleIdentifier key.
The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization.
Note
Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata .
See also: AWS API Documentation
Request Syntax
response = client.put_organization_config_rule(
OrganizationConfigRuleName='string',
OrganizationManagedRuleMetadata={
'Description': 'string',
'RuleIdentifier': 'string',
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
OrganizationCustomRuleMetadata={
'Description': 'string',
'LambdaFunctionArn': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification'|'ScheduledNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
ExcludedAccounts=[
'string',
],
OrganizationCustomPolicyRuleMetadata={
'Description': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string',
'PolicyRuntime': 'string',
'PolicyText': 'string',
'DebugLogDeliveryAccounts': [
'string',
]
}
)
[REQUIRED]
The name that you assign to an organization Config rule.
An OrganizationManagedRuleMetadata object.
The description that you provide for your organization Config rule.
For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules .
A string, in JSON format, that is passed to your organization Config rule Lambda function.
The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
The type of the Amazon Web Services resource that was evaluated.
The ID of the Amazon Web Services resource that was evaluated.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
An OrganizationCustomRuleMetadata object.
The description that you provide for your organization Config rule.
The lambda function ARN.
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
A string, in JSON format, that is passed to your organization Config rule Lambda function.
The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
The type of the Amazon Web Services resource that was evaluated.
The ID of the Amazon Web Services resource that was evaluated.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
A comma-separated list of accounts that you want to exclude from an organization Config rule.
An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.
The description that you provide for your organization Config Custom Policy rule.
The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
The type of the Amazon Web Services resource that was evaluated.
The ID of the Amazon Web Services resource that was evaluated.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
The policy definition containing the logic for your organization Config Custom Policy rule.
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
dict
Response Syntax
{
'OrganizationConfigRuleArn': 'string'
}
Response Structure
(dict) --
OrganizationConfigRuleArn (string) --
The Amazon Resource Name (ARN) of an organization Config rule.
Exceptions
Deploys conformance packs across member accounts in an Amazon Web Services Organization.
Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ListDelegatedAdministrator permissions are added.
This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com .
Note
Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.
You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.
Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization.
See also: AWS API Documentation
Request Syntax
response = client.put_organization_conformance_pack(
OrganizationConformancePackName='string',
TemplateS3Uri='string',
TemplateBody='string',
DeliveryS3Bucket='string',
DeliveryS3KeyPrefix='string',
ConformancePackInputParameters=[
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
ExcludedAccounts=[
'string',
]
)
[REQUIRED]
Name of the organization conformance pack you want to create.
Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).
Note
You must have access to read Amazon S3 bucket.
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional. If used, it must be prefixed with awsconfigconforms .
The prefix for the Amazon S3 bucket.
Note
This field is optional.
A list of ConformancePackInputParameter objects.
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
One part of a key-value pair.
Another part of the key-value pair.
A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.
dict
Response Syntax
{
'OrganizationConformancePackArn': 'string'
}
Response Structure
(dict) --
OrganizationConformancePackArn (string) --
ARN of the organization conformance pack.
Exceptions
Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
Note
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
See also: AWS API Documentation
Request Syntax
response = client.put_remediation_configurations(
RemediationConfigurations=[
{
'ConfigRuleName': 'string',
'TargetType': 'SSM_DOCUMENT',
'TargetId': 'string',
'TargetVersion': 'string',
'Parameters': {
'string': {
'ResourceValue': {
'Value': 'RESOURCE_ID'
},
'StaticValue': {
'Values': [
'string',
]
}
}
},
'ResourceType': 'string',
'Automatic': True|False,
'ExecutionControls': {
'SsmControls': {
'ConcurrentExecutionRatePercentage': 123,
'ErrorPercentage': 123
}
},
'MaximumAutomaticAttempts': 123,
'RetryAttemptSeconds': 123,
'Arn': 'string',
'CreatedByService': 'string'
},
]
)
[REQUIRED]
A list of remediation configuration objects.
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
The name of the Config rule.
The type of the target. Target executes remediation. For example, SSM document.
Target ID is the name of the public document.
Version of the target. For example, version of the SSM document.
Note
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
An object of the RemediationParameterValue.
The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.
The value is dynamic and changes at run-time.
The value is a resource ID.
The value is static and does not change at run-time.
A list of values. For example, the ARN of the assumed role.
The type of a resource.
The remediation is triggered automatically.
An ExecutionControls object.
A SsmControls object.
The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.
The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
Amazon Resource Name (ARN) of remediation configuration.
Name of the service that owns the service linked rule, if applicable.
{
'FailedBatches': [
{
'FailureMessage': 'string',
'FailedItems': [
{
'ConfigRuleName': 'string',
'TargetType': 'SSM_DOCUMENT',
'TargetId': 'string',
'TargetVersion': 'string',
'Parameters': {
'string': {
'ResourceValue': {
'Value': 'RESOURCE_ID'
},
'StaticValue': {
'Values': [
'string',
]
}
}
},
'ResourceType': 'string',
'Automatic': True|False,
'ExecutionControls': {
'SsmControls': {
'ConcurrentExecutionRatePercentage': 123,
'ErrorPercentage': 123
}
},
'MaximumAutomaticAttempts': 123,
'RetryAttemptSeconds': 123,
'Arn': 'string',
'CreatedByService': 'string'
},
]
},
]
}
Response Structure
Returns a list of failed remediation batch objects.
List of each of the failed remediations with specific reasons.
Returns a failure message. For example, the resource is already compliant.
Returns remediation configurations of the failed items.
An object that represents the details about the remediation configuration that includes the remediation action, parameters, and data to execute the action.
The name of the Config rule.
The type of the target. Target executes remediation. For example, SSM document.
Target ID is the name of the public document.
Version of the target. For example, version of the SSM document.
Note
If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.
An object of the RemediationParameterValue.
The value is either a dynamic (resource) value or a static value. You must select either a dynamic value or a static value.
The value is dynamic and changes at run-time.
The value is a resource ID.
The value is static and does not change at run-time.
A list of values. For example, the ARN of the assumed role.
The type of a resource.
The remediation is triggered automatically.
An ExecutionControls object.
A SsmControls object.
The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.
The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.
The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.
For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.
Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.
For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.
Amazon Resource Name (ARN) of remediation configuration.
Name of the service that owns the service linked rule, if applicable.
Exceptions
A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule.
Note
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
See also: AWS API Documentation
Request Syntax
response = client.put_remediation_exceptions(
ConfigRuleName='string',
ResourceKeys=[
{
'ResourceType': 'string',
'ResourceId': 'string'
},
],
Message='string',
ExpirationTime=datetime(2015, 1, 1)
)
[REQUIRED]
The name of the Config rule for which you want to create remediation exception.
[REQUIRED]
An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.
The details that identify a resource within Config, including the resource type and resource ID.
The type of a resource.
The ID of the resource (for example., sg-xxxxxx).
dict
Response Syntax
{
'FailedBatches': [
{
'FailureMessage': 'string',
'FailedItems': [
{
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string',
'Message': 'string',
'ExpirationTime': datetime(2015, 1, 1)
},
]
},
]
}
Response Structure
(dict) --
FailedBatches (list) --
Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
(dict) --
List of each of the failed remediation exceptions with specific reasons.
FailureMessage (string) --
Returns a failure message. For example, the auto-remediation has failed.
FailedItems (list) --
Returns remediation exception resource key object of the failed items.
(dict) --
An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.
ConfigRuleName (string) --
The name of the Config rule.
ResourceType (string) --
The type of a resource.
ResourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
Message (string) --
An explanation of an remediation exception.
ExpirationTime (datetime) --
The time when the remediation exception will be deleted.
Exceptions
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
Note
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
See also: AWS API Documentation
Request Syntax
response = client.put_resource_config(
ResourceType='string',
SchemaVersionId='string',
ResourceId='string',
ResourceName='string',
Configuration='string',
Tags={
'string': 'string'
}
)
[REQUIRED]
The type of the resource. The custom resource type must be registered with CloudFormation.
Note
You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
[REQUIRED]
Version of the schema registered for the ResourceType in CloudFormation.
[REQUIRED]
Unique identifier of the resource.
[REQUIRED]
The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.
Note
The configuration JSON must not exceed 64 KB.
Tags associated with the resource.
None
Exceptions
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default . When you have a RetentionConfiguration object named default , calling the API modifies the default object.
Note
Currently, Config supports only one retention configuration per region in your account.
See also: AWS API Documentation
Request Syntax
response = client.put_retention_configuration(
RetentionPeriodInDays=123
)
[REQUIRED]
Number of days Config stores your historical information.
Note
Currently, only applicable to the configuration item history.
{
'RetentionConfiguration': {
'Name': 'string',
'RetentionPeriodInDays': 123
}
}
Response Structure
Returns a retention configuration object.
The name of the retention configuration object.
Number of days Config stores your historical information.
Note
Currently, only applicable to the configuration item history.
Exceptions
Saves a new query or updates an existing saved query. The QueryName must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
See also: AWS API Documentation
Request Syntax
response = client.put_stored_query(
StoredQuery={
'QueryId': 'string',
'QueryArn': 'string',
'QueryName': 'string',
'Description': 'string',
'Expression': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A list of StoredQuery objects. The mandatory fields are QueryName and Expression .
Note
When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.
The ID of the query.
Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
The name of the query.
A unique description for the query.
The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.
A list of Tags object.
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
dict
Response Syntax
{
'QueryArn': 'string'
}
Response Structure
(dict) --
QueryArn (string) --
Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.
Exceptions
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.
For more information about query components, see the ` Query Components https://docs.aws.amazon.com/config/latest/developerguide/query-components.html`__ section in the Config Developer Guide.
Note
If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT ; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId ) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.
If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType = 'AWS::IAM::Role' ) and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.
See also: AWS API Documentation
Request Syntax
response = client.select_aggregate_resource_config(
Expression='string',
ConfigurationAggregatorName='string',
Limit=123,
MaxResults=123,
NextToken='string'
)
[REQUIRED]
The SQL query SELECT command.
[REQUIRED]
The name of the configuration aggregator.
dict
Response Syntax
{
'Results': [
'string',
],
'QueryInfo': {
'SelectFields': [
{
'Name': 'string'
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
Returns the results for the SQL query.
QueryInfo (dict) --
Details about the query.
SelectFields (list) --
Returns a FieldInfo object.
(dict) --
Details about the fields such as name of the field.
Name (string) --
Name of the field.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the ` Query Components https://docs.aws.amazon.com/config/latest/developerguide/query-components.html`__ section in the Config Developer Guide.
See also: AWS API Documentation
Request Syntax
response = client.select_resource_config(
Expression='string',
Limit=123,
NextToken='string'
)
[REQUIRED]
The SQL query SELECT command.
dict
Response Syntax
{
'Results': [
'string',
],
'QueryInfo': {
'SelectFields': [
{
'Name': 'string'
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
Results (list) --
Returns the results for the SQL query.
QueryInfo (dict) --
Returns the QueryInfo object.
SelectFields (list) --
Returns a FieldInfo object.
(dict) --
Details about the fields such as name of the field.
Name (string) --
Name of the field.
NextToken (string) --
The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
Exceptions
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.
Note
You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:
See also: AWS API Documentation
Request Syntax
response = client.start_config_rules_evaluation(
ConfigRuleNames=[
'string',
]
)
The list of names of Config rules that you want to run evaluations for.
{}
Response Structure
The output when you start the evaluation for the specified Config rule.
Exceptions
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
See also: AWS API Documentation
Request Syntax
response = client.start_configuration_recorder(
ConfigurationRecorderName='string'
)
[REQUIRED]
The name of the recorder object that records each configuration change made to the resources.
Exceptions
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
See also: AWS API Documentation
Request Syntax
response = client.start_remediation_execution(
ConfigRuleName='string',
ResourceKeys=[
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
]
)
[REQUIRED]
The list of names of Config rules that you want to run remediation execution for.
[REQUIRED]
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
The details that identify a resource within Config, including the resource type and resource ID.
The resource type.
The ID of the resource (for example., sg-xxxxxx).
dict
Response Syntax
{
'FailureMessage': 'string',
'FailedItems': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
]
}
Response Structure
(dict) --
FailureMessage (string) --
Returns a failure message. For example, the resource is already compliant.
FailedItems (list) --
For resources that have failed to start execution, the API returns a resource key object.
(dict) --
The details that identify a resource within Config, including the resource type and resource ID.
resourceType (string) --
The resource type.
resourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
Exceptions
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
response = client.stop_configuration_recorder(
ConfigurationRecorderName='string'
)
[REQUIRED]
The name of the recorder object that records each configuration change made to the resources.
Exceptions
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule , ConfigurationAggregator and AggregatorAuthorization .
[REQUIRED]
An array of tag object.
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
None
Exceptions
Deletes specified tags from a resource.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceArn='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule , ConfigurationAggregator and AggregatorAuthorization .
[REQUIRED]
The keys of the tags to be removed.
None
Exceptions
The available paginators are:
paginator = client.get_paginator('describe_aggregate_compliance_by_config_rules')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_aggregate_compliance_by_config_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorName='string',
Filters={
'ConfigRuleName': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'AccountId': 'string',
'AwsRegion': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
Filters the results by ConfigRuleComplianceFilters object.
The name of the Config rule.
The rule compliance status.
For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.
The 12-digit account ID of the source account.
The source region where the data is aggregated.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AggregateComplianceByConfigRules': [
{
'ConfigRuleName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
},
'AccountId': 'string',
'AwsRegion': 'string'
},
],
}
Response Structure
(dict) --
AggregateComplianceByConfigRules (list) --
Returns a list of AggregateComplianceByConfigRule object.
(dict) --
Indicates whether an Config rule is compliant based on account ID, region, compliance, and rule name.
A rule is compliant if all of the resources that the rule evaluated comply with it. It is noncompliant if any of these resources do not comply.
ConfigRuleName (string) --
The name of the Config rule.
Compliance (dict) --
Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
AccountId (string) --
The 12-digit account ID of the source account.
AwsRegion (string) --
The source region from where the data is aggregated.
paginator = client.get_paginator('describe_aggregate_compliance_by_conformance_packs')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_aggregate_compliance_by_conformance_packs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorName='string',
Filters={
'ConformancePackName': 'string',
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'AccountId': 'string',
'AwsRegion': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
Filters the result by AggregateConformancePackComplianceFilters object.
The name of the conformance pack.
The compliance status of the conformance pack.
The 12-digit Amazon Web Services account ID of the source account.
The source Amazon Web Services Region from where the data is aggregated.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AggregateComplianceByConformancePacks': [
{
'ConformancePackName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA',
'CompliantRuleCount': 123,
'NonCompliantRuleCount': 123,
'TotalRuleCount': 123
},
'AccountId': 'string',
'AwsRegion': 'string'
},
],
}
Response Structure
(dict) --
AggregateComplianceByConformancePacks (list) --
Returns the AggregateComplianceByConformancePack object.
(dict) --
Provides aggregate compliance of the conformance pack. Indicates whether a conformance pack is compliant based on the name of the conformance pack, account ID, and region.
A conformance pack is compliant if all of the rules in a conformance packs are compliant. It is noncompliant if any of the rules are not compliant. The compliance status of a conformance pack is INSUFFICIENT_DATA only if all rules within a conformance pack cannot be evaluated due to insufficient data. If some of the rules in a conformance pack are compliant but the compliance status of other rules in that same conformance pack is INSUFFICIENT_DATA, the conformance pack shows compliant.
ConformancePackName (string) --
The name of the conformance pack.
Compliance (dict) --
The compliance status of the conformance pack.
ComplianceType (string) --
The compliance status of the conformance pack.
CompliantRuleCount (integer) --
The number of compliant Config Rules.
NonCompliantRuleCount (integer) --
The number of noncompliant Config Rules.
TotalRuleCount (integer) --
Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.
AccountId (string) --
The 12-digit Amazon Web Services account ID of the source account.
AwsRegion (string) --
The source Amazon Web Services Region from where the data is aggregated.
paginator = client.get_paginator('describe_aggregation_authorizations')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_aggregation_authorizations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'AggregationAuthorizations': [
{
'AggregationAuthorizationArn': 'string',
'AuthorizedAccountId': 'string',
'AuthorizedAwsRegion': 'string',
'CreationTime': datetime(2015, 1, 1)
},
],
}
Response Structure
Returns a list of authorizations granted to various aggregator accounts and regions.
An object that represents the authorizations granted to aggregator accounts and regions.
The Amazon Resource Name (ARN) of the aggregation object.
The 12-digit account ID of the account authorized to aggregate data.
The region authorized to collect aggregated data.
The time stamp when the aggregation authorization was created.
paginator = client.get_paginator('describe_compliance_by_config_rule')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_compliance_by_config_rule().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigRuleNames=[
'string',
],
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
Specify one or more Config rule names to filter the results by rule.
Filters the results by compliance.
The allowed values are COMPLIANT and NON_COMPLIANT .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ComplianceByConfigRules': [
{
'ConfigRuleName': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
}
},
],
}
Response Structure
(dict) --
ComplianceByConfigRules (list) --
Indicates whether each of the specified Config rules is compliant.
(dict) --
Indicates whether an Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it. A rule is noncompliant if any of these resources do not comply.
ConfigRuleName (string) --
The name of the Config rule.
Compliance (dict) --
Indicates whether the Config rule is compliant.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
paginator = client.get_paginator('describe_compliance_by_resource')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_compliance_by_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceType='string',
ResourceId='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ComplianceByResources': [
{
'ResourceType': 'string',
'ResourceId': 'string',
'Compliance': {
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ComplianceContributorCount': {
'CappedCount': 123,
'CapExceeded': True|False
}
}
},
],
}
Response Structure
(dict) --
ComplianceByResources (list) --
Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.
(dict) --
Indicates whether an Amazon Web Services resource that is evaluated according to one or more Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
ResourceType (string) --
The type of the Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the Amazon Web Services resource that was evaluated.
Compliance (dict) --
Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.
ComplianceType (string) --
Indicates whether an Amazon Web Services resource or Config rule is compliant.
A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.
A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.
Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.
For the Compliance data type, Config supports only COMPLIANT , NON_COMPLIANT , and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.
ComplianceContributorCount (dict) --
The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT , up to a maximum number.
CappedCount (integer) --
The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.
CapExceeded (boolean) --
Indicates whether the maximum count is reached.
paginator = client.get_paginator('describe_config_rule_evaluation_status')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_config_rule_evaluation_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigRuleNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConfigRulesEvaluationStatus': [
{
'ConfigRuleName': 'string',
'ConfigRuleArn': 'string',
'ConfigRuleId': 'string',
'LastSuccessfulInvocationTime': datetime(2015, 1, 1),
'LastFailedInvocationTime': datetime(2015, 1, 1),
'LastSuccessfulEvaluationTime': datetime(2015, 1, 1),
'LastFailedEvaluationTime': datetime(2015, 1, 1),
'FirstActivatedTime': datetime(2015, 1, 1),
'LastDeactivatedTime': datetime(2015, 1, 1),
'LastErrorCode': 'string',
'LastErrorMessage': 'string',
'FirstEvaluationStarted': True|False,
'LastDebugLogDeliveryStatus': 'string',
'LastDebugLogDeliveryStatusReason': 'string',
'LastDebugLogDeliveryTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ConfigRulesEvaluationStatus (list) --
Status information about your Config managed rules.
(dict) --
Status information for your Config Managed rules and Config Custom Policy rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.
This action does not return status information about Config Custom Lambda rules.
ConfigRuleName (string) --
The name of the Config rule.
ConfigRuleArn (string) --
The Amazon Resource Name (ARN) of the Config rule.
ConfigRuleId (string) --
The ID of the Config rule.
LastSuccessfulInvocationTime (datetime) --
The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.
LastFailedInvocationTime (datetime) --
The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.
LastSuccessfulEvaluationTime (datetime) --
The time that Config last successfully evaluated your Amazon Web Services resources against the rule.
LastFailedEvaluationTime (datetime) --
The time that Config last failed to evaluate your Amazon Web Services resources against the rule.
FirstActivatedTime (datetime) --
The time that you first activated the Config rule.
LastDeactivatedTime (datetime) --
The time that you last turned off the Config rule.
LastErrorCode (string) --
The error code that Config returned when the rule last failed.
LastErrorMessage (string) --
The error message that Config returned when the rule last failed.
FirstEvaluationStarted (boolean) --
Indicates whether Config has evaluated your resources against the rule at least once.
LastDebugLogDeliveryStatus (string) --
The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed .
LastDebugLogDeliveryStatusReason (string) --
The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.
LastDebugLogDeliveryTime (datetime) --
The time Config last attempted to deliver a debug log for your Config Custom Policy rules.
paginator = client.get_paginator('describe_config_rules')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_config_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigRuleNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConfigRules': [
{
'ConfigRuleName': 'string',
'ConfigRuleArn': 'string',
'ConfigRuleId': 'string',
'Description': 'string',
'Scope': {
'ComplianceResourceTypes': [
'string',
],
'TagKey': 'string',
'TagValue': 'string',
'ComplianceResourceId': 'string'
},
'Source': {
'Owner': 'CUSTOM_LAMBDA'|'AWS'|'CUSTOM_POLICY',
'SourceIdentifier': 'string',
'SourceDetails': [
{
'EventSource': 'aws.config',
'MessageType': 'ConfigurationItemChangeNotification'|'ConfigurationSnapshotDeliveryCompleted'|'ScheduledNotification'|'OversizedConfigurationItemChangeNotification',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours'
},
],
'CustomPolicyDetails': {
'PolicyRuntime': 'string',
'PolicyText': 'string',
'EnableDebugLogDelivery': True|False
}
},
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ConfigRuleState': 'ACTIVE'|'DELETING'|'DELETING_RESULTS'|'EVALUATING',
'CreatedBy': 'string'
},
],
}
Response Structure
(dict) --
ConfigRules (list) --
The details about your Config rules.
(dict) --
An Config rule represents an Lambda function that you create for a custom rule or a predefined function for an Config managed rule. The function evaluates configuration items to assess whether your Amazon Web Services resources comply with your desired configurations. This function can run when Config detects a configuration change to an Amazon Web Services resource and at a periodic frequency that you choose (for example, every 24 hours).
Note
You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide .
ConfigRuleName (string) --
The name that you assign to the Config rule. The name is required if you are adding a new rule.
ConfigRuleArn (string) --
The Amazon Resource Name (ARN) of the Config rule.
ConfigRuleId (string) --
The ID of the Config rule.
Description (string) --
The description that you provide for the Config rule.
Scope (dict) --
Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
Note
The scope can be empty.
ComplianceResourceTypes (list) --
The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId .
TagKey (string) --
The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.
TagValue (string) --
The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue , you must also specify a value for TagKey .
ComplianceResourceId (string) --
The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .
Source (dict) --
Provides the rule owner (Amazon Web Services or customer), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.
Owner (string) --
Indicates whether Amazon Web Services or the customer owns and manages the Config rule.
Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.
Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY ) or Lambda (CUSTOM_LAMBDA ). For more information, see Config Custom Rules in the Config developer guide.
SourceIdentifier (string) --
For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules .
For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name .
For Config Custom Policy rules, this field will be ignored.
SourceDetails (list) --
Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.
If the owner is set to CUSTOM_POLICY , the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification .
(dict) --
Provides the source and the message types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for SourceDetail only for custom rules.
EventSource (string) --
The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.
MessageType (string) --
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification .
MaximumExecutionFrequency (string) --
The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency , then MessageType must use the ScheduledNotification value.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours , Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.
CustomPolicyDetails (dict) --
Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY .
PolicyRuntime (string) --
The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
PolicyText (string) --
The policy definition containing the logic for your Config Custom Policy rule.
EnableDebugLogDelivery (boolean) --
The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false .
InputParameters (string) --
A string, in JSON format, that is passed to the Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ConfigRuleState (string) --
Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.
Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.
Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.
Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
CreatedBy (string) --
Service principal name of the service that created the rule.
Note
The field is populated only if the service linked rule is created by a service. The field is empty if you create your own rule.
paginator = client.get_paginator('describe_configuration_aggregator_sources_status')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_configuration_aggregator_sources_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorName='string',
UpdateStatus=[
'FAILED'|'SUCCEEDED'|'OUTDATED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
Filters the status type.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AggregatedSourceStatusList': [
{
'SourceId': 'string',
'SourceType': 'ACCOUNT'|'ORGANIZATION',
'AwsRegion': 'string',
'LastUpdateStatus': 'FAILED'|'SUCCEEDED'|'OUTDATED',
'LastUpdateTime': datetime(2015, 1, 1),
'LastErrorCode': 'string',
'LastErrorMessage': 'string'
},
],
}
Response Structure
(dict) --
AggregatedSourceStatusList (list) --
Returns an AggregatedSourceStatus object.
(dict) --
The current sync status between the source and the aggregator account.
SourceId (string) --
The source account ID or an organization.
SourceType (string) --
The source account or an organization.
AwsRegion (string) --
The region authorized to collect aggregated data.
LastUpdateStatus (string) --
Filters the last updated status type.
LastUpdateTime (datetime) --
The time of the last update.
LastErrorCode (string) --
The error code that Config returned when the source account aggregation last failed.
LastErrorMessage (string) --
The message indicating that the source account aggregation failed due to an error.
paginator = client.get_paginator('describe_configuration_aggregators')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_configuration_aggregators().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name of the configuration aggregators.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConfigurationAggregators': [
{
'ConfigurationAggregatorName': 'string',
'ConfigurationAggregatorArn': 'string',
'AccountAggregationSources': [
{
'AccountIds': [
'string',
],
'AllAwsRegions': True|False,
'AwsRegions': [
'string',
]
},
],
'OrganizationAggregationSource': {
'RoleArn': 'string',
'AwsRegions': [
'string',
],
'AllAwsRegions': True|False
},
'CreationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
},
],
}
Response Structure
(dict) --
ConfigurationAggregators (list) --
Returns a ConfigurationAggregators object.
(dict) --
The details about the configuration aggregator, including information about source accounts, regions, and metadata of the aggregator.
ConfigurationAggregatorName (string) --
The name of the aggregator.
ConfigurationAggregatorArn (string) --
The Amazon Resource Name (ARN) of the aggregator.
AccountAggregationSources (list) --
Provides a list of source accounts and regions to be aggregated.
(dict) --
A collection of accounts and regions.
AccountIds (list) --
The 12-digit account ID of the account being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
AwsRegions (list) --
The source regions being aggregated.
OrganizationAggregationSource (dict) --
Provides an organization and list of regions to be aggregated.
RoleArn (string) --
ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.
AwsRegions (list) --
The source regions being aggregated.
AllAwsRegions (boolean) --
If true, aggregate existing Config regions and future regions.
CreationTime (datetime) --
The time stamp when the configuration aggregator was created.
LastUpdatedTime (datetime) --
The time of the last update.
CreatedBy (string) --
Amazon Web Services service that created the configuration aggregator.
paginator = client.get_paginator('describe_conformance_pack_status')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_conformance_pack_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConformancePackNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Comma-separated list of conformance pack names.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConformancePackStatusDetails': [
{
'ConformancePackName': 'string',
'ConformancePackId': 'string',
'ConformancePackArn': 'string',
'ConformancePackState': 'CREATE_IN_PROGRESS'|'CREATE_COMPLETE'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'StackArn': 'string',
'ConformancePackStatusReason': 'string',
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'LastUpdateCompletedTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
ConformancePackStatusDetails (list) --
A list of ConformancePackStatusDetail objects.
(dict) --
Status details of a conformance pack.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of comformance pack.
ConformancePackState (string) --
Indicates deployment status of conformance pack.
Config sets the state of the conformance pack to:
StackArn (string) --
Amazon Resource Name (ARN) of CloudFormation stack.
ConformancePackStatusReason (string) --
The reason of conformance pack creation failure.
LastUpdateRequestedTime (datetime) --
Last time when conformation pack creation and update was requested.
LastUpdateCompletedTime (datetime) --
Last time when conformation pack creation and update was successful.
paginator = client.get_paginator('describe_conformance_packs')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_conformance_packs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConformancePackNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConformancePackDetails': [
{
'ConformancePackName': 'string',
'ConformancePackArn': 'string',
'ConformancePackId': 'string',
'DeliveryS3Bucket': 'string',
'DeliveryS3KeyPrefix': 'string',
'ConformancePackInputParameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
'LastUpdateRequestedTime': datetime(2015, 1, 1),
'CreatedBy': 'string'
},
],
}
Response Structure
(dict) --
ConformancePackDetails (list) --
Returns a list of ConformancePackDetail objects.
(dict) --
Returns details of a conformance pack. A conformance pack is a collection of Config rules and remediation actions that can be easily deployed in an account and a region.
ConformancePackName (string) --
Name of the conformance pack.
ConformancePackArn (string) --
Amazon Resource Name (ARN) of the conformance pack.
ConformancePackId (string) --
ID of the conformance pack.
DeliveryS3Bucket (string) --
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional.
DeliveryS3KeyPrefix (string) --
The prefix for the Amazon S3 bucket.
Note
This field is optional.
ConformancePackInputParameters (list) --
A list of ConformancePackInputParameter objects.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) --
One part of a key-value pair.
ParameterValue (string) --
Another part of the key-value pair.
LastUpdateRequestedTime (datetime) --
Last time when conformation pack update was requested.
CreatedBy (string) --
Amazon Web Services service that created the conformance pack.
paginator = client.get_paginator('describe_organization_config_rule_statuses')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_organization_config_rule_statuses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConfigRuleNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConfigRuleStatuses': [
{
'OrganizationConfigRuleName': 'string',
'OrganizationRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
OrganizationConfigRuleStatuses (list) --
A list of OrganizationConfigRuleStatus objects.
(dict) --
Returns the status for an organization Config rule in an organization.
OrganizationConfigRuleName (string) --
The name that you assign to organization Config rule.
OrganizationRuleStatus (string) --
Indicates deployment status of an organization Config rule. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the master account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
ErrorCode (string) --
An error code that is returned when organization Config rule creation or deletion has failed.
ErrorMessage (string) --
An error message indicating that organization Config rule creation or deletion failed due to an error.
LastUpdateTime (datetime) --
The timestamp of the last update.
paginator = client.get_paginator('describe_organization_config_rules')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_organization_config_rules().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConfigRuleNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConfigRules': [
{
'OrganizationConfigRuleName': 'string',
'OrganizationConfigRuleArn': 'string',
'OrganizationManagedRuleMetadata': {
'Description': 'string',
'RuleIdentifier': 'string',
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
'OrganizationCustomRuleMetadata': {
'Description': 'string',
'LambdaFunctionArn': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification'|'ScheduledNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string'
},
'ExcludedAccounts': [
'string',
],
'LastUpdateTime': datetime(2015, 1, 1),
'OrganizationCustomPolicyRuleMetadata': {
'Description': 'string',
'OrganizationConfigRuleTriggerTypes': [
'ConfigurationItemChangeNotification'|'OversizedConfigurationItemChangeNotification',
],
'InputParameters': 'string',
'MaximumExecutionFrequency': 'One_Hour'|'Three_Hours'|'Six_Hours'|'Twelve_Hours'|'TwentyFour_Hours',
'ResourceTypesScope': [
'string',
],
'ResourceIdScope': 'string',
'TagKeyScope': 'string',
'TagValueScope': 'string',
'PolicyRuntime': 'string',
'DebugLogDeliveryAccounts': [
'string',
]
}
},
],
}
Response Structure
(dict) --
OrganizationConfigRules (list) --
Returns a list of OrganizationConfigRule objects.
(dict) --
An organization Config rule that has information about Config rules that Config creates in member accounts.
OrganizationConfigRuleName (string) --
The name that you assign to organization Config rule.
OrganizationConfigRuleArn (string) --
Amazon Resource Name (ARN) of organization Config rule.
OrganizationManagedRuleMetadata (dict) --
An OrganizationManagedRuleMetadata object.
Description (string) --
The description that you provide for your organization Config rule.
RuleIdentifier (string) --
For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules .
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. You are using an Config managed rule that is triggered at a periodic frequency.
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
OrganizationCustomRuleMetadata (dict) --
An OrganizationCustomRuleMetadata object.
Description (string) --
The description that you provide for your organization Config rule.
LambdaFunctionArn (string) --
The lambda function ARN.
OrganizationConfigRuleTriggerTypes (list) --
The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config rule Lambda function.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
Note
By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
ExcludedAccounts (list) --
A comma-separated list of accounts excluded from organization Config rule.
LastUpdateTime (datetime) --
The timestamp of the last update.
OrganizationCustomPolicyRuleMetadata (dict) --
An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.
Description (string) --
The description that you provide for your organization Config Custom Policy rule.
OrganizationConfigRuleTriggerTypes (list) --
The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:
InputParameters (string) --
A string, in JSON format, that is passed to your organization Config Custom Policy rule.
MaximumExecutionFrequency (string) --
The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties .
ResourceTypesScope (list) --
The type of the Amazon Web Services resource that was evaluated.
ResourceIdScope (string) --
The ID of the Amazon Web Services resource that was evaluated.
TagKeyScope (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
TagValueScope (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
PolicyRuntime (string) --
The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository .
DebugLogDeliveryAccounts (list) --
A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.
paginator = client.get_paginator('describe_organization_conformance_pack_statuses')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_organization_conformance_pack_statuses().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConformancePackNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConformancePackStatuses': [
{
'OrganizationConformancePackName': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
OrganizationConformancePackStatuses (list) --
A list of OrganizationConformancePackStatus objects.
(dict) --
Returns the status for an organization conformance pack in an organization.
OrganizationConformancePackName (string) --
The name that you assign to organization conformance pack.
Status (string) --
Indicates deployment status of an organization conformance pack. When master account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When master account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the master account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
ErrorCode (string) --
An error code that is returned when organization conformance pack creation or deletion has failed in a member account.
ErrorMessage (string) --
An error message indicating that organization conformance pack creation or deletion failed due to an error.
LastUpdateTime (datetime) --
The timestamp of the last update.
paginator = client.get_paginator('describe_organization_conformance_packs')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_organization_conformance_packs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConformancePackNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
The name that you assign to an organization conformance pack.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConformancePacks': [
{
'OrganizationConformancePackName': 'string',
'OrganizationConformancePackArn': 'string',
'DeliveryS3Bucket': 'string',
'DeliveryS3KeyPrefix': 'string',
'ConformancePackInputParameters': [
{
'ParameterName': 'string',
'ParameterValue': 'string'
},
],
'ExcludedAccounts': [
'string',
],
'LastUpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
OrganizationConformancePacks (list) --
Returns a list of OrganizationConformancePacks objects.
(dict) --
An organization conformance pack that has information about conformance packs that Config creates in member accounts.
OrganizationConformancePackName (string) --
The name you assign to an organization conformance pack.
OrganizationConformancePackArn (string) --
Amazon Resource Name (ARN) of organization conformance pack.
DeliveryS3Bucket (string) --
The name of the Amazon S3 bucket where Config stores conformance pack templates.
Note
This field is optional.
DeliveryS3KeyPrefix (string) --
Any folder structure you want to add to an Amazon S3 bucket.
Note
This field is optional.
ConformancePackInputParameters (list) --
A list of ConformancePackInputParameter objects.
(dict) --
Input parameters in the form of key-value pairs for the conformance pack, both of which you define. Keys can have a maximum character length of 255 characters, and values can have a maximum length of 4096 characters.
ParameterName (string) --
One part of a key-value pair.
ParameterValue (string) --
Another part of the key-value pair.
ExcludedAccounts (list) --
A comma-separated list of accounts excluded from organization conformance pack.
LastUpdateTime (datetime) --
Last time when organization conformation pack was updated.
paginator = client.get_paginator('describe_pending_aggregation_requests')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_pending_aggregation_requests().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'PendingAggregationRequests': [
{
'RequesterAccountId': 'string',
'RequesterAwsRegion': 'string'
},
],
}
Response Structure
Returns a PendingAggregationRequests object.
An object that represents the account ID and region of an aggregator account that is requesting authorization but is not yet authorized.
The 12-digit account ID of the account requesting to aggregate data.
The region requesting to aggregate data.
paginator = client.get_paginator('describe_remediation_execution_status')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_remediation_execution_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigRuleName='string',
ResourceKeys=[
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
A list of Config rule names.
A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.
The details that identify a resource within Config, including the resource type and resource ID.
The resource type.
The ID of the resource (for example., sg-xxxxxx).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RemediationExecutionStatuses': [
{
'ResourceKey': {
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string'
},
'State': 'QUEUED'|'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
'StepDetails': [
{
'Name': 'string',
'State': 'SUCCEEDED'|'PENDING'|'FAILED',
'ErrorMessage': 'string',
'StartTime': datetime(2015, 1, 1),
'StopTime': datetime(2015, 1, 1)
},
],
'InvocationTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
RemediationExecutionStatuses (list) --
Returns a list of remediation execution statuses objects.
(dict) --
Provides details of the current status of the invoked remediation action for that resource.
ResourceKey (dict) --
The details that identify a resource within Config, including the resource type and resource ID.
resourceType (string) --
The resource type.
resourceId (string) --
The ID of the resource (for example., sg-xxxxxx).
State (string) --
ENUM of the values.
StepDetails (list) --
Details of every step.
(dict) --
Name of the step from the SSM document.
Name (string) --
The details of the step.
State (string) --
The valid status of the step.
ErrorMessage (string) --
An error message if the step was interrupted during execution.
StartTime (datetime) --
The time when the step started.
StopTime (datetime) --
The time when the step stopped.
InvocationTime (datetime) --
Start time when the remediation was executed.
LastUpdatedTime (datetime) --
The time when the remediation execution was last updated.
paginator = client.get_paginator('describe_retention_configurations')
Creates an iterator that will paginate through responses from ConfigService.Client.describe_retention_configurations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
RetentionConfigurationNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.
Note
Currently, Config supports only one retention configuration per region in your account.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'RetentionConfigurations': [
{
'Name': 'string',
'RetentionPeriodInDays': 123
},
],
}
Response Structure
(dict) --
RetentionConfigurations (list) --
Returns a retention configuration object.
(dict) --
An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in Config.
Name (string) --
The name of the retention configuration object.
RetentionPeriodInDays (integer) --
Number of days Config stores your historical information.
Note
Currently, only applicable to the configuration item history.
paginator = client.get_paginator('get_aggregate_compliance_details_by_config_rule')
Creates an iterator that will paginate through responses from ConfigService.Client.get_aggregate_compliance_details_by_config_rule().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorName='string',
ConfigRuleName='string',
AccountId='string',
AwsRegion='string',
ComplianceType='COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
The name of the Config rule for which you want compliance information.
[REQUIRED]
The 12-digit account ID of the source account.
[REQUIRED]
The source region from where the data is aggregated.
The resource compliance status.
Note
For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'AggregateEvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'AccountId': 'string',
'AwsRegion': 'string'
},
],
}
Response Structure
(dict) --
AggregateEvaluationResults (list) --
Returns an AggregateEvaluationResults object.
(dict) --
The details of an Config evaluation for an account ID and region in an aggregator. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
The resource compliance status.
For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT . Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.
ResultRecordedTime (datetime) --
The time when Config recorded the aggregate evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the agrregate evaluation determined the compliance.
AccountId (string) --
The 12-digit account ID of the source account.
AwsRegion (string) --
The source region from where the data is aggregated.
paginator = client.get_paginator('get_compliance_details_by_config_rule')
Creates an iterator that will paginate through responses from ConfigService.Client.get_compliance_details_by_config_rule().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigRuleName='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the Config rule for which you want compliance information.
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'ResultToken': 'string'
},
],
}
Response Structure
(dict) --
EvaluationResults (list) --
Indicates whether the Amazon Web Services resource complies with the specified Config rule.
(dict) --
The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the EvaluationResult data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.
ResultRecordedTime (datetime) --
The time when Config recorded the evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
ResultToken (string) --
An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
paginator = client.get_paginator('get_compliance_details_by_resource')
Creates an iterator that will paginate through responses from ConfigService.Client.get_compliance_details_by_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceType='string',
ResourceId='string',
ComplianceTypes=[
'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
],
PaginationConfig={
'MaxItems': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The type of the Amazon Web Services resource for which you want compliance information.
[REQUIRED]
The ID of the Amazon Web Services resource for which you want compliance information.
Filters the results by compliance.
The allowed values are COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'EvaluationResults': [
{
'EvaluationResultIdentifier': {
'EvaluationResultQualifier': {
'ConfigRuleName': 'string',
'ResourceType': 'string',
'ResourceId': 'string'
},
'OrderingTimestamp': datetime(2015, 1, 1)
},
'ComplianceType': 'COMPLIANT'|'NON_COMPLIANT'|'NOT_APPLICABLE'|'INSUFFICIENT_DATA',
'ResultRecordedTime': datetime(2015, 1, 1),
'ConfigRuleInvokedTime': datetime(2015, 1, 1),
'Annotation': 'string',
'ResultToken': 'string'
},
],
}
Response Structure
(dict) --
EvaluationResults (list) --
Indicates whether the specified Amazon Web Services resource complies each Config rule.
(dict) --
The details of an Config evaluation. Provides the Amazon Web Services resource that was evaluated, the compliance of the resource, related time stamps, and supplementary information.
EvaluationResultIdentifier (dict) --
Uniquely identifies the evaluation result.
EvaluationResultQualifier (dict) --
Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.
ConfigRuleName (string) --
The name of the Config rule that was used in the evaluation.
ResourceType (string) --
The type of Amazon Web Services resource that was evaluated.
ResourceId (string) --
The ID of the evaluated Amazon Web Services resource.
OrderingTimestamp (datetime) --
The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.
ComplianceType (string) --
Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.
For the EvaluationResult data type, Config supports only the COMPLIANT , NON_COMPLIANT , and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.
ResultRecordedTime (datetime) --
The time when Config recorded the evaluation result.
ConfigRuleInvokedTime (datetime) --
The time when the Config rule evaluated the Amazon Web Services resource.
Annotation (string) --
Supplementary information about how the evaluation determined the compliance.
ResultToken (string) --
An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.
paginator = client.get_paginator('get_conformance_pack_compliance_summary')
Creates an iterator that will paginate through responses from ConfigService.Client.get_conformance_pack_compliance_summary().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConformancePackNames=[
'string',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
Names of conformance packs.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ConformancePackComplianceSummaryList': [
{
'ConformancePackName': 'string',
'ConformancePackComplianceStatus': 'COMPLIANT'|'NON_COMPLIANT'|'INSUFFICIENT_DATA'
},
],
}
Response Structure
(dict) --
ConformancePackComplianceSummaryList (list) --
A list of ConformancePackComplianceSummary objects.
(dict) --
Summary includes the name and status of the conformance pack.
ConformancePackName (string) --
The name of the conformance pack name.
ConformancePackComplianceStatus (string) --
The status of the conformance pack. The allowed values are COMPLIANT , NON_COMPLIANT and INSUFFICIENT_DATA .
paginator = client.get_paginator('get_organization_config_rule_detailed_status')
Creates an iterator that will paginate through responses from ConfigService.Client.get_organization_config_rule_detailed_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConfigRuleName='string',
Filters={
'AccountId': 'string',
'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of your organization Config rule for which you want status details for member accounts.
A StatusDetailFilters object.
The 12-digit account ID of the member account within an organization.
Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConfigRuleDetailedStatus': [
{
'AccountId': 'string',
'ConfigRuleName': 'string',
'MemberAccountRuleStatus': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
OrganizationConfigRuleDetailedStatus (list) --
A list of MemberAccountStatus objects.
(dict) --
Organization Config rule creation or deletion status in each member account. This includes the name of the rule, the status, error code and error message when the rule creation or deletion failed.
AccountId (string) --
The 12-digit account ID of a member account.
ConfigRuleName (string) --
The name of Config rule deployed in the member account.
MemberAccountRuleStatus (string) --
Indicates deployment status for Config rule in the member account. When master account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When master account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the master account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the rule to:
ErrorCode (string) --
An error code that is returned when Config rule creation or deletion failed in the member account.
ErrorMessage (string) --
An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.
LastUpdateTime (datetime) --
The timestamp of the last status update.
paginator = client.get_paginator('get_organization_conformance_pack_detailed_status')
Creates an iterator that will paginate through responses from ConfigService.Client.get_organization_conformance_pack_detailed_status().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
OrganizationConformancePackName='string',
Filters={
'AccountId': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of organization conformance pack for which you want status details for member accounts.
An OrganizationResourceDetailedStatusFilters object.
The 12-digit account ID of the member account within an organization.
Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'OrganizationConformancePackDetailedStatuses': [
{
'AccountId': 'string',
'ConformancePackName': 'string',
'Status': 'CREATE_SUCCESSFUL'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_SUCCESSFUL'|'DELETE_FAILED'|'DELETE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
'ErrorCode': 'string',
'ErrorMessage': 'string',
'LastUpdateTime': datetime(2015, 1, 1)
},
],
}
Response Structure
(dict) --
OrganizationConformancePackDetailedStatuses (list) --
A list of OrganizationConformancePackDetailedStatus objects.
(dict) --
Organization conformance pack creation or deletion status in each member account. This includes the name of the conformance pack, the status, error code and error message when the conformance pack creation or deletion failed.
AccountId (string) --
The 12-digit account ID of a member account.
ConformancePackName (string) --
The name of conformance pack deployed in the member account.
Status (string) --
Indicates deployment status for conformance pack in a member account. When master account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When master account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the master account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com .
Config sets the state of the conformance pack to:
ErrorCode (string) --
An error code that is returned when conformance pack creation or deletion failed in the member account.
ErrorMessage (string) --
An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.
LastUpdateTime (datetime) --
The timestamp of the last status update.
paginator = client.get_paginator('get_resource_config_history')
Creates an iterator that will paginate through responses from ConfigService.Client.get_resource_config_history().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
resourceId='string',
laterTime=datetime(2015, 1, 1),
earlierTime=datetime(2015, 1, 1),
chronologicalOrder='Reverse'|'Forward',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The resource type.
[REQUIRED]
The ID of the resource (for example., sg-xxxxxx ).
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'configurationItems': [
{
'version': 'string',
'accountId': 'string',
'configurationItemCaptureTime': datetime(2015, 1, 1),
'configurationItemStatus': 'OK'|'ResourceDiscovered'|'ResourceNotRecorded'|'ResourceDeleted'|'ResourceDeletedNotRecorded',
'configurationStateId': 'string',
'configurationItemMD5Hash': 'string',
'arn': 'string',
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'awsRegion': 'string',
'availabilityZone': 'string',
'resourceCreationTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'relatedEvents': [
'string',
],
'relationships': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'relationshipName': 'string'
},
],
'configuration': 'string',
'supplementaryConfiguration': {
'string': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
The output for the GetResourceConfigHistory action.
configurationItems (list) --
A list that contains the configuration history of one or more resources.
(dict) --
A list that contains detailed configurations of a specified resource.
version (string) --
The version number of the resource configuration.
accountId (string) --
The 12-digit Amazon Web Services account ID associated with the resource.
configurationItemCaptureTime (datetime) --
The time when the configuration recording was initiated.
configurationItemStatus (string) --
The configuration item status. The valid values are:
Note
The CIs do not incur any cost.
configurationStateId (string) --
An identifier that indicates the ordering of the configuration items of a resource.
configurationItemMD5Hash (string) --
Unique MD5 hash that represents the configuration item's state.
You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
arn (string) --
Amazon Resource Name (ARN) associated with the resource.
resourceType (string) --
The type of Amazon Web Services resource.
resourceId (string) --
The ID of the resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the resource, if available.
awsRegion (string) --
The region where the resource resides.
availabilityZone (string) --
The Availability Zone associated with the resource.
resourceCreationTime (datetime) --
The time stamp when the resource was created.
tags (dict) --
A mapping of key value tags associated with the resource.
relatedEvents (list) --
A list of CloudTrail event IDs.
A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail .
An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.
relationships (list) --
A list of related Amazon Web Services resources.
(dict) --
The relationship of the related resource to the main resource.
resourceType (string) --
The resource type of the related resource.
resourceId (string) --
The ID of the related resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the related resource, if available.
relationshipName (string) --
The type of relationship with the related resource.
configuration (string) --
The description of the resource configuration.
supplementaryConfiguration (dict) --
Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_aggregate_discovered_resources')
Creates an iterator that will paginate through responses from ConfigService.Client.list_aggregate_discovered_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ConfigurationAggregatorName='string',
ResourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
Filters={
'AccountId': 'string',
'ResourceId': 'string',
'ResourceName': 'string',
'Region': 'string'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The name of the configuration aggregator.
[REQUIRED]
The type of resources that you want Config to list in the response.
Filters the results based on the ResourceFilters object.
The 12-digit source account ID.
The ID of the resource.
The name of the resource.
The source region.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ResourceIdentifiers': [
{
'SourceAccountId': 'string',
'SourceRegion': 'string',
'ResourceId': 'string',
'ResourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'ResourceName': 'string'
},
],
}
Response Structure
(dict) --
ResourceIdentifiers (list) --
Returns a list of ResourceIdentifiers objects.
(dict) --
The details that identify a resource that is collected by Config aggregator, including the resource type, ID, (if available) the custom resource name, the source account, and source region.
SourceAccountId (string) --
The 12-digit account ID of the source account.
SourceRegion (string) --
The source region where data is aggregated.
ResourceId (string) --
The ID of the Amazon Web Services resource.
ResourceType (string) --
The type of the Amazon Web Services resource.
ResourceName (string) --
The name of the Amazon Web Services resource.
paginator = client.get_paginator('list_discovered_resources')
Creates an iterator that will paginate through responses from ConfigService.Client.list_discovered_resources().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
resourceType='AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
resourceIds=[
'string',
],
resourceName='string',
includeDeletedResources=True|False,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The type of resources that you want Config to list in the response.
The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'resourceIdentifiers': [
{
'resourceType': 'AWS::EC2::CustomerGateway'|'AWS::EC2::EIP'|'AWS::EC2::Host'|'AWS::EC2::Instance'|'AWS::EC2::InternetGateway'|'AWS::EC2::NetworkAcl'|'AWS::EC2::NetworkInterface'|'AWS::EC2::RouteTable'|'AWS::EC2::SecurityGroup'|'AWS::EC2::Subnet'|'AWS::CloudTrail::Trail'|'AWS::EC2::Volume'|'AWS::EC2::VPC'|'AWS::EC2::VPNConnection'|'AWS::EC2::VPNGateway'|'AWS::EC2::RegisteredHAInstance'|'AWS::EC2::NatGateway'|'AWS::EC2::EgressOnlyInternetGateway'|'AWS::EC2::VPCEndpoint'|'AWS::EC2::VPCEndpointService'|'AWS::EC2::FlowLog'|'AWS::EC2::VPCPeeringConnection'|'AWS::Elasticsearch::Domain'|'AWS::IAM::Group'|'AWS::IAM::Policy'|'AWS::IAM::Role'|'AWS::IAM::User'|'AWS::ElasticLoadBalancingV2::LoadBalancer'|'AWS::ACM::Certificate'|'AWS::RDS::DBInstance'|'AWS::RDS::DBSubnetGroup'|'AWS::RDS::DBSecurityGroup'|'AWS::RDS::DBSnapshot'|'AWS::RDS::DBCluster'|'AWS::RDS::DBClusterSnapshot'|'AWS::RDS::EventSubscription'|'AWS::S3::Bucket'|'AWS::S3::AccountPublicAccessBlock'|'AWS::Redshift::Cluster'|'AWS::Redshift::ClusterSnapshot'|'AWS::Redshift::ClusterParameterGroup'|'AWS::Redshift::ClusterSecurityGroup'|'AWS::Redshift::ClusterSubnetGroup'|'AWS::Redshift::EventSubscription'|'AWS::SSM::ManagedInstanceInventory'|'AWS::CloudWatch::Alarm'|'AWS::CloudFormation::Stack'|'AWS::ElasticLoadBalancing::LoadBalancer'|'AWS::AutoScaling::AutoScalingGroup'|'AWS::AutoScaling::LaunchConfiguration'|'AWS::AutoScaling::ScalingPolicy'|'AWS::AutoScaling::ScheduledAction'|'AWS::DynamoDB::Table'|'AWS::CodeBuild::Project'|'AWS::WAF::RateBasedRule'|'AWS::WAF::Rule'|'AWS::WAF::RuleGroup'|'AWS::WAF::WebACL'|'AWS::WAFRegional::RateBasedRule'|'AWS::WAFRegional::Rule'|'AWS::WAFRegional::RuleGroup'|'AWS::WAFRegional::WebACL'|'AWS::CloudFront::Distribution'|'AWS::CloudFront::StreamingDistribution'|'AWS::Lambda::Function'|'AWS::NetworkFirewall::Firewall'|'AWS::NetworkFirewall::FirewallPolicy'|'AWS::NetworkFirewall::RuleGroup'|'AWS::ElasticBeanstalk::Application'|'AWS::ElasticBeanstalk::ApplicationVersion'|'AWS::ElasticBeanstalk::Environment'|'AWS::WAFv2::WebACL'|'AWS::WAFv2::RuleGroup'|'AWS::WAFv2::IPSet'|'AWS::WAFv2::RegexPatternSet'|'AWS::WAFv2::ManagedRuleSet'|'AWS::XRay::EncryptionConfig'|'AWS::SSM::AssociationCompliance'|'AWS::SSM::PatchCompliance'|'AWS::Shield::Protection'|'AWS::ShieldRegional::Protection'|'AWS::Config::ConformancePackCompliance'|'AWS::Config::ResourceCompliance'|'AWS::ApiGateway::Stage'|'AWS::ApiGateway::RestApi'|'AWS::ApiGatewayV2::Stage'|'AWS::ApiGatewayV2::Api'|'AWS::CodePipeline::Pipeline'|'AWS::ServiceCatalog::CloudFormationProvisionedProduct'|'AWS::ServiceCatalog::CloudFormationProduct'|'AWS::ServiceCatalog::Portfolio'|'AWS::SQS::Queue'|'AWS::KMS::Key'|'AWS::QLDB::Ledger'|'AWS::SecretsManager::Secret'|'AWS::SNS::Topic'|'AWS::SSM::FileData'|'AWS::Backup::BackupPlan'|'AWS::Backup::BackupSelection'|'AWS::Backup::BackupVault'|'AWS::Backup::RecoveryPoint'|'AWS::ECR::Repository'|'AWS::ECS::Cluster'|'AWS::ECS::Service'|'AWS::ECS::TaskDefinition'|'AWS::EFS::AccessPoint'|'AWS::EFS::FileSystem'|'AWS::EKS::Cluster'|'AWS::OpenSearch::Domain'|'AWS::EC2::TransitGateway'|'AWS::Kinesis::Stream'|'AWS::Kinesis::StreamConsumer'|'AWS::CodeDeploy::Application'|'AWS::CodeDeploy::DeploymentConfig'|'AWS::CodeDeploy::DeploymentGroup'|'AWS::EC2::LaunchTemplate'|'AWS::ECR::PublicRepository'|'AWS::GuardDuty::Detector',
'resourceId': 'string',
'resourceName': 'string',
'resourceDeletionTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
resourceIdentifiers (list) --
The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
(dict) --
The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.
resourceType (string) --
The type of resource.
resourceId (string) --
The ID of the resource (for example, sg-xxxxxx ).
resourceName (string) --
The custom name of the resource (if available).
resourceDeletionTime (datetime) --
The time that the resource was deleted.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_tags_for_resource')
Creates an iterator that will paginate through responses from ConfigService.Client.list_tags_for_resource().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
ResourceArn='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule , ConfigurationAggregator and AggregatorAuthorization .
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
}
Response Structure
(dict) --
Tags (list) --
The tags for the resource.
(dict) --
The tags for the resource. The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
Key (string) --
One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.
Value (string) --
The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).
paginator = client.get_paginator('select_aggregate_resource_config')
Creates an iterator that will paginate through responses from ConfigService.Client.select_aggregate_resource_config().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Expression='string',
ConfigurationAggregatorName='string',
MaxResults=123,
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The SQL query SELECT command.
[REQUIRED]
The name of the configuration aggregator.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Results': [
'string',
],
'QueryInfo': {
'SelectFields': [
{
'Name': 'string'
},
]
},
}
Response Structure
(dict) --
Results (list) --
Returns the results for the SQL query.
QueryInfo (dict) --
Details about the query.
SelectFields (list) --
Returns a FieldInfo object.
(dict) --
Details about the fields such as name of the field.
Name (string) --
Name of the field.
paginator = client.get_paginator('select_resource_config')
Creates an iterator that will paginate through responses from ConfigService.Client.select_resource_config().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
Expression='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The SQL query SELECT command.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Results': [
'string',
],
'QueryInfo': {
'SelectFields': [
{
'Name': 'string'
},
]
},
}
Response Structure
(dict) --
Results (list) --
Returns the results for the SQL query.
QueryInfo (dict) --
Returns the QueryInfo object.
SelectFields (list) --
Returns a FieldInfo object.
(dict) --
Details about the fields such as name of the field.
Name (string) --
Name of the field.