Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRemediationExecutionStatus

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

Request Syntax


{
   "ConfigRuleName": "string",
   "Limit": number,
   "NextToken": "string",
   "ResourceKeys": [ 
      { 
         "resourceId": "string",
         "resourceType": "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.

ConfigRuleName

The name of the AWS Config rule.

Type: String

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

Pattern: .*\S.*

Required: Yes

Limit

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.

Type: Integer

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

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

ResourceKeys

A list of resource keys to be processed with the current request. Each element in the list consists of the resource type and resource ID.

Type: Array of ResourceKey objects

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Required: No

Response Syntax


{
   "NextToken": "string",
   "RemediationExecutionStatuses": [ 
      { 
         "InvocationTime": number,
         "LastUpdatedTime": number,
         "ResourceKey": { 
            "resourceId": "string",
            "resourceType": "string"
         },
         "State": "string",
         "StepDetails": [ 
            { 
               "ErrorMessage": "string",
               "Name": "string",
               "StartTime": number,
               "State": "string",
               "StopTime": number
            }
         ]
      }
   ]
}

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.

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

RemediationExecutionStatuses

Returns a list of remediation execution statuses objects.

Type: Array of RemediationExecutionStatus objects

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

NoSuchRemediationConfigurationException

You specified an AWS Config rule without a remediation configuration.

HTTP Status Code: 400