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.

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

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 BeginDefineIndexField and EndDefineIndexField.

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

Syntax

C#
public virtual Task<DefineIndexFieldResponse> DefineIndexFieldAsync(
         DefineIndexFieldRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudSearch.Model.DefineIndexFieldRequest

Container for the necessary parameters to execute the DefineIndexField 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 DefineIndexField 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.
InvalidTypeException The request was rejected because it specified an invalid type definition.
LimitExceededException The request was rejected because a resource limit has already been met.
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