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.

The query search index.

Requires permission to access the SearchIndex action.

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 BeginSearchIndex and EndSearchIndex.

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

Syntax

C#
public virtual Task<SearchIndexResponse> SearchIndexAsync(
         SearchIndexRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IoT.Model.SearchIndexRequest

Container for the necessary parameters to execute the SearchIndex 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 SearchIndex service method, as returned by IoT.

Exceptions

ExceptionCondition
IndexNotReadyException The index is not ready.
InternalFailureException An unexpected error has occurred.
InvalidQueryException The query is invalid.
InvalidRequestException The request is not valid.
ResourceNotFoundException The specified resource does not exist.
ServiceUnavailableException The service is temporarily unavailable.
ThrottlingException The rate exceeds the limit.
UnauthorizedException You are not authorized to perform this operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also