aws_sdk_sagemaker/client/
describe_cluster.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 [`DescribeCluster`](crate::operation::describe_cluster::builders::DescribeClusterFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`cluster_name(impl Into<String>)`](crate::operation::describe_cluster::builders::DescribeClusterFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::describe_cluster::builders::DescribeClusterFluentBuilder::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    /// - On success, responds with [`DescribeClusterOutput`](crate::operation::describe_cluster::DescribeClusterOutput) with field(s):
8    ///   - [`cluster_arn(Option<String>)`](crate::operation::describe_cluster::DescribeClusterOutput::cluster_arn): <p>The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.</p>
9    ///   - [`cluster_name(Option<String>)`](crate::operation::describe_cluster::DescribeClusterOutput::cluster_name): <p>The name of the SageMaker HyperPod cluster.</p>
10    ///   - [`cluster_status(Option<ClusterStatus>)`](crate::operation::describe_cluster::DescribeClusterOutput::cluster_status): <p>The status of the SageMaker HyperPod cluster.</p>
11    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_cluster::DescribeClusterOutput::creation_time): <p>The time when the SageMaker Cluster is created.</p>
12    ///   - [`failure_message(Option<String>)`](crate::operation::describe_cluster::DescribeClusterOutput::failure_message): <p>The failure message of the SageMaker HyperPod cluster.</p>
13    ///   - [`instance_groups(Option<Vec::<ClusterInstanceGroupDetails>>)`](crate::operation::describe_cluster::DescribeClusterOutput::instance_groups): <p>The instance groups of the SageMaker HyperPod cluster.</p>
14    ///   - [`restricted_instance_groups(Option<Vec::<ClusterRestrictedInstanceGroupDetails>>)`](crate::operation::describe_cluster::DescribeClusterOutput::restricted_instance_groups): <p>The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.</p>
15    ///   - [`vpc_config(Option<VpcConfig>)`](crate::operation::describe_cluster::DescribeClusterOutput::vpc_config): <p>Specifies an Amazon Virtual Private Cloud (VPC) that your SageMaker jobs, hosted models, and compute resources have access to. You can control access to and from your resources by configuring a VPC. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/infrastructure-give-access.html">Give SageMaker Access to Resources in your Amazon VPC</a>.</p>
16    ///   - [`orchestrator(Option<ClusterOrchestrator>)`](crate::operation::describe_cluster::DescribeClusterOutput::orchestrator): <p>The type of orchestrator used for the SageMaker HyperPod cluster.</p>
17    ///   - [`node_recovery(Option<ClusterNodeRecovery>)`](crate::operation::describe_cluster::DescribeClusterOutput::node_recovery): <p>The node recovery mode configured for the SageMaker HyperPod cluster.</p>
18    ///   - [`node_provisioning_mode(Option<ClusterNodeProvisioningMode>)`](crate::operation::describe_cluster::DescribeClusterOutput::node_provisioning_mode): <p>The mode used for provisioning nodes in the cluster.</p>
19    ///   - [`cluster_role(Option<String>)`](crate::operation::describe_cluster::DescribeClusterOutput::cluster_role): <p>The Amazon Resource Name (ARN) of the IAM role that HyperPod uses for cluster autoscaling operations.</p>
20    ///   - [`auto_scaling(Option<ClusterAutoScalingConfigOutput>)`](crate::operation::describe_cluster::DescribeClusterOutput::auto_scaling): <p>The current autoscaling configuration and status for the autoscaler.</p>
21    /// - On failure, responds with [`SdkError<DescribeClusterError>`](crate::operation::describe_cluster::DescribeClusterError)
22    pub fn describe_cluster(&self) -> crate::operation::describe_cluster::builders::DescribeClusterFluentBuilder {
23        crate::operation::describe_cluster::builders::DescribeClusterFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_sagemaker/client/describe_cluster.rs

aws_sdk_sagemaker/client/
describe_cluster.rs
