Skip to content

Bedrock Agent Runtime  >  Operations  >  delete_session

delete_session

Operation

delete_session async 

delete_session(input: DeleteSessionInput, plugins: list[Plugin] | None = None) -> DeleteSessionOutput

Deletes a session that you ended. You can't delete a session with an ACTIVE status. To delete an active session, you must first end it with the EndSession 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 DeleteSessionInput

An instance of DeleteSessionInput.

 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
DeleteSessionOutput

An instance of DeleteSessionOutput.

Input

DeleteSessionInput dataclass

Dataclass for DeleteSessionInput structure.

Attributes

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

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

Output

DeleteSessionOutput dataclass

Dataclass for DeleteSessionOutput 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.