class Aws::CloudHSMV2::Types::DescribeBackupsRequest
@note When making an API call, you may pass DescribeBackupsRequest
data as a hash: { next_token: "NextToken", max_results: 1, filters: { "Field" => ["String"], }, sort_ascending: false, }
@!attribute [rw] next_token
The `NextToken` value that you received in the previous response. Use this value to get more backups. @return [String]
@!attribute [rw] max_results
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. @return [Integer]
@!attribute [rw] 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. @return [Hash<String,Array<String>>]
@!attribute [rw] sort_ascending
Designates whether or not to sort the return backups by ascending chronological order of generation. @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsRequest AWS API Documentation
Constants
- SENSITIVE