AWS SDK Version 3 for .NET
API 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.

Container for the parameters to the UpdateEndpoint operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.UpdateEndpointRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

C#
public class UpdateEndpointRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The UpdateEndpointRequest type exposes the following members

Constructors

NameDescription
Public Method UpdateEndpointRequest()

Properties

NameTypeDescription
Public Property DeploymentConfig Amazon.SageMaker.Model.DeploymentConfig

Gets and sets the property DeploymentConfig.

The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.

Public Property EndpointConfigName System.String

Gets and sets the property EndpointConfigName.

The name of the new endpoint configuration.

Public Property EndpointName System.String

Gets and sets the property EndpointName.

The name of the endpoint whose configuration you want to update.

Public Property ExcludeRetainedVariantProperties System.Collections.Generic.List<Amazon.SageMaker.Model.VariantProperty>

Gets and sets the property ExcludeRetainedVariantProperties.

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.

Public Property RetainAllVariantProperties System.Boolean

Gets and sets the property RetainAllVariantProperties.

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.

Public Property RetainDeploymentConfig System.Boolean

Gets and sets the property RetainDeploymentConfig.

Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5