configservice_put_remediation_exceptions: A remediation exception is when a specific resource is no...

Description Usage Arguments Value Request syntax

View source: R/configservice_operations.R

Description

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

AWS 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.

Usage

1
2
configservice_put_remediation_exceptions(ConfigRuleName, ResourceKeys,
  Message, ExpirationTime)

Arguments

ConfigRuleName

[required] The name of the AWS Config rule for which you want to create remediation exception.

ResourceKeys

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

Message

The message contains an explanation of the exception.

ExpirationTime

The exception is automatically deleted after the expiration date.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
list(
  FailedBatches = list(
    list(
      FailureMessage = "string",
      FailedItems = list(
        list(
          ConfigRuleName = "string",
          ResourceType = "string",
          ResourceId = "string",
          Message = "string",
          ExpirationTime = as.POSIXct(
            "2015-01-01"
          )
        )
      )
    )
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
svc$put_remediation_exceptions(
  ConfigRuleName = "string",
  ResourceKeys = list(
    list(
      ResourceType = "string",
      ResourceId = "string"
    )
  ),
  Message = "string",
  ExpirationTime = as.POSIXct(
    "2015-01-01"
  )
)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.