aws_sdk_deadline/client/
get_budget.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 [`GetBudget`](crate::operation::get_budget::builders::GetBudgetFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`farm_id(impl Into<String>)`](crate::operation::get_budget::builders::GetBudgetFluentBuilder::farm_id) / [`set_farm_id(Option<String>)`](crate::operation::get_budget::builders::GetBudgetFluentBuilder::set_farm_id):<br>required: **true**<br><p>The farm ID of the farm connected to the budget.</p><br>
7    ///   - [`budget_id(impl Into<String>)`](crate::operation::get_budget::builders::GetBudgetFluentBuilder::budget_id) / [`set_budget_id(Option<String>)`](crate::operation::get_budget::builders::GetBudgetFluentBuilder::set_budget_id):<br>required: **true**<br><p>The budget ID.</p><br>
8    /// - On success, responds with [`GetBudgetOutput`](crate::operation::get_budget::GetBudgetOutput) with field(s):
9    ///   - [`budget_id(String)`](crate::operation::get_budget::GetBudgetOutput::budget_id): <p>The budget ID.</p>
10    ///   - [`usage_tracking_resource(Option<UsageTrackingResource>)`](crate::operation::get_budget::GetBudgetOutput::usage_tracking_resource): <p>The resource that the budget is tracking usage for.</p>
11    ///   - [`status(BudgetStatus)`](crate::operation::get_budget::GetBudgetOutput::status): <p>The status of the budget.</p> <ul>  <li>   <p><code>ACTIVE</code>–Get a budget being evaluated.</p></li>  <li>   <p><code>INACTIVE</code>–Get an inactive budget. This can include expired, canceled, or deleted statuses.</p></li> </ul>
12    ///   - [`display_name(String)`](crate::operation::get_budget::GetBudgetOutput::display_name): <p>The display name of the budget.</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>
13    ///   - [`description(Option<String>)`](crate::operation::get_budget::GetBudgetOutput::description): <p>The description of the budget.</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>
14    ///   - [`approximate_dollar_limit(f32)`](crate::operation::get_budget::GetBudgetOutput::approximate_dollar_limit): <p>The consumed usage limit for the budget.</p>
15    ///   - [`usages(Option<ConsumedUsages>)`](crate::operation::get_budget::GetBudgetOutput::usages): <p>The usages of the budget.</p>
16    ///   - [`actions(Vec::<ResponseBudgetAction>)`](crate::operation::get_budget::GetBudgetOutput::actions): <p>The budget actions for the budget.</p>
17    ///   - [`schedule(Option<BudgetSchedule>)`](crate::operation::get_budget::GetBudgetOutput::schedule): <p>The budget schedule.</p>
18    ///   - [`created_by(String)`](crate::operation::get_budget::GetBudgetOutput::created_by): <p>The user or system that created this resource.</p>
19    ///   - [`created_at(DateTime)`](crate::operation::get_budget::GetBudgetOutput::created_at): <p>The date and time the resource was created.</p>
20    ///   - [`updated_by(Option<String>)`](crate::operation::get_budget::GetBudgetOutput::updated_by): <p>The user or system that updated this resource.</p>
21    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_budget::GetBudgetOutput::updated_at): <p>The date and time the resource was updated.</p>
22    ///   - [`queue_stopped_at(Option<DateTime>)`](crate::operation::get_budget::GetBudgetOutput::queue_stopped_at): <p>The date and time the queue stopped.</p>
23    /// - On failure, responds with [`SdkError<GetBudgetError>`](crate::operation::get_budget::GetBudgetError)
24    pub fn get_budget(&self) -> crate::operation::get_budget::builders::GetBudgetFluentBuilder {
25        crate::operation::get_budget::builders::GetBudgetFluentBuilder::new(self.handle.clone())
26    }
27}
aws_sdk_deadline/client/get_budget.rs

aws_sdk_deadline/client/
get_budget.rs
