DescribeConfigRules - Amazon Config
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeConfigRules

Returns details about your Amazon Config rules.

Request Syntax

{ "ConfigRuleNames": [ "string" ], "NextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ConfigRuleNames

The names of the Amazon Config rules for which you want details. If you do not specify any names, Amazon Config returns details for all your rules.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: .*\S.*

Required: No

NextToken

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Type: String

Required: No

Response Syntax

{ "ConfigRules": [ { "ConfigRuleArn": "string", "ConfigRuleId": "string", "ConfigRuleName": "string", "ConfigRuleState": "string", "CreatedBy": "string", "Description": "string", "InputParameters": "string", "MaximumExecutionFrequency": "string", "Scope": { "ComplianceResourceId": "string", "ComplianceResourceTypes": [ "string" ], "TagKey": "string", "TagValue": "string" }, "Source": { "CustomPolicyDetails": { "EnableDebugLogDelivery": boolean, "PolicyRuntime": "string", "PolicyText": "string" }, "Owner": "string", "SourceDetails": [ { "EventSource": "string", "MaximumExecutionFrequency": "string", "MessageType": "string" } ], "SourceIdentifier": "string" } } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConfigRules

The details about your Amazon Config rules.

Type: Array of ConfigRule objects

NextToken

The string that you use in a subsequent request to get the next page of results in a paginated response.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The specified next token is invalid. Specify the nextToken string that was returned in the previous response to get the next page of results.

HTTP Status Code: 400

NoSuchConfigRuleException

The Amazon Config rule in the request is invalid. Verify that the rule is an Amazon Config Custom Policy rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: