IoTSiteWise / Client / list_asset_model_composite_models

list_asset_model_composite_models#

IoTSiteWise.Client.list_asset_model_composite_models(**kwargs)#

Retrieves a paginated list of composite models associated with the asset model

See also: AWS API Documentation

Request Syntax

response = client.list_asset_model_composite_models(
    assetModelId='string',
    nextToken='string',
    maxResults=123,
    assetModelVersion='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.

  • nextToken (string) – The token to be used for the next set of paginated results.

  • maxResults (integer) –

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

    Default: 50

  • assetModelVersion (string) – 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 IoT SiteWise User Guide.

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 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 composite model that this summary describes..

        • type (string) –

          The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.

        • description (string) –

          The description of 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) –

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

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException

  • IoTSiteWise.Client.exceptions.InternalFailureException

  • IoTSiteWise.Client.exceptions.ThrottlingException

  • IoTSiteWise.Client.exceptions.ResourceNotFoundException