Class: Aws::IoTSiteWise::Types::UpdateAssetModelCompositeModelRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#asset_model_composite_model_descriptionString

A description for the composite model.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#asset_model_composite_model_external_idString

An external ID to assign to the asset model. You can only set the external ID of the asset model if it wasn't set when it was created, or you're setting it to the exact same thing as when it was created.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#asset_model_composite_model_idString

The ID of a composite model on this asset model.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#asset_model_composite_model_nameString

A unique name for the composite model.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#asset_model_composite_model_propertiesArray<Types::AssetModelProperty>

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.

Returns:



10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#asset_model_idString

The ID of the asset model, in UUID format.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

class UpdateAssetModelCompositeModelRequest < Struct.new(
  :asset_model_id,
  :asset_model_composite_model_id,
  :asset_model_composite_model_external_id,
  :asset_model_composite_model_description,
  :asset_model_composite_model_name,
  :client_token,
  :asset_model_composite_model_properties,
  :if_match,
  :if_none_match,
  :match_for_version_type)
  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)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#if_matchString

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.

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#if_none_matchString

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

Returns:

  • (String)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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

#match_for_version_typeString

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)


10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 10386

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