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.LookoutEquipment.ListSensorStatistics

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists statistics about the data collected for each of the sensors that have been successfully ingested in the particular dataset. Can also be used to retreive Sensor Statistics for a previous ingestion job.

Synopsis

Creating a Request

data ListSensorStatistics Source #

See: newListSensorStatistics smart constructor.

Constructors

ListSensorStatistics'

Fields

ingestionJobId :: Maybe Text
The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.
maxResults :: Maybe Natural
Specifies the maximum number of sensors for which to retrieve statistics.
nextToken :: Maybe Text
An opaque pagination token indicating where to continue the listing of sensor statistics.
datasetName :: Text
The name of the dataset associated with the list of Sensor Statistics.

Instances

Instances details

ToJSON ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods toJSON :: ListSensorStatistics -> Value # toEncoding :: ListSensorStatistics -> Encoding # toJSONList :: [ListSensorStatistics] -> Value # toEncodingList :: [ListSensorStatistics] -> Encoding #
ToHeaders ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods toHeaders :: ListSensorStatistics -> [Header] #
ToPath ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods toPath :: ListSensorStatistics -> ByteString #
ToQuery ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods toQuery :: ListSensorStatistics -> QueryString #
AWSRequest ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Associated Types type AWSResponse ListSensorStatistics # Methods request :: (Service -> Service) -> ListSensorStatistics -> Request ListSensorStatistics # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSensorStatistics -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSensorStatistics))) #
Generic ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Associated Types type Rep ListSensorStatistics :: Type -> Type # Methods from :: ListSensorStatistics -> Rep ListSensorStatistics x # to :: Rep ListSensorStatistics x -> ListSensorStatistics #
Read ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods readsPrec :: Int -> ReadS ListSensorStatistics # readList :: ReadS [ListSensorStatistics] # readPrec :: ReadPrec ListSensorStatistics # readListPrec :: ReadPrec [ListSensorStatistics] #
Show ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods showsPrec :: Int -> ListSensorStatistics -> ShowS # show :: ListSensorStatistics -> String # showList :: [ListSensorStatistics] -> ShowS #
NFData ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods rnf :: ListSensorStatistics -> () #
Eq ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods (==) :: ListSensorStatistics -> ListSensorStatistics -> Bool # (/=) :: ListSensorStatistics -> ListSensorStatistics -> Bool #
Hashable ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics Methods hashWithSalt :: Int -> ListSensorStatistics -> Int # hash :: ListSensorStatistics -> Int #
type AWSResponse ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics type AWSResponse ListSensorStatistics = ListSensorStatisticsResponse
type Rep ListSensorStatistics Source #
Instance details Defined in Amazonka.LookoutEquipment.ListSensorStatistics type Rep ListSensorStatistics = D1 ('MetaData "ListSensorStatistics" "Amazonka.LookoutEquipment.ListSensorStatistics" "amazonka-lookoutequipment-2.0-FBtgEViQ46F6elHeNaa8oC" 'False) (C1 ('MetaCons "ListSensorStatistics'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "ingestionJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "datasetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSensorStatistics Source #

Arguments

:: Text	`ListSensorStatistics`
-> ListSensorStatistics

Create a value of ListSensorStatistics 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:ingestionJobId:ListSensorStatistics', listSensorStatistics_ingestionJobId - The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.

$sel:maxResults:ListSensorStatistics', listSensorStatistics_maxResults - Specifies the maximum number of sensors for which to retrieve statistics.

ListSensorStatistics, listSensorStatistics_nextToken - An opaque pagination token indicating where to continue the listing of sensor statistics.

ListSensorStatistics, listSensorStatistics_datasetName - The name of the dataset associated with the list of Sensor Statistics.

Request Lenses

listSensorStatistics_ingestionJobId :: Lens' ListSensorStatistics (Maybe Text) Source #

The ingestion job id associated with the list of Sensor Statistics. To get sensor statistics for a particular ingestion job id, both dataset name and ingestion job id must be submitted as inputs.

listSensorStatistics_maxResults :: Lens' ListSensorStatistics (Maybe Natural) Source #

Specifies the maximum number of sensors for which to retrieve statistics.

listSensorStatistics_nextToken :: Lens' ListSensorStatistics (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of sensor statistics.

listSensorStatistics_datasetName :: Lens' ListSensorStatistics Text Source #

The name of the dataset associated with the list of Sensor Statistics.

Destructuring the Response

data ListSensorStatisticsResponse Source #

See: newListSensorStatisticsResponse smart constructor.

Constructors

ListSensorStatisticsResponse'

Fields

nextToken :: Maybe Text
An opaque pagination token indicating where to continue the listing of sensor statistics.
sensorStatisticsSummaries :: Maybe [SensorStatisticsSummary]
Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newListSensorStatisticsResponse Source #

Arguments

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

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

ListSensorStatistics, listSensorStatisticsResponse_nextToken - An opaque pagination token indicating where to continue the listing of sensor statistics.

$sel:sensorStatisticsSummaries:ListSensorStatisticsResponse', listSensorStatisticsResponse_sensorStatisticsSummaries - Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

$sel:httpStatus:ListSensorStatisticsResponse', listSensorStatisticsResponse_httpStatus - The response's http status code.

Response Lenses

listSensorStatisticsResponse_nextToken :: Lens' ListSensorStatisticsResponse (Maybe Text) Source #

An opaque pagination token indicating where to continue the listing of sensor statistics.

listSensorStatisticsResponse_sensorStatisticsSummaries :: Lens' ListSensorStatisticsResponse (Maybe [SensorStatisticsSummary]) Source #

Provides ingestion-based statistics regarding the specified sensor with respect to various validation types, such as whether data exists, the number and percentage of missing values, and the number and percentage of duplicate timestamps.

listSensorStatisticsResponse_httpStatus :: Lens' ListSensorStatisticsResponse Int Source #

The response's http status code.