IoTSiteWise / Client / associate_assets

associate_assets

IoTSiteWise.Client.associate_assets(**kwargs)

Associates a child asset with the given parent asset through a hierarchy defined in the parent asset’s model. For more information, see Associating assets in the IoT SiteWise User Guide.

See also: AWS API Documentation

Request Syntax

response = client.associate_assets(
    assetId='string',
    hierarchyId='string',
    childAssetId='string',
    clientToken='string'
)

Parameters:

• assetId (string) –

  [REQUIRED]

  The ID of the parent asset.

• hierarchyId (string) –

  [REQUIRED]

  The ID of a hierarchy in the parent asset’s model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

• childAssetId (string) –

  [REQUIRED]

  The ID of the child asset to be associated.

• clientToken (string) –

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don’t reuse this client token if a new idempotent request is required.

  This field is autopopulated if not provided.

Returns:

None

Exceptions

• IoTSiteWise.Client.exceptions.InvalidRequestException

• IoTSiteWise.Client.exceptions.ResourceAlreadyExistsException

• IoTSiteWise.Client.exceptions.ResourceNotFoundException

• IoTSiteWise.Client.exceptions.InternalFailureException

• IoTSiteWise.Client.exceptions.LimitExceededException

• IoTSiteWise.Client.exceptions.ThrottlingException

• IoTSiteWise.Client.exceptions.ConflictingOperationException