Skip to content

Bedrock Agent Runtime  >  Operations  >  end_session

end_session

Operation

end_session async 

end_session(input: EndSessionInput, plugins: list[Plugin] | None = None) -> EndSessionOutput

Ends the session. After you end a session, you can still access its content but you can't add to it. To delete the session and it's content, you use the DeleteSession API operation. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

Name Type Description Default
input EndSessionInput

An instance of EndSessionInput.

 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
EndSessionOutput

An instance of EndSessionOutput.

Input

EndSessionInput dataclass

Dataclass for EndSessionInput structure.

Attributes

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

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

Output

EndSessionOutput dataclass

Dataclass for EndSessionOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

session_arn instance-attribute 
session_arn: str

The Amazon Resource Name (ARN) of the session you ended.

session_id instance-attribute 
session_id: str

The unique identifier of the session you ended.

session_status instance-attribute 
session_status: str

The current status of the session you ended.