HealthLake 使用 的範例 AWS CLI - AWS Command Line Interface
動作

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

HealthLake 使用 的範例 AWS CLI

下列程式碼範例示範如何使用 AWS Command Line Interface 搭配 來執行動作和實作常見案例 HealthLake。

Actions 是大型程式的程式碼摘錄，必須在內容中執行。雖然動作會示範如何呼叫個別服務函數，但您可以在其相關案例中查看內容中的動作。

每個範例都包含完整原始程式碼的連結，您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例示範如何使用 create-fhir-datastore。

AWS CLI

建立 FHIR Data Store。

下列create-fhir-datastore範例示範如何在 Amazon 中建立新的 Data Store HealthLake。

aws healthlake create-fhir-datastore \
    --region us-east-1 \
    --datastore-type-version R4 \
    --datastore-type-version R4 \
    --datastore-name "FhirTestDatastore"

輸出：

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
    "DatastoreStatus": "CREATING",
    "DatastoreId": "(Datastore ID)"
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的建立和監控FHIR資料存放區。

下列程式碼範例示範如何使用 delete-fhir-datastore。

AWS CLI

刪除FHIR資料存放區

下列delete-fhir-datastore範例示範如何在 Amazon 中刪除 Data Store 及其所有內容 HealthLake。

aws healthlake delete-fhir-datastore \
    --datastore-id (Data Store ID) \
    --region us-east-1

輸出：

{
    "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
    "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
    "DatastoreStatus": "DELETING",
    "DatastoreId": "(Datastore ID)"
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的建立和監控 FHIR Data Store <https://docs.aws.amazon.com/healthlake/latest/devguide/working-withFHIR--healthlake.html>。

下列程式碼範例示範如何使用 describe-fhir-datastore。

AWS CLI

描述 FHIR Data Store

下列describe-fhir-datastore範例示範如何在 Amazon 中尋找 Data Store 的屬性 HealthLake。

aws healthlake describe-fhir-datastore \
    --datastore-id "1f2f459836ac6c513ce899f9e4f66a59" \
    --region us-east-1

輸出：

{
    "DatastoreProperties": {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "DatastoreName": "FhirTestDatastore",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Datastore ID)",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Datastore ID)/r4/",
        "DatastoreStatus": "CREATING",
        "DatastoreTypeVersion": "R4",
        "DatastoreId": "(Datastore ID)"
    }
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的建立和監控FHIR資料存放區。

下列程式碼範例示範如何使用 describe-fhir-export-job。

AWS CLI

描述FHIR匯出任務

下列describe-fhir-export-job範例示範如何在 Amazon 中尋找FHIR匯出任務的屬性 HealthLake。

aws healthlake describe-fhir-export-job \
    --datastore-id (Datastore ID) \
    --job-id 9b9a51943afaedd0a8c0c26c49135a31

輸出：

{
    "ExportJobProperties": {
        "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
        "JobStatus": "IN_PROGRESS",
        "JobId": "9009813e9d69ba7cf79bcb3468780f16",
        "SubmitTime": 1609175692.715,
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/59593b2d0367ce252b5e66bf5fd6b574-FHIR_EXPORT-9009813e9d69ba7cf79bcb3468780f16/"
        },
        "DatastoreId": "(Datastore ID)"
    }
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的從FHIR資料存放區匯出檔案。

下列程式碼範例示範如何使用 describe-fhir-import-job。

AWS CLI

描述FHIR匯入任務

下列describe-fhir-import-job範例示範如何使用 Amazon 學習FHIR匯入任務的屬性 HealthLake。

aws healthlake describe-fhir-import-job \
    --datastore-id (Datastore ID) \
    --job-id c145fbb27b192af392f8ce6e7838e34f \
    --region us-east-1

輸出：

{
    "ImportJobProperties": {
    "InputDataConfig": {
        "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
        { "arrayitem2": 2 }
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Datastore ID)"
    }
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的將檔案匯入FHIR資料存放區。

下列程式碼範例示範如何使用 list-fhir-datastores。

AWS CLI

列出FHIR資料存放區

下列list-fhir-datastores範例顯示如何使用 命令，以及使用者如何根據 Amazon 中的 Data Store 狀態篩選結果 HealthLake。

aws healthlake list-fhir-datastores \
    --region us-east-1 \
    --filter DatastoreStatus=ACTIVE

輸出：

{
    "DatastorePropertiesList": [
    {
        "PreloadDataConfig": {
            "PreloadDataType": "SYNTHEA"
        },
        "DatastoreName": "FhirTestDatastore",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1605574003.209,
        "DatastoreId": "<Datastore ID>"
    },
    {
        "DatastoreName": "Demo",
        "DatastoreArn": "arn:aws:healthlake:us-east-1:<AWS Account ID>:datastore/<Datastore ID>",
        "DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/<Datastore ID>/r4/",
        "DatastoreStatus": "ACTIVE",
        "DatastoreTypeVersion": "R4",
        "CreatedAt": 1603761064.881,
        "DatastoreId": "<Datastore ID>"
    }
    ]
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的建立和監控FHIR資料存放區。

下列程式碼範例示範如何使用 list-fhir-export-jobs。

AWS CLI

列出所有FHIR匯出任務

下列list-fhir-export-jobs範例示範如何使用 命令來檢視與帳戶相關聯的匯出任務清單。

aws healthlake list-fhir-export-jobs \
    --datastore-id (Datastore ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z)\
    --submitted-after (DATE like 2020-10-13T19:00:00Z )\
    --job-name "FHIR-EXPORT" \
    --job-status SUBMITTED  \
    --max-results (Integer between 1 and 500)

輸出：

{
    "ExportJobProperties": {
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/"
                "S3Configuration": {
                "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                "KmsKeyId" : "(KmsKey Id)"
        },
    },
    "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
    "JobStatus": "COMPLETED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f",
    "JobName" "FHIR-EXPORT",
    "SubmitTime": 1606272542.161,
    "EndTime": 1606272609.497,
    "DatastoreId": "(Datastore ID)"
    }
}
"NextToken": String

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南中的從 FHIR Data Store 匯出檔案。

下列程式碼範例示範如何使用 list-fhir-import-jobs。

AWS CLI

若要列出所有FHIR匯入任務

下列list-fhir-import-jobs範例示範如何使用 命令來檢視與帳戶相關聯的所有匯入任務清單。

aws healthlake list-fhir-import-jobs \
    --datastore-id (Datastore ID) \
    --submitted-before (DATE like 2024-10-13T19:00:00Z) \
    --submitted-after (DATE like 2020-10-13T19:00:00Z ) \
    --job-name "FHIR-IMPORT" \
    --job-status SUBMITTED  \
    -max-results (Integer between 1 and 500)

輸出：

{
    "ImportJobProperties": {
        "OutputDataConfig": {
            "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                "S3Configuration": {
                    "S3Uri": "s3://(Bucket Name)/(Prefix Name)/",
                    "KmsKeyId" : "(KmsKey Id)"
    },
    },
        "DataAccessRoleArn": "arn:aws:iam::(AWS Account ID):role/(Role Name)",
        "JobStatus": "COMPLETED",
        "JobId": "c145fbb27b192af392f8ce6e7838e34f",
        "JobName" "FHIR-IMPORT",
        "SubmitTime": 1606272542.161,
        "EndTime": 1606272609.497,
        "DatastoreId": "(Datastore ID)"
    }
}
"NextToken": String

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南中的將檔案匯入 FHIR Data Store。

下列程式碼範例示範如何使用 list-tags-for-resource。

AWS CLI

列出 Data Store 的標籤

下列list-tags-for-resource範例列出與指定 Data Store 相關聯的標籤。：

aws healthlake list-tags-for-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:674914422125:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --region us-east-1

輸出：

{
    "tags": {
        "key": "value",
        "key1": "value1"
    }
}

如需詳細資訊，請參閱 Amazon 開發人員指南中的在 Amazon 中標記資源 HealthLake。 HealthLake

下列程式碼範例示範如何使用 start-fhir-export-job。

AWS CLI

啟動FHIR匯出任務

下列start-fhir-export-job範例示範如何使用 Amazon 啟動FHIR匯出任務 HealthLake。

aws healthlake start-fhir-export-job \
    --output-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \
    --datastore-id (Datastore ID) \
    --data-access-role-arn arn:aws:iam::(AWS Account ID):role/(Role Name)

輸出：

{
    "DatastoreId": "(Datastore ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "9b9a51943afaedd0a8c0c26c49135a31"
}

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的從FHIR資料存放區匯出檔案。

下列程式碼範例示範如何使用 start-fhir-import-job。

AWS CLI

啟動FHIR匯入任務

下列start-fhir-import-job範例示範如何使用 Amazon 啟動FHIR匯入任務 HealthLake。

aws healthlake start-fhir-import-job \
    --input-data-config S3Uri="s3://(Bucket Name)/(Prefix Name)/" \
    --datastore-id (Datastore ID) \
    --data-access-role-arn "arn:aws:iam::(AWS Account ID):role/(Role Name)" \
    --region us-east-1

輸出：

{
    "DatastoreId": "(Datastore ID)",
    "JobStatus": "SUBMITTED",
    "JobId": "c145fbb27b192af392f8ce6e7838e34f"
}

如需詳細資訊，請參閱 Amazon HeatlhLake 開發人員指南 中的將檔案匯入 FHIR Data Store 'https://docs.aws.amazon.com/healthlake/latest/devguide/import-datastore.html。

下列程式碼範例示範如何使用 tag-resource。

AWS CLI

若要將標籤新增至 Data Store

下列tag-resource範例示範如何將標籤新增至 Data Store。

aws healthlake tag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:691207106566:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
    --tags '[{"Key": "key1", "Value": "value1"}]' \
    --region us-east-1

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon 開發人員指南中的「將標籤新增至 Data Store <https://docs.aws.amazon.com/healthlake/latest/devguide/add-a-tag.html>'__。 HealthLake

  • 如需API詳細資訊，請參閱 命令參考 TagResource中的 。 AWS CLI

下列程式碼範例示範如何使用 untag-resource。

AWS CLI

從 Data Store 移除標籤。

下列untag-resource範例示範如何從 Data Store 移除標籤。

aws healthlake untag-resource \
    --resource-arn "arn:aws:healthlake:us-east-1:674914422125:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \
    --tag-keys '["key1"]' \
    --region us-east-1

此命令不會產生輸出。

如需詳細資訊，請參閱 Amazon HealthLake 開發人員指南 中的從資料存放區移除標籤。

  • 如需API詳細資訊，請參閱 命令參考 UntagResource中的 。 AWS CLI