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

Class: Aws::Glacier::Waiters::VaultExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ VaultExists

Returns a new instance of VaultExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 15
  • :delay (Integer) — default: 3
  • :before_attempt (Proc)
  • :before_wait (Proc)


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 15,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_vault,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "status",
          "expected" => 200
        },
        {
          "state" => "retry",
          "matcher" => "error",
          "expected" => "ResourceNotFoundException"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeVaultOutput

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {})

    a customizable set of options

Options Hash (params):

  • :account_id (required, String)

    The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens ('-') in the ID.

  • :vault_name (required, String)

    The name of the vault.

Returns:



46
47
48
# File 'gems/aws-sdk-glacier/lib/aws-sdk-glacier/waiters.rb', line 46

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end