Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeAsset

Retrieves information about an asset.

Request Syntax


GET /assets/assetId?excludeProperties=excludeProperties HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assetId

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

Length Constraints: Minimum length of 13. Maximum length of 139.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$|^externalId:[a-zA-Z0-9][a-zA-Z_\-0-9.:]*[a-zA-Z0-9]+

Required: Yes

excludeProperties

Whether or not to exclude asset properties from the response.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assetArn": "string",
   "assetCompositeModels": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "properties": [ 
            { 
               "alias": "string",
               "dataType": "string",
               "dataTypeSpec": "string",
               "externalId": "string",
               "id": "string",
               "name": "string",
               "notification": { 
                  "state": "string",
                  "topic": "string"
               },
               "path": [ 
                  { 
                     "id": "string",
                     "name": "string"
                  }
               ],
               "unit": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetCompositeModelSummaries": [ 
      { 
         "description": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "type": "string"
      }
   ],
   "assetCreationDate": number,
   "assetDescription": "string",
   "assetExternalId": "string",
   "assetHierarchies": [ 
      { 
         "externalId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "assetId": "string",
   "assetLastUpdateDate": number,
   "assetModelId": "string",
   "assetName": "string",
   "assetProperties": [ 
      { 
         "alias": "string",
         "dataType": "string",
         "dataTypeSpec": "string",
         "externalId": "string",
         "id": "string",
         "name": "string",
         "notification": { 
            "state": "string",
            "topic": "string"
         },
         "path": [ 
            { 
               "id": "string",
               "name": "string"
            }
         ],
         "unit": "string"
      }
   ],
   "assetStatus": { 
      "error": { 
         "code": "string",
         "details": [ 
            { 
               "code": "string",
               "message": "string"
            }
         ],
         "message": "string"
      },
      "state": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

assetArn

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

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-cn|-us-gov)?:[a-zA-Z0-9-:\/_\.]+$

assetCompositeModels

The composite models for the asset.

Type: Array of AssetCompositeModel objects

assetCompositeModelSummaries

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

Type: Array of AssetCompositeModelSummary objects

assetCreationDate

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

Type: Timestamp

assetDescription

A description for the asset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: [^\u0000-\u001F\u007F]+

assetExternalId

The external ID of the asset, if any.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 128.

Pattern: [a-zA-Z0-9_][a-zA-Z_\-0-9.:]*[a-zA-Z0-9_]+

assetHierarchies

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

Type: Array of AssetHierarchy objects

assetId

The ID of the asset, in UUID format.

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

assetLastUpdateDate

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

Type: Timestamp

assetModelId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

assetName

The name of the asset.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [^\u0000-\u001F\u007F]+

assetProperties

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.

Type: Array of AssetProperty objects

assetStatus

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

Type: AssetStatus object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalFailureException

AWS IoT SiteWise can't process your request right now. Try again later.

HTTP Status Code: 500

InvalidRequestException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.

HTTP Status Code: 400

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a rate limit. For example, you might have exceeded the number of AWS IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.

For more information, see Quotas in the AWS IoT SiteWise User Guide.

HTTP Status Code: 429