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.IoTSiteWise.BatchGetAssetPropertyAggregates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more information, see Querying aggregates in the IoT SiteWise User Guide.

Synopsis

Creating a Request

data BatchGetAssetPropertyAggregates Source #

See: newBatchGetAssetPropertyAggregates smart constructor.

Constructors

BatchGetAssetPropertyAggregates'

Fields

maxResults :: Maybe Natural
The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.
- The size of the result set is less than 1 MB.
- The number of data points in the result set is less than the value of maxResults. The maximum value of maxResults is 4000.
nextToken :: Maybe Text
The token to be used for the next set of paginated results.
entries :: [BatchGetAssetPropertyAggregatesEntry]
The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

Instances

Instances details

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

newBatchGetAssetPropertyAggregates :: BatchGetAssetPropertyAggregates Source #

Create a value of BatchGetAssetPropertyAggregates 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:maxResults:BatchGetAssetPropertyAggregates', batchGetAssetPropertyAggregates_maxResults - The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

The size of the result set is less than 1 MB.
The number of data points in the result set is less than the value of maxResults. The maximum value of maxResults is 4000.

BatchGetAssetPropertyAggregates, batchGetAssetPropertyAggregates_nextToken - The token to be used for the next set of paginated results.

$sel:entries:BatchGetAssetPropertyAggregates', batchGetAssetPropertyAggregates_entries - The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

Request Lenses

batchGetAssetPropertyAggregates_maxResults :: Lens' BatchGetAssetPropertyAggregates (Maybe Natural) Source #

The maximum number of results to return for each paginated request. A result set is returned in the two cases, whichever occurs first.

The size of the result set is less than 1 MB.
The number of data points in the result set is less than the value of maxResults. The maximum value of maxResults is 4000.

batchGetAssetPropertyAggregates_nextToken :: Lens' BatchGetAssetPropertyAggregates (Maybe Text) Source #

The token to be used for the next set of paginated results.

batchGetAssetPropertyAggregates_entries :: Lens' BatchGetAssetPropertyAggregates [BatchGetAssetPropertyAggregatesEntry] Source #

The list of asset property aggregate entries for the batch get request. You can specify up to 16 entries per request.

Destructuring the Response

data BatchGetAssetPropertyAggregatesResponse Source #

See: newBatchGetAssetPropertyAggregatesResponse smart constructor.

Constructors

BatchGetAssetPropertyAggregatesResponse'

Fields

nextToken :: Maybe Text
The token for the next set of results, or null if there are no additional results.
httpStatus :: Int
The response's http status code.
errorEntries :: [BatchGetAssetPropertyAggregatesErrorEntry]
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
successEntries :: [BatchGetAssetPropertyAggregatesSuccessEntry]
A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.
skippedEntries :: [BatchGetAssetPropertyAggregatesSkippedEntry]
A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

Instances

Instances details

Generic BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates Associated Types type Rep BatchGetAssetPropertyAggregatesResponse :: Type -> Type # Methods from :: BatchGetAssetPropertyAggregatesResponse -> Rep BatchGetAssetPropertyAggregatesResponse x # to :: Rep BatchGetAssetPropertyAggregatesResponse x -> BatchGetAssetPropertyAggregatesResponse #
Read BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates Methods readsPrec :: Int -> ReadS BatchGetAssetPropertyAggregatesResponse # readList :: ReadS [BatchGetAssetPropertyAggregatesResponse] # readPrec :: ReadPrec BatchGetAssetPropertyAggregatesResponse # readListPrec :: ReadPrec [BatchGetAssetPropertyAggregatesResponse] #
Show BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates Methods showsPrec :: Int -> BatchGetAssetPropertyAggregatesResponse -> ShowS # show :: BatchGetAssetPropertyAggregatesResponse -> String # showList :: [BatchGetAssetPropertyAggregatesResponse] -> ShowS #
NFData BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates Methods rnf :: BatchGetAssetPropertyAggregatesResponse -> () #
Eq BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates Methods (==) :: BatchGetAssetPropertyAggregatesResponse -> BatchGetAssetPropertyAggregatesResponse -> Bool # (/=) :: BatchGetAssetPropertyAggregatesResponse -> BatchGetAssetPropertyAggregatesResponse -> Bool #
type Rep BatchGetAssetPropertyAggregatesResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates type Rep BatchGetAssetPropertyAggregatesResponse = D1 ('MetaData "BatchGetAssetPropertyAggregatesResponse" "Amazonka.IoTSiteWise.BatchGetAssetPropertyAggregates" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "BatchGetAssetPropertyAggregatesResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "errorEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetAssetPropertyAggregatesErrorEntry]) :: (S1 ('MetaSel ('Just "successEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetAssetPropertyAggregatesSuccessEntry]) :: S1 ('MetaSel ('Just "skippedEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetAssetPropertyAggregatesSkippedEntry])))))

newBatchGetAssetPropertyAggregatesResponse Source #

Arguments

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

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

BatchGetAssetPropertyAggregates, batchGetAssetPropertyAggregatesResponse_nextToken - The token for the next set of results, or null if there are no additional results.

$sel:httpStatus:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_httpStatus - The response's http status code.

$sel:errorEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_errorEntries - A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

$sel:successEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_successEntries - A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

$sel:skippedEntries:BatchGetAssetPropertyAggregatesResponse', batchGetAssetPropertyAggregatesResponse_skippedEntries - A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.

Response Lenses

batchGetAssetPropertyAggregatesResponse_nextToken :: Lens' BatchGetAssetPropertyAggregatesResponse (Maybe Text) Source #

The token for the next set of results, or null if there are no additional results.

batchGetAssetPropertyAggregatesResponse_httpStatus :: Lens' BatchGetAssetPropertyAggregatesResponse Int Source #

The response's http status code.

batchGetAssetPropertyAggregatesResponse_errorEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesErrorEntry] Source #

A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.

batchGetAssetPropertyAggregatesResponse_successEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesSuccessEntry] Source #

A list of entries that were processed successfully by this batch request. Each success entry contains the entryId of the entry that succeeded and the latest query result.

batchGetAssetPropertyAggregatesResponse_skippedEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesSkippedEntry] Source #

A list of entries that were not processed by this batch request. because these entries had been completely processed by previous paginated requests. Each skipped entry contains the entryId of the entry that skipped.