Class: Aws::ECS::Waiters::TasksRunning

Inherits:

Object

• Object
• Aws::ECS::Waiters::TasksRunning

Defined in:

lib/aws-sdk-ecs/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ TasksRunning constructor

  A new instance of TasksRunning.

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

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

Constructor Details

#initialize(options) ⇒ TasksRunning

Returns a new instance of TasksRunning.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-ecs/waiters.rb', line 187

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" => "pathAny",
          "state" => "failure",
          "argument" => "tasks[].last_status"
        },
        {
          "expected" => "MISSING",
          "matcher" => "pathAny",
          "state" => "failure",
          "argument" => "failures[].reason"
        },
        {
          "expected" => "RUNNING",
          "matcher" => "pathAll",
          "state" => "success",
          "argument" => "tasks[].last_status"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiter ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/aws-sdk-ecs/waiters.rb', line 225

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #tasks => Array<Types::Task>

• #failures => Array<Types::Failure>

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. This parameter is required if the task or tasks you are describing were launched in any cluster other than the default cluster.

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

• (Types::DescribeTasksResponse) —

  Returns a response object which responds to the following methods:

  • #tasks => Array&lt;Types::Task&gt;

  • #failures => Array&lt;Types::Failure&gt;

# File 'lib/aws-sdk-ecs/waiters.rb', line 220

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