AWS CLI Command Reference

[ aws . iotsitewise ]

describe-asset

Description

Retrieves information about an asset.

See also: AWS API Documentation

Synopsis

  describe-asset
--asset-id <value>
[--exclude-properties | --no-exclude-properties]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--asset-id (string)

The ID of the asset. This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the IoT SiteWise User Guide .

--exclude-properties | --no-exclude-properties (boolean)

Whether or not to exclude asset properties from the response.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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, in UUID format.

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

notification -> (structure)

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

topic -> (string)

The MQTT topic to which 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.

path -> (list)

The structured path to the property from the root of the asset.

(structure)

Represents one level between a property and the root of the asset.

id -> (string)

The ID of the path segment.

name -> (string)

The name of the path segment.

externalId -> (string)

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide .

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.

externalId -> (string)

The external ID of the hierarchy, if it has one. When you update an asset hierarchy, you may assign an external ID if it doesn’t already have one. You can’t change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the IoT SiteWise User Guide .

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

notification -> (structure)

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

topic -> (string)

The MQTT topic to which 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.

path -> (list)

The structured path to the property from the root of the asset.

(structure)

Represents one level between a property and the root of the asset.

id -> (string)

The ID of the path segment.

name -> (string)

The name of the path segment.

externalId -> (string)

The external ID of the asset property. For more information, see Using external IDs in the IoT SiteWise User Guide .

id -> (string)

The ID of the asset composite model.

externalId -> (string)

The external ID of the asset composite model. For more information, see Using external IDs in the IoT SiteWise User Guide .

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.

details -> (list)

A list of detailed errors.

(structure)

Contains detailed error information.

code -> (string)

The error code.

message -> (string)

The error message.

assetDescription -> (string)

A description for the asset.

assetCompositeModelSummaries -> (list)

The list of the immediate child custom composite model summaries for the asset.

(structure)

Contains a summary of the composite model for a specific asset.

id -> (string)

The ID of the composite model that this summary describes.

externalId -> (string)

An external ID to assign to the asset model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using UpdateAssetModelCompositeModel and specifying the derived ID of the model or property from the created model it’s a part of.

name -> (string)

The name of the composite model that this summary describes.

type -> (string)

The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.
  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.

description -> (string)

A description of the composite model that this summary describes.

path -> (list)

The path that includes all the components of the asset model for the asset.

(structure)

Represents one level between a composite model and the root of the asset.

id -> (string)

The ID of the path segment.

name -> (string)

The name of the path segment.

assetExternalId -> (string)

The external ID of the asset, if any.
© Copyright 2018, Amazon Web Services. Created using Sphinx.