Omics / Waiter / RunCompleted

RunCompleted

class Omics.Waiter.RunCompleted

waiter = client.get_waiter('run_completed')

wait(**kwargs)

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

See also: AWS API Documentation

Request Syntax

waiter.wait(
    id='string',
    export=[
        'DEFINITION',
    ],
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)

Parameters:

• id (string) –

  [REQUIRED]

  The run’s ID.

• export (list) –

  The run’s export format.

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

  • MaxAttempts (integer) –

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

Returns:

None