:doc:`BedrockAgentCore <../../bedrock-agentcore>` / Paginator / ListMemoryRecords

*****************
ListMemoryRecords
*****************



.. py:class:: BedrockAgentCore.Paginator.ListMemoryRecords

  ::

    
    paginator = client.get_paginator('list_memory_records')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`BedrockAgentCore.Client.list_memory_records`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agentcore-2024-02-28/ListMemoryRecords>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          memoryId='string',
          namespace='string',
          memoryStrategyId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type memoryId: string
    :param memoryId: **[REQUIRED]** 

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

      

    
    :type namespace: string
    :param namespace: **[REQUIRED]** 

      The namespace prefix to filter memory records by. Returns all memory records in namespaces that start with the provided prefix.

      

    
    :type memoryStrategyId: string
    :param memoryStrategyId: 

      The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: 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'
                        }
                    }
                },
            ],
            '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) --* 

                  Value associated with the ``eventMetadata`` key.

                  .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``stringValue``.     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) --* 

                    Value associated with the ``eventMetadata`` key.

                    
              
          
        
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    