HealthLake / Client / describe_fhir_datastore

describe_fhir_datastore

HealthLake.Client.describe_fhir_datastore(**kwargs)

Gets the properties associated with the FHIR Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

See also: AWS API Documentation

Request Syntax

response = client.describe_fhir_datastore(
    DatastoreId='string'
)

Parameters:

DatastoreId (string) – The AWS-generated Data Store id. This is part of the ‘CreateFHIRDatastore’ output.

Return type:

dict

Returns:

Response Syntax

{
    'DatastoreProperties': {
        'DatastoreId': 'string',
        'DatastoreArn': 'string',
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
        'CreatedAt': datetime(2015, 1, 1),
        'DatastoreTypeVersion': 'R4',
        'DatastoreEndpoint': 'string',
        'SseConfiguration': {
            'KmsEncryptionConfig': {
                'CmkType': 'CUSTOMER_MANAGED_KMS_KEY'|'AWS_OWNED_KMS_KEY',
                'KmsKeyId': 'string'
            }
        },
        'PreloadDataConfig': {
            'PreloadDataType': 'SYNTHEA'
        }
    }
}

Response Structure

• (dict) –

  • DatastoreProperties (dict) –

    All properties associated with a Data Store, including the Data Store ID, Data Store ARN, Data Store name, Data Store status, created at, Data Store type version, and Data Store endpoint.

    • DatastoreId (string) –

      The AWS-generated ID number for the Data Store.

    • DatastoreArn (string) –

      The Amazon Resource Name used in the creation of the Data Store.

    • DatastoreName (string) –

      The user-generated name for the Data Store.

    • DatastoreStatus (string) –

      The status of the Data Store. Possible statuses are ‘CREATING’, ‘ACTIVE’, ‘DELETING’, or ‘DELETED’.

    • CreatedAt (datetime) –

      The time that a Data Store was created.

    • DatastoreTypeVersion (string) –

      The FHIR version. Only R4 version data is supported.

    • DatastoreEndpoint (string) –

      The AWS endpoint for the Data Store. Each Data Store will have it’s own endpoint with Data Store ID in the endpoint URL.

    • SseConfiguration (dict) –

      The server-side encryption key configuration for a customer provided encryption key (CMK).

      • KmsEncryptionConfig (dict) –

        The KMS encryption configuration used to provide details for data encryption.

        • CmkType (string) –

          The type of customer-managed-key(CMK) used for encyrption. The two types of supported CMKs are customer owned CMKs and AWS owned CMKs.

        • KmsKeyId (string) –

          The KMS encryption key id/alias used to encrypt the Data Store contents at rest.

    • PreloadDataConfig (dict) –

      The preloaded data configuration for the Data Store. Only data preloaded from Synthea is supported.

      • PreloadDataType (string) –

        The type of preloaded data. Only Synthea preloaded data is supported.

Exceptions

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.ResourceNotFoundException

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.InternalServerException