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

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::UpdateAssetModelRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_model_composite_models ⇒ Array<Types::AssetModelCompositeModel>

  The composite models that are part of this asset model.

• #asset_model_description ⇒ String

  A description for the asset model.

• #asset_model_external_id ⇒ String

  An external ID to assign to the asset model.

• #asset_model_hierarchies ⇒ Array<Types::AssetModelHierarchy>

  The updated hierarchy definitions of the asset model.

• #asset_model_id ⇒ String

  The ID of the asset model to update.

• #asset_model_name ⇒ String

  A unique name for the asset model.

• #asset_model_properties ⇒ Array<Types::AssetModelProperty>

  The updated property definitions of the asset model.

• #client_token ⇒ String

  A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.

• #if_match ⇒ String

  The expected current entity tag (ETag) for the asset model’s latest or active version (specified using ‘matchForVersionType`).

• #if_none_match ⇒ String

  Accepts ***** to reject the update request if an active version (specified using ‘matchForVersionType` as `ACTIVE`) already exists for the asset model.

• #match_for_version_type ⇒ String

  Specifies the asset model version type (‘LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the update operation.

Instance Attribute Details

#asset_model_composite_models ⇒ Array<Types::AssetModelCompositeModel>

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.

<note markdown=“1”> When creating custom composite models, you need to use [CreateAssetModelCompositeModel]. For more information, see

Creating custom composite models (Components)][2

in the *IoT

SiteWise User Guide*.

</note>

[1]: docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html

Returns:

• (Array<Types::AssetModelCompositeModel>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_description ⇒ String

A description for the asset model.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_external_id ⇒ String

An external ID to assign to the asset model. The asset model must not already have an external ID. The external ID must be unique within your Amazon Web Services account. For more information, see

Using external IDs][1

in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-ids

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_hierarchies ⇒ Array<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][1

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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-hierarchies.html [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html

Returns:

• (Array<Types::AssetModelHierarchy>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_id ⇒ String

The ID of the asset model to update. 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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/object-ids.html#external-id-references

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_name ⇒ String

A unique name for the asset model.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#asset_model_properties ⇒ Array<Types::AssetModelProperty>

The updated 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*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html

Returns:

• (Array<Types::AssetModelProperty>)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

class UpdateAssetModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_external_id,
  :asset_model_name,
  :asset_model_description,
  :asset_model_properties,
  :asset_model_hierarchies,
  :asset_model_composite_models,
  :client_token,
  :if_match,
  :if_none_match,
  :match_for_version_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)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#if_match ⇒ String

The expected current entity tag (ETag) for the asset model’s latest or active version (specified using ‘matchForVersionType`). The update request is rejected if the tag does not match the latest or active version’s current entity tag. See [Optimistic locking for asset model writes] in the *IoT SiteWise User Guide*.

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/opt-locking-for-model.html

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#if_none_match ⇒ String

Accepts ***** to reject the update request if an active version (specified using ‘matchForVersionType` as `ACTIVE`) already exists for the asset model.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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

#match_for_version_type ⇒ String

Specifies the asset model version type (‘LATEST` or `ACTIVE`) used in conjunction with `If-Match` or `If-None-Match` headers to determine the target ETag for the update operation.

Returns:

• (String)

# File 'lib/aws-sdk-iotsitewise/types.rb', line 8549

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