

# 使用 AWS CLI 的 HealthImaging 示例
<a name="cli_medical-imaging_code_examples"></a>

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

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

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

**Topics**
+ [操作](#actions)

## 操作
<a name="actions"></a>

### `copy-image-set`
<a name="medical-imaging_CopyImageSet_cli_topic"></a>

以下代码示例演示了如何使用 `copy-image-set`。

**AWS CLI**  
**示例 1：复制没有目标的图像集**  
以下 `copy-image-set` 示例制作没有目标的图像集的副本。  

```
aws medical-imaging copy-image-set \
    --datastore-id 12345678901234567890123456789012 \
    --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" } }'
```
输出：  

```
{
    "destinationImageSetProperties": {
        "latestVersionId": "2",
        "imageSetWorkflowStatus": "COPYING",
        "updatedAt": 1680042357.432,
        "imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
        "imageSetState": "LOCKED",
        "createdAt": 1680042357.432
    },
    "sourceImageSetProperties": {
        "latestVersionId": "1",
        "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
        "updatedAt": 1680042357.432,
        "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
        "imageSetState": "LOCKED",
        "createdAt": 1680027126.436
    },
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 2：复制带有目标的图像集**  
以下 `copy-image-set` 示例制作带有目标的图像集的副本。  

```
aws medical-imaging copy-image-set \
    --datastore-id 12345678901234567890123456789012 \
    --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1" }, "destinationImageSet": { "imageSetId": "b9a06fef182a5f992842f77f8e0868e5", "latestVersionId": "1"} }'
```
输出：  

```
{
    "destinationImageSetProperties": {
        "latestVersionId": "2",
        "imageSetWorkflowStatus": "COPYING",
        "updatedAt": 1680042505.135,
        "imageSetId": "b9a06fef182a5f992842f77f8e0868e5",
        "imageSetState": "LOCKED",
        "createdAt": 1680042357.432
    },
    "sourceImageSetProperties": {
        "latestVersionId": "1",
        "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
        "updatedAt": 1680042505.135,
        "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
        "imageSetState": "LOCKED",
        "createdAt": 1680027126.436
    },
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 3：将实例子集从源图像集复制到目标图像集**  
以下 `copy-image-set` 示例将一个 DICOM 实例从源图像集复制到目标图像集。提供 force 参数是为了覆盖“患者”、“研究”和“系列”级别属性中的不一致。  

```
aws medical-imaging copy-image-set \
    --datastore-id 12345678901234567890123456789012 \
    --source-image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --copy-image-set-information '{"sourceImageSet": {"latestVersionId": "1","DICOMCopies": {"copiableAttributes": "{\"SchemaVersion\":\"1.1\",\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3666.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3673257865.2104868982.1369432891697.3669.0\":{}}}}}}"}},"destinationImageSet": {"imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7","latestVersionId": "1"}}' \
    --force
```
输出：  

```
{
    "destinationImageSetProperties": {
        "latestVersionId": "2",
        "imageSetWorkflowStatus": "COPYING",
        "updatedAt": 1680042505.135,
        "imageSetId": "b9eb50d8ee682eb9fcf4acbf92f62bb7",
        "imageSetState": "LOCKED",
        "createdAt": 1680042357.432
    },
    "sourceImageSetProperties": {
        "latestVersionId": "1",
        "imageSetWorkflowStatus": "COPYING_WITH_READ_ONLY_ACCESS",
        "updatedAt": 1680042505.135,
        "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
        "imageSetState": "LOCKED",
        "createdAt": 1680027126.436
    },
    "datastoreId": "12345678901234567890123456789012"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[复制图像集](https://docs.aws.amazon.com/healthimaging/latest/devguide/copy-image-set.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [CopyImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/copy-image-set.html)。

### `create-datastore`
<a name="medical-imaging_CreateDatastore_cli_topic"></a>

以下代码示例演示了如何使用 `create-datastore`。

**AWS CLI**  
**示例 1：创建数据存储**  
以下 `create-datastore` 代码示例创建名称为 `my-datastore` 的数据存储。当您在不指定 `--lossless-storage-format` 的情况下创建数据存储时，AWS HealthImaging 默认采用 HTJ2K（高吞吐量 JPEG 2000）。  

```
aws medical-imaging create-datastore \
    --datastore-name "my-datastore"
```
输出：  

```
{
    "datastoreId": "12345678901234567890123456789012",
    "datastoreStatus": "CREATING"
}
```
**示例 2：采用 JPEG 2000 无损存储格式创建数据存储**  
使用 JPEG 2000 无损存储格式配置的数据存储将会转码并以 JPEG 2000 格式保存无损图像帧。然后，无需转码即可在 JPEG 2000 无损存储中检索图像帧。以下 `create-datastore` 代码示例创建配置为 JPEG 2000 无损存储格式的数据存储，其名称为 `my-datastore`。  

```
aws medical-imaging create-datastore \
    --datastore-name "my-datastore" \
    --lossless-storage-format JPEG_2000_LOSSLESS
```
输出：  

```
{
    "datastoreId": "12345678901234567890123456789012",
    "datastoreStatus": "CREATING"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[创建数据存储](https://docs.aws.amazon.com/healthimaging/latest/devguide/create-data-store.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [CreateDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/create-datastore.html)。

### `delete-datastore`
<a name="medical-imaging_DeleteDatastore_cli_topic"></a>

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

**AWS CLI**  
**删除数据存储**  
以下 `delete-datastore` 代码示例可删除数据存储。  

```
aws medical-imaging delete-datastore \
    --datastore-id "12345678901234567890123456789012"
```
输出：  

```
{
    "datastoreId": "12345678901234567890123456789012",
    "datastoreStatus": "DELETING"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[删除数据存储](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-data-store.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeleteDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-datastore.html)。

### `delete-image-set`
<a name="medical-imaging_DeleteImageSet_cli_topic"></a>

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

**AWS CLI**  
**删除图像集**  
以下 `delete-image-set` 代码示例删除图像集。  

```
aws medical-imaging delete-image-set \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
输出：  

```
{
    "imageSetWorkflowStatus": "DELETING",
    "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
    "imageSetState": "LOCKED",
    "datastoreId": "12345678901234567890123456789012"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[删除图像集](https://docs.aws.amazon.com/healthimaging/latest/devguide/delete-image-set.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [DeleteImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/delete-image-set.html)。

### `get-datastore`
<a name="medical-imaging_GetDatastore_cli_topic"></a>

以下代码示例演示了如何使用 `get-datastore`。

**AWS CLI**  
**示例 1：获取数据存储的属性**  
以下 `get-datastore` 代码示例可获取数据存储的属性。  

```
aws medical-imaging get-datastore \
    --datastore-id 12345678901234567890123456789012
```
输出：  

```
{
    "datastoreProperties": {
        "datastoreId": "12345678901234567890123456789012",
        "datastoreName": "TestDatastore123",
        "datastoreStatus": "ACTIVE",
        "losslessStorageFormat": "HTJ2K"
        "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
        "createdAt": "2022-11-15T23:33:09.643000+00:00",
        "updatedAt": "2022-11-15T23:33:09.643000+00:00"
    }
}
```
**示例 2：获取配置为 JPEG2000 的数据存储的属性**  
以下 `get-datastore` 代码示例获取配置为 JPEG 2000 无损存储格式的数据存储的属性。  

```
aws medical-imaging get-datastore \
    --datastore-id 12345678901234567890123456789012
```
输出：  

```
{
    "datastoreProperties": {
        "datastoreId": "12345678901234567890123456789012",
        "datastoreName": "TestDatastore123",
        "datastoreStatus": "ACTIVE",
        "losslessStorageFormat": "JPEG_2000_LOSSLESS",
        "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
        "createdAt": "2022-11-15T23:33:09.643000+00:00",
        "updatedAt": "2022-11-15T23:33:09.643000+00:00"
    }
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[获取数据存储属性](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-data-store.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-datastore.html)。

### `get-dicom-import-job`
<a name="medical-imaging_GetDICOMImportJob_cli_topic"></a>

以下代码示例演示了如何使用 `get-dicom-import-job`。

**AWS CLI**  
**获取 dicom 导入作业的属性**  
以下 `get-dicom-import-job` 代码示例获取 dicom 导入作业的属性。  

```
aws medical-imaging get-dicom-import-job \
    --datastore-id "12345678901234567890123456789012" \
    --job-id "09876543210987654321098765432109"
```
输出：  

```
{
    "jobProperties": {
        "jobId": "09876543210987654321098765432109",
        "jobName": "my-job",
        "jobStatus": "COMPLETED",
        "datastoreId": "12345678901234567890123456789012",
        "dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
        "endedAt": "2022-08-12T11:29:42.285000+00:00",
        "submittedAt": "2022-08-12T11:28:11.152000+00:00",
        "inputS3Uri": "s3://medical-imaging-dicom-input/dicom_input/",
        "outputS3Uri": "s3://medical-imaging-output/job_output/12345678901234567890123456789012-DicomImport-09876543210987654321098765432109/"
    }
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[获取导入作业属性](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-dicom-import-job.html)。  
+  有关 API 详细信息，请参阅*《AWS CLI 命令参考》*中的 [GetDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-dicom-import-job.html)。

### `get-image-frame`
<a name="medical-imaging_GetImageFrame_cli_topic"></a>

以下代码示例演示了如何使用 `get-image-frame`。

**AWS CLI**  
**获取图像集像素数据**  
以下 `get-image-frame` 代码示例获取图像帧。  

```
aws medical-imaging get-image-frame \
    --datastore-id "12345678901234567890123456789012" \
    --image-set-id "98765412345612345678907890789012" \
    --image-frame-information imageFrameId=3abf5d5d7ae72f80a0ec81b2c0de3ef4 \
    imageframe.jph
```
注意：此代码示例不包括输出，因为 GetImageFrame 操作会向 imageframe.jph 文件返回像素数据流。有关解码和查看图像帧的信息，请参阅 HTJ2K 解码库。  
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[获取图像集像素数据](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-frame.html)。  
+  有关 API 详细信息，请参阅*《AWS CLI 命令参考*》中的 [GetImageFrame](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-frame.html)。

### `get-image-set-metadata`
<a name="medical-imaging_GetImageSetMetadata_cli_topic"></a>

以下代码示例演示了如何使用 `get-image-set-metadata`。

**AWS CLI**  
**示例 1：获取没有版本的图像集元数据**  
以下 `get-image-set-metadata` 代码示例获取未指定版本的图像集的元数据。  
注意：`outfile` 是必需的参数。  

```
aws medical-imaging get-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    studymetadata.json.gz
```
返回的元数据使用 gzip 压缩并存储在 studymetadata.json.gz 文件中。要查看返回的 JSON 对象的内容，必须先将其解压。  
输出：  

```
{
    "contentType": "application/json",
    "contentEncoding": "gzip"
}
```
**示例 2：获取带有版本的图像集元数据**  
以下 `get-image-set-metadata` 代码示例获取指定版本的图像集的元数据。  
注意：`outfile` 是必需的参数。  

```
aws medical-imaging get-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --version-id 1 \
    studymetadata.json.gz
```
返回的元数据使用 gzip 压缩并存储在 studymetadata.json.gz 文件中。要查看返回的 JSON 对象的内容，必须先将其解压。  
输出：  

```
{
    "contentType": "application/json",
    "contentEncoding": "gzip"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[获取图像集元数据](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-metadata.html)。  
+  有关 API 详细信息，请参阅*《AWS CLI 命令参考》*中的 [GetImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set-metadata.html)。

### `get-image-set`
<a name="medical-imaging_GetImageSet_cli_topic"></a>

以下代码示例演示了如何使用 `get-image-set`。

**AWS CLI**  
**获取图像集属性**  
以下 `get-image-set` 代码示例可获取图像集的属性。  

```
aws medical-imaging get-image-set \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id 18f88ac7870584f58d56256646b4d92b \
    --version-id 1
```
输出：  

```
{
    "versionId": "1",
    "imageSetWorkflowStatus": "COPIED",
    "updatedAt": 1680027253.471,
    "imageSetId": "18f88ac7870584f58d56256646b4d92b",
    "imageSetState": "ACTIVE",
    "createdAt": 1679592510.753,
    "datastoreId": "12345678901234567890123456789012"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[获取映像集属性](https://docs.aws.amazon.com/healthimaging/latest/devguide/get-image-set-properties.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [GetImageSet](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/get-image-set.html)。

### `list-datastores`
<a name="medical-imaging_ListDatastores_cli_topic"></a>

以下代码示例演示了如何使用 `list-datastores`。

**AWS CLI**  
**列出数据存储**  
以下 `list-datastores` 代码示例列出可用的数据存储。  

```
aws medical-imaging list-datastores
```
输出：  

```
{
    "datastoreSummaries": [
        {
            "datastoreId": "12345678901234567890123456789012",
            "datastoreName": "TestDatastore123",
            "datastoreStatus": "ACTIVE",
            "datastoreArn": "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012",
            "createdAt": "2022-11-15T23:33:09.643000+00:00",
            "updatedAt": "2022-11-15T23:33:09.643000+00:00"
        }
    ]
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[列出数据存储](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-data-stores.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [ListDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-datastores.html)。

### `list-dicom-import-jobs`
<a name="medical-imaging_ListDICOMImportJobs_cli_topic"></a>

以下代码示例演示了如何使用 `list-dicom-import-jobs`。

**AWS CLI**  
**列出 dicom 导入作业**  
以下 `list-dicom-import-jobs` 代码示例列出 dicom 导入作业。  

```
aws medical-imaging list-dicom-import-jobs \
    --datastore-id "12345678901234567890123456789012"
```
输出：  

```
{
    "jobSummaries": [
        {
            "jobId": "09876543210987654321098765432109",
            "jobName": "my-job",
            "jobStatus": "COMPLETED",
            "datastoreId": "12345678901234567890123456789012",
            "dataAccessRoleArn": "arn:aws:iam::123456789012:role/ImportJobDataAccessRole",
            "endedAt": "2022-08-12T11:21:56.504000+00:00",
            "submittedAt": "2022-08-12T11:20:21.734000+00:00"
        }
    ]
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[列出导入作业](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-dicom-import-jobs.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [ListDICOMImportJobs](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-dicom-import-jobs.html)。

### `list-image-set-versions`
<a name="medical-imaging_ListImageSetVersions_cli_topic"></a>

以下代码示例演示了如何使用 `list-image-set-versions`。

**AWS CLI**  
**列出图像集版本**  
以下 `list-image-set-versions` 代码示例列出了图像集的版本历史记录。  

```
aws medical-imaging list-image-set-versions \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e
```
输出：  

```
{
    "imageSetPropertiesList": [
        {
            "ImageSetWorkflowStatus": "UPDATED",
            "versionId": "4",
            "updatedAt": 1680029436.304,
            "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
            "imageSetState": "ACTIVE",
            "createdAt": 1680027126.436
        },
        {
            "ImageSetWorkflowStatus": "UPDATED",
            "versionId": "3",
            "updatedAt": 1680029163.325,
            "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
            "imageSetState": "ACTIVE",
            "createdAt": 1680027126.436
        },
        {
            "ImageSetWorkflowStatus": "COPY_FAILED",
            "versionId": "2",
            "updatedAt": 1680027455.944,
            "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
            "imageSetState": "ACTIVE",
            "message": "INVALID_REQUEST:  Series of SourceImageSet and DestinationImageSet don't match.",
            "createdAt": 1680027126.436
        },
        {
            "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
            "imageSetState": "ACTIVE",
            "versionId": "1",
            "ImageSetWorkflowStatus": "COPIED",
            "createdAt": 1680027126.436
        }
    ]
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[列出图像集版本](https://docs.aws.amazon.com/healthimaging/latest/devguide/list-image-set-versions.html)。  
+  有关 API 详细信息，请参阅*《AWS CLI 命令参考》*中的 [ListImageSetVersions](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-image-set-versions.html)。

### `list-tags-for-resource`
<a name="medical-imaging_ListTagsForResource_cli_topic"></a>

以下代码示例演示了如何使用 `list-tags-for-resource`。

**AWS CLI**  
**示例 1：列出数据存储的资源标签**  
以下 `list-tags-for-resource` 代码示例列出数据存储的标签。  

```
aws medical-imaging list-tags-for-resource \
    --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012"
```
输出：  

```
{
    "tags":{
        "Deployment":"Development"
    }
}
```
**例 2：列出图像集的资源标签**  
以下 `list-tags-for-resource` 代码示例列出图像集的标签。  

```
aws medical-imaging list-tags-for-resource \
    --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b"
```
输出：  

```
{
    "tags":{
        "Deployment":"Development"
    }
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[标记 AWS HealthImaging 中的资源](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/list-tags-for-resource.html)。

### `search-image-sets`
<a name="medical-imaging_SearchImageSets_cli_topic"></a>

以下代码示例演示了如何使用 `search-image-sets`。

**AWS CLI**  
**示例 1：使用 EQUAL 运算符搜索图像集**  
以下 `search-image-sets` 代码示例使用 EQUAL 运算符根据特定值搜索图像集。  

```
aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria file://search-criteria.json
```
`search-criteria.json` 的内容  

```
{
    "filters": [{
        "values": [{"DICOMPatientId" : "SUBJECT08701"}],
        "operator": "EQUAL"
    }]
}
```
输出：  

```
{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
             "DICOMPatientSex": "F",
             "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
             "DICOMPatientBirthDate": "19201120",
             "DICOMStudyDescription": "UNKNOWN",
             "DICOMPatientId": "SUBJECT08701",
             "DICOMPatientName": "Melissa844 Huel628",
             "DICOMNumberOfStudyRelatedInstances": 1,
             "DICOMStudyTime": "140728",
             "DICOMNumberOfStudyRelatedSeries": 1
            },
        "updatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}
```
**例 2：使用 DICOMStudyDate 和 DICOMStudyTime，通过 BETWEEN 运算符搜索图像集**  
以下 `search-image-sets` 代码示例搜索在 1990 年 1 月 1 日（12:00 AM）至 2023 年 1 月 1 日（12:00 AM）之间生成的 DICOM 研究的图像集。  
注意：DICOMStudyTime 为可选项。如果不存在，则上午 12:00（一天的开始）是提供用于筛选的日期的时间值。  

```
aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria file://search-criteria.json
```
`search-criteria.json` 的内容  

```
{
    "filters": [{
        "values": [{
            "DICOMStudyDateAndTime": {
                "DICOMStudyDate": "19900101",
                "DICOMStudyTime": "000000"
            }
        },
        {
            "DICOMStudyDateAndTime": {
                "DICOMStudyDate": "20230101",
                "DICOMStudyTime": "000000"
            }
        }],
        "operator": "BETWEEN"
    }]
}
```
输出：  

```
{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "updatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}
```
**例 3：使用 CreatedAt，通过 BETWEEN 运算符搜索图像集（之前保留了时间研究）**  
以下 `search-image-sets` 代码示例在 UTC 时区的时间范围内搜索 HealthImaging 中保存的 DICOM 研究的图像集。  
注意：采用示例中的格式（"1985-04-12T23:20:50.52Z"）提供 createdAt。  

```
aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria  file://search-criteria.json
```
`search-criteria.json` 的内容  

```
{
    "filters": [{
        "values": [{
            "createdAt": "1985-04-12T23:20:50.52Z"
        },
        {
            "createdAt": "2022-04-12T23:20:50.52Z"
        }],
        "operator": "BETWEEN"
    }]
}
```
输出：  

```
{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}
```
**示例 4：通过对 DICOMSeriesInstanceUID 使用 EQUAL 运算符，对 updatedAt 使用 BETWEEN 运算符并对 updatedAt 字段按照 ASC 顺序排序响应来搜索图像集**  
以下 `search-image-sets` 代码示例通过对 DICOMSeriesInstanceUID 使用 EQUAL 运算符，对 updatedAt 使用 BETWEEN 运算符并对 updatedAt 字段按照 ASC 顺序排序响应来搜索图像集。  
注意：采用示例中的格式（"1985-04-12T23:20:50.52Z"）提供 updatedAt。  

```
aws medical-imaging search-image-sets \
    --datastore-id 12345678901234567890123456789012 \
    --search-criteria  file://search-criteria.json
```
`search-criteria.json` 的内容  

```
{
    "filters": [{
        "values": [{
            "updatedAt": "2024-03-11T15:00:05.074000-07:00"
        }, {
            "updatedAt": "2024-03-11T16:00:05.074000-07:00"
        }],
        "operator": "BETWEEN"
    }, {
        "values": [{
            "DICOMSeriesInstanceUID": "1.2.840.99999999.84710745.943275268089"
        }],
        "operator": "EQUAL"
    }],
    "sort": {
        "sortField": "updatedAt",
        "sortOrder": "ASC"
    }
}
```
输出：  

```
{
    "imageSetsMetadataSummaries": [{
        "imageSetId": "09876543210987654321098765432109",
        "createdAt": "2022-12-06T21:40:59.429000+00:00",
        "version": 1,
        "DICOMTags": {
            "DICOMStudyId": "2011201407",
            "DICOMStudyDate": "19991122",
            "DICOMPatientSex": "F",
            "DICOMStudyInstanceUID": "1.2.840.99999999.84710745.943275268089",
            "DICOMPatientBirthDate": "19201120",
            "DICOMStudyDescription": "UNKNOWN",
            "DICOMPatientId": "SUBJECT08701",
            "DICOMPatientName": "Melissa844 Huel628",
            "DICOMNumberOfStudyRelatedInstances": 1,
            "DICOMStudyTime": "140728",
            "DICOMNumberOfStudyRelatedSeries": 1
        },
        "lastUpdatedAt": "2022-12-06T21:40:59.429000+00:00"
    }]
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[搜索图像集](https://docs.aws.amazon.com/healthimaging/latest/devguide/search-image-sets.html)。  
+  有关 API 详细信息，请参阅*《AWS CLI 命令参考》*中的 [SearchImageSets](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/search-image-sets.html)。

### `start-dicom-import-job`
<a name="medical-imaging_StartDICOMImportJob_cli_topic"></a>

以下代码示例演示了如何使用 `start-dicom-import-job`。

**AWS CLI**  
**启动 dicom 导入作业**  
以下 `start-dicom-import-job` 代码示例启动 dicom 导入作业。  

```
aws medical-imaging start-dicom-import-job \
    --job-name "my-job" \
    --datastore-id "12345678901234567890123456789012" \
    --input-s3-uri "s3://medical-imaging-dicom-input/dicom_input/" \
    --output-s3-uri "s3://medical-imaging-output/job_output/" \
    --data-access-role-arn "arn:aws:iam::123456789012:role/ImportJobDataAccessRole"
```
输出：  

```
{
    "datastoreId": "12345678901234567890123456789012",
    "jobId": "09876543210987654321098765432109",
    "jobStatus": "SUBMITTED",
    "submittedAt": "2022-08-12T11:28:11.152000+00:00"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[启动导入作业](https://docs.aws.amazon.com/healthimaging/latest/devguide/start-dicom-import-job.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [StartDICOMImportJob](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/start-dicom-import-job.html)。

### `tag-resource`
<a name="medical-imaging_TagResource_cli_topic"></a>

以下代码示例演示了如何使用 `tag-resource`。

**AWS CLI**  
**示例 1：标记数据存储**  
以下 `tag-resource` 代码示例可标记数据存储。  

```
aws medical-imaging tag-resource \
  --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
  --tags '{"Deployment":"Development"}'
```
此命令不生成任何输出。  
**例 2：标记图像集**  
以下 `tag-resource` 代码示例可标记图像集。  

```
aws medical-imaging tag-resource \
    --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
    --tags '{"Deployment":"Development"}'
```
此命令不生成任何输出。  
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[标记 AWS HealthImaging 中的资源](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/tag-resource.html)。

### `untag-resource`
<a name="medical-imaging_UntagResource_cli_topic"></a>

以下代码示例演示了如何使用 `untag-resource`。

**AWS CLI**  
**示例 1：取消标记数据存储**  
以下 `untag-resource` 代码示例可取消标记数据存储。  

```
aws medical-imaging untag-resource \
    --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012" \
    --tag-keys '["Deployment"]'
```
此命令不生成任何输出。  
**例 2：取消标记图像集**  
以下 `untag-resource` 代码示例可取消标记图像集。  

```
aws medical-imaging untag-resource \
    --resource-arn "arn:aws:medical-imaging:us-east-1:123456789012:datastore/12345678901234567890123456789012/imageset/18f88ac7870584f58d56256646b4d92b" \
    --tag-keys '["Deployment"]'
```
此命令不生成任何输出。  
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[标记 AWS HealthImaging 中的资源](https://docs.aws.amazon.com/healthimaging/latest/devguide/tagging.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/untag-resource.html)。

### `update-image-set-metadata`
<a name="medical-imaging_UpdateImageSetMetadata_cli_topic"></a>

以下代码示例演示了如何使用 `update-image-set-metadata`。

**AWS CLI**  
**示例 1：在图像集元数据中插入或更新属性**  
以下 `update-image-set-metadata` 示例在图像集元数据中插入或更新属性。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --latest-version-id 1 \
    --cli-binary-format raw-in-base64-out \
    --update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "updatableAttributes": "{\"SchemaVersion\":1.1,\"Patient\":{\"DICOM\":{\"PatientName\":\"MX^MX\"}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 2：从图像集元数据中删除属性**  
以下 `update-image-set-metadata` 示例从图像集元数据中删除属性。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --latest-version-id 1 \
    --cli-binary-format raw-in-base64-out \
    --update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "removableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"DICOM\":{\"StudyDescription\":\"CHEST\"}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 3：从图像集元数据中删除实例**  
以下 `update-image-set-metadata` 示例从图像集元数据中删除实例。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id ea92b0d8838c72a3f25d00d13616f87e \
    --latest-version-id 1 \
    --cli-binary-format raw-in-base64-out \
    --update-image-set-metadata-updates file://metadata-updates.json \
    --force
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "removableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {}}}}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "ea92b0d8838c72a3f25d00d13616f87e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 4：将图像集恢复到以前的版本**  
以下 `update-image-set-metadata` 示例演示如何将图像集恢复到以前的版本。CopyImageSet 和 UpdateImageSetMetadata 操作可创建图像集的新版本。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
    --latest-version-id 3 \
    --cli-binary-format raw-in-base64-out \
    --update-image-set-metadata-updates '{"revertToVersionId": "1"}'
```
输出：  

```
{
    "datastoreId": "12345678901234567890123456789012",
    "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
    "latestVersionId": "4",
    "imageSetState": "LOCKED",
    "imageSetWorkflowStatus": "UPDATING",
    "createdAt": 1680027126.436,
    "updatedAt": 1680042257.908
}
```
**示例 5：向实例添加私有 DICOM 数据元素**  
以下 `update-image-set-metadata` 示例演示如何将私有元素添加到图像集中的指定实例。DICOM 标准允许将私有数据元素用于通信标准数据元素中无法包含的信息。您可以使用 UpdateImageSetMetadata 操作来创建、更新和删除私有数据元素。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
    --latest-version-id 1 \
    --cli-binary-format raw-in-base64-out \
    --force \
    --update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"001910F9\": \"97\"},\"DICOMVRs\": {\"001910F9\": \"DS\"}}}}}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 6：更新实例的私有 DICOM 数据元素**  
以下 `update-image-set-metadata` 示例演示如何更新属于图像集内某个实例的私有数据元素的值。  

```
aws medical-imaging update-image-set-metadata \
    --datastore-id 12345678901234567890123456789012 \
    --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
    --latest-version-id 1 \
    --cli-binary-format raw-in-base64-out \
    --force \
    --update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "updatableAttributes": "{\"SchemaVersion\": 1.1,\"Study\": {\"Series\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"Instances\": {\"1.1.1.1.1.1.12345.123456789012.123.12345678901234.1\": {\"DICOM\": {\"00091001\": \"GE_GENESIS_DD\"}}}}}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
**示例 7：使用 force 参数更新 SOPInstanceUID**  
以下 `update-image-set-metadata` 示例演示如何通过使用 force 参数覆盖 DICOM 元数据约束来更新 SOPInstanceUID。  

```
aws medical-imaging update-image-set-metadata \
        --datastore-id 12345678901234567890123456789012 \
        --image-set-id 53d5fdb05ca4d46ac7ca64b06545c66e \
        --latest-version-id 1 \
        --cli-binary-format raw-in-base64-out \
        --force \
        --update-image-set-metadata-updates file://metadata-updates.json
```
`metadata-updates.json` 的内容  

```
{
    "DICOMUpdates": {
        "updatableAttributes": "{\"SchemaVersion\":1.1,\"Study\":{\"Series\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3656.0\":{\"Instances\":{\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.0\":{\"DICOM\":{\"SOPInstanceUID\":\"1.3.6.1.4.1.5962.99.1.3633258862.2104868982.1369432891697.3659.9\"}}}}}}}"
    }
}
```
输出：  

```
{
    "latestVersionId": "2",
    "imageSetWorkflowStatus": "UPDATING",
    "updatedAt": 1680042257.908,
    "imageSetId": "53d5fdb05ca4d46ac7ca64b06545c66e",
    "imageSetState": "LOCKED",
    "createdAt": 1680027126.436,
    "datastoreId": "12345678901234567890123456789012"
}
```
有关更多信息，请参阅《AWS HealthImaging 开发人员指南》**中的[更新图像集元数据](https://docs.aws.amazon.com/healthimaging/latest/devguide/update-image-set-metadata.html)。  
+  有关 API 详细信息，请参阅《AWS CLI 命令参考》**中的 [UpdateImageSetMetadata](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/medical-imaging/update-image-set-metadata.html)。