KendraRanking / Client / update_rescore_execution_plan

update_rescore_execution_plan#

KendraRanking.Client.update_rescore_execution_plan(**kwargs)#

Updates a rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API. You can update the number of capacity units you require for Amazon Kendra Intelligent Ranking to rescore or re-rank a search service’s results.

See also: AWS API Documentation

Request Syntax

response = client.update_rescore_execution_plan(
    Id='string',
    Name='string',
    Description='string',
    CapacityUnits={
        'RescoreCapacityUnits': 123
    }
)
Parameters:
  • Id (string) –

    [REQUIRED]

    The identifier of the rescore execution plan that you want to update.

  • Name (string) – A new name for the rescore execution plan.

  • Description (string) – A new description for the rescore execution plan.

  • CapacityUnits (dict) –

    You can set additional capacity units to meet the needs of your rescore execution plan. You are given a single capacity unit by default. If you want to use the default capacity, you don’t set additional capacity units. For more information on the default capacity and additional capacity units, see Adjusting capacity.

    • RescoreCapacityUnits (integer) – [REQUIRED]

      The amount of extra capacity for your rescore execution plan.

      A single extra capacity unit for a rescore execution plan provides 0.01 rescore requests per second. You can add up to 1000 extra capacity units.

Returns:

None

Exceptions

  • KendraRanking.Client.exceptions.ValidationException

  • KendraRanking.Client.exceptions.ResourceNotFoundException

  • KendraRanking.Client.exceptions.ThrottlingException

  • KendraRanking.Client.exceptions.AccessDeniedException

  • KendraRanking.Client.exceptions.ServiceQuotaExceededException

  • KendraRanking.Client.exceptions.ConflictException

  • KendraRanking.Client.exceptions.InternalServerException