kendra / Client / create_index

create_index#

kendra.Client.create_index(**kwargs)#

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 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 API or using one of the supported data sources.

For an example of creating an index and data source using the Python SDK, see Getting started with Python SDK. For an example of creating an index and data source using the Java SDK, see Getting started with Java SDK.

Request Syntax

response = client.create_index(
    Name='string',
    Edition='DEVELOPER_EDITION'|'ENTERPRISE_EDITION',
    RoleArn='string',
    ServerSideEncryptionConfiguration={
        'KmsKeyId': 'string'
    },
    Description='string',
    ClientToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    UserTokenConfigurations=[
        {
            'JwtTokenTypeConfiguration': {
                'KeyLocation': 'URL'|'SECRET_MANAGER',
                'URL': 'string',
                'SecretManagerArn': 'string',
                'UserNameAttributeField': 'string',
                'GroupAttributeField': 'string',
                'Issuer': 'string',
                'ClaimRegex': 'string'
            },
            'JsonTokenTypeConfiguration': {
                'UserNameAttributeField': 'string',
                'GroupAttributeField': 'string'
            }
        },
    ],
    UserContextPolicy='ATTRIBUTE_FILTER'|'USER_TOKEN',
    UserGroupResolutionConfiguration={
        'UserGroupResolutionMode': 'AWS_SSO'|'NONE'
    }
)

Parameters:

Name (string) –
[REQUIRED]

A name for the 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 production. 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.
RoleArn (string) –
[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 (dict) –
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.
- KmsKeyId (string) –
  
  The identifier of the KMS key. Amazon Kendra doesn’t support asymmetric keys.
Description (string) – A description for the index.
ClientToken (string) –
A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

This field is autopopulated if not provided.
Tags (list) –
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: _ . : / = + - @.
- (dict) –
  
  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) – [REQUIRED]
    
    The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, or data source.
  - Value (string) – [REQUIRED]
    
    The value associated with the tag. The value may be an empty string but it can’t be null.
UserTokenConfigurations (list) –
The user token configuration.
- (dict) –
  
  Provides the configuration information for a token.
  - JwtTokenTypeConfiguration (dict) –
    
    Information about the JWT token type configuration.
    - KeyLocation (string) – [REQUIRED]
      
      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 (dict) –
    
    Information about the JSON token type configuration.
    - UserNameAttributeField (string) – [REQUIRED]
      
      The user name attribute field.
    - GroupAttributeField (string) – [REQUIRED]
      
      The group attribute field.
UserContextPolicy (string) –
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_id and _group_ids or you can provide user and group information in UserContext.

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 (dict) –
Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
- UserGroupResolutionMode (string) – [REQUIRED]
  
  The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string'
}

Response Structure

(dict) –
- Id (string) –
  
  The identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.

Exceptions

kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ResourceAlreadyExistException
kendra.Client.exceptions.ServiceQuotaExceededException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.ConflictException
kendra.Client.exceptions.InternalServerException