aws_sdk_deadline/client/
update_limit.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 [`UpdateLimit`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::set_farm_id):<br>required: **true**<br><p>The unique identifier of the farm that contains the limit.</p><br>
7    ///   - [`limit_id(impl Into<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::limit_id) / [`set_limit_id(Option<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::set_limit_id):<br>required: **true**<br><p>The unique identifier of the limit to update.</p><br>
8    ///   - [`display_name(impl Into<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::display_name) / [`set_display_name(Option<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::set_display_name):<br>required: **false**<br><p>The new display name of the limit.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::set_description):<br>required: **false**<br><p>The new description of the limit.</p><important>  <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important><br>
10    ///   - [`max_count(i32)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::max_count) / [`set_max_count(Option<i32>)`](crate::operation::update_limit::builders::UpdateLimitFluentBuilder::set_max_count):<br>required: **false**<br><p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>If more than the new maximum number is currently in use, running jobs finish but no new jobs are started until the number of resources in use is below the new maximum number.</p> <p>The <code>maxCount</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p><br>
11    /// - On success, responds with [`UpdateLimitOutput`](crate::operation::update_limit::UpdateLimitOutput)
12    /// - On failure, responds with [`SdkError<UpdateLimitError>`](crate::operation::update_limit::UpdateLimitError)
13    pub fn update_limit(&self) -> crate::operation::update_limit::builders::UpdateLimitFluentBuilder {
14        crate::operation::update_limit::builders::UpdateLimitFluentBuilder::new(self.handle.clone())
15    }
16}