AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb

Overview

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,
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filtersHash<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>>)


674
675
676
677
678
679
680
681
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 674

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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)


674
675
676
677
678
679
680
681
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 674

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


674
675
676
677
678
679
680
681
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 674

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end

#sort_ascendingBoolean

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

Returns:

  • (Boolean)


674
675
676
677
678
679
680
681
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 674

class DescribeBackupsRequest < Struct.new(
  :next_token,
  :max_results,
  :filters,
  :sort_ascending)
  SENSITIVE = []
  include Aws::Structure
end