execution_plans

Creates, updates, deletes or gets an execution_plan resource or lists execution_plans in a region

Overview

Name	execution_plans
Type	Resource
Description	A KendraRanking Rescore execution plan
Id	aws.kendraranking.execution_plans

Fields

Name	Datatype	Description
id	string	Unique ID of rescore execution plan
arn	string
description	string	A description for the execution plan
tags	array	Tags for labeling the execution plan
name	string	Name of kendra ranking rescore execution plan
capacity_units	object	Capacity units
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all execution_plans in a region.

SELECT
region,
id,
arn,
description,
tags,
name,
capacity_units
FROM aws.kendraranking.execution_plans
WHERE region = 'us-east-1';

Gets all properties from an individual execution_plan.

SELECT
region,
id,
arn,
description,
tags,
name,
capacity_units
FROM aws.kendraranking.execution_plans
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new execution_plan resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.kendraranking.execution_plans (
 Name,
 region
)
SELECT 
'{{ Name }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.kendraranking.execution_plans (
 Description,
 Tags,
 Name,
 CapacityUnits,
 region
)
SELECT 
 '{{ Description }}',
 '{{ Tags }}',
 '{{ Name }}',
 '{{ CapacityUnits }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: execution_plan
    props:
      - name: Description
        value: '{{ Description }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: Name
        value: '{{ Name }}'
      - name: CapacityUnits
        value:
          RescoreCapacityUnits: '{{ RescoreCapacityUnits }}'

DELETE example

/*+ delete */
DELETE FROM aws.kendraranking.execution_plans
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the execution_plans resource, the following permissions are required:

Create

kendra-ranking:CreateRescoreExecutionPlan,
kendra-ranking:DescribeRescoreExecutionPlan,
kendra-ranking:UpdateRescoreExecutionPlan,
kendra-ranking:ListTagsForResource,
kendra-ranking:TagResource

Read

kendra-ranking:DescribeRescoreExecutionPlan,
kendra-ranking:ListTagsForResource

Update

kendra-ranking:DescribeRescoreExecutionPlan,
kendra-ranking:UpdateRescoreExecutionPlan,
kendra-ranking:ListTagsForResource,
kendra-ranking:TagResource,
kendra-ranking:UntagResource

Delete

kendra-ranking:DescribeRescoreExecutionPlan,
kendra-ranking:DeleteRescoreExecutionPlan

List

kendra-ranking:ListRescoreExecutionPlans