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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.

Synopsis

Creating a Request

data BatchGetAssetPropertyValueHistory Source #

See: newBatchGetAssetPropertyValueHistory smart constructor.

Constructors

BatchGetAssetPropertyValueHistory'

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 :: [BatchGetAssetPropertyValueHistoryEntry]
The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

Instances

Instances details

ToJSON BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods toJSON :: BatchGetAssetPropertyValueHistory -> Value # toEncoding :: BatchGetAssetPropertyValueHistory -> Encoding # toJSONList :: [BatchGetAssetPropertyValueHistory] -> Value # toEncodingList :: [BatchGetAssetPropertyValueHistory] -> Encoding #
ToHeaders BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods toHeaders :: BatchGetAssetPropertyValueHistory -> [Header] #
ToPath BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods toPath :: BatchGetAssetPropertyValueHistory -> ByteString #
ToQuery BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods toQuery :: BatchGetAssetPropertyValueHistory -> QueryString #
AWSRequest BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Associated Types type AWSResponse BatchGetAssetPropertyValueHistory # Methods request :: (Service -> Service) -> BatchGetAssetPropertyValueHistory -> Request BatchGetAssetPropertyValueHistory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy BatchGetAssetPropertyValueHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse BatchGetAssetPropertyValueHistory))) #
Generic BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Associated Types type Rep BatchGetAssetPropertyValueHistory :: Type -> Type # Methods from :: BatchGetAssetPropertyValueHistory -> Rep BatchGetAssetPropertyValueHistory x # to :: Rep BatchGetAssetPropertyValueHistory x -> BatchGetAssetPropertyValueHistory #
Read BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods readsPrec :: Int -> ReadS BatchGetAssetPropertyValueHistory # readList :: ReadS [BatchGetAssetPropertyValueHistory] # readPrec :: ReadPrec BatchGetAssetPropertyValueHistory # readListPrec :: ReadPrec [BatchGetAssetPropertyValueHistory] #
Show BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods showsPrec :: Int -> BatchGetAssetPropertyValueHistory -> ShowS # show :: BatchGetAssetPropertyValueHistory -> String # showList :: [BatchGetAssetPropertyValueHistory] -> ShowS #
NFData BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods rnf :: BatchGetAssetPropertyValueHistory -> () #
Eq BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods (==) :: BatchGetAssetPropertyValueHistory -> BatchGetAssetPropertyValueHistory -> Bool # (/=) :: BatchGetAssetPropertyValueHistory -> BatchGetAssetPropertyValueHistory -> Bool #
Hashable BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods hashWithSalt :: Int -> BatchGetAssetPropertyValueHistory -> Int # hash :: BatchGetAssetPropertyValueHistory -> Int #
type AWSResponse BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory type AWSResponse BatchGetAssetPropertyValueHistory = BatchGetAssetPropertyValueHistoryResponse
type Rep BatchGetAssetPropertyValueHistory Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory type Rep BatchGetAssetPropertyValueHistory = D1 ('MetaData "BatchGetAssetPropertyValueHistory" "Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "BatchGetAssetPropertyValueHistory'" '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 [BatchGetAssetPropertyValueHistoryEntry]))))

newBatchGetAssetPropertyValueHistory :: BatchGetAssetPropertyValueHistory Source #

Create a value of BatchGetAssetPropertyValueHistory 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:BatchGetAssetPropertyValueHistory', batchGetAssetPropertyValueHistory_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.

BatchGetAssetPropertyValueHistory, batchGetAssetPropertyValueHistory_nextToken - The token to be used for the next set of paginated results.

$sel:entries:BatchGetAssetPropertyValueHistory', batchGetAssetPropertyValueHistory_entries - The list of asset property historical value entries for the batch get request. You can specify up to 16 entries per request.

Request Lenses

batchGetAssetPropertyValueHistory_maxResults :: Lens' BatchGetAssetPropertyValueHistory (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.

batchGetAssetPropertyValueHistory_nextToken :: Lens' BatchGetAssetPropertyValueHistory (Maybe Text) Source #

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

batchGetAssetPropertyValueHistory_entries :: Lens' BatchGetAssetPropertyValueHistory [BatchGetAssetPropertyValueHistoryEntry] Source #

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

Destructuring the Response

data BatchGetAssetPropertyValueHistoryResponse Source #

See: newBatchGetAssetPropertyValueHistoryResponse smart constructor.

Constructors

BatchGetAssetPropertyValueHistoryResponse'

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 :: [BatchGetAssetPropertyValueHistoryErrorEntry]
A list of the errors (if any) associated with the batch request. Each error entry contains the entryId of the entry that failed.
successEntries :: [BatchGetAssetPropertyValueHistorySuccessEntry]
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 :: [BatchGetAssetPropertyValueHistorySkippedEntry]
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 BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Associated Types type Rep BatchGetAssetPropertyValueHistoryResponse :: Type -> Type # Methods from :: BatchGetAssetPropertyValueHistoryResponse -> Rep BatchGetAssetPropertyValueHistoryResponse x # to :: Rep BatchGetAssetPropertyValueHistoryResponse x -> BatchGetAssetPropertyValueHistoryResponse #
Read BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods readsPrec :: Int -> ReadS BatchGetAssetPropertyValueHistoryResponse # readList :: ReadS [BatchGetAssetPropertyValueHistoryResponse] # readPrec :: ReadPrec BatchGetAssetPropertyValueHistoryResponse # readListPrec :: ReadPrec [BatchGetAssetPropertyValueHistoryResponse] #
Show BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods showsPrec :: Int -> BatchGetAssetPropertyValueHistoryResponse -> ShowS # show :: BatchGetAssetPropertyValueHistoryResponse -> String # showList :: [BatchGetAssetPropertyValueHistoryResponse] -> ShowS #
NFData BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods rnf :: BatchGetAssetPropertyValueHistoryResponse -> () #
Eq BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory Methods (==) :: BatchGetAssetPropertyValueHistoryResponse -> BatchGetAssetPropertyValueHistoryResponse -> Bool # (/=) :: BatchGetAssetPropertyValueHistoryResponse -> BatchGetAssetPropertyValueHistoryResponse -> Bool #
type Rep BatchGetAssetPropertyValueHistoryResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory type Rep BatchGetAssetPropertyValueHistoryResponse = D1 ('MetaData "BatchGetAssetPropertyValueHistoryResponse" "Amazonka.IoTSiteWise.BatchGetAssetPropertyValueHistory" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "BatchGetAssetPropertyValueHistoryResponse'" '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 [BatchGetAssetPropertyValueHistoryErrorEntry]) :: (S1 ('MetaSel ('Just "successEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetAssetPropertyValueHistorySuccessEntry]) :: S1 ('MetaSel ('Just "skippedEntries") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [BatchGetAssetPropertyValueHistorySkippedEntry])))))

newBatchGetAssetPropertyValueHistoryResponse Source #

Arguments

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

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

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

$sel:httpStatus:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_httpStatus - The response's http status code.

$sel:errorEntries:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_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:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_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:BatchGetAssetPropertyValueHistoryResponse', batchGetAssetPropertyValueHistoryResponse_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

batchGetAssetPropertyValueHistoryResponse_nextToken :: Lens' BatchGetAssetPropertyValueHistoryResponse (Maybe Text) Source #

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

batchGetAssetPropertyValueHistoryResponse_httpStatus :: Lens' BatchGetAssetPropertyValueHistoryResponse Int Source #

The response's http status code.

batchGetAssetPropertyValueHistoryResponse_errorEntries :: Lens' BatchGetAssetPropertyValueHistoryResponse [BatchGetAssetPropertyValueHistoryErrorEntry] Source #

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

batchGetAssetPropertyValueHistoryResponse_successEntries :: Lens' BatchGetAssetPropertyValueHistoryResponse [BatchGetAssetPropertyValueHistorySuccessEntry] 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.

batchGetAssetPropertyValueHistoryResponse_skippedEntries :: Lens' BatchGetAssetPropertyValueHistoryResponse [BatchGetAssetPropertyValueHistorySkippedEntry] 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.