libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.CreateFleetMetric

Description

Creates a fleet metric.

Requires permission to access the CreateFleetMetric action.

Synopsis

Creating a Request

data CreateFleetMetric Source #

See: newCreateFleetMetric smart constructor.

Constructors

CreateFleetMetric' 

Fields

Instances

Instances details
Eq CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Read CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Show CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Generic CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Associated Types

type Rep CreateFleetMetric :: Type -> Type #

NFData CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Methods

rnf :: CreateFleetMetric -> () #

Hashable CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

ToJSON CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

AWSRequest CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Associated Types

type AWSResponse CreateFleetMetric #

ToHeaders CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

ToPath CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

ToQuery CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

type Rep CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

type AWSResponse CreateFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

newCreateFleetMetric Source #

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:

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

$sel:description:CreateFleetMetric', createFleetMetric_description - The fleet metric description.

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

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

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

$sel:metricName:CreateFleetMetric', createFleetMetric_metricName - The name of the fleet metric to create.

$sel:queryString: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_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_tags :: Lens' CreateFleetMetric (Maybe [Tag]) Source #

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

createFleetMetric_metricName :: Lens' CreateFleetMetric Text Source #

The name of the fleet metric to create.

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.

Destructuring the Response

data CreateFleetMetricResponse Source #

See: newCreateFleetMetricResponse smart constructor.

Constructors

CreateFleetMetricResponse' 

Fields

Instances

Instances details
Eq CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Read CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Show CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Generic CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

Associated Types

type Rep CreateFleetMetricResponse :: Type -> Type #

NFData CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

type Rep CreateFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateFleetMetric

type Rep CreateFleetMetricResponse = D1 ('MetaData "CreateFleetMetricResponse" "Amazonka.IoT.CreateFleetMetric" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateFleetMetricResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") '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))))

newCreateFleetMetricResponse Source #

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:

$sel:metricName:CreateFleetMetric', createFleetMetricResponse_metricName - The name of the fleet metric to create.

$sel:metricArn:CreateFleetMetricResponse', createFleetMetricResponse_metricArn - The Amazon Resource Name (ARN) of the new fleet metric.

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