Continuum / Client / list_collectors

list_collectors¶

Continuum.Client.list_collectors()¶

Lists the Collectors owned by the authenticated caller’s account, including a Collector whose deletion is in progress. A Collector that is still being created is omitted. The account-scoped Collector quota currently permits at most one result, so no result ordering applies.

Request Syntax

response = client.list_collectors()

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'collectorId': 'string',
            'collectorArn': 'string',
            'type': 'AWS_COLLECTOR',
            'status': 'ACTIVE'|'PENDING_DELETION',
            'createdAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

(dict) –

Contains summaries of the caller account’s Collectors.
- items (list) –
  
  The Collectors owned by the authenticated caller’s account. At most one result is currently returned, so no result ordering applies.
  - (dict) –
    
    A summary of a Collector returned in list responses.
    - collectorId (string) –
      
      The unique identifier of the Collector.
    - collectorArn (string) –
      
      The ARN of the 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

Continuum.Client.exceptions.ValidationException
Continuum.Client.exceptions.InternalServerException
Continuum.Client.exceptions.ThrottlingException
Continuum.Client.exceptions.AccessDeniedException