Class: Aws::IoTSiteWise::Types::DisassociateAssetsRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DisassociateAssetsRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_id ⇒ String

  The ID of the parent asset from which to disassociate the child asset.

• #child_asset_id ⇒ String

  The ID of the child asset to disassociate.

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

• #hierarchy_id ⇒ String

  The ID of a hierarchy in the parent asset’s model.

Instance Attribute Details

#asset_id ⇒ String

The ID of the parent asset from which to disassociate the child 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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5530

class DisassociateAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :child_asset_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#child_asset_id ⇒ String

The ID of the child asset to disassociate. 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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5530

class DisassociateAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :child_asset_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_token ⇒ 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.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5530

class DisassociateAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :child_asset_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#hierarchy_id ⇒ String

The ID of a hierarchy in the parent asset’s 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][1

in the *IoT SiteWise User

Guide*.) Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see [Asset hierarchies] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 5530

class DisassociateAssetsRequest < Struct.new(
  :asset_id,
  :hierarchy_id,
  :child_asset_id,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end