BedrockAgentCore / Paginator / ListSessions

ListSessions¶

class BedrockAgentCore.Paginator.ListSessions ¶

paginator = client.get_paginator('list_sessions')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from BedrockAgentCore.Client.list_sessions().

Request Syntax

response_iterator = paginator.paginate(
    memoryId='string',
    actorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

memoryId (string) –
[REQUIRED]

The identifier of the AgentCore Memory resource for which to list sessions.
actorId (string) –
[REQUIRED]

The identifier of the actor for which to list sessions.
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

{
    'sessionSummaries': [
        {
            'sessionId': 'string',
            'actorId': 'string',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- sessionSummaries (list) –
  
  The list of session summaries that match the specified criteria.
  - (dict) –
    
    Contains summary information about a session in an AgentCore Memory resource.
    - sessionId (string) –
      
      The unique identifier of the session.
    - actorId (string) –
      
      The identifier of the actor associated with the session.
    - createdAt (datetime) –
      
      The timestamp when the session was created.
- NextToken (string) –
  
  A token to resume pagination.