AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates a custom composite model from specified property and hierarchy definitions. There are two types of custom composite models, inline and component-model-based.

Use component-model-based custom composite models to define standard, reusable components. A component-model-based custom composite model consists of a name, a description, and the ID of the component model it references. A component-model-based custom composite model has no properties of its own; its referenced component model provides its associated properties to any created assets. For more information, see Custom composite models (Components) in the IoT SiteWise User Guide.

Use inline custom composite models to organize the properties of an asset model. The properties of inline custom composite models are local to the asset model where they are included and can't be used to create multiple assets.

To create a component-model-based model, specify the composedAssetModelId of an existing asset model with assetModelType of COMPONENT_MODEL.

To create an inline model, specify the assetModelCompositeModelProperties and don't include an composedAssetModelId.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateAssetModelCompositeModel and EndCreateAssetModelCompositeModel.

Namespace: Amazon.IoTSiteWise
Assembly: AWSSDK.IoTSiteWise.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<CreateAssetModelCompositeModelResponse> CreateAssetModelCompositeModelAsync(
         CreateAssetModelCompositeModelRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.IoTSiteWise.Model.CreateAssetModelCompositeModelRequest

Container for the necessary parameters to execute the CreateAssetModelCompositeModel service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the CreateAssetModelCompositeModel service method, as returned by IoTSiteWise.

Exceptions

ExceptionCondition
ConflictingOperationException Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.
InternalFailureException IoT SiteWise can't process your request right now. Try again later.
InvalidRequestException The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.
LimitExceededException You've reached the quota for a resource. For example, this can occur if you're trying to associate more than the allowed number of child assets or attempting to create more than the allowed number of properties for an asset model. For more information, see Quotas in the IoT SiteWise User Guide.
PreconditionFailedException The precondition in one or more of the request-header fields evaluated to FALSE.
ResourceAlreadyExistsException The resource already exists.
ResourceNotFoundException The requested resource can't be found.
ThrottlingException Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on. For more information, see Quotas in the IoT SiteWise User Guide.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also