get_index¶
Operation¶
async
¶
get_index(input: GetIndexInput, plugins: list[Plugin] | None = None) -> GetIndexOutput
Gets information about an existing Amazon Q Business index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
GetIndexInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
GetIndexOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for GetIndexInput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application connected to the index.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the Amazon Q Business index you want information on.
Output¶
dataclass
¶
Dataclass for GetIndexOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
application_id: str | None = None
The identifier of the Amazon Q Business application associated with the index.
class-attribute
instance-attribute
¶
capacity_configuration: IndexCapacityConfiguration | None = None
The storage capacity units chosen for your Amazon Q Business index.
class-attribute
instance-attribute
¶
created_at: datetime | None = None
The Unix timestamp when the Amazon Q Business index was created.
class-attribute
instance-attribute
¶
description: str | None = None
The description for the Amazon Q Business index.
class-attribute
instance-attribute
¶
display_name: str | None = None
The name of the Amazon Q Business index.
class-attribute
instance-attribute
¶
document_attribute_configurations: list[DocumentAttributeConfiguration] | None = None
Configuration information for document attributes or metadata. Document metadata are fields associated with your documents. For example, the company department name associated with each document. For more information, see Understanding document attributes.
class-attribute
instance-attribute
¶
error: ErrorDetail | None = None
When the Status field value is FAILED, the ErrorMessage field
contains a message that explains why.
class-attribute
instance-attribute
¶
index_arn: str | None = None
The Amazon Resource Name (ARN) of the Amazon Q Business index.
class-attribute
instance-attribute
¶
index_id: str | None = None
The identifier of the Amazon Q Business index.
class-attribute
instance-attribute
¶
index_statistics: IndexStatistics | None = None
Provides information about the number of documents indexed.
class-attribute
instance-attribute
¶
status: IndexStatus | None = None
The current status of the index. When the value is ACTIVE, the index
is ready for use. If the Status field value is FAILED, the
ErrorMessage field contains a message that explains why.
class-attribute
instance-attribute
¶
type: IndexType | None = None
The type of index attached to your Amazon Q Business application.
class-attribute
instance-attribute
¶
updated_at: datetime | None = None
The Unix timestamp when the Amazon Q Business index was last updated.