Amazonka.CloudHSMV2.DescribeBackups

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.

Creating a Request

data DescribeBackups

See: newDescribeBackups smart constructor.

Constructors

DescribeBackups'

Fields

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

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

• nextToken :: Maybe Text

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

• sortAscending :: Maybe Bool

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

Instances

ToJSON DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

toJSON :: DescribeBackups -> Value

toEncoding :: DescribeBackups -> Encoding

toJSONList :: [DescribeBackups] -> Value

toEncodingList :: [DescribeBackups] -> Encoding

ToHeaders DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

toHeaders :: DescribeBackups -> [Header]

ToPath DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

toPath :: DescribeBackups -> ByteString

ToQuery DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

toQuery :: DescribeBackups -> QueryString

AWSPager DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

page :: DescribeBackups -> AWSResponse DescribeBackups -> Maybe DescribeBackups

AWSRequest DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type AWSResponse DescribeBackups

Methods

request :: (Service -> Service) -> DescribeBackups -> Request DescribeBackups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeBackups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeBackups)))

Generic DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type Rep DescribeBackups :: Type -> Type

Methods

from :: DescribeBackups -> Rep DescribeBackups x

to :: Rep DescribeBackups x -> DescribeBackups

Read DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

readsPrec :: Int -> ReadS DescribeBackups

readList :: ReadS [DescribeBackups]

readPrec :: ReadPrec DescribeBackups

readListPrec :: ReadPrec [DescribeBackups]

Show DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

showsPrec :: Int -> DescribeBackups -> ShowS

show :: DescribeBackups -> String

showList :: [DescribeBackups] -> ShowS

NFData DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

rnf :: DescribeBackups -> ()

Eq DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

(==) :: DescribeBackups -> DescribeBackups -> Bool

(/=) :: DescribeBackups -> DescribeBackups -> Bool

Hashable DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

hashWithSalt :: Int -> DescribeBackups -> Int

hash :: DescribeBackups -> Int

type AWSResponse DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

type AWSResponse DescribeBackups = DescribeBackupsResponse

type Rep DescribeBackups

Defined in Amazonka.CloudHSMV2.DescribeBackups

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

newDescribeBackups :: DescribeBackups

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

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

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

Request Lenses

describeBackups_filters :: Lens' DescribeBackups (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.

describeBackups_maxResults :: Lens' DescribeBackups (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.

describeBackups_nextToken :: Lens' DescribeBackups (Maybe Text)

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

describeBackups_sortAscending :: Lens' DescribeBackups (Maybe Bool)

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

Destructuring the Response

data DescribeBackupsResponse

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

Generic DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

Associated Types

type Rep DescribeBackupsResponse :: Type -> Type

Methods

from :: DescribeBackupsResponse -> Rep DescribeBackupsResponse x

to :: Rep DescribeBackupsResponse x -> DescribeBackupsResponse

Read DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

readsPrec :: Int -> ReadS DescribeBackupsResponse

readList :: ReadS [DescribeBackupsResponse]

readPrec :: ReadPrec DescribeBackupsResponse

readListPrec :: ReadPrec [DescribeBackupsResponse]

Show DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

showsPrec :: Int -> DescribeBackupsResponse -> ShowS

show :: DescribeBackupsResponse -> String

showList :: [DescribeBackupsResponse] -> ShowS

NFData DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

rnf :: DescribeBackupsResponse -> ()

Eq DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

Methods

(==) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool

(/=) :: DescribeBackupsResponse -> DescribeBackupsResponse -> Bool

type Rep DescribeBackupsResponse

Defined in Amazonka.CloudHSMV2.DescribeBackups

type Rep DescribeBackupsResponse = D1 ('MetaData "DescribeBackupsResponse" "Amazonka.CloudHSMV2.DescribeBackups" "amazonka-cloudhsmv2-2.0-JPONnjzt63Q1wP3HCntyXZ" '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

Arguments

:: Int

$sel:httpStatus:DescribeBackupsResponse'

-> DescribeBackupsResponse

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.

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_backups :: Lens' DescribeBackupsResponse (Maybe [Backup])

A list of backups.

describeBackupsResponse_nextToken :: Lens' DescribeBackupsResponse (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.

describeBackupsResponse_httpStatus :: Lens' DescribeBackupsResponse Int

The response's http status code.