Class: Aws::IoTSiteWise::Types::AssociateAssetsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Overview

Note:

When making an API call, you may pass AssociateAssetsRequest data as a hash:

{
  asset_id: "ID", # required
  hierarchy_id: "ID", # required
  child_asset_id: "ID", # required
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_idString

The ID of the parent asset.

Returns:

  • (String)


1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1041

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

#child_asset_idString

The ID of the child asset to be associated.

Returns:

  • (String)


1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1041

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

#client_tokenString

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)


1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1041

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

#hierarchy_idString

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.

Returns:

  • (String)


1041
1042
1043
1044
1045
1046
1047
1048
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 1041

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