Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotsitewise ]

update-asset-property

Description

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

See 'aws help' for descriptions of global parameters.

Synopsis

  update-asset-property
--asset-id <value>
--property-id <value>
[--property-alias <value>]
[--property-notification-state <value>]
[--client-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--asset-id (string)

The ID of the asset to be updated.

--property-id (string)

The ID of the asset property to be updated.

--property-alias (string)

The property 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 AWS IoT SiteWise User Guide .

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

--property-notification-state (string)

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

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

Possible values:

  • ENABLED
  • DISABLED

--client-token (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Example 1: To update an asset property's alias

The following update-asset-property example updates a wind turbine asset's power property alias.

aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-55555EXAMPLE \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power" \
    --property-notification-state DISABLED

This command produces no output.

For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide.

Example 2: To enable asset property notifications

The following update-asset-property example enables asset property update notifications for a wind turbine asset's power property. Property value updates are published to the MQTT topic $aws/sitewise/asset-models/<assetModelId>/assets/<assetId>/properties/<propertyId>, where each ID is replaced by the property, asset, and model ID of the asset property.

aws iotsitewise update-asset-property \
    --asset-id a1b2c3d4-5678-90ab-cdef-33333EXAMPLE \
    --property-id a1b2c3d4-5678-90ab-cdef-66666EXAMPLE \
    --property-notification-state ENABLED \
    --property-alias "/examplecorp/windfarm/1/turbine/1/power"

This command produces no output.

For more information, see Interacting with other services in the AWS IoT SiteWise User Guide.

Output

None