:doc:`PrometheusService <../../amp>` / Client / list_anomaly_detectors

**********************
list_anomaly_detectors
**********************



.. py:method:: PrometheusService.Client.list_anomaly_detectors(**kwargs)

  

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

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/amp-2020-08-01/ListAnomalyDetectors>`_  


  **Request Syntax**
  ::

    response = client.list_anomaly_detectors(
        workspaceId='string',
        alias='string',
        maxResults=123,
        nextToken='string'
    )
    
  :type workspaceId: string
  :param workspaceId: **[REQUIRED]** 

    The identifier of the workspace containing the anomaly detectors to list.

    

  
  :type alias: string
  :param alias: 

    Filters the results to anomaly detectors with the specified alias.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return in a single call. Valid range is 1 to 1000.

    

  
  :type nextToken: string
  :param nextToken: 

    The pagination token to continue retrieving results.

    

  
  
  :rtype: 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**
  
  *   :py:class:`PrometheusService.Client.exceptions.ThrottlingException`

  
  *   :py:class:`PrometheusService.Client.exceptions.ValidationException`

  
  *   :py:class:`PrometheusService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`PrometheusService.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`PrometheusService.Client.exceptions.InternalServerException`

  