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

Description

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Synopsis

Creating a Request

data DescribeFleetMetric Source #

See: newDescribeFleetMetric smart constructor.

Constructors

DescribeFleetMetric' 

Fields

Instances

Instances details
Eq DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Read DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Show DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Generic DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type Rep DescribeFleetMetric :: Type -> Type #

NFData DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

rnf :: DescribeFleetMetric -> () #

Hashable DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

AWSRequest DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type AWSResponse DescribeFleetMetric #

ToHeaders DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

ToPath DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

ToQuery DescribeFleetMetric Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

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

newDescribeFleetMetric Source #

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

Instances

Instances details
Eq DescribeFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Read DescribeFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Show DescribeFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Generic DescribeFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type Rep DescribeFleetMetricResponse :: Type -> Type #

NFData DescribeFleetMetricResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeFleetMetric

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 #

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.

Response Lenses

describeFleetMetricResponse_period :: Lens' DescribeFleetMetricResponse (Maybe Natural) Source #

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

describeFleetMetricResponse_unit :: Lens' DescribeFleetMetricResponse (Maybe FleetMetricUnit) Source #

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