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.

Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginIndexDocuments and EndIndexDocuments.

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

Syntax

C#
public abstract Task<IndexDocumentsResponse> IndexDocumentsAsync(
         IndexDocumentsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudSearch.Model.IndexDocumentsRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the IndexDocuments service method, as returned by CloudSearch.

Exceptions

ExceptionCondition
BaseException An error occurred while processing the request.
InternalException An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.
ResourceNotFoundException The request was rejected because it attempted to reference a resource that does not exist.
ValidationException The request was rejected because it has invalid parameters.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also