Omics / Client / get_workflow

get_workflow

Omics.Client.get_workflow(**kwargs)

Gets information about a workflow.

If a workflow is shared with you, you cannot export the workflow.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow(
    id='string',
    type='PRIVATE'|'READY2RUN',
    export=[
        'DEFINITION',
    ],
    workflowOwnerId='string'
)

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.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
    'type': 'PRIVATE'|'READY2RUN',
    'name': 'string',
    'description': 'string',
    'engine': 'WDL'|'NEXTFLOW'|'CWL',
    'definition': 'string',
    'main': 'string',
    'digest': 'string',
    'parameterTemplate': {
        'string': {
            'description': 'string',
            'optional': True|False
        }
    },
    'storageCapacity': 123,
    'creationTime': datetime(2015, 1, 1),
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    },
    'metadata': {
        'string': 'string'
    },
    'accelerators': 'GPU',
    'storageType': 'STATIC'|'DYNAMIC',
    'uuid': 'string'
}

Response Structure

• (dict) –

  • arn (string) –

    The workflow’s ARN.

  • id (string) –

    The workflow’s ID.

  • status (string) –

    The workflow’s status.

  • type (string) –

    The workflow’s type.

  • name (string) –

    The workflow’s name.

  • description (string) –

    The workflow’s description.

  • engine (string) –

    The workflow’s engine.

  • definition (string) –

    The workflow’s definition.

  • main (string) –

    The path of the main definition file for the workflow.

  • digest (string) –

    The workflow’s digest.

  • parameterTemplate (dict) –

    The workflow’s parameter template.

    • (string) –

      • (dict) –

        A workflow parameter.

        • description (string) –

          The parameter’s description.

        • optional (boolean) –

          Whether the parameter is optional.

  • storageCapacity (integer) –

    The default static storage capacity (in gibibytes) for runs that use this workflow or workflow version.

  • creationTime (datetime) –

    When the workflow was created.

  • statusMessage (string) –

    The workflow’s status message.

  • tags (dict) –

    The workflow’s tags.

    • (string) –

      • (string) –

  • metadata (dict) –

    Gets metadata for the workflow.

    • (string) –

      • (string) –

  • accelerators (string) –

    The computational accelerator specified to run the workflow.

  • storageType (string) –

    The default storage type for runs using this workflow.

  • uuid (string) –

    The universally unique identifier (UUID) value for this workflow.

Exceptions

• Omics.Client.exceptions.InternalServerException

• Omics.Client.exceptions.ServiceQuotaExceededException

• Omics.Client.exceptions.ThrottlingException

• Omics.Client.exceptions.ValidationException

• Omics.Client.exceptions.ConflictException

• Omics.Client.exceptions.ResourceNotFoundException

• Omics.Client.exceptions.AccessDeniedException

• Omics.Client.exceptions.RequestTimeoutException