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 CreateInferenceRecommendationsJob API operation.

Syntax

New-SMInferenceRecommendationsJob
-JobName <String>
-ContainerConfig_DataInputConfig <String>
-ContainerConfig_Domain <String>
-Stairs_DurationInSecond <Int32>
-InputConfig_EndpointConfiguration <EndpointInputConfiguration[]>
-InputConfig_Endpoint <EndpointInfo[]>
-StoppingConditions_FlatInvocation <FlatInvocations>
-ContainerConfig_Framework <String>
-ContainerConfig_FrameworkVersion <String>
-JobDescription <String>
-InputConfig_JobDurationInSecond <Int32>
-JobType <RecommendationJobType>
-OutputConfig_KmsKeyId <String>
-StoppingConditions_MaxInvocation <Int32>
-ResourceLimit_MaxNumberOfTest <Int32>
-ResourceLimit_MaxParallelOfTest <Int32>
-StoppingConditions_ModelLatencyThreshold <ModelLatencyThreshold[]>
-InputConfig_ModelName <String>
-InputConfig_ModelPackageVersionArn <String>
-ContainerConfig_NearestModelName <String>
-Stairs_NumberOfStep <Int32>
-TrafficPattern_Phase <Phase[]>
-RoleArn <String>
-CompiledOutputConfig_S3OutputUri <String>
-PayloadConfig_SamplePayloadUrl <String>
-VpcConfig_SecurityGroupId <String[]>
-VpcConfig_Subnet <String[]>
-PayloadConfig_SupportedContentType <String[]>
-ContainerConfig_SupportedEndpointType <RecommendationJobSupportedEndpointType>
-ContainerConfig_SupportedInstanceType <String[]>
-ContainerConfig_SupportedResponseMIMEType <String[]>
-Tag <Tag[]>
-ContainerConfig_Task <String>
-TrafficPattern_TrafficType <TrafficType>
-Stairs_UsersPerStep <Int32>
-InputConfig_VolumeKmsKeyId <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Starts a recommendation job. You can create either an instance recommendation or load test job.

Parameters

-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CompiledOutputConfig_S3OutputUri <String>
Identifies the Amazon S3 bucket where you want SageMaker to store the compiled model artifacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOutputConfig_CompiledOutputConfig_S3OutputUri
-ContainerConfig_DataInputConfig <String>
Specifies the name and shape of the expected data inputs for your trained model with a JSON dictionary form. This field is used for optimizing your model using SageMaker Neo. For more information, see DataInputConfig.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_DataInputConfig
-ContainerConfig_Domain <String>
The machine learning domain of the model and its components.Valid Values: COMPUTER_VISION | NATURAL_LANGUAGE_PROCESSING | MACHINE_LEARNING
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_Domain
-ContainerConfig_Framework <String>
The machine learning framework of the container image.Valid Values: TENSORFLOW | PYTORCH | XGBOOST | SAGEMAKER-SCIKIT-LEARN
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_Framework
-ContainerConfig_FrameworkVersion <String>
The framework version of the container image.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_FrameworkVersion
-ContainerConfig_NearestModelName <String>
The name of a pre-trained machine learning model benchmarked by Amazon SageMaker Inference Recommender that matches your model.Valid Values: efficientnetb7 | unet | xgboost | faster-rcnn-resnet101 | nasnetlarge | vgg16 | inception-v3 | mask-rcnn | sagemaker-scikit-learn | densenet201-gluon | resnet18v2-gluon | xception | densenet201 | yolov4 | resnet152 | bert-base-cased | xceptionV1-keras | resnet50 | retinanet
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_NearestModelName
-ContainerConfig_SupportedEndpointType <RecommendationJobSupportedEndpointType>
The endpoint type to receive recommendations for. By default this is null, and the results of the inference recommendation job return a combined list of both real-time and serverless benchmarks. By specifying a value for this field, you can receive a longer list of benchmarks for the desired endpoint type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_SupportedEndpointType
-ContainerConfig_SupportedInstanceType <String[]>
A list of the instance types that are used to generate inferences in real-time. 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)
AliasesInputConfig_ContainerConfig_SupportedInstanceTypes
-ContainerConfig_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)
AliasesInputConfig_ContainerConfig_SupportedResponseMIMETypes
-ContainerConfig_Task <String>
The machine learning task that the model accomplishes.Valid Values: IMAGE_CLASSIFICATION | OBJECT_DETECTION | TEXT_GENERATION | IMAGE_SEGMENTATION | FILL_MASK | CLASSIFICATION | REGRESSION | OTHER
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_Task
-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)
-InputConfig_Endpoint <EndpointInfo[]>
Existing customer endpoints on which to run an Inference Recommender 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)
AliasesInputConfig_Endpoints
-InputConfig_EndpointConfiguration <EndpointInputConfiguration[]>
Specifies the endpoint configuration to use for a 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)
AliasesInputConfig_EndpointConfigurations
-InputConfig_JobDurationInSecond <Int32>
Specifies the maximum duration of the job, in seconds. The maximum value is 18,000 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_JobDurationInSeconds
-InputConfig_ModelName <String>
The name of the created model.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConfig_ModelPackageVersionArn <String>
The Amazon Resource Name (ARN) of a versioned model package.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InputConfig_VolumeKmsKeyId <String>
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. This key will be passed to SageMaker Hosting for endpoint creation. The SageMaker execution role must have kms:CreateGrant permission in order to encrypt data on the storage volume of the endpoints created for inference recommendation. The inference recommendation job will fail asynchronously during endpoint configuration creation if the role passed does not have kms:CreateGrant permission.The KmsKeyId can be any of the following formats:
  • // KMS Key ID"1234abcd-12ab-34cd-56ef-1234567890ab"
  • // Amazon Resource Name (ARN) of a KMS Key"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  • // KMS Key Alias"alias/ExampleAlias"
  • // Amazon Resource Name (ARN) of a KMS Key Alias"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobDescription <String>
Description of the recommendation job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobName <String>
A name for the recommendation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account. The job name is passed down to the resources created by the recommendation job. The names of resources (such as the model, endpoint configuration, endpoint, and compilation) that are prefixed with the job name are truncated at 40 characters.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-JobType <RecommendationJobType>
Defines the type of recommendation job. Specify Default to initiate an instance recommendation and Advanced to initiate a load test. If left unspecified, Amazon SageMaker Inference Recommender will run an instance recommendation (DEFAULT) job.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-OutputConfig_KmsKeyId <String>
The Amazon Resource Name (ARN) of a Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt your output artifacts with Amazon S3 server-side encryption. The SageMaker execution role must have kms:GenerateDataKey permission.The KmsKeyId can be any of the following formats:
  • // KMS Key ID"1234abcd-12ab-34cd-56ef-1234567890ab"
  • // Amazon Resource Name (ARN) of a KMS Key"arn:aws:kms:<region>:<account>:key/<key-id-12ab-34cd-56ef-1234567890ab>"
  • // KMS Key Alias"alias/ExampleAlias"
  • // Amazon Resource Name (ARN) of a KMS Key Alias"arn:aws:kms:<region>:<account>:alias/<ExampleAlias>"
For more information about key identifiers, see Key identifiers (KeyID) in the Amazon Web Services Key Management Service (Amazon Web Services KMS) documentation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PayloadConfig_SamplePayloadUrl <String>
The Amazon Simple Storage Service (Amazon S3) path where the sample payload is stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ContainerConfig_PayloadConfig_SamplePayloadUrl
-PayloadConfig_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)
AliasesInputConfig_ContainerConfig_PayloadConfig_SupportedContentTypes
-ResourceLimit_MaxNumberOfTest <Int32>
Defines the maximum number of load tests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ResourceLimit_MaxNumberOfTests
-ResourceLimit_MaxParallelOfTest <Int32>
Defines the maximum number of parallel load tests.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_ResourceLimit_MaxParallelOfTests
-RoleArn <String>
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'JobArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateInferenceRecommendationsJobResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateInferenceRecommendationsJobResponse 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)
-Stairs_DurationInSecond <Int32>
Defines how long each traffic step should be.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_TrafficPattern_Stairs_DurationInSeconds
-Stairs_NumberOfStep <Int32>
Specifies how many steps to perform during traffic.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_TrafficPattern_Stairs_NumberOfSteps
-Stairs_UsersPerStep <Int32>
Specifies how many new users to spawn in each step.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_TrafficPattern_Stairs_UsersPerStep
-StoppingConditions_FlatInvocation <FlatInvocations>
Stops a load test when the number of invocations (TPS) peaks and flattens, which means that the instance has reached capacity. The default value is Stop. If you want the load test to continue after invocations have flattened, set the value to Continue.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoppingConditions_FlatInvocations
-StoppingConditions_MaxInvocation <Int32>
The maximum number of requests per minute expected for the endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoppingConditions_MaxInvocations
-StoppingConditions_ModelLatencyThreshold <ModelLatencyThreshold[]>
The interval of time taken by a model to respond as viewed from SageMaker. The interval includes the local communication time taken to send the request and to fetch the response from the container of a model and the time taken to complete the inference in the 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)
AliasesStoppingConditions_ModelLatencyThresholds
-Tag <Tag[]>
The metadata that you apply to Amazon Web Services resources to help you categorize and organize them. Each tag consists of a key and a value, both of which you define. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference. 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
-TrafficPattern_Phase <Phase[]>
Defines the phases traffic specification. 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)
AliasesInputConfig_TrafficPattern_Phases
-TrafficPattern_TrafficType <TrafficType>
Defines the traffic patterns. Choose either PHASES or STAIRS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesInputConfig_TrafficPattern_TrafficType
-VpcConfig_SecurityGroupId <String[]>
The VPC security group IDs. IDs have the form of sg-xxxxxxxx. Specify the security groups for the VPC that is specified in the Subnets field. 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)
AliasesInputConfig_VpcConfig_SecurityGroupIds
-VpcConfig_Subnet <String[]>
The ID of the subnets in the VPC to which you want to connect your model. 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)
AliasesInputConfig_VpcConfig_Subnets

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.CreateInferenceRecommendationsJobResponse
This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateInferenceRecommendationsJobResponse) 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