NovaActService / Paginator / ListSessions

ListSessions

class NovaActService.Paginator.ListSessions

paginator = client.get_paginator('list_sessions')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    workflowDefinitionName='string',
    workflowRunId='string',
    sortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• workflowDefinitionName (string) –

  [REQUIRED]

  The name of the workflow definition containing the workflow run.

• workflowRunId (string) –

  [REQUIRED]

  The unique identifier of the workflow run to list sessions for.

• sortOrder (string) – The sort order for the returned sessions (ascending or descending).

• 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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • sessionSummaries (list) –

    A list of summary information for sessions in the workflow run.

    • (dict) –

      Summary information about a session within a workflow run.

      • sessionId (string) –

        The unique identifier of the session.

  • NextToken (string) –

    A token to resume pagination.