UpdateSession
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.
Request Syntax
POST /assistants/assistantId/sessions/sessionId HTTP/1.1
Content-type: application/json
{
"aiAgentConfiguration": {
"string" : {
"aiAgentId": "string"
}
},
"description": "string",
"tagFilter": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- assistantId
-
The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
- sessionId
-
The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- aiAgentConfiguration
-
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.
Type: String to AIAgentConfigurationData object map
Valid Keys:
MANUAL_SEARCH | ANSWER_RECOMMENDATION | SELF_SERVICERequired: No
- description
-
The description.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[a-zA-Z0-9\s_.,-]+Required: No
- tagFilter
-
An object that can be used to specify Tag conditions.
Type: TagFilter object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"session": {
"aiAgentConfiguration": {
"string" : {
"aiAgentId": "string"
}
},
"description": "string",
"integrationConfiguration": {
"topicIntegrationArn": "string"
},
"name": "string",
"sessionArn": "string",
"sessionId": "string",
"tagFilter": { ... },
"tags": {
"string" : "string"
}
}
}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.
- session
-
Information about the session.
Type: SessionData object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
