Omics / Client / get_run

get_run

Omics.Client.get_run(**kwargs)

Gets information about a workflow run.

See also: AWS API Documentation

Request Syntax

response = client.get_run(
    id='string',
    export=[
        'DEFINITION',
    ]
)

Parameters:

• id (string) –

  [REQUIRED]

  The run’s ID.

• export (list) –

  The run’s export format.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'id': 'string',
    'status': 'PENDING'|'STARTING'|'RUNNING'|'STOPPING'|'COMPLETED'|'DELETED'|'CANCELLED'|'FAILED',
    'workflowId': 'string',
    'workflowType': 'PRIVATE'|'READY2RUN',
    'runId': 'string',
    'roleArn': 'string',
    'name': 'string',
    'runGroupId': 'string',
    'priority': 123,
    'definition': 'string',
    'digest': 'string',
    'parameters': {...}|[...]|123|123.4|'string'|True|None,
    'storageCapacity': 123,
    'outputUri': 'string',
    'logLevel': 'OFF'|'FATAL'|'ERROR'|'ALL',
    'resourceDigests': {
        'string': 'string'
    },
    'startedBy': 'string',
    'creationTime': datetime(2015, 1, 1),
    'startTime': datetime(2015, 1, 1),
    'stopTime': datetime(2015, 1, 1),
    'statusMessage': 'string',
    'tags': {
        'string': 'string'
    },
    'accelerators': 'GPU',
    'retentionMode': 'RETAIN'|'REMOVE',
    'failureReason': 'string',
    'logLocation': {
        'engineLogStream': 'string',
        'runLogStream': 'string'
    }
}

Response Structure

• (dict) –

  • arn (string) –

    The run’s ARN.

  • id (string) –

    The run’s ID.

  • status (string) –

    The run’s status.

  • workflowId (string) –

    The run’s workflow ID.

  • workflowType (string) –

    The run’s workflow type.

  • runId (string) –

    The run’s ID.

  • roleArn (string) –

    The run’s service role ARN.

  • name (string) –

    The run’s name.

  • runGroupId (string) –

    The run’s group ID.

  • priority (integer) –

    The run’s priority.

  • definition (string) –

    The run’s definition.

  • digest (string) –

    The run’s digest.

  • parameters (document) –

    The run’s parameters.

  • storageCapacity (integer) –

    The run’s storage capacity in gigabytes.

  • outputUri (string) –

    The run’s output URI.

  • logLevel (string) –

    The run’s log level.

  • resourceDigests (dict) –

    The run’s resource digests.

    • (string) –

      • (string) –

  • startedBy (string) –

    Who started the run.

  • creationTime (datetime) –

    When the run was created.

  • startTime (datetime) –

    When the run started.

  • stopTime (datetime) –

    The run’s stop time.

  • statusMessage (string) –

    The run’s status message.

  • tags (dict) –

    The run’s tags.

    • (string) –

      • (string) –

  • accelerators (string) –

    The computational accelerator used to run the workflow.

  • retentionMode (string) –

    The run’s retention mode.

  • failureReason (string) –

    The reason a run has failed.

  • logLocation (dict) –

    The location of the run log.

    • engineLogStream (string) –

      The log stream ARN for the engine log.

    • runLogStream (string) –

      The log stream ARN for the run log.

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