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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates an asset property's alias and notification state.

This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty.

Synopsis

data UpdateAssetProperty = UpdateAssetProperty' {
- clientToken :: Maybe Text
- propertyAlias :: Maybe Text
- propertyNotificationState :: Maybe PropertyNotificationState
- propertyUnit :: Maybe Text
- assetId :: Text
- propertyId :: Text
}
newUpdateAssetProperty :: Text -> Text -> UpdateAssetProperty
updateAssetProperty_clientToken :: Lens' UpdateAssetProperty (Maybe Text)
updateAssetProperty_propertyAlias :: Lens' UpdateAssetProperty (Maybe Text)
updateAssetProperty_propertyNotificationState :: Lens' UpdateAssetProperty (Maybe PropertyNotificationState)
updateAssetProperty_propertyUnit :: Lens' UpdateAssetProperty (Maybe Text)
updateAssetProperty_assetId :: Lens' UpdateAssetProperty Text
updateAssetProperty_propertyId :: Lens' UpdateAssetProperty Text
data UpdateAssetPropertyResponse = UpdateAssetPropertyResponse' {
}
newUpdateAssetPropertyResponse :: UpdateAssetPropertyResponse

Creating a Request

data UpdateAssetProperty Source #

See: newUpdateAssetProperty smart constructor.

Constructors

UpdateAssetProperty'

Fields

clientToken :: Maybe Text
A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
propertyAlias :: Maybe Text
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.
If you omit this parameter, the alias is removed from the property.
propertyNotificationState :: Maybe PropertyNotificationState
The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.
If you omit this parameter, the notification state is set to DISABLED.
propertyUnit :: Maybe Text
The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.
assetId :: Text
The ID of the asset to be updated.
propertyId :: Text
The ID of the asset property to be updated.

Instances

Instances details

ToJSON UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods toJSON :: UpdateAssetProperty -> Value # toEncoding :: UpdateAssetProperty -> Encoding # toJSONList :: [UpdateAssetProperty] -> Value # toEncodingList :: [UpdateAssetProperty] -> Encoding #
ToHeaders UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods toHeaders :: UpdateAssetProperty -> [Header] #
ToPath UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods toPath :: UpdateAssetProperty -> ByteString #
ToQuery UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods toQuery :: UpdateAssetProperty -> QueryString #
AWSRequest UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Associated Types type AWSResponse UpdateAssetProperty # Methods request :: (Service -> Service) -> UpdateAssetProperty -> Request UpdateAssetProperty # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAssetProperty -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAssetProperty))) #
Generic UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Associated Types type Rep UpdateAssetProperty :: Type -> Type # Methods from :: UpdateAssetProperty -> Rep UpdateAssetProperty x # to :: Rep UpdateAssetProperty x -> UpdateAssetProperty #
Read UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods readsPrec :: Int -> ReadS UpdateAssetProperty # readList :: ReadS [UpdateAssetProperty] # readPrec :: ReadPrec UpdateAssetProperty # readListPrec :: ReadPrec [UpdateAssetProperty] #
Show UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods showsPrec :: Int -> UpdateAssetProperty -> ShowS # show :: UpdateAssetProperty -> String # showList :: [UpdateAssetProperty] -> ShowS #
NFData UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods rnf :: UpdateAssetProperty -> () #
Eq UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods (==) :: UpdateAssetProperty -> UpdateAssetProperty -> Bool # (/=) :: UpdateAssetProperty -> UpdateAssetProperty -> Bool #
Hashable UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods hashWithSalt :: Int -> UpdateAssetProperty -> Int # hash :: UpdateAssetProperty -> Int #
type AWSResponse UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty type AWSResponse UpdateAssetProperty = UpdateAssetPropertyResponse
type Rep UpdateAssetProperty Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty type Rep UpdateAssetProperty = D1 ('MetaData "UpdateAssetProperty" "Amazonka.IoTSiteWise.UpdateAssetProperty" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "UpdateAssetProperty'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "propertyAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "propertyNotificationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PropertyNotificationState)))) :: (S1 ('MetaSel ('Just "propertyUnit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "assetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "propertyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateAssetProperty Source #

Arguments

:: Text	`UpdateAssetProperty`
-> Text	`UpdateAssetProperty`
-> UpdateAssetProperty

Create a value of UpdateAssetProperty 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:clientToken:UpdateAssetProperty', updateAssetProperty_clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

UpdateAssetProperty, updateAssetProperty_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.

If you omit this parameter, the alias is removed from the property.

$sel:propertyNotificationState:UpdateAssetProperty', updateAssetProperty_propertyNotificationState - The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

If you omit this parameter, the notification state is set to DISABLED.

$sel:propertyUnit:UpdateAssetProperty', updateAssetProperty_propertyUnit - The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

UpdateAssetProperty, updateAssetProperty_assetId - The ID of the asset to be updated.

UpdateAssetProperty, updateAssetProperty_propertyId - The ID of the asset property to be updated.

Request Lenses

updateAssetProperty_clientToken :: Lens' UpdateAssetProperty (Maybe Text) Source #

A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

updateAssetProperty_propertyAlias :: Lens' UpdateAssetProperty (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.

If you omit this parameter, the alias is removed from the property.

updateAssetProperty_propertyNotificationState :: Lens' UpdateAssetProperty (Maybe PropertyNotificationState) Source #

The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

If you omit this parameter, the notification state is set to DISABLED.

updateAssetProperty_propertyUnit :: Lens' UpdateAssetProperty (Maybe Text) Source #

The unit of measure (such as Newtons or RPM) of the asset property. If you don't specify a value for this parameter, the service uses the value of the assetModelProperty in the asset model.

updateAssetProperty_assetId :: Lens' UpdateAssetProperty Text Source #

The ID of the asset to be updated.

updateAssetProperty_propertyId :: Lens' UpdateAssetProperty Text Source #

The ID of the asset property to be updated.

Destructuring the Response

data UpdateAssetPropertyResponse Source #

See: newUpdateAssetPropertyResponse smart constructor.

Constructors

UpdateAssetPropertyResponse'

Instances

Instances details

Generic UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Associated Types type Rep UpdateAssetPropertyResponse :: Type -> Type # Methods from :: UpdateAssetPropertyResponse -> Rep UpdateAssetPropertyResponse x # to :: Rep UpdateAssetPropertyResponse x -> UpdateAssetPropertyResponse #
Read UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods readsPrec :: Int -> ReadS UpdateAssetPropertyResponse # readList :: ReadS [UpdateAssetPropertyResponse] # readPrec :: ReadPrec UpdateAssetPropertyResponse # readListPrec :: ReadPrec [UpdateAssetPropertyResponse] #
Show UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods showsPrec :: Int -> UpdateAssetPropertyResponse -> ShowS # show :: UpdateAssetPropertyResponse -> String # showList :: [UpdateAssetPropertyResponse] -> ShowS #
NFData UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods rnf :: UpdateAssetPropertyResponse -> () #
Eq UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty Methods (==) :: UpdateAssetPropertyResponse -> UpdateAssetPropertyResponse -> Bool # (/=) :: UpdateAssetPropertyResponse -> UpdateAssetPropertyResponse -> Bool #
type Rep UpdateAssetPropertyResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.UpdateAssetProperty type Rep UpdateAssetPropertyResponse = D1 ('MetaData "UpdateAssetPropertyResponse" "Amazonka.IoTSiteWise.UpdateAssetProperty" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "UpdateAssetPropertyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateAssetPropertyResponse :: UpdateAssetPropertyResponse Source #

Create a value of UpdateAssetPropertyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.