Skip to content

Describe Retention Configurations

configservice_describe_retention_configurations R Documentation

Returns the details of one or more 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.

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

Usage

configservice_describe_retention_configurations(
  RetentionConfigurationNames, NextToken)

Arguments

RetentionConfigurationNames

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.

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

NextToken

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

Value

A list with the following syntax:

list(
  RetentionConfigurations = list(
    list(
      Name = "string",
      RetentionPeriodInDays = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$describe_retention_configurations(
  RetentionConfigurationNames = list(
    "string"
  ),
  NextToken = "string"
)