AWS CLI を使用した HealthOmics の例

次のコード例は、HealthOmics で AWS Command Line Interface を使用してアクションを実行し、一般的なシナリオを実装する方法を示しています。

アクションはより大きなプログラムからのコードの抜粋であり、コンテキスト内で実行する必要があります。アクションは個々のサービス機能を呼び出す方法を示していますが、コンテキスト内のアクションは、関連するシナリオで確認できます。

各例には完全なソースコードへのリンクが含まれており、コードの設定方法と実行方法に関する手順を確認できます。

アクション

abort-multipart-read-set-upload

次の例は、abort-multipart-read-set-upload を使用する方法を説明しています。

AWS CLI

マルチパート読み取りセットのアップロードを停止するには

次の abort-multipart-read-set-upload の例では、HealthOmics シーケンスストアへのマルチパート読み取りセットのアップロードを停止します。

aws omics abort-multipart-read-set-upload \
    --sequence-store-id 0123456789 \
    --upload-id 1122334455

このコマンドでは何も出力されません。

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「AbortMultipartReadSetUpload」を参照してください。

accept-share

次の例は、accept-share を使用する方法を説明しています。

AWS CLI

分析ストアデータの共有を受け入れるには

次の accept-share の例では、HealthOmics 分析ストアデータの共有を受け入れます。

aws omics accept-share \
    ----share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a"

出力:

{
    "status": "ACTIVATING"
}

詳細については、「AWS HealthOmics User Guide」の「Cross-account sharing」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「AcceptShare」を参照してください。

batch-delete-read-set

次の例は、batch-delete-read-set を使用する方法を説明しています。

AWS CLI

複数の読み取りセットを削除するには

次の batch-delete-read-set の例では、2 つの読み取りセットを削除します。

aws omics batch-delete-read-set \
    --sequence-store-id 1234567890 \
    --ids 1234567890 0123456789

指定された読み取りセットの削除でエラーが発生した場合、サービスはエラーリストを返します。

{
    "errors": [
        {
            "code": "",
            "id": "0123456789",
            "message": "The specified readset does not exist."
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「BatchDeleteReadSet」を参照してください。

cancel-annotation-import-job

次の例は、cancel-annotation-import-job を使用する方法を説明しています。

AWS CLI

注釈インポートジョブをキャンセルするには

次の cancel-annotation-import-job の例では、ID 04f57618-xmpl-4fd0-9349-e5a85aefb997 の注釈インポートジョブをキャンセルします。

aws omics cancel-annotation-import-job \
    --job-id 04f57618-xmpl-4fd0-9349-e5a85aefb997

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CancelAnnotationImportJob」を参照してください。

cancel-run

次の例は、cancel-run を使用する方法を説明しています。

AWS CLI

実行をキャンセルするには

次の cancel-run の例では、ID 1234567 の実行をキャンセルします。

aws omics cancel-run \
    --id 1234567

詳細については、「AWS HealthOmics ユーザーガイド」の「Run lifecycle in a workflow」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CancelRun」を参照してください。

cancel-variant-import-job

次の例は、cancel-variant-import-job を使用する方法を説明しています。

AWS CLI

バリアントインポートジョブをキャンセルするには

次の cancel-variant-import-job の例では、ID 69cb65d6-xmpl-4a4a-9025-4565794b684e のバリアントインポートジョブをキャンセルします。

aws omics cancel-variant-import-job \
    --job-id 69cb65d6-xmpl-4a4a-9025-4565794b684e

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CancelVariantImportJob」を参照してください。

complete-multipart-read-set-upload

次の例は、complete-multipart-read-set-upload を使用する方法を説明しています。

AWS CLI

すべてのコンポーネントをアップロードした後で、マルチパートアップロードを終了するには

次の complete-multipart-read-set-upload の例では、すべてのコンポーネントがアップロードされた後で、シーケンスストアへのマルチパートアップロードを終了します。

aws omics complete-multipart-read-set-upload \
    --sequence-store-id 0123456789 \
    --upload-id 1122334455 \
    --parts '[{"checksum":"gaCBQMe+rpCFZxLpoP6gydBoXaKKDA/Vobh5zBDb4W4=","partNumber":1,"partSource":"SOURCE1"}]'

出力:

{
    "readSetId": "0000000001"
    "readSetId": "0000000002"
    "readSetId": "0000000003"
}

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CompleteMultipartReadSetUpload」を参照してください。

create-annotation-store-version

次の例は、create-annotation-store-version を使用する方法を説明しています。

AWS CLI

注釈ストアの新しいバージョンを作成するには

次の create-annotation-store-version の例では、注釈ストアの新しいバージョンを作成します。

aws omics create-annotation-store-version \
    --name my_annotation_store \
    --version-name my_version

出力:

{
    "creationTime": "2023-07-21T17:15:49.251040+00:00",
    "id": "3b93cdef69d2",
    "name": "my_annotation_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:555555555555:referenceStore/6505293348/reference/5987565360"
    },
    "status": "CREATING",
    "versionName": "my_version"
}

詳細については、「AWS HealthOmics User Guide」の「Creating new versions of annotation stores」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateAnnotationStoreVersion」を参照してください。

create-annotation-store

次の例は、create-annotation-store を使用する方法を説明しています。

AWS CLI

例 1: VCF 注釈ストアを作成するには

次の create-annotation-store の例では、VCF 形式の注釈ストアを作成します。

aws omics create-annotation-store \
    --name my_ann_store \
    --store-format VCF \
    --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890

出力:

{
    "creationTime": "2022-11-23T22:48:39.226492Z",
    "id": "0a91xmplc71f",
    "name": "my_ann_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "CREATING",
    "storeFormat": "VCF"
}

例 2: TSV 注釈ストアを作成するには

次の create-annotation-store の例では、TSV 形式の注釈ストアを作成します。

aws omics create-annotation-store \
    --name tsv_ann_store \
    --store-format TSV \
    --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890 \
    --store-options file://tsv-store-options.json

tsv-store-options.json は注釈の形式オプションを設定します。

{
    "tsvStoreOptions": {
        "annotationType": "CHR_START_END_ZERO_BASE",
        "formatToHeader": {
            "CHR": "chromosome",
            "START": "start",
            "END": "end"
        },
        "schema": [
            {
                "chromosome": "STRING"
            },
            {
                "start": "LONG"
            },
            {
                "end": "LONG"
            },
            {
                "name": "STRING"
            }
        ]
    }
}

出力:

{
    "creationTime": "2022-11-30T01:28:08.525586Z",
    "id": "861cxmpl96b0",
    "name": "tsv_ann_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "CREATING",
    "storeFormat": "TSV",
    "storeOptions": {
        "tsvStoreOptions": {
            "annotationType": "CHR_START_END_ZERO_BASE",
            "formatToHeader": {
                "CHR": "chromosome",
                "END": "end",
                "START": "start"
            },
            "schema": [
                {
                    "chromosome": "STRING"
                },
                {
                    "start": "LONG"
                },
                {
                    "end": "LONG"
                },
                {
                    "name": "STRING"
                }
            ]
        }
    }
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateAnnotationStore」を参照してください。

create-multipart-read-set-upload

次の例は、create-multipart-read-set-upload を使用する方法を説明しています。

AWS CLI

マルチパート読み取りセットのアップロードを開始するには

次の create-multipart-read-set-upload の例では、マルチパート読み取りセットのアップロードを開始します。

aws omics create-multipart-read-set-upload \
    --sequence-store-id 0123456789 \
    --name HG00146 \
    --source-file-type FASTQ \
    --subject-id mySubject\
    --sample-id mySample\
    --description "FASTQ for HG00146"\
    --generated-from "1000 Genomes"

出力:

{
    "creationTime": "2022-07-13T23:25:20Z",
    "description": "FASTQ for HG00146",
    "generatedFrom": "1000 Genomes",
    "name": "HG00146",
    "sampleId": "mySample",
    "sequenceStoreId": "0123456789",
    "sourceFileType": "FASTQ",
    "subjectId": "mySubject",
    "uploadId": "1122334455"
}

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateMultipartReadSetUpload」を参照してください。

create-reference-store

次の例は、create-reference-store を使用する方法を説明しています。

AWS CLI

参照ストアを作成するには

次の create-reference-store の例では、参照ストア my-ref-store を作成します。

aws omics create-reference-store \
    --name my-ref-store

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890",
    "creationTime": "2022-11-22T22:13:25.947Z",
    "id": "1234567890",
    "name": "my-ref-store"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateReferenceStore」を参照してください。

create-run-group

次の例は、create-run-group を使用する方法を説明しています。

AWS CLI

実行グループを作成するには

次の create-run-group の例では、cram-converter という名前の実行グループを作成します。

aws omics create-run-group \
    --name cram-converter \
    --max-cpus 20 \
    --max-gpus 10 \
    --max-duration 600 \
    --max-runs 5

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567",
    "id": "1234567",
    "tags": {}
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating run groups」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateRunGroup」を参照してください。

create-sequence-store

次の例は、create-sequence-store を使用する方法を説明しています。

AWS CLI

シーケンスストアを作成するには

次の create-sequence-store の例では、シーケンスストアを作成します。

aws omics create-sequence-store \
    --name my-seq-store

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890",
    "creationTime": "2022-11-23T01:24:33.629Z",
    "id": "1234567890",
    "name": "my-seq-store"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateSequenceStore」を参照してください。

create-share

次の例は、create-share を使用する方法を説明しています。

AWS CLI

HealthOmics 分析ストアの共有を作成するには

次の create-share の例は、アカウント外のサブスクライバーが受け入れることができる HealthOmics 分析ストアの共有を作成する方法を示しています。

aws omics create-share \
    --resource-arn "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store" \
    --principal-subscriber "123456789012" \
    --name "my_Share-123"

出力:

{
    "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a",
    "name": "my_Share-123",
    "status": "PENDING"
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Cross-acount sharing」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateShare」を参照してください。

create-variant-store

次の例は、create-variant-store を使用する方法を説明しています。

AWS CLI

バリアントストアを作成するには

次の create-variant-store の例では、my_var_store という名前のバリアントストアを作成します。

aws omics create-variant-store \
    --name my_var_store \
    --reference referenceArn=arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890

出力:

{
    "creationTime": "2022-11-23T22:09:07.534499Z",
    "id": "02dexmplcfdd",
    "name": "my_var_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "CREATING"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateVariantStore」を参照してください。

create-workflow

次の例は、create-workflow を使用する方法を説明しています。

AWS CLI

ワークフローを作成するには

次の create-workflow の例では、WDL ワークフローを作成します。

aws omics create-workflow \
    --name cram-converter \
    --engine WDL \
    --definition-zip fileb://workflow-crambam.zip \
    --parameter-template file://workflow-params.json

workflow-crambam.zip は、ワークフロー定義を含む ZIP アーカイブです。workflow-params.json は、ワークフローのランタイムパラメータを定義します。

{
    "ref_fasta" : {
        "description": "Reference genome fasta file",
        "optional": false
    },
    "ref_fasta_index" : {
        "description": "Index of the reference genome fasta file",
        "optional": false
    },
    "ref_dict" : {
        "description": "dictionary file for 'ref_fasta'",
        "optional": false
    },
    "input_cram" : {
        "description": "The Cram file to convert to BAM",
        "optional": false
    },
    "sample_name" : {
        "description": "The name of the input sample, used to name the output BAM",
        "optional": false
    }
}

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
    "id": "1234567",
    "status": "CREATING",
    "tags": {}
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating private workflows」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「CreateWorkflow」を参照してください。

delete-annotation-store-versions

次の例は、delete-annotation-store-versions を使用する方法を説明しています。

AWS CLI

注釈ストアのバージョンを削除するには

次の delete-annotation-store-versions の例では、注釈ストアのバージョンを削除します。

aws omics delete-annotation-store-versions \
    --name my_annotation_store \
    --versions my_version

出力:

{
    "errors": []
}

詳細については、「AWS HealthOmics User Guide」の「Creating new versions of annotation stores」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAnnotationStoreVersions」を参照してください。

delete-annotation-store

次の例は、delete-annotation-store を使用する方法を説明しています。

AWS CLI

注釈ストアを削除するには

次の delete-annotation-store の例では、my_vcf_store という名前の注釈ストアを削除します。

aws omics delete-annotation-store \
    --name my_vcf_store

出力:

{
    "status": "DELETING"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteAnnotationStore」を参照してください。

delete-reference-store

次の例は、delete-reference-store を使用する方法を説明しています。

AWS CLI

参照ストアを削除するには

次の delete-reference-store の例では、ID 1234567890 の参照ストアを削除します。

aws omics delete-reference-store \
    --id 1234567890

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteReferenceStore」を参照してください。

delete-reference

次の例は、delete-reference を使用する方法を説明しています。

AWS CLI

参照を削除するには

次の delete-reference の例では、参照を削除します。

aws omics delete-reference \
    --reference-store-id 1234567890 \
    --id 1234567890

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteReference」を参照してください。

delete-run-group

次の例は、delete-run-group を使用する方法を説明しています。

AWS CLI

実行グループを削除するには

次の delete-run-group の例では、ID 1234567 の実行グループを削除します。

aws omics delete-run-group \
    --id 1234567

詳細については、「AWS HealthOmics ユーザーガイド」の「Deleting runs and run groups」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRunGroup」を参照してください。

delete-run

次の例は、delete-run を使用する方法を説明しています。

AWS CLI

ワークフローの実行を削除するには

次の delete-run の例では、ID 1234567 の実行を削除します。

aws omics delete-run \
    --id 1234567

詳細については、「AWS HealthOmics ユーザーガイド」の「Deleting runs and run groups」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteRun」を参照してください。

delete-sequence-store

次の例は、delete-sequence-store を使用する方法を説明しています。

AWS CLI

シーケンスストアを削除するには

次の delete-sequence-store の例では、ID 1234567890 のシーケンスストアを削除します。

aws omics delete-sequence-store \
    --id 1234567890

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteSequenceStore」を参照してください。

delete-share

次の例は、delete-share を使用する方法を説明しています。

AWS CLI

HealthOmics 分析データの共有を削除するには

次の delete-share の例では、分析データのクロスアカウント共有を削除します。

aws omics delete-share \
    --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a"

出力:

{
    "status": "DELETING"
}

詳細については、「AWS HealthOmics User Guide」の「Cross-account sharing」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteShare」を参照してください。

delete-variant-store

次の例は、delete-variant-store を使用する方法を説明しています。

AWS CLI

バリアントストアを削除するには

次の delete-variant-store の例では、my_var_store というバリアントストアを削除します。

aws omics delete-variant-store \
    --name my_var_store

出力:

{
    "status": "DELETING"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteVariantStore」を参照してください。

delete-workflow

次の例は、delete-workflow を使用する方法を説明しています。

AWS CLI

ワークフローを削除するには

次の delete-workflow の例では、ID 1234567 のワークフローを削除します。

aws omics delete-workflow \
    --id 1234567

詳細については、「AWS HealthOmics ユーザーガイド」の「Delete a private workflow」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「DeleteWorkflow」を参照してください。

get-annotation-import-job

次の例は、get-annotation-import-job を使用する方法を説明しています。

AWS CLI

注釈インポートジョブを表示するには

次の get-annotation-import-job の例では、注釈インポートジョブの詳細を取得します。

aws omics get-annotation-import-job \
    --job-id 984162c7-xmpl-4d23-ab47-286f7950bfbf

出力:

{
    "creationTime": "2022-11-30T01:40:11.017746Z",
    "destinationName": "tsv_ann_store",
    "id": "984162c7-xmpl-4d23-ab47-286f7950bfbf",
    "items": [
        {
            "jobStatus": "COMPLETED",
            "source": "s3://omics-artifacts-01d6xmpl4e72dd32/targetedregions.bed.gz"
        }
    ],
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "runLeftNormalization": false,
    "status": "COMPLETED",
    "updateTime": "2022-11-30T01:42:39.134009Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetAnnotationImportJob」を参照してください。

get-annotation-store-version

次の例は、get-annotation-store-version を使用する方法を説明しています。

AWS CLI

注釈ストアバージョンのメタデータを取得するには

次の get-annotation-store-version の例では、リクエストされた注釈ストアバージョンのメタデータを取得します。

aws omics get-annotation-store-version \
    --name my_annotation_store \
    --version-name my_version

出力:

{
    "storeId": "4934045d1c6d",
    "id": "2a3f4a44aa7b",
    "status": "ACTIVE",
    "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version",
    "name": "my_annotation_store",
    "versionName": "my_version",
    "creationTime": "2023-07-21T17:15:49.251040+00:00",
    "updateTime": "2023-07-21T17:15:56.434223+00:00",
    "statusMessage": "",
    "versionSizeBytes": 0
}

詳細については、「AWS HealthOmics User Guide」の「Creating new versions of annotation stores」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetAnnotationStoreVersion」を参照してください。

get-annotation-store

次の例は、get-annotation-store を使用する方法を説明しています。

AWS CLI

注釈ストアを表示するには

次の get-annotation-store の例では、my_ann_store という名前の注釈ストアの詳細を取得します。

aws omics get-annotation-store \
    --name my_ann_store

出力:

{
    "creationTime": "2022-11-23T22:48:39.226492Z",
    "id": "0a91xmplc71f",
    "name": "my_ann_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "CREATING",
    "storeArn": "arn:aws:omics:us-west-2:123456789012:annotationStore/my_ann_store",
    "storeFormat": "VCF",
    "storeSizeBytes": 0,
    "tags": {}
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetAnnotationStore」を参照してください。

get-read-set-activation-job

次の例は、get-read-set-activation-job を使用する方法を説明しています。

AWS CLI

読み取りセットのアクティベーションジョブを表示するには

次の get-read-set-activation-job の例では、読み取りセットのアクティベーションジョブの詳細を取得します。

aws omics get-read-set-activation-job \
    --sequence-store-id 1234567890 \
    --id 1234567890

出力:

{
    "completionTime": "2022-12-06T22:33:42.828Z",
    "creationTime": "2022-12-06T22:32:45.213Z",
    "id": "1234567890",
    "sequenceStoreId": "1234567890",
    "sources": [
        {
            "readSetId": "1234567890",
            "status": "FINISHED",
            "statusMessage": "No activation needed as read set is already in ACTIVATING or ACTIVE state."
        }
    ],
    "status": "COMPLETED",
    "statusMessage": "The job completed successfully."
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReadSetActivationJob」を参照してください。

get-read-set-export-job

次の例は、get-read-set-export-job を使用する方法を説明しています。

AWS CLI

読み取りセットのエクスポートジョブを表示するには

次の get-read-set-export-job の例では、読み取りセットのエクスポートジョブの詳細を取得します。

aws omics get-read-set-export-job \
    --sequence-store-id 1234567890 \
    --id 1234567890

出力:

{
    "completionTime": "2022-12-06T22:39:14.491Z",
    "creationTime": "2022-12-06T22:37:18.612Z",
    "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/",
    "id": "1234567890",
    "sequenceStoreId": "1234567890",
    "status": "COMPLETED",
    "statusMessage": "The job is submitted and will start soon."
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReadSetExportJob」を参照してください。

get-read-set-import-job

次の例は、get-read-set-import-job を使用する方法を説明しています。

AWS CLI

読み取りセットのインポートジョブを表示するには

次の get-read-set-import-job の例では、読み取りセットのインポートジョブの詳細を取得します。

aws omics get-read-set-import-job \
    --sequence-store-id 1234567890 \
    --id 1234567890

出力:

{
    "creationTime": "2022-11-23T01:36:38.158Z",
    "id": "1234567890",
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "sequenceStoreId": "1234567890",
    "sources": [
        {
            "name": "HG00100",
            "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "sampleId": "bam-sample",
            "sourceFileType": "BAM",
            "sourceFiles": {
                "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00100.chrom20.ILLUMINA.bwa.GBR.low_coverage.20101123.bam",
                "source2": ""
            },
            "status": "IN_PROGRESS",
            "statusMessage": "The source job is currently in progress.",
            "subjectId": "bam-subject",
            "tags": {
                "aws:omics:sampleId": "bam-sample",
                "aws:omics:subjectId": "bam-subject"
            }
        },
        {
            "name": "HG00146",
            "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "sampleId": "fastq-sample",
            "sourceFileType": "FASTQ",
            "sourceFiles": {
                "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/SRR233106_1.filt.fastq.gz",
                "source2": "s3://omics-artifacts-01d6xmpl4e72dd32/SRR233106_2.filt.fastq.gz"
            },
            "status": "IN_PROGRESS",
            "statusMessage": "The source job is currently in progress.",
            "subjectId": "fastq-subject",
            "tags": {
                "aws:omics:sampleId": "fastq-sample",
                "aws:omics:subjectId": "fastq-subject"
            }
        },
        {
            "name": "HG00096",
            "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "sampleId": "cram-sample",
            "sourceFileType": "CRAM",
            "sourceFiles": {
                "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00096.alt_bwamem_GRCh38DH.20150718.GBR.low_coverage.cram",
                "source2": ""
            },
            "status": "IN_PROGRESS",
            "statusMessage": "The source job is currently in progress.",
            "subjectId": "cram-subject",
            "tags": {
                "aws:omics:sampleId": "cram-sample",
                "aws:omics:subjectId": "cram-subject"
            }
        }
    ],
    "status": "IN_PROGRESS",
    "statusMessage": "The job is currently in progress."
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReadSetImportJob」を参照してください。

get-read-set-metadata

次の例は、get-read-set-metadata を使用する方法を説明しています。

AWS CLI

読み取りセットを表示するには

次の get-read-set-metadata の例では、読み取りセットのファイルの詳細を取得します。

aws omics get-read-set-metadata \
    --sequence-store-id 1234567890 \
    --id 1234567890

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890",
    "creationTime": "2022-11-23T21:55:00.515Z",
    "fileType": "FASTQ",
    "files": {
        "source1": {
            "contentLength": 310054739,
            "partSize": 104857600,
            "totalParts": 3
        },
        "source2": {
            "contentLength": 307846621,
            "partSize": 104857600,
            "totalParts": 3
        }
    },
    "id": "1234567890",
    "name": "HG00146",
    "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
    "sampleId": "fastq-sample",
    "sequenceInformation": {
        "alignment": "UNALIGNED",
        "totalBaseCount": 677717384,
        "totalReadCount": 8917334
    },
    "sequenceStoreId": "1234567890",
    "status": "ACTIVE",
    "subjectId": "fastq-subject"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReadSetMetadata」を参照してください。

get-read-set

次の例は、get-read-set を使用する方法を説明しています。

AWS CLI

読み取りセットをダウンロードするには

次の get-read-set の例では、読み取りセットのパート 3 を 1234567890.3.bam としてダウンロードします。

aws omics get-read-set \
    --sequence-store-id 1234567890 \
    --id 1234567890 \
    --part-number 3  1234567890.3.bam

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReadSet」を参照してください。

get-reference-import-job

次の例は、get-reference-import-job を使用する方法を説明しています。

AWS CLI

参照インポートジョブを表示するには

次の get-reference-import-job の例では、参照インポートジョブの詳細を取得します。

aws omics get-reference-import-job \
    --reference-store-id 1234567890 \
    --id 1234567890

出力:

{
    "creationTime": "2022-11-22T22:25:41.124Z",
    "id": "1234567890",
    "referenceStoreId": "1234567890",
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "sources": [
        {
            "name": "assembly-38",
            "sourceFile": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta",
            "status": "IN_PROGRESS",
            "statusMessage": "The source job is currently in progress."
        }
    ],
    "status": "IN_PROGRESS",
    "statusMessage": "The job is currently in progress."
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReferenceImportJob」を参照してください。

get-reference-metadata

次の例は、get-reference-metadata を使用する方法を説明しています。

AWS CLI

参照を表示するには

次の get-reference-metadata の例では、参照の詳細を取得します。

aws omics get-reference-metadata \
    --reference-store-id 1234567890 \
    --id 1234567890

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
    "creationTime": "2022-11-22T22:27:09.033Z",
    "files": {
        "index": {
            "contentLength": 160928,
            "partSize": 104857600,
            "totalParts": 1
        },
        "source": {
            "contentLength": 3249912778,
            "partSize": 104857600,
            "totalParts": 31
        }
    },
    "id": "1234567890",
    "md5": "7ff134953dcca8c8997453bbb80b6b5e",
    "name": "assembly-38",
    "referenceStoreId": "1234567890",
    "status": "ACTIVE",
    "updateTime": "2022-11-22T22:27:09.033Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReferenceMetadata」を参照してください。

get-reference-store

次の例は、get-reference-store を使用する方法を説明しています。

AWS CLI

参照ストアを表示するには

次の get-reference-store の例では、参照ストアの詳細を取得します。

aws omics get-reference-store \
    --id 1234567890

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890",
    "creationTime": "2022-09-23T23:27:20.364Z",
    "id": "1234567890",
    "name": "my-rstore-0"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReferenceStore」を参照してください。

get-reference

次の例は、get-reference を使用する方法を説明しています。

AWS CLI

ゲノム参照をダウンロードするには

次の get-reference の例では、ゲノムのパート 1 を hg38.1.fa としてダウンロードします。

aws omics get-reference \
    --reference-store-id 1234567890 \
    --id 1234567890 \
    --part-number 1 hg38.1.fa

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetReference」を参照してください。

get-run-group

次の例は、get-run-group を使用する方法を説明しています。

AWS CLI

実行グループを表示するには

次の get-run-group の例では、実行グループの詳細を取得します。

aws omics get-run-group \
    --id 1234567

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567",
    "creationTime": "2022-12-01T00:58:42.915219Z",
    "id": "1234567",
    "maxCpus": 20,
    "maxDuration": 600,
    "name": "cram-convert",
    "tags": {}
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating run groups」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetRunGroup」を参照してください。

get-run-task

次の例は、get-run-task を使用する方法を説明しています。

AWS CLI

タスクを表示するには

次の get-run-task の例では、ワークフロータスクの詳細を取得します。

aws omics get-run-task \
    --id 1234567 \
    --task-id 1234567

出力:

{
    "cpus": 1,
    "creationTime": "2022-11-30T23:13:00.718651Z",
    "logStream": "arn:aws:logs:us-west-2:123456789012:log-group:/aws/omics/WorkflowLog:log-stream:run/1234567/task/1234567",
    "memory": 15,
    "name": "CramToBamTask",
    "startTime": "2022-11-30T23:17:47.016Z",
    "status": "COMPLETED",
    "stopTime": "2022-11-30T23:18:21.503Z",
    "taskId": "1234567"
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Task lifecycle in a HealthOmics run」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetRunTask」を参照してください。

get-run

次の例は、get-run を使用する方法を説明しています。

AWS CLI

ワークフローの実行を表示するには

次の get-run の例では、ワークフロー実行の詳細を取得します。

aws omics get-run \
    --id 1234567

出力:

{
    "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"
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Run lifecycle in a workflow‭」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetRun」を参照してください。

get-sequence-store

次の例は、get-sequence-store を使用する方法を説明しています。

AWS CLI

シーケンスストアを表示するには

次の get-sequence-store の例では、ID 1234567890 のシーケンスストアの詳細を取得します。

aws omics get-sequence-store \
    --id 1234567890

出力:

{
    "arn": "arn:aws:omics:us-east-1:123456789012:sequenceStore/1234567890",
    "creationTime": "2022-11-23T19:55:48.376Z",
    "id": "1234567890",
    "name": "my-seq-store"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetSequenceStore」を参照してください。

get-share

次の例は、get-share を使用する方法を説明しています。

AWS CLI

HealthOmics 分析データの共有に関するメタデータを取得するには

次の get-share の例では、分析データのクロスアカウント共有のメタデータを取得します。

aws omics get-share \
    --share-id "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a"

出力:

{
    "share": {
        "shareId": "495c21bedc889d07d0ab69d710a6841e-dd75ab7a1a9c384fa848b5bd8e5a7e0a",
        "name": "my_Share-123",
        "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/omics_dev_var_store",
        "principalSubscriber": "123456789012",
        "ownerId": "555555555555",
        "status": "PENDING"
    }
}

詳細については、「AWS HealthOmics User Guide」の「Cross-account sharing」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetShare」を参照してください。

get-variant-import-job

次の例は、get-variant-import-job を使用する方法を説明しています。

AWS CLI

バリアントインポートジョブを表示するには

次の get-variant-import-job の例では、バリアントインポートジョブの詳細を取得します。

aws omics get-variant-import-job \
    --job-id edd7b8ce-xmpl-47e2-bc99-258cac95a508

出力:

{
    "creationTime": "2022-11-23T22:42:50.037812Z",
    "destinationName": "my_var_store",
    "id": "edd7b8ce-xmpl-47e2-bc99-258cac95a508",
    "items": [
        {
            "jobStatus": "IN_PROGRESS",
            "source": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.known_indels.vcf.gz"
        }
    ],
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "runLeftNormalization": false,
    "status": "IN_PROGRESS",
    "updateTime": "2022-11-23T22:43:05.898309Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetVariantImportJob」を参照してください。

get-variant-store

次の例は、get-variant-store を使用する方法を説明しています。

AWS CLI

バリアントストアを表示するには

次の get-variant-store の例では、バリアントストアの詳細を取得します。

aws omics get-variant-store \
    --name my_var_store

出力:

{
    "creationTime": "2022-11-23T22:09:07.534499Z",
    "id": "02dexmplcfdd",
    "name": "my_var_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "CREATING",
    "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/my_var_store",
    "storeSizeBytes": 0,
    "tags": {},
    "updateTime": "2022-11-23T22:09:24.931711Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetVariantStore」を参照してください。

get-workflow

次の例は、get-workflow を使用する方法を説明しています。

AWS CLI

ワークフローを表示するには

次の get-workflow の例では、ID 1234567 のワークフローの詳細を取得します。

aws omics get-workflow \
    --id 1234567

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
    "creationTime": "2022-11-30T22:33:16.225368Z",
    "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf",
    "engine": "WDL",
    "id": "1234567",
    "main": "workflow-crambam.wdl",
    "name": "cram-converter",
    "parameterTemplate": {
        "ref_dict": {
            "description": "dictionary file for 'ref_fasta'"
        },
        "ref_fasta_index": {
            "description": "Index of the reference genome fasta file"
        },
        "ref_fasta": {
            "description": "Reference genome fasta file"
        },
        "input_cram": {
            "description": "The Cram file to convert to BAM"
        },
        "sample_name": {
            "description": "The name of the input sample, used to name the output BAM"
        }
    },
    "status": "ACTIVE",
    "statusMessage": "workflow-crambam.wdl\n    workflow CramToBamFlow\n        call CramToBamTask\n        call ValidateSamFile\n    task CramToBamTask\n    task ValidateSamFile\n",
    "tags": {},
    "type": "PRIVATE"
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating private workflows」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「GetWorkflow」を参照してください。

list-annotation-import-jobs

次の例は、list-annotation-import-jobs を使用する方法を説明しています。

AWS CLI

注釈インポートジョブのリストを取得するには

次の list-annotation-import-jobs は、注釈インポートジョブのリストを取得します。

aws omics list-annotation-import-jobs

出力:

{
    "annotationImportJobs": [
        {
            "creationTime": "2022-11-30T01:39:41.478294Z",
            "destinationName": "gff_ann_store",
            "id": "18a9e792-xmpl-4869-a105-e5b602900444",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "runLeftNormalization": false,
            "status": "COMPLETED",
            "updateTime": "2022-11-30T01:47:09.145178Z"
        },
        {
            "creationTime": "2022-11-30T00:45:58.007838Z",
            "destinationName": "my_ann_store",
            "id": "4e9eafc8-xmpl-431e-a0b2-3bda27cb600a",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "runLeftNormalization": false,
            "status": "FAILED",
            "updateTime": "2022-11-30T00:47:01.706325Z"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListAnnotationImportJobs」を参照してください。

list-annotation-store-versions

次の例は、list-annotation-store-versions を使用する方法を説明しています。

AWS CLI

注釈ストアのすべてのバージョンを一覧表示するには

次の list-annotation-store-versions の例では、注釈ストアが存在するすべてのバージョンを一覧表示します。

aws omics list-annotation-store-versions \
    --name my_annotation_store

出力:

{
    "annotationStoreVersions": [
        {
        "storeId": "4934045d1c6d",
        "id": "2a3f4a44aa7b",
        "status": "CREATING",
        "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_2",
        "name": "my_annotation_store",
        "versionName": "my_version_2",
        "creation Time": "2023-07-21T17:20:59.380043+00:00",
        "versionSizeBytes": 0
},
{
     "storeId": "4934045d1c6d",
     "id": "4934045d1c6d",
     "status": "ACTIVE",
     "versionArn": "arn:aws:omics:us-west-2:555555555555:annotationStore/my_annotation_store/version/my_version_1",
     "name": "my_annotation_store",
     "versionName": "my_version_1",
     "creationTime": "2023-07-21T17:15:49.251040+00:00",
     "updateTime": "2023-07-21T17:15:56.434223+00:00",
     "statusMessage": "",
     "versionSizeBytes": 0
     }

}

詳細については、「AWS HealthOmics User Guide」の「Creating new versions of annotation stores」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListAnnotationStoreVersions」を参照してください。

list-annotation-stores

次の例は、list-annotation-stores を使用する方法を説明しています。

AWS CLI

注釈ストアのリストを取得するには

次の list-annotation-stores の例では、注釈ストアのリストを取得します。

aws omics list-annotation-stores

出力:

{
    "annotationStores": [
        {
            "creationTime": "2022-11-23T22:48:39.226492Z",
            "id": "0a91xmplc71f",
            "name": "my_ann_store",
            "reference": {
                "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
            },
            "status": "ACTIVE",
            "statusMessage": "",
            "storeArn": "arn:aws:omics:us-west-2:123456789012:annotationStore/my_ann_store",
            "storeFormat": "VCF",
            "storeSizeBytes": 0,
            "updateTime": "2022-11-23T22:53:27.372840Z"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListAnnotationStores」を参照してください。

list-multipart-read-set-uploads

次の例は、list-multipart-read-set-uploads を使用する方法を説明しています。

AWS CLI

すべてのマルチパート読み取りセットのアップロードとそのステータスを一覧表示するには

次の list-multipart-read-set-uploads の例では、すべてのマルチパート読み取りセットのアップロードとそのステータスを一覧表示します。

aws omics list-multipart-read-set-uploads \
    --sequence-store-id 0123456789

出力:

{
"uploads":
    [
        {
           "sequenceStoreId": "0123456789",
           "uploadId": "8749584421",
           "sourceFileType": "FASTQ",
            "subjectId": "mySubject",
            "sampleId": "mySample",
            "generatedFrom": "1000 Genomes",
            "name": "HG00146",
            "description": "FASTQ for HG00146",
            "creationTime": "2023-11-29T19:22:51.349298+00:00"
        },
        {
            "sequenceStoreId": "0123456789",
            "uploadId": "5290538638",
            "sourceFileType": "BAM",
            "subjectId": "mySubject",
            "sampleId": "mySample",
            "generatedFrom": "1000 Genomes",
            "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383",
            "name": "HG00146",
            "description": "BAM for HG00146",
            "creationTime": "2023-11-29T19:23:33.116516+00:00"
        },
        {
            "sequenceStoreId": "0123456789",
            "uploadId": "4174220862",
            "sourceFileType": "BAM",
            "subjectId": "mySubject",
            "sampleId": "mySample",
            "generatedFrom": "1000 Genomes",
            "referenceArn": "arn:aws:omics:us-west-2:845448930428:referenceStore/8168613728/reference/2190697383",
            "name": "HG00147",
            "description": "BAM for HG00147",
            "creationTime": "2023-11-29T19:23:47.007866+00:00"
        }
    ]
}

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListMultipartReadSetUploads」を参照してください。

list-read-set-activation-jobs

次の例は、list-read-set-activation-jobs を使用する方法を説明しています。

AWS CLI

読み取りセットのアクティベーションジョブのリストを取得するには

次の list-read-set-activation-jobs の例では、ID 1234567890 のシーケンスストアのアクティベーションジョブのリストを取得します。

aws omics list-read-set-activation-jobs \
    --sequence-store-id 1234567890

出力:

{
    "activationJobs": [
        {
            "completionTime": "2022-12-06T22:33:42.828Z",
            "creationTime": "2022-12-06T22:32:45.213Z",
            "id": "1234567890",
            "sequenceStoreId": "1234567890",
            "status": "COMPLETED"
        },
        {
            "creationTime": "2022-12-06T22:35:10.100Z",
            "id": "1234567890",
            "sequenceStoreId": "1234567890",
            "status": "IN_PROGRESS"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReadSetActivationJobs」を参照してください。

list-read-set-export-jobs

次の例は、list-read-set-export-jobs を使用する方法を説明しています。

AWS CLI

読み取りセットのエクスポートジョブのリストを取得するには

次の list-read-set-export-jobs の例では、ID 1234567890 のシーケンスストアのエクスポートジョブのリストを取得します。

aws omics list-read-set-export-jobs \
    --sequence-store-id 1234567890

出力:

{
    "exportJobs": [
        {
            "completionTime": "2022-12-06T22:39:14.491Z",
            "creationTime": "2022-12-06T22:37:18.612Z",
            "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/",
            "id": "1234567890",
            "sequenceStoreId": "1234567890",
            "status": "COMPLETED"
        },
        {
            "creationTime": "2022-12-06T22:38:04.871Z",
            "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/",
            "id": "1234567890",
            "sequenceStoreId": "1234567890",
            "status": "IN_PROGRESS"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReadSetExportJobs」を参照してください。

list-read-set-import-jobs

次の例は、list-read-set-import-jobs を使用する方法を説明しています。

AWS CLI

読み取りセットインポートジョブのリストを取得するには

次の list-read-set-import-jobs の例では、ID 1234567890 のシーケンスストアのインポートジョブのリストを取得します。

aws omics list-read-set-import-jobs \
    --sequence-store-id 1234567890

出力:

{
    "importJobs": [
        {
            "completionTime": "2022-11-29T18:17:49.244Z",
            "creationTime": "2022-11-29T17:32:47.700Z",
            "id": "1234567890",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "sequenceStoreId": "1234567890",
            "status": "COMPLETED"
        },
        {
            "completionTime": "2022-11-23T22:01:34.090Z",
            "creationTime": "2022-11-23T21:52:43.289Z",
            "id": "1234567890",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "sequenceStoreId": "1234567890",
            "status": "COMPLETED_WITH_FAILURES"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReadSetImportJobs」を参照してください。

list-read-set-upload-parts

次の例は、list-read-set-upload-parts を使用する方法を説明しています。

AWS CLI

シーケンスストアのリクエストされたマルチパートアップロード内のすべてのパートを一覧表示するには

次の list-read-set-upload-parts の例では、シーケンスストアのリクエストされたマルチパートアップロードのすべてのパートを一覧表示します。

aws omics list-read-set-upload-parts \
    --sequence-store-id 0123456789 \
    --upload-id 1122334455 \
    --part-source SOURCE1

出力:

{
    "parts": [
        {
            "partNumber": 1,
            "partSize": 94371840,
            "file": "SOURCE1",
            "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635",
            "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00"
        }
        {
            "partNumber": 2,
            "partSize": 10471840,
            "file": "SOURCE1",
            "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635",
            "lastUpdatedTime": "2023-02-02T20:14:47.533000+00:00"
        }
      ]

}

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReadSetUploadParts」を参照してください。

list-read-sets

次の例は、list-read-sets を使用する方法を説明しています。

AWS CLI

読み取りセットのリストを取得するには

次の list-read-sets の例では、ID 1234567890 のシーケンスストアの読み取りセットのリストを取得します。

aws omics list-read-sets \
    --sequence-store-id 1234567890

出力:

{
    "readSets": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890/readSet/1234567890",
            "creationTime": "2022-11-23T21:55:00.515Z",
            "fileType": "FASTQ",
            "id": "1234567890",
            "name": "HG00146",
            "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "sampleId": "fastq-sample",
            "sequenceStoreId": "1234567890",
            "status": "ACTIVE",
            "subjectId": "fastq-subject"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReadSets」を参照してください。

list-reference-import-jobs

次の例は、list-reference-import-jobs を使用する方法を説明しています。

AWS CLI

参照インポートジョブのリストを取得するには

次の list-reference-import-jobs の例では、ID 1234567890 の参照ストアの参照インポートジョブのリストを取得します。

aws omics list-reference-import-jobs \
    --reference-store-id 1234567890

出力:

{
    "importJobs": [
        {
            "completionTime": "2022-11-23T19:54:58.204Z",
            "creationTime": "2022-11-23T19:53:20.729Z",
            "id": "1234567890",
            "referenceStoreId": "1234567890",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "status": "COMPLETED"
        },
        {
            "creationTime": "2022-11-23T20:34:03.250Z",
            "id": "1234567890",
            "referenceStoreId": "1234567890",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "status": "IN_PROGRESS"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReferenceImportJobs」を参照してください。

list-reference-stores

次の例は、list-reference-stores を使用する方法を説明しています。

AWS CLI

参照ストアのリストを取得するには

次の list-reference-stores の例では、参照ストアのリストを取得します。

aws omics list-reference-stores

出力:

{
    "referenceStores": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890",
            "creationTime": "2022-11-22T22:13:25.947Z",
            "id": "1234567890",
            "name": "my-ref-store"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReferenceStores」を参照してください。

list-references

次の例は、list-references を使用する方法を説明しています。

AWS CLI

参照のリストを取得するには

次の list-references の例では、ID 1234567890 の参照ストアのゲノム参照のリストを取得します。

aws omics list-references \
    --reference-store-id 1234567890

出力:

{
    "references": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
            "creationTime": "2022-11-22T22:27:09.033Z",
            "id": "1234567890",
            "md5": "7ff134953dcca8c8997453bbb80b6b5e",
            "name": "assembly-38",
            "referenceStoreId": "1234567890",
            "status": "ACTIVE",
            "updateTime": "2022-11-22T22:27:09.033Z"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListReferences」を参照してください。

list-run-groups

次の例は、list-run-groups を使用する方法を説明しています。

AWS CLI

実行グループのリストを取得するには

次の list-run-groups の例では、実行グループのリストを取得します。

aws omics list-run-groups

出力:

{
    "items": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567",
            "creationTime": "2022-12-01T00:58:42.915219Z",
            "id": "1234567",
            "maxCpus": 20,
            "maxDuration": 600,
            "name": "cram-convert"
        }
    ]
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating run groups」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListRunGroups」を参照してください。

list-run-tasks

次の例は、list-run-tasks を使用する方法を説明しています。

AWS CLI

タスクのリストを取得するには

次の list-run-tasks の例では、ワークフロー実行のタスクのリストを取得します。

aws omics list-run-tasks \
    --id 1234567

出力:

{
    "items": [
        {
            "cpus": 1,
            "creationTime": "2022-11-30T23:13:00.718651Z",
            "memory": 15,
            "name": "CramToBamTask",
            "startTime": "2022-11-30T23:17:47.016Z",
            "status": "COMPLETED",
            "stopTime": "2022-11-30T23:18:21.503Z",
            "taskId": "1234567"
        },
        {
            "cpus": 1,
            "creationTime": "2022-11-30T23:18:32.315606Z",
            "memory": 4,
            "name": "ValidateSamFile",
            "startTime": "2022-11-30T23:23:40.165Z",
            "status": "COMPLETED",
            "stopTime": "2022-11-30T23:24:14.766Z",
            "taskId": "1234567"
        }
    ]
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Task lifecycle in a HealthOmics run」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListRunTasks」を参照してください。

list-runs

次の例は、list-runs を使用する方法を説明しています。

AWS CLI

ワークフロー実行のリストを取得するには

次の list-runs の例では、ワークフロー実行のリストを取得します。

aws omics list-runs

出力:

{
    "items": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
            "creationTime": "2022-12-02T23:20:01.202074Z",
            "id": "1234567",
            "name": "cram-to-bam",
            "priority": 1,
            "startTime": "2022-12-02T23:29:18.115Z",
            "status": "COMPLETED",
            "stopTime": "2022-12-02T23:57:54.428812Z",
            "storageCapacity": 10,
            "workflowId": "1234567"
        },
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
            "creationTime": "2022-12-03T00:16:57.180066Z",
            "id": "1234567",
            "name": "cram-to-bam",
            "priority": 1,
            "startTime": "2022-12-03T00:26:50.233Z",
            "status": "FAILED",
            "stopTime": "2022-12-03T00:37:21.451340Z",
            "storageCapacity": 10,
            "workflowId": "1234567"
        },
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
            "creationTime": "2022-12-05T17:57:08.444817Z",
            "id": "1234567",
            "name": "cram-to-bam",
            "status": "STARTING",
            "workflowId": "1234567"
        }
    ]
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Run lifecycle in a workflow‭」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListRuns」を参照してください。

list-sequence-stores

次の例は、list-sequence-stores を使用する方法を説明しています。

AWS CLI

シーケンスストアのリストを取得するには

次の list-sequence-stores の例では、シーケンスストアのリストを取得します。

aws omics list-sequence-stores

出力:

{
    "sequenceStores": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:sequenceStore/1234567890",
            "creationTime": "2022-11-23T01:24:33.629Z",
            "id": "1234567890",
            "name": "my-seq-store"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListSequenceStores」を参照してください。

list-shares

次の例は、list-shares を使用する方法を説明しています。

AWS CLI

HealthOmics 分析データの使用可能な共有を一覧表示するには

次の list-shares の例では、リソース所有者用に作成されたすべての共有を一覧表示します。

aws omics list-shares \
    --resource-owner SELF

出力:

{
    "shares": [
        {
            "shareId": "595c1cbd-a008-4eca-a887-954d30c91c6e",
            "name": "myShare",
            "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_1",
            "principalSubscriber": "123456789012",
            "ownerId": "555555555555",
            "status": "PENDING"
        }
        {
            "shareId": "39b65d0d-4368-4a19-9814-b0e31d73c10a",
            "name": "myShare3456",
            "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_2",
            "principalSubscriber": "123456789012",
            "ownerId": "555555555555",
            "status": "ACTIVE"
        },
        {
            "shareId": "203152f5-eef9-459d-a4e0-a691668d44ef",
            "name": "myShare4",
            "resourceArn": "arn:aws:omics:us-west-2:555555555555:variantStore/store_3",
            "principalSubscriber": "123456789012",
            "ownerId": "555555555555",
            "status": "ACTIVE"
        }
    ]
}

詳細については、「AWS HealthOmics User Guide」の「Cross-account sharing」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListShares」を参照してください。

list-tags-for-resource

次の例は、list-tags-for-resource を使用する方法を説明しています。

AWS CLI

タグのリストを取得するには

次の list-tags-for-resource の例では、ID 1234567 のワークフローのタグのリストを取得します。

aws omics list-tags-for-resource \
    --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567

出力:

{
    "tags": {
        "department": "analytics"
    }
}

詳細については、「Amazon Omics Developer Guide」の「Amazon Omics リソースにタグを付ける」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListTagsForResource」を参照してください。

list-variant-import-jobs

次の例は、list-variant-import-jobs を使用する方法を説明しています。

AWS CLI

バリアントインポートジョブのリストを取得するには

次の list-variant-import-jobs の例では、バリアントインポートジョブのリストを取得します。

aws omics list-variant-import-jobs

出力:

{
    "variantImportJobs": [
        {
            "creationTime": "2022-11-23T22:47:02.514002Z",
            "destinationName": "my_var_store",
            "id": "69cb65d6-xmpl-4a4a-9025-4565794b684e",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "runLeftNormalization": false,
            "status": "COMPLETED",
            "updateTime": "2022-11-23T22:49:17.976597Z"
        },
        {
            "creationTime": "2022-11-23T22:42:50.037812Z",
            "destinationName": "my_var_store",
            "id": "edd7b8ce-xmpl-47e2-bc99-258cac95a508",
            "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
            "runLeftNormalization": false,
            "status": "COMPLETED",
            "updateTime": "2022-11-23T22:45:26.009880Z"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListVariantImportJobs」を参照してください。

list-variant-stores

次の例は、list-variant-stores を使用する方法を説明しています。

AWS CLI

バリアントストアのリストを取得するには

次の list-variant-stores の例では、バリアントストアのリストを取得します。

aws omics list-variant-stores

出力:

{
    "variantStores": [
        {
            "creationTime": "2022-11-23T22:09:07.534499Z",
            "id": "02dexmplcfdd",
            "name": "my_var_store",
            "reference": {
                "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
            },
            "status": "CREATING",
            "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/my_var_store",
            "storeSizeBytes": 0,
            "updateTime": "2022-11-23T22:09:24.931711Z"
        },
        {
            "creationTime": "2022-09-23T23:00:09.140265Z",
            "id": "8777xmpl1a24",
            "name": "myvstore0",
            "status": "ACTIVE",
            "storeArn": "arn:aws:omics:us-west-2:123456789012:variantStore/myvstore0",
            "storeSizeBytes": 0,
            "updateTime": "2022-09-23T23:03:26.013220Z"
        }
    ]
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListVariantStores」を参照してください。

list-workflows

次の例は、list-workflows を使用する方法を説明しています。

AWS CLI

ワークフローのリストを取得するには

次の list-workflows の例では、ワークフローのリストを取得します。

aws omics list-workflows

出力:

{
    "items": [
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
            "creationTime": "2022-09-23T23:08:22.041227Z",
            "digest": "nSCNo/qMWFxmplXpUdokXJnwgneOaxyyc2YOxVxrJTE=",
            "id": "1234567",
            "name": "my-wkflow-0",
            "status": "ACTIVE",
            "type": "PRIVATE"
        },
        {
            "arn": "arn:aws:omics:us-west-2:123456789012:workflow/1234567",
            "creationTime": "2022-11-30T22:33:16.225368Z",
            "digest": "sha256:c54bxmpl742dcc26f7fa1f10e37550ddd8f251f418277c0a58e895b801ed28cf",
            "id": "1234567",
            "name": "cram-converter",
            "status": "ACTIVE",
            "type": "PRIVATE"
        }
    ]
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating private workflows」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「ListWorkflows」を参照してください。

start-annotation-import-job

次の例は、start-annotation-import-job を使用する方法を説明しています。

AWS CLI

注釈をインポートするには

次の start-annotation-import-job の例では、Amazon S3 から注釈をインポートします。

aws omics start-annotation-import-job \
    --destination-name tsv_ann_store \
    --no-run-left-normalization \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --items source=s3://omics-artifacts-01d6xmpl4e72dd32/targetedregions.bed.gz

出力:

{
    "jobId": "984162c7-xmpl-4d23-ab47-286f7950bfbf"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartAnnotationImportJob」を参照してください。

start-read-set-activation-job

次の例は、start-read-set-activation-job を使用する方法を説明しています。

AWS CLI

アーカイブされた読み取りセットをアクティブ化するには

次の start-read-set-activation-job の例では、2 つの読み取りセットをアクティブ化します。

aws omics start-read-set-activation-job \
    --sequence-store-id 1234567890 \
    --sources readSetId=1234567890 readSetId=1234567890

出力:

{
    "creationTime": "2022-12-06T22:35:10.100Z",
    "id": "1234567890",
    "sequenceStoreId": "1234567890",
    "status": "SUBMITTED"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartReadSetActivationJob」を参照してください。

start-read-set-export-job

次の例は、start-read-set-export-job を使用する方法を説明しています。

AWS CLI

読み取りセットをエクスポートするには

次の start-read-set-export-job の例では、2 つの読み取りセットを Amazon S3 にエクスポートします。

   aws omics start-read-set-export-job \
       --sequence-store-id 1234567890 \
       --sources readSetId=1234567890 readSetId=1234567890 \
       --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ
\
       --destination s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/

出力:

{
    "creationTime": "2022-12-06T22:37:18.612Z",
    "destination": "s3://omics-artifacts-01d6xmpl4e72dd32/read-set-export/",
    "id": "1234567890",
    "sequenceStoreId": "1234567890",
    "status": "SUBMITTED"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartReadSetExportJob」を参照してください。

start-read-set-import-job

次の例は、start-read-set-import-job を使用する方法を説明しています。

AWS CLI

読み取りセットをインポートするには

次の start-read-set-import-job の例では、読み取りセットをインポートします。

aws omics start-read-set-import-job \
    --sequence-store-id 1234567890 \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --sources file://readset-sources.json

readset-sources.json は、次のコンテンツを含む JSON ドキュメントです。

[
    {
        "sourceFiles":
        {
            "source1": "s3://omics-artifacts-01d6xmpl4e72dd32/HG00100.chrom20.ILLUMINA.bwa.GBR.low_coverage.20101123.bam"
        },
        "sourceFileType": "BAM",
        "subjectId": "bam-subject",
        "sampleId": "bam-sample",
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890",
        "name": "HG00100"
    }
]

出力:

{
    "creationTime": "2022-11-23T01:36:38.158Z",
    "id": "1234567890",
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "sequenceStoreId": "1234567890",
    "status": "SUBMITTED"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartReadSetImportJob」を参照してください。

start-reference-import-job

次の例は、start-reference-import-job を使用する方法を説明しています。

AWS CLI

参照ゲノムをインポートするには

次の start-reference-import-job の例では、Amazon S3 から参照ゲノムをインポートします。

aws omics start-reference-import-job \
    --reference-store-id 1234567890 \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --sources sourceFile=s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta,name=assembly-38

出力:

{
    "creationTime": "2022-11-22T22:25:41.124Z",
    "id": "1234567890",
    "referenceStoreId": "1234567890",
    "roleArn": "arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ",
    "status": "SUBMITTED"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartReferenceImportJob」を参照してください。

start-run

次の例は、start-run を使用する方法を説明しています。

AWS CLI

ワークフローを実行するには

次の start-run の例では、ID 1234567 のワークフローを実行します。

aws omics start-run \
    --workflow-id 1234567 \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --name 'cram-to-bam' \
    --output-uri s3://omics-artifacts-01d6xmpl4e72dd32/workflow-output/ \
    --run-group-id 1234567 \
    --priority 1 \
    --storage-capacity 10 \
    --log-level ALL \
    --parameters file://workflow-inputs.json

workflow-inputs.json は、次のコンテンツを含む JSON ドキュメントです。

{
    "sample_name": "NA12878",
    "input_cram": "s3://omics-artifacts-01d6xmpl4e72dd32/NA12878.cram",
    "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict",
    "ref_fasta": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta",
    "ref_fasta_index": "omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.fasta.fai"
}

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:run/1234567",
    "id": "1234567",
    "status": "PENDING",
    "tags": {}
}

詳細については、「AWS HealthOmics ユーザーガイド」の「Starting a run」を参照してください。

Amazon Omics からソースファイルをロードするには

サービス固有の URI を使用して、Amazon Omics Storage からソースファイルをロードすることもできます。次の workflow-inputs.json ファイルの例では、読み取りセットおよび参照ゲノムのソースに Amazon Omics URI を使用します。

{
    "sample_name": "NA12878",
    "input_cram": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/readSet/1234567890/source1",
    "ref_dict": "s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.dict",
    "ref_fasta": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890",
    "ref_fasta_index": "omics://123456789012.storage.us-west-2.amazonaws.com/1234567890/reference/1234567890/index"
}

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartRun」を参照してください。

start-variant-import-job

次の例は、start-variant-import-job を使用する方法を説明しています。

AWS CLI

バリアントファイルをインポートするには

次の start-variant-import-job の例では、VCF 形式のバリアントファイルをインポートします。

aws omics start-variant-import-job \
    --destination-name my_var_store \
    --no-run-left-normalization  \
    --role-arn arn:aws:iam::123456789012:role/omics-service-role-serviceRole-W8O1XMPL7QZ \
    --items source=s3://omics-artifacts-01d6xmpl4e72dd32/Homo_sapiens_assembly38.known_indels.vcf.gz

出力:

{
    "jobId": "edd7b8ce-xmpl-47e2-bc99-258cac95a508"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「StartVariantImportJob」を参照してください。

tag-resource

次の例は、tag-resource を使用する方法を説明しています。

AWS CLI

リソースにタグを付けるには

次の tag-resource の例では、ID 1234567 のワークフローに department タグを追加します。

aws omics tag-resource \
    --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \
    --tags department=analytics

詳細については、「Amazon Omics Developer Guide」の「Amazon Omics リソースにタグを付ける」を参照してください。

• API の詳細については、AWS CLI コマンドリファレンスの「TagResource」を参照してください。

untag-resource

次の例では、untag-resource を使用する方法を説明しています。

AWS CLI

リソースからタグを削除するには

次の untag-resource の例では、ワークフローから department タグを削除します。

aws omics untag-resource \
    --resource-arn arn:aws:omics:us-west-2:123456789012:workflow/1234567 \
    --tag-keys department

詳細については、「Amazon Omics Developer Guide」の「Omics Storage」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UntagResource」を参照してください。

update-annotation-store

次の例は、update-annotation-store を使用する方法を説明しています。

AWS CLI

注釈ストアを更新するには

次の update-annotation-store の例では、my_vcf_store という名前の注釈ストアの説明を更新します。

aws omics update-annotation-store \
    --name my_vcf_store \
    --description "VCF annotation store"

出力:

{
    "creationTime": "2022-12-05T18:00:56.101860Z",
    "description": "VCF annotation store",
    "id": "bd6axmpl2444",
    "name": "my_vcf_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "ACTIVE",
    "storeFormat": "VCF",
    "updateTime": "2022-12-05T18:13:16.100051Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateAnnotationStore」を参照してください。

update-run-group

次の例は、update-run-group を使用する方法を説明しています。

AWS CLI

実行グループを更新するには

次の update-run-group の例では、ID 1234567 の実行グループの設定を更新します。

aws omics update-run-group \
    --id 1234567 \
    --max-cpus 10

出力:

{
    "arn": "arn:aws:omics:us-west-2:123456789012:runGroup/1234567",
    "creationTime": "2022-12-01T00:58:42.915219Z",
    "id": "1234567",
    "maxCpus": 10,
    "maxDuration": 600,
    "name": "cram-convert",
    "tags": {}
}

詳細については、「Amazon Omics Developer Guide」の「Omics Workflows」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateRunGroup」を参照してください。

update-variant-store

次の例は、update-variant-store を使用する方法を説明しています。

AWS CLI

バリアントストアを更新するには

次の update-variant-store の例では、my_var_store という名前のバリアントストアの説明を更新します。

aws omics update-variant-store \
    --name my_var_store \
    --description "variant store"

出力:

{
    "creationTime": "2022-11-23T22:09:07.534499Z",
    "description": "variant store",
    "id": "02dexmplcfdd",
    "name": "my_var_store",
    "reference": {
        "referenceArn": "arn:aws:omics:us-west-2:123456789012:referenceStore/1234567890/reference/1234567890"
    },
    "status": "ACTIVE",
    "updateTime": "2022-12-05T18:23:37.686402Z"
}

詳細については、「Amazon Omics Developer Guide」の「Omics Analytics」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateVariantStore」を参照してください。

update-workflow

次の例は、update-workflow を使用する方法を説明しています。

AWS CLI

ワークフローを更新するには

次の update-workflow の例では、ID 1234567 のワークフローの説明を更新します。

aws omics update-workflow \
    --id 1234567 \
    --description "copy workflow"

詳細については、「AWS HealthOmics ユーザーガイド」の「Creating or updating a workflow」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UpdateWorkflow」を参照してください。

upload-read-set-part

次の例は、upload-read-set-part を使用する方法を説明しています。

AWS CLI

読み取りセットのパートをアップロードするには

次の upload-read-set-part の例では、読み取りセットの指定されたパートをアップロードします。

aws omics upload-read-set-part \
    --sequence-store-id 0123456789 \
    --upload-id 1122334455 \
    --part-source SOURCE1 \
    --part-number 1 \
    --payload /path/to/file/read_1_part_1.fastq.gz

出力:

{
    "checksum": "984979b9928ae8d8622286c4a9cd8e99d964a22d59ed0f5722e1733eb280e635"
}

詳細については、「AWS HealthOmics User Guide」の「Direct upload to a sequence store」を参照してください。

• API の詳細については、「AWS CLI コマンドリファレンス」の「UploadReadSetPart」を参照してください。