Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeFHIRDatastore

Gets the properties associated with the FHIR data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

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 data store ID.

Type: String

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

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

Required: Yes

Response Syntax


{
   "DatastoreProperties": { 
      "CreatedAt": number,
      "DatastoreArn": "string",
      "DatastoreEndpoint": "string",
      "DatastoreId": "string",
      "DatastoreName": "string",
      "DatastoreStatus": "string",
      "DatastoreTypeVersion": "string",
      "IdentityProviderConfiguration": { 
         "AuthorizationStrategy": "string",
         "FineGrainedAuthorizationEnabled": boolean,
         "IdpLambdaArn": "string",
         "Metadata": "string"
      },
      "PreloadDataConfig": { 
         "PreloadDataType": "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

All properties associated with a data store, including the data store ID, data store ARN, data store name, data store status, when the data store was created, data store type version, and the data store's endpoint.

Type: DatastoreProperties object

Errors

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

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