AWS::KendraRanking::ExecutionPlan

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

For an example of using the CreateRescoreExecutionPlan API, including using the Python and Java SDKs, see Semantically ranking a search service's results.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::KendraRanking::ExecutionPlan",
  "Properties" : {
      "CapacityUnits" : CapacityUnitsConfiguration,
      "Description" : String,
      "Name" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::KendraRanking::ExecutionPlan
Properties: 
  CapacityUnits: 
    CapacityUnitsConfiguration
  Description: String
  Name: String
  Tags: 
    - Tag

Properties

CapacityUnits

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.

Required: No

Type: CapacityUnitsConfiguration

Update requires: No interruption

Description

A description for the rescore execution plan.

Required: No

Type: String

Minimum: 0

Maximum: 1000

Pattern: ^\P{C}*$

Update requires: No interruption

Name

A name for the rescore execution plan.

Required: Yes

Type: String

Minimum: 1

Maximum: 1000

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Update requires: No interruption

Tags

A list of key-value pairs that identify or categorize your rescore execution plan. You can also use tags to help control access to the rescore execution plan. Tag keys and values can consist of Unicode letters, digits, white space. They can also consist of underscore, period, colon, equal, plus, and asperand.

Required: No

Type: List of Tag

Maximum: 200

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the rescore execution plan ID. For example:

{"Ref": "rescore-execution-plan-id"}

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAttintrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the rescore execution plan.

Id

The identifier of the rescore execution plan.