Skip to content

list_memories

Operation

list_memories

list_memories(request: ListMemoriesInput | ListMemoriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoriesInputDict]) -> ListMemoriesOutput

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Parameters:

Name Type Description Default
request ListMemoriesInput | ListMemoriesInputDict | 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[ListMemoriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListMemoriesOutput

An instance of ListMemoriesOutput.

list_memories async

list_memories(request: ListMemoriesInput | ListMemoriesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoriesInputDict]) -> ListMemoriesOutput

Lists the available Amazon Bedrock AgentCore Memory resources in the current Amazon Web Services Region.

Parameters:

Name Type Description Default
request ListMemoriesInput | ListMemoriesInputDict | 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[ListMemoriesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListMemoriesOutput

An instance of ListMemoriesOutput.

Input

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

ListMemoriesInputDict

Bases: TypedDict

Dictionary form of ListMemoriesInput.

Attributes

max_results instance-attribute
max_results: int | None

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

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.

ListMemoriesInput dataclass

Bases: _SerdeShape

Dataclass for ListMemoriesInput structure.

Attributes

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

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

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.

Output

ListMemoriesOutput dataclass

Bases: _SerdeShape

Dataclass for ListMemoriesOutput structure.

Attributes

memories instance-attribute
memories: list[MemorySummary]

The list of AgentCore Memory resource summaries.

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

A token to retrieve the next page of results.

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.