aws_sdk_cleanrooms/client/
list_privacy_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 [`ListPrivacyBudgets`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`membership_identifier(impl Into<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::membership_identifier) / [`set_membership_identifier(Option<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::set_membership_identifier):<br>required: **true**<br><p>A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.</p><br>
8    ///   - [`privacy_budget_type(PrivacyBudgetType)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::privacy_budget_type) / [`set_privacy_budget_type(Option<PrivacyBudgetType>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::set_privacy_budget_type):<br>required: **true**<br><p>The privacy budget type.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token that's used to fetch the next set of results.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a `nextToken` even if the `maxResults` value has not been met.</p><br>
11    ///   - [`access_budget_resource_arn(impl Into<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::access_budget_resource_arn) / [`set_access_budget_resource_arn(Option<String>)`](crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::set_access_budget_resource_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the access budget resource to filter privacy budgets by.</p><br>
12    /// - On success, responds with [`ListPrivacyBudgetsOutput`](crate::operation::list_privacy_budgets::ListPrivacyBudgetsOutput) with field(s):
13    ///   - [`privacy_budget_summaries(Vec::<PrivacyBudgetSummary>)`](crate::operation::list_privacy_budgets::ListPrivacyBudgetsOutput::privacy_budget_summaries): <p>An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_privacy_budgets::ListPrivacyBudgetsOutput::next_token): <p>The pagination token that's used to fetch the next set of results.</p>
15    /// - On failure, responds with [`SdkError<ListPrivacyBudgetsError>`](crate::operation::list_privacy_budgets::ListPrivacyBudgetsError)
16    pub fn list_privacy_budgets(&self) -> crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder {
17        crate::operation::list_privacy_budgets::builders::ListPrivacyBudgetsFluentBuilder::new(self.handle.clone())
18    }
19}