

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 実行情報を取得する
<a name="getinfo-about-runs"></a>

実行を開始したら、HealthOmics API を使用してステータス、設定、タスクレベルの詳細を取得できます。このページでは、次の方法について説明します。

**Topics**
+ [実行ステータスと詳細を取得する](#get-run)
+ [すべての実行を一覧表示する](#list-runs)
+ [実行のタスクを一覧表示する](#list-tasks)
+ [タスクの詳細を取得する](#get-task)
+ [CloudWatch でメタデータを実行する](#run-metadata)

## 実行ステータスと詳細を取得する
<a name="get-run"></a>

**GetRun** API オペレーションを使用して、特定の実行のステータスを確認し、詳細を取得します。実行の開始時に返される実行 ID が必要です。

```
aws omics get-run --id {{run_id}}
```

**実行 ID の検索**  
実行 ID は、次の方法で確認できます。  
[**StartRun** API レスポンス](starting-a-run.md#start-run-api-basic)から – 実行を開始すると、 `id`フィールドが返されます。
HealthOmics コンソールから – **Runs** ページで、実行リストの最初の列に実行 ID が表示されます。
**ListRuns** API から – アカウント内のすべての実行を IDs。

レスポンスには、実行ステータス、ワークフローの詳細、アクセラレーター情報、タイムスタンプが含まれます。考えられる実行ステータスは次のとおりです。


| ステータス | 説明 | 
| --- | --- | 
| PENDING | 実行が送信され、開始を待っています。 | 
| STARTING | HealthOmics は実行用のリソースをプロビジョニングしています。 | 
| RUNNING | 実行はタスクをアクティブに実行しています。 | 
| COMPLETED | 実行は正常に終了しました。出力ファイルは Amazon S3 の出力場所にあります。 | 
| FAILED | 実行でエラーが発生しました。「[実行失敗の理由](workflows-run-errors.md)」を参照してください。 | 
| CANCELLED | 実行はユーザーによってキャンセルされました。 | 

実行が の場合`COMPLETED`、Amazon S3 出力バケットの出力ファイルは、実行 ID の後に という名前のフォルダにあります。

### レスポンスの例
<a name="get-run-example-response"></a>

次の例は、GPU アクセラレーターを使用したプライベート WDL ワークフローの実行が完了した場合のレスポンスを示しています。

```
{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/7830534",
    "id": "7830534",
    "uuid": "96c57683-74bf-9d6d-ae7e-f09b097db14a",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "status": "COMPLETED",
    "workflowId": "4074992",
    "workflowType": "PRIVATE",
    "workflowVersionName": "3.0.0",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "RunGroupMaxGpuTest",
    "runGroupId": "9938959",
    "digest": "sha256:a23a6fc54040d36784206234c02147302ab8658bed89860a...",
    "accelerators": "GPU",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/Admin/role_name",
    "creationTime": "2023-04-07T16:44:22.262471+00:00",
    "startTime": "2023-04-07T16:56:12.504000+00:00",
    "stopTime": "2023-04-07T17:22:29.908813+00:00",
    "tags": {}
}
```

### レスポンスのキーフィールド
<a name="get-run-key-fields"></a>


| フィールド | 説明 | 
| --- | --- | 
| uuid | 実行の汎用一意識別子。とともにoutputUri、 を使用して出力データが書き込まれる場所を追跡できます。 | 
| status | 現在の実行ステータス (前の表を参照）。 | 
| workflowType | ワークフローが PRIVATEか かREADY2RUN。 | 
| accelerators | 該当する場合は、使用されるアクセラレータータイプ (例: GPU)。 | 
| digest | ワークフロー定義の SHA-256 ダイジェスト。 | 
| creationTime | 実行が送信された日時。 | 
| startTime | 実行が開始されたとき。 | 
| stopTime | 実行が終了したとき、またはキャンセルされたとき。 | 
| engineSettings | 実行に適用されるエンジン設定。このフィールドは、Nextflow ワークフローに対してのみ返されます。WDL または CWL ワークフローのエンジン設定を指定すると、それらはサイレントに無視され、このフィールドはGetRunレスポンスに存在しません。「[Nextflow エンジン設定の指定](starting-a-run.md#start-run-api-engine-settings)」を参照してください。 | 

### エンジン設定を使用した Nextflow 実行のレスポンスの例
<a name="get-run-engine-settings-example"></a>

エンジン設定で開始された Nextflow 実行の場合、**GetRun**レスポンスには実行に適用された値を反映する`engineSettings`マップが含まれます。次の例は、ピン留めされたエンジンバージョンと 2 つのプロファイルで開始された実行を示しています。

```
{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/9876543",
    "id": "9876543",
    "uuid": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "status": "COMPLETED",
    "workflowId": "1122334",
    "workflowType": "PRIVATE",
    "workflowVersionName": "1.2.1",
    "roleArn": "arn:aws:iam::123456789012:role/OmicsRole",
    "name": "nextflow-rnaseq-run",
    "outputUri": "s3://amzn-s3-demo-bucket/output",
    "engineSettings": {
        "engineVersion": "26.04",
        "profile": "test,docker"
    },
    "creationTime": "2024-09-10T16:44:22.262471+00:00",
    "startTime": "2024-09-10T16:56:12.504000+00:00",
    "stopTime": "2024-09-10T17:22:29.908813+00:00",
    "tags": {}
}
```

`engineSettings` フィールドは Nextflow ワークフローに対してのみ返されます。WDL および CWL ワークフローの場合、このフィールドはレスポンスに存在しません。詳細については、「[Nextflow エンジン設定の指定](starting-a-run.md#start-run-api-engine-settings)」を参照してください。

## すべての実行を一覧表示する
<a name="list-runs"></a>

**ListRuns** API オペレーションを使用して、アカウント内のすべての実行を表示します。

```
aws omics list-runs
```

レスポンスは、実行 ID、名前、ステータス、タイムスタンプなどの概要情報を含む実行のページ分割されたリストを返します。`--starting-token` パラメータを使用して、追加のページを取得します。

## 実行のタスクを一覧表示する
<a name="list-tasks"></a>

**ListRunTasks** API オペレーションを使用して、特定の実行内で完了したすべてのタスクを表示します。

```
aws omics list-run-tasks --id {{run_id}}
```

レスポンスは、ステータス、リソース割り当て、タイミング情報を含むタスクのリストを返します。

## タスクの詳細を取得する
<a name="get-task"></a>

**GetRunTask** API オペレーションを使用して、実行内の特定のタスクに関する詳細情報を取得します。

```
aws omics get-run-task --id {{run_id}} --task-id {{task_id}}
```

レスポンスには、CPU、メモリ割り当て、コンテナイメージ、タスクステータスなどのタスクレベルの詳細が含まれます。

## CloudWatch でメタデータを実行する
<a name="run-metadata"></a>

実行が完了すると、HealthOmics は実行メタデータをストリームの CloudWatch Logs に送信します。

```
manifest/run/{{run_id}}/{{run_uuid}}
```

マニフェストには、完全な実行設定、入力パラメータ、リソースダイジェスト、タスクレベルの詳細が含まれます。マニフェストの例を次に示します。

```
[
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "creationTime": "2022-08-24T19:53:55.284Z",
    "resourceDigests": {
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict": "etag:3884c62eb0e53fa92459ed9bff133ae6",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta": "etag:e307d81c605fb91b7720a08f00276842-388",
      "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai": "etag:f76371b113734a56cde236bc0372de0a",
      "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals": "etag:27fdd1341246896721ec49a46a575334",
      "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt": "etag:e22f5aeed0b350a66696d8ffae453227"
    },
    "digest": "sha256:a5baaff84dd54085eb03f78766b0a367e93439486bc3f67de42bb38b93304964",
    "engine": "WDL",
    "main": "gatk4-basic-joint-genotyping-v2.wdl",
    "name": "1044-gvcfs",
    "outputUri": "s3://omics-data/workflow-output",
    "parameters": {
      "callset_name": "cohort",
      "input_gvcf_uris": "s3://omics-data/workflow-input-lists/dragen-gvcf-list.txt",
      "interval_list": "s3://omics-data/intervals/hg38-mjs-whole-chr.500M.intervals",
      "ref_dict": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.dict",
      "ref_fasta": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta",
      "ref_fasta_index": "s3://omics-data/broad-references/hg38/v0/Homo_sapiens_assembly38.fasta.fai"
    },
    "roleArn": "arn:aws:iam::123456789012:role/OmicsServiceRole",
    "startedBy": "arn:aws:sts::123456789012:assumed-role/admin/ahenroid-Isengard",
    "startTime": "2022-08-24T20:08:22.582Z",
    "status": "COMPLETED",
    "stopTime": "2022-08-24T20:08:22.582Z",
    "storageCapacity": 9600,
    "uuid": "a3b0ca7e-9597-4ecc-94a4-6ed45481aeab",
    "workflow": "arn:aws:omics:us-east-1:123456789012:workflow/1558364",
    "workflowType": "PRIVATE"
  },
  {
    "arn": "arn:aws:omics:us-east-1:123456789012:task/1245938",
    "cpus": 16,
    "creationTime": "2022-08-24T20:06:32.971290",
    "image": "123456789012.dkr.ecr.us-west-2.amazonaws.com/gatk",
    "imageDigest": "sha256:8051adab0ff725e7e9c2af5997680346f3c3799b2df3785dd51d4abdd3da747b",
    "memory": 32,
    "name": "geno-123",
    "run": "arn:aws:omics:us-east-1:123456789012:run/1695324",
    "startTime": "2022-08-24T20:08:22.278Z",
    "status": "SUCCESS",
    "stopTime": "2022-08-24T20:08:22.278Z",
    "uuid": "44c1a30a-4eee-426d-88ea-1af403858f76"
  },
  ...
]
```

CloudWatch for HealthOmics の実行で使用できるログの詳細については、「」を参照してください[CloudWatch Logs による HealthOmics のモニタリング](monitoring-cloudwatch-logs.md)。

**注記**  
HealthOmics から実行を削除しても、実行メタデータは CloudWatch Logs から削除されません。 HealthOmics CloudWatch を使用して、HealthOmics API で利用できなくなった実行のメタデータにアクセスできます。