HealthLake / Client / list_fhir_datastores

list_fhir_datastores

HealthLake.Client.list_fhir_datastores(**kwargs)

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

See also: AWS API Documentation

Request Syntax

response = client.list_fhir_datastores(
    Filter={
        'DatastoreName': 'string',
        'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
        'CreatedBefore': datetime(2015, 1, 1),
        'CreatedAfter': datetime(2015, 1, 1)
    },
    NextToken='string',
    MaxResults=123
)

Parameters:

• Filter (dict) –

  Lists all filters associated with a FHIR Data Store request.

  • DatastoreName (string) –

    Allows the user to filter Data Store results by name.

  • DatastoreStatus (string) –

    Allows the user to filter Data Store results by status.

  • CreatedBefore (datetime) –

    A filter that allows the user to set cutoff dates for records. All Data Stores created before the specified date will be included in the results.

  • CreatedAfter (datetime) –

    A filter that allows the user to set cutoff dates for records. All Data Stores created after the specified date will be included in the results.

• NextToken (string) – Fetches the next page of Data Stores when results are paginated.

• MaxResults (integer) – The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call.

Return type:

dict

Returns:

Response Syntax

{
    'DatastorePropertiesList': [
        {
            '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'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • DatastorePropertiesList (list) –

    All properties associated with the listed Data Stores.

    • (dict) –

      Displays the properties of the Data Store, including the ID, Arn, name, and the status of the Data Store.

      • 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.

  • NextToken (string) –

    Pagination token that can be used to retrieve the next page of results.

Exceptions

• HealthLake.Client.exceptions.ValidationException

• HealthLake.Client.exceptions.ThrottlingException

• HealthLake.Client.exceptions.InternalServerException