Skip to content

Bedrock Agent Runtime  >  Operations  >  update_session

update_session

Operation

update_session async 

update_session(input: UpdateSessionInput, plugins: list[Plugin] | None = None) -> UpdateSessionOutput

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.

Parameters:

Name Type Description Default
input UpdateSessionInput

An instance of UpdateSessionInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
UpdateSessionOutput

An instance of UpdateSessionOutput.

Input

UpdateSessionInput dataclass

Dataclass for UpdateSessionInput structure.

Attributes

session_identifier class-attribute instance-attribute 
session_identifier: str | None = None

The unique identifier of the session to modify. You can specify either the session's sessionId or its Amazon Resource Name (ARN).

session_metadata class-attribute instance-attribute 
session_metadata: dict[str, str] | None = None

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.

Output

UpdateSessionOutput dataclass

Dataclass for UpdateSessionOutput structure.

Attributes

created_at instance-attribute 
created_at: datetime

The timestamp for when the session was created.

last_updated_at instance-attribute 
last_updated_at: datetime

The timestamp for when the session was last modified.

session_arn instance-attribute 
session_arn: str

The Amazon Resource Name (ARN) of the session that was updated.

session_id instance-attribute 
session_id: str

The unique identifier of the session you updated.

session_status instance-attribute 
session_status: SessionStatus

The status of the session you updated.