aws_sdk_sagemaker/client/get_scaling_configuration_recommendation.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 [`GetScalingConfigurationRecommendation`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`inference_recommendations_job_name(impl Into<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::inference_recommendations_job_name) / [`set_inference_recommendations_job_name(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::set_inference_recommendations_job_name):<br>required: **true**<br><p>The name of a previously completed Inference Recommender job.</p><br>
7 /// - [`recommendation_id(impl Into<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::recommendation_id) / [`set_recommendation_id(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::set_recommendation_id):<br>required: **false**<br><p>The recommendation ID of a previously completed inference recommendation. This ID should come from one of the recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p> <p>Specify either this field or the <code>EndpointName</code> field.</p><br>
8 /// - [`endpoint_name(impl Into<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::endpoint_name) / [`set_endpoint_name(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::set_endpoint_name):<br>required: **false**<br><p>The name of an endpoint benchmarked during a previously completed inference recommendation job. This name should come from one of the recommendations returned by the job specified in the <code>InferenceRecommendationsJobName</code> field.</p> <p>Specify either this field or the <code>RecommendationId</code> field.</p><br>
9 /// - [`target_cpu_utilization_per_core(i32)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::target_cpu_utilization_per_core) / [`set_target_cpu_utilization_per_core(Option<i32>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::set_target_cpu_utilization_per_core):<br>required: **false**<br><p>The percentage of how much utilization you want an instance to use before autoscaling. The default value is 50%.</p><br>
10 /// - [`scaling_policy_objective(ScalingPolicyObjective)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::scaling_policy_objective) / [`set_scaling_policy_objective(Option<ScalingPolicyObjective>)`](crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::set_scaling_policy_objective):<br>required: **false**<br><p>An object where you specify the anticipated traffic pattern for an endpoint.</p><br>
11 /// - On success, responds with [`GetScalingConfigurationRecommendationOutput`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput) with field(s):
12 /// - [`inference_recommendations_job_name(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::inference_recommendations_job_name): <p>The name of a previously completed Inference Recommender job.</p>
13 /// - [`recommendation_id(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::recommendation_id): <p>The recommendation ID of a previously completed inference recommendation.</p>
14 /// - [`endpoint_name(Option<String>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::endpoint_name): <p>The name of an endpoint benchmarked during a previously completed Inference Recommender job.</p>
15 /// - [`target_cpu_utilization_per_core(Option<i32>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::target_cpu_utilization_per_core): <p>The percentage of how much utilization you want an instance to use before autoscaling, which you specified in the request. The default value is 50%.</p>
16 /// - [`scaling_policy_objective(Option<ScalingPolicyObjective>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::scaling_policy_objective): <p>An object representing the anticipated traffic pattern for an endpoint that you specified in the request.</p>
17 /// - [`metric(Option<ScalingPolicyMetric>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::metric): <p>An object with a list of metrics that were benchmarked during the previously completed Inference Recommender job.</p>
18 /// - [`dynamic_scaling_configuration(Option<DynamicScalingConfiguration>)`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationOutput::dynamic_scaling_configuration): <p>An object with the recommended values for you to specify when creating an autoscaling policy.</p>
19 /// - On failure, responds with [`SdkError<GetScalingConfigurationRecommendationError>`](crate::operation::get_scaling_configuration_recommendation::GetScalingConfigurationRecommendationError)
20 pub fn get_scaling_configuration_recommendation(
21 &self,
22 ) -> crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder {
23 crate::operation::get_scaling_configuration_recommendation::builders::GetScalingConfigurationRecommendationFluentBuilder::new(
24 self.handle.clone(),
25 )
26 }
27}