aws_sdk_sagemaker/client/
describe_compute_quota.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 [`DescribeComputeQuota`](crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`compute_quota_id(impl Into<String>)`](crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder::compute_quota_id) / [`set_compute_quota_id(Option<String>)`](crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder::set_compute_quota_id):<br>required: **true**<br><p>ID of the compute allocation definition.</p><br>
7    ///   - [`compute_quota_version(i32)`](crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder::compute_quota_version) / [`set_compute_quota_version(Option<i32>)`](crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder::set_compute_quota_version):<br>required: **false**<br><p>Version of the compute allocation definition.</p><br>
8    /// - On success, responds with [`DescribeComputeQuotaOutput`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput) with field(s):
9    ///   - [`compute_quota_arn(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::compute_quota_arn): <p>ARN of the compute allocation definition.</p>
10    ///   - [`compute_quota_id(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::compute_quota_id): <p>ID of the compute allocation definition.</p>
11    ///   - [`name(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::name): <p>Name of the compute allocation definition.</p>
12    ///   - [`description(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::description): <p>Description of the compute allocation definition.</p>
13    ///   - [`compute_quota_version(Option<i32>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::compute_quota_version): <p>Version of the compute allocation definition.</p>
14    ///   - [`status(Option<SchedulerResourceStatus>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::status): <p>Status of the compute allocation definition.</p>
15    ///   - [`failure_reason(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::failure_reason): <p>Failure reason of the compute allocation definition.</p>
16    ///   - [`cluster_arn(Option<String>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::cluster_arn): <p>ARN of the cluster.</p>
17    ///   - [`compute_quota_config(Option<ComputeQuotaConfig>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::compute_quota_config): <p>Configuration of the compute allocation definition. This includes the resource sharing option, and the setting to preempt low priority tasks.</p>
18    ///   - [`compute_quota_target(Option<ComputeQuotaTarget>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::compute_quota_target): <p>The target entity to allocate compute resources to.</p>
19    ///   - [`activation_state(Option<ActivationState>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::activation_state): <p>The state of the compute allocation being described. Use to enable or disable compute allocation.</p> <p>Default is <code>Enabled</code>.</p>
20    ///   - [`creation_time(Option<DateTime>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::creation_time): <p>Creation time of the compute allocation configuration.</p>
21    ///   - [`created_by(Option<UserContext>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::created_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
22    ///   - [`last_modified_time(Option<DateTime>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::last_modified_time): <p>Last modified time of the compute allocation configuration.</p>
23    ///   - [`last_modified_by(Option<UserContext>)`](crate::operation::describe_compute_quota::DescribeComputeQuotaOutput::last_modified_by): <p>Information about the user who created or modified an experiment, trial, trial component, lineage group, project, or model card.</p>
24    /// - On failure, responds with [`SdkError<DescribeComputeQuotaError>`](crate::operation::describe_compute_quota::DescribeComputeQuotaError)
25    pub fn describe_compute_quota(&self) -> crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder {
26        crate::operation::describe_compute_quota::builders::DescribeComputeQuotaFluentBuilder::new(self.handle.clone())
27    }
28}