AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 3.5
 
Interface for accessing ConfigService AWS Config

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.

Inheritance Hierarchy

Amazon.ConfigService.IAmazonConfigService

Namespace: Amazon.ConfigService
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonConfigService
         IDisposable

The IAmazonConfigService type exposes the following members

Methods

NameDescription
Public Method BeginDeleteConfigRule(DeleteConfigRuleRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteConfigRule operation.
Public Method BeginDeleteDeliveryChannel(DeleteDeliveryChannelRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteDeliveryChannel operation.
Public Method BeginDeliverConfigSnapshot(DeliverConfigSnapshotRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeliverConfigSnapshot operation.
Public Method BeginDescribeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation.
Public Method BeginDescribeComplianceByResource(DescribeComplianceByResourceRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeComplianceByResource operation.
Public Method BeginDescribeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation.
Public Method BeginDescribeConfigRules(DescribeConfigRulesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConfigRules operation.
Public Method BeginDescribeConfigurationRecorders(DescribeConfigurationRecordersRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConfigurationRecorders operation.
Public Method BeginDescribeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation.
Public Method BeginDescribeDeliveryChannels(DescribeDeliveryChannelsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeDeliveryChannels operation.
Public Method BeginDescribeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeDeliveryChannelStatus operation.
Public Method BeginGetComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation.
Public Method BeginGetComplianceDetailsByResource(GetComplianceDetailsByResourceRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetComplianceDetailsByResource operation.
Public Method BeginGetComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation.
Public Method BeginGetComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation.
Public Method BeginGetResourceConfigHistory(GetResourceConfigHistoryRequest, AsyncCallback, object) Initiates the asynchronous execution of the GetResourceConfigHistory operation.
Public Method BeginListDiscoveredResources(ListDiscoveredResourcesRequest, AsyncCallback, object) Initiates the asynchronous execution of the ListDiscoveredResources operation.
Public Method BeginPutConfigRule(PutConfigRuleRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutConfigRule operation.
Public Method BeginPutConfigurationRecorder(PutConfigurationRecorderRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutConfigurationRecorder operation.
Public Method BeginPutDeliveryChannel(PutDeliveryChannelRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutDeliveryChannel operation.
Public Method BeginPutEvaluations(PutEvaluationsRequest, AsyncCallback, object) Initiates the asynchronous execution of the PutEvaluations operation.
Public Method BeginStartConfigurationRecorder(StartConfigurationRecorderRequest, AsyncCallback, object) Initiates the asynchronous execution of the StartConfigurationRecorder operation.
Public Method BeginStopConfigurationRecorder(StopConfigurationRecorderRequest, AsyncCallback, object) Initiates the asynchronous execution of the StopConfigurationRecorder operation.
Public Method DeleteConfigRule(DeleteConfigRuleRequest) Deletes the specified AWS Config rule and all of its evaluation results.

AWS 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 request for the rule, you will receive a ResourceInUseException.

You can check the state of a rule by using the DescribeConfigRules request.

Public Method 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.

Public Method 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.

Public Method 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.
  • Notification of starting the delivery.
  • Notification of delivery completed, if the delivery was successfully completed.
  • Notification of delivery failure, if the delivery failed to complete.
Public Method 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.
  • Notification of starting the delivery.
  • Notification of delivery completed, if the delivery was successfully completed.
  • Notification of delivery failure, if the delivery failed to complete.
Public Method 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 INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.
  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Public Method 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 INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.
  • The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a customer managed rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission.
  • The rule's AWS Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Public Method 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.
Public Method DescribeConfigRules(DescribeConfigRulesRequest) Returns details about your AWS Config rules.
Public Method 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.

Public Method 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.

Public Method 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. Currently, you can specify only one configuration recorder per account.
Public Method 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. Currently, you can specify only one configuration recorder per account.
Public Method 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.

Public Method 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.

Public Method 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. Currently, you can specify only one delivery channel per account.
Public Method 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. Currently, you can specify only one delivery channel per account.
Public Method EndDeleteConfigRule(IAsyncResult) Finishes the asynchronous execution of the DeleteConfigRule operation.
Public Method EndDeleteDeliveryChannel(IAsyncResult) Finishes the asynchronous execution of the DeleteDeliveryChannel operation.
Public Method EndDeliverConfigSnapshot(IAsyncResult) Finishes the asynchronous execution of the DeliverConfigSnapshot operation.
Public Method EndDescribeComplianceByConfigRule(IAsyncResult) Finishes the asynchronous execution of the DescribeComplianceByConfigRule operation.
Public Method EndDescribeComplianceByResource(IAsyncResult) Finishes the asynchronous execution of the DescribeComplianceByResource operation.
Public Method EndDescribeConfigRuleEvaluationStatus(IAsyncResult) Finishes the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation.
Public Method EndDescribeConfigRules(IAsyncResult) Finishes the asynchronous execution of the DescribeConfigRules operation.
Public Method EndDescribeConfigurationRecorders(IAsyncResult) Finishes the asynchronous execution of the DescribeConfigurationRecorders operation.
Public Method EndDescribeConfigurationRecorderStatus(IAsyncResult) Finishes the asynchronous execution of the DescribeConfigurationRecorderStatus operation.
Public Method EndDescribeDeliveryChannels(IAsyncResult) Finishes the asynchronous execution of the DescribeDeliveryChannels operation.
Public Method EndDescribeDeliveryChannelStatus(IAsyncResult) Finishes the asynchronous execution of the DescribeDeliveryChannelStatus operation.
Public Method EndGetComplianceDetailsByConfigRule(IAsyncResult) Finishes the asynchronous execution of the GetComplianceDetailsByConfigRule operation.
Public Method EndGetComplianceDetailsByResource(IAsyncResult) Finishes the asynchronous execution of the GetComplianceDetailsByResource operation.
Public Method EndGetComplianceSummaryByConfigRule(IAsyncResult) Finishes the asynchronous execution of the GetComplianceSummaryByConfigRule operation.
Public Method EndGetComplianceSummaryByResourceType(IAsyncResult) Finishes the asynchronous execution of the GetComplianceSummaryByResourceType operation.
Public Method EndGetResourceConfigHistory(IAsyncResult) Finishes the asynchronous execution of the GetResourceConfigHistory operation.
Public Method EndListDiscoveredResources(IAsyncResult) Finishes the asynchronous execution of the ListDiscoveredResources operation.
Public Method EndPutConfigRule(IAsyncResult) Finishes the asynchronous execution of the PutConfigRule operation.
Public Method EndPutConfigurationRecorder(IAsyncResult) Finishes the asynchronous execution of the PutConfigurationRecorder operation.
Public Method EndPutDeliveryChannel(IAsyncResult) Finishes the asynchronous execution of the PutDeliveryChannel operation.
Public Method EndPutEvaluations(IAsyncResult) Finishes the asynchronous execution of the PutEvaluations operation.
Public Method EndStartConfigurationRecorder(IAsyncResult) Finishes the asynchronous execution of the StartConfigurationRecorder operation.
Public Method EndStopConfigurationRecorder(IAsyncResult) Finishes the asynchronous execution of the StopConfigurationRecorder operation.
Public Method 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.
Public Method 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.
Public Method GetComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest) Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Public Method 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.
Public Method 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 limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

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.

Public Method 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. You can specify either resource IDs or a resource name but not both in the same request.

The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Public Method 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 PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS 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 a new AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see Using AWS Managed Config 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 AWS Config for new rules.

If you are updating a rule that you have added previously, specify the rule's ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request.

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.

Public Method PutConfigurationRecorder(PutConfigurationRecorderRequest) Creates a new configuration recorder to record the selected resource configurations.

You can use this action to change the role roleARN and/or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.

Currently, you can specify only one configuration recorder per account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Public Method 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.

Public Method 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.
Public Method 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.

Public Method 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.

Public Method StopConfigurationRecorder(string) Stops recording configurations of the AWS resources you have selected to record in your AWS account.
Public Method StopConfigurationRecorder(StopConfigurationRecorderRequest) Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5