update_asset_property

IoTSiteWise.Client.update_asset_property(**kwargs)

Updates an asset property's alias and notification state.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.update_asset_property(
    assetId='string',
    propertyId='string',
    propertyAlias='string',
    propertyNotificationState='ENABLED'|'DISABLED',
    clientToken='string',
    propertyUnit='string'
)

Parameters

• assetId (string) --

  [REQUIRED]

  The ID of the asset to be updated.

• propertyId (string) --

  [REQUIRED]

  The ID of the asset property to be updated.

• propertyAlias (string) --

  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 (string) --

  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 .

• clientToken (string) --

  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.

  This field is autopopulated if not provided.

• propertyUnit (string) -- 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.

Returns

None

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException
• IoTSiteWise.Client.exceptions.ResourceNotFoundException
• IoTSiteWise.Client.exceptions.InternalFailureException
• IoTSiteWise.Client.exceptions.ThrottlingException
• IoTSiteWise.Client.exceptions.ConflictingOperationException