PrometheusService / Client / list_anomaly_detectors

list_anomaly_detectors¶

PrometheusService.Client.list_anomaly_detectors(**kwargs)¶

Returns a paginated list of anomaly detectors for a workspace with optional filtering by alias.

Request Syntax

response = client.list_anomaly_detectors(
    workspaceId='string',
    alias='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

workspaceId (string) –
[REQUIRED]

The identifier of the workspace containing the anomaly detectors to list.
alias (string) – Filters the results to anomaly detectors with the specified alias.
maxResults (integer) – The maximum number of results to return in a single call. Valid range is 1 to 1000.
nextToken (string) – The pagination token to continue retrieving results.

Return type:

dict

Returns:

Response Syntax

{
    'anomalyDetectors': [
        {
            'arn': 'string',
            'anomalyDetectorId': 'string',
            'alias': 'string',
            'status': {
                'statusCode': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATION_FAILED'|'UPDATE_FAILED'|'DELETION_FAILED',
                'statusReason': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'modifiedAt': datetime(2015, 1, 1),
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- anomalyDetectors (list) –
  
  The list of anomaly detectors in the workspace.
  - (dict) –
    
    Summary information about an anomaly detector for list operations.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the anomaly detector.
    - anomalyDetectorId (string) –
      
      The unique identifier of the anomaly detector.
    - alias (string) –
      
      The user-friendly name of the anomaly detector.
    - status (dict) –
      
      The current status of the anomaly detector.
      - statusCode (string) –
        
        The status code of the anomaly detector.
      - statusReason (string) –
        
        A description of the current status of the anomaly detector.
    - createdAt (datetime) –
      
      The timestamp when the anomaly detector was created.
    - modifiedAt (datetime) –
      
      The timestamp when the anomaly detector was last modified.
    - tags (dict) –
      
      The tags applied to the anomaly detector.
      - (string) –
        
        The key of the tag. Must not begin with aws:.
        
        (string) –
        
        The value of the tag.
- nextToken (string) –
  
  The pagination token to retrieve the next set of results.

Exceptions

PrometheusService.Client.exceptions.ThrottlingException
PrometheusService.Client.exceptions.ValidationException
PrometheusService.Client.exceptions.ResourceNotFoundException
PrometheusService.Client.exceptions.AccessDeniedException
PrometheusService.Client.exceptions.InternalServerException