UpdateSessionCommand

Suggest an Edit

Updates a session. A session is a contextual container used for generating recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect is enabled.

Example Syntax

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

import { QConnectClient, UpdateSessionCommand } from "@aws-sdk/client-qconnect"; // ES Modules import
// const { QConnectClient, UpdateSessionCommand } = require("@aws-sdk/client-qconnect"); // CommonJS import
const client = new QConnectClient(config);
const input = { // UpdateSessionRequest
  assistantId: "STRING_VALUE", // required
  sessionId: "STRING_VALUE", // required
  description: "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
    },
  },
};
const command = new UpdateSessionCommand(input);
const response = await client.send(command);
// { // UpdateSessionResponse
//   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
//       },
//     },
//   },
// };

UpdateSessionCommand Input

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

aiAgentConfiguration
Partial<Record<AIAgentType, AIAgentConfigurationData> | undefined

The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that should be used by Amazon Q in Connect for this Session.

description
string | undefined

The description.

tagFilter
TagFilter | undefined

An object that can be used to specify Tag conditions.

UpdateSessionCommand Output

See UpdateSessionCommandOutput for details

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

Information about 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.