Continuum / Client / create_collector
create_collector¶
- Continuum.Client.create_collector(**kwargs)¶
Creates the Collector for the caller’s account. Provisions an AWS Config service-linked recorder using the caller’s federated access session and begins recording infrastructure changes.
See also: AWS API Documentation
Request Syntax
response = client.create_collector( type='AWS_COLLECTOR', kubernetesClusterRole={ 'roleArn': 'string', 'externalId': 'string' }, clientToken='string' )
- Parameters:
type (string) – Source to collect. Defaults to AWS_COLLECTOR when omitted.
kubernetesClusterRole (dict) –
IAM role configuration used to collect Kubernetes cluster metadata. The authenticated caller must be allowed to pass its exact roleArn to Continuum.
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.
clientToken (string) –
Caller-provided token that makes retried create requests return the original Collector rather than creating a duplicate.
This field is autopopulated if not provided.
- Return type:
dict
- Returns:
Response Syntax
{ 'collectorId': 'string', 'collectorArn': 'string', 'type': 'AWS_COLLECTOR', 'status': 'ACTIVE'|'PENDING_DELETION', 'createdAt': datetime(2015, 1, 1) }
Response Structure
(dict) –
Contains the identifier and ARN of the newly created Collector.
collectorId (string) –
The unique identifier assigned to the Collector.
collectorArn (string) –
The ARN of the created Collector.
type (string) –
The source collected by this Collector.
status (string) –
The current lifecycle status.
createdAt (datetime) –
The timestamp when the Collector was created.
Exceptions