/

POST

Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ConfigRuleNames": [],
    "NextToken": "string",
    "Limit": 0
}'

Response Example

200 - Example 1

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

Request

Query Params

Limit

string

optional

Pagination limit

NextToken

string

optional

Pagination token

Header Params

X-Amz-Target

string

required

Body Params application/json

<p/>

ConfigRuleNames

array[string]

optional

The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

>= 0 items<= 25 items

NextToken

string

optional

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

Limit

integer

optional

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 150 rules.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

>= 0<= 50

Examples

Responses

🟢200Success

application/json

Body

<p/>

ConfigRulesEvaluationStatus

array[object (ConfigRuleEvaluationStatus) {15}]

optional

Status information about your Config managed rules.

ConfigRuleName

string

optional

The name of the Config rule.

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

ConfigRuleArn

string

optional

The Amazon Resource Name (ARN) of the Config rule.

ConfigRuleId

string

optional

The ID of the Config rule.

LastSuccessfulInvocationTime

string <date-time>

optional

The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

LastFailedInvocationTime

string <date-time>

optional

The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

LastSuccessfulEvaluationTime

string <date-time>

optional

The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

LastFailedEvaluationTime

string <date-time>

optional

The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

FirstActivatedTime

string <date-time>

optional

The time that you first activated the Config rule.

LastDeactivatedTime

string <date-time>

optional

The time that you last turned off the Config rule.

LastErrorCode

string

optional

The error code that Config returned when the rule last failed.

LastErrorMessage

string

optional

The error message that Config returned when the rule last failed.

FirstEvaluationStarted

boolean

optional

Indicates whether Config has evaluated your resources against the rule at least once.

true - Config has evaluated your Amazon Web Services resources against the rule at least once.
false - Config has not finished evaluating your Amazon Web Services resources against the rule at least once.

LastDebugLogDeliveryStatus

string

optional

The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

LastDebugLogDeliveryStatusReason

string

optional

The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

LastDebugLogDeliveryTime

string <date-time>

optional

The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

NextToken

string

optional

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

🟠480NoSuchConfigRuleException

🟠481InvalidParameterValueException

🟠482InvalidNextTokenException

Modified at 2023-08-15 05:59:06