aws_sdk_sagemaker/client/
update_endpoint.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`UpdateEndpoint`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`endpoint_name(impl Into<String>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::endpoint_name) / [`set_endpoint_name(Option<String>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_endpoint_name):<br>required: **true**<br><p>The name of the endpoint whose configuration you want to update.</p><br>
7    ///   - [`endpoint_config_name(impl Into<String>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::endpoint_config_name) / [`set_endpoint_config_name(Option<String>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_endpoint_config_name):<br>required: **true**<br><p>The name of the new endpoint configuration.</p><br>
8    ///   - [`retain_all_variant_properties(bool)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::retain_all_variant_properties) / [`set_retain_all_variant_properties(Option<bool>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_retain_all_variant_properties):<br>required: **false**<br><p>When updating endpoint resources, enables or disables the retention of <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">variant properties</a>, such as the instance count or the variant weight. To retain the variant properties of an endpoint when updating it, set <code>RetainAllVariantProperties</code> to <code>true</code>. To use the variant properties specified in a new <code>EndpointConfig</code> call when updating an endpoint, set <code>RetainAllVariantProperties</code> to <code>false</code>. The default is <code>false</code>.</p><br>
9    ///   - [`exclude_retained_variant_properties(VariantProperty)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::exclude_retained_variant_properties) / [`set_exclude_retained_variant_properties(Option<Vec::<VariantProperty>>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_exclude_retained_variant_properties):<br>required: **false**<br><p>When you are updating endpoint resources with <code>RetainAllVariantProperties</code>, whose value is set to <code>true</code>, <code>ExcludeRetainedVariantProperties</code> specifies the list of type <a href="https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_VariantProperty.html">VariantProperty</a> to override with the values provided by <code>EndpointConfig</code>. If you don't specify a value for <code>ExcludeRetainedVariantProperties</code>, no variant properties are overridden.</p><br>
10    ///   - [`deployment_config(DeploymentConfig)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::deployment_config) / [`set_deployment_config(Option<DeploymentConfig>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_deployment_config):<br>required: **false**<br><p>The deployment configuration for an endpoint, which contains the desired deployment strategy and rollback configurations.</p><br>
11    ///   - [`retain_deployment_config(bool)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::retain_deployment_config) / [`set_retain_deployment_config(Option<bool>)`](crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::set_retain_deployment_config):<br>required: **false**<br><p>Specifies whether to reuse the last deployment configuration. The default value is false (the configuration is not reused).</p><br>
12    /// - On success, responds with [`UpdateEndpointOutput`](crate::operation::update_endpoint::UpdateEndpointOutput) with field(s):
13    ///   - [`endpoint_arn(Option<String>)`](crate::operation::update_endpoint::UpdateEndpointOutput::endpoint_arn): <p>The Amazon Resource Name (ARN) of the endpoint.</p>
14    /// - On failure, responds with [`SdkError<UpdateEndpointError>`](crate::operation::update_endpoint::UpdateEndpointError)
15    pub fn update_endpoint(&self) -> crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder {
16        crate::operation::update_endpoint::builders::UpdateEndpointFluentBuilder::new(self.handle.clone())
17    }
18}