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

*********************
describe_fleet_metric
*********************



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

  

  Gets information about the specified fleet metric.

   

  Requires permission to access the `DescribeFleetMetric <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

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


  **Request Syntax**
  ::

    response = client.describe_fleet_metric(
        metricName='string'
    )
    
  :type metricName: string
  :param metricName: **[REQUIRED]** 

    The name of the fleet metric to describe.

    

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

    
    ::

      {
          'metricName': 'string',
          'queryString': 'string',
          'aggregationType': {
              'name': 'Statistics'|'Percentiles'|'Cardinality',
              'values': [
                  'string',
              ]
          },
          'period': 123,
          'aggregationField': 'string',
          'description': 'string',
          'queryVersion': 'string',
          'indexName': 'string',
          'creationDate': datetime(2015, 1, 1),
          'lastModifiedDate': datetime(2015, 1, 1),
          'unit': 'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Count'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'|'None',
          'version': 123,
          'metricArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **metricName** *(string) --* 

        The name of the fleet metric to describe.

        
      

      - **queryString** *(string) --* 

        The search query string.

        
      

      - **aggregationType** *(dict) --* 

        The type of the aggregation query.

        
        

        - **name** *(string) --* 

          The name of the aggregation type.

          
        

        - **values** *(list) --* 

          A list of the values of aggregation types.

          
          

          - *(string) --* 
      
    
      

      - **period** *(integer) --* 

        The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

        
      

      - **aggregationField** *(string) --* 

        The field to aggregate.

        
      

      - **description** *(string) --* 

        The fleet metric description.

        
      

      - **queryVersion** *(string) --* 

        The query version.

        
      

      - **indexName** *(string) --* 

        The name of the index to search.

        
      

      - **creationDate** *(datetime) --* 

        The date when the fleet metric is created.

        
      

      - **lastModifiedDate** *(datetime) --* 

        The date when the fleet metric is last modified.

        
      

      - **unit** *(string) --* 

        Used to support unit transformation such as milliseconds to seconds. The unit must be supported by `CW metric <https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_MetricDatum.html>`__.

        
      

      - **version** *(integer) --* 

        The version of the fleet metric.

        
      

      - **metricArn** *(string) --* 

        The ARN of the fleet metric to describe.

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

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

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

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

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

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

  