Table Of Contents


User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . kendra ]



Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to DescribeIndex . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the BatchPutDocument operation or using one of the supported data sources.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


--name <value>
[--edition <value>]
--role-arn <value>
[--server-side-encryption-configuration <value>]
[--description <value>]
[--client-token <value>]
[--tags <value>]
[--user-token-configurations <value>]
[--user-context-policy <value>]
[--user-group-resolution-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--name (string)

The name for the new index.

--edition (string)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for your production databases. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION .

For more information on quota limits for enterprise and developer editions, see Quotas .

Possible values:


--role-arn (string)

An Identity and Access Management(IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

--server-side-encryption-configuration (structure)

The identifier of the KMScustomer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

KmsKeyId -> (string)

The identifier of the KMScustomer master key (CMK). Amazon Kendra doesn't support asymmetric CMKs.

Shorthand Syntax:


JSON Syntax:

  "KmsKeyId": "string"

--description (string)

A description for the index.

--client-token (string)

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex operation with the same client token will create only one index.

--tags (list)

A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.


A list of key/value pairs that identify an index, FAQ, or data source. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Key -> (string)

The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.

Value -> (string)

The value associated with the tag. The value may be an empty string but it can't be null.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

    "Key": "string",
    "Value": "string"

--user-token-configurations (list)

The user token configuration.


Provides configuration information for a token configuration.

JwtTokenTypeConfiguration -> (structure)

Information about the JWT token type configuration.

KeyLocation -> (string)

The location of the key.

URL -> (string)

The signing key URL.

SecretManagerArn -> (string)

The Amazon Resource Name (arn) of the secret.

UserNameAttributeField -> (string)

The user name attribute field.

GroupAttributeField -> (string)

The group attribute field.

Issuer -> (string)

The issuer of the token.

ClaimRegex -> (string)

The regular expression that identifies the claim.

JsonTokenTypeConfiguration -> (structure)

Information about the JSON token type configuration.

UserNameAttributeField -> (string)

The user name attribute field.

GroupAttributeField -> (string)

The group attribute field.

Shorthand Syntax:

JwtTokenTypeConfiguration={KeyLocation=string,URL=string,SecretManagerArn=string,UserNameAttributeField=string,GroupAttributeField=string,Issuer=string,ClaimRegex=string},JsonTokenTypeConfiguration={UserNameAttributeField=string,GroupAttributeField=string} ...

JSON Syntax:

    "JwtTokenTypeConfiguration": {
      "KeyLocation": "URL"|"SECRET_MANAGER",
      "URL": "string",
      "SecretManagerArn": "string",
      "UserNameAttributeField": "string",
      "GroupAttributeField": "string",
      "Issuer": "string",
      "ClaimRegex": "string"
    "JsonTokenTypeConfiguration": {
      "UserNameAttributeField": "string",
      "GroupAttributeField": "string"

--user-context-policy (string)

The user context policy.


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_id and _group_ids or you can provide user and group information in UserContext .


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.

Possible values:


--user-group-resolution-configuration (structure)

Enables fetching access levels of groups and users from an AWS Single Sign-On identity source. To configure this, see UserGroupResolutionConfiguration .

UserGroupResolutionMode -> (string)

The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode.

Shorthand Syntax:


JSON Syntax:

  "UserGroupResolutionMode": "AWS_SSO"|"NONE"

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.


Id -> (string)

The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.