aws_sdk_opensearchserverless/client/
list_access_policies.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 [`ListAccessPolicies`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`r#type(AccessPolicyType)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::type) / [`set_type(Option<AccessPolicyType>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::set_type):<br>required: **true**<br><p>The type of access policy.</p><br>
8    ///   - [`resource(impl Into<String>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::resource) / [`set_resource(Option<Vec::<String>>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::set_resource):<br>required: **false**<br><p>Resource filters (can be collections or indexes) that policies can apply to.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::set_next_token):<br>required: **false**<br><p>If your initial <code>ListAccessPolicies</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListAccessPolicies</code> operations, which returns results in the next page.</p><br>
10    ///   - [`max_results(i32)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::set_max_results):<br>required: **false**<br><p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results. The default is 20.</p><br>
11    /// - On success, responds with [`ListAccessPoliciesOutput`](crate::operation::list_access_policies::ListAccessPoliciesOutput) with field(s):
12    ///   - [`access_policy_summaries(Option<Vec::<AccessPolicySummary>>)`](crate::operation::list_access_policies::ListAccessPoliciesOutput::access_policy_summaries): <p>Details about the requested access policies.</p>
13    ///   - [`next_token(Option<String>)`](crate::operation::list_access_policies::ListAccessPoliciesOutput::next_token): <p>When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
14    /// - On failure, responds with [`SdkError<ListAccessPoliciesError>`](crate::operation::list_access_policies::ListAccessPoliciesError)
15    pub fn list_access_policies(&self) -> crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder {
16        crate::operation::list_access_policies::builders::ListAccessPoliciesFluentBuilder::new(self.handle.clone())
17    }
18}