Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Preferences
Contact Us
Feedback
AWS Documentation
Create an AWS Account

MetricToRetain

PDF
Focus mode
MetricToRetain - AWS IoT
ContentsSee Also

The metric you want to retain. Dimensions are optional.

Contents

metric

What is measured by the behavior.

Type: String

Required: Yes

exportMetric

The value indicates exporting metrics related to the MetricToRetain when it's true.

Type: Boolean

Required: No

metricDimension

The dimension of a metric. This can't be used with custom metrics.

Type: MetricDimension object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page

PrivacySite termsCookie preferences
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved.