HealthLake / Client / delete_fhir_datastore

delete_fhir_datastore#

HealthLake.Client.delete_fhir_datastore(**kwargs)#

Deletes a Data Store.

See also: AWS API Documentation

Request Syntax

response = client.delete_fhir_datastore(
    DatastoreId='string'
)
Parameters:

DatastoreId (string) – The AWS-generated ID for the Data Store to be deleted.

Return type:

dict

Returns:

Response Syntax

{
    'DatastoreId': 'string',
    'DatastoreArn': 'string',
    'DatastoreStatus': 'CREATING'|'ACTIVE'|'DELETING'|'DELETED',
    'DatastoreEndpoint': 'string'
}

Response Structure

  • (dict) –

    • DatastoreId (string) –

      The AWS-generated ID for the Data Store to be deleted.

    • DatastoreArn (string) –

      The Amazon Resource Name (ARN) that gives Amazon HealthLake access permission.

    • DatastoreStatus (string) –

      The status of the Data Store that the user has requested to be deleted.

    • DatastoreEndpoint (string) –

      The AWS endpoint for the Data Store the user has requested to be deleted.

Exceptions

  • HealthLake.Client.exceptions.AccessDeniedException

  • HealthLake.Client.exceptions.ConflictException

  • HealthLake.Client.exceptions.ValidationException

  • HealthLake.Client.exceptions.ResourceNotFoundException

  • HealthLake.Client.exceptions.ThrottlingException

  • HealthLake.Client.exceptions.InternalServerException