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.

Returns:

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


618
619
620
621
622
623
624
625
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 618

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)


618
619
620
621
622
623
624
625
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 618

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)


618
619
620
621
622
623
624
625
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 618

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)


618
619
620
621
622
623
624
625
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 618

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