list-associated-assets¶

Description¶

Retrieves a paginated list of associated assets.

You can use this operation to do the following:

List child assets associated to a parent asset by a hierarchy that you specify.
List an asset’s parent asset.

Synopsis¶

  list-associated-assets
--asset-id <value>
[--hierarchy-id <value>]
[--traversal-direction <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options¶

--asset-id (string)

The ID of the asset to query.

--hierarchy-id (string)

The ID of the hierarchy by which child assets are associated to the asset. To find a hierarchy ID, use the DescribeAsset or DescribeAssetModel operations. This parameter is required if you choose CHILD for traversalDirection .

For more information, see Asset hierarchies in the IoT SiteWise User Guide .

--traversal-direction (string)

The direction to list associated assets. Choose one of the following options:

CHILD – The list includes all child assets associated to the asset. The hierarchyId parameter is required if you choose CHILD .

PARENT – The list includes the asset’s parent asset.

Default: CHILD

Possible values:

PARENT

CHILD

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To list all assets associated to an asset in a specific hierarchy

The following list-associated-assets example lists all wind turbine assets associated to the specified wind farm asset.

aws iotsitewise list-associated-assets \
    --asset-id a1b2c3d4-5678-90ab-cdef-44444EXAMPLE \
    --hierarchy-id a1b2c3d4-5678-90ab-cdef-77777EXAMPLE

Output:

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

For more information, see Listing assets associated to a specific asset in the AWS IoT SiteWise User Guide.

Output¶

assetSummaries -> (list)

A list that summarizes the associated assets.

(structure)

Contains a summary of an associated asset.

id -> (string)

The ID of the asset.

arn -> (string)

The ARN of the asset, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

name -> (string)

The name of the asset.

assetModelId -> (string)

The ID of the asset model used to create the asset.

creationDate -> (timestamp)

The date the asset was created, in Unix epoch time.

lastUpdateDate -> (timestamp)

The date the asset was last updated, in Unix epoch time.

status -> (structure)

The current status of the asset.

state -> (string)

The current status of the asset.

error -> (structure)

Contains associated error information, if any.

code -> (string)

The error code.

message -> (string)

The error message.

details -> (list)

A list of detailed errors.

(structure)

Contains detailed error information.

code -> (string)

The error code.

message -> (string)

The error message.

hierarchies -> (list)

A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.

(structure)

Describes an asset hierarchy that contains a hierarchy’s name and ID.

id -> (string)

The ID of the hierarchy. This ID is a hierarchyId .

name -> (string)

The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation.

description -> (string)

A description for the asset.

nextToken -> (string)

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

Table of Contents

Feedback

User Guide