# Managing data stores with AWS HealthLake
With AWS HealthLake, you create and manage data stores for FHIR R4 resources. When you create a HealthLake data store, a FHIR data respository is made available via a RESTful API [endpoint](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints). You can choose to import (preload) Synthea open source FHIR R4 health data into your data store when you create it. For more information, see [Preloaded data types](reference-healthlake-preloaded-data-types.md).
**Important**
HealthLake supports two types of FHIR data store authorization strategies, AWS SigV4 or SMART on FHIR. You must choose one of the authorization strategies prior to creating a HealthLake FHIR data store. For more information, see [Data store authorization strategy](getting-started-concepts.md#concept-data-store-authorization-strategy).
To find the FHIR-related capabilities (behaviors) of an active HealthLake data store, retrieve its [Capability Statement](reference-fhir-capability-statement.md).
The following topics describe how to use HealthLake cloud native actions to create, describe, list, tag, and delete FHIR data stores using the AWS CLI, AWS SDKs, and AWS Management Console.
**Topics**
+ [Creating a data store](managing-data-stores-create.md)
+ [Getting data store properties](managing-data-stores-describe.md)
+ [Listing data stores](managing-data-stores-list.md)
+ [Tagging data stores](managing-data-stores-tagging.md)
+ [Deleting a data store](managing-data-stores-delete.md)
# Creating a HealthLake data store
Use `CreateFHIRDatastore` to create an AWS HealthLake data store conformant to the FHIR R4 specification. HealthLake data stores are used for importing, managing, searching, and exporting FHIR data. You can choose to import (preload) Synthea open source FHIR R4 health data into your data store when you create it. For more information, see [Preloaded data types](reference-healthlake-preloaded-data-types.md).
**Important**
HealthLake supports two types of FHIR data store authorization strategies, AWS SigV4 or SMART on FHIR. You must choose one of the authorization strategies prior to creating a HealthLake FHIR data store. For more information, see [Data store authorization strategy](getting-started-concepts.md#concept-data-store-authorization-strategy).
When you create a HealthLake data store, a FHIR data repository is made available via a RESTful API [endpoint](reference-healthlake-endpoints-quotas.md#reference-healthlake-endpoints). After you've created your HealthLake data store, you can request its [Capability Statement](reference-fhir-capability-statement.md) to find all associated FHIR-related capabilities (behaviors).
The following menus provide examples for the AWS CLI and AWS SDKs and a procedure for the AWS Management Console. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_CreateFHIRDatastore.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_CreateFHIRDatastore.html) in the *AWS HealthLake API Reference*.
**To create a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
## AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**Example 1: Create a SigV4-enabled HealthLake data store**
The following `create-fhir-datastore` example demonstrates how to create a new data store in AWS HealthLake.
```
aws healthlake create-fhir-datastore \
--datastore-type-version R4 \
--datastore-name "FhirTestDatastore"
```
Output:
```
{
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
"DatastoreStatus": "CREATING",
"DatastoreId": "(Data store ID)"
}
```
**Example 2: Create a SMART on FHIR-enabled HealthLake data store**
The following `create-fhir-datastore` example demonstrates how to create a new SMART on FHIR-enabled data store in AWS HealthLake.
```
aws healthlake create-fhir-datastore \
--datastore-name "your-data-store-name" \
--datastore-type-version R4 \
--preload-data-config PreloadDataType="SYNTHEA" \
--sse-configuration '{ "KmsEncryptionConfig": { "CmkType": "CUSTOMER_MANAGED_KMS_KEY", "KmsKeyId": "arn:aws:kms:us-east-1:your-account-id:key/your-key-id" } }' \
--identity-provider-configuration file://identity_provider_configuration.json
```
Contents of `identity_provider_configuration.json`:
```
{
"AuthorizationStrategy": "SMART_ON_FHIR_V1",
"FineGrainedAuthorizationEnabled": true,
"IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name",
"Metadata": "{\"issuer\":\"https://ehr.example.com\", \"jwks_uri\":\"https://ehr.example.com/.well-known/jwks.json\",\"authorization_endpoint\":\"https://ehr.example.com/auth/authorize\",\"token_endpoint\":\"https://ehr.token.com/auth/token\",\"token_endpoint_auth_methods_supported\":[\"client_secret_basic\",\"foo\"],\"grant_types_supported\":[\"client_credential\",\"foo\"],\"registration_endpoint\":\"https://ehr.example.com/auth/register\",\"scopes_supported\":[\"openId\",\"profile\",\"launch\"],\"response_types_supported\":[\"code\"],\"management_endpoint\":\"https://ehr.example.com/user/manage\",\"introspection_endpoint\":\"https://ehr.example.com/user/introspect\",\"revocation_endpoint\":\"https://ehr.example.com/user/revoke\",\"code_challenge_methods_supported\":[\"S256\"],\"capabilities\":[\"launch-ehr\",\"sso-openid-connect\",\"client-public\"]}"
}
```
Output:
```
{
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
"DatastoreStatus": "CREATING",
"DatastoreId": "(Data store ID)"
}
```
+ For API details, see [CreateFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/create-fhir-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def create_fhir_datastore(
self,
datastore_name: str,
sse_configuration: dict[str, any] = None,
identity_provider_configuration: dict[str, any] = None,
) -> dict[str, str]:
"""
Creates a new HealthLake data store.
When creating a SMART on FHIR data store, the following parameters are required:
- sse_configuration: The server-side encryption configuration for a SMART on FHIR-enabled data store.
- identity_provider_configuration: The identity provider configuration for a SMART on FHIR-enabled data store.
:param datastore_name: The name of the data store.
:param sse_configuration: The server-side encryption configuration for a SMART on FHIR-enabled data store.
:param identity_provider_configuration: The identity provider configuration for a SMART on FHIR-enabled data store.
:return: A dictionary containing the data store information.
"""
try:
parameters = {"DatastoreName": datastore_name, "DatastoreTypeVersion": "R4"}
if (
sse_configuration is not None
and identity_provider_configuration is not None
):
# Creating a SMART on FHIR-enabled data store
parameters["SseConfiguration"] = sse_configuration
parameters[
"IdentityProviderConfiguration"
] = identity_provider_configuration
response = self.health_lake_client.create_fhir_datastore(**parameters)
return response
except ClientError as err:
logger.exception(
"Couldn't create data store %s. Here's why %s",
datastore_name,
err.response["Error"]["Message"],
)
raise
```
The following code shows an example of parameters for a SMART on FHIR-enabled HealthLake data store.
```
sse_configuration = {
"KmsEncryptionConfig": {"CmkType": "AWS_OWNED_KMS_KEY"}
}
# TODO: Update the metadata to match your environment.
metadata = {
"issuer": "https://ehr.example.com",
"jwks_uri": "https://ehr.example.com/.well-known/jwks.json",
"authorization_endpoint": "https://ehr.example.com/auth/authorize",
"token_endpoint": "https://ehr.token.com/auth/token",
"token_endpoint_auth_methods_supported": [
"client_secret_basic",
"foo",
],
"grant_types_supported": ["client_credential", "foo"],
"registration_endpoint": "https://ehr.example.com/auth/register",
"scopes_supported": ["openId", "profile", "launch"],
"response_types_supported": ["code"],
"management_endpoint": "https://ehr.example.com/user/manage",
"introspection_endpoint": "https://ehr.example.com/user/introspect",
"revocation_endpoint": "https://ehr.example.com/user/revoke",
"code_challenge_methods_supported": ["S256"],
"capabilities": [
"launch-ehr",
"sso-openid-connect",
"client-public",
],
}
# TODO: Update the IdpLambdaArn.
identity_provider_configuration = {
"AuthorizationStrategy": "SMART_ON_FHIR_V1",
"FineGrainedAuthorizationEnabled": True,
"IdpLambdaArn": "arn:aws:lambda:your-region:your-account-id:function:your-lambda-name",
"Metadata": json.dumps(metadata),
}
data_store = self.create_fhir_datastore(
datastore_name, sse_configuration, identity_provider_configuration
)
```
+ For API details, see [CreateFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/CreateFHIRDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_datastore_name = 'MyHealthLakeDataStore'
oo_result = lo_hll->createfhirdatastore(
iv_datastorename = iv_datastore_name
iv_datastoretypeversion = 'R4'
).
MESSAGE 'Data store created successfully.' TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllinternalserverex INTO DATA(lo_internal_ex).
lv_error = |Internal server error: { lo_internal_ex->av_err_code }-{ lo_internal_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_internal_ex.
CATCH /aws1/cx_hllthrottlingex INTO DATA(lo_throttling_ex).
lv_error = |Throttling error: { lo_throttling_ex->av_err_code }-{ lo_throttling_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_throttling_ex.
ENDTRY.
```
+ For API details, see [CreateFHIRDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
## AWS Console
**Note**
The following procedure creates a HealthLake data store with [AWS SigV4](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_sigv.html) authorization. The HealthLake Console does not support the creation of a SMART on FHIR data store.
**To create a HealthLake data store with AWS SigV4 authorization**
1. Sign in to the [Create data store](https://console.aws.amazon.com/healthlake/home#/create-datastore) page on the HealthLake Console.
1. Choose **Create Data Store**.
1. In the **Data Store settings** section, for **Data Store name**, specify a name.
1. (Optional) In the **Data Store settings** section, for **Preload sample data**, select the check box to preload Synthea data. Synthea data is an open-source sample dataset. For more information, see [Synthea preloaded data types for HealthLake](reference-healthlake-preloaded-data-types.md).
1. In the **Data Store encryption** section, choose either **Use AWS owned key (default)** or **Choose a different AWS KMS key (advanced)**.
1. In the **Tags - *optional*** section, you can add tags to your data store. To learn more about tagging your data store, see [Tagging HealthLake data stores](managing-data-stores-tagging.md).
1. Choose **Create Data Store**.
The status of your data store is available on the **Data stores** page.
# Getting HealthLake data store properties
Use `DescribeFHIRDatastore` to get properties for an AWS HealthLake data store. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRDatastore.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DescribeFHIRDatastore.html) in the *AWS HealthLake API Reference*.
**To get properties for a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
## AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To describe a FHIR data store**
The following `describe-fhir-datastore` example demonstrates how to find the properties of a data store in AWS HealthLake.
```
aws healthlake describe-fhir-datastore \
--datastore-id "1f2f459836ac6c513ce899f9e4f66a59"
```
Output:
```
{
"DatastoreProperties": {
"PreloadDataConfig": {
"PreloadDataType": "SYNTHEA"
},
"SseConfiguration": {
"KmsEncryptionConfig": {
"CmkType": "CUSTOMER_MANAGED_KMS_KEY",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
},
"DatastoreName": "Demo",
"DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/",
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
}
}
}
```
+ For API details, see [DescribeFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/describe-fhir-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def describe_fhir_datastore(self, datastore_id: str) -> dict[str, any]:
"""
Describes a HealthLake data store.
:param datastore_id: The data store ID.
:return: The data store description.
"""
try:
response = self.health_lake_client.describe_fhir_datastore(
DatastoreId=datastore_id
)
return response["DatastoreProperties"]
except ClientError as err:
logger.exception(
"Couldn't describe data store with ID %s. Here's why %s",
datastore_id,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DescribeFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_datastore_id = 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
oo_result = lo_hll->describefhirdatastore(
iv_datastoreid = iv_datastore_id
).
DATA(lo_datastore_properties) = oo_result->get_datastoreproperties( ).
IF lo_datastore_properties IS BOUND.
DATA(lv_datastore_name) = lo_datastore_properties->get_datastorename( ).
DATA(lv_datastore_status) = lo_datastore_properties->get_datastorestatus( ).
MESSAGE 'Data store described successfully.' TYPE 'I'.
ENDIF.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
DATA(lv_error) = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
lv_error = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
ENDTRY.
```
+ For API details, see [DescribeFHIRDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
## AWS Console
1. Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
1. Choose a data store.
The **Data Store details** page opens and all HealthLake data store properties are available.
# Listing HealthLake data stores
Use `ListFHIRDatastores` to list all HealthLake data stores in a user's account, regardless of data store status. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRDatastores.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListFHIRDatastores.html) in the *AWS HealthLake API Reference*.
**To list all HealthLake data stores**
Choose a menu based on your access preference to AWS HealthLake.
## AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To list FHIR data stores**
The following `list-fhir-datastores` example shows to how to use the command and how users can filter results based on data store status in AWS HealthLake.
```
aws healthlake list-fhir-datastores \
--filter DatastoreStatus=ACTIVE
```
Output:
```
{
"DatastorePropertiesList": [
{
"PreloadDataConfig": {
"PreloadDataType": "SYNTHEA"
},
"SseConfiguration": {
"KmsEncryptionConfig": {
"CmkType": "CUSTOMER_MANAGED_KMS_KEY",
"KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}
},
"DatastoreName": "Demo",
"DatastoreArn": "arn:aws:healthlake:us-east-1::datastore/",
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore//r4/",
"DatastoreStatus": "ACTIVE",
"DatastoreTypeVersion": "R4",
"CreatedAt": 1603761064.881,
"DatastoreId": "",
"IdentityProviderConfiguration": {
"AuthorizationStrategy": "AWS_AUTH",
"FineGrainedAuthorizationEnabled": false
}
}
]
}
```
+ For API details, see [ListFHIRDatastores](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-fhir-datastores.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def list_fhir_datastores(self) -> list[dict[str, any]]:
"""
Lists all HealthLake data stores.
:return: A list of data store descriptions.
"""
try:
next_token = None
datastores = []
# Loop through paginated results.
while True:
parameters = {}
if next_token is not None:
parameters["NextToken"] = next_token
response = self.health_lake_client.list_fhir_datastores(**parameters)
datastores.extend(response["DatastorePropertiesList"])
if "NextToken" in response:
next_token = response["NextToken"]
else:
break
return datastores
except ClientError as err:
logger.exception(
"Couldn't list data stores. Here's why %s", err.response["Error"]["Message"]
)
raise
```
+ For API details, see [ListFHIRDatastores](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListFHIRDatastores) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
oo_result = lo_hll->listfhirdatastores( ).
DATA(lt_datastores) = oo_result->get_datastorepropertieslist( ).
DATA(lv_datastore_count) = lines( lt_datastores ).
MESSAGE |Found { lv_datastore_count } data store(s).| TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllthrottlingex INTO DATA(lo_throttling_ex).
lv_error = |Throttling error: { lo_throttling_ex->av_err_code }-{ lo_throttling_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_throttling_ex.
ENDTRY.
```
+ For API details, see [ListFHIRDatastores](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
## AWS Console
+ Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
All HealthLake data stores are listed under the **Data stores** section.
# Tagging HealthLake data stores
You can assign metadata to HealthLake data stores in the form of tags. Each tag is a label consisting of a user-defined key and value. Tags help you manage, identify, organize, search for, and filter data stores.
**Important**
Do not store protected health information (PHI), personally identifiable information (PII), or other confidential or sensitive information in tags. Tags are not intended to be used for private or sensitive data.
The following topics describe how to use HealthLake tagging operations using the AWS Management Console, AWS CLI, and AWS SDKs. For more information, see [Tagging your AWS resources](https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html) in the *AWS General Reference Guide*.
**Topics**
+ [
## Tagging a HealthLake data store
](#tagresource)
+ [
## Listing tags for a HealthLake data store
](#listtagsforresource)
+ [
## Untagging a HealthLake data store
](#untagresource)
## Tagging a HealthLake data store
Use `TagResource` to tag a HealthLake data store. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_TagResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_TagResource.html.html) in the *AWS HealthLake API Reference*.
**To tag a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
### AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To add a tag to data store**
The following `tag-resource` example shows how to add a tag to a data store.
```
aws healthlake tag-resource \
--resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe" \
--tags '[{"Key": "key1", "Value": "value1"}]'
```
This command produces no output.
+ For API details, see [TagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/tag-resource.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def tag_resource(self, resource_arn: str, tags: list[dict[str, str]]) -> None:
"""
Tags a HealthLake resource.
:param resource_arn: The resource ARN.
:param tags: The tags to add to the resource.
"""
try:
self.health_lake_client.tag_resource(ResourceARN=resource_arn, Tags=tags)
except ClientError as err:
logger.exception(
"Couldn't tag resource %s. Here's why %s",
resource_arn,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [TagResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/TagResource) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
lo_hll->tagresource(
iv_resourcearn = iv_resource_arn
it_tags = it_tags
).
MESSAGE 'Resource tagged successfully.' TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
lv_error = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
ENDTRY.
```
+ For API details, see [TagResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
### AWS Console
1. Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
1. Choose a data store.
The **Data store details** page opens.
1. Under the **Tags** section, choose **Manage tags**.
The **Manage tags** page opens.
1. Choose **Add new tag**.
1. Enter a **Key** and **Value** (optional).
1. Choose **Save**.
## Listing tags for a HealthLake data store
Use `ListTagsForResource` to list tags for a HealthLake data store. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListTagsForResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_ListTagsForResource.html.html) in the *AWS HealthLake API Reference*.
**To list tags for a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
### AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To list tags for a data store**
The following `list-tags-for-resource` example lists the tags associated with the specified data store.:
```
aws healthlake list-tags-for-resource \
--resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/0725c83f4307f263e16fd56b6d8ebdbe"
```
Output:
```
{
"tags": {
"key": "value",
"key1": "value1"
}
}
```
+ For API details, see [ListTagsForResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/list-tags-for-resource.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def list_tags_for_resource(self, resource_arn: str) -> dict[str, str]:
"""
Lists the tags for a HealthLake resource.
:param resource_arn: The resource ARN.
:return: The tags for the resource.
"""
try:
response = self.health_lake_client.list_tags_for_resource(
ResourceARN=resource_arn
)
return response["Tags"]
except ClientError as err:
logger.exception(
"Couldn't list tags for resource %s. Here's why %s",
resource_arn,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [ListTagsForResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/ListTagsForResource) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
DATA(lo_result) = lo_hll->listtagsforresource(
iv_resourcearn = iv_resource_arn
).
ot_tags = lo_result->get_tags( ).
DATA(lv_tag_count) = lines( ot_tags ).
MESSAGE |Found { lv_tag_count } tag(s).| TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
lv_error = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
ENDTRY.
```
+ For API details, see [ListTagsForResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
### AWS Console
1. Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
1. Choose a data store.
The **Data store details** page opens. Under the **Tags** section, all data store tags are listed.
## Untagging a HealthLake data store
Use `UntagResource` to remove a tag from a HealthLake data store. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_UntagResource.html.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_UntagResource.html.html) in the *AWS HealthLake API Reference*.
**To untag a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
### AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To remove tags from a data store.**
The following `untag-resource` example shows how to remove tags from a data store.
```
aws healthlake untag-resource \
--resource-arn "arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/b91723d65c6fdeb1d26543a49d2ed1fa" \
--tag-keys '["key1"]'
```
This command produces no output.
+ For API details, see [UntagResource](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/untag-resource.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def untag_resource(self, resource_arn: str, tag_keys: list[str]) -> None:
"""
Untags a HealthLake resource.
:param resource_arn: The resource ARN.
:param tag_keys: The tag keys to remove from the resource.
"""
try:
self.health_lake_client.untag_resource(
ResourceARN=resource_arn, TagKeys=tag_keys
)
except ClientError as err:
logger.exception(
"Couldn't untag resource %s. Here's why %s",
resource_arn,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [UntagResource](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/UntagResource) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_resource_arn = 'arn:aws:healthlake:us-east-1:123456789012:datastore/fhir/a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
lo_hll->untagresource(
iv_resourcearn = iv_resource_arn
it_tagkeys = it_tag_keys
).
MESSAGE 'Resource untagged successfully.' TYPE 'I'.
CATCH /aws1/cx_hllvalidationex INTO DATA(lo_validation_ex).
DATA(lv_error) = |Validation error: { lo_validation_ex->av_err_code }-{ lo_validation_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_validation_ex.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
lv_error = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
ENDTRY.
```
+ For API details, see [UntagResource](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
### AWS Console
1. Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
1. Choose a data store.
The **Data store details** page opens.
1. Under the **Tags** section, choose **Manage tags**.
The **Manage tags** page opens.
1. Choose **Remove** next to the tag you want to remove.
1. Choose **Save**.
# Deleting a HealthLake data store
Use `DeleteFHIRDatastore` to delete a HealthLake data store. The following menus provide a procedure for the AWS Management Console and code examples for the AWS CLI and AWS SDKs. For more information, see [https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DeleteFHIRDatastores.html](https://docs.aws.amazon.com/healthlake/latest/APIReference/API_DeleteFHIRDatastores.html) in the *AWS HealthLake API Reference*.
**To delete a HealthLake data store**
Choose a menu based on your access preference to AWS HealthLake.
## AWS CLI and SDKs
------
#### [ CLI ]
**AWS CLI**
**To delete a FHIR data store**
The following `delete-fhir-datastore` example demonstrates how to delete a data store and all of its contents in AWS HealthLake.
```
aws healthlake delete-fhir-datastore \
--datastore-id (Data store ID)
```
Output:
```
{
"DatastoreEndpoint": "https://healthlake.us-east-1.amazonaws.com/datastore/(Data store ID)/r4/",
"DatastoreArn": "arn:aws:healthlake:us-east-1:(AWS Account ID):datastore/(Data store ID)",
"DatastoreStatus": "DELETING",
"DatastoreId": "(Data store ID)"
}
```
+ For API details, see [DeleteFHIRDatastore](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/healthlake/delete-fhir-datastore.html) in *AWS CLI Command Reference*.
------
#### [ Python ]
**SDK for Python (Boto3)**
```
@classmethod
def from_client(cls) -> "HealthLakeWrapper":
"""
Creates a HealthLakeWrapper instance with a default AWS HealthLake client.
:return: An instance of HealthLakeWrapper initialized with the default HealthLake client.
"""
health_lake_client = boto3.client("healthlake")
return cls(health_lake_client)
def delete_fhir_datastore(self, datastore_id: str) -> None:
"""
Deletes a HealthLake data store.
:param datastore_id: The data store ID.
"""
try:
self.health_lake_client.delete_fhir_datastore(DatastoreId=datastore_id)
except ClientError as err:
logger.exception(
"Couldn't delete data store with ID %s. Here's why %s",
datastore_id,
err.response["Error"]["Message"],
)
raise
```
+ For API details, see [DeleteFHIRDatastore](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DeleteFHIRDatastore) in *AWS SDK for Python (Boto3) API Reference*.
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/python/example_code/healthlake#code-examples).
------
#### [ SAP ABAP ]
**SDK for SAP ABAP**
There's more on GitHub. Find the complete example and learn how to set up and run in the [AWS Code Examples Repository](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/hll#code-examples).
```
TRY.
" iv_datastore_id = 'a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6'
oo_result = lo_hll->deletefhirdatastore(
iv_datastoreid = iv_datastore_id
).
MESSAGE 'Data store deleted successfully.' TYPE 'I'.
CATCH /aws1/cx_hllaccessdeniedex INTO DATA(lo_access_ex).
DATA(lv_error) = |Access denied: { lo_access_ex->av_err_code }-{ lo_access_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_access_ex.
CATCH /aws1/cx_hllconflictexception INTO DATA(lo_conflict_ex).
lv_error = |Conflict error: { lo_conflict_ex->av_err_code }-{ lo_conflict_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_conflict_ex.
CATCH /aws1/cx_hllresourcenotfoundex INTO DATA(lo_notfound_ex).
lv_error = |Resource not found: { lo_notfound_ex->av_err_code }-{ lo_notfound_ex->av_err_msg }|.
MESSAGE lv_error TYPE 'I'.
RAISE EXCEPTION lo_notfound_ex.
ENDTRY.
```
+ For API details, see [DeleteFHIRDatastore](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html) in *AWS SDK for SAP ABAP API reference*.
------
**Example availability**
Can't find what you need? Request a code example using the **Provide feedback** link on the right sidebar of this page.
## AWS Console
1. Sign in to the [Data stores](https://console.aws.amazon.com/healthlake/home#/list-datastores) page on the HealthLake Console.
1. Choose a data store.
The **Data store details** page opens.
1. Choose **Delete**.
The **Delete data store** page opens.
1. To confirm data store deletion, enter the data store name in the text input field.
1. Choose **Delete**.