:doc:`IoT <../../iot>` / Client / list_metric_values

******************
list_metric_values
******************



.. py:method:: IoT.Client.list_metric_values(**kwargs)

  

  Lists the values reported for an IoT Device Defender metric (device-side metric, cloud-side metric, or custom metric) by the given thing during the specified time period.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/ListMetricValues>`_  


  **Request Syntax**
  ::

    response = client.list_metric_values(
        thingName='string',
        metricName='string',
        dimensionName='string',
        dimensionValueOperator='IN'|'NOT_IN',
        startTime=datetime(2015, 1, 1),
        endTime=datetime(2015, 1, 1),
        maxResults=123,
        nextToken='string'
    )
    
  :type thingName: string
  :param thingName: **[REQUIRED]** 

    The name of the thing for which security profile metric values are returned.

    

  
  :type metricName: string
  :param metricName: **[REQUIRED]** 

    The name of the security profile metric for which values are returned.

    

  
  :type dimensionName: string
  :param dimensionName: 

    The dimension name.

    

  
  :type dimensionValueOperator: string
  :param dimensionValueOperator: 

    The dimension value operator.

    

  
  :type startTime: datetime
  :param startTime: **[REQUIRED]** 

    The start of the time period for which metric values are returned.

    

  
  :type endTime: datetime
  :param endTime: **[REQUIRED]** 

    The end of the time period for which metric values are returned.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return at one time.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'metricDatumList': [
              {
                  'timestamp': datetime(2015, 1, 1),
                  'value': {
                      'count': 123,
                      'cidrs': [
                          'string',
                      ],
                      'ports': [
                          123,
                      ],
                      'number': 123.0,
                      'numbers': [
                          123.0,
                      ],
                      'strings': [
                          'string',
                      ]
                  }
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **metricDatumList** *(list) --* 

        The data the thing reports for the metric during the specified time period.

        
        

        - *(dict) --* 

          A metric.

          
          

          - **timestamp** *(datetime) --* 

            The time the metric value was reported.

            
          

          - **value** *(dict) --* 

            The value reported for the metric.

            
            

            - **count** *(integer) --* 

              If the ``comparisonOperator`` calls for a numeric value, use this to specify that numeric value to be compared with the ``metric``.

              
            

            - **cidrs** *(list) --* 

              If the ``comparisonOperator`` calls for a set of CIDRs, use this to specify that set to be compared with the ``metric``.

              
              

              - *(string) --* 
          
            

            - **ports** *(list) --* 

              If the ``comparisonOperator`` calls for a set of ports, use this to specify that set to be compared with the ``metric``.

              
              

              - *(integer) --* 
          
            

            - **number** *(float) --* 

              The numeral value of a metric.

              
            

            - **numbers** *(list) --* 

              The numeral values of a metric.

              
              

              - *(float) --* 
          
            

            - **strings** *(list) --* 

              The string values of a metric.

              
              

              - *(string) --* 
          
        
      
    
      

      - **nextToken** *(string) --* 

        A token that can be used to retrieve the next set of results, or ``null`` if there are no additional results.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.InternalFailureException`

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

  