ConfigService / Client / put_remediation_exceptions

put_remediation_exceptions#

ConfigService.Client.put_remediation_exceptions(**kwargs)#

A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.

Note

Exceptions block auto remediation

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Note

Manual remediation is recommended when placing an exception

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

Note

Exceptions can only be performed on non-compliant resources

Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.

Note

Exceptions cannot be placed on service-linked remediation actions

You cannot place an exception on service-linked remediation actions, such as remediation actions put by an organizational conformance pack.

Note

Auto remediation can be initiated even for compliant resources

If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.

This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.

Request Syntax

response = client.put_remediation_exceptions(
    ConfigRuleName='string',
    ResourceKeys=[
        {
            'ResourceType': 'string',
            'ResourceId': 'string'
        },
    ],
    Message='string',
    ExpirationTime=datetime(2015, 1, 1)
)

Parameters:

ConfigRuleName (string) –
[REQUIRED]

The name of the Config rule for which you want to create remediation exception.
ResourceKeys (list) –
[REQUIRED]

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).
Message (string) – The message contains an explanation of the exception.
ExpirationTime (datetime) – The exception is automatically deleted after the expiration date.

Return type:

dict

Returns:

Response Syntax

{
    'FailedBatches': [
        {
            'FailureMessage': 'string',
            'FailedItems': [
                {
                    'ConfigRuleName': 'string',
                    'ResourceType': 'string',
                    'ResourceId': 'string',
                    'Message': 'string',
                    'ExpirationTime': datetime(2015, 1, 1)
                },
            ]
        },
    ]
}

Response Structure

(dict) –
- FailedBatches (list) –
  
  Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.
  - (dict) –
    
    List of each of the failed remediation exceptions with specific reasons.
    - FailureMessage (string) –
      
      Returns a failure message. For example, the auto-remediation has failed.
    - FailedItems (list) –
      
      Returns remediation exception resource key object of the failed items.
      - (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.