Continuum / Paginator / ListAssociatedCollectors

ListAssociatedCollectors

class Continuum.Paginator.ListAssociatedCollectors

paginator = client.get_paginator('list_associated_collectors')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• environmentId (string) –

  [REQUIRED]

  The unique identifier of the Environment 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

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

    A token to resume pagination.