/

POST

Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "RemediationConfigurations": []
}'

Response Example

200 - Example 1

{
  "FailedBatches": []
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

RemediationConfigurations

array[object (RemediationConfiguration) {12}]

required

A list of remediation configuration objects.

>= 0 items<= 25 items

ConfigRuleName

string

required

The name of the Config rule.

>= 1 characters<= 128 characters

Match pattern:

.*\S.*

TargetType

enum<string>

required

The type of the target. Target executes remediation. For example, SSM document.

Allowed value:

SSM_DOCUMENT

TargetId

string

required

Target ID is the name of the SSM document.

>= 1 characters<= 256 characters

TargetVersion

string

optional

Version of the target. For example, version of the SSM document.

Parameters

object

optional

An object of the RemediationParameterValue.

ResourceType

string

optional

The type of a resource.

Automatic

boolean

optional

The remediation is triggered automatically.

ExecutionControls

object

optional

An ExecutionControls object.

MaximumAutomaticAttempts

integer

optional

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

>= 1<= 25

RetryAttemptSeconds

integer

optional

Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

>= 1<= 2678000

Arn

string

optional

Amazon Resource Name (ARN) of remediation configuration.

>= 1 characters<= 1024 characters

CreatedByService

string

optional

Name of the service that owns the service-linked rule, if applicable.

>= 1 characters<= 1024 characters

Examples

Responses

🟢200Success

application/json

Body

FailedBatches

array[object (FailedRemediationBatch) {2}]

optional

Returns a list of failed remediation batch objects.

FailureMessage

string

optional

Returns a failure message. For example, the resource is already compliant.

FailedItems

array[object (RemediationConfiguration) {12}]

optional

Returns remediation configurations of the failed items.

>= 0 items<= 25 items

🟠480InsufficientPermissionsException

🟠481InvalidParameterValueException

Modified at 2023-08-15 05:59:06