Cloud9 / Client / list_environments

list_environments#

Cloud9.Client.list_environments(**kwargs)#

Gets a list of Cloud9 development environment identifiers.

See also: AWS API Documentation

Request Syntax

response = client.list_environments(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

  • maxResults (integer) – The maximum number of environments to get identifiers for.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'environmentIds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a next token. To get the next batch of items in the list, call this operation again, adding the next token to the call.

    • environmentIds (list) –

      The list of environment identifiers.

      • (string) –

Exceptions

  • Cloud9.Client.exceptions.BadRequestException

  • Cloud9.Client.exceptions.ConflictException

  • Cloud9.Client.exceptions.NotFoundException

  • Cloud9.Client.exceptions.ForbiddenException

  • Cloud9.Client.exceptions.TooManyRequestsException

  • Cloud9.Client.exceptions.LimitExceededException

  • Cloud9.Client.exceptions.InternalServerErrorException

Examples

response = client.list_environments(
)

print(response)

Expected Output:

{
    'environmentIds': [
        '349c86d4579e4e7298d500ff57a6b2EX',
        '45a3da47af0840f2b0c0824f5ee232EX',
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}