Continuum / Paginator / ListAssociatedEnvironments

ListAssociatedEnvironments

class Continuum.Paginator.ListAssociatedEnvironments

paginator = client.get_paginator('list_associated_environments')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    collectorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• collectorId (string) –

  [REQUIRED]

  The unique identifier of the Collector whose associations to list.

• 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

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

Response Structure

• (dict) –

  Contains one page of Environment summaries associated with the requested Collector.

  • associatedEnvironments (list) –

    Summaries of the Environments associated with this Collector, ordered by environmentArn lexicographically ascending. Each summary has the same fields as a ListEnvironments item but uses an independent model shape. Empty when the Collector has no associations.

    • (dict) –

      A summary of one Environment associated with a Collector. This shape intentionally remains distinct from EnvironmentSummary so the two list operations can evolve independently.

      • environmentId (string) –

        The unique identifier of the associated Environment.

      • environmentArn (string) –

        The ARN of the associated Environment. The account encoded in this ARN identifies cross-account associations; association mutations require its Region to match the Collector’s Region.

      • name (string) –

        The customer-visible name of the associated Environment.

      • status (string) –

        The current operational status of the associated Environment.

      • createdAt (datetime) –

        The timestamp when the associated Environment was created.

  • NextToken (string) –

    A token to resume pagination.