get_retriever `async` ¶

get_retriever(
    application_id: ApplicationId,
    retriever_id: RetrieverId,
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> GetRetrieverResponse

Gets information about an existing retriever used by an Amazon Q Business application.

Parameters:

application_id (ApplicationId) –

The identifier of the Amazon Q Business application using the retriever.
retriever_id (RetrieverId) –

The identifier of the retriever.

Raises:

AccessDeniedException –

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
InternalServerException –

An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
ResourceNotFoundException –

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
ThrottlingException –

The request was denied due to throttling. Reduce the number of requests and try again.
ValidationException –

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_qbusiness/_services/async_q_business.py

async def get_retriever(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    retriever_id: "capo_qbusiness.types.retriever_id.RetrieverId",
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
) -> "capo_qbusiness.types.get_retriever_response.GetRetrieverResponse":
    """<p>Gets information about an existing retriever used by an Amazon Q Business application.</p>

    Args:
        application_id: <p>The identifier of the Amazon Q Business application using the retriever.</p>
        retriever_id: <p>The identifier of the retriever.</p>

    Raises:
        capo_qbusiness.errors.access_denied_exception.AccessDeniedException: <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
        capo_qbusiness.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_qbusiness.errors.resource_not_found_exception.ResourceNotFoundException: <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
        capo_qbusiness.errors.throttling_exception.ThrottlingException: <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
        capo_qbusiness.errors.validation_exception.ValidationException: <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
        capo_qbusiness.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_qbusiness.types.get_retriever_request.GetRetrieverRequest]",
    ) -> AsyncOperationResponse[
        "capo_qbusiness.types.get_retriever_response.GetRetrieverResponse"
    ]:
        import capo_qbusiness._operations.expert_q.get_retriever

        (
            output,
            http_response,
        ) = await capo_qbusiness._operations.expert_q.get_retriever.async_get_retriever(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRetriever")
    )
    input_: capo_qbusiness.types.get_retriever_request.GetRetrieverRequest = {
        "application_id": application_id,
        "retriever_id": retriever_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

get_retriever async ¶

get_retriever `async` ¶