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 Amazon SageMaker Service CreateAlgorithm API operation.

Syntax

New-SMAlgorithm
-AlgorithmName <String>
-AlgorithmDescription <String>
-CertifyForMarketplace <Boolean>
-AdditionalS3DataSource_CompressionType <CompressionType>
-InferenceSpecification_Container <ModelPackageContainerDefinition[]>
-AdditionalS3DataSource_ETag <String>
-TrainingSpecification_MetricDefinition <MetricDefinition[]>
-AdditionalS3DataSource_S3DataType <AdditionalS3DataSourceDataType>
-AdditionalS3DataSource_S3Uri <String>
-InferenceSpecification_SupportedContentType <String[]>
-TrainingSpecification_SupportedHyperParameter <HyperParameterSpecification[]>
-InferenceSpecification_SupportedRealtimeInferenceInstanceType <String[]>
-InferenceSpecification_SupportedResponseMIMEType <String[]>
-TrainingSpecification_SupportedTrainingInstanceType <String[]>
-InferenceSpecification_SupportedTransformInstanceType <String[]>
-TrainingSpecification_SupportedTuningJobObjectiveMetric <HyperParameterTuningJobObjective[]>
-TrainingSpecification_SupportsDistributedTraining <Boolean>
-Tag <Tag[]>
-TrainingSpecification_TrainingChannel <ChannelSpecification[]>
-TrainingSpecification_TrainingImage <String>
-TrainingSpecification_TrainingImageDigest <String>
-ValidationSpecification_ValidationProfile <AlgorithmValidationProfile[]>
-ValidationSpecification_ValidationRole <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Create a machine learning algorithm that you can use in SageMaker and list in the Amazon Web Services Marketplace.

Parameters

-AdditionalS3DataSource_CompressionType <CompressionType>
The type of compression used for an additional data source used in inference or training. Specify None if your additional data source is not compressed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingSpecification_AdditionalS3DataSource_CompressionType
-AdditionalS3DataSource_ETag <String>
The ETag associated with S3 URI.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingSpecification_AdditionalS3DataSource_ETag
-AdditionalS3DataSource_S3DataType <AdditionalS3DataSourceDataType>
The data type of the additional data source that you specify for use in inference or training.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingSpecification_AdditionalS3DataSource_S3DataType
-AdditionalS3DataSource_S3Uri <String>
The uniform resource identifier (URI) used to identify an additional data source used in inference or training.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTrainingSpecification_AdditionalS3DataSource_S3Uri
-AlgorithmDescription <String>
A description of the algorithm.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AlgorithmName <String>
The name of the algorithm.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CertifyForMarketplace <Boolean>
Whether to certify the algorithm so that it can be listed in Amazon Web Services Marketplace.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
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)
-InferenceSpecification_Container <ModelPackageContainerDefinition[]>
The Amazon ECR registry path of the Docker image that contains the inference code. 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)
AliasesInferenceSpecification_Containers
-InferenceSpecification_SupportedContentType <String[]>
The supported MIME types for the input data. 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)
AliasesInferenceSpecification_SupportedContentTypes
-InferenceSpecification_SupportedRealtimeInferenceInstanceType <String[]>
A list of the instance types that are used to generate inferences in real-time.This parameter is required for unversioned models, and optional for versioned models. 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)
AliasesInferenceSpecification_SupportedRealtimeInferenceInstanceTypes
-InferenceSpecification_SupportedResponseMIMEType <String[]>
The supported MIME types for the output data. 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)
AliasesInferenceSpecification_SupportedResponseMIMETypes
-InferenceSpecification_SupportedTransformInstanceType <String[]>
A list of the instance types on which a transformation job can be run or on which an endpoint can be deployed.This parameter is required for unversioned models, and optional for versioned models. 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)
AliasesInferenceSpecification_SupportedTransformInstanceTypes
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'AlgorithmArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateAlgorithmResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateAlgorithmResponse 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)
-Tag <Tag[]>
An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources. 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
-TrainingSpecification_MetricDefinition <MetricDefinition[]>
A list of MetricDefinition objects, which are used for parsing metrics generated by the algorithm. 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)
AliasesTrainingSpecification_MetricDefinitions
-TrainingSpecification_SupportedHyperParameter <HyperParameterSpecification[]>
A list of the HyperParameterSpecification objects, that define the supported hyperparameters. This is required if the algorithm supports automatic model tuning.> 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)
AliasesTrainingSpecification_SupportedHyperParameters
-TrainingSpecification_SupportedTrainingInstanceType <String[]>
A list of the instance types that this algorithm can use for training. 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)
AliasesTrainingSpecification_SupportedTrainingInstanceTypes
-TrainingSpecification_SupportedTuningJobObjectiveMetric <HyperParameterTuningJobObjective[]>
A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job. 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)
AliasesTrainingSpecification_SupportedTuningJobObjectiveMetrics
-TrainingSpecification_SupportsDistributedTraining <Boolean>
Indicates whether the algorithm supports distributed training. If set to false, buyers can't request more than one instance during training.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrainingSpecification_TrainingChannel <ChannelSpecification[]>
A list of ChannelSpecification objects, which specify the input sources to be used by the algorithm. 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)
AliasesTrainingSpecification_TrainingChannels
-TrainingSpecification_TrainingImage <String>
The Amazon ECR registry path of the Docker image that contains the training algorithm.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TrainingSpecification_TrainingImageDigest <String>
An MD5 hash of the training algorithm that identifies the Docker image used for training.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ValidationSpecification_ValidationProfile <AlgorithmValidationProfile[]>
An array of AlgorithmValidationProfile objects, each of which specifies a training job and batch transform job that SageMaker runs to validate your algorithm. 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)
AliasesValidationSpecification_ValidationProfiles
-ValidationSpecification_ValidationRole <String>
The IAM roles that SageMaker uses to run the training jobs.
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.SageMaker.Model.CreateAlgorithmResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateAlgorithmResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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