describe-asset¶

Description¶

Retrieves information about an asset.

Synopsis¶

  describe-asset
--asset-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--asset-id (string)

The ID of the asset.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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¶

To describe an asset

The following describe-asset example describes a wind farm asset.

aws iotsitewise describe-asset \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE

Output:

{
    "assetId": "a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetArn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-44444EXAMPLE",
    "assetName": "Wind Farm 1",
    "assetModelId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
    "assetProperties": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-88888EXAMPLE",
            "name": "Region",
            "dataType": "STRING"
        },
        {
            "id": "a1b2c3d4-5678-90ab-cdef-99999EXAMPLE",
            "name": "Total Generated Power",
            "dataType": "DOUBLE",
            "unit": "kW"
        }
    ],
    "assetHierarchies": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-77777EXAMPLE",
            "name": "Wind Turbines"
        }
    ],
    "assetCreationDate": 1575672453.0,
    "assetLastUpdateDate": 1575672453.0,
    "assetStatus": {
        "state": "ACTIVE"
    }
}

For more information, see Describing a specific asset in the AWS IoT SiteWise User Guide.

Output¶

assetId -> (string)

The ID of the asset.

assetArn -> (string)

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

assetName -> (string)

The name of the asset.

assetModelId -> (string)

The ID of the asset model that was used to create the asset.

assetProperties -> (list)

The list of asset properties for the asset.

This object doesn’t include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.

(structure)

Contains asset property information.

id -> (string)

The ID of the asset property.

name -> (string)

The name of the 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 .

notification -> (structure)

The asset property’s notification topic and state. For more information, see UpdateAssetProperty .

topic -> (string)

The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

state -> (string)

The current notification state.

dataType -> (string)

The data type of the asset property.

dataTypeSpec -> (string)

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

unit -> (string)

The unit (such as Newtons or RPM ) of the asset property.

assetHierarchies -> (list)

A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.

(structure)

Describes an asset hierarchy that contains a hierarchy’s name and ID.

id -> (string)

The ID of the hierarchy. This ID is a hierarchyId .

name -> (string)

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

assetCompositeModels -> (list)

The composite models for the asset.

(structure)

Contains information about a composite model in an asset. This object contains the asset’s properties that you define in the composite model.

name -> (string)

The name of the composite model.

description -> (string)

The description of the composite model.

type -> (string)

The type of the composite model. For alarm composite models, this type is AWS/ALARM .

properties -> (list)

The asset properties that this composite model defines.

(structure)

Contains asset property information.

id -> (string)

The ID of the asset property.

name -> (string)

The name of the 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 .

notification -> (structure)

The asset property’s notification topic and state. For more information, see UpdateAssetProperty .

topic -> (string)

The MQTT topic to which AWS IoT SiteWise publishes property value update notifications.

state -> (string)

The current notification state.

dataType -> (string)

The data type of the asset property.

dataTypeSpec -> (string)

The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type.

unit -> (string)

The unit (such as Newtons or RPM ) of the asset property.

assetCreationDate -> (timestamp)

The date the asset was created, in Unix epoch time.

assetLastUpdateDate -> (timestamp)

The date the asset was last updated, in Unix epoch time.

assetStatus -> (structure)

The current status of the asset, which contains a state and any error message.

state -> (string)

The current status of the asset.

error -> (structure)

Contains associated error information, if any.

code -> (string)

The error code.

message -> (string)

The error message.

Table of Contents

Feedback

User Guide