

# DescribeFHIRDatastore


Get properties for a FHIR-enabled data store.

## Request Syntax


```
{
   "DatastoreId": "string"
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DatastoreId](#API_DescribeFHIRDatastore_RequestSyntax) **   <a name="HealthLake-DescribeFHIRDatastore-request-DatastoreId"></a>
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

## Response Syntax


```
{
   "DatastoreProperties": { 
      "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"
      },
      "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](#API_DescribeFHIRDatastore_ResponseSyntax) **   <a name="HealthLake-DescribeFHIRDatastore-response-DatastoreProperties"></a>
The data store properties.  
Type: [DatastoreProperties](API_DatastoreProperties.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/healthlake-2017-07-01/DescribeFHIRDatastore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/healthlake-2017-07-01/DescribeFHIRDatastore) 