AWS SDK Version 3 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.

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.ConfigService.dll
Version: 3.x.y.z

Syntax

C#
public interface IAmazonConfigService
         IAmazonService, IDisposable

The IAmazonConfigService type exposes the following members

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

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

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

Public Method DeleteConfigRuleAsync(DeleteConfigRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigRule operation.

Public Method DeleteConfigurationRecorder(DeleteConfigurationRecorderRequest)

Deletes the configuration recorder.

After the configuration recorder is deleted, AWS 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 AWS Config console until you create a new configuration recorder.

Public Method DeleteConfigurationRecorderAsync(DeleteConfigurationRecorderRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteConfigurationRecorder operation.

Public Method DeleteDeliveryChannel(string)

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Public Method DeleteDeliveryChannel(DeleteDeliveryChannelRequest)

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Public Method DeleteDeliveryChannelAsync(string, CancellationToken)

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Public Method DeleteDeliveryChannelAsync(DeleteDeliveryChannelRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteDeliveryChannel operation.

Public Method DeleteEvaluationResults(DeleteEvaluationResultsRequest)

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 AWS resources against the rule.

Public Method DeleteEvaluationResultsAsync(DeleteEvaluationResultsRequest, CancellationToken)

Initiates the asynchronous execution of the DeleteEvaluationResults operation.

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 DeliverConfigSnapshotAsync(string, CancellationToken)

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 DeliverConfigSnapshotAsync(DeliverConfigSnapshotRequest, CancellationToken)

Initiates the asynchronous execution of the DeliverConfigSnapshot operation.

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 custom 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 DescribeComplianceByConfigRuleAsync(DescribeComplianceByConfigRuleRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeComplianceByConfigRule operation.

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 custom 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 DescribeComplianceByResourceAsync(DescribeComplianceByResourceRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeComplianceByResource operation.

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 DescribeConfigRuleEvaluationStatusAsync(DescribeConfigRuleEvaluationStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigRuleEvaluationStatus operation.

Public Method DescribeConfigRules(DescribeConfigRulesRequest)

Returns details about your AWS Config rules.

Public Method DescribeConfigRulesAsync(DescribeConfigRulesRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigRules operation.

Public Method DescribeConfigurationRecorders()

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.

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

Public Method DescribeConfigurationRecorders(DescribeConfigurationRecordersRequest)

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.

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

Public Method DescribeConfigurationRecordersAsync(CancellationToken)

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.

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

Public Method DescribeConfigurationRecordersAsync(DescribeConfigurationRecordersRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationRecorders operation.

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 region in your 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 region in your account.

Public Method DescribeConfigurationRecorderStatusAsync(CancellationToken)

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 region in your account.

Public Method DescribeConfigurationRecorderStatusAsync(DescribeConfigurationRecorderStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeConfigurationRecorderStatus operation.

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 region in your 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 region in your account.

Public Method DescribeDeliveryChannelsAsync(CancellationToken)

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 region in your account.

Public Method DescribeDeliveryChannelsAsync(DescribeDeliveryChannelsRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDeliveryChannels operation.

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 region in your 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 region in your account.

Public Method DescribeDeliveryChannelStatusAsync(CancellationToken)

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 region in your account.

Public Method DescribeDeliveryChannelStatusAsync(DescribeDeliveryChannelStatusRequest, CancellationToken)

Initiates the asynchronous execution of the DescribeDeliveryChannelStatus 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 GetComplianceDetailsByConfigRuleAsync(GetComplianceDetailsByConfigRuleRequest, CancellationToken)

Initiates the asynchronous execution of the GetComplianceDetailsByConfigRule operation.

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 GetComplianceDetailsByResourceAsync(GetComplianceDetailsByResourceRequest, CancellationToken)

Initiates the asynchronous execution of the GetComplianceDetailsByResource operation.

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 GetComplianceSummaryByConfigRuleAsync(GetComplianceSummaryByConfigRuleRequest, CancellationToken)

Initiates the asynchronous execution of the GetComplianceSummaryByConfigRule operation.

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 GetComplianceSummaryByResourceTypeAsync(GetComplianceSummaryByResourceTypeRequest, CancellationToken)

Initiates the asynchronous execution of the GetComplianceSummaryByResourceType operation.

Public Method GetDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest)
Public Method GetDiscoveredResourceCountsAsync(GetDiscoveredResourceCountsRequest, CancellationToken)

Initiates the asynchronous execution of the GetDiscoveredResourceCounts operation.

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. 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. To get the next page of results, run the request again and specify the 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 GetResourceConfigHistoryAsync(GetResourceConfigHistoryRequest, CancellationToken)

Initiates the asynchronous execution of the GetResourceConfigHistory operation.

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. 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. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Public Method ListDiscoveredResourcesAsync(ListDiscoveredResourcesRequest, CancellationToken)

Initiates the asynchronous execution of the ListDiscoveredResources operation.

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 custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.

If you are adding a new custom 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 an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About 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 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 AWS Config supports is 50.

For more information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.

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 PutConfigRuleAsync(PutConfigRuleRequest, CancellationToken)

Initiates the asynchronous execution of the PutConfigRule operation.

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 region in your account.

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

Public Method PutConfigurationRecorderAsync(PutConfigurationRecorderRequest, CancellationToken)

Initiates the asynchronous execution of the PutConfigurationRecorder operation.

Public Method PutDeliveryChannel(PutDeliveryChannelRequest)

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.

You can have only one delivery channel per region in your account.

Public Method PutDeliveryChannelAsync(PutDeliveryChannelRequest, CancellationToken)

Initiates the asynchronous execution of the PutDeliveryChannel operation.

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 PutEvaluationsAsync(PutEvaluationsRequest, CancellationToken)

Initiates the asynchronous execution of the PutEvaluations operation.

Public Method StartConfigRulesEvaluation(StartConfigRulesEvaluationRequest)

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 a rule that 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 must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. AWS Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Public Method StartConfigRulesEvaluationAsync(StartConfigRulesEvaluationRequest, CancellationToken)

Initiates the asynchronous execution of the StartConfigRulesEvaluation operation.

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 StartConfigurationRecorderAsync(string, CancellationToken)

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 StartConfigurationRecorderAsync(StartConfigurationRecorderRequest, CancellationToken)

Initiates the asynchronous execution of the StartConfigurationRecorder operation.

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.

Public Method StopConfigurationRecorderAsync(string, CancellationToken)

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Public Method StopConfigurationRecorderAsync(StopConfigurationRecorderRequest, CancellationToken)

Initiates the asynchronous execution of the StopConfigurationRecorder operation.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms