Menu
AWS Config
API Reference (API Version 2014-11-12)

DescribeConfigRuleEvaluationStatus

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.

Request Syntax

{
   "ConfigRuleNames": [ "string" ],
   "Limit": number,
   "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 name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.

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 64.

Required: No

Limit

The number of rule evaluation results that you want returned.

This parameter is required if the rule limit for your account is more than the default of 50 rules.

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 50.

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

{
   "ConfigRulesEvaluationStatus": [ 
      { 
         "ConfigRuleArn": "string",
         "ConfigRuleId": "string",
         "ConfigRuleName": "string",
         "FirstActivatedTime": number,
         "FirstEvaluationStarted": boolean,
         "LastErrorCode": "string",
         "LastErrorMessage": "string",
         "LastFailedEvaluationTime": number,
         "LastFailedInvocationTime": number,
         "LastSuccessfulEvaluationTime": number,
         "LastSuccessfulInvocationTime": number
      }
   ],
   "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.

ConfigRulesEvaluationStatus

Status information about your AWS managed Config rules.

Type: Array of ConfigRuleEvaluationStatus 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

InvalidParameterValueException

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

HTTP Status Code: 400

NoSuchConfigRuleException

One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.

HTTP Status Code: 400

See Also

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