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) 


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 478

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: [{
        "matcher" => "pathAll",
        "argument" => "tasks[].last_status",
        "state" => "success",
        "expected" => "STOPPED"
      }]
    )
  }.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 or tasks 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 ARN entries.

  • :include (Array<String>) —

    Specifies whether you want to see the resource tags for the task. If TAGS is specified, the tags are included in the response. If this field is omitted, tags aren't included in the response.

Returns:



497
498
499
 
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/waiters.rb', line 497

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