AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
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.
Namespace: Amazon.ConfigService
Assembly: AWSSDK.dll
Version: (assembly version)
public interface IAmazonConfigService IDisposable
The IAmazonConfigService type exposes the following members
Name | Description | |
---|---|---|
DeleteConfigRule(DeleteConfigRuleRequest) |
Deletes the specified AWS Config rule and all of its evaluation results.
AWS Config sets the state of a rule to
You can check the state of a rule by using the |
|
DeleteConfigRuleAsync(DeleteConfigRuleRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteConfigRule operation. | |
DeleteDeliveryChannel(string) |
Deletes the specified delivery channel.
The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action. |
|
DeleteDeliveryChannel(DeleteDeliveryChannelRequest) |
Deletes the specified delivery channel.
The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action. |
|
DeleteDeliveryChannelAsync(DeleteDeliveryChannelRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDeliveryChannel operation. | |
DeliverConfigSnapshot(string) |
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified
delivery channel. After the delivery has started, AWS Config sends following notifications
using an Amazon SNS topic that you have specified.
|
|
DeliverConfigSnapshot(DeliverConfigSnapshotRequest) |
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified
delivery channel. After the delivery has started, AWS Config sends following notifications
using an Amazon SNS topic that you have specified.
|
|
DeliverConfigSnapshotAsync(DeliverConfigSnapshotRequest, CancellationToken) | Initiates the asynchronous execution of the DeliverConfigSnapshot operation. | |
DescribeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest) |
Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant,
this action returns the number of AWS resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.
If AWS Config has no current evaluation results for the rule, it returns
|
|
DescribeComplianceByConfigRuleAsync(DescribeComplianceByConfigRuleRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation. | |
DescribeComplianceByResource(DescribeComplianceByResourceRequest) |
Indicates whether the specified AWS resources are compliant. If a resource is noncompliant,
this action returns the number of AWS Config rules that the resource does not comply
with.
A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If AWS Config has no current evaluation results for the resource, it returns
|
|
DescribeComplianceByResourceAsync(DescribeComplianceByResourceRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeComplianceByResource operation. | |
DescribeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest) | Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure. | |
DescribeConfigRuleEvaluationStatusAsync(DescribeConfigRuleEvaluationStatusRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation. | |
DescribeConfigRules(DescribeConfigRulesRequest) | Returns details about your AWS Config rules. | |
DescribeConfigRulesAsync(DescribeConfigRulesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigRules operation. | |
DescribeConfigurationRecorders() |
Returns the name of one or more specified configuration recorders. If the recorder
name is not specified, this action returns the names of all the configuration recorders
associated with the account.
Currently, you can specify only one configuration recorder per account. |
|
DescribeConfigurationRecorders(DescribeConfigurationRecordersRequest) |
Returns the name of one or more specified configuration recorders. If the recorder
name is not specified, this action returns the names of all the configuration recorders
associated with the account.
Currently, you can specify only one configuration recorder per account. |
|
DescribeConfigurationRecordersAsync(DescribeConfigurationRecordersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigurationRecorders operation. | |
DescribeConfigurationRecorderStatus() |
Returns the current status of the specified configuration recorder. If a configuration
recorder is not specified, this action returns the status of all configuration recorder
associated with the account.
|
|
DescribeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest) |
Returns the current status of the specified configuration recorder. If a configuration
recorder is not specified, this action returns the status of all configuration recorder
associated with the account.
|
|
DescribeConfigurationRecorderStatusAsync(DescribeConfigurationRecorderStatusRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation. | |
DescribeDeliveryChannels() |
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.
Currently, you can specify only one delivery channel per account. |
|
DescribeDeliveryChannels(DescribeDeliveryChannelsRequest) |
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.
Currently, you can specify only one delivery channel per account. |
|
DescribeDeliveryChannelsAsync(DescribeDeliveryChannelsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDeliveryChannels operation. | |
DescribeDeliveryChannelStatus() |
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.
|
|
DescribeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest) |
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.
|
|
DescribeDeliveryChannelStatusAsync(DescribeDeliveryChannelStatusRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation. | |
GetComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest) | Returns the evaluation results for the specified AWS Config 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. | |
GetComplianceDetailsByConfigRuleAsync(GetComplianceDetailsByConfigRuleRequest, CancellationToken) | Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation. | |
GetComplianceDetailsByResource(GetComplianceDetailsByResourceRequest) | Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule. | |
GetComplianceDetailsByResourceAsync(GetComplianceDetailsByResourceRequest, CancellationToken) | Initiates the asynchronous execution of the GetComplianceDetailsByResource operation. | |
GetComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest) | Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each. | |
GetComplianceSummaryByConfigRuleAsync(GetComplianceSummaryByConfigRuleRequest, CancellationToken) | Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation. | |
GetComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest) | 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. | |
GetComplianceSummaryByResourceTypeAsync(GetComplianceSummaryByResourceTypeRequest, CancellationToken) | Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation. | |
GetResourceConfigHistory(GetResourceConfigHistoryRequest) |
Returns a list of configuration items for the specified resource. The list contains
details about each state of the resource during the specified time interval.
The response is paginated, and by default, AWS Config returns a limit of 10 configuration
items per page. You can customize this number with the
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 |
|
GetResourceConfigHistoryAsync(GetResourceConfigHistoryRequest, CancellationToken) | Initiates the asynchronous execution of the GetResourceConfigHistory operation. | |
ListDiscoveredResources(ListDiscoveredResourcesRequest) |
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 AWS Config has discovered,
including those that AWS Config is not currently recording. You can narrow the results
to include only resources that have specific resource IDs or a resource name.
The response is paginated, and by default AWS Config lists 100 resource identifiers
on each page. You can customize this number with the |
|
ListDiscoveredResourcesAsync(ListDiscoveredResourcesRequest, CancellationToken) | Initiates the asynchronous execution of the ListDiscoveredResources operation. | |
PutConfigRule(PutConfigRuleRequest) |
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply
with your desired configurations.
You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config.
If you are adding a new customer managed Config rule, you must first create the AWS
Lambda function that the rule invokes to evaluate your resources. When you use the
If you are adding a new AWS managed Config rule, specify the rule's identifier for
the
For any new rule that you add, specify the
If you are updating a rule that you have added previously, specify the rule's The maximum number of rules that AWS Config supports is 25. For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide. |
|
PutConfigRuleAsync(PutConfigRuleRequest, CancellationToken) | Initiates the asynchronous execution of the PutConfigRule operation. | |
PutConfigurationRecorder(PutConfigurationRecorderRequest) |
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role Currently, you can specify only one configuration recorder per account.
If |
|
PutConfigurationRecorderAsync(PutConfigurationRecorderRequest, CancellationToken) | Initiates the asynchronous execution of the PutConfigurationRecorder operation. | |
PutDeliveryChannel(PutDeliveryChannelRequest) |
Creates a new delivery channel object to deliver the configuration information to
an Amazon S3 bucket, and to an Amazon SNS topic.
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. Currently, you can specify only one delivery channel per account. |
|
PutDeliveryChannelAsync(PutDeliveryChannelRequest, CancellationToken) | Initiates the asynchronous execution of the PutDeliveryChannel operation. | |
PutEvaluations(PutEvaluationsRequest) | Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule. | |
PutEvaluationsAsync(PutEvaluationsRequest, CancellationToken) | Initiates the asynchronous execution of the PutEvaluations operation. | |
StartConfigurationRecorder(string) |
Starts recording configurations of the AWS resources you have selected to record in
your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder. |
|
StartConfigurationRecorder(StartConfigurationRecorderRequest) |
Starts recording configurations of the AWS resources you have selected to record in
your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder. |
|
StartConfigurationRecorderAsync(StartConfigurationRecorderRequest, CancellationToken) | Initiates the asynchronous execution of the StartConfigurationRecorder operation. | |
StopConfigurationRecorder(string) | Stops recording configurations of the AWS resources you have selected to record in your AWS account. | |
StopConfigurationRecorder(StopConfigurationRecorderRequest) | Stops recording configurations of the AWS resources you have selected to record in your AWS account. | |
StopConfigurationRecorderAsync(StopConfigurationRecorderRequest, CancellationToken) | Initiates the asynchronous execution of the StopConfigurationRecorder operation. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5