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

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 CreateAssetModelRequest data as a hash:

{
  asset_model_name: "Name", # required
  asset_model_description: "Description",
  asset_model_properties: [
    {
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
    },
  ],
  asset_model_hierarchies: [
    {
      name: "Name", # required
      child_asset_model_id: "ID", # required
    },
  ],
  asset_model_composite_models: [
    {
      name: "Name", # required
      description: "Description",
      type: "Name", # required
      properties: [
        {
          name: "Name", # required
          data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
          data_type_spec: "Name",
          unit: "PropertyUnit",
          type: { # required
            attribute: {
              default_value: "DefaultValue",
            },
            measurement: {
              processing_config: {
                forwarding_config: { # required
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            transform: {
              expression: "Expression", # required
              variables: [ # required
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro", # required
                    hierarchy_id: "Macro",
                  },
                },
              ],
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
                forwarding_config: {
                  state: "DISABLED", # required, accepts DISABLED, ENABLED
                },
              },
            },
            metric: {
              expression: "Expression", # required
              variables: [ # required
                {
                  name: "VariableName", # required
                  value: { # required
                    property_id: "Macro", # required
                    hierarchy_id: "Macro",
                  },
                },
              ],
              window: { # required
                tumbling: {
                  interval: "Interval", # required
                  offset: "Offset",
                },
              },
              processing_config: {
                compute_location: "EDGE", # required, accepts EDGE, CLOUD
              },
            },
          },
        },
      ],
    },
  ],
  client_token: "ClientToken",
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_composite_models ⇒ Array<Types::AssetModelCompositeModelDefinition>

The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model.

Returns:



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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

#asset_model_description ⇒ String

A description for the asset model.

Returns:

  • (String) 


2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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

#asset_model_name ⇒ String

A unique, friendly name for the asset model.

Returns:

  • (String) 


2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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



2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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


2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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


2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
 
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 2513

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