DescribeRetentionConfigurations
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account.
Note
Currently, AWS Config supports only one retention configuration per region in your account.
Request Syntax
{
"NextToken": "string",
"RetentionConfigurationNames": [ "string" ]
}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.
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
Required: No
- RetentionConfigurationNames
-
A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account.
Note
Currently, AWS Config supports only one retention configuration per region in your account.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 1 item.
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\-]+Required: No
Response Syntax
{
"NextToken": "string",
"RetentionConfigurations": [
{
"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.
- NextToken
-
The
nextTokenstring returned on a previous page that you use to get the next page of results in a paginated response.Type: String
- RetentionConfigurations
-
Returns a retention configuration object.
Type: Array of RetentionConfiguration objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidNextTokenException
-
The specified next token is not valid. Specify the
nextTokenstring that was returned in the previous response to get the next page of results.HTTP Status Code: 400
- InvalidParameterValueException
-
One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
HTTP Status Code: 400
- NoSuchRetentionConfigurationException
-
You have specified a retention configuration that does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
