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

Class: Aws::DynamoDB::Waiters::TableExists

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ TableExists

Returns a new instance of TableExists

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 25
  • :delay (Integer) — default: 20
  • :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
43
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/waiters.rb', line 21

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 25,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_table,
      acceptors: [
        {
          "expected" => "ACTIVE",
          "matcher" => "path",
          "state" => "success",
          "argument" => "table.table_status"
        },
        {
          "expected" => "ResourceNotFoundException",
          "matcher" => "error",
          "state" => "retry"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

  • #table => Types::TableDescription

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :table_name (required, String)

    The name of the table to describe.

Returns:



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

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