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

Class: Aws::ECS::Waiters::TasksStopped

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ TasksStopped

Returns a new instance of TasksStopped

Parameters:

  • options (Hash)

Options Hash (options):

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


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 171

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 100,
    delay: 6,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_tasks,
      acceptors: [{
        "expected" => "STOPPED",
        "matcher" => "pathAll",
        "state" => "success",
        "argument" => "tasks[].last_status"
      }]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :cluster (String)

    The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to describe. If you do not specify a cluster, the default cluster is assumed.

  • :tasks (required, Array<String>)

    A list of up to 100 task IDs or full Amazon Resource Name (ARN) entries.

Returns:



190
191
192
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 190

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