UpdateSession
Updates the metadata or encryption settings of a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.
Request Syntax
PUT /sessions/sessionIdentifier/ HTTP/1.1
Content-type: application/json
{
"sessionMetadata": {
"string" : "string"
}
}URI Request Parameters
The request uses the following URI parameters.
- sessionIdentifier
-
The unique identifier of the session to modify. You can specify either the session's
sessionIdor its Amazon Resource Name (ARN).Pattern:
^(arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[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})$Required: Yes
Request Body
The request accepts the following data in JSON format.
- sessionMetadata
-
A map of key-value pairs containing attributes to be persisted across the session. For example the user's ID, their language preference, and the type of device they are using.
Type: String to string map
Map Entries: Minimum number of 0 items. Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 100.
Value Length Constraints: Minimum length of 0. Maximum length of 5000.
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"createdAt": "string",
"lastUpdatedAt": "string",
"sessionArn": "string",
"sessionId": "string",
"sessionStatus": "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.
- createdAt
-
The timestamp for when the session was created.
Type: Timestamp
- lastUpdatedAt
-
The timestamp for when the session was last modified.
Type: Timestamp
- sessionArn
-
The Amazon Resource Name (ARN) of the session that was updated.
Type: String
Pattern:
^arn:aws(-[^:]+)?:bedrock:[a-z0-9-]+:[0-9]{12}:session/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - sessionId
-
The unique identifier of the session you updated.
Type: String
Pattern:
^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - sessionStatus
-
The status of the session you updated.
Type: String
Valid Values:
ACTIVE | EXPIRED | ENDED
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The request is denied because of missing access permissions. Check your permissions and retry your request.
HTTP Status Code: 403
- ConflictException
-
There was a conflict performing an operation. Resolve the conflict and retry your request.
HTTP Status Code: 409
- InternalServerException
-
An internal server error occurred. Retry your request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests exceeds the limit. Resubmit your request later.
HTTP Status Code: 429
- ValidationException
-
Input validation failed. Check your request parameters and retry the request.
HTTP Status Code: 400
Examples
Example request
This example illustrates one usage of UpdateSession.
PUT bedrock-agent-runtime.us-east-1.amazonaws.com/sessions/12345abc-1234-abcd-1234-abcdef123456/ HTTP/1.1
Content-type: application/json
{
"sessionMetadata": {
"userLanguage" : "French"
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
