list_retrievers `async` ¶

list_retrievers(
    application_id: ApplicationId,
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsIntegerForListRetrieversRequest] = None,
) -> ListRetrieversResponse

Lists the retriever used by an Amazon Q Business application.

Parameters:

application_id (ApplicationId) –

The identifier of the Amazon Q Business application using the retriever.
next_token (Optional[NextToken], default: None ) –

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.
max_results (Optional[MaxResultsIntegerForListRetrieversRequest], default: None ) –

The maximum number of retrievers returned.

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 list_retrievers(
    self,
    application_id: "capo_qbusiness.types.application_id.ApplicationId",
    *,
    config_overrides: Optional[AsyncQBusinessClientConfig] = None,
    next_token: Optional["capo_qbusiness.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_qbusiness.types.max_results_integer_for_list_retrievers_request.MaxResultsIntegerForListRetrieversRequest"
    ] = None,
) -> "capo_qbusiness.types.list_retrievers_response.ListRetrieversResponse":
    """<p>Lists the 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>
        next_token: <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of retrievers.</p>
        max_results: <p>The maximum number of retrievers returned.</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.list_retrievers_request.ListRetrieversRequest]",
    ) -> AsyncOperationResponse[
        "capo_qbusiness.types.list_retrievers_response.ListRetrieversResponse"
    ]:
        import capo_qbusiness._operations.expert_q.list_retrievers

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRetrievers")
    )
    input_: capo_qbusiness.types.list_retrievers_request.ListRetrieversRequest = {
        "application_id": application_id
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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

list_retrievers async ¶

list_retrievers `async` ¶