aws iotsitewise list-assets

Retrieves a paginated list of asset summaries. AWS CLI reference

2 examples 4 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

Example 1: To list all top-level assets

The following list-assets example lists all assets that are top-level in the asset hierarchy tree and defined in your AWS account in the current Region.

aws iotsitewise list-assets --filter TOP_LEVELIdentify

--filterThe filter for the requested list of assets.

Its output

{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-EXAMPLE44444",
            "name": "Wind Farm 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222",
            "creationDate": 1575672453.0,
            "lastUpdateDate": 1575672453.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": [
                {
                    "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE77777",
                    "name": "Wind Turbines"
                }
            ]
        }
    ]
}

For more information, see Model industrial assets in the AWS IoT SiteWise User Guide.

Example 2: To list all assets based on an asset model

The following list-assets example lists all assets based on an asset model and defined in your AWS account in the current Region.

aws iotsitewise list-assets --asset-model-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Identify

--asset-model-idThe ID of the asset model by which to filter the list of assets.

Its output

{
    "assetSummaries": [
        {
            "id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "arn": "arn:aws:iotsitewise:us-west-2:123456789012:asset/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333",
            "name": "Wind Turbine 1",
            "assetModelId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "creationDate": 1575671550.0,
            "lastUpdateDate": 1575686308.0,
            "status": {
                "state": "ACTIVE"
            },
            "hierarchies": []
        }
    ]
}

For more information, see Model industrial assets in the AWS IoT SiteWise User Guide.

Options

4 in the AWS CLI reference

--asset-model-idThe ID of the asset model by which to filter the list of assets.

--filterThe filter for the requested list of assets.

--max-resultsThe maximum number of results to return for each paginated request.

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