Continuum / Paginator / ListEnvironments

ListEnvironments

class Continuum.Paginator.ListEnvironments

paginator = client.get_paginator('list_environments')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Continuum.Client.list_environments().

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

{
    'items': [
        {
            'environmentId': 'string',
            'environmentArn': 'string',
            'name': 'string',
            'status': 'ACTIVE',
            'createdAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains environment metadata and an optional pagination token.

  • items (list) –

    Common metadata for the environments in the account, ordered by environmentId descending.

    • (dict) –

      Summary of an environment returned in list responses.

      • environmentId (string) –

        The unique identifier of the environment.

      • environmentArn (string) –

        The ARN of the environment.

      • name (string) –

        The customer-visible name of the environment.

      • status (string) –

        The current operational status of the environment.

      • createdAt (datetime) –

        The timestamp when the environment was created. Preserve the existing EnvironmentSummary.createdAt date-time wire format.

  • NextToken (string) –

    A token to resume pagination.