| Package | Description |
|---|---|
| com.amazonaws.services.qbusiness |
This is the Amazon Q Business API Reference.
|
| com.amazonaws.services.qbusiness.model |
| Modifier and Type | Method and Description |
|---|---|
GetIndexResult |
AWSQBusinessClient.getIndex(GetIndexRequest request)
Gets information about an existing Amazon Q Business index.
|
GetIndexResult |
AbstractAWSQBusiness.getIndex(GetIndexRequest request) |
GetIndexResult |
AWSQBusiness.getIndex(GetIndexRequest getIndexRequest)
Gets information about an existing Amazon Q Business index.
|
| Modifier and Type | Method and Description |
|---|---|
Future<GetIndexResult> |
AbstractAWSQBusinessAsync.getIndexAsync(GetIndexRequest request) |
Future<GetIndexResult> |
AWSQBusinessAsync.getIndexAsync(GetIndexRequest getIndexRequest)
Gets information about an existing Amazon Q Business index.
|
Future<GetIndexResult> |
AWSQBusinessAsyncClient.getIndexAsync(GetIndexRequest request) |
Future<GetIndexResult> |
AbstractAWSQBusinessAsync.getIndexAsync(GetIndexRequest request,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler) |
Future<GetIndexResult> |
AWSQBusinessAsync.getIndexAsync(GetIndexRequest getIndexRequest,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler)
Gets information about an existing Amazon Q Business index.
|
Future<GetIndexResult> |
AWSQBusinessAsyncClient.getIndexAsync(GetIndexRequest request,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler) |
| Modifier and Type | Method and Description |
|---|---|
Future<GetIndexResult> |
AbstractAWSQBusinessAsync.getIndexAsync(GetIndexRequest request,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler) |
Future<GetIndexResult> |
AWSQBusinessAsync.getIndexAsync(GetIndexRequest getIndexRequest,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler)
Gets information about an existing Amazon Q Business index.
|
Future<GetIndexResult> |
AWSQBusinessAsyncClient.getIndexAsync(GetIndexRequest request,
AsyncHandler<GetIndexRequest,GetIndexResult> asyncHandler) |
| Modifier and Type | Method and Description |
|---|---|
GetIndexResult |
GetIndexResult.clone() |
GetIndexResult |
GetIndexResult.withApplicationId(String applicationId)
The identifier of the Amazon Q Business application associated with the index.
|
GetIndexResult |
GetIndexResult.withCapacityConfiguration(IndexCapacityConfiguration capacityConfiguration)
The storage capacity units chosen for your Amazon Q Business index.
|
GetIndexResult |
GetIndexResult.withCreatedAt(Date createdAt)
The Unix timestamp when the Amazon Q Business index was created.
|
GetIndexResult |
GetIndexResult.withDescription(String description)
The description for the Amazon Q Business index.
|
GetIndexResult |
GetIndexResult.withDisplayName(String displayName)
The name of the Amazon Q Business index.
|
GetIndexResult |
GetIndexResult.withDocumentAttributeConfigurations(Collection<DocumentAttributeConfiguration> documentAttributeConfigurations)
Configuration information for document attributes or metadata.
|
GetIndexResult |
GetIndexResult.withDocumentAttributeConfigurations(DocumentAttributeConfiguration... documentAttributeConfigurations)
Configuration information for document attributes or metadata.
|
GetIndexResult |
GetIndexResult.withError(ErrorDetail error)
When the
Status field value is FAILED, the ErrorMessage field contains a
message that explains why. |
GetIndexResult |
GetIndexResult.withIndexArn(String indexArn)
The Amazon Resource Name (ARN) of the Amazon Q Business index.
|
GetIndexResult |
GetIndexResult.withIndexId(String indexId)
The identifier of the Amazon Q Business index.
|
GetIndexResult |
GetIndexResult.withIndexStatistics(IndexStatistics indexStatistics)
Provides information about the number of documents indexed.
|
GetIndexResult |
GetIndexResult.withStatus(IndexStatus status)
The current status of the index.
|
GetIndexResult |
GetIndexResult.withStatus(String status)
The current status of the index.
|
GetIndexResult |
GetIndexResult.withType(IndexType type)
The type of index attached to your Amazon Q Business application.
|
GetIndexResult |
GetIndexResult.withType(String type)
The type of index attached to your Amazon Q Business application.
|
GetIndexResult |
GetIndexResult.withUpdatedAt(Date updatedAt)
The Unix timestamp when the Amazon Q Business index was last updated.
|
Copyright © 2024. All rights reserved.