BedrockAgentCore / Client / list_memory_records

list_memory_records¶

BedrockAgentCore.Client.list_memory_records(**kwargs)¶

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.

Request Syntax

response = client.list_memory_records(
    memoryId='string',
    namespace='string',
    namespacePath='string',
    memoryStrategyId='string',
    maxResults=123,
    nextToken='string',
    metadataFilters=[
        {
            'left': {
                'metadataKey': 'string'
            },
            'operator': 'EQUALS_TO'|'EXISTS'|'NOT_EXISTS'|'BEFORE'|'AFTER'|'CONTAINS'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS'|'LESS_THAN'|'LESS_THAN_OR_EQUALS',
            'right': {
                'metadataValue': {
                    'stringValue': 'string',
                    'stringListValue': [
                        'string',
                    ],
                    'numberValue': 123.0,
                    'dateTimeValue': datetime(2015, 1, 1)
                }
            }
        },
    ]
)

Parameters:

memoryId (string) –
[REQUIRED]

The identifier of the AgentCore Memory resource for which to list memory records.
namespace (string) – The namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix.
namespacePath (string) – Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy.
memoryStrategyId (string) – The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.
maxResults (integer) – The maximum number of results to return in a single call. The default value is 20.
nextToken (string) – 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.
metadataFilters (list) –
A list of metadata filter expressions to scope the returned memory records.
- (dict) –
  
  Filters to apply to metadata associated with a memory. Specify the metadata key and value in the left and right fields and use the operator field to define the relationship to match.
  - left (dict) – [REQUIRED]
    
    The metadata key to evaluate.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: metadataKey.
    - metadataKey (string) –
      
      The metadata key to filter on.
  - operator (string) – [REQUIRED]
    
    The relationship between the metadata key and value to match when applying the metadata filter.
  - right (dict) –
    
    The value to compare against. Required for all operators except EXISTS and NOT_EXISTS.
    
    Note
    This is a Tagged Union structure. Only one of the following top level keys can be set: metadataValue.
    - metadataValue (dict) –
      
      The metadata value to compare against.
      
      Note
      This is a Tagged Union structure. Only one of the following top level keys can be set: stringValue, stringListValue, numberValue, dateTimeValue.
      - stringValue (string) –
        
        A string value.
      - stringListValue (list) –
        
        A list of string values.
        
        (string) –
      - numberValue (float) –
        
        A numeric value.
      - dateTimeValue (datetime) –
        
        A timestamp value in ISO 8601 UTC format.

Return type:

dict

Returns:

Response Syntax

{
    'memoryRecordSummaries': [
        {
            'memoryRecordId': 'string',
            'content': {
                'text': 'string'
            },
            'memoryStrategyId': 'string',
            'namespaces': [
                'string',
            ],
            'createdAt': datetime(2015, 1, 1),
            'score': 123.0,
            'metadata': {
                'string': {
                    'stringValue': 'string',
                    'stringListValue': [
                        'string',
                    ],
                    'numberValue': 123.0,
                    'dateTimeValue': datetime(2015, 1, 1)
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- memoryRecordSummaries (list) –
  
  The list of memory record summaries that match the specified criteria.
  - (dict) –
    
    Contains summary information about a memory record.
    - memoryRecordId (string) –
      
      The unique identifier of the memory record.
    - content (dict) –
      
      The content of the memory record.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: text. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - text (string) –
        
        The text content of the memory record.
    - memoryStrategyId (string) –
      
      The identifier of the memory strategy associated with this record.
    - namespaces (list) –
      
      The namespaces associated with this memory record.
      - (string) –
    - createdAt (datetime) –
      
      The timestamp when the memory record was created.
    - score (float) –
      
      The relevance score of the memory record when returned as part of a search result. Higher values indicate greater relevance to the search query.
    - metadata (dict) –
      
      A map of metadata key-value pairs associated with a memory record.
      - (string) –
        
        (dict) –
        
        The value of a memory record metadata entry.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: stringValue, stringListValue, numberValue, dateTimeValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        stringValue (string) –
        
        A string value.
        
        stringListValue (list) –
        
        A list of string values.
        
        (string) –
        
        numberValue (float) –
        
        A numeric value.
        
        dateTimeValue (datetime) –
        
        A timestamp value in ISO 8601 UTC format.
- nextToken (string) –
  
  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.

Exceptions

BedrockAgentCore.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCore.Client.exceptions.ThrottledException
BedrockAgentCore.Client.exceptions.ServiceException
BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.InvalidInputException
BedrockAgentCore.Client.exceptions.ResourceNotFoundException