Continuum / Client / list_associated_collectors

list_associated_collectors

Continuum.Client.list_associated_collectors(**kwargs)

Lists the Collectors currently associated with one Environment in ascending collectorId order. Each entry carries the Collector ARN, so a listed association can be passed straight to DisassociateCollector, including when the Collector belongs to another account. An association recorded before Continuum persisted the ARN is omitted from the response, because without the ARN it cannot be acted on.

See also: AWS API Documentation

Request Syntax

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

  • environmentId (string) –

    [REQUIRED]

    The unique identifier of the Environment whose associations to list.

  • maxResults (integer) – Maximum number of associated Collectors to return.

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

Return type:

dict

Returns:

Response Syntax

{
    'associatedCollectors': [
        {
            'collectorId': 'string',
            'collectorArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    Contains one page of the Collectors associated with the requested Environment.

    • associatedCollectors (list) –

      The Collectors associated with this Environment, ordered by collectorId ascending. Empty when the Environment has no associations, and also when every association on the page predates Continuum persisting the ARN — the page is still advanced by nextToken in that case.

      • (dict) –

        One Collector associated with an Environment.

        • collectorId (string) –

          The unique identifier of the associated Collector.

        • collectorArn (string) –

          The ARN of the associated Collector. The account and Region encoded in this ARN identify cross-account and cross-Region associations.

    • nextToken (string) –

      Pagination token for the next page, if present.

Exceptions