Class: Aws::ARCRegionswitch::Waiters::PlanExecutionCompleted

Inherits:

Object

• Object
• Aws::ARCRegionswitch::Waiters::PlanExecutionCompleted

Defined in:

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

Instance Method Summary

• #initialize(options) ⇒ PlanExecutionCompleted constructor

  A new instance of PlanExecutionCompleted.

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

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

Constructor Details

#initialize(options) ⇒ PlanExecutionCompleted

Returns a new instance of PlanExecutionCompleted.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/waiters.rb', line 135

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_execution,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "execution_state",
          "state" => "success",
          "expected" => "completed"
        },
        {
          "matcher" => "path",
          "argument" => "execution_state",
          "state" => "success",
          "expected" => "completedWithExceptions"
        },
        {
          "matcher" => "path",
          "argument" => "execution_state",
          "state" => "failure",
          "expected" => "failed"
        },
        {
          "matcher" => "path",
          "argument" => "execution_state",
          "state" => "failure",
          "expected" => "canceled"
        },
        {
          "matcher" => "path",
          "argument" => "execution_state",
          "state" => "failure",
          "expected" => "planExecutionTimedOut"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #plan_arn => String
• #execution_id => String
• #version => String
• #updated_at => Time
• #comment => String
• #start_time => Time
• #end_time => Time
• #mode => String
• #execution_state => String
• #execution_action => String
• #execution_region => String
• #step_states => Array<Types::StepState>
• #plan => Types::Plan
• #actual_recovery_time => String
• #next_token => String

Parameters:

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

  a customizable set of options

Options Hash (params):

• :plan_arn (required, String) —

  The Amazon Resource Name (ARN) of the plan with the execution to retrieve.

• :execution_id (required, String) —

  The execution identifier of a plan execution.

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

• (Types::GetPlanExecutionResponse) —

  Returns a response object which responds to the following methods:

  • #plan_arn => String
  • #execution_id => String
  • #version => String
  • #updated_at => Time
  • #comment => String
  • #start_time => Time
  • #end_time => Time
  • #mode => String
  • #execution_state => String
  • #execution_action => String
  • #execution_region => String
  • #step_states => Array<Types::StepState>
  • #plan => Types::Plan
  • #actual_recovery_time => String
  • #next_token => String

# File 'gems/aws-sdk-arcregionswitch/lib/aws-sdk-arcregionswitch/waiters.rb', line 180

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