list_memory_records¶
Operation¶
list_memory_records
¶
list_memory_records(request: ListMemoryRecordsInput | ListMemoryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoryRecordsInputDict]) -> ListMemoryRecordsOutput
Lists memory records 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:ListMemoryRecords permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListMemoryRecordsInput | ListMemoryRecordsInputDict | 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[ListMemoryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListMemoryRecordsOutput
|
An instance of |
list_memory_records
async
¶
list_memory_records(request: ListMemoryRecordsInput | ListMemoryRecordsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListMemoryRecordsInputDict]) -> ListMemoryRecordsOutput
Lists memory records 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:ListMemoryRecords permission.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListMemoryRecordsInput | ListMemoryRecordsInputDict | 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[ListMemoryRecordsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListMemoryRecordsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListMemoryRecordsInputDict
¶
Bases: TypedDict
Dictionary form of ListMemoryRecordsInput.
Attributes¶
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
¶
The identifier of the AgentCore Memory resource for which to list memory records.
memory_strategy_id
instance-attribute
¶
memory_strategy_id: str | None
The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
metadata_filters
instance-attribute
¶
metadata_filters: Sequence[MemoryMetadataFilterExpression | MemoryMetadataFilterExpressionDict] | None
A list of metadata filter expressions to scope the returned memory records.
namespace
instance-attribute
¶
namespace: str | None
The exact namespace to filter memory records by. Returns all memory
records that matches the provided namespace. Either namespace or
namespacePath is required.
ListMemoryRecordsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListMemoryRecordsInput 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 20.
memory_id
class-attribute
instance-attribute
¶
memory_id: str | None = ...
The identifier of the AgentCore Memory resource for which to list memory records.
memory_strategy_id
class-attribute
instance-attribute
¶
memory_strategy_id: str | None = ...
The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
metadata_filters
class-attribute
instance-attribute
¶
metadata_filters: list[MemoryMetadataFilterExpression] | None = ...
A list of metadata filter expressions to scope the returned memory records.
namespace
class-attribute
instance-attribute
¶
namespace: str | None = ...
The exact namespace to filter memory records by. Returns all memory
records that matches the provided namespace. Either namespace or
namespacePath is required.
Output¶
ListMemoryRecordsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListMemoryRecordsOutput structure.
Attributes¶
memory_record_summaries
instance-attribute
¶
memory_record_summaries: list[MemoryRecordSummary]
The list of memory record summaries 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
¶
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.