Class: Aws::CloudControlApi::Waiters::ResourceRequestSuccess

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

Overview

Wait until resource operation request is successful

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ResourceRequestSuccess

Returns a new instance of ResourceRequestSuccess.

Parameters:

  • options (Hash)

Options Hash (options):

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


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/aws-sdk-cloudcontrolapi/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 24,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_resource_request_status,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "progress_event.operation_status",
          "state" => "success",
          "expected" => "SUCCESS"
        },
        {
          "matcher" => "path",
          "argument" => "progress_event.operation_status",
          "state" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "progress_event.operation_status",
          "state" => "failure",
          "expected" => "CANCEL_COMPLETE"
        }
      ]
    )
  }.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. 



123
124
125
 
# File 'lib/aws-sdk-cloudcontrolapi/waiters.rb', line 123

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :request_token (required, String) —

    A unique token used to track the progress of the resource operation request.

    Request tokens are included in the ‘ProgressEvent` type returned by a resource operation request.

Returns:



118
119
120
 
# File 'lib/aws-sdk-cloudcontrolapi/waiters.rb', line 118

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