:doc:`AgentsforBedrockRuntime <../../bedrock-agent-runtime>` / Paginator / GetAgentMemory

**************
GetAgentMemory
**************



.. py:class:: AgentsforBedrockRuntime.Paginator.GetAgentMemory

  ::

    
    paginator = client.get_paginator('get_agent_memory')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`AgentsforBedrockRuntime.Client.get_agent_memory`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GetAgentMemory>`_    


    **Request Syntax**
    ::

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

      The unique identifier of an alias of an agent.

      

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

      The unique identifier of the agent to which the alias belongs.

      

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

      The unique identifier of the memory.

      

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

      The type of memory.

      

    
    :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**

      
      ::

        {
            'memoryContents': [
                {
                    'sessionSummary': {
                        'memoryId': 'string',
                        'sessionExpiryTime': datetime(2015, 1, 1),
                        'sessionId': 'string',
                        'sessionStartTime': datetime(2015, 1, 1),
                        'summaryText': 'string'
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **memoryContents** *(list) --* 

          Contains details of the sessions stored in the memory

          
          

          - *(dict) --* 

            Contains sessions summaries.

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


          
            

            - **sessionSummary** *(dict) --* 

              Contains summary of a session.

              
              

              - **memoryId** *(string) --* 

                The unique identifier of the memory where the session summary is stored.

                
              

              - **sessionExpiryTime** *(datetime) --* 

                The time when the memory duration for the session is set to end.

                
              

              - **sessionId** *(string) --* 

                The identifier for this session.

                
              

              - **sessionStartTime** *(datetime) --* 

                The start time for this session.

                
              

              - **summaryText** *(string) --* 

                The summarized text for this session.

                
          
        
      
        

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

          A token to resume pagination.

          
    