You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudHSMV2::Types::DescribeBackupsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeBackupsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  next_token: "NextToken",
  max_results: 1,
  filters: {
    "Field" => ["String"],
  },
  sort_ascending: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#filters ⇒ Hash<String,Array<String>>

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.

Returns:

  • (Hash<String,Array<String>>) —

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

#max_results ⇒ Integer

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.

Returns:

  • (Integer) —

    The maximum number of backups to return in the response.

#next_token ⇒ String

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

Returns:

  • (String) —

    The NextToken value that you received in the previous response.

#sort_ascending ⇒ Boolean

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

Returns:

  • (Boolean) —

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