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 |
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' {}
- 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.
GetPropertyValueHistory' | |
|
Instances
newGetPropertyValueHistory Source #
:: Text | |
-> NonEmpty Text | |
-> 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.
GetPropertyValueHistoryResponse' | |
|
Instances
newGetPropertyValueHistoryResponse Source #
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.