Continuum / Client / list_environments

list_environments

Continuum.Client.list_environments(**kwargs)

Lists all environments in your account in descending environmentId order. This complete-inventory operation intentionally has no response filters; see the input documentation for the API standards justification.

See also: AWS API Documentation

Request Syntax

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

  • maxResults (integer) – The maximum number of results to return in a single call.

  • nextToken (string) – A pagination token returned by a previous call. Set to null for the first request; use the returned token for subsequent calls.

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 pagination token to retrieve the next page of results. Absent when there are no more results.

Exceptions