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.

Classes

NameDescription
Class Compliance

Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.

Class ComplianceByConfigRule

Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it, and it is noncompliant if any of these resources do not comply.

Class ComplianceByResource

Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.

Class ComplianceContributorCount

The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.

Class ComplianceSummary

The number of AWS Config rules or AWS resources that are compliant and noncompliant.

Class ComplianceSummaryByResourceType

The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each compliance.

Class ConfigExportDeliveryInfo

Provides status of the delivery of the snapshot or the configuration history to the specified Amazon S3 bucket. Also provides the status of notifications about the Amazon S3 delivery to the specified Amazon SNS topic.

Class ConfigRule

An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).

You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

Class ConfigRuleEvaluationStatus

Status information for your AWS managed Config 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 custom Config rules.

Class ConfigSnapshotDeliveryProperties

Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.

If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:

The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:

  • The value for the deliveryFrequency parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for Config rules.

  • The value for the MaximumExecutionFrequency parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see ConfigRule.

If the deliveryFrequency value is less frequent than the MaximumExecutionFrequency value for a rule, AWS Config invokes the rule only as often as the deliveryFrequency value.

  1. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.

  2. You specify the MaximumExecutionFrequency value for Six_Hours.

  3. You then specify the delivery channel deliveryFrequency value for TwentyFour_Hours.

  4. Because the value for deliveryFrequency is less frequent than MaximumExecutionFrequency, AWS Config invokes evaluations for the rule every 24 hours.

You should set the MaximumExecutionFrequency value to be at least as frequent as the deliveryFrequency value. You can view the deliveryFrequency value by using the DescribeDeliveryChannnels action.

To update the deliveryFrequency with which AWS Config delivers your configuration snapshots, use the PutDeliveryChannel action.

Class ConfigStreamDeliveryInfo

A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.

Class ConfigurationItem

A list that contains detailed configurations of a specified resource.

Class ConfigurationRecorder

An object that represents the recording of configuration changes of an AWS resource.

Class ConfigurationRecorderStatus

The current status of the configuration recorder.

Class DeleteConfigRuleRequest

Container for the parameters to the DeleteConfigRule operation. 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.

Class DeleteConfigRuleResponse

This is the response object from the DeleteConfigRule operation.

Class DeleteConfigurationRecorderRequest

Container for the parameters to the DeleteConfigurationRecorder operation. 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.

Class DeleteConfigurationRecorderResponse

This is the response object from the DeleteConfigurationRecorder operation.

Class DeleteDeliveryChannelRequest

Container for the parameters to the DeleteDeliveryChannel operation. Deletes the delivery channel.

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

Class DeleteDeliveryChannelResponse

This is the response object from the DeleteDeliveryChannel operation.

Class DeleteEvaluationResultsRequest

Container for the parameters to the DeleteEvaluationResults operation. 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.

Class DeleteEvaluationResultsResponse

The output when you delete the evaluation results for the specified Config rule.

Class DeliverConfigSnapshotRequest

Container for the parameters to the DeliverConfigSnapshot operation. 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.

Class DeliverConfigSnapshotResponse

The output for the DeliverConfigSnapshot action in JSON format.

Class DeliveryChannel

The channel through which AWS Config delivers notifications and updated configuration states.

Class DeliveryChannelStatus

The status of a specified delivery channel.

Valid values: Success | Failure

Class DescribeComplianceByConfigRuleRequest

Container for the parameters to the DescribeComplianceByConfigRule operation. 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.

Class DescribeComplianceByConfigRuleResponse

Class DescribeComplianceByResourceRequest

Container for the parameters to the DescribeComplianceByResource operation. 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.

Class DescribeComplianceByResourceResponse

Class DescribeConfigRuleEvaluationStatusRequest

Container for the parameters to the DescribeConfigRuleEvaluationStatus operation. 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.

Class DescribeConfigRuleEvaluationStatusResponse

Class DescribeConfigRulesRequest

Container for the parameters to the DescribeConfigRules operation. Returns details about your AWS Config rules.

Class DescribeConfigRulesResponse

Class DescribeConfigurationRecordersRequest

Container for the parameters to the DescribeConfigurationRecorders operation. 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.

Class DescribeConfigurationRecordersResponse

The output for the DescribeConfigurationRecorders action.

Class DescribeConfigurationRecorderStatusRequest

Container for the parameters to the DescribeConfigurationRecorderStatus operation. 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.

Class DescribeConfigurationRecorderStatusResponse

The output for the DescribeConfigurationRecorderStatus action in JSON format.

Class DescribeDeliveryChannelsRequest

Container for the parameters to the DescribeDeliveryChannels operation. 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.

Class DescribeDeliveryChannelsResponse

The output for the DescribeDeliveryChannels action.

Class DescribeDeliveryChannelStatusRequest

Container for the parameters to the DescribeDeliveryChannelStatus operation. 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.

Class DescribeDeliveryChannelStatusResponse

The output for the DescribeDeliveryChannelStatus action.

Class Evaluation

Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.

Class EvaluationResult

The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information.

Class EvaluationResultIdentifier

Uniquely identifies an evaluation result.

Class EvaluationResultQualifier

Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated.

Class GetComplianceDetailsByConfigRuleRequest

Container for the parameters to the GetComplianceDetailsByConfigRule operation. 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.

Class GetComplianceDetailsByConfigRuleResponse

Class GetComplianceDetailsByResourceRequest

Container for the parameters to the GetComplianceDetailsByResource operation. 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.

Class GetComplianceDetailsByResourceResponse

Class GetComplianceSummaryByConfigRuleRequest

Container for the parameters to the GetComplianceSummaryByConfigRule operation. Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Class GetComplianceSummaryByConfigRuleResponse

Class GetComplianceSummaryByResourceTypeRequest

Container for the parameters to the GetComplianceSummaryByResourceType operation. 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.

Class GetComplianceSummaryByResourceTypeResponse

Class GetDiscoveredResourceCountsRequest
Class GetDiscoveredResourceCountsResponse

This is the response object from the GetDiscoveredResourceCounts operation.

Class GetResourceConfigHistoryRequest

Container for the parameters to the GetResourceConfigHistory operation. 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.

Class GetResourceConfigHistoryResponse

The output for the GetResourceConfigHistory action.

Class InsufficientDeliveryPolicyException

ConfigService exception

Class InsufficientPermissionsException

ConfigService exception

Class InvalidConfigurationRecorderNameException

ConfigService exception

Class InvalidDeliveryChannelNameException

ConfigService exception

Class InvalidLimitException

ConfigService exception

Class InvalidNextTokenException

ConfigService exception

Class InvalidParameterValueException

ConfigService exception

Class InvalidRecordingGroupException

ConfigService exception

Class InvalidResultTokenException

ConfigService exception

Class InvalidRoleException

ConfigService exception

Class InvalidS3KeyPrefixException

ConfigService exception

Class InvalidSNSTopicARNException

ConfigService exception

Class InvalidTimeRangeException

ConfigService exception

Class LastDeliveryChannelDeleteFailedException

ConfigService exception

Class LimitExceededException

ConfigService exception

Class ListDiscoveredResourcesRequest

Container for the parameters to the ListDiscoveredResources operation. 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.

Class ListDiscoveredResourcesResponse

Class MaxNumberOfConfigRulesExceededException

ConfigService exception

Class MaxNumberOfConfigurationRecordersExceededException

ConfigService exception

Class MaxNumberOfDeliveryChannelsExceededException

ConfigService exception

Class NoAvailableConfigurationRecorderException

ConfigService exception

Class NoAvailableDeliveryChannelException

ConfigService exception

Class NoRunningConfigurationRecorderException

ConfigService exception

Class NoSuchBucketException

ConfigService exception

Class NoSuchConfigRuleException

ConfigService exception

Class NoSuchConfigurationRecorderException

ConfigService exception

Class NoSuchDeliveryChannelException

ConfigService exception

Class PutConfigRuleRequest

Container for the parameters to the PutConfigRule operation. 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.

Class PutConfigRuleResponse

This is the response object from the PutConfigRule operation.

Class PutConfigurationRecorderRequest

Container for the parameters to the PutConfigurationRecorder operation. 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.

Class PutConfigurationRecorderResponse

This is the response object from the PutConfigurationRecorder operation.

Class PutDeliveryChannelRequest

Container for the parameters to the PutDeliveryChannel operation. 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.

Class PutDeliveryChannelResponse

This is the response object from the PutDeliveryChannel operation.

Class PutEvaluationsRequest

Container for the parameters to the PutEvaluations operation. 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.

Class PutEvaluationsResponse

Class RecordingGroup

Specifies the types of AWS resource for which AWS Config records configuration changes.

In the recording group, you specify whether all supported types or specific types of resources are recorded.

By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.

You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.

The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.

If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the resourceTypes parameter.

For a list of supported resource types, see Supported resource types.

For more information, see Selecting Which Resources AWS Config Records.

Class Relationship

The relationship of the related resource to the main resource.

Class ResourceCount

An object that contains the resource type and the number of resources.

Class ResourceIdentifier

The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.

Class ResourceInUseException

ConfigService exception

Class ResourceNotDiscoveredException

ConfigService exception

Class Scope

Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

Class Source

Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.

Class SourceDetail

Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS 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.

Class StartConfigRulesEvaluationRequest

Container for the parameters to the StartConfigRulesEvaluation operation. 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.

Class StartConfigRulesEvaluationResponse

The output when you start the evaluation for the specified Config rule.

Class StartConfigurationRecorderRequest

Container for the parameters to the StartConfigurationRecorder operation. 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.

Class StartConfigurationRecorderResponse

This is the response object from the StartConfigurationRecorder operation.

Class StopConfigurationRecorderRequest

Container for the parameters to the StopConfigurationRecorder operation. Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Class StopConfigurationRecorderResponse

This is the response object from the StopConfigurationRecorder operation.

Class ValidationException

ConfigService exception