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

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


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'gems/aws-sdk-ecs/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 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. 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 are not included in the response.

Returns:



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

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