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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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)


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/aws-sdk-ecs/waiters.rb', line 121

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

#waiterObject (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.



159
160
161
# File 'lib/aws-sdk-ecs/waiters.rb', line 159

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 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.

Returns:



154
155
156
# File 'lib/aws-sdk-ecs/waiters.rb', line 154

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