Continuum / Client / list_associated_environments

list_associated_environments

Continuum.Client.list_associated_environments(**kwargs)

Lists the Environments currently associated with one Collector in lexicographically ascending environmentArn order. The ARN identifies each Environment across accounts within the Collector’s Region.

See also: AWS API Documentation

Request Syntax

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

  • collectorId (string) –

    [REQUIRED]

    The unique identifier of the Collector whose associations to list.

  • maxResults (integer) – Maximum number of Environment associations to return.

  • nextToken (string) – Pagination token returned by a prior request.

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) –

      Pagination token for the next page, if present.

Exceptions