Skip to main content

aws_sdk_sagemaker/client/
start_cluster_health_check.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 [`StartClusterHealthCheck`](crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_name(impl Into<String>)`](crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The string name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</p><br>
7    ///   - [`deep_health_check_configurations(InstanceGroupHealthCheckConfiguration)`](crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder::deep_health_check_configurations) / [`set_deep_health_check_configurations(Option<Vec::<InstanceGroupHealthCheckConfiguration>>)`](crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder::set_deep_health_check_configurations):<br>required: **true**<br><p>A list of configurations containing instance group names, EC2 instance IDs, and deep health checks to perform.</p><br>
8    /// - On success, responds with [`StartClusterHealthCheckOutput`](crate::operation::start_cluster_health_check::StartClusterHealthCheckOutput) with field(s):
9    ///   - [`cluster_arn(String)`](crate::operation::start_cluster_health_check::StartClusterHealthCheckOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster on which the deep health checks were initiated.</p>
10    /// - On failure, responds with [`SdkError<StartClusterHealthCheckError>`](crate::operation::start_cluster_health_check::StartClusterHealthCheckError)
11    pub fn start_cluster_health_check(&self) -> crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder {
12        crate::operation::start_cluster_health_check::builders::StartClusterHealthCheckFluentBuilder::new(self.handle.clone())
13    }
14}