View a markdown version of this page

UpdateFHIRDatastore - AWS HealthLake

UpdateFHIRDatastore

Update the properties of a FHIR-enabled data store.

Request Syntax

{ "AnalyticsConfiguration": { "Status": "string" }, "DatastoreId": "string", "DatastoreName": "string", "IdentityProviderConfiguration": { "AuthorizationStrategy": "string", "FineGrainedAuthorizationEnabled": boolean, "IdpLambdaArn": "string", "Metadata": "string" }, "NlpConfiguration": { "Status": "string" }, "ProfileConfiguration": { "DefaultProfiles": [ "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.

AnalyticsConfiguration

The analytics configuration for the data store.

Type: AnalyticsConfiguration object

Required: No

DatastoreId

The data store identifier.

Type: String

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

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

Required: Yes

DatastoreName

The data store name.

Type: String

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

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

Required: No

IdentityProviderConfiguration

The identity provider configuration for the data store.

Type: IdentityProviderConfiguration object

Required: No

NlpConfiguration

The natural language processing (NLP) configuration for the data store.

Type: NlpConfiguration object

Required: No

ProfileConfiguration

The profile configuration for the data store.

Type: ProfileConfiguration object

Required: No

Response Syntax

{ "DatastoreProperties": { "AnalyticsConfiguration": { "Status": "string" }, "CreatedAt": number, "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreName": "string", "DatastoreStatus": "string", "DatastoreTypeVersion": "string", "ErrorCause": { "ErrorCategory": "string", "ErrorMessage": "string" }, "IdentityProviderConfiguration": { "AuthorizationStrategy": "string", "FineGrainedAuthorizationEnabled": boolean, "IdpLambdaArn": "string", "Metadata": "string" }, "NlpConfiguration": { "Status": "string" }, "PreloadDataConfig": { "PreloadDataType": "string" }, "ProfileConfiguration": { "DefaultProfiles": [ "string" ] }, "SseConfiguration": { "KmsEncryptionConfig": { "CmkType": "string", "KmsKeyId": "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.

DatastoreProperties

The data store properties.

Type: DatastoreProperties object

Errors

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

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 cannot be performed.

HTTP Status Code: 400

InternalServerException

An unknown internal error occurred 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: