Omics / Waiter / TaskCompleted

TaskCompleted

class Omics.Waiter.TaskCompleted

waiter = client.get_waiter('task_completed')

wait(**kwargs)

Polls Omics.Client.get_run_task() every 30 seconds until a successful state is reached. An error is returned after 20 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    id='string',
    taskId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• id (string) –

  [REQUIRED]

  The workflow run ID.

• taskId (string) –

  [REQUIRED]

  The task’s ID.

• WaiterConfig (dict) –

  A dictionary that provides parameters to control waiting behavior.

  • Delay (integer) –

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

  • MaxAttempts (integer) –

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

Returns:

None