Cloud9 / Paginator / ListEnvironments
ListEnvironments#
- class Cloud9.Paginator.ListEnvironments#
paginator = client.get_paginator('list_environments')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
Cloud9.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
{ 'environmentIds': [ 'string', ], 'NextToken': 'string' }
Response Structure
(dict) –
environmentIds (list) –
The list of environment identifiers.
(string) –
NextToken (string) –
A token to resume pagination.