Class: Aws::IoTSiteWise::Types::CreateAssetRequest

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_descriptionString

A description for the asset.

Returns:

  • (String)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_external_idString

An external ID to assign to the asset. The external ID must be unique within your Amazon Web Services account. For more information, see Using external IDs in the IoT SiteWise User Guide.

Returns:

  • (String)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_idString

The ID to assign to the asset, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.

Returns:

  • (String)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_idString

The ID of the asset model from which to create the 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.

Returns:

  • (String)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#asset_nameString

A friendly name for the asset.

Returns:

  • (String)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  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)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.

Returns:

  • (Hash<String,String>)


2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2898

class CreateAssetRequest < Struct.new(
  :asset_name,
  :asset_model_id,
  :client_token,
  :tags,
  :asset_description,
  :asset_id,
  :asset_external_id)
  SENSITIVE = []
  include Aws::Structure
end