AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

Welcome

AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS 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 AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config. This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. The AWS 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 AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config in the AWS Config Developer Guide.

AWS Config

Use the following APIs for AWS Config:

BatchGetResourceConfig, returns the current configuration for one or more requested resources.
DeleteConfigurationRecorder, deletes the configuration recorder.
DeleteDeliveryChannel, deletes the delivery channel.
DeleteResourceConfig, records the configuration state for a custom resource that has been deleted.
DeleteRetentionConfiguration, deletes the retention configuration.
DeliverConfigSnapshot, schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
DescribeConfigurationRecorders, returns the details for the specified configuration recorders.
DescribeConfigurationRecorderStatus, returns the current status of the specified configuration recorder.
DescribeDeliveryChannels, returns details about the specified delivery channel.
DescribeDeliveryChannelStatus, returns the current status of the specified delivery channel.
DescribeRetentionConfigurations, returns the details of one or more retention configurations.
GetDiscoveredResourceCounts, returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.
GetResourceConfigHistory, returns a list of configuration items for the specified resource.
ListDiscoveredResources, accepts a resource type and returns a list of resource identifiers for the resources of that type.
PutConfigurationRecorder, creates a new configuration recorder to record the selected resource configurations.
PutDeliveryChannel, creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
PutResourceConfig, records the configuration state for the resource provided in the request.
PutRetentionConfiguration, creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information.
SelectResourceConfig, accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.
StartConfigurationRecorder, starts recording configurations of the AWS resources you have selected to record in your AWS account.
StopConfigurationRecorder, stops recording configurations of the AWS resources you have selected to record in your AWS account.

AWS Config Rules

Use the following APIs for AWS Config Rules:

DeleteConfigRule, deletes the specified AWS Config rule and all of its evaluation results.
DeleteEvaluationResults, deletes the evaluation results for the specified Config rule.
DeleteOrganizationConfigRule, deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization.
DeleteRemediationConfiguration, deletes the remediation configuration.
DeleteRemediationExceptions, deletes one or more remediation exceptions mentioned in the resource keys.
DescribeComplianceByConfigRule, indicates whether the specified AWS Config rules are compliant.
DescribeComplianceByResource, indicates whether the specified AWS resources are compliant.
DescribeConfigRuleEvaluationStatus, returns status information for each of your AWS managed Config rules.
DescribeConfigRules, returns details about your AWS Config rules.
DescribeOrganizationConfigRules, returns a list of organization config rules.
DescribeOrganizationConfigRuleStatuses, provides organization config rule deployment status for an organization.
DescribeRemediationConfigurations, returns the details of one or more remediation configurations.
DescribeRemediationExceptions, returns the details of one or more remediation exceptions.
DescribeRemediationExecutionStatus, 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.
GetComplianceDetailsByConfigRule, returns the evaluation results for the specified AWS Config rule.
GetComplianceDetailsByResource, returns the evaluation results for the specified AWS resource.
GetComplianceSummaryByConfigRule, returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
GetComplianceSummaryByResourceType, returns the number of resources that are compliant and the number that are noncompliant.
GetOrganizationConfigRuleDetailedStatus, returns detailed status for each member account within an organization for a given organization config rule.
ListTagsForResource, list the tags for AWS Config resource.
PutConfigRule, adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
PutEvaluations, used by an AWS Lambda function to deliver evaluation results to AWS Config.
PutOrganizationConfigRule, adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.
PutRemediationConfigurations, adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action.
PutRemediationExceptions, adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.
StartConfigRulesEvaluation, runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.
StartRemediationExecution, runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration.
TagResource, associates the specified tags to a resource with the specified resourceArn.
UntagResource, deletes specified tags from a resource.

Conformance Packs

Use the following APIs for conformance packs:

DeleteConformancePack, deletes the specified conformance pack and all the AWS Config rules and all evaluation results within that conformance pack.
DeleteOrganizationConformancePack, deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization.
DescribeConformancePackCompliance, returns compliance information for each rule in that conformance pack.
DescribeConformancePacks, returns a list of one or more conformance packs.
DescribeConformancePackStatus, provides one or more conformance packs deployment status.
DescribeOrganizationConformancePacks, returns a list of organization conformance packs.
DescribeOrganizationConformancePackStatuses, provides organization conformance pack deployment status for an organization.
GetConformancePackComplianceDetails, returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack.
GetConformancePackComplianceSummary, returns compliance information for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
GetOrganizationConformancePackDetailedStatus, returns detailed status for each member account within an organization for a given organization conformance pack.
PutConformancePack, creates or updates a conformance pack.
PutOrganizationConformancePack, deploys conformance packs across member accounts in an AWS Organization.

Multi-Account Multi-Region Data Aggregation

AWS Config introduces a new resource type aggregator that collects AWS Config data from multiple source accounts and regions. Use the following objects for aggregating data:

BatchGetAggregateResourceConfig, returns the current configuration items for resources that are present in your AWS Config aggregator.
DeleteAggregationAuthorization, deletes the authorization granted to the specified configuration aggregator account in a specified region.
DeleteConfigurationAggregator, deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
DeletePendingAggregationRequest, deletes pending authorization requests for a specified aggregator account in a specified region.
DescribeAggregateComplianceByConfigRules, returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
DescribeAggregationAuthorizations, returns a list of authorizations granted to various aggregator accounts and regions.
DescribeConfigurationAggregators, 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.
DescribeConfigurationAggregatorSourcesStatus, returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account.
DescribePendingAggregationRequests, returns a list of all pending aggregation requests.
GetAggregateComplianceDetailsByConfigRule, returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
GetAggregateConfigRuleComplianceSummary, returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
GetAggregateDiscoveredResourceCounts, returns the resource counts across accounts and regions that are present in your AWS Config aggregator.
GetAggregateResourceConfig, returns configuration item that is aggregated for your specific resource in a specific source account and region.
ListAggregateDiscoveredResources, accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
PutAggregationAuthorization, authorizes the aggregator account and region to collect data from the source account and region.
PutConfigurationAggregator, creates and updates the configuration aggregator with the selected source accounts and regions.

This document was last published on November 26, 2019.

Javascript is disabled or is unavailable in your browser.

To use the AWS Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.