AgentsforBedrockRuntime / Paginator / ListSessions

ListSessions

class AgentsforBedrockRuntime.Paginator.ListSessions

paginator = client.get_paginator('list_sessions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

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': [
        {
            'createdAt': datetime(2015, 1, 1),
            'lastUpdatedAt': datetime(2015, 1, 1),
            'sessionArn': 'string',
            'sessionId': 'string',
            'sessionStatus': 'ACTIVE'|'EXPIRED'|'ENDED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • sessionSummaries (list) –

    A list of summaries for each session in your Amazon Web Services account.

    • (dict) –

      Contains details about a session. For more information about sessions, see Store and retrieve conversation history and context with Amazon Bedrock sessions.

      • createdAt (datetime) –

        The timestamp for when the session was created.

      • lastUpdatedAt (datetime) –

        The timestamp for when the session was last modified.

      • sessionArn (string) –

        The Amazon Resource Name (ARN) of the session.

      • sessionId (string) –

        The unique identifier for the session.

      • sessionStatus (string) –

        The current status of the session.

  • NextToken (string) –

    A token to resume pagination.