list_runs

Omics.Client.list_runs(**kwargs)

Retrieves a list of runs.

See also: AWS API Documentation

Request Syntax

response = client.list_runs(
    maxResults=123,
    name='string',
    runGroupId='string',
    startingToken='string'
)

Parameters

• maxResults (integer) -- The maximum number of runs to return in one page of results.
• name (string) -- Filter the list by run name.
• runGroupId (string) -- Filter the list by run group ID.
• startingToken (string) -- Specify the pagination token from a previous request to retrieve the next page of results.

Return type

dict

Returns

Response Syntax

{
    'items': [
        {
            'arn': 'string',
            'creationTime': datetime(2015, 1, 1),
            'id': 'string',
            'name': 'string',
            'priority': 123,
            'startTime': datetime(2015, 1, 1),
            'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
            'stopTime': datetime(2015, 1, 1),
            'storageCapacity': 123,
            'workflowId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) --

  • items (list) --

    A list of runs.

    • (dict) --

      A workflow run.

      • arn (string) --

        The run's ARN.

      • creationTime (datetime) --

        When the run was created.

      • id (string) --

        The run's ID.

      • name (string) --

        The run's name.

      • priority (integer) --

        The run's priority.

      • startTime (datetime) --

        When the run started.

      • status (string) --

        The run's status.

      • stopTime (datetime) --

        When the run stopped.

      • storageCapacity (integer) --

        The run's storage capacity.

      • workflowId (string) --

        The run's workflow ID.

  • 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