Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . omics ]

get-run¶

Description¶

Gets information about a workflow run.

If a workflow is shared with you, you cannot export information about the run.

HealthOmics stores a fixed number of runs that are available to the console and API. If GetRun doesn't return the requested run, you can find run logs for all runs in the CloudWatch logs. For more information about viewing the run logs, see CloudWatch logs in the AWS HealthOmics User Guide .

Synopsis¶

  get-run
--id <value>
[--export <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--id (string)

The run's ID.

--export (list)

The run's export format.

(string)

Syntax:

"string" "string" ...

Where valid values are:
  DEFINITION

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view a workflow run

The following get-run example gets details about a workflow run.

aws omics get-run \
    --id 1234567

Output:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
    "creationTime": "2022-11-30T22:58:22.615865Z",
    "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf",
    "id": "1234567",
    "name": "cram-to-bam",
    "outputUri": "s3://omics-artifacts-01d6xmpl4e72dd32/workflow-output/",
    "parameters": {
        "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict",
        "ref_fasta_index": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai",
        "ref_fasta": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta",
        "sample_name": "NA12878",
        "input_cram": "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram"
    },
    "resourceDigests": {
        "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai": "etag:f76371b113734a56cde236bc0372de0a",
        "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict": "etag:3884c62eb0e53fa92459ed9bff133ae6",
        "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta": "etag:e307d81c605fb91b7720a08f00276842-388",
        "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram": "etag:a9f52976381286c6143b5cc681671ec6"
    },
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "startedBy": "arn:aws:iam::123456789012:user/laptop-2020",
    "status": "STARTING",
    "tags": {},
    "workflowId": "1234567",
    "workflowType": "PRIVATE"
}

For more information, see Omics Workflows in the Amazon Omics Developer Guide.

Output¶

arn -> (string)

The run's ARN.

id -> (string)

The run's ID.

cacheId -> (string)

The run cache associated with the run.

cacheBehavior -> (string)

The run cache behavior for the run.

engineVersion -> (string)

The workflow engine version.

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 gibibytes. For dynamic storage, after the run has completed, this value is the maximum amount of storage used during the run.

outputUri -> (string)

The run's output URI.

logLevel -> (string)

The run's log level.

resourceDigests -> (map)

The run's resource digests.

key -> (string)

value -> (string)

startedBy -> (string)

Who started the run.

creationTime -> (timestamp)

When the run was created.

startTime -> (timestamp)

When the run started.

stopTime -> (timestamp)

The run's stop time.

statusMessage -> (string)

The run's status message.

tags -> (map)

The run's tags.

key -> (string)

value -> (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 -> (structure)

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.

uuid -> (string)

The universally unique identifier for a run.

runOutputUri -> (string)

The destination for workflow outputs.

storageType -> (string)

The run's storage type.

workflowOwnerId -> (string)

The ID of the workflow owner.

Table Of Contents

Feedback

User Guide

Note:

get-run¶

Description¶

Synopsis¶

Options¶

Global Options¶

Examples¶

Note

Output¶