Lightsail / Paginator / GetActiveNames

GetActiveNames

class Lightsail.Paginator.GetActiveNames

paginator = client.get_paginator('get_active_names')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Lightsail.Client.get_active_names().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 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.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'activeNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • activeNames (list) –

    The list of active names returned by the get active names request.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.