GetIndexCommand

Suggest an Edit

Gets information about an existing Amazon Q Business index.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QBusinessClient, GetIndexCommand } from "@aws-sdk/client-qbusiness"; // ES Modules import
// const { QBusinessClient, GetIndexCommand } = require("@aws-sdk/client-qbusiness"); // CommonJS import
const client = new QBusinessClient(config);
const input = { // GetIndexRequest
  applicationId: "STRING_VALUE", // required
  indexId: "STRING_VALUE", // required
};
const command = new GetIndexCommand(input);
const response = await client.send(command);
// { // GetIndexResponse
//   applicationId: "STRING_VALUE",
//   indexId: "STRING_VALUE",
//   displayName: "STRING_VALUE",
//   indexArn: "STRING_VALUE",
//   status: "CREATING" || "ACTIVE" || "DELETING" || "FAILED" || "UPDATING",
//   type: "ENTERPRISE" || "STARTER",
//   description: "STRING_VALUE",
//   createdAt: new Date("TIMESTAMP"),
//   updatedAt: new Date("TIMESTAMP"),
//   capacityConfiguration: { // IndexCapacityConfiguration
//     units: Number("int"),
//   },
//   documentAttributeConfigurations: [ // DocumentAttributeConfigurations
//     { // DocumentAttributeConfiguration
//       name: "STRING_VALUE",
//       type: "STRING" || "STRING_LIST" || "NUMBER" || "DATE",
//       search: "ENABLED" || "DISABLED",
//     },
//   ],
//   error: { // ErrorDetail
//     errorMessage: "STRING_VALUE",
//     errorCode: "InternalError" || "InvalidRequest" || "ResourceInactive" || "ResourceNotFound",
//   },
//   indexStatistics: { // IndexStatistics
//     textDocumentStatistics: { // TextDocumentStatistics
//       indexedTextBytes: Number("long"),
//       indexedTextDocumentCount: Number("int"),
//     },
//   },
// };

GetIndexCommand Input

See GetIndexCommandInput for more details

Parameter
Type
Description
applicationId
Required
string | undefined

The identifier of the Amazon Q Business application connected to the index.

indexId
Required
string | undefined

The identifier of the Amazon Q Business index you want information on.

GetIndexCommand Output

See GetIndexCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
applicationId
string | undefined

The identifier of the Amazon Q Business application associated with the index.

capacityConfiguration
IndexCapacityConfiguration | undefined

The storage capacity units chosen for your Amazon Q Business index.

createdAt
Date | undefined

The Unix timestamp when the Amazon Q Business index was created.

description
string | undefined

The description for the Amazon Q Business index.

displayName
string | undefined

The name of the Amazon Q Business index.

documentAttributeConfigurations
DocumentAttributeConfiguration[] | undefined

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
ErrorDetail | undefined

When the Status field value is FAILED, the ErrorMessage field contains a message that explains why.

indexArn
string | undefined

The Amazon Resource Name (ARN) of the Amazon Q Business index.

indexId
string | undefined

The identifier of the Amazon Q Business index.

indexStatistics
IndexStatistics | undefined

Provides information about the number of documents indexed.

status
IndexStatus | undefined

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.

type
IndexType | undefined

The type of index attached to your Amazon Q Business application.

updatedAt
Date | undefined

The Unix timestamp when the Amazon Q Business index was last updated.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.

InternalServerException
server

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
client

The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to throttling. Reduce the number of requests and try again.

ValidationException
client

The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.

QBusinessServiceException
Base exception class for all service exceptions from QBusiness service.