Class: Aws::IoTSiteWise::Types::UpdateAssetModelRequest

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

{
  asset_model_id: "ID", # required
  asset_model_name: "Name", # required
  asset_model_description: "Description",
  asset_model_properties: [
    {
      id: "ID",
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
        },
        metric: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
            },
          },
        },
      },
    },
  ],
  asset_model_hierarchies: [
    {
      id: "ID",
      name: "Name", # required
      child_asset_model_id: "ID", # required
    },
  ],
  client_token: "ClientToken",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_descriptionString

A description for the asset model.

Returns:

  • (String)


4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

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

#asset_model_hierarchiesArray<Types::AssetModelHierarchy>

The updated 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 AWS IoT SiteWise User Guide.

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

Returns:



4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

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

#asset_model_idString

The ID of the asset model to update.

Returns:

  • (String)


4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

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

#asset_model_nameString

A unique, friendly name for the asset model.

Returns:

  • (String)


4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

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

#asset_model_propertiesArray<Types::AssetModelProperty>

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

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

Returns:



4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

class UpdateAssetModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :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)


4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 4866

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