Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRemediationExceptions

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.

Note

Amazon Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

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 Amazon Config rule.

Type: String

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

Pattern: .*\S.*

Required: Yes

Limit

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Amazon Config uses the default.

Type: Integer

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

Required: No

NextToken

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

Type: String

Required: No

ResourceKeys

An exception list of resource exception keys to be processed with the current request. Amazon Config adds exception for each resource key. For example, Amazon Config adds 3 exceptions for 3 resource keys.

Type: Array of RemediationExceptionResourceKey objects

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

Required: No

Response Syntax


{
   "NextToken": "string",
   "RemediationExceptions": [ 
      { 
         "ConfigRuleName": "string",
         "ExpirationTime": number,
         "Message": "string",
         "ResourceId": "string",
         "ResourceType": "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.

NextToken

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

Type: String

RemediationExceptions

Returns a list of remediation exception objects.

Type: Array of RemediationException objects

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

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