amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.DescribeRetentionConfigurations

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.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeRetentionConfigurations Source #

See: newDescribeRetentionConfigurations smart constructor.

Constructors

DescribeRetentionConfigurations' 

Fields

  • nextToken :: Maybe Text

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

  • retentionConfigurationNames :: Maybe [Text]

    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.

Instances

Instances details
ToJSON DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

ToHeaders DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

ToPath DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

ToQuery DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

AWSPager DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

AWSRequest DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Generic DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Associated Types

type Rep DescribeRetentionConfigurations :: Type -> Type #

Read DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Show DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

NFData DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Eq DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Hashable DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

type AWSResponse DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

type Rep DescribeRetentionConfigurations Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

type Rep DescribeRetentionConfigurations = D1 ('MetaData "DescribeRetentionConfigurations" "Amazonka.Config.DescribeRetentionConfigurations" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeRetentionConfigurations'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "retentionConfigurationNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newDescribeRetentionConfigurations :: DescribeRetentionConfigurations Source #

Create a value of DescribeRetentionConfigurations with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:retentionConfigurationNames:DescribeRetentionConfigurations', describeRetentionConfigurations_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.

Request Lenses

describeRetentionConfigurations_nextToken :: Lens' DescribeRetentionConfigurations (Maybe Text) Source #

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

describeRetentionConfigurations_retentionConfigurationNames :: Lens' DescribeRetentionConfigurations (Maybe [Text]) Source #

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.

Destructuring the Response

data DescribeRetentionConfigurationsResponse Source #

Constructors

DescribeRetentionConfigurationsResponse' 

Fields

Instances

Instances details
Generic DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Read DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Show DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

NFData DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

Eq DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

type Rep DescribeRetentionConfigurationsResponse Source # 
Instance details

Defined in Amazonka.Config.DescribeRetentionConfigurations

type Rep DescribeRetentionConfigurationsResponse = D1 ('MetaData "DescribeRetentionConfigurationsResponse" "Amazonka.Config.DescribeRetentionConfigurations" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "DescribeRetentionConfigurationsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "retentionConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RetentionConfiguration])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeRetentionConfigurationsResponse Source #

Create a value of DescribeRetentionConfigurationsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

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

$sel:retentionConfigurations:DescribeRetentionConfigurationsResponse', describeRetentionConfigurationsResponse_retentionConfigurations - Returns a retention configuration object.

$sel:httpStatus:DescribeRetentionConfigurationsResponse', describeRetentionConfigurationsResponse_httpStatus - The response's http status code.

Response Lenses

describeRetentionConfigurationsResponse_nextToken :: Lens' DescribeRetentionConfigurationsResponse (Maybe Text) Source #

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