Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListFHIRDatastores

List all FHIR-enabled data stores in a 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

List all filters associated with a FHIR data store request.

Type: DatastoreFilter object

Required: No

MaxResults

The maximum number of data stores returned on a page.

Type: Integer

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

Required: No

NextToken

The token used to retrieve 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",
         "IdentityProviderConfiguration": { 
            "AuthorizationStrategy": "string",
            "FineGrainedAuthorizationEnabled": boolean,
            "IdpLambdaArn": "string",
            "Metadata": "string"
         },
         "PreloadDataConfig": { 
            "PreloadDataType": "string"
         },
         "SseConfiguration": { 
            "KmsEncryptionConfig": { 
               "CmkType": "string",
               "KmsKeyId": "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

The properties associated with all listed data stores.

Type: Array of DatastoreProperties objects

NextToken

The pagination token 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

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