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 DescribeFHIRDatastore
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.
- 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 Amazon HealthLake.aws healthlake describe-fhir-datastore \ --datastore-id
"1f2f459836ac6c513ce899f9e4f66a59"
\ --regionus-east-1
Output:
{ "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)" } }
For more information, see Creating and monitoring a FHIR Data Stores in the Amazon HealthLake Developer Guide.
-
For API details, see DescribeFHIRDatastore
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 in AWS SDK for Python (Boto3) API Reference.
Note
There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository
. -
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 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 Amazon HealthLake.aws healthlake describe-fhir-datastore \ --datastore-id
"1f2f459836ac6c513ce899f9e4f66a59"
\ --regionus-east-1
Output:
{ "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)" } }
For more information, see Creating and monitoring a FHIR Data Stores in the Amazon HealthLake Developer Guide.
-
For API details, see DescribeFHIRDatastore
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 in AWS SDK for Python (Boto3) API Reference.
Note
There's more on GitHub. Find the complete example and learn how to set up and run in the AWS Code Examples Repository
. -
- 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 Amazon HealthLake.aws healthlake describe-fhir-datastore \ --datastore-id
"1f2f459836ac6c513ce899f9e4f66a59"
\ --regionus-east-1
Output:
{ "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)" } }
For more information, see Creating and monitoring a FHIR Data Stores in the Amazon HealthLake Developer Guide.
-
For API details, see DescribeFHIRDatastore
in AWS CLI Command 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.
-
Sign in to the Data stores
page on the HealthLake Console. -
Choose a data store.
The Data Store details page opens and all HealthLake data store properties are available.
AWS Console
-
Sign in to the Data stores
page on the HealthLake Console. -
Choose a data store.
The Data Store details page opens and all HealthLake data store properties are available.