VariantProperty - Amazon SageMaker
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Specifies a production variant property type for an Endpoint.

If you are updating an endpoint with the RetainAllVariantProperties option of UpdateEndpointInput set to true, the VariantProperty objects listed in the ExcludeRetainedVariantProperties parameter of UpdateEndpointInput override the existing variant properties of the endpoint.



The type of variant property. The supported values are:

  • DesiredInstanceCount: Overrides the existing variant instance counts using the InitialInstanceCount values in the ProductionVariants of CreateEndpointConfig.

  • DesiredWeight: Overrides the existing variant weights using the InitialVariantWeight values in the ProductionVariants of CreateEndpointConfig.

  • DataCaptureConfig: (Not currently supported.)

Type: String

Valid Values: DesiredInstanceCount | DesiredWeight | DataCaptureConfig

Required: Yes

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: