aws_sdk_budgets/client/
describe_budgets.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 [`DescribeBudgets`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`account_id(impl Into<String>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::set_account_id):<br>required: **true**<br><p>The <code>accountId</code> that is associated with the budgets that you want to describe.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::set_max_results):<br>required: **false**<br><p>An integer that represents how many budgets a paginated response contains. The default is 100.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p><br>
10    ///   - [`show_filter_expression(bool)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::show_filter_expression) / [`set_show_filter_expression(Option<bool>)`](crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::set_show_filter_expression):<br>required: **false**<br><p>Specifies whether the response includes the filter expression associated with the budgets. By showing the filter expression, you can see detailed filtering logic applied to the budgets, such as Amazon Web Services services or tags that are being tracked.</p><br>
11    /// - On success, responds with [`DescribeBudgetsOutput`](crate::operation::describe_budgets::DescribeBudgetsOutput) with field(s):
12    ///   - [`budgets(Option<Vec::<Budget>>)`](crate::operation::describe_budgets::DescribeBudgetsOutput::budgets): <p>A list of budgets.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_budgets::DescribeBudgetsOutput::next_token): <p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>
14    /// - On failure, responds with [`SdkError<DescribeBudgetsError>`](crate::operation::describe_budgets::DescribeBudgetsError)
15    pub fn describe_budgets(&self) -> crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder {
16        crate::operation::describe_budgets::builders::DescribeBudgetsFluentBuilder::new(self.handle.clone())
17    }
18}