list_workflows

Omics.Client.list_workflows(**kwargs)

Retrieves a list of workflows.

See also: AWS API Documentation

Request Syntax

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

Parameters

• maxResults (integer) -- The maximum number of workflows to return in one page of results.
• name (string) -- The workflows' name.
• startingToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.
• type (string) -- The workflows' type.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'digest': 'string',
            'id': 'string',
            'name': 'string',
            'status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETED'|'FAILED'|'INACTIVE',
            'type': 'PRIVATE'|'SERVICE'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    The workflows' items.

    • (dict) --

      A workflow.

      • arn (string) --

        The workflow's ARN.

      • creationTime (datetime) --

        When the workflow was created.

      • digest (string) --

        The workflow's digest.

      • id (string) --

        The workflow's ID.

      • name (string) --

        The workflow's name.

      • status (string) --

        The workflow's status.

      • type (string) --

        The workflow's type.

  • nextToken (string) --

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

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