/

POST

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object.

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

{
  "RetentionConfiguration": {
    "Name": "string",
    "RetentionPeriodInDays": 0
  }
}

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

RetentionPeriodInDays

integer

required

Number of days Config stores your historical information.

>= 30<= 2557

Examples

Responses

🟢200Success

application/json

Body

RetentionConfiguration

object

optional

Returns a retention configuration object.

Name

string

required

The name of the retention configuration object.

>= 1 characters<= 256 characters

Match pattern:

[\w\-]+

RetentionPeriodInDays

integer

required

Number of days Config stores your historical information.

>= 30<= 2557

🟠480InvalidParameterValueException

🟠481MaxNumberOfRetentionConfigurationsExceededException

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