GetAssistantCommand

Suggest an Edit

Retrieves information about an assistant.

Example Syntax

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

import { QConnectClient, GetAssistantCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, GetAssistantCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // GetAssistantRequest
  assistantId: "STRING_VALUE", // required
};
const command = new GetAssistantCommand(input);
const response = await client.send(command);
// { // GetAssistantResponse
//   assistant: { // AssistantData
//     assistantId: "STRING_VALUE", // required
//     assistantArn: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     type: "STRING_VALUE", // required
//     status: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     serverSideEncryptionConfiguration: { // ServerSideEncryptionConfiguration
//       kmsKeyId: "STRING_VALUE",
//     },
//     integrationConfiguration: { // AssistantIntegrationConfiguration
//       topicIntegrationArn: "STRING_VALUE",
//     },
//     capabilityConfiguration: { // AssistantCapabilityConfiguration
//       type: "STRING_VALUE",
//     },
//     aiAgentConfiguration: { // AIAgentConfigurationMap
//       "<keys>": { // AIAgentConfigurationData
//         aiAgentId: "STRING_VALUE", // required
//       },
//     },
//   },
// };

GetAssistantCommand Input

See GetAssistantCommandInput for more details

Parameter
Type
Description
assistantId
Required
string | undefined

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

GetAssistantCommand Output

See GetAssistantCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
assistant
AssistantData | undefined

Information about the assistant.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ResourceNotFoundException
client

The specified resource does not exist.

ValidationException
client

The input fails to satisfy the constraints specified by a service.

QConnectServiceException
Base exception class for all service exceptions from QConnect service.