AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateIndexAsync.

Namespace: Amazon.Kendra
Assembly: AWSSDK.Kendra.dll
Version: 3.x.y.z

Syntax

C#
public virtual CreateIndexResponse CreateIndex(
         CreateIndexRequest request
)

Parameters

request
Type: Amazon.Kendra.Model.CreateIndexRequest

Container for the necessary parameters to execute the CreateIndex service method.

Return Value


The response from the CreateIndex service method, as returned by Kendra.

Exceptions

ExceptionCondition
AccessDeniedException You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.
ConflictException A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
InternalServerException An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.
ResourceAlreadyExistException The resource you want to use already exists. Please check you have provided the correct resource and try again.
ServiceQuotaExceededException You have exceeded the set limits for your Amazon Kendra service. Please see Quotas for more information, or contact Support to inquire about an increase of limits.
ThrottlingException The request was denied due to request throttling. Please reduce the number of requests and try again.
ValidationException The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also