Class: Aws::Glacier::Waiters::VaultNotExists

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ VaultNotExists

Returns a new instance of VaultNotExists.

Parameters:

  • options (Hash)

Options Hash (options):

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


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/aws-sdk-glacier/waiters.rb', line 127

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" => "retry",
          "matcher" => "status",
          "expected" => 200
        },
        {
          "state" => "success",
          "matcher" => "error",
          "expected" => "ResourceNotFoundException"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



157
158
159
 
# File 'lib/aws-sdk-glacier/waiters.rb', line 157

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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 S3 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:



152
153
154
 
# File 'lib/aws-sdk-glacier/waiters.rb', line 152

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