Omics / Waiter / WorkflowVersionActive

WorkflowVersionActive

class Omics.Waiter.WorkflowVersionActive
waiter = client.get_waiter('workflow_version_active')
wait(**kwargs)

Polls Omics.Client.get_workflow_version() 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(
    workflowId='string',
    versionName='string',
    type='PRIVATE'|'READY2RUN',
    export=[
        'DEFINITION'|'README',
    ],
    workflowOwnerId='string',
    WaiterConfig={
        'Delay': 123,
        'MaxAttempts': 123
    }
)
Parameters:

  • workflowId (string) –

    [REQUIRED]

    The workflow’s ID. The workflowId is not the UUID.

  • versionName (string) –

    [REQUIRED]

    The workflow version name.

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

  • export (list) –

    The export format for the workflow.

    • (string) –

  • workflowOwnerId (string) – The 12-digit account ID of the workflow owner. The workflow owner ID can be retrieved using the GetShare API operation. If you are the workflow owner, you do not need to include this 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: 3

    • MaxAttempts (integer) –

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

Returns:

None