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

Class: Aws::EC2::Waiters::ConversionTaskCancelled

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) ⇒ ConversionTaskCancelled

Returns a new instance of ConversionTaskCancelled

Parameters:

  • options (Hash)

Options Hash (options):

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


65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb', line 65

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" => "cancelled",
        "matcher" => "pathAll",
        "state" => "success",
        "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:



84
85
86
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/waiters.rb', line 84

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