Skip to content

list_rescore_execution_plans

list_rescore_execution_plans(
    *,
    config_overrides: Optional[KendraRankingClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResultsIntegerForListRescoreExecutionPlansRequest] = None,
) -> ListRescoreExecutionPlansResponse

Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

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

    If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.

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

    The maximum number of rescore execution plans to return.

Raises:

  • AccessDeniedException –

    You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

  • InternalServerException –

    An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact Support for help.

  • ThrottlingException –

    The request was denied due to request throttling. Please reduce the number of requests and try again.

  • ValidationException –

    The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please 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_kendra_ranking/_services/kendra_ranking.py
def list_rescore_execution_plans(
    self,
    *,
    config_overrides: Optional[KendraRankingClientConfig] = None,
    next_token: Optional["capo_kendra_ranking.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_kendra_ranking.types.max_results_integer_for_list_rescore_execution_plans_request.MaxResultsIntegerForListRescoreExecutionPlansRequest"
    ] = None,
) -> "capo_kendra_ranking.types.list_rescore_execution_plans_response.ListRescoreExecutionPlansResponse":
    """<p>Lists your rescore execution plans. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the <code>Rescore</code> API.</p>

    Args:
        next_token: <p>If the response is truncated, Amazon Kendra Intelligent Ranking returns a pagination token in the response. You can use this pagination token to retrieve the next set of rescore execution plans.</p>
        max_results: <p>The maximum number of rescore execution plans to return.</p>

    Raises:
        capo_kendra_ranking.errors.access_denied_exception.AccessDeniedException: <p>You don’t have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
        capo_kendra_ranking.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra Intelligent Ranking service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
        capo_kendra_ranking.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
        capo_kendra_ranking.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra Intelligent Ranking service. Please provide the correct input and try again.</p>
        capo_kendra_ranking.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_kendra_ranking.types.list_rescore_execution_plans_request.ListRescoreExecutionPlansRequest]",
    ) -> OperationResponse[
        "capo_kendra_ranking.types.list_rescore_execution_plans_response.ListRescoreExecutionPlansResponse"
    ]:
        import capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.list_rescore_execution_plans

        output, http_response = (
            capo_kendra_ranking._operations.aws_kendra_reranking_frontend_service.list_rescore_execution_plans.list_rescore_execution_plans(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRescoreExecutionPlans")
    )
    input_: capo_kendra_ranking.types.list_rescore_execution_plans_request.ListRescoreExecutionPlansRequest = {}
    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