Class: Aws::IoTSiteWise::Types::CreateAssetModelRequest

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_model_composite_models ⇒ Array<Types::AssetModelCompositeModelDefinition>

The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use CreateAssetModelCompositeModel. For more information, see <LINK>.

Returns:



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_description ⇒ String

A description for the asset model.

Returns:

  • (String) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_external_id ⇒ String

An external ID to assign to the asset model. 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) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_hierarchies ⇒ Array<Types::AssetModelHierarchyDefinition>

The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide.

You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

Returns:



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_id ⇒ String

The ID to assign to the asset model, 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) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_name ⇒ String

A unique, friendly name for the asset model.

Returns:

  • (String) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_properties ⇒ Array<Types::AssetModelPropertyDefinition>

The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide.

You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide.

Returns:



2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_type ⇒ String

The type of asset model.

  • ASSET_MODEL – (default) An asset model that you can use to create assets. Can't be included as a component in another asset model.

  • COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can't create assets directly from this type of asset model.

Returns:

  • (String) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  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) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2768

class CreateAssetModelRequest < Struct.new(
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :tags,
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_type)
  SENSITIVE = []
  include Aws::Structure
end