Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . configservice ]

describe-retention-configurations

Description

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.

Note

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  describe-retention-configurations
[--retention-configuration-names <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--retention-configuration-names (list)

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.

Syntax:

"string" "string" ...

--next-token (string)

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

RetentionConfigurations -> (list)

Returns a retention configuration object.

(structure)

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.