AWS Tools for Windows PowerShell
Command 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.

Synopsis

Calls the AWS IoT SiteWise CreateAssetModelCompositeModel API operation.

Syntax

New-IOTSWAssetModelCompositeModel
-AssetModelCompositeModelDescription <String>
-AssetModelCompositeModelExternalId <String>
-AssetModelCompositeModelId <String>
-AssetModelCompositeModelName <String>
-AssetModelCompositeModelProperty <AssetModelPropertyDefinition[]>
-AssetModelCompositeModelType <String>
-AssetModelId <String>
-ComposedAssetModelId <String>
-IfMatch <String>
-IfNoneMatch <String>
-MatchForVersionType <AssetModelVersionType>
-ParentAssetModelCompositeModelId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTSiteWiseConfig>

Description

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.

Parameters

-AssetModelCompositeModelDescription <String>
A description for the composite model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetModelCompositeModelExternalId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetModelCompositeModelId <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetModelCompositeModelName <String>
A unique name for the composite model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetModelCompositeModelProperty <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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAssetModelCompositeModelProperties
-AssetModelCompositeModelType <String>
The composite model type. Valid values are AWS/ALARM, CUSTOM, or AWS/L4E_ANOMALY.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-AssetModelId <String>
The ID of the asset model this composite model is a part of.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonIoTSiteWiseConfig>
Amazon.PowerShell.Cmdlets.IOTSW.AmazonIoTSiteWiseClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ComposedAssetModelId <String>
The ID of a component model which is reused to create this composite model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IfMatch <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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IfNoneMatch <String>
Accepts * to reject the create request if an active version (specified using matchForVersionType as ACTIVE) already exists for the asset model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MatchForVersionType <AssetModelVersionType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ParentAssetModelCompositeModelId <String>
The ID of the parent composite model in this asset model relationship.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.IoTSiteWise.Model.CreateAssetModelCompositeModelResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateAssetModelCompositeModelResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.IoTSiteWise.Model.CreateAssetModelCompositeModelResponse
This cmdlet returns an Amazon.IoTSiteWise.Model.CreateAssetModelCompositeModelResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z