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.IotTwinMaker.GetPropertyValueHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about the history of a time series property value for a component, component type, entity, or workspace.

You must specify a value for workspaceId. For entity-specific queries, specify values for componentName and entityId. For cross-entity quries, specify a value for componentTypeId.

Synopsis

data GetPropertyValueHistory = GetPropertyValueHistory' {
- componentName :: Maybe Text
- componentTypeId :: Maybe Text
- endDateTime :: Maybe POSIX
- endTime :: Maybe Text
- entityId :: Maybe Text
- interpolation :: Maybe InterpolationParameters
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- orderByTime :: Maybe OrderByTime
- propertyFilters :: Maybe (NonEmpty PropertyFilter)
- startDateTime :: Maybe POSIX
- startTime :: Maybe Text
- workspaceId :: Text
- selectedProperties :: NonEmpty Text
}
newGetPropertyValueHistory :: Text -> NonEmpty Text -> GetPropertyValueHistory
getPropertyValueHistory_componentName :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_componentTypeId :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_endDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime)
getPropertyValueHistory_endTime :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_entityId :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_interpolation :: Lens' GetPropertyValueHistory (Maybe InterpolationParameters)
getPropertyValueHistory_maxResults :: Lens' GetPropertyValueHistory (Maybe Natural)
getPropertyValueHistory_nextToken :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_orderByTime :: Lens' GetPropertyValueHistory (Maybe OrderByTime)
getPropertyValueHistory_propertyFilters :: Lens' GetPropertyValueHistory (Maybe (NonEmpty PropertyFilter))
getPropertyValueHistory_startDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime)
getPropertyValueHistory_startTime :: Lens' GetPropertyValueHistory (Maybe Text)
getPropertyValueHistory_workspaceId :: Lens' GetPropertyValueHistory Text
getPropertyValueHistory_selectedProperties :: Lens' GetPropertyValueHistory (NonEmpty Text)
data GetPropertyValueHistoryResponse = GetPropertyValueHistoryResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- propertyValues :: [PropertyValueHistory]
}
newGetPropertyValueHistoryResponse :: Int -> GetPropertyValueHistoryResponse
getPropertyValueHistoryResponse_nextToken :: Lens' GetPropertyValueHistoryResponse (Maybe Text)
getPropertyValueHistoryResponse_httpStatus :: Lens' GetPropertyValueHistoryResponse Int
getPropertyValueHistoryResponse_propertyValues :: Lens' GetPropertyValueHistoryResponse [PropertyValueHistory]

Creating a Request

data GetPropertyValueHistory Source #

See: newGetPropertyValueHistory smart constructor.

Constructors

GetPropertyValueHistory'

Fields

componentName :: Maybe Text
The name of the component.
componentTypeId :: Maybe Text
The ID of the component type.
endDateTime :: Maybe POSIX
The date and time of the latest property value to return.
endTime :: Maybe Text
The ISO8601 DateTime of the latest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
entityId :: Maybe Text
The ID of the entity.
interpolation :: Maybe InterpolationParameters
An object that specifies the interpolation type and the interval over which to interpolate data.
maxResults :: Maybe Natural
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
nextToken :: Maybe Text
The string that specifies the next page of results.
orderByTime :: Maybe OrderByTime
The time direction to use in the result order.
propertyFilters :: Maybe (NonEmpty PropertyFilter)
A list of objects that filter the property value history request.
startDateTime :: Maybe POSIX
The date and time of the earliest property value to return.
startTime :: Maybe Text
The ISO8601 DateTime of the earliest property value to return.
For more information about the ISO8601 DateTime format, see the data type PropertyValue.
workspaceId :: Text
The ID of the workspace.
selectedProperties :: NonEmpty Text
A list of properties whose value histories the request retrieves.

Instances

Instances details

ToJSON GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods toJSON :: GetPropertyValueHistory -> Value # toEncoding :: GetPropertyValueHistory -> Encoding # toJSONList :: [GetPropertyValueHistory] -> Value # toEncodingList :: [GetPropertyValueHistory] -> Encoding #
ToHeaders GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods toHeaders :: GetPropertyValueHistory -> [Header] #
ToPath GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods toPath :: GetPropertyValueHistory -> ByteString #
ToQuery GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods toQuery :: GetPropertyValueHistory -> QueryString #
AWSRequest GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Associated Types type AWSResponse GetPropertyValueHistory # Methods request :: (Service -> Service) -> GetPropertyValueHistory -> Request GetPropertyValueHistory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetPropertyValueHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetPropertyValueHistory))) #
Generic GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Associated Types type Rep GetPropertyValueHistory :: Type -> Type # Methods from :: GetPropertyValueHistory -> Rep GetPropertyValueHistory x # to :: Rep GetPropertyValueHistory x -> GetPropertyValueHistory #
Read GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods readsPrec :: Int -> ReadS GetPropertyValueHistory # readList :: ReadS [GetPropertyValueHistory] # readPrec :: ReadPrec GetPropertyValueHistory # readListPrec :: ReadPrec [GetPropertyValueHistory] #
Show GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods showsPrec :: Int -> GetPropertyValueHistory -> ShowS # show :: GetPropertyValueHistory -> String # showList :: [GetPropertyValueHistory] -> ShowS #
NFData GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods rnf :: GetPropertyValueHistory -> () #
Eq GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods (==) :: GetPropertyValueHistory -> GetPropertyValueHistory -> Bool # (/=) :: GetPropertyValueHistory -> GetPropertyValueHistory -> Bool #
Hashable GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory Methods hashWithSalt :: Int -> GetPropertyValueHistory -> Int # hash :: GetPropertyValueHistory -> Int #
type AWSResponse GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory type AWSResponse GetPropertyValueHistory = GetPropertyValueHistoryResponse
type Rep GetPropertyValueHistory Source #
Instance details Defined in Amazonka.IotTwinMaker.GetPropertyValueHistory type Rep GetPropertyValueHistory = D1 ('MetaData "GetPropertyValueHistory" "Amazonka.IotTwinMaker.GetPropertyValueHistory" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "GetPropertyValueHistory'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "componentName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "componentTypeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "entityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "interpolation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InterpolationParameters)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "orderByTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OrderByTime)) :: S1 ('MetaSel ('Just "propertyFilters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty PropertyFilter))))) :: ((S1 ('MetaSel ('Just "startDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "selectedProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)))))))

newGetPropertyValueHistory Source #

Arguments

:: Text	`GetPropertyValueHistory`
-> NonEmpty Text	`$sel:selectedProperties:GetPropertyValueHistory'`
-> GetPropertyValueHistory

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

GetPropertyValueHistory, getPropertyValueHistory_componentName - The name of the component.

GetPropertyValueHistory, getPropertyValueHistory_componentTypeId - The ID of the component type.

$sel:endDateTime:GetPropertyValueHistory', getPropertyValueHistory_endDateTime - The date and time of the latest property value to return.

$sel:endTime:GetPropertyValueHistory', getPropertyValueHistory_endTime - The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

GetPropertyValueHistory, getPropertyValueHistory_entityId - The ID of the entity.

$sel:interpolation:GetPropertyValueHistory', getPropertyValueHistory_interpolation - An object that specifies the interpolation type and the interval over which to interpolate data.

$sel:maxResults:GetPropertyValueHistory', getPropertyValueHistory_maxResults - The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

GetPropertyValueHistory, getPropertyValueHistory_nextToken - The string that specifies the next page of results.

$sel:orderByTime:GetPropertyValueHistory', getPropertyValueHistory_orderByTime - The time direction to use in the result order.

GetPropertyValueHistory, getPropertyValueHistory_propertyFilters - A list of objects that filter the property value history request.

$sel:startDateTime:GetPropertyValueHistory', getPropertyValueHistory_startDateTime - The date and time of the earliest property value to return.

$sel:startTime:GetPropertyValueHistory', getPropertyValueHistory_startTime - The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

GetPropertyValueHistory, getPropertyValueHistory_workspaceId - The ID of the workspace.

$sel:selectedProperties:GetPropertyValueHistory', getPropertyValueHistory_selectedProperties - A list of properties whose value histories the request retrieves.

Request Lenses

getPropertyValueHistory_componentName :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The name of the component.

getPropertyValueHistory_componentTypeId :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ID of the component type.

getPropertyValueHistory_endDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime) Source #

The date and time of the latest property value to return.

getPropertyValueHistory_endTime :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ISO8601 DateTime of the latest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

getPropertyValueHistory_entityId :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ID of the entity.

getPropertyValueHistory_interpolation :: Lens' GetPropertyValueHistory (Maybe InterpolationParameters) Source #

An object that specifies the interpolation type and the interval over which to interpolate data.

getPropertyValueHistory_maxResults :: Lens' GetPropertyValueHistory (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

Valid Range: Minimum value of 1. Maximum value of 250.

getPropertyValueHistory_nextToken :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueHistory_orderByTime :: Lens' GetPropertyValueHistory (Maybe OrderByTime) Source #

The time direction to use in the result order.

getPropertyValueHistory_propertyFilters :: Lens' GetPropertyValueHistory (Maybe (NonEmpty PropertyFilter)) Source #

A list of objects that filter the property value history request.

getPropertyValueHistory_startDateTime :: Lens' GetPropertyValueHistory (Maybe UTCTime) Source #

The date and time of the earliest property value to return.

getPropertyValueHistory_startTime :: Lens' GetPropertyValueHistory (Maybe Text) Source #

The ISO8601 DateTime of the earliest property value to return.

For more information about the ISO8601 DateTime format, see the data type PropertyValue.

getPropertyValueHistory_workspaceId :: Lens' GetPropertyValueHistory Text Source #

The ID of the workspace.

getPropertyValueHistory_selectedProperties :: Lens' GetPropertyValueHistory (NonEmpty Text) Source #

A list of properties whose value histories the request retrieves.

Destructuring the Response

data GetPropertyValueHistoryResponse Source #

See: newGetPropertyValueHistoryResponse smart constructor.

Constructors

GetPropertyValueHistoryResponse'
Fields nextToken :: Maybe Text The string that specifies the next page of results. httpStatus :: Int The response's http status code. propertyValues :: [PropertyValueHistory] An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

Instances

Instances details

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

newGetPropertyValueHistoryResponse Source #

Arguments

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

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

GetPropertyValueHistory, getPropertyValueHistoryResponse_nextToken - The string that specifies the next page of results.

$sel:httpStatus:GetPropertyValueHistoryResponse', getPropertyValueHistoryResponse_httpStatus - The response's http status code.

GetPropertyValueHistoryResponse, getPropertyValueHistoryResponse_propertyValues - An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

Response Lenses

getPropertyValueHistoryResponse_nextToken :: Lens' GetPropertyValueHistoryResponse (Maybe Text) Source #

The string that specifies the next page of results.

getPropertyValueHistoryResponse_httpStatus :: Lens' GetPropertyValueHistoryResponse Int Source #

The response's http status code.

getPropertyValueHistoryResponse_propertyValues :: Lens' GetPropertyValueHistoryResponse [PropertyValueHistory] Source #

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.