UpdateSessionData
Updates the data stored on an Amazon Q in Connect Session.
Request Syntax
PATCH /assistants/assistantId/sessions/sessionId/data HTTP/1.1
Content-type: application/json
{
"data": [
{
"key": "string",
"value": { ... }
}
],
"namespace": "string"
}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.
- data
-
The data stored on the Amazon Q in Connect Session.
Type: Array of RuntimeSessionData objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: Yes
- namespace
-
The namespace into which the session data is stored. Supported namespaces are: Custom
Type: String
Valid Values:
CustomRequired: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"data": [
{
"key": "string",
"value": { ... }
}
],
"namespace": "string",
"sessionArn": "string",
"sessionId": "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.
- data
-
Data stored in the session.
Type: Array of RuntimeSessionData objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- namespace
-
The namespace into which the session data is stored. Supported namespaces are: Custom
Type: String
Valid Values:
Custom - sessionArn
-
The Amazon Resource Name (ARN) of the session.
Type: String
Pattern:
^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}$ - sessionId
-
The identifier of the session.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$
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:
