Amazonka.IoT.DescribeFleetMetric

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Creating a Request

data DescribeFleetMetric

See: newDescribeFleetMetric smart constructor.

Constructors

DescribeFleetMetric'

Fields

• metricName :: Text

  The name of the fleet metric to describe.

Instances

ToHeaders DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

toHeaders :: DescribeFleetMetric -> [Header]

ToPath DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

toPath :: DescribeFleetMetric -> ByteString

ToQuery DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

toQuery :: DescribeFleetMetric -> QueryString

AWSRequest DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type AWSResponse DescribeFleetMetric

Methods

request :: (Service -> Service) -> DescribeFleetMetric -> Request DescribeFleetMetric

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeFleetMetric -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeFleetMetric)))

Generic DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type Rep DescribeFleetMetric :: Type -> Type

Methods

from :: DescribeFleetMetric -> Rep DescribeFleetMetric x

to :: Rep DescribeFleetMetric x -> DescribeFleetMetric

Read DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

readsPrec :: Int -> ReadS DescribeFleetMetric

readList :: ReadS [DescribeFleetMetric]

readPrec :: ReadPrec DescribeFleetMetric

readListPrec :: ReadPrec [DescribeFleetMetric]

Show DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

showsPrec :: Int -> DescribeFleetMetric -> ShowS

show :: DescribeFleetMetric -> String

showList :: [DescribeFleetMetric] -> ShowS

NFData DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

rnf :: DescribeFleetMetric -> ()

Eq DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

(==) :: DescribeFleetMetric -> DescribeFleetMetric -> Bool

(/=) :: DescribeFleetMetric -> DescribeFleetMetric -> Bool

Hashable DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

hashWithSalt :: Int -> DescribeFleetMetric -> Int

hash :: DescribeFleetMetric -> Int

type AWSResponse DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

type AWSResponse DescribeFleetMetric = DescribeFleetMetricResponse

type Rep DescribeFleetMetric

Defined in Amazonka.IoT.DescribeFleetMetric

type Rep DescribeFleetMetric = D1 ('MetaData "DescribeFleetMetric" "Amazonka.IoT.DescribeFleetMetric" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeFleetMetric'" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeFleetMetric

Arguments

:: Text

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:

DescribeFleetMetric, describeFleetMetric_metricName - The name of the fleet metric to describe.

Request Lenses

describeFleetMetric_metricName :: Lens' DescribeFleetMetric Text

The name of the fleet metric to describe.

Destructuring the Response

data DescribeFleetMetricResponse

See: newDescribeFleetMetricResponse smart constructor.

Constructors

DescribeFleetMetricResponse'

Fields

• aggregationField :: Maybe Text

  The field to aggregate.

• aggregationType :: Maybe AggregationType

  The type of the aggregation query.

• creationDate :: Maybe POSIX

  The date when the fleet metric is created.

• description :: Maybe Text

  The fleet metric description.

• indexName :: Maybe Text

  The name of the index to search.

• lastModifiedDate :: Maybe POSIX

  The date when the fleet metric is last modified.

• metricArn :: Maybe Text

  The ARN of the fleet metric to describe.

• metricName :: Maybe Text

  The name of the fleet metric to describe.

• period :: Maybe Natural

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

• queryString :: Maybe Text

  The search query string.

• queryVersion :: Maybe Text

  The query version.

• unit :: Maybe FleetMetricUnit

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

• version :: Maybe Integer

  The version of the fleet metric.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

Associated Types

type Rep DescribeFleetMetricResponse :: Type -> Type

Methods

from :: DescribeFleetMetricResponse -> Rep DescribeFleetMetricResponse x

to :: Rep DescribeFleetMetricResponse x -> DescribeFleetMetricResponse

Read DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

readsPrec :: Int -> ReadS DescribeFleetMetricResponse

readList :: ReadS [DescribeFleetMetricResponse]

readPrec :: ReadPrec DescribeFleetMetricResponse

readListPrec :: ReadPrec [DescribeFleetMetricResponse]

Show DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

showsPrec :: Int -> DescribeFleetMetricResponse -> ShowS

show :: DescribeFleetMetricResponse -> String

showList :: [DescribeFleetMetricResponse] -> ShowS

NFData DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

rnf :: DescribeFleetMetricResponse -> ()

Eq DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

Methods

(==) :: DescribeFleetMetricResponse -> DescribeFleetMetricResponse -> Bool

(/=) :: DescribeFleetMetricResponse -> DescribeFleetMetricResponse -> Bool

type Rep DescribeFleetMetricResponse

Defined in Amazonka.IoT.DescribeFleetMetric

type Rep DescribeFleetMetricResponse = D1 ('MetaData "DescribeFleetMetricResponse" "Amazonka.IoT.DescribeFleetMetric" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeFleetMetricResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "aggregationField") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "aggregationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AggregationType)) :*: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "indexName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: S1 ('MetaSel ('Just "metricArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "queryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "queryVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "unit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FleetMetricUnit))) :*: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeFleetMetricResponse

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:aggregationField:DescribeFleetMetricResponse', describeFleetMetricResponse_aggregationField - The field to aggregate.

$sel:aggregationType:DescribeFleetMetricResponse', describeFleetMetricResponse_aggregationType - The type of the aggregation query.

DescribeFleetMetricResponse, describeFleetMetricResponse_creationDate - The date when the fleet metric is created.

DescribeFleetMetricResponse, describeFleetMetricResponse_description - The fleet metric description.

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

DescribeFleetMetricResponse, describeFleetMetricResponse_lastModifiedDate - The date when the fleet metric is last modified.

DescribeFleetMetricResponse, describeFleetMetricResponse_metricArn - The ARN of the fleet metric to describe.

DescribeFleetMetric, describeFleetMetricResponse_metricName - The name of the fleet metric to describe.

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

DescribeFleetMetricResponse, describeFleetMetricResponse_queryString - The search query string.

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

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

DescribeFleetMetricResponse, describeFleetMetricResponse_version - The version of the fleet metric.

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

Response Lenses

describeFleetMetricResponse_aggregationField :: Lens' DescribeFleetMetricResponse (Maybe Text)

The field to aggregate.

describeFleetMetricResponse_aggregationType :: Lens' DescribeFleetMetricResponse (Maybe AggregationType)

The type of the aggregation query.

describeFleetMetricResponse_creationDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime)

The date when the fleet metric is created.

describeFleetMetricResponse_description :: Lens' DescribeFleetMetricResponse (Maybe Text)

The fleet metric description.

describeFleetMetricResponse_indexName :: Lens' DescribeFleetMetricResponse (Maybe Text)

The name of the index to search.

describeFleetMetricResponse_lastModifiedDate :: Lens' DescribeFleetMetricResponse (Maybe UTCTime)

The date when the fleet metric is last modified.

describeFleetMetricResponse_metricArn :: Lens' DescribeFleetMetricResponse (Maybe Text)

The ARN of the fleet metric to describe.

describeFleetMetricResponse_metricName :: Lens' DescribeFleetMetricResponse (Maybe Text)

The name of the fleet metric to describe.

describeFleetMetricResponse_period :: Lens' DescribeFleetMetricResponse (Maybe Natural)

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

describeFleetMetricResponse_queryString :: Lens' DescribeFleetMetricResponse (Maybe Text)

The search query string.

describeFleetMetricResponse_queryVersion :: Lens' DescribeFleetMetricResponse (Maybe Text)

The query version.

describeFleetMetricResponse_unit :: Lens' DescribeFleetMetricResponse (Maybe FleetMetricUnit)

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

describeFleetMetricResponse_version :: Lens' DescribeFleetMetricResponse (Maybe Integer)

The version of the fleet metric.

describeFleetMetricResponse_httpStatus :: Lens' DescribeFleetMetricResponse Int

The response's http status code.