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 |
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
- data BatchGetAssetPropertyAggregates = BatchGetAssetPropertyAggregates' {}
- newBatchGetAssetPropertyAggregates :: BatchGetAssetPropertyAggregates
- batchGetAssetPropertyAggregates_maxResults :: Lens' BatchGetAssetPropertyAggregates (Maybe Natural)
- batchGetAssetPropertyAggregates_nextToken :: Lens' BatchGetAssetPropertyAggregates (Maybe Text)
- batchGetAssetPropertyAggregates_entries :: Lens' BatchGetAssetPropertyAggregates [BatchGetAssetPropertyAggregatesEntry]
- data BatchGetAssetPropertyAggregatesResponse = BatchGetAssetPropertyAggregatesResponse' {}
- newBatchGetAssetPropertyAggregatesResponse :: Int -> BatchGetAssetPropertyAggregatesResponse
- batchGetAssetPropertyAggregatesResponse_nextToken :: Lens' BatchGetAssetPropertyAggregatesResponse (Maybe Text)
- batchGetAssetPropertyAggregatesResponse_httpStatus :: Lens' BatchGetAssetPropertyAggregatesResponse Int
- batchGetAssetPropertyAggregatesResponse_errorEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesErrorEntry]
- batchGetAssetPropertyAggregatesResponse_successEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesSuccessEntry]
- batchGetAssetPropertyAggregatesResponse_skippedEntries :: Lens' BatchGetAssetPropertyAggregatesResponse [BatchGetAssetPropertyAggregatesSkippedEntry]
Creating a Request
data BatchGetAssetPropertyAggregates Source #
See: newBatchGetAssetPropertyAggregates
smart constructor.
BatchGetAssetPropertyAggregates' | |
|
Instances
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 ofmaxResults
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 ofmaxResults
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.
BatchGetAssetPropertyAggregatesResponse' | |
|
Instances
newBatchGetAssetPropertyAggregatesResponse Source #
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.