Actions, resources, and condition keys for Amazon Kendra - AWS Identity and Access Management

Actions, resources, and condition keys for Amazon Kendra

Tip

This page is moving to a new location on November 16, 2020. Please update your bookmark to use the new page at https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html.

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

References:

Actions defined by Amazon Kendra

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.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
BatchDeleteDocument Batch Delete document Write

index*

BatchPutDocument Batch put document Write

index*

CreateDataSource Create a data source Write

index*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateFaq Create an Faq Write

index*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateIndex Create an Index Write

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteDataSource Delete a data source Write

data-source*

index*

DeleteFaq Delete an Faq Write

faq*

index*

DeleteIndex Delete an Index Write

index*

DescribeDataSource Describe a data source Read

data-source*

index*

DescribeFaq Describe an Faq Read

faq*

index*

DescribeIndex Describe an Index Read

index*

ListDataSourceSyncJobs Get Data Source sync job history List

data-source*

index*

ListDataSources List the data sources List

index*

ListFaqs List the Faqs List

index*

ListIndices List the indexes List
ListTagsForResource Lists tags for a resource List

data-source

faq

index

Query Query documents and Faqs Read

index*

StartDataSourceSyncJob Start Data Source sync job Write

data-source*

index*

StopDataSourceSyncJob Stop Data Source sync job Write

data-source*

index*

SubmitFeedback Send feedback about a query results Write

index*

TagResource Tags a resource with given key value pairs Tagging

data-source

faq

index

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Removes the tag with the given key from a resource Tagging

data-source

faq

index

aws:TagKeys

UpdateDataSource Update a data source Write

data-source*

index*

UpdateIndex Update an Index Write

index*

Resource types defined by Amazon Kendra

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
index arn:${Partition}:kendra:${Region}:${Account}:index/${IndexId}

aws:ResourceTag/${TagKey}

data-source arn:${Partition}:kendra:${Region}:${Account}:index/${IndexId}/data-source/${DataSourceId}

aws:ResourceTag/${TagKey}

faq arn:${Partition}:kendra:${Region}:${Account}:index/${IndexId}/faq/${FaqId}

aws:ResourceTag/${TagKey}

Condition keys for Amazon Kendra

Amazon Kendra defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters create requests based on the allowed set of values for each of the mandatory tags. String
aws:ResourceTag/${TagKey} Filters actions based on the tag value associated with the resource. String
aws:TagKeys Filters create requests based on the presence of mandatory tags in the request. String