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.

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information 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 BeginDescribeIndexFields and EndDescribeIndexFields.

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

Syntax

C#
public abstract Task<DescribeIndexFieldsResponse> DescribeIndexFieldsAsync(
         DescribeIndexFieldsRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.CloudSearch.Model.DescribeIndexFieldsRequest

Container for the necessary parameters to execute the DescribeIndexFields 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 DescribeIndexFields 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also