GetSessionCommand

Suggest an Edit

Retrieves information for a specified session.

Example Syntax

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

import { QConnectClient, GetSessionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, GetSessionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // GetSessionRequest
  assistantId: "STRING_VALUE", // required
  sessionId: "STRING_VALUE", // required
};
const command = new GetSessionCommand(input);
const response = await client.send(command);
// { // GetSessionResponse
//   session: { // SessionData
//     sessionArn: "STRING_VALUE", // required
//     sessionId: "STRING_VALUE", // required
//     name: "STRING_VALUE", // required
//     description: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     integrationConfiguration: { // SessionIntegrationConfiguration
//       topicIntegrationArn: "STRING_VALUE",
//     },
//     tagFilter: { // TagFilter Union: only one key present
//       tagCondition: { // TagCondition
//         key: "STRING_VALUE", // required
//         value: "STRING_VALUE",
//       },
//       andConditions: [ // AndConditions
//         {
//           key: "STRING_VALUE", // required
//           value: "STRING_VALUE",
//         },
//       ],
//       orConditions: [ // OrConditions
//         { // OrCondition Union: only one key present
//           andConditions: [
//             "<TagCondition>",
//           ],
//           tagCondition: "<TagCondition>",
//         },
//       ],
//     },
//     aiAgentConfiguration: { // AIAgentConfigurationMap
//       "<keys>": { // AIAgentConfigurationData
//         aiAgentId: "STRING_VALUE", // required
//       },
//     },
//   },
// };

GetSessionCommand Input

See GetSessionCommandInput 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.

sessionId
Required
string | undefined

The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

GetSessionCommand Output

See GetSessionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
session
SessionData | undefined

The session.

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.