AWS Config

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.

See also: AWS API Documentation

Request Syntax

client.describe_retention_configurations(
    RetentionConfigurationNames=[
        'string',
    ],
    NextToken='string'
)

type RetentionConfigurationNames

list

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

• (string) --

type NextToken

string

param NextToken

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

rtype

dict

returns

Response Syntax

{
    'RetentionConfigurations': [
        {
            'Name': 'string',
            'RetentionPeriodInDays': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • RetentionConfigurations (list) --

    Returns a retention configuration object.

    • (dict) --

      An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in AWS Config.

      • Name (string) --

        The name of the retention configuration object.

      • RetentionPeriodInDays (integer) --

        Number of days AWS Config stores your historical information.

        Note

        Currently, only applicable to the configuration item history.

  • NextToken (string) --

    The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

Deletes the retention configuration.

See also: AWS API Documentation

Request Syntax

client.delete_retention_configuration(
    RetentionConfigurationName='string'
)

type RetentionConfigurationName

string

param RetentionConfigurationName

[REQUIRED]

The name of the retention configuration to delete.

returns

None

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.

See also: AWS API Documentation

Request Syntax

client.put_retention_configuration(
    RetentionPeriodInDays=123
)

type RetentionPeriodInDays

integer

param RetentionPeriodInDays

[REQUIRED]

Number of days AWS Config stores your historical information.

Note

Currently, only applicable to the configuration item history.

rtype

dict

returns

Response Syntax

{
    'RetentionConfiguration': {
        'Name': 'string',
        'RetentionPeriodInDays': 123
    }
}

Response Structure

• (dict) --

  • RetentionConfiguration (dict) --

    Returns a retention configuration object.

    • Name (string) --

      The name of the retention configuration object.

    • RetentionPeriodInDays (integer) --

      Number of days AWS Config stores your historical information.

      Note

      Currently, only applicable to the configuration item history.