Continuum / Client / update_collector

update_collector

Continuum.Client.update_collector(**kwargs)

Updates the customer-controlled mutable properties of a Collector. Only the name and Kubernetes cluster IAM role can be changed.

See also: AWS API Documentation

Request Syntax

response = client.update_collector(
    collectorId='string',
    name='string',
    kubernetesClusterRole={
        'set': {
            'roleArn': 'string',
            'externalId': 'string'
        },
        'remove': {}

    }
)
Parameters:

  • collectorId (string) –

    [REQUIRED]

    The unique identifier of the Collector to update.

  • name (string) – The new customer-visible name.

  • kubernetesClusterRole (dict) –

    Atomic update to the IAM role configuration used to collect Kubernetes cluster metadata. The set variant requires a complete configuration; the authenticated caller must be allowed to pass its exact roleArn to Continuum. The remove variant clears both the role and external ID.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: set, remove.

    • set (dict) –

      Replace the complete role configuration.

      • roleArn (string) – [REQUIRED]

        IAM role the authenticated caller passes to Continuum.

      • externalId (string) –

        Optional external ID Continuum supplies when assuming roleArn. This must match the role trust policy when configured and does not replace the caller’s iam:PassRole permission.

    • remove (dict) –

      Remove the configured role and external ID.

Return type:

dict

Returns:

Response Syntax

{
    'collectorId': 'string',
    'collectorArn': 'string',
    'type': 'AWS_COLLECTOR',
    'status': 'ACTIVE'|'PENDING_DELETION',
    'configRecorderArn': 'string',
    'kubernetesClusterRoleArn': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    Contains the current state of the updated Collector.

    • collectorId (string) –

      The unique identifier of the updated Collector.

    • collectorArn (string) –

      The ARN of the updated Collector.

    • type (string) –

      The source collected by this Collector.

    • status (string) –

      The current lifecycle status.

    • configRecorderArn (string) –

      The ARN of the provisioned AWS Config Recorder.

    • kubernetesClusterRoleArn (string) –

      IAM role used to collect Kubernetes cluster metadata.

    • createdAt (datetime) –

      The timestamp when the Collector was created.

    • updatedAt (datetime) –

      The time of the last successful UpdateCollector call, returned at whole-second precision in the same date-time format as createdAt.

Exceptions