Class: Aws::IoTSiteWise::Types::DeleteAssetModelRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTSiteWise::Types::DeleteAssetModelRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iotsitewise/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #asset_model_id ⇒ String

  The ID of the asset model to delete.

• #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 delete 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 delete operation.

Instance Attribute Details

#asset_model_id ⇒ String

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

class DeleteAssetModelRequest < Struct.new(
  :asset_model_id,
  :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 3841

class DeleteAssetModelRequest < Struct.new(
  :asset_model_id,
  :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 delete 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 3841

class DeleteAssetModelRequest < Struct.new(
  :asset_model_id,
  :client_token,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#if_none_match ⇒ String

Accepts ***** to reject the delete 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 3841

class DeleteAssetModelRequest < Struct.new(
  :asset_model_id,
  :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 delete operation.

Returns:

• (String)

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

class DeleteAssetModelRequest < Struct.new(
  :asset_model_id,
  :client_token,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end