Class: Aws::DynamoDB::Waiters::BulkOperationCompleted

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

Overview

Wait until a bulk operation is completed.

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ BulkOperationCompleted

Returns a new instance of BulkOperationCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/waiters.rb', line 91

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 20,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_bulk_operation,
      acceptors: [
        {
          "expected" => "COMPLETED",
          "matcher" => "path",
          "state" => "success",
          "argument" => "bulk_operation_description.bulk_operation_status"
        },
        {
          "expected" => "COMPLETED_WITH_ERRORS",
          "matcher" => "path",
          "state" => "success",
          "argument" => "bulk_operation_description.bulk_operation_status"
        },
        {
          "expected" => "CANCELLED",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bulk_operation_description.bulk_operation_status"
        },
        {
          "expected" => "FAILED",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "bulk_operation_description.bulk_operation_status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :bulk_operation_arn (required, String) —

    The Amazon Resource Name (ARN) of the bulk operation to describe.

Returns:



130
131
132
 
# File 'gems/aws-sdk-dynamodb/lib/aws-sdk-dynamodb/waiters.rb', line 130

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