Skip to content

list_retrieval_instructions async

list_retrieval_instructions(
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    status: Optional[RetrievalInstructionStatus] = None,
    max_results: Optional[RetrievalInstructionMaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListRetrievalInstructionsResponse

Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.

Parameters:

Raises:

Source code in docs_src/capo_bedrock_agent/_services/async_bedrock_agent.py
async def list_retrieval_instructions(
    self,
    *,
    config_overrides: Optional[AsyncBedrockAgentClientConfig] = None,
    status: Optional[
        "capo_bedrock_agent.types.retrieval_instruction_status.RetrievalInstructionStatus"
    ] = None,
    max_results: Optional[
        "capo_bedrock_agent.types.retrieval_instruction_max_results.RetrievalInstructionMaxResults"
    ] = None,
    next_token: Optional["capo_bedrock_agent.types.next_token.NextToken"] = None,
) -> "capo_bedrock_agent.types.list_retrieval_instructions_response.ListRetrievalInstructionsResponse":
    """<p>Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.</p>

    Args:
        status: <p>Return only instructions with this availability status.</p>
        max_results: <p>The maximum number of results to return in a single page. The effective upper bound is enforced service-side.</p>
        next_token: <p>The pagination token from a previous ListRetrievalInstructions response.</p>

    Raises:
        capo_bedrock_agent.errors.access_denied_exception.AccessDeniedException: <p>The request is denied because of missing access permissions.</p>
        capo_bedrock_agent.errors.internal_server_exception.InternalServerException: <p>An internal server error occurred. Retry your request.</p>
        capo_bedrock_agent.errors.throttling_exception.ThrottlingException: <p>The number of requests exceeds the limit. Resubmit your request later.</p>
        capo_bedrock_agent.errors.validation_exception.ValidationException: <p>Input validation failed. Check your request parameters and retry the request.</p>
        capo_bedrock_agent.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_bedrock_agent.types.list_retrieval_instructions_request.ListRetrievalInstructionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_bedrock_agent.types.list_retrieval_instructions_response.ListRetrievalInstructionsResponse"
    ]:
        import capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_retrieval_instructions

        (
            output,
            http_response,
        ) = await capo_bedrock_agent._operations.amazon_bedrock_agent_build_time_lambda.list_retrieval_instructions.async_list_retrieval_instructions(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_bedrock_agent.types.list_retrieval_instructions_response.ListRetrievalInstructionsResponse",
    ) -> dict[str, Any]:
        import capo_bedrock_agent.types.list_retrieval_instructions_response

        return capo_bedrock_agent.types.list_retrieval_instructions_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("ListRetrievalInstructions", redact_output=_redact_output),
    )
    input_: capo_bedrock_agent.types.list_retrieval_instructions_request.ListRetrievalInstructionsRequest = {}
    if status is not None:
        input_["status"] = status
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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