Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoT.DescribeFleetMetric

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Synopsis

data DescribeFleetMetric = DescribeFleetMetric' {
- metricName :: Text
}
newDescribeFleetMetric :: Text -> DescribeFleetMetric
describeFleetMetric_metricName :: Lens' DescribeFleetMetric Text
data DescribeFleetMetricResponse = DescribeFleetMetricResponse' {
- aggregationType :: Maybe AggregationType
- lastModifiedDate :: Maybe POSIX
- period :: Maybe Natural
- queryVersion :: Maybe Text
- metricName :: Maybe Text
- aggregationField :: Maybe Text
- queryString :: Maybe Text
- version :: Maybe Integer
- creationDate :: Maybe POSIX
- description :: Maybe Text
- unit :: Maybe FleetMetricUnit
- indexName :: Maybe Text
- metricArn :: Maybe Text
- httpStatus :: Int
}
newDescribeFleetMetricResponse :: Int -> DescribeFleetMetricResponse
describeFleetMetricResponse_aggregationType :: Lens' DescribeFleetMetricResponse (Maybe AggregationType)
describeFleetMetricResponse_lastModifiedDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime)
describeFleetMetricResponse_period :: Lens' DescribeFleetMetricResponse (Maybe Natural)
describeFleetMetricResponse_queryVersion :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_metricName :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_aggregationField :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_queryString :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_version :: Lens' DescribeFleetMetricResponse (Maybe Integer)
describeFleetMetricResponse_creationDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime)
describeFleetMetricResponse_description :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_unit :: Lens' DescribeFleetMetricResponse (Maybe FleetMetricUnit)
describeFleetMetricResponse_indexName :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_metricArn :: Lens' DescribeFleetMetricResponse (Maybe Text)
describeFleetMetricResponse_httpStatus :: Lens' DescribeFleetMetricResponse Int

Creating a Request

data DescribeFleetMetric Source #

See: newDescribeFleetMetric smart constructor.

Constructors

DescribeFleetMetric'
Fields metricName :: Text The name of the fleet metric to describe.

Instances

Instances details

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

newDescribeFleetMetric Source #

Arguments

:: Text	`$sel:metricName:DescribeFleetMetric'`
-> DescribeFleetMetric

Create a value of DescribeFleetMetric 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:metricName:DescribeFleetMetric', describeFleetMetric_metricName - The name of the fleet metric to describe.

Request Lenses

describeFleetMetric_metricName :: Lens' DescribeFleetMetric Text Source #

The name of the fleet metric to describe.

Destructuring the Response

data DescribeFleetMetricResponse Source #

See: newDescribeFleetMetricResponse smart constructor.

Constructors

DescribeFleetMetricResponse'

Fields

aggregationType :: Maybe AggregationType
The type of the aggregation query.
lastModifiedDate :: Maybe POSIX
The date when the fleet metric is last modified.
period :: Maybe Natural
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
queryVersion :: Maybe Text
The query version.
metricName :: Maybe Text
The name of the fleet metric to describe.
aggregationField :: Maybe Text
The field to aggregate.
queryString :: Maybe Text
The search query string.
version :: Maybe Integer
The version of the fleet metric.
creationDate :: Maybe POSIX
The date when the fleet metric is created.
description :: Maybe Text
The fleet metric description.
unit :: Maybe FleetMetricUnit
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
indexName :: Maybe Text
The name of the index to search.
metricArn :: Maybe Text
The ARN of the fleet metric to describe.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric Methods (==) :: DescribeFleetMetricResponse -> DescribeFleetMetricResponse -> Bool # (/=) :: DescribeFleetMetricResponse -> DescribeFleetMetricResponse -> Bool #
Read DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric Methods readsPrec :: Int -> ReadS DescribeFleetMetricResponse # readList :: ReadS [DescribeFleetMetricResponse] # readPrec :: ReadPrec DescribeFleetMetricResponse # readListPrec :: ReadPrec [DescribeFleetMetricResponse] #
Show DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric Methods showsPrec :: Int -> DescribeFleetMetricResponse -> ShowS # show :: DescribeFleetMetricResponse -> String # showList :: [DescribeFleetMetricResponse] -> ShowS #
Generic DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric Associated Types type Rep DescribeFleetMetricResponse :: Type -> Type # Methods from :: DescribeFleetMetricResponse -> Rep DescribeFleetMetricResponse x # to :: Rep DescribeFleetMetricResponse x -> DescribeFleetMetricResponse #
NFData DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric Methods rnf :: DescribeFleetMetricResponse -> () #
type Rep DescribeFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.DescribeFleetMetric type Rep DescribeFleetMetricResponse = D1 ('MetaData "DescribeFleetMetricResponse" "Amazonka.IoT.DescribeFleetMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DescribeFleetMetricResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationType)) :: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: ((S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetMetricUnit)) :: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "metricArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeFleetMetricResponse Source #

Arguments

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

Create a value of DescribeFleetMetricResponse 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:aggregationType:DescribeFleetMetricResponse', describeFleetMetricResponse_aggregationType - The type of the aggregation query.

$sel:lastModifiedDate:DescribeFleetMetricResponse', describeFleetMetricResponse_lastModifiedDate - The date when the fleet metric is last modified.

$sel:period:DescribeFleetMetricResponse', describeFleetMetricResponse_period - The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

$sel:queryVersion:DescribeFleetMetricResponse', describeFleetMetricResponse_queryVersion - The query version.

$sel:metricName:DescribeFleetMetric', describeFleetMetricResponse_metricName - The name of the fleet metric to describe.

$sel:aggregationField:DescribeFleetMetricResponse', describeFleetMetricResponse_aggregationField - The field to aggregate.

$sel:queryString:DescribeFleetMetricResponse', describeFleetMetricResponse_queryString - The search query string.

$sel:version:DescribeFleetMetricResponse', describeFleetMetricResponse_version - The version of the fleet metric.

$sel:creationDate:DescribeFleetMetricResponse', describeFleetMetricResponse_creationDate - The date when the fleet metric is created.

$sel:description:DescribeFleetMetricResponse', describeFleetMetricResponse_description - The fleet metric description.

$sel:unit:DescribeFleetMetricResponse', describeFleetMetricResponse_unit - Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

$sel:indexName:DescribeFleetMetricResponse', describeFleetMetricResponse_indexName - The name of the index to search.

$sel:metricArn:DescribeFleetMetricResponse', describeFleetMetricResponse_metricArn - The ARN of the fleet metric to describe.

$sel:httpStatus:DescribeFleetMetricResponse', describeFleetMetricResponse_httpStatus - The response's http status code.