Omics / Client / list_workflow_versions

list_workflow_versions

Omics.Client.list_workflow_versions(**kwargs)

Lists the workflow versions for the specified workflow. 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.list_workflow_versions(
    workflowId='string',
    type='PRIVATE'|'READY2RUN',
    workflowOwnerId='string',
    startingToken='string',
    maxResults=123
)
Parameters:

  • workflowId (string) –

    [REQUIRED]

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

  • type (string) – The workflow type.

  • 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.

  • startingToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • maxResults (integer) – The maximum number of workflows to return in one page of results.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'workflowId': 'string',
            'versionName': 'string',
            'description': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
            'type': 'PRIVATE'|'READY2RUN',
            'digest': 'string',
            'creationTime': datetime(2015, 1, 1),
            'metadata': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • items (list) –

      A list of workflow version items.

      • (dict) –

        A list of workflow version items.

        • arn (string) –

          ARN of the workflow version.

        • workflowId (string) –

          The workflow’s ID.

        • versionName (string) –

          The name of the workflow version.

        • description (string) –

          The description of the workflow version.

        • status (string) –

          The status of the workflow version.

        • type (string) –

          The type of the workflow version.

        • digest (string) –

          The digist of the workflow version.

        • creationTime (datetime) –

          The creation time of the workflow version.

        • metadata (dict) –

          Metadata for the workflow version.

          • (string) –

            • (string) –

    • nextToken (string) –

      A pagination token that’s included if more results are available.

Exceptions