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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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' {
- dimensionName :: Maybe Text
- dimensionValueOperator :: Maybe DimensionValueOperator
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- thingName :: Text
- metricName :: Text
- startTime :: POSIX
- endTime :: POSIX
}
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

dimensionName :: Maybe Text
The dimension name.
dimensionValueOperator :: Maybe DimensionValueOperator
The dimension value operator.
maxResults :: Maybe Natural
The maximum number of results to return at one time.
nextToken :: Maybe Text
The token for the next set of results.
thingName :: Text
The name of the thing for which security profile metric values are returned.
metricName :: Text
The name of the security profile metric for which values are returned.
startTime :: POSIX
The start of the time period for which metric values are returned.
endTime :: POSIX
The end of the time period for which metric values are returned.

Instances

Instances details

ToHeaders ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods toHeaders :: ListMetricValues -> [Header] #
ToPath ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods toPath :: ListMetricValues -> ByteString #
ToQuery ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods toQuery :: ListMetricValues -> QueryString #
AWSPager ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods page :: ListMetricValues -> AWSResponse ListMetricValues -> Maybe ListMetricValues #
AWSRequest ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Associated Types type AWSResponse ListMetricValues # Methods request :: (Service -> Service) -> ListMetricValues -> Request ListMetricValues # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListMetricValues -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListMetricValues))) #
Generic ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Associated Types type Rep ListMetricValues :: Type -> Type # Methods from :: ListMetricValues -> Rep ListMetricValues x # to :: Rep ListMetricValues x -> ListMetricValues #
Read ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods readsPrec :: Int -> ReadS ListMetricValues # readList :: ReadS [ListMetricValues] # readPrec :: ReadPrec ListMetricValues # readListPrec :: ReadPrec [ListMetricValues] #
Show ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods showsPrec :: Int -> ListMetricValues -> ShowS # show :: ListMetricValues -> String # showList :: [ListMetricValues] -> ShowS #
NFData ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods rnf :: ListMetricValues -> () #
Eq ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods (==) :: ListMetricValues -> ListMetricValues -> Bool # (/=) :: ListMetricValues -> ListMetricValues -> Bool #
Hashable ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods hashWithSalt :: Int -> ListMetricValues -> Int # hash :: ListMetricValues -> Int #
type AWSResponse ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues type AWSResponse ListMetricValues = ListMetricValuesResponse
type Rep ListMetricValues Source #
Instance details Defined in Amazonka.IoT.ListMetricValues type Rep ListMetricValues = D1 ('MetaData "ListMetricValues" "Amazonka.IoT.ListMetricValues" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListMetricValues'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "dimensionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dimensionValueOperator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DimensionValueOperator))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newListMetricValues Source #

Arguments

:: Text	`ListMetricValues`
-> Text	`ListMetricValues`
-> UTCTime	`ListMetricValues`
-> UTCTime	`ListMetricValues`
-> 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 metricDatumList :: Maybe [MetricDatum] The data the thing reports for the metric during the specified time period. nextToken :: Maybe Text A token that can be used to retrieve the next set of results, or `null` if there are no additional results. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Associated Types type Rep ListMetricValuesResponse :: Type -> Type # Methods from :: ListMetricValuesResponse -> Rep ListMetricValuesResponse x # to :: Rep ListMetricValuesResponse x -> ListMetricValuesResponse #
Read ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods readsPrec :: Int -> ReadS ListMetricValuesResponse # readList :: ReadS [ListMetricValuesResponse] # readPrec :: ReadPrec ListMetricValuesResponse # readListPrec :: ReadPrec [ListMetricValuesResponse] #
Show ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods showsPrec :: Int -> ListMetricValuesResponse -> ShowS # show :: ListMetricValuesResponse -> String # showList :: [ListMetricValuesResponse] -> ShowS #
NFData ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods rnf :: ListMetricValuesResponse -> () #
Eq ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues Methods (==) :: ListMetricValuesResponse -> ListMetricValuesResponse -> Bool # (/=) :: ListMetricValuesResponse -> ListMetricValuesResponse -> Bool #
type Rep ListMetricValuesResponse Source #
Instance details Defined in Amazonka.IoT.ListMetricValues type Rep ListMetricValuesResponse = D1 ('MetaData "ListMetricValuesResponse" "Amazonka.IoT.ListMetricValues" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListMetricValuesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricDatumList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MetricDatum])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListMetricValuesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListMetricValuesResponse'`
-> ListMetricValuesResponse

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.