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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Synopsis

Creating a Request

data DescribeCustomMetric Source #

See: newDescribeCustomMetric smart constructor.

Constructors

DescribeCustomMetric'
Fields metricName :: Text The name of the custom metric.

Instances

Instances details

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

newDescribeCustomMetric Source #

Arguments

:: Text	`DescribeCustomMetric`
-> DescribeCustomMetric

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

DescribeCustomMetric, describeCustomMetric_metricName - The name of the custom metric.

Request Lenses

describeCustomMetric_metricName :: Lens' DescribeCustomMetric Text Source #

The name of the custom metric.

Destructuring the Response

data DescribeCustomMetricResponse Source #

See: newDescribeCustomMetricResponse smart constructor.

Constructors

DescribeCustomMetricResponse'

Fields

creationDate :: Maybe POSIX
The creation date of the custom metric in milliseconds since epoch.
displayName :: Maybe Text
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.
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 DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric Associated Types type Rep DescribeCustomMetricResponse :: Type -> Type # Methods from :: DescribeCustomMetricResponse -> Rep DescribeCustomMetricResponse x # to :: Rep DescribeCustomMetricResponse x -> DescribeCustomMetricResponse #
Read DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric Methods readsPrec :: Int -> ReadS DescribeCustomMetricResponse # readList :: ReadS [DescribeCustomMetricResponse] # readPrec :: ReadPrec DescribeCustomMetricResponse # readListPrec :: ReadPrec [DescribeCustomMetricResponse] #
Show DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric Methods showsPrec :: Int -> DescribeCustomMetricResponse -> ShowS # show :: DescribeCustomMetricResponse -> String # showList :: [DescribeCustomMetricResponse] -> ShowS #
NFData DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric Methods rnf :: DescribeCustomMetricResponse -> () #
Eq DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric Methods (==) :: DescribeCustomMetricResponse -> DescribeCustomMetricResponse -> Bool # (/=) :: DescribeCustomMetricResponse -> DescribeCustomMetricResponse -> Bool #
type Rep DescribeCustomMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeCustomMetric type Rep DescribeCustomMetricResponse = D1 ('MetaData "DescribeCustomMetricResponse" "Amazonka.IoT.DescribeCustomMetric" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeCustomMetricResponse'" '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)))))

newDescribeCustomMetricResponse Source #

Arguments

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

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

DescribeCustomMetricResponse, describeCustomMetricResponse_creationDate - The creation date of the custom metric in milliseconds since epoch.

$sel:displayName:DescribeCustomMetricResponse', describeCustomMetricResponse_displayName - 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.

DescribeCustomMetricResponse, describeCustomMetricResponse_lastModifiedDate - The time the custom metric was last modified in milliseconds since epoch.

DescribeCustomMetricResponse, describeCustomMetricResponse_metricArn - The Amazon Resource Number (ARN) of the custom metric.

DescribeCustomMetric, describeCustomMetricResponse_metricName - The name of the custom metric.

$sel:metricType:DescribeCustomMetricResponse', describeCustomMetricResponse_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:DescribeCustomMetricResponse', describeCustomMetricResponse_httpStatus - The response's http status code.

Response Lenses

describeCustomMetricResponse_creationDate :: Lens' DescribeCustomMetricResponse (Maybe UTCTime) Source #

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

describeCustomMetricResponse_displayName :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

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.

describeCustomMetricResponse_lastModifiedDate :: Lens' DescribeCustomMetricResponse (Maybe UTCTime) Source #

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

describeCustomMetricResponse_metricArn :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

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

describeCustomMetricResponse_metricName :: Lens' DescribeCustomMetricResponse (Maybe Text) Source #

The name of the custom metric.

describeCustomMetricResponse_metricType :: Lens' DescribeCustomMetricResponse (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.

describeCustomMetricResponse_httpStatus :: Lens' DescribeCustomMetricResponse Int Source #

The response's http status code.