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

Inherits:

Object

• Object
• Aws::Glacier::Waiters::VaultNotExists

Defined in:

gems/aws-sdk-glacier/lib/aws-sdk-glacier/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ VaultNotExists constructor

  A new instance of VaultNotExists.

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

  Returns a response object which responds to the following methods:.

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)

# File 'gems/aws-sdk-glacier/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 Method Details

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

Returns a response object which responds to the following methods:

• #vault_arn => String
• #vault_name => String
• #creation_date => Time
• #last_inventory_date => Time
• #number_of_archives => Integer
• #size_in_bytes => Integer

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

• (Types::DescribeVaultOutput) —

  Returns a response object which responds to the following methods:

  • #vault_arn => String
  • #vault_name => String
  • #creation_date => Time
  • #last_inventory_date => Time
  • #number_of_archives => Integer
  • #size_in_bytes => Integer

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

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