Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeConfigRules

Returns details about your AWS Config rules.

Request Syntax


{
   "ConfigRuleNames": [ "string" ],
   "Filters": { 
      "EvaluationMode": "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 AWS Config rules for which you want details. If you do not specify any names, AWS 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

Filters

Returns a list of Detective or Proactive AWS Config rules. By default, this API returns an unfiltered list. For more information on Detective or Proactive AWS Config rules, see Evaluation Mode in the AWS Config Developer Guide.

Type: DescribeConfigRulesFilters object

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",
         "EvaluationModes": [ 
            { 
               "Mode": "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 AWS 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 not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.

HTTP Status Code: 400

InvalidParameterValueException

One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.

HTTP Status Code: 400

NoSuchConfigRuleException

The AWS Config rule in the request is not valid. Verify that the rule is an AWS Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.

HTTP Status Code: 400