aws_sdk_budgets/client/describe_notifications_for_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 [`DescribeNotificationsForBudget`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`account_id(impl Into<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::set_account_id):<br>required: **true**<br><p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p><br>
8 /// - [`budget_name(impl Into<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::budget_name) / [`set_budget_name(Option<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::set_budget_name):<br>required: **true**<br><p>The name of the budget whose notifications you want descriptions of.</p><br>
9 /// - [`max_results(i32)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional integer that represents how many entries a paginated response contains.</p><br>
10 /// - [`next_token(impl Into<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::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>
11 /// - On success, responds with [`DescribeNotificationsForBudgetOutput`](crate::operation::describe_notifications_for_budget::DescribeNotificationsForBudgetOutput) with field(s):
12 /// - [`notifications(Option<Vec::<Notification>>)`](crate::operation::describe_notifications_for_budget::DescribeNotificationsForBudgetOutput::notifications): <p>A list of notifications that are associated with a budget.</p>
13 /// - [`next_token(Option<String>)`](crate::operation::describe_notifications_for_budget::DescribeNotificationsForBudgetOutput::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<DescribeNotificationsForBudgetError>`](crate::operation::describe_notifications_for_budget::DescribeNotificationsForBudgetError)
15 pub fn describe_notifications_for_budget(
16 &self,
17 ) -> crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder {
18 crate::operation::describe_notifications_for_budget::builders::DescribeNotificationsForBudgetFluentBuilder::new(self.handle.clone())
19 }
20}