GetIndex
Gets information about an existing Amazon Q Business index.
Request Syntax
GET /applications/applicationId/indices/indexId HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The identifier of the Amazon Q Business application connected to the index.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
- indexId
-
The identifier of the Amazon Q Business index you want information on.
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35}Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"applicationId": "string",
"capacityConfiguration": {
"units": number
},
"createdAt": number,
"description": "string",
"displayName": "string",
"documentAttributeConfigurations": [
{
"name": "string",
"search": "string",
"type": "string"
}
],
"error": {
"errorCode": "string",
"errorMessage": "string"
},
"indexArn": "string",
"indexId": "string",
"indexStatistics": {
"textDocumentStatistics": {
"indexedTextBytes": number,
"indexedTextDocumentCount": number
}
},
"status": "string",
"type": "string",
"updatedAt": number
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- applicationId
-
The identifier of the Amazon Q Business application associated with the index.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35} - capacityConfiguration
-
The storage capacity units chosen for your Amazon Q Business index.
Type: IndexCapacityConfiguration object
- createdAt
-
The Unix timestamp when the Amazon Q Business index was created.
Type: Timestamp
- description
-
The description for the Amazon Q Business index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Pattern:
[\s\S]* - displayName
-
The name of the Amazon Q Business index.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9_-]* - documentAttributeConfigurations
-
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.
Type: Array of DocumentAttributeConfiguration objects
Array Members: Minimum number of 1 item. Maximum number of 500 items.
- error
-
When the
Statusfield value isFAILED, theErrorMessagefield contains a message that explains why.Type: ErrorDetail object
- indexArn
-
The Amazon Resource Name (ARN) of the Amazon Q Business index.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023} - indexId
-
The identifier of the Amazon Q Business index.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]{35} - indexStatistics
-
Provides information about the number of documents indexed.
Type: IndexStatistics object
- status
-
The current status of the index. When the value is
ACTIVE, the index is ready for use. If theStatusfield value isFAILED, theErrorMessagefield contains a message that explains why.Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED | UPDATING - type
-
The type of index attached to your Amazon Q Business application.
Type: String
Valid Values:
ENTERPRISE | STARTER - updatedAt
-
The Unix timestamp when the Amazon Q Business index was last updated.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.
HTTP Status Code: 403
- 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. HTTP Status Code: 500
- ResourceNotFoundException
-
The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to throttling. Reduce the number of requests and try again.
HTTP Status Code: 429
- ValidationException
-
The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
