:doc:`PrometheusService <../../amp>` / Paginator / ListAnomalyDetectors

********************
ListAnomalyDetectors
********************



.. py:class:: PrometheusService.Paginator.ListAnomalyDetectors

  ::

    
    paginator = client.get_paginator('list_anomaly_detectors')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`PrometheusService.Client.list_anomaly_detectors`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          workspaceId='string',
          alias='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    