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

Class: Aws::Glacier::Types::ListVaultsInput

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

Overview

Note:

When making an API call, you may pass ListVaultsInput data as a hash:

{
  account_id: "string", # required
  marker: "string",
  limit: 1,
}

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

Instance Attribute Summary collapse

Instance Attribute Details

#account_idString

The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. You can either specify an AWS account ID or optionally a single '-' (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you specify your account ID, do not include any hyphens ('-') in the ID.

Returns:

  • (String)


2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2135

class ListVaultsInput < Struct.new(
  :account_id,
  :marker,
  :limit)
  include Aws::Structure
end

#limitInteger

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Returns:

  • (Integer)


2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2135

class ListVaultsInput < Struct.new(
  :account_id,
  :marker,
  :limit)
  include Aws::Structure
end

#markerString

A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

Returns:

  • (String)


2135
2136
2137
2138
2139
2140
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/types.rb', line 2135

class ListVaultsInput < Struct.new(
  :account_id,
  :marker,
  :limit)
  include Aws::Structure
end