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

Syntax

Update-SMEndpoint
-EndpointConfigName <String>
-AutoRollbackConfiguration_Alarm <Alarm[]>
-EndpointName <String>
-ExcludeRetainedVariantProperty <VariantProperty[]>
-BlueGreenUpdatePolicy_MaximumExecutionTimeoutInSecond <Int32>
-RetainAllVariantProperty <Boolean>
-RetainDeploymentConfig <Boolean>
-BlueGreenUpdatePolicy_TerminationWaitInSecond <Int32>
-CanarySize_Type <CapacitySizeType>
-LinearStepSize_Type <CapacitySizeType>
-TrafficRoutingConfiguration_Type <TrafficRoutingConfigType>
-CanarySize_Value <Int32>
-LinearStepSize_Value <Int32>
-TrafficRoutingConfiguration_WaitIntervalInSecond <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Deploys the new EndpointConfig specified in the request, switches to using newly created endpoint, and then deletes resources provisioned for the endpoint using the previous EndpointConfig (there is no availability loss). When SageMaker receives the request, it sets the endpoint status to Updating. After updating the endpoint, it sets the status to InService. To check the status of an endpoint, use the DescribeEndpoint API. You must not delete an EndpointConfig 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. If you delete the EndpointConfig of an endpoint that is active or being created or updated you may lose visibility into the instance type the endpoint is using. The endpoint must be deleted in order to stop incurring charges.

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
-EndpointConfigName <String>
The name of the new endpoint configuration.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointName <String>
The name of the endpoint whose configuration you want to update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExcludeRetainedVariantProperty <VariantProperty[]>
When you are updating endpoint resources with UpdateEndpointInput$RetainAllVariantProperties, whose value is set to true, ExcludeRetainedVariantProperties specifies the list of type VariantProperty to override with the values provided by EndpointConfig. If you don't specify a value for ExcludeAllVariantProperties, no variant properties are overridden.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesExcludeRetainedVariantProperties
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
-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)
-RetainAllVariantProperty <Boolean>
When updating endpoint resources, enables or disables the retention of variant properties, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set RetainAllVariantProperties to true. To use the variant properties specified in a new EndpointConfig call when updating an endpoint, set RetainAllVariantProperties to false. The default is false.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetainAllVariantProperties
-RetainDeploymentConfig <Boolean>
Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.UpdateEndpointResponse). Specifying the name of a property of type Amazon.SageMaker.Model.UpdateEndpointResponse 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)
-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.UpdateEndpointResponse) 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