Skip to content

list_fhir_datastores

list_fhir_datastores(
    *,
    config_overrides: Optional[HealthLakeClientConfig] = None,
    filter: Optional[DatastoreFilter] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsInteger] = None,
) -> ListFHIRDatastoresResponse

List all FHIR-enabled data stores in a user’s account, regardless of data store status.

Parameters:

  • filter (Optional[DatastoreFilter], default: None ) –

    List all filters associated with a FHIR data store request.

  • next_token (Optional[NextToken], default: None ) –

    The token used to retrieve the next page of data stores when results are paginated.

  • max_results (Optional[MaxResultsInteger], default: None ) –

    The maximum number of data stores returned on a page.

Raises:

Source code in docs_src/capo_healthlake/_services/health_lake.py
def list_fhir_datastores(
    self,
    *,
    config_overrides: Optional[HealthLakeClientConfig] = None,
    filter: Optional[
        "capo_healthlake.types.datastore_filter.DatastoreFilter"
    ] = None,
    next_token: Optional["capo_healthlake.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_healthlake.types.max_results_integer.MaxResultsInteger"
    ] = None,
) -> (
    "capo_healthlake.types.list_fhir_datastores_response.ListFHIRDatastoresResponse"
):
    """<p>List all FHIR-enabled data stores in a user’s account, regardless of data store status.</p>

    Args:
        filter: <p>List all filters associated with a FHIR data store request.</p>
        next_token: <p>The token used to retrieve the next page of data stores when results are paginated.</p>
        max_results: <p>The maximum number of data stores returned on a page.</p>

    Raises:
        capo_healthlake.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred in the service.</p>
        capo_healthlake.errors.throttling_exception.ThrottlingException: <p>The user has exceeded their maximum number of allowed calls to the given API. </p>
        capo_healthlake.errors.validation_exception.ValidationException: <p>The user input parameter was invalid.</p>
        capo_healthlake.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_healthlake.types.list_fhir_datastores_request.ListFHIRDatastoresRequest]",
    ) -> OperationResponse[
        "capo_healthlake.types.list_fhir_datastores_response.ListFHIRDatastoresResponse"
    ]:
        import capo_healthlake._operations.health_lake.list_fhir_datastores

        output, http_response = (
            capo_healthlake._operations.health_lake.list_fhir_datastores.list_fhir_datastores(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFHIRDatastores")
    )
    input_: capo_healthlake.types.list_fhir_datastores_request.ListFHIRDatastoresRequest = {}
    if filter is not None:
        input_["filter"] = filter
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output