Skip to content

Bedrock Agent Runtime  >  Operations  >  list_sessions

list_sessions

Operation

list_sessions async

list_sessions(input: ListSessionsInput, plugins: list[Plugin] | None = None) -> ListSessionsOutput

Lists all sessions in your Amazon Web Services account. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

Parameters:

Name Type Description Default
input ListSessionsInput

An instance of ListSessionsInput.

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
ListSessionsOutput

An instance of ListSessionsOutput.

Input

ListSessionsInput dataclass

Dataclass for ListSessionsInput structure.

Attributes

max_results class-attribute instance-attribute
max_results: int = 10

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

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

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Output

ListSessionsOutput dataclass

Dataclass for ListSessionsOutput structure.

Attributes

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

If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

session_summaries instance-attribute
session_summaries: list[SessionSummary]

A list of summaries for each session in your Amazon Web Services account.