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

Class: Aws::EC2::Waiters::ConversionTaskCompleted

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ConversionTaskCompleted

Returns a new instance of ConversionTaskCompleted

Parameters:

  • options (Hash)

Options Hash (options):

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


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
127
128
129
130
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb', line 101

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_conversion_tasks,
      acceptors: [
        {
          "expected" => "completed",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "conversion_tasks[].state"
        },
        {
          "expected" => "cancelled",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "conversion_tasks[].state"
        },
        {
          "expected" => "cancelling",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "conversion_tasks[].state"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :conversion_task_ids (Array<String>)

    One or more conversion task IDs.

  • :dry_run (Boolean)

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:



134
135
136
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb', line 134

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