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	awscc.kendraranking.execution_plans

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string	Unique ID of rescore execution plan
region	string	AWS region.

For more information, see AWS::KendraRanking::ExecutionPlan.

Methods

Name	Resource	Accessible by	Required Params
create_resource	execution_plans	INSERT	Name, region
delete_resource	execution_plans	DELETE	Identifier, region
update_resource	execution_plans	UPDATE	Identifier, PatchDocument, region
list_resources	execution_plans_list_only	SELECT	region
get_resource	execution_plans	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual execution_plan.

SELECT
  region,
  id,
  arn,
  description,
  tags,
  name,
  capacity_units
FROM awscc.kendraranking.execution_plans
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all execution_plans in a region.

SELECT
  region,
  id
FROM awscc.kendraranking.execution_plans_list_only
WHERE
  region = '{{ region }}';

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 awscc.kendraranking.execution_plans (
  Name,
  region
)
SELECT
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.kendraranking.execution_plans (
  Description,
  Tags,
  Name,
  CapacityUnits,
  region
)
SELECT
  '{{ description }}',
  '{{ tags }}',
  '{{ name }}',
  '{{ capacity_units }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: capacity_units
      value:
        rescore_capacity_units: '{{ rescore_capacity_units }}'

UPDATE example

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

/*+ update */
UPDATE awscc.kendraranking.execution_plans
SET PatchDocument = string('{{ {
    "Description": description,
    "Tags": tags,
    "Name": name,
    "CapacityUnits": capacity_units
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.kendraranking.execution_plans
WHERE
  Identifier = '{{ id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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