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

Syntax

New-SMEndpoint
-EndpointConfigName <String>
-AutoRollbackConfiguration_Alarm <Alarm[]>
-EndpointName <String>
-BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSecond <Int32>
-RollingUpdatePolicy_MaximumExecutionTimeoutInSecond <Int32>
-Tag <Tag[]>
-BlueGreenUpdatePolicy_TerminationWaitInSecond <Int32>
-CanarySize_Type <CapacitySizeType>
-LinearStepSize_Type <CapacitySizeType>
-TrafficRoutingConfiguration_Type <TrafficRoutingConfigType>
-MaximumBatchSize_Type <CapacitySizeType>
-RollbackMaximumBatchSize_Type <CapacitySizeType>
-CanarySize_Value <Int32>
-LinearStepSize_Value <Int32>
-MaximumBatchSize_Value <Int32>
-RollbackMaximumBatchSize_Value <Int32>
-TrafficRoutingConfiguration_WaitIntervalInSecond <Int32>
-RollingUpdatePolicy_WaitIntervalInSecond <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonSageMakerConfig>

Description

Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API. Use this API to deploy models using SageMaker hosting services. You must not delete an EndpointConfig that is in use by an endpoint that is live or while the UpdateEndpoint or CreateEndpoint operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig. The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account. When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them. When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read. When SageMaker receives the request, it sets the endpoint status to Creating. After it creates the endpoint, it sets the status to InService. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API. If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide. To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
  • Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess policy.
  • Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role: "Action": ["sagemaker:CreateEndpoint", "sagemaker:CreateEndpointConfig"]"Resource": ["arn:aws:sagemaker:region:account-id:endpoint/endpointName""arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName"] For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.

Parameters

-AutoRollbackConfiguration_Alarm <Alarm[]>
List of CloudWatch alarms in your account that are configured to monitor metrics on an endpoint. If any alarms are tripped during a deployment, SageMaker rolls back the deployment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_AutoRollbackConfiguration_Alarms
-BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSecond <Int32>
Maximum execution timeout for the deployment. Note that the timeout value should be larger than the total waiting time specified in TerminationWaitInSeconds and WaitIntervalInSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSeconds
-BlueGreenUpdatePolicy_TerminationWaitInSecond <Int32>
Additional waiting time in seconds after the completion of an endpoint deployment before terminating the old endpoint fleet. Default is 0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TerminationWaitInSeconds
-CanarySize_Type <CapacitySizeType>
Specifies the endpoint capacity type.
  • INSTANCE_COUNT: The endpoint activates based on the number of instances.
  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_CanarySize_Type
-CanarySize_Value <Int32>
Defines the capacity size, either as a number of instances or a capacity percentage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_CanarySize_Value
-ClientConfig <AmazonSageMakerConfig>
Amazon.PowerShell.Cmdlets.SM.AmazonSageMakerClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointConfigName <String>
The name of an endpoint configuration. For more information, see CreateEndpointConfig.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointName <String>
The name of the endpoint.The name must be unique within an Amazon Web Services Region in your Amazon Web Services account. The name is case-insensitive in CreateEndpoint, but the case is preserved and must be matched in InvokeEndpoint.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
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)
-LinearStepSize_Type <CapacitySizeType>
Specifies the endpoint capacity type.
  • INSTANCE_COUNT: The endpoint activates based on the number of instances.
  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_LinearStepSize_Type
-LinearStepSize_Value <Int32>
Defines the capacity size, either as a number of instances or a capacity percentage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_LinearStepSize_Value
-MaximumBatchSize_Type <CapacitySizeType>
Specifies the endpoint capacity type.
  • INSTANCE_COUNT: The endpoint activates based on the number of instances.
  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_MaximumBatchSize_Type
-MaximumBatchSize_Value <Int32>
Defines the capacity size, either as a number of instances or a capacity percentage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_MaximumBatchSize_Value
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the EndpointConfigName parameter. The -PassThru parameter is deprecated, use -Select '^EndpointConfigName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RollbackMaximumBatchSize_Type <CapacitySizeType>
Specifies the endpoint capacity type.
  • INSTANCE_COUNT: The endpoint activates based on the number of instances.
  • CAPACITY_PERCENT: The endpoint activates based on the specified percentage of capacity.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_RollbackMaximumBatchSize_Type
-RollbackMaximumBatchSize_Value <Int32>
Defines the capacity size, either as a number of instances or a capacity percentage.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_RollbackMaximumBatchSize_Value
-RollingUpdatePolicy_MaximumExecutionTimeoutInSecond <Int32>
The time limit for the total deployment. Exceeding this limit causes a timeout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_MaximumExecutionTimeoutInSeconds
-RollingUpdatePolicy_WaitIntervalInSecond <Int32>
The length of the baking period, during which SageMaker monitors alarms for each batch on the new fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_RollingUpdatePolicy_WaitIntervalInSeconds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'EndpointArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.SageMaker.Model.CreateEndpointResponse). Specifying the name of a property of type Amazon.SageMaker.Model.CreateEndpointResponse 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TrafficRoutingConfiguration_Type <TrafficRoutingConfigType>
Traffic routing strategy type.
  • ALL_AT_ONCE: Endpoint traffic shifts to the new fleet in a single step.
  • CANARY: Endpoint traffic shifts to the new fleet in two steps. The first step is the canary, which is a small portion of the traffic. The second step is the remainder of the traffic.
  • LINEAR: Endpoint traffic shifts to the new fleet in n steps of a configurable size.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_Type
-TrafficRoutingConfiguration_WaitIntervalInSecond <Int32>
The waiting time (in seconds) between incremental steps to turn on traffic on the new endpoint fleet.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDeploymentConfig_BlueGreenUpdatePolicy_TrafficRoutingConfiguration_WaitIntervalInSeconds

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

This cmdlet returns a System.String object. The service call response (type Amazon.SageMaker.Model.CreateEndpointResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

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