Omics / Client / get_workflow_version

get_workflow_version

Omics.Client.get_workflow_version(**kwargs)

Gets information about a workflow version. For more information, see Workflow versioning in Amazon Web Services HealthOmics in the Amazon Web Services HealthOmics User Guide.

See also: AWS API Documentation

Request Syntax

response = client.get_workflow_version(
    workflowId='string',
    versionName='string',
    type='PRIVATE'|'READY2RUN',
    export=[
        'DEFINITION',
    ],
    workflowOwnerId='string'
)
Parameters:

  • workflowId (string) –

    [REQUIRED]

    The workflow’s ID.

  • versionName (string) –

    [REQUIRED]

    The workflow version name.

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

  • export (list) –

    The export format for the workflow.

    • (string) –

  • workflowOwnerId (string) – Amazon Web Services Id of the owner of the workflow.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • arn (string) –

      ARN of the workflow version.

    • workflowId (string) –

      The workflow’s ID.

    • versionName (string) –

      The workflow version name.

    • accelerators (string) –

      The accelerator for this workflow version.

    • creationTime (datetime) –

      When the workflow version was created.

    • description (string) –

      Description of the workflow version.

    • definition (string) –

      Definition of the workflow version.

    • digest (string) –

      The workflow version’s digest.

    • engine (string) –

      The workflow engine for this workflow version.

    • main (string) –

      The path of the main definition file for the workflow.

    • metadata (dict) –

      The metadata for the workflow version.

      • (string) –

        • (string) –

    • parameterTemplate (dict) –

      The parameter template for the workflow version.

      • (string) –

        • (dict) –

          A workflow parameter.

          • description (string) –

            The parameter’s description.

          • optional (boolean) –

            Whether the parameter is optional.

    • status (string) –

      The workflow version status

    • statusMessage (string) –

      The workflow version status message

    • storageType (string) –

      The default storage type for the run.

    • storageCapacity (integer) –

      The default run storage capacity for static storage.

    • type (string) –

      The workflow version type

    • tags (dict) –

      The workflow version tags

      • (string) –

        • (string) –

    • uuid (string) –

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

    • workflowBucketOwnerId (string) –

      Amazon Web Services Id of the owner of the bucket.

Exceptions