IoT / Client / describe_custom_metric



Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_metric(

metricName (string) –


The name of the custom metric.

Return type:



Response Syntax

    'metricName': 'string',
    'metricArn': 'string',
    'metricType': 'string-list'|'ip-address-list'|'number-list'|'number',
    'displayName': 'string',
    'creationDate': datetime(2015, 1, 1),
    'lastModifiedDate': datetime(2015, 1, 1)

Response Structure

  • (dict) –

    • metricName (string) –

      The name of the custom metric.

    • metricArn (string) –

      The Amazon Resource Number (ARN) of the custom metric.

    • metricType (string) –

      The type of the custom metric.


      The type number only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.

    • displayName (string) –

      Field represents a friendly name in the console for the custom metric; doesn’t have to be unique. Don’t use this name as the metric identifier in the device metric report. Can be updated.

    • creationDate (datetime) –

      The creation date of the custom metric in milliseconds since epoch.

    • lastModifiedDate (datetime) –

      The time the custom metric was last modified in milliseconds since epoch.


  • IoT.Client.exceptions.InvalidRequestException

  • IoT.Client.exceptions.ResourceNotFoundException

  • IoT.Client.exceptions.ThrottlingException

  • IoT.Client.exceptions.InternalFailureException