Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide.
To identify an asset property, you must specify one of the following:
- The
assetId
andpropertyId
of an asset property. - A
propertyAlias
, which is a data stream alias (for example,/company/windfarm/3/turbine/7/temperature
). To define an asset property's alias, see UpdateAssetProperty.
Synopsis
- data GetAssetPropertyValue = GetAssetPropertyValue' {
- propertyAlias :: Maybe Text
- propertyId :: Maybe Text
- assetId :: Maybe Text
- newGetAssetPropertyValue :: GetAssetPropertyValue
- getAssetPropertyValue_propertyAlias :: Lens' GetAssetPropertyValue (Maybe Text)
- getAssetPropertyValue_propertyId :: Lens' GetAssetPropertyValue (Maybe Text)
- getAssetPropertyValue_assetId :: Lens' GetAssetPropertyValue (Maybe Text)
- data GetAssetPropertyValueResponse = GetAssetPropertyValueResponse' {}
- newGetAssetPropertyValueResponse :: Int -> GetAssetPropertyValueResponse
- getAssetPropertyValueResponse_propertyValue :: Lens' GetAssetPropertyValueResponse (Maybe AssetPropertyValue)
- getAssetPropertyValueResponse_httpStatus :: Lens' GetAssetPropertyValueResponse Int
Creating a Request
data GetAssetPropertyValue Source #
See: newGetAssetPropertyValue
smart constructor.
GetAssetPropertyValue' | |
|
Instances
newGetAssetPropertyValue :: GetAssetPropertyValue Source #
Create a value of GetAssetPropertyValue
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:propertyAlias:GetAssetPropertyValue'
, getAssetPropertyValue_propertyAlias
- The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
$sel:propertyId:GetAssetPropertyValue'
, getAssetPropertyValue_propertyId
- The ID of the asset property.
$sel:assetId:GetAssetPropertyValue'
, getAssetPropertyValue_assetId
- The ID of the asset.
Request Lenses
getAssetPropertyValue_propertyAlias :: Lens' GetAssetPropertyValue (Maybe Text) Source #
The alias that identifies the property, such as an OPC-UA server data
stream path (for example,
/company/windfarm/3/turbine/7/temperature
). For more
information, see
Mapping industrial data streams to asset properties
in the IoT SiteWise User Guide.
getAssetPropertyValue_propertyId :: Lens' GetAssetPropertyValue (Maybe Text) Source #
The ID of the asset property.
getAssetPropertyValue_assetId :: Lens' GetAssetPropertyValue (Maybe Text) Source #
The ID of the asset.
Destructuring the Response
data GetAssetPropertyValueResponse Source #
See: newGetAssetPropertyValueResponse
smart constructor.
GetAssetPropertyValueResponse' | |
|
Instances
newGetAssetPropertyValueResponse Source #
Create a value of GetAssetPropertyValueResponse
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:propertyValue:GetAssetPropertyValueResponse'
, getAssetPropertyValueResponse_propertyValue
- The current asset property value.
$sel:httpStatus:GetAssetPropertyValueResponse'
, getAssetPropertyValueResponse_httpStatus
- The response's http status code.
Response Lenses
getAssetPropertyValueResponse_propertyValue :: Lens' GetAssetPropertyValueResponse (Maybe AssetPropertyValue) Source #
The current asset property value.
getAssetPropertyValueResponse_httpStatus :: Lens' GetAssetPropertyValueResponse Int Source #
The response's http status code.