IoTSiteWise / Paginator / ListAssetModelCompositeModels
ListAssetModelCompositeModels#
- class IoTSiteWise.Paginator.ListAssetModelCompositeModels#
paginator = client.get_paginator('list_asset_model_composite_models')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
IoTSiteWise.Client.list_asset_model_composite_models()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( assetModelId='string', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
assetModelId (string) –
[REQUIRED]
The ID of the asset model. 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.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'assetModelCompositeModelSummaries': [ { 'id': 'string', 'externalId': 'string', 'name': 'string', 'type': 'string', 'description': 'string', 'path': [ { 'id': 'string', 'name': 'string' }, ] }, ], 'NextToken': 'string' }
Response Structure
(dict) –
assetModelCompositeModelSummaries (list) –
A list that summarizes each composite model.
(dict) –
Contains a summary of the composite model.
id (string) –
The ID of the the composite model that this summary describes..
externalId (string) –
The external ID of a composite model on this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
name (string) –
The name of the 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) –
The description of the the composite model that this summary describes..
path (list) –
The path that includes all the pieces that make up the composite model.
(dict) –
Represents one level between a composite model and the root of the asset model.
id (string) –
The ID of the path segment.
name (string) –
The name of the path segment.
NextToken (string) –
A token to resume pagination.