Skip to content

Bedrock AgentCore  >  Operations  >  list_events

list_events

Operation

list_events async 

list_events(input: ListEventsInput, plugins: list[Plugin] | None = None) -> ListEventsOutput

Lists events in an AgentCore Memory resource based on specified criteria. We recommend using pagination to ensure that the operation returns quickly and successfully.

To use this operation, you must have the bedrock-agentcore:ListEvents permission.

Parameters:

Name Type Description Default
input ListEventsInput

An instance of ListEventsInput.

 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
ListEventsOutput

An instance of ListEventsOutput.

Input

ListEventsInput dataclass

Dataclass for ListEventsInput structure.

Attributes

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

The identifier of the actor for which to list events.

filter class-attribute instance-attribute 
filter: FilterInput | None = None

Filter criteria to apply when listing events.

include_payloads class-attribute instance-attribute 
include_payloads: bool = True

Specifies whether to include event payloads in the response. Set to true to include payloads, or false to exclude them.

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

The maximum number of results to return in a single call. The default value is 20.

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

The identifier of the AgentCore Memory resource for which to list events.

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

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

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

The identifier of the session for which to list events.

Output

ListEventsOutput dataclass

Dataclass for ListEventsOutput structure.

Attributes

events instance-attribute 
events: list[Event]

The list of events that match the specified criteria.

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

The token to use in a subsequent request to get the next set of results. This value is null when there are no more results to return.