Continuum / Client / associate_collector

associate_collector

Continuum.Client.associate_collector(**kwargs)

Associates one Collector with this Environment and configures the customer role Continuum uses to authorize access to associated Collector data. The caller must have permission on the Environment and permission to pass the role. Continuum assumes the supplied role and calls GetCollectorDataAccessAuthorization on the requested Collector; only a successful authorization response permits the association. The caller does not need Collector data-access permission. The Environment retains its other Collector associations. Calling again with an existing association is safe and does not create a duplicate.

See also: AWS API Documentation

Request Syntax

response = client.associate_collector(
    environmentId='string',
    clientToken='string',
    collectorArn='string',
    collectorDataAccessRoleArn='string'
)
Parameters:

  • environmentId (string) –

    [REQUIRED]

    The unique identifier of the Environment making the association.

  • clientToken (string) –

    Caller-provided token that makes retried association requests idempotent. The first successful request binds the token to the complete Collector ARN, supplied role, and result for at least 24 hours. During that retry window, reusing it with a different request fails with ConflictException. A matching replay still requires the supplied role to have current Collector access. Once authorized, a matching replay returns the stored result without changing association state. Revocation can deny a replay; it does not remove the stored association or its original result.

    This field is autopopulated if not provided.

  • collectorArn (string) –

    [REQUIRED]

    The ARN of the Collector to associate with this Environment.

  • collectorDataAccessRoleArn (string) –

    [REQUIRED]

    IAM role in the Environment account that Continuum assumes before authorizing access to associated Collector inventory. Every association, including a same-account association, requires this role. The supplied ARN replaces the Environment’s previously stored role. The customer is responsible for granting the role access to every Collector that should contribute data.

Return type:

dict

Returns:

Response Syntax

{
    'environmentId': 'string',
    'environmentArn': 'string',
    'associatedCollector': {
        'collectorId': 'string',
        'collectorArn': 'string'
    }
}

Response Structure

  • (dict) –

    Contains the Environment and the Collector associated by this request.

    • environmentId (string) –

      The unique identifier of the Environment making the association.

    • environmentArn (string) –

      The ARN of the Environment making the association.

    • associatedCollector (dict) –

      The Collector identifier and ARN validated by this operation.

      • 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.

Exceptions