View source: R/kendra_operations.R
kendra_create_index | R Documentation |
Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine if index creation has completed, check the Status
field returned from a call to describe_index
. The Status
field is set to ACTIVE
when the index is ready to use.
See https://www.paws-r-sdk.com/docs/kendra_create_index/ for full documentation.
kendra_create_index(
Name,
Edition = NULL,
RoleArn,
ServerSideEncryptionConfiguration = NULL,
Description = NULL,
ClientToken = NULL,
Tags = NULL,
UserTokenConfigurations = NULL,
UserContextPolicy = NULL,
UserGroupResolutionConfiguration = NULL
)
Name |
[required] A name for the index. |
Edition |
The Amazon Kendra edition to use for the index. Choose
The For more information on quota limits for Enterprise and Developer editions, see Quotas. |
RoleArn |
[required] The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra. |
ServerSideEncryptionConfiguration |
The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs. |
Description |
A description for the index. |
ClientToken |
A token that you provide to identify the request to create an index.
Multiple calls to the |
Tags |
A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @. |
UserTokenConfigurations |
The user token configuration. |
UserContextPolicy |
The user context policy. ATTRIBUTE_FILTER All indexed content is searchable and displayable for all users. If you
want to filter search results on user context, you can use the attribute
filters of USER_TOKEN Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable. |
UserGroupResolutionConfiguration |
Gets users and groups from IAM Identity Center (successor to Single Sign-On) identity source. To configure this, see UserGroupResolutionConfiguration. |
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.