ListFHIRDatastores - Amazon HealthLake

ListFHIRDatastores

Lists all FHIR Data Stores that are in the user’s account, regardless of Data Store status.

Request Syntax

{ "Filter": { "CreatedAfter": number, "CreatedBefore": number, "DatastoreName": "string", "DatastoreStatus": "string" }, "MaxResults": number, "NextToken": "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.

Filter

Lists all filters associated with a FHIR Data Store request.

Type: DatastoreFilter object

Required: No

MaxResults

The maximum number of Data Stores returned in a single page of a ListFHIRDatastoresRequest call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

Required: No

NextToken

Fetches the next page of Data Stores when results are paginated.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

Required: No

Response Syntax

{ "DatastorePropertiesList": [ { "CreatedAt": number, "DatastoreArn": "string", "DatastoreEndpoint": "string", "DatastoreId": "string", "DatastoreName": "string", "DatastoreStatus": "string", "DatastoreTypeVersion": "string", "PreloadDataConfig": { "PreloadDataType": "string" } } ], "NextToken": "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.

DatastorePropertiesList

All properties associated with the listed Data Stores.

Type: Array of DatastoreProperties objects

NextToken

Pagination token that can be used to retrieve the next page of results.

Type: String

Length Constraints: Maximum length of 8192.

Pattern: \p{ASCII}{0,8192}

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

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: