aws_sdk_sagemaker/client/describe_cluster_event.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 [`DescribeClusterEvent`](crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`event_id(impl Into<String>)`](crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder::event_id) / [`set_event_id(Option<String>)`](crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder::set_event_id):<br>required: **true**<br><p>The unique identifier (UUID) of the event to describe. This ID can be obtained from the <code>ListClusterEvents</code> operation.</p><br>
7 /// - [`cluster_name(impl Into<String>)`](crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name or Amazon Resource Name (ARN) of the HyperPod cluster associated with the event.</p><br>
8 /// - On success, responds with [`DescribeClusterEventOutput`](crate::operation::describe_cluster_event::DescribeClusterEventOutput) with field(s):
9 /// - [`event_details(Option<ClusterEventDetail>)`](crate::operation::describe_cluster_event::DescribeClusterEventOutput::event_details): <p>Detailed information about the requested cluster event, including event metadata for various resource types such as <code>Cluster</code>, <code>InstanceGroup</code>, <code>Instance</code>, and their associated attributes.</p>
10 /// - On failure, responds with [`SdkError<DescribeClusterEventError>`](crate::operation::describe_cluster_event::DescribeClusterEventError)
11 pub fn describe_cluster_event(&self) -> crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder {
12 crate::operation::describe_cluster_event::builders::DescribeClusterEventFluentBuilder::new(self.handle.clone())
13 }
14}