使用 AWS CLI 的 HealthOmics 示例 - AWS Command Line Interface
操作

本文档仅适用于 AWS CLI 版本 1。有关 AWS CLI 版本 2 的相关文档，请参阅版本 2 用户指南。

使用 AWS CLI 的 HealthOmics 示例

以下代码示例演示了如何通过将 AWS Command Line Interface与 HealthOmics 结合使用，来执行操作和实现常见场景。

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景的上下文查看操作。

每个示例都包含一个指向完整源代码的链接，您可以从中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

以下代码示例演示了如何使用 accept-share。

AWS CLI

接受分析存储数据共享

以下 accept-share 示例接受 HealthOmics 分析存储数据共享。

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

输出：

{
    "status": "ACTIVATING"
}

有关更多信息，请参阅《AWS HealthOmics 用户指南》中的跨账户共享。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 AcceptShare。

以下代码示例演示了如何使用 batch-delete-read-set。

AWS CLI

删除多个读取集

以下 batch-delete-read-set 示例删除了两个读取集。

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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 BatchDeleteReadSet。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 cancel-run。

AWS CLI

取消运行

以下 cancel-run 示例取消了 ID 为 1234567 的运行。

aws omics cancel-run \
    --id 1234567

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CancelRun。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

以下代码示例演示了如何使用 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 用户指南》中的创建注释存储的新版本。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 create-run-group。

AWS CLI

创建运行组

以下 create-run-group 示例创建名为 cram-converter 的运行组。

aws omics create-run-group \
    --name cram-converter \
    --max-cpus 20 \
    --max-duration 600

输出：

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateRunGroup。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 用户指南》中的跨账户共享。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateShare。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateVariantStore。

以下代码示例演示了如何使用 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": {}
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 CreateWorkflow。

以下代码示例演示了如何使用 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 用户指南》中的创建注释存储的新版本。

以下代码示例演示了如何使用 delete-annotation-store。

AWS CLI

删除注释存储

以下 delete-annotation-store 示例删除了名为 my_vcf_store 的注释存储。

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

输出：

{
    "status": "DELETING"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 delete-reference-store。

AWS CLI

删除参考存储

以下 delete-reference-store 示例删除了 ID 为 1234567890 的参考存储。

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 delete-reference。

AWS CLI

删除参考

以下 delete-reference 示例删除了参考。

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteReference。

以下代码示例演示了如何使用 delete-run-group。

AWS CLI

删除运行组

以下 delete-run-group 示例删除了 ID 为 1234567 的运行组。

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteRunGroup。

以下代码示例演示了如何使用 delete-run。

AWS CLI

删除工作流运行

以下 delete-run 示例删除了 ID 为 1234567 的运行。

aws omics delete-run \
    --id 1234567

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteRun。

以下代码示例演示了如何使用 delete-sequence-store。

AWS CLI

删除序列存储

以下 delete-sequence-store 示例删除了 ID 为 1234567890 的序列存储。

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 delete-share。

AWS CLI

删除 HealthOmics 分析数据共享

以下 delete-share 示例删除了分析数据的跨账户共享。

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

输出：

{
    "status": "DELETING"
}

有关更多信息，请参阅《AWS HealthOmics 用户指南》中的跨账户共享。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteShare。

以下代码示例演示了如何使用 delete-variant-store。

AWS CLI

删除变体存储

以下 delete-variant-store 示例删除了名为 my_var_store 的变体存储。

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

输出：

{
    "status": "DELETING"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteVariantStore。

以下代码示例演示了如何使用 delete-workflow。

AWS CLI

删除工作流

以下 delete-workflow 示例删除了 ID 为 1234567 的工作流。

aws omics delete-workflow \
    --id 1234567

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 DeleteWorkflow。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 用户指南》中的创建注释存储的新版本。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetAnnotationStore。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetReadSetMetadata。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetReadSet。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetReferenceStore。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetReference。

以下代码示例演示了如何使用 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": {}
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetRunGroup。

以下代码示例演示了如何使用 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"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetRunTask。

以下代码示例演示了如何使用 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"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetRun。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetSequenceStore。

以下代码示例演示了如何使用 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 用户指南》中的跨账户共享。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetShare。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetVariantStore。

以下代码示例演示了如何使用 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"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 GetWorkflow。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 用户指南》中的创建注释存储的新版本。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListReadSets。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListReferences。

以下代码示例演示了如何使用 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"
        }
    ]
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListRunGroups。

以下代码示例演示了如何使用 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"
        }
    ]
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListRunTasks。

以下代码示例演示了如何使用 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"
        }
    ]
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListRuns。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListSequenceStores。

以下代码示例演示了如何使用 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 用户指南》中的跨账户共享。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListShares。

以下代码示例演示了如何使用 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 开发人员指南》中的在 Amazon Omics 中标记资源。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListVariantStores。

以下代码示例演示了如何使用 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"
        }
    ]
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 ListWorkflows。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 start-read-set-activation-job。

AWS CLI

激活已存档的读取集

以下 start-read-set-activation-job 示例激活了两个读取集。

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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 start-read-set-export-job。

AWS CLI

导出读取集

以下 start-read-set-export-job 示例将两个读取集导出到 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

以下代码示例演示了如何使用 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": {}
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

从 Amazon Omics 加载源文件

您还可以使用特定于服务的 URI 从 Amazon Omics 存储服务加载源文件。以下示例 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"
}

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 StartRun。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 开发人员指南》中的在 Amazon Omics 中标记资源。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 TagResource。

以下代码示例演示了如何使用 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 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UntagResource。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

以下代码示例演示了如何使用 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 开发人员指南》中的组学流程预置扩缩功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UpdateRunGroup。

以下代码示例演示了如何使用 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 开发人员指南》中的组学分析功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UpdateVariantStore。

以下代码示例演示了如何使用 update-workflow。

AWS CLI

更新工作流

以下 update-workflow 示例更新了 ID 为 1234567 的工作流的描述。

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

有关更多信息，请参阅《Amazon Omics 开发人员指南》中的组学存储功能。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UpdateWorkflow。

以下代码示例演示了如何使用 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 用户指南》中的直接上传到序列存储。

  • 有关 API 详细信息，请参阅《AWS CLI 命令参考》中的 UploadReadSetPart。