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

ListAssetModels

Retrieves a paginated list of summaries of all asset models.

Request Syntax


GET /asset-models?assetModelTypes=assetModelTypes&assetModelVersion=assetModelVersion&maxResults=maxResults&nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assetModelTypes

The type of asset model. If you don't provide an assetModelTypes, all types of asset models are returned.

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

Valid Values: ASSET_MODEL | COMPONENT_MODEL

assetModelVersion

The version alias that specifies the latest or active version of the asset model. The details are returned in the response. The default value is LATEST. See Asset model versions in the AWS IoT SiteWise User Guide.

Pattern: ^(LATEST|ACTIVE)$

maxResults

The maximum number of results to return for each paginated request.

Default: 50

Valid Range: Minimum value of 1. Maximum value of 250.

nextToken

The token to be used for the next set of paginated results.

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

Pattern: [A-Za-z0-9+/=]+

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "assetModelSummaries": [ 
      { 
         "arn": "string",
         "assetModelType": "string",
         "creationDate": number,
         "description": "string",
         "externalId": "string",
         "id": "string",
         "lastUpdateDate": number,
         "name": "string",
         "status": { 
            "error": { 
               "code": "string",
               "details": [ 
                  { 
                     "code": "string",
                     "message": "string"
                  }
               ],
               "message": "string"
            },
            "state": "string"
         },
         "version": "string"
      }
   ],
   "nextToken": "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.

assetModelSummaries

A list that summarizes each asset model.

Type: Array of AssetModelSummary objects

nextToken

The token for the next set of results, or null if there are no additional results.

Type: String

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

Pattern: [A-Za-z0-9+/=]+

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

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