AgentsforBedrockRuntime / Paginator / GetAgentMemory

GetAgentMemory#

class AgentsforBedrockRuntime.Paginator.GetAgentMemory#
paginator = client.get_paginator('get_agent_memory')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from AgentsforBedrockRuntime.Client.get_agent_memory().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentAliasId='string',
    agentId='string',
    memoryId='string',
    memoryType='SESSION_SUMMARY',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • agentAliasId (string) –

    [REQUIRED]

    The unique identifier of an alias of an agent.

  • agentId (string) –

    [REQUIRED]

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

  • memoryId (string) –

    [REQUIRED]

    The unique identifier of the memory.

  • memoryType (string) –

    [REQUIRED]

    The type of memory.

  • PaginationConfig (dict) –

    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.

Return type:

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.