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.UpdateCustomMetric

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates a Device Defender detect custom metric.

Requires permission to access the UpdateCustomMetric action.

Synopsis

data UpdateCustomMetric = UpdateCustomMetric' {
- metricName :: Text
- displayName :: Text
}
newUpdateCustomMetric :: Text -> Text -> UpdateCustomMetric
updateCustomMetric_metricName :: Lens' UpdateCustomMetric Text
updateCustomMetric_displayName :: Lens' UpdateCustomMetric Text
data UpdateCustomMetricResponse = UpdateCustomMetricResponse' {
- creationDate :: Maybe POSIX
- displayName :: Maybe Text
- lastModifiedDate :: Maybe POSIX
- metricArn :: Maybe Text
- metricName :: Maybe Text
- metricType :: Maybe CustomMetricType
- httpStatus :: Int
}
newUpdateCustomMetricResponse :: Int -> UpdateCustomMetricResponse
updateCustomMetricResponse_creationDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime)
updateCustomMetricResponse_displayName :: Lens' UpdateCustomMetricResponse (Maybe Text)
updateCustomMetricResponse_lastModifiedDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime)
updateCustomMetricResponse_metricArn :: Lens' UpdateCustomMetricResponse (Maybe Text)
updateCustomMetricResponse_metricName :: Lens' UpdateCustomMetricResponse (Maybe Text)
updateCustomMetricResponse_metricType :: Lens' UpdateCustomMetricResponse (Maybe CustomMetricType)
updateCustomMetricResponse_httpStatus :: Lens' UpdateCustomMetricResponse Int

Creating a Request

data UpdateCustomMetric Source #

See: newUpdateCustomMetric smart constructor.

Constructors

UpdateCustomMetric'
Fields metricName :: Text The name of the custom metric. Cannot be updated. displayName :: Text Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Instances

Instances details

ToJSON UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods toJSON :: UpdateCustomMetric -> Value # toEncoding :: UpdateCustomMetric -> Encoding # toJSONList :: [UpdateCustomMetric] -> Value # toEncodingList :: [UpdateCustomMetric] -> Encoding #
ToHeaders UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods toHeaders :: UpdateCustomMetric -> [Header] #
ToPath UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods toPath :: UpdateCustomMetric -> ByteString #
ToQuery UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods toQuery :: UpdateCustomMetric -> QueryString #
AWSRequest UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Associated Types type AWSResponse UpdateCustomMetric # Methods request :: (Service -> Service) -> UpdateCustomMetric -> Request UpdateCustomMetric # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateCustomMetric -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateCustomMetric))) #
Generic UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Associated Types type Rep UpdateCustomMetric :: Type -> Type # Methods from :: UpdateCustomMetric -> Rep UpdateCustomMetric x # to :: Rep UpdateCustomMetric x -> UpdateCustomMetric #
Read UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods readsPrec :: Int -> ReadS UpdateCustomMetric # readList :: ReadS [UpdateCustomMetric] # readPrec :: ReadPrec UpdateCustomMetric # readListPrec :: ReadPrec [UpdateCustomMetric] #
Show UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods showsPrec :: Int -> UpdateCustomMetric -> ShowS # show :: UpdateCustomMetric -> String # showList :: [UpdateCustomMetric] -> ShowS #
NFData UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods rnf :: UpdateCustomMetric -> () #
Eq UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods (==) :: UpdateCustomMetric -> UpdateCustomMetric -> Bool # (/=) :: UpdateCustomMetric -> UpdateCustomMetric -> Bool #
Hashable UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric Methods hashWithSalt :: Int -> UpdateCustomMetric -> Int # hash :: UpdateCustomMetric -> Int #
type AWSResponse UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric type AWSResponse UpdateCustomMetric = UpdateCustomMetricResponse
type Rep UpdateCustomMetric Source #
Instance details Defined in Amazonka.IoT.UpdateCustomMetric type Rep UpdateCustomMetric = D1 ('MetaData "UpdateCustomMetric" "Amazonka.IoT.UpdateCustomMetric" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "UpdateCustomMetric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateCustomMetric Source #

Arguments

:: Text	`UpdateCustomMetric`
-> Text	`UpdateCustomMetric`
-> UpdateCustomMetric

Create a value of UpdateCustomMetric 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:

UpdateCustomMetric, updateCustomMetric_metricName - The name of the custom metric. Cannot be updated.

UpdateCustomMetric, updateCustomMetric_displayName - Field represents a friendly name in the console for the custom metric, it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

Request Lenses

updateCustomMetric_metricName :: Lens' UpdateCustomMetric Text Source #

The name of the custom metric. Cannot be updated.

updateCustomMetric_displayName :: Lens' UpdateCustomMetric Text Source #

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

Destructuring the Response

data UpdateCustomMetricResponse Source #

See: newUpdateCustomMetricResponse smart constructor.

Constructors

UpdateCustomMetricResponse'

Fields

creationDate :: Maybe POSIX
The creation date of the custom metric in milliseconds since epoch.
displayName :: Maybe Text
A friendly name in the console for the custom metric
lastModifiedDate :: Maybe POSIX
The time the custom metric was last modified in milliseconds since epoch.
metricArn :: Maybe Text
The Amazon Resource Number (ARN) of the custom metric.
metricName :: Maybe Text
The name of the custom metric.
metricType :: Maybe CustomMetricType
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newUpdateCustomMetricResponse Source #

Arguments

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

Create a value of UpdateCustomMetricResponse 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:

UpdateCustomMetricResponse, updateCustomMetricResponse_creationDate - The creation date of the custom metric in milliseconds since epoch.

UpdateCustomMetric, updateCustomMetricResponse_displayName - A friendly name in the console for the custom metric

UpdateCustomMetricResponse, updateCustomMetricResponse_lastModifiedDate - The time the custom metric was last modified in milliseconds since epoch.

UpdateCustomMetricResponse, updateCustomMetricResponse_metricArn - The Amazon Resource Number (ARN) of the custom metric.

UpdateCustomMetric, updateCustomMetricResponse_metricName - The name of the custom metric.

$sel:metricType:UpdateCustomMetricResponse', updateCustomMetricResponse_metricType - 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.

$sel:httpStatus:UpdateCustomMetricResponse', updateCustomMetricResponse_httpStatus - The response's http status code.

Response Lenses

updateCustomMetricResponse_creationDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

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

updateCustomMetricResponse_displayName :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

A friendly name in the console for the custom metric

updateCustomMetricResponse_lastModifiedDate :: Lens' UpdateCustomMetricResponse (Maybe UTCTime) Source #

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

updateCustomMetricResponse_metricArn :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

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

updateCustomMetricResponse_metricName :: Lens' UpdateCustomMetricResponse (Maybe Text) Source #

The name of the custom metric.

updateCustomMetricResponse_metricType :: Lens' UpdateCustomMetricResponse (Maybe CustomMetricType) Source #

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.

updateCustomMetricResponse_httpStatus :: Lens' UpdateCustomMetricResponse Int Source #

The response's http status code.