Skip to content

list_events

Operation

list_events

list_events(request: ListEventsInput | ListEventsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEventsInputDict]) -> 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
request ListEventsInput | ListEventsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListEventsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListEventsOutput

An instance of ListEventsOutput.

list_events async

list_events(request: ListEventsInput | ListEventsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListEventsInputDict]) -> 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
request ListEventsInput | ListEventsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[ListEventsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListEventsOutput

An instance of ListEventsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListEventsInputDict

Bases: TypedDict

Dictionary form of ListEventsInput.

Attributes

actor_id instance-attribute
actor_id: Required[str]

The identifier of the actor for which to list events.

filter instance-attribute
filter: FilterInput | FilterInputDict | None

Filter criteria to apply when listing events.

include_payloads instance-attribute
include_payloads: bool | None

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

max_results instance-attribute
max_results: int | None

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

memory_id instance-attribute
memory_id: Required[str]

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

next_token instance-attribute
next_token: str | 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 instance-attribute
session_id: Required[str]

The identifier of the session for which to list events.

ListEventsInput dataclass

Bases: _SerdeShape

Dataclass for ListEventsInput structure.

Attributes

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

The identifier of the actor for which to list events.

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

Filter criteria to apply when listing events.

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

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 = ...

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 = ...

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

next_token class-attribute instance-attribute
next_token: str | 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 = ...

The identifier of the session for which to list events.

Output

ListEventsOutput dataclass

Bases: _SerdeShape

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 = ...

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.