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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the data for a fleet metric.

Requires permission to access the UpdateFleetMetric action.

Synopsis

data UpdateFleetMetric = UpdateFleetMetric' {
- aggregationType :: Maybe AggregationType
- period :: Maybe Natural
- queryVersion :: Maybe Text
- aggregationField :: Maybe Text
- expectedVersion :: Maybe Integer
- queryString :: Maybe Text
- description :: Maybe Text
- unit :: Maybe FleetMetricUnit
- metricName :: Text
- indexName :: Text
}
newUpdateFleetMetric :: Text -> Text -> UpdateFleetMetric
updateFleetMetric_aggregationType :: Lens' UpdateFleetMetric (Maybe AggregationType)
updateFleetMetric_period :: Lens' UpdateFleetMetric (Maybe Natural)
updateFleetMetric_queryVersion :: Lens' UpdateFleetMetric (Maybe Text)
updateFleetMetric_aggregationField :: Lens' UpdateFleetMetric (Maybe Text)
updateFleetMetric_expectedVersion :: Lens' UpdateFleetMetric (Maybe Integer)
updateFleetMetric_queryString :: Lens' UpdateFleetMetric (Maybe Text)
updateFleetMetric_description :: Lens' UpdateFleetMetric (Maybe Text)
updateFleetMetric_unit :: Lens' UpdateFleetMetric (Maybe FleetMetricUnit)
updateFleetMetric_metricName :: Lens' UpdateFleetMetric Text
updateFleetMetric_indexName :: Lens' UpdateFleetMetric Text
data UpdateFleetMetricResponse = UpdateFleetMetricResponse' {
}
newUpdateFleetMetricResponse :: UpdateFleetMetricResponse

Creating a Request

data UpdateFleetMetric Source #

See: newUpdateFleetMetric smart constructor.

Constructors

UpdateFleetMetric'

Fields

aggregationType :: Maybe AggregationType
The type of the aggregation query.
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 version of the query.
aggregationField :: Maybe Text
The field to aggregate.
expectedVersion :: Maybe Integer
The expected version of the fleet metric record in the registry.
queryString :: Maybe Text
The search query string.
description :: Maybe Text
The description of the fleet metric.
unit :: Maybe FleetMetricUnit
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.
metricName :: Text
The name of the fleet metric to update.
indexName :: Text
The name of the index to search.

Instances

Instances details

Eq UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods (==) :: UpdateFleetMetric -> UpdateFleetMetric -> Bool # (/=) :: UpdateFleetMetric -> UpdateFleetMetric -> Bool #
Read UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods readsPrec :: Int -> ReadS UpdateFleetMetric # readList :: ReadS [UpdateFleetMetric] # readPrec :: ReadPrec UpdateFleetMetric # readListPrec :: ReadPrec [UpdateFleetMetric] #
Show UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods showsPrec :: Int -> UpdateFleetMetric -> ShowS # show :: UpdateFleetMetric -> String # showList :: [UpdateFleetMetric] -> ShowS #
Generic UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Associated Types type Rep UpdateFleetMetric :: Type -> Type # Methods from :: UpdateFleetMetric -> Rep UpdateFleetMetric x # to :: Rep UpdateFleetMetric x -> UpdateFleetMetric #
NFData UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods rnf :: UpdateFleetMetric -> () #
Hashable UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods hashWithSalt :: Int -> UpdateFleetMetric -> Int # hash :: UpdateFleetMetric -> Int #
ToJSON UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods toJSON :: UpdateFleetMetric -> Value # toEncoding :: UpdateFleetMetric -> Encoding # toJSONList :: [UpdateFleetMetric] -> Value # toEncodingList :: [UpdateFleetMetric] -> Encoding #
AWSRequest UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Associated Types type AWSResponse UpdateFleetMetric # Methods request :: UpdateFleetMetric -> Request UpdateFleetMetric # response :: MonadResource m => Logger -> Service -> Proxy UpdateFleetMetric -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateFleetMetric))) #
ToHeaders UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods toHeaders :: UpdateFleetMetric -> [Header] #
ToPath UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods toPath :: UpdateFleetMetric -> ByteString #
ToQuery UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods toQuery :: UpdateFleetMetric -> QueryString #
type Rep UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric type Rep UpdateFleetMetric = D1 ('MetaData "UpdateFleetMetric" "Amazonka.IoT.UpdateFleetMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateFleetMetric'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationType)) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expectedVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer))))) :: ((S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetMetricUnit)) :: (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse UpdateFleetMetric Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric type AWSResponse UpdateFleetMetric = UpdateFleetMetricResponse

newUpdateFleetMetric Source #

Arguments

:: Text	`$sel:metricName:UpdateFleetMetric'`
-> Text	`$sel:indexName:UpdateFleetMetric'`
-> UpdateFleetMetric

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

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

$sel:queryVersion:UpdateFleetMetric', updateFleetMetric_queryVersion - The version of the query.

$sel:aggregationField:UpdateFleetMetric', updateFleetMetric_aggregationField - The field to aggregate.

$sel:expectedVersion:UpdateFleetMetric', updateFleetMetric_expectedVersion - The expected version of the fleet metric record in the registry.

$sel:queryString:UpdateFleetMetric', updateFleetMetric_queryString - The search query string.

$sel:description:UpdateFleetMetric', updateFleetMetric_description - The description of the fleet metric.

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

$sel:metricName:UpdateFleetMetric', updateFleetMetric_metricName - The name of the fleet metric to update.

$sel:indexName:UpdateFleetMetric', updateFleetMetric_indexName - The name of the index to search.

Request Lenses

updateFleetMetric_aggregationType :: Lens' UpdateFleetMetric (Maybe AggregationType) Source #

The type of the aggregation query.

updateFleetMetric_period :: Lens' UpdateFleetMetric (Maybe Natural) Source #

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

updateFleetMetric_queryVersion :: Lens' UpdateFleetMetric (Maybe Text) Source #

The version of the query.

updateFleetMetric_aggregationField :: Lens' UpdateFleetMetric (Maybe Text) Source #

The field to aggregate.

updateFleetMetric_expectedVersion :: Lens' UpdateFleetMetric (Maybe Integer) Source #

The expected version of the fleet metric record in the registry.

updateFleetMetric_queryString :: Lens' UpdateFleetMetric (Maybe Text) Source #

The search query string.

updateFleetMetric_description :: Lens' UpdateFleetMetric (Maybe Text) Source #

The description of the fleet metric.

updateFleetMetric_unit :: Lens' UpdateFleetMetric (Maybe FleetMetricUnit) Source #

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

updateFleetMetric_metricName :: Lens' UpdateFleetMetric Text Source #

The name of the fleet metric to update.

updateFleetMetric_indexName :: Lens' UpdateFleetMetric Text Source #

The name of the index to search.

Destructuring the Response

data UpdateFleetMetricResponse Source #

See: newUpdateFleetMetricResponse smart constructor.

Constructors

UpdateFleetMetricResponse'

Instances

Instances details

Eq UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods (==) :: UpdateFleetMetricResponse -> UpdateFleetMetricResponse -> Bool # (/=) :: UpdateFleetMetricResponse -> UpdateFleetMetricResponse -> Bool #
Read UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods readsPrec :: Int -> ReadS UpdateFleetMetricResponse # readList :: ReadS [UpdateFleetMetricResponse] # readPrec :: ReadPrec UpdateFleetMetricResponse # readListPrec :: ReadPrec [UpdateFleetMetricResponse] #
Show UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods showsPrec :: Int -> UpdateFleetMetricResponse -> ShowS # show :: UpdateFleetMetricResponse -> String # showList :: [UpdateFleetMetricResponse] -> ShowS #
Generic UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Associated Types type Rep UpdateFleetMetricResponse :: Type -> Type # Methods from :: UpdateFleetMetricResponse -> Rep UpdateFleetMetricResponse x # to :: Rep UpdateFleetMetricResponse x -> UpdateFleetMetricResponse #
NFData UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric Methods rnf :: UpdateFleetMetricResponse -> () #
type Rep UpdateFleetMetricResponse Source #
Instance details Defined in Amazonka.IoT.UpdateFleetMetric type Rep UpdateFleetMetricResponse = D1 ('MetaData "UpdateFleetMetricResponse" "Amazonka.IoT.UpdateFleetMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateFleetMetricResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateFleetMetricResponse :: UpdateFleetMetricResponse Source #

Create a value of UpdateFleetMetricResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.