ConfigService / Paginator / DescribeRetentionConfigurations

DescribeRetentionConfigurations

class ConfigService.Paginator.DescribeRetentionConfigurations

paginator = client.get_paginator('describe_retention_configurations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConfigService.Client.describe_retention_configurations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RetentionConfigurationNames=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• RetentionConfigurationNames (list) –

  A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

  Note

  Currently, Config supports only one retention configuration per region in your account.

  • (string) –

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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

      • Name (string) –

        The name of the retention configuration object.

      • RetentionPeriodInDays (integer) –

        Number of days Config stores your historical information.

        Note

        Currently, only applicable to the configuration item history.