DeleteFHIRDatastore - Amazon HealthLake

DeleteFHIRDatastore

Deletes a Data Store.

Request Syntax

{ "DatastoreId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DatastoreId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

Required: No

Response Syntax

{ "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreStatus": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DatastoreArn

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

Type: String

Pattern: ^arn:aws((-us-gov)|(-iso)|(-iso-b)|(-cn))?:healthlake:[a-zA-Z0-9-]+:[0-9]{12}:datastore/.+?

DatastoreEndpoint

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Pattern: [\P{M}\p{M}]{1,5000}

DatastoreId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-%@]*)$

DatastoreStatus

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

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied. Your account is not authorized to perform this operation.

HTTP Status Code: 400

ConflictException

The Data Store is in a transition state and the user requested action can not be performed.

HTTP Status Code: 400

InternalServerException

Unknown error occurs in the service.

HTTP Status Code: 500

ResourceNotFoundException

The requested Data Store was not found.

HTTP Status Code: 400

ThrottlingException

The user has exceeded their maximum number of allowed calls to the given API.

HTTP Status Code: 400

ValidationException

The user input parameter was invalid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: