libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudHSMV2.DescribeBackups

Description

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeBackups Source #

See: newDescribeBackups smart constructor.

Constructors

DescribeBackups' 

Fields

  • sortAscending :: Maybe Bool

    Designates whether or not to sort the return backups by ascending chronological order of generation.

  • filters :: Maybe (HashMap Text [Text])

    One or more filters to limit the items returned in the response.

    Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

    Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

    Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

    Use the states filter to return only backups that match the specified state.

    Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

  • nextToken :: Maybe Text

    The NextToken value that you received in the previous response. Use this value to get more backups.

  • maxResults :: Maybe Natural

    The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Instances

Instances details
Eq DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Read DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Show DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Generic DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type Rep DescribeBackups :: Type -> Type #

NFData DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

rnf :: DescribeBackups -> () #

Hashable DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

ToJSON DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

AWSPager DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

AWSRequest DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type AWSResponse DescribeBackups #

ToHeaders DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

ToPath DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

ToQuery DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

type Rep DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

type Rep DescribeBackups = D1 ('MetaData "DescribeBackups" "Amazonka.CloudHSMV2.DescribeBackups" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DescribeBackups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "sortAscending") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))))
type AWSResponse DescribeBackups Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

newDescribeBackups :: DescribeBackups Source #

Create a value of DescribeBackups 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:

$sel:sortAscending:DescribeBackups', describeBackups_sortAscending - Designates whether or not to sort the return backups by ascending chronological order of generation.

$sel:filters:DescribeBackups', describeBackups_filters - One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

$sel:nextToken:DescribeBackups', describeBackups_nextToken - The NextToken value that you received in the previous response. Use this value to get more backups.

$sel:maxResults:DescribeBackups', describeBackups_maxResults - The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Request Lenses

describeBackups_sortAscending :: Lens' DescribeBackups (Maybe Bool) Source #

Designates whether or not to sort the return backups by ascending chronological order of generation.

describeBackups_filters :: Lens' DescribeBackups (Maybe (HashMap Text [Text])) Source #

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text) Source #

The NextToken value that you received in the previous response. Use this value to get more backups.

describeBackups_maxResults :: Lens' DescribeBackups (Maybe Natural) Source #

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

Destructuring the Response

data DescribeBackupsResponse Source #

See: newDescribeBackupsResponse smart constructor.

Constructors

DescribeBackupsResponse' 

Fields

  • backups :: Maybe [Backup]

    A list of backups.

  • nextToken :: Maybe Text

    An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Read DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Show DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Generic DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type Rep DescribeBackupsResponse :: Type -> Type #

NFData DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

rnf :: DescribeBackupsResponse -> () #

type Rep DescribeBackupsResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.DescribeBackups

type Rep DescribeBackupsResponse = D1 ('MetaData "DescribeBackupsResponse" "Amazonka.CloudHSMV2.DescribeBackups" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "DescribeBackupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Backup])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeBackupsResponse Source #

Create a value of DescribeBackupsResponse 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:

$sel:backups:DescribeBackupsResponse', describeBackupsResponse_backups - A list of backups.

$sel:nextToken:DescribeBackups', describeBackupsResponse_nextToken - An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.

$sel:httpStatus:DescribeBackupsResponse', describeBackupsResponse_httpStatus - The response's http status code.

Response Lenses

describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (Maybe Text) Source #

An opaque string that indicates that the response contains only a subset of backups. Use this value in a subsequent DescribeBackups request to get more backups.