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 CleanRoomsML CreateTrainedModel API operation.

Syntax

New-CRMLTrainedModel
-ConfiguredModelAlgorithmAssociationArn <String>
-DataChannel <ModelTrainingDataChannel[]>
-Description <String>
-Environment <Hashtable>
-Hyperparameter <Hashtable>
-IncrementalTrainingDataChannel <IncrementalTrainingDataChannel[]>
-ResourceConfig_InstanceCount <Int32>
-ResourceConfig_InstanceType <InstanceType>
-KmsKeyArn <String>
-StoppingCondition_MaxRuntimeInSecond <Int32>
-MembershipIdentifier <String>
-Name <String>
-Tag <Hashtable>
-TrainingInputMode <TrainingInputMode>
-ResourceConfig_VolumeSizeInGB <Int32>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonCleanRoomsMLConfig>

Description

Creates a trained model from an associated configured model algorithm using data from any member of the collaboration.

Parameters

-ClientConfig <AmazonCleanRoomsMLConfig>
Amazon.PowerShell.Cmdlets.CRML.AmazonCleanRoomsMLClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfiguredModelAlgorithmAssociationArn <String>
The associated configured model algorithm used to train this model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataChannel <ModelTrainingDataChannel[]>
Defines the data channels that are used as input for the trained model request.Limit: Maximum of 20 channels total (including both dataChannels and incrementalTrainingDataChannels). 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?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataChannels
-Description <String>
The description of the trained model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Environment <Hashtable>
The environment variables to set in the Docker container. 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)
-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)
-Hyperparameter <Hashtable>
Algorithm-specific parameters that influence the quality of the model. You set hyperparameters before you start the learning process. 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)
AliasesHyperparameters
-IncrementalTrainingDataChannel <IncrementalTrainingDataChannel[]>
Specifies the incremental training data channels for the trained model. Incremental training allows you to create a new trained model with updates without retraining from scratch. You can specify up to one incremental training data channel that references a previously trained model and its version.Limit: Maximum of 20 channels total (including both incrementalTrainingDataChannels and dataChannels). 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)
AliasesIncrementalTrainingDataChannels
-KmsKeyArn <String>
The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MembershipIdentifier <String>
The membership ID of the member that is creating the trained model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Name <String>
The name of the trained model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_InstanceCount <Int32>
The number of resources that are used to train the model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_InstanceType <InstanceType>
The instance type that is used to train the model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResourceConfig_VolumeSizeInGB <Int32>
The maximum size of the instance that is used to train the model.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'TrainedModelArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CleanRoomsML.Model.CreateTrainedModelResponse). Specifying the name of a property of type Amazon.CleanRoomsML.Model.CreateTrainedModelResponse 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)
-StoppingCondition_MaxRuntimeInSecond <Int32>
The maximum amount of time, in seconds, that model training can run before it is terminated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoppingCondition_MaxRuntimeInSeconds
-Tag <Hashtable>
The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.The following basic restrictions apply to tags:
  • Maximum number of tags per resource - 50.
  • For each resource, each tag key must be unique, and each tag key can have only one value.
  • Maximum key length - 128 Unicode characters in UTF-8.
  • Maximum value length - 256 Unicode characters in UTF-8.
  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
  • Tag keys and values are case sensitive.
  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
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)
AliasesTags
-TrainingInputMode <TrainingInputMode>
The input mode for accessing the training data. This parameter determines how the training data is made available to the training algorithm. Valid values are:
  • File - The training data is downloaded to the training instance and made available as files.
  • FastFile - The training data is streamed directly from Amazon S3 to the training algorithm, providing faster access for large datasets.
  • Pipe - The training data is streamed to the training algorithm using named pipes, which can improve performance for certain algorithms.
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

System.String or Amazon.CleanRoomsML.Model.CreateTrainedModelResponse
This cmdlet returns a System.String object. The service call response (type Amazon.CleanRoomsML.Model.CreateTrainedModelResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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