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 an existing Amazon Q Business index.

Note:

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

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

Syntax

C#
public abstract GetIndexResponse GetIndex(
         GetIndexRequest request
)

Parameters

request
Type: Amazon.QBusiness.Model.GetIndexRequest

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

Return Value


The response from the GetIndex service method, as returned by QBusiness.

Exceptions

ExceptionCondition
AccessDeniedException You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
InternalServerException An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact Support for help.
ResourceNotFoundException The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
ThrottlingException The request was denied due to throttling. Reduce the number of requests and try again.
ValidationException The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

Version Information

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

See Also