IoTSiteWise / Client / list_asset_properties

list_asset_properties#

IoTSiteWise.Client.list_asset_properties(**kwargs)#

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

See also: AWS API Documentation

Request Syntax

response = client.list_asset_properties(
    assetId='string',
    nextToken='string',
    maxResults=123,
    filter='ALL'|'BASE'
)
Parameters:

  • assetId (string) –

    [REQUIRED]

    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 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. If not specified, the default value is 50.

  • filter (string) –

    Filters the requested list of asset properties. You can choose one of the following options:

    • ALL – The list includes all asset properties for a given asset model ID.

    • BASE – The list includes only base asset properties for a given asset model ID.

    Default: BASE

Return type:

dict

Returns:

Response Syntax

{
    'assetPropertySummaries': [
        {
            'id': 'string',
            'alias': 'string',
            'unit': 'string',
            'notification': {
                'topic': 'string',
                'state': 'ENABLED'|'DISABLED'
            },
            'assetCompositeModelId': 'string',
            'path': [
                {
                    'id': 'string',
                    'name': 'string'
                },
            ],
            'externalId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • assetPropertySummaries (list) –

      A list that summarizes the properties associated with the specified asset.

      • (dict) –

        Contains a summary of a property associated with an asset.

        • id (string) –

          The ID of the property.

        • alias (string) –

          The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide.

        • unit (string) –

          The unit of measure (such as Newtons or RPM) of the asset property.

        • notification (dict) –

          Contains asset property value notification information. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide.

          • topic (string) –

            The MQTT topic to which IoT SiteWise publishes property value update notifications.

          • state (string) –

            The current notification state.

        • assetCompositeModelId (string) –

          The ID of the composite model that contains the asset property.

        • path (list) –

          The structured path to the property from the root of the asset.

          • (dict) –

            Represents one level between a property and the root of the asset.

            • id (string) –

              The ID of the path segment.

            • name (string) –

              The name of the path segment.

        • externalId (string) –

          The external ID of the property. For more information, see Using external IDs in the IoT SiteWise User Guide.

    • nextToken (string) –

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

Exceptions