get_index¶
Operation¶
get_index
¶
get_index(request: GetIndexInput | GetIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIndexInputDict]) -> GetIndexOutput
Gets information about an existing Amazon Q Business index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIndexInput | GetIndexInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetIndexInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIndexOutput
|
An instance of |
get_index
async
¶
get_index(request: GetIndexInput | GetIndexInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIndexInputDict]) -> GetIndexOutput
Gets information about an existing Amazon Q Business index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
GetIndexInput | GetIndexInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[GetIndexInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIndexOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
GetIndexOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIndexOutput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the Amazon Q Business application associated with the index.
capacity_configuration
class-attribute
instance-attribute
¶
capacity_configuration: IndexCapacityConfiguration | None = ...
The storage capacity units chosen for your Amazon Q Business index.
created_at
class-attribute
instance-attribute
¶
created_at: datetime | None = ...
The Unix timestamp when the Amazon Q Business index was created.
description
class-attribute
instance-attribute
¶
description: str | None = ...
The description for the Amazon Q Business index.
display_name
class-attribute
instance-attribute
¶
display_name: str | None = ...
The name of the Amazon Q Business index.
document_attribute_configurations
class-attribute
instance-attribute
¶
document_attribute_configurations: list[DocumentAttributeConfiguration] | 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.
error
class-attribute
instance-attribute
¶
error: ErrorDetail | None = ...
When the Status field value is FAILED, the ErrorMessage field
contains a message that explains why.
index_arn
class-attribute
instance-attribute
¶
index_arn: str | None = ...
The Amazon Resource Name (ARN) of the Amazon Q Business index.
index_id
class-attribute
instance-attribute
¶
index_id: str | None = ...
The identifier of the Amazon Q Business index.
index_statistics
class-attribute
instance-attribute
¶
index_statistics: IndexStatistics | None = ...
Provides information about the number of documents indexed.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
status
class-attribute
instance-attribute
¶
status: str | 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.