ConfigService / Client / describe_remediation_exceptions

describe_remediation_exceptions#

ConfigService.Client.describe_remediation_exceptions(**kwargs)#

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

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_remediation_exceptions(
    ConfigRuleName='string',
    ResourceKeys=[
        {
            'ResourceType': 'string',
            'ResourceId': 'string'
        },
    ],
    Limit=123,
    NextToken='string'
)
Parameters:

  • ConfigRuleName (string) –

    [REQUIRED]

    The name of the Config rule.

  • ResourceKeys (list) –

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

    • (dict) –

      The details that identify a resource within Config, including the resource type and resource ID.

      • ResourceType (string) –

        The type of a resource.

      • ResourceId (string) –

        The ID of the resource (for example., sg-xxxxxx).

  • Limit (integer) – The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

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

Return type:

dict

Returns:

Response Syntax

{
    'RemediationExceptions': [
        {
            'ConfigRuleName': 'string',
            'ResourceType': 'string',
            'ResourceId': 'string',
            'Message': 'string',
            'ExpirationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • RemediationExceptions (list) –

      Returns a list of remediation exception objects.

      • (dict) –

        An object that represents the details about the remediation exception. The details include the rule name, an explanation of an exception, the time when the exception will be deleted, the resource ID, and resource type.

        • ConfigRuleName (string) –

          The name of the Config rule.

        • ResourceType (string) –

          The type of a resource.

        • ResourceId (string) –

          The ID of the resource (for example., sg-xxxxxx).

        • Message (string) –

          An explanation of an remediation exception.

        • ExpirationTime (datetime) –

          The time when the remediation exception will be deleted.

    • NextToken (string) –

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

Exceptions

  • ConfigService.Client.exceptions.InvalidNextTokenException

  • ConfigService.Client.exceptions.InvalidParameterValueException