View a markdown version of this page

HealthOmics で実行を開始する - AWS HealthOmics

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

HealthOmics で実行を開始する

実行を開始するときは、HealthOmics が実行に割り当てるリソースを指定します。次の設定を使用できます。

  1. 出力場所 – 実行からの出力ファイルが保存される Amazon S3 URI を指定します。大量のワークフローを同時に実行する場合は、バケットのスロットリングを避けるために、ワークフローごとに個別の Amazon S3 出力 URIs を使用します。詳細については、「Amazon S3 ユーザーガイド」の「プレフィックスを使用してオブジェクトを整理する」および「Amazon S3 パフォーマンスの最適化」ホワイトペーパーの「ストレージ接続を水平方向にスケールする」を参照してください。 Amazon S3 Amazon S3

  2. サービスロール – 実行に必要なリソースへのアクセス許可を HealthOmics に付与する IAM サービスロールを指定します。必要に応じて、 コンソールでサービスロールを作成できます。詳細については、「のサービスロール AWS HealthOmics」を参照してください。

  3. Run storage (オプション、デフォルトは Dynamic) – 実行ストレージタイプとストレージ量 (静的ストレージの場合) を指定します。データの分離とセキュリティを確保するために、HealthOmics は各実行の開始時にストレージをプロビジョニングし、実行の終了時にそれをプロビジョニング解除します。詳細については、「HealthOmics ワークフローでストレージタイプを実行する」を参照してください。

  4. 実行優先度 (オプション) – 実行に優先度を割り当てます。優先度が実行に与える影響は、実行が実行グループに関連付けられているかどうかによって異なります。詳細については、「実行優先度」を参照してください。

  5. ワークフローバージョン (オプション) – 実行の特定のワークフローバージョンを選択します。バージョンを指定しない場合、HealthOmics はデフォルトのワークフローバージョンを開始します。

  6. Nextflow エンジン設定 (オプション、Nextflow のみ) – ランタイム中の Nextflow ワークフローのバージョンや構文パーサーなどのエンジン設定を指定します。詳細については、「Nextflow エンジン設定の指定」を参照してください。

  7. 入力パラメータ (オプション) – ワークフロー入力パラメータを JSON ファイルまたはインライン値として指定します。必須パラメータは、ワークフローのパラメータテンプレートによって定義されます。詳細については、「HealthOmics 実行入力」を参照してください。

  8. リクエスト ID (オプション、API および CLI のみ) – 実行ごとに一意のリクエスト ID を指定します。リクエスト ID は、HealthOmics が重複するリクエストを識別し、実行を 1 回だけ開始するために使用するべき等性トークンです。

コンソールを使用した実行の開始

実行開始ウィザードには 4 つのステップがあります。

  1. 実行の詳細を指定する

  2. パラメータ値を追加する

  3. 実行グループ、実行キャッシュ、タグを追加する

  4. 実行を確認して開始する

実行を開始するには

  1. HealthOmics コンソールを開きます。

  2. 必要に応じて、左側のナビゲーションペイン (≡) を開きます。[実行] を選択します。

  3. Start run を選択します。

ステップ 1: 実行の詳細を指定する

次の設定を指定します。

# 設定 必要 説明
1 ワークフローソースを選択する 必須 所有ワークフロー (所有するプライベートワークフロー) または共有ワークフロー (共有ワークフロー) を選択します。
2 ワークフロー ID 必須 この実行のワークフロー ID を選択します。
3 実行名 必須 (API および CLI ではオプション) この実行のわかりやすい名前。最大 127 文字。ワークフローが実行されると、実行 ID が自動的に生成されます。
4 設定 オプションです。 インターネット接続用の VPC 設定 (サブネット、セキュリティグループ) を指定し、コンテナレジストリマッピングと Git リポジトリ接続を含める設定を選択します。実行の開始後は変更できません。
5 実行優先度 オプションです。 実行グループの実行の優先度を設定します。数値が大きいほど優先度が高くなります。整数のみ。範囲は 0~1,000 です。
6 ストレージタイプを実行する オプションです。 動的ストレージ (デフォルト、推奨) または静的ストレージを選択します。動的ストレージは、タスクごとにスケールアップおよびスケールダウンします。静的ストレージは固定量をプロビジョニングします。詳細については、「HealthOmics ワークフローでストレージタイプを実行する」を参照してください。
7 ストレージ容量の実行 条件付き 静的ストレージのみ。GiB で量を指定します。
8 S3 出力先を選択する 必須 実行出力が配信される Amazon S3 の場所。形式: s3://bucket/prefix/object
9 出力バケット所有者のアカウント ID オプションです。 アカウントが出力バケットを所有していない場合は、バケット所有者の AWS アカウント ID を入力します。
10 メタデータ保持モードの実行 オプションです。 実行メタデータを保持する (デフォルト) または最も古いメタデータを自動的に削除するを選択します。 RETAINがデフォルト値です。このモードではHealthOmics は実行メタデータを削除しません。詳細については、「HealthOmics 実行の保持モードの実行」を参照してください。
11 ネットワークアクセス オプションです。 制限付き (デフォルト) または仮想プライベートクラウド (VPC) を選択します。詳細については、「VPC ネットワーキング」を参照してください。
12 サービスロール 必須 既存のサービスロールを選択するか、新しいサービスロールを作成します。HealthOmics にはAmazon S3 および KMS のアクセス許可が必要です。詳細については、「のサービスロール AWS HealthOmics」を参照してください。

へ を選択してステップ 2 に進みます。

ステップ 2: パラメータ値を追加する

このページでは、実行のパラメータ値を入力するか、ワークフロー作成者が提供する事前定義された値を選択します。

Nextflow ワークフローを選択して実行を開始すると、このステップの上部に Nextflow エンジン設定Nextflow プロファイルの追加セクションが表示されます。これらの設定 (サポートされている値、動作、プロファイルの優先順位) の詳細については、「」を参照してくださいNextflow エンジン設定の指定

パラメータ値を実行する

実行パラメータを指定します。JSON ファイルをアップロードするか、値を手動で入力できます。JSON ファイルには、各入力パラメータの正確な名前と パラメータの値が含まれています。

HealthOmics は、パラメータ値に対して次の JSON タイプをサポートしています。

JSON タイプ キーと値の例 注意事項
boolean "b":true 値は引用符ではなく、すべて小文字です。
整数 「i」: 7 値は引用符で囲まれていません。
数値 「f」:42.3 値は引用符で囲まれていません。
string 「s"characters」 値は引用符で囲まれています。テキスト値と URIs。URI ターゲットは、予想される入力タイプである必要があります。
array 「a」:[1,2,3] 値は引用符で囲まれていません。配列メンバーには、それぞれ入力パラメータで定義された型が必要です。
オブジェクト "o":{"left"a"、"right":1} WDL では、オブジェクトは WDL ペア、マップ、または構造体にマッピングされます。

詳細については、「HealthOmics 実行入力」および「実行パラメータサイズの管理」を参照してください。

へ を選択してステップ 3 に進みます。

ステップ 3: 実行グループ、実行キャッシュ、タグを追加する

このページのすべての設定はオプションです。

# 設定 必要 説明
1 実行グループ オプションです。 既存の実行グループを選択するか、新しい実行グループを作成します。実行グループバンドルは、カテゴリと優先度ごとに実行され、最大 vCPUsと実行時間を設定します。詳細については、「HealthOmics 実行グループの使用」を参照してください。
2 キャッシュの実行 オプションです。 実行キャッシュを使用して、タスク結果を再計算するのではなく、完了したタスク結果を再利用します。詳細については、「コンソールを使用した実行キャッシュを使用した実行の設定」を参照してください。
3 タグ オプションです。 検索、フィルタリング、コスト追跡に最大 50 個のキーと値のタグを追加します。

へ を選択してステップ 4 に進みます。

ステップ 4: 実行を確認して開始する

前のすべてのステップの実行設定を確認します。設定を変更するには、関連するステップの横にある編集を選択します。準備ができたら、実行の開始を選択します。

API を使用して実行を開始する

StartRun API オペレーションを使用して、実行を作成して開始します。

基本的な実行を開始する

次の例では、ワークフロー ID、サービスロール、および出力 URI を指定します。この例では、保持モードを に設定しますREMOVE。保持モードの詳細については、「」を参照してくださいHealthOmics 実行の保持モードの実行

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --name "my-workflow-run" \ --retention-mode REMOVE

応答として、次の出力を取得します。uuid は実行に固有であり、 とともに出力データが書き込まれる場所を追跡するためにoutputUri使用できます。

{ "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567", "id": "123456789", "uuid": "96c57683-74bf-9d6d-ae7e-f09b097db14a", "outputUri": "s3://bucket/folder/8405154/96c57683-74bf-9d6d-ae7e-f09b097db14a", "status": "PENDING" }

一般的な API オプション

パラメータファイルを含める

ワークフローのパラメータテンプレートで必須パラメータが宣言されている場合は、ワークフロー実行の開始時に入力のローカル JSON ファイルを指定できます。JSON ファイルには、各入力パラメータの正確な名前と パラメータの値が含まれています。

start-run リクエスト--parameters file://<input_file.json>に を追加して AWS CLI 、 の入力 JSON ファイルを参照します。詳細については、ステップ 2: パラメータ値を追加する「」および「」のパラメータ値でサポートされている JSON タイプ」を参照してくださいHealthOmics 実行入力

リクエスト ID を指定する

実行requestIdごとに一意の を指定できます。リクエスト ID は、HealthOmics が重複するリクエストをキャッチするために使用するべき等性トークンです。リクエスト ID が前回の実行と重複している場合、実行は開始されません。

実行開始のオーケストレーションにインフラストラクチャ (Lambda 関数やステップ関数など) を使用する場合は、StartRun リクエストごとに一意のリクエスト ID を提供することがベストプラクティスです。これにより、インフラストラクチャがすでに開始した実行を誤って開始した場合、HealthOmics は重複した実行を開始しません。

aws omics start-run \ --workflow-id workflow id \ ... \ --request-id "unique-request-id-12345"

ワークフローバージョンを選択する

実行のワークフローバージョンを指定できます。バージョンを指定しない場合、HealthOmics はデフォルトのワークフローバージョンで実行を開始します。

aws omics start-run \ --workflow-id workflow id \ ... \ --workflow-version-name '1.2.1'

実行ストレージタイプを上書きする

ワークフローで設定されたデフォルトの実行ストレージタイプを上書きできます。

aws omics start-run \ --workflow-id workflow id \ ... \ --storage-type STATIC \ --storage-capacity 2400

エフェメラルストレージの有効化

実行のエフェメラルストレージを有効にするには、実行を開始するLOCALときに --scratch-storage-mode を に設定します。HealthOmics は、ワークフロータスクインスタンスごとに専用のローカルストレージボリュームを /tmp にマウントします。

aws omics start-run \ --workflow-id workflow-id \ --role-arn arn:aws:iam::123456789012:role/OmicsServiceRole \ --output-uri s3://amzn-s3-demo-bucket/output-folder/ \ --parameters file:///path/to/parameters.json \ --scratch-storage-mode LOCAL

特定の実行のエフェメラルストレージを無効にするには (たとえば、障害を分離するには)、 --scratch-storage-mode を に設定しますSHARED

詳細については、「HealthOmics ワークフロータスク用のエフェメラルストレージ」を参照してください。

Nextflow エンジン設定 (エンジンバージョン、プロファイル、構文パーサー) については、「」を参照してくださいNextflow エンジン設定の指定

Nextflow エンジン設定の指定

Nextflow ワークフローでは、ワークフローソースコードを変更せずに StartRun API リクエストにengineSettingsマップを渡してエンジンの動作を制御できます。コンソールでは、これらの設定はステップ 2: Nextflow ワークフローに表示される別のセクションとしてパラメータ値を追加するで使用できます。

注記

エンジン設定は Nextflow ワークフローにのみ適用されます。API または CLI で WDL または CWL ワークフローのエンジン設定を指定すると、それらはサイレントに無視され、GetRunレスポンスでは使用できません。

サポートされるキー

# キー 有効値 動作 バージョンのサポート
1 engineVersion "22.04.0" (または "22.04")、 "23.10.0" (または "23.10")、 "24.10.8" (または "24.10")、 "25.10.0" (または "25.10")、 "26.04.0" (または "26.04") 実行の Nextflow バージョンを固定します。から検出されたバージョンを上書きしますnextflow.config。フルバージョン形式とショートバージョン形式の両方を使用できます。 すべての Nextflow バージョン
2 syntaxVersion "v1" (レガシーパーサー)、 "v2" (厳密な構文パーサー) 構文パーサーを選択します。 v26.04 以降。以前のバージョンでは、 のみがサポートされています"v1"
3 outputFormat "json", "text", "none" エンジン stdout/stderr の概要形式を設定します。 v26.04 以降 (以前のバージョンでは無視)。
4 agentMode "true", "false" Nextflow エージェントモードを制御します。 v26.04 以降 (以前のバージョンでは無視)。
5 profile たとえば、カンマ区切りのプロファイル名 "test,docker" Nextflow プロファイルをアクティブ化します。詳細については、「Nextflow プロファイル」を参照してください。 すべての Nextflow バージョン

Nextflow エンジンバージョンのピン留め

特定の Nextflow エンジンバージョンを選択してワークフローを実行し、エンジンバージョン間で制御された移行を有効にできます。ランタイムバージョンオーバーライドにより、ワークフロー定義が設定またはプロファイルを通じてバージョンを指定しても、実行時に指定したエンジンバージョンが優先されます。これにより、ワークフローソースコードを変更せずに、複数のエンジンバージョンで同じワークフローをテストできます。

サポートされているバージョン: 22.04.0 (または 22.04)、23.10.0 (または 23.10)、24.10.8 (または 24.10)、25.10.0 (または 25.10)、および 26.04.0 (または 26.04)。フルバージョン形式とショートバージョン形式の両方を使用できます。

API と CLI

engineVersionキーを使用します--engine-settings

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --engine-settings '{"engineVersion":"26.04"}'

コンソール

ステップ 2: パラメータ値を追加する、Nextflow エンジン設定セクションのエンジンバージョンドロップダウンからバージョンを選択します。

Nextflow プロファイル

Nextflow プロファイルは、ワークフローの で定義された実行設定の名前付きセットですnextflow.config。実行時に 1 つ以上のプロファイルをアクティブ化して、ワークフローソースコードを変更せずに環境固有の設定 (開発、テスト、本番稼働など) を適用できます。

API と CLI

profileキーを使用します--engine-settings。複数のプロファイルをカンマ区切りリストとして指定します。

aws omics start-run \ --workflow-id workflow id \ --role-arn arn:aws:iam::123456789012:role/OmicsRole \ --output-uri s3://amzn-s3-demo-bucket/output \ --engine-settings '{"profile":"test,docker"}'

コンソール

ではステップ 2: パラメータ値を追加するNextflow プロファイルセクションがエンジン設定の下に表示されます。プロファイルの選択ドロップダウンから 1 つ以上のプロファイルを選択します。コンソールにプロファイルアプリケーションの順序が表示されます。プロファイルを削除するには、名前の横にある × を選択します。

プロファイルアプリケーションの順序

複数のプロファイルを指定する場合、アプリケーションの順序は Nextflow エンジンのバージョンと構文パーサーによって異なります。

  • Nextflow v26.04 以降と厳密な構文パーサー (v2) – プロファイルは、profile値 (左から右) で指定された順序で、またはコンソールの選択順序で適用されます。後のプロファイルは、競合する設定の以前のプロファイルを上書きします。

  • レガシーパーサー (v1) を使用する v26.04 および v26.04 以前の Nextflow バージョン – API リクエストまたはコンソールの選択で指定された順序に関係なく、プロファイルは nextflow.config ファイルで定義された順序で適用されます。

設定の優先順位

Nextflow は、次の順序でパラメータを解決し、後のレイヤーが以前のレイヤーを上書きします。

  1. nextflow.config デフォルト

  2. 選択した Nextflow プロファイル

  3. 事前定義された値ファイル

  4. ランタイムパラメータの上書き

注記

推奨事項 – 実行間で一貫したプロファイルアプリケーション動作を確保するには、コンソールの API またはエンジンバージョンの engineVersionキーを使用して Nextflow エンジンバージョンを固定します。

VPC ネットワーキング

Virtual Private Cloud (VPC) でワークフローを実行できます。これにより、パブリックインターネットへのアクセス、クロスリージョントラフィック、VPC 内のリソースとの通信が可能になります。

VPC ネットワークを有効にするには:

  1. VPC サブネットとセキュリティグループを指定する設定を作成します。

  2. コンソールを使用して実行を開始する場合は、仮想プライベートクラウド (VPC) へのネットワークアクセスを設定し、ステップ 1 で設定を選択します。

  3. API を使用して実行を開始する場合は、 を使用して設定--networking-mode VPCを参照します--configuration-name

詳細については、「HealthOmics ワークフローを VPC に接続する」を参照してください。