Omics / Client / list_workflows

list_workflows#

Omics.Client.list_workflows(**kwargs)#

Retrieves a list of workflows.

See also: AWS API Documentation

Request Syntax

response = client.list_workflows(
    type='PRIVATE'|'READY2RUN',
    name='string',
    startingToken='string',
    maxResults=123
)
Parameters:

  • type (string) – Filter the list by workflow type.

  • name (string) – Filter the list by workflow name.

  • 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',
            'id': 'string',
            'name': '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 items.

      • (dict) –

        A workflow.

        • arn (string) –

          The workflow’s ARN.

        • id (string) –

          The workflow’s ID.

        • name (string) –

          The workflow’s name.

        • status (string) –

          The workflow’s status.

        • type (string) –

          The workflow’s type.

        • digest (string) –

          The workflow’s digest.

        • creationTime (datetime) –

          When the workflow was created.

        • metadata (dict) –

          Any metadata available for workflow. The information listed may vary depending on the workflow, and there may also be no metadata to return.

          • (string) –

            • (string) –

    • nextToken (string) –

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

Exceptions