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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Synopsis

data CreateFleetMetric = CreateFleetMetric' {
- description :: Maybe Text
- indexName :: Maybe Text
- queryVersion :: Maybe Text
- tags :: Maybe [Tag]
- unit :: Maybe FleetMetricUnit
- metricName :: Text
- queryString :: Text
- aggregationType :: AggregationType
- period :: Natural
- aggregationField :: Text
}
newCreateFleetMetric :: Text -> Text -> AggregationType -> Natural -> Text -> CreateFleetMetric
createFleetMetric_description :: Lens' CreateFleetMetric (Maybe Text)
createFleetMetric_indexName :: Lens' CreateFleetMetric (Maybe Text)
createFleetMetric_queryVersion :: Lens' CreateFleetMetric (Maybe Text)
createFleetMetric_tags :: Lens' CreateFleetMetric (Maybe [Tag])
createFleetMetric_unit :: Lens' CreateFleetMetric (Maybe FleetMetricUnit)
createFleetMetric_metricName :: Lens' CreateFleetMetric Text
createFleetMetric_queryString :: Lens' CreateFleetMetric Text
createFleetMetric_aggregationType :: Lens' CreateFleetMetric AggregationType
createFleetMetric_period :: Lens' CreateFleetMetric Natural
createFleetMetric_aggregationField :: Lens' CreateFleetMetric Text
data CreateFleetMetricResponse = CreateFleetMetricResponse' {
- metricArn :: Maybe Text
- metricName :: Maybe Text
- httpStatus :: Int
}
newCreateFleetMetricResponse :: Int -> CreateFleetMetricResponse
createFleetMetricResponse_metricArn :: Lens' CreateFleetMetricResponse (Maybe Text)
createFleetMetricResponse_metricName :: Lens' CreateFleetMetricResponse (Maybe Text)
createFleetMetricResponse_httpStatus :: Lens' CreateFleetMetricResponse Int

Creating a Request

data CreateFleetMetric Source #

See: newCreateFleetMetric smart constructor.

Constructors

CreateFleetMetric'

Fields

description :: Maybe Text
The fleet metric description.
indexName :: Maybe Text
The name of the index to search.
queryVersion :: Maybe Text
The query version.
tags :: Maybe [Tag]
Metadata, which can be used to manage the fleet metric.
unit :: Maybe FleetMetricUnit
Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.
metricName :: Text
The name of the fleet metric to create.
queryString :: Text
The search query string.
aggregationType :: AggregationType
The type of the aggregation query.
period :: Natural
The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.
aggregationField :: Text
The field to aggregate.

Instances

Instances details

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

newCreateFleetMetric Source #

Arguments

:: Text	`CreateFleetMetric`
-> Text	`CreateFleetMetric`
-> AggregationType	`$sel:aggregationType:CreateFleetMetric'`
-> Natural	`$sel:period:CreateFleetMetric'`
-> Text	`$sel:aggregationField:CreateFleetMetric'`
-> CreateFleetMetric

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

CreateFleetMetric, createFleetMetric_description - The fleet metric description.

$sel:indexName:CreateFleetMetric', createFleetMetric_indexName - The name of the index to search.

$sel:queryVersion:CreateFleetMetric', createFleetMetric_queryVersion - The query version.

$sel:tags:CreateFleetMetric', createFleetMetric_tags - Metadata, which can be used to manage the fleet metric.

CreateFleetMetric, createFleetMetric_unit - Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric. Default to null.

CreateFleetMetric, createFleetMetric_metricName - The name of the fleet metric to create.

CreateFleetMetric, createFleetMetric_queryString - The search query string.

$sel:aggregationType:CreateFleetMetric', createFleetMetric_aggregationType - The type of the aggregation query.

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

$sel:aggregationField:CreateFleetMetric', createFleetMetric_aggregationField - The field to aggregate.

Request Lenses

createFleetMetric_description :: Lens' CreateFleetMetric (Maybe Text) Source #

The fleet metric description.

createFleetMetric_indexName :: Lens' CreateFleetMetric (Maybe Text) Source #

The name of the index to search.

createFleetMetric_queryVersion :: Lens' CreateFleetMetric (Maybe Text) Source #

The query version.

createFleetMetric_tags :: Lens' CreateFleetMetric (Maybe [Tag]) Source #

Metadata, which can be used to manage the fleet metric.

createFleetMetric_unit :: Lens' CreateFleetMetric (Maybe FleetMetricUnit) Source #

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

createFleetMetric_metricName :: Lens' CreateFleetMetric Text Source #

The name of the fleet metric to create.

createFleetMetric_queryString :: Lens' CreateFleetMetric Text Source #

The search query string.

createFleetMetric_aggregationType :: Lens' CreateFleetMetric AggregationType Source #

The type of the aggregation query.

createFleetMetric_period :: Lens' CreateFleetMetric Natural Source #

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

createFleetMetric_aggregationField :: Lens' CreateFleetMetric Text Source #

The field to aggregate.

Destructuring the Response

data CreateFleetMetricResponse Source #

See: newCreateFleetMetricResponse smart constructor.

Constructors

CreateFleetMetricResponse'
Fields metricArn :: Maybe Text The Amazon Resource Name (ARN) of the new fleet metric. metricName :: Maybe Text The name of the fleet metric to create. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateFleetMetricResponse Source #

Arguments

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

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

CreateFleetMetricResponse, createFleetMetricResponse_metricArn - The Amazon Resource Name (ARN) of the new fleet metric.

CreateFleetMetric, createFleetMetricResponse_metricName - The name of the fleet metric to create.

$sel:httpStatus:CreateFleetMetricResponse', createFleetMetricResponse_httpStatus - The response's http status code.

Response Lenses

createFleetMetricResponse_metricArn :: Lens' CreateFleetMetricResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the new fleet metric.

createFleetMetricResponse_metricName :: Lens' CreateFleetMetricResponse (Maybe Text) Source #

The name of the fleet metric to create.

createFleetMetricResponse_httpStatus :: Lens' CreateFleetMetricResponse Int Source #

The response's http status code.