View a markdown version of this page

Actions, resources, and condition keys for Amazon Kendra Intelligent Ranking - Service Authorization Reference

Actions, resources, and condition keys for Amazon Kendra Intelligent Ranking

Amazon Kendra Intelligent Ranking (service prefix: kendra-ranking) provides the following service-specific operations, resources, actions, and condition keys for use in IAM permission policies.

References:

API operations defined by Amazon Kendra Intelligent Ranking

The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.

Operation IAM action Condition key Possible value(s) Access level

CreateRescoreExecutionPlan

kendra-ranking:CreateRescoreExecutionPlan

Write

kendra-ranking:TagResource

Tagging, Write

DeleteRescoreExecutionPlan

kendra-ranking:DeleteRescoreExecutionPlan

Write

DescribeRescoreExecutionPlan

kendra-ranking:DescribeRescoreExecutionPlan

Read

ListRescoreExecutionPlans

kendra-ranking:ListRescoreExecutionPlans

List

ListTagsForResource

kendra-ranking:ListTagsForResource

Read

Rescore

kendra-ranking:Rescore

Read

TagResource

kendra-ranking:TagResource

Tagging, Write

UntagResource

kendra-ranking:UntagResource

Tagging, Write

UpdateRescoreExecutionPlan

kendra-ranking:UpdateRescoreExecutionPlan

Write

Actions defined by Amazon Kendra Intelligent Ranking

You can specify the following actions in the Action element of an IAM policy statement. Use policies to grant permissions to perform an operation in AWS. When you use an action in a policy, you usually allow or deny access to the API operation or CLI command with the same name. However, in some cases, a single action controls access to more than one operation. Alternatively, some operations require several different actions.

Actions Description Resource types (*required) Condition keys Access level

CreateRescoreExecutionPlan

Grants permission to create a RescoreExecutionPlan

aws:RequestTag/${TagKey}

aws:TagKeys

Write

DeleteRescoreExecutionPlan

Grants permission to delete a RescoreExecutionPlan

rescore-execution-plan*

aws:ResourceTag/${TagKey}

Write

DescribeRescoreExecutionPlan

Grants permission to describe a RescoreExecutionPlan

rescore-execution-plan*

aws:ResourceTag/${TagKey}

Read

ListRescoreExecutionPlans

Grants permission to list all RescoreExecutionPlans

List

ListTagsForResource

Grants permission to list tags for a resource

rescore-execution-plan

aws:ResourceTag/${TagKey}

Read

Rescore

Grants permission to Rescore documents with Kendra Intelligent Ranking

rescore-execution-plan*

aws:ResourceTag/${TagKey}

Read

TagResource

Grants permission to tag a resource with given key value pairs

rescore-execution-plan

aws:RequestTag/${TagKey}

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

UntagResource

Grants permission to remove the tag with the given key from a resource

rescore-execution-plan

aws:ResourceTag/${TagKey}

aws:TagKeys

Tagging, Write

UpdateRescoreExecutionPlan

Grants permission to update a RescoreExecutionPlan

rescore-execution-plan*

aws:ResourceTag/${TagKey}

Write

Resource types defined by Amazon Kendra Intelligent Ranking

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements.

Resource types ARN Condition keys

rescore-execution-plan

arn:${Partition}:kendra-ranking:${Region}:${Account}:rescore-execution-plan/${RescoreExecutionPlanId}

aws:ResourceTag/${TagKey}

Condition keys for Amazon Kendra Intelligent Ranking

Amazon Kendra Intelligent Ranking defines the following condition keys that can be used in the Condition element of an IAM policy.

Condition keys Description Type

aws:RequestTag/${TagKey}

Filters access by the tags that are passed in the request

String

aws:ResourceTag/${TagKey}

Filters access by the tags associated with the resource

String

aws:TagKeys

Filters access by the tag keys that are passed in the request

ArrayOfString