PutRetentionConfiguration
Creates and updates the retention configuration with details
about retention period (number of days) that AWS 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.
Note
Currently, AWS Config supports only one retention configuration per region in your account.
Request Syntax
{
"RetentionPeriodInDays": number
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- RetentionPeriodInDays
-
Number of days AWS Config stores your historical information.
Note
Currently, only applicable to the configuration item history.
Type: Integer
Valid Range: Minimum value of 30. Maximum value of 2557.
Required: Yes
Response Syntax
{
"RetentionConfiguration": {
"Name": "string",
"RetentionPeriodInDays": number
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- RetentionConfiguration
-
Returns a retention configuration object.
Type: RetentionConfiguration object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterValueException
-
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- MaxNumberOfRetentionConfigurationsExceededException
-
Failed to add the retention configuration because a retention configuration with that name already exists.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
