| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.IoT.ListMetricValues
Description
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.
This operation returns paginated results.
Synopsis
- data ListMetricValues = ListMetricValues' {}
- newListMetricValues :: Text -> Text -> UTCTime -> UTCTime -> ListMetricValues
- listMetricValues_dimensionName :: Lens' ListMetricValues (Maybe Text)
- listMetricValues_dimensionValueOperator :: Lens' ListMetricValues (Maybe DimensionValueOperator)
- listMetricValues_maxResults :: Lens' ListMetricValues (Maybe Natural)
- listMetricValues_nextToken :: Lens' ListMetricValues (Maybe Text)
- listMetricValues_thingName :: Lens' ListMetricValues Text
- listMetricValues_metricName :: Lens' ListMetricValues Text
- listMetricValues_startTime :: Lens' ListMetricValues UTCTime
- listMetricValues_endTime :: Lens' ListMetricValues UTCTime
- data ListMetricValuesResponse = ListMetricValuesResponse' {
- metricDatumList :: Maybe [MetricDatum]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListMetricValuesResponse :: Int -> ListMetricValuesResponse
- listMetricValuesResponse_metricDatumList :: Lens' ListMetricValuesResponse (Maybe [MetricDatum])
- listMetricValuesResponse_nextToken :: Lens' ListMetricValuesResponse (Maybe Text)
- listMetricValuesResponse_httpStatus :: Lens' ListMetricValuesResponse Int
Creating a Request
data ListMetricValues Source #
See: newListMetricValues smart constructor.
Constructors
| ListMetricValues' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UTCTime | |
| -> UTCTime | |
| -> ListMetricValues |
Create a value of ListMetricValues with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListMetricValues, listMetricValues_dimensionName - The dimension name.
$sel:dimensionValueOperator:ListMetricValues', listMetricValues_dimensionValueOperator - The dimension value operator.
$sel:maxResults:ListMetricValues', listMetricValues_maxResults - The maximum number of results to return at one time.
ListMetricValues, listMetricValues_nextToken - The token for the next set of results.
ListMetricValues, listMetricValues_thingName - The name of the thing for which security profile metric values are
returned.
ListMetricValues, listMetricValues_metricName - The name of the security profile metric for which values are returned.
ListMetricValues, listMetricValues_startTime - The start of the time period for which metric values are returned.
ListMetricValues, listMetricValues_endTime - The end of the time period for which metric values are returned.
Request Lenses
listMetricValues_dimensionName :: Lens' ListMetricValues (Maybe Text) Source #
The dimension name.
listMetricValues_dimensionValueOperator :: Lens' ListMetricValues (Maybe DimensionValueOperator) Source #
The dimension value operator.
listMetricValues_maxResults :: Lens' ListMetricValues (Maybe Natural) Source #
The maximum number of results to return at one time.
listMetricValues_nextToken :: Lens' ListMetricValues (Maybe Text) Source #
The token for the next set of results.
listMetricValues_thingName :: Lens' ListMetricValues Text Source #
The name of the thing for which security profile metric values are returned.
listMetricValues_metricName :: Lens' ListMetricValues Text Source #
The name of the security profile metric for which values are returned.
listMetricValues_startTime :: Lens' ListMetricValues UTCTime Source #
The start of the time period for which metric values are returned.
listMetricValues_endTime :: Lens' ListMetricValues UTCTime Source #
The end of the time period for which metric values are returned.
Destructuring the Response
data ListMetricValuesResponse Source #
See: newListMetricValuesResponse smart constructor.
Constructors
| ListMetricValuesResponse' | |
Fields
| |
Instances
newListMetricValuesResponse Source #
Create a value of ListMetricValuesResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:metricDatumList:ListMetricValuesResponse', listMetricValuesResponse_metricDatumList - The data the thing reports for the metric during the specified time
period.
ListMetricValues, listMetricValuesResponse_nextToken - A token that can be used to retrieve the next set of results, or null
if there are no additional results.
$sel:httpStatus:ListMetricValuesResponse', listMetricValuesResponse_httpStatus - The response's http status code.
Response Lenses
listMetricValuesResponse_metricDatumList :: Lens' ListMetricValuesResponse (Maybe [MetricDatum]) Source #
The data the thing reports for the metric during the specified time period.
listMetricValuesResponse_nextToken :: Lens' ListMetricValuesResponse (Maybe Text) Source #
A token that can be used to retrieve the next set of results, or null
if there are no additional results.
listMetricValuesResponse_httpStatus :: Lens' ListMetricValuesResponse Int Source #
The response's http status code.