aws_sdk_sagemaker/client/
describe_cluster_scheduler_config.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeClusterSchedulerConfig`](crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`cluster_scheduler_config_id(impl Into<String>)`](crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder::cluster_scheduler_config_id) / [`set_cluster_scheduler_config_id(Option<String>)`](crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder::set_cluster_scheduler_config_id):<br>required: **true**<br><p>ID of the cluster policy.</p><br>
    ///   - [`cluster_scheduler_config_version(i32)`](crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder::cluster_scheduler_config_version) / [`set_cluster_scheduler_config_version(Option<i32>)`](crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder::set_cluster_scheduler_config_version):<br>required: **false**<br><p>Version of the cluster policy.</p><br>
    /// - On success, responds with [`DescribeClusterSchedulerConfigOutput`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput) with field(s):
    ///   - [`cluster_scheduler_config_arn(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::cluster_scheduler_config_arn): <p>ARN of the cluster policy.</p>
    ///   - [`cluster_scheduler_config_id(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::cluster_scheduler_config_id): <p>ID of the cluster policy.</p>
    ///   - [`name(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::name): <p>Name of the cluster policy.</p>
    ///   - [`cluster_scheduler_config_version(Option<i32>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::cluster_scheduler_config_version): <p>Version of the cluster policy.</p>
    ///   - [`status(Option<SchedulerResourceStatus>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::status): <p>Status of the cluster policy.</p>
    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::failure_reason): <p>Failure reason of the cluster policy.</p>
    ///   - [`cluster_arn(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::cluster_arn): <p>ARN of the cluster where the cluster policy is applied.</p>
    ///   - [`scheduler_config(Option<SchedulerConfig>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::scheduler_config): <p>Cluster policy configuration. This policy is used for task prioritization and fair-share allocation. This helps prioritize critical workloads and distributes idle compute across entities.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::description): <p>Description of the cluster policy.</p>
    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::creation_time): <p>Creation time of the cluster policy.</p>
    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::created_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::last_modified_time): <p>Last modified time of the cluster policy.</p>
    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigOutput::last_modified_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
    /// - On failure, responds with [`SdkError<DescribeClusterSchedulerConfigError>`](crate::operation::describe_cluster_scheduler_config::DescribeClusterSchedulerConfigError)
    pub fn describe_cluster_scheduler_config(
        &self,
    ) -> crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder {
        crate::operation::describe_cluster_scheduler_config::builders::DescribeClusterSchedulerConfigFluentBuilder::new(self.handle.clone())
    }
}