Omics / Waiter / WorkflowActive

WorkflowActive#

class Omics.Waiter.WorkflowActive#
waiter = client.get_waiter('workflow_active')
wait(**kwargs)#

Polls Omics.Client.get_workflow() every 3 seconds until a successful state is reached. An error is raised after 10 failed checks.

See also: AWS API Documentation

Request Syntax

waiter.wait(
    id='string',
    type='PRIVATE'|'READY2RUN',
    export=[
        'DEFINITION',
    ],
    workflowOwnerId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • id (string) –

    [REQUIRED]

    The workflow’s ID.

  • type (string) – The workflow’s type.

  • export (list) –

    The export format for the workflow.

    • (string) –

  • workflowOwnerId (string) – The ID of the workflow owner.

  • WaiterConfig (dict) –

    A dictionary that provides parameters to control waiting behavior.

    • Delay (integer) –

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

    • MaxAttempts (integer) –

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

Returns:

None