Class: Aws::ARCRegionswitch::Waiters::PlanEvaluationStatusPassed

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ PlanEvaluationStatusPassed

Returns a new instance of PlanEvaluationStatusPassed.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 5
  • :delay (Integer) — default: 30
  • :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-arcregionswitch/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_plan_evaluation_status,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "evaluation_state",
          "state" => "success",
          "expected" => "passed"
        },
        {
          "matcher" => "path",
          "argument" => "evaluation_state",
          "state" => "failure",
          "expected" => "actionRequired"
        },
        {
          "matcher" => "path",
          "argument" => "evaluation_state",
          "state" => "retry",
          "expected" => "pendingEvaluation"
        }
      ]
    )
  }.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-arcregionswitch/waiters.rb', line 123

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :plan_arn (required, String) —

    The Amazon Resource Name (ARN) of the Region switch plan to retrieve evaluation status for.

  • :max_results (Integer) —

    The number of objects that you want to return with this call.

  • :next_token (String) —

    Specifies that you want to receive the next page of results. Valid only if you received a ‘nextToken` response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call’s ‘nextToken` response to request the next page of results.

Returns:



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

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