IoTSiteWise / Client / list_composition_relationships

list_composition_relationships#

IoTSiteWise.Client.list_composition_relationships(**kwargs)#

Retrieves a paginated list of composition relationships for an asset model of type COMPONENT_MODEL.

See also: AWS API Documentation

Request Syntax

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

Return type:

dict

Returns:

Response Syntax

{
    'compositionRelationshipSummaries': [
        {
            'assetModelId': 'string',
            'assetModelCompositeModelId': 'string',
            'assetModelCompositeModelType': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • compositionRelationshipSummaries (list) –

      A list that summarizes each composition relationship.

      • (dict) –

        Contains a summary of the components of the composite model.

        • assetModelId (string) –

          The ID of the asset model, in UUID format.

        • assetModelCompositeModelId (string) –

          The ID of a composite model on this asset model.

        • assetModelCompositeModelType (string) –

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

    • nextToken (string) –

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

Exceptions