Class: Aws::IoTSiteWise::Types::CreateAssetModelCompositeModelRequest

Inherits:

Struct

Object
Struct
Aws::IoTSiteWise::Types::CreateAssetModelCompositeModelRequest

show all

Includes:: Structure

Defined in:: lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#asset_model_composite_model_description ⇒ String

A description for the composite model.
#asset_model_composite_model_external_id ⇒ String

An external ID to assign to the composite model.
#asset_model_composite_model_id ⇒ String

The ID of the composite model.
#asset_model_composite_model_name ⇒ String

A unique name for the composite model.
#asset_model_composite_model_properties ⇒ Array<Types::AssetModelPropertyDefinition>

The property definitions of the composite model.
#asset_model_composite_model_type ⇒ String

The composite model type.
#asset_model_id ⇒ String

The ID of the asset model this composite model is a part of.
#client_token ⇒ String

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

The ID of a component model which is reused to create this composite model.
#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 create 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 create operation.
#parent_asset_model_composite_model_id ⇒ String

The ID of the parent composite model in this asset model relationship.

Instance Attribute Details

#asset_model_composite_model_description ⇒ `String`

A description for the composite model.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_external_id ⇒ `String`

An external ID to assign to the composite model.

If the composite model is a derived composite model, or one nested inside a component model, you can only set the external ID using ‘UpdateAssetModelCompositeModel` and specifying the derived ID of the model or property from the created model it’s a part of.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_id ⇒ `String`

The ID of the composite model. 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)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_name ⇒ `String`

A unique name for the composite model.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_properties ⇒ `Array<Types::AssetModelPropertyDefinition>`

The property definitions of the composite model. For more information, see [ Inline custom composite models] in the *IoT SiteWise User Guide*.

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

[1]: docs.aws.amazon.com/iot-sitewise/latest/userguide/custom-composite-models.html#inline-composite-models [2]: docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html

Returns:

(Array<Types::AssetModelPropertyDefinition>)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_composite_model_type ⇒ `String`

The composite model type. Valid values are ‘AWS/ALARM`, `CUSTOM`, or ` AWS/L4E_ANOMALY`.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#asset_model_id ⇒ `String`

The ID of the asset model this composite model is a part of.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :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 2681

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#composed_asset_model_id ⇒ `String`

The ID of a component model which is reused to create this composite model.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :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 create 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 2681

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#if_none_match ⇒ `String`

Accepts ***** to reject the create 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 2681

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :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 create operation.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

#parent_asset_model_composite_model_id ⇒ `String`

The ID of the parent composite model in this asset model relationship.

Returns:

(String)

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

class CreateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_external_id,
  :parent_asset_model_composite_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :asset_model_composite_model_type,
  :client_token,
  :composed_asset_model_id,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::IoTSiteWise::Types::CreateAssetModelCompositeModelRequest

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_composite_model_description ⇒ String

#asset_model_composite_model_external_id ⇒ String

#asset_model_composite_model_id ⇒ String

#asset_model_composite_model_name ⇒ String

#asset_model_composite_model_properties ⇒ Array<Types::AssetModelPropertyDefinition>

#asset_model_composite_model_type ⇒ String

#asset_model_id ⇒ String

#client_token ⇒ String

#composed_asset_model_id ⇒ String

#if_match ⇒ String

#if_none_match ⇒ String

#match_for_version_type ⇒ String

#parent_asset_model_composite_model_id ⇒ String

#asset_model_composite_model_description ⇒ `String`

#asset_model_composite_model_external_id ⇒ `String`

#asset_model_composite_model_id ⇒ `String`

#asset_model_composite_model_name ⇒ `String`

#asset_model_composite_model_properties ⇒ `Array<Types::AssetModelPropertyDefinition>`

#asset_model_composite_model_type ⇒ `String`

#asset_model_id ⇒ `String`

#client_token ⇒ `String`

#composed_asset_model_id ⇒ `String`

#if_match ⇒ `String`

#if_none_match ⇒ `String`

#match_for_version_type ⇒ `String`

#parent_asset_model_composite_model_id ⇒ `String`