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 4.5
 
 

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, up to a maximum.
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 A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.
Class ConfigRule An AWS Lambda function that 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 or delivers a configuration snapshot.

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 customer managed Config rules.

Class ConfigSnapshotDeliveryProperties Options for how AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.
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.

Currently, the list does not contain information about non-AWS components (for example, applications on your Amazon EC2 instances).

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

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

Class DeleteConfigRuleResponse
Class DeleteDeliveryChannelRequest Container for the parameters to the DeleteDeliveryChannel operation. 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.

Class DeleteDeliveryChannelResponse
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 Configuration for accessing Amazon DeliverConfigSnapshot service
Class DeliverConfigSnapshotResult The output for the DeliverConfigSnapshot action in JSON format.
Class DeliveryChannel A logical container used for storing the configuration changes of an AWS resource.
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 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.
Class DescribeComplianceByConfigRuleResponse Configuration for accessing Amazon DescribeComplianceByConfigRule service
Class DescribeComplianceByConfigRuleResult
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 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.
Class DescribeComplianceByResourceResponse Configuration for accessing Amazon DescribeComplianceByResource service
Class DescribeComplianceByResourceResult
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 Configuration for accessing Amazon DescribeConfigRuleEvaluationStatus service
Class DescribeConfigRuleEvaluationStatusResult
Class DescribeConfigRulesRequest Container for the parameters to the DescribeConfigRules operation. Returns details about your AWS Config rules.
Class DescribeConfigRulesResponse Configuration for accessing Amazon DescribeConfigRules service
Class DescribeConfigRulesResult
Class DescribeConfigurationRecordersRequest Container for the parameters to the DescribeConfigurationRecorders operation. 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.

Class DescribeConfigurationRecordersResponse Configuration for accessing Amazon DescribeConfigurationRecorders service
Class DescribeConfigurationRecordersResult 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 account.
Class DescribeConfigurationRecorderStatusResponse Configuration for accessing Amazon DescribeConfigurationRecorderStatus service
Class DescribeConfigurationRecorderStatusResult 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 account.

Class DescribeDeliveryChannelsResponse Configuration for accessing Amazon DescribeDeliveryChannels service
Class DescribeDeliveryChannelsResult 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 account.
Class DescribeDeliveryChannelStatusResponse Configuration for accessing Amazon DescribeDeliveryChannelStatus service
Class DescribeDeliveryChannelStatusResult 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 Configuration for accessing Amazon GetComplianceDetailsByConfigRule service
Class GetComplianceDetailsByConfigRuleResult
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 Configuration for accessing Amazon GetComplianceDetailsByResource service
Class GetComplianceDetailsByResourceResult
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 Configuration for accessing Amazon GetComplianceSummaryByConfigRule service
Class GetComplianceSummaryByConfigRuleResult
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 Configuration for accessing Amazon GetComplianceSummaryByResourceType service
Class GetComplianceSummaryByResourceTypeResult
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, 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.

Class GetResourceConfigHistoryResponse Configuration for accessing Amazon GetResourceConfigHistory service
Class GetResourceConfigHistoryResult 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 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, 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.

Class ListDiscoveredResourcesResponse Configuration for accessing Amazon ListDiscoveredResources service
Class ListDiscoveredResourcesResult
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 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.

Class PutConfigRuleResponse
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 account.

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

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

Class PutDeliveryChannelResponse
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 Configuration for accessing Amazon PutEvaluations service
Class PutEvaluationsResult
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. 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 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 type of the event that triggers AWS Config to evaluate your AWS resources against a 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
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
Class ValidationException ConfigService exception