ECS / Waiter / TasksStopped

TasksStopped#

class ECS.Waiter.TasksStopped#
waiter = client.get_waiter('tasks_stopped')
wait(**kwargs)#

Polls ECS.Client.describe_tasks() every 6 seconds until a successful state is reached. An error is returned after 100 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    cluster='string',
    tasks=[
        'string',
    ],
    include=[
        'TAGS',
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • 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 (list) –

    [REQUIRED]

    A list of up to 100 task IDs or full ARN entries.

    • (string) –

  • include (list) –

    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.

    • (string) –

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

      The amount of time in seconds to wait between attempts. Default: 6

    • MaxAttempts (integer) –

      The maximum number of attempts to be made. Default: 100

Returns:

None