aws_sdk_lakeformation/operation/list_permissions/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_permissions::_list_permissions_output::ListPermissionsOutputBuilder;
3
4pub use crate::operation::list_permissions::_list_permissions_input::ListPermissionsInputBuilder;
5
6impl crate::operation::list_permissions::builders::ListPermissionsInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::list_permissions::ListPermissionsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_permissions::ListPermissionsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_permissions();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListPermissions`.
24///
25/// <p>Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.</p>
26/// <p>This operation returns only those permissions that have been explicitly granted. If both <code>Principal</code> and <code>Resource</code> parameters are provided, the response returns effective permissions rather than the explicitly granted permissions.</p>
27/// <p>For information about permissions, see <a href="https://docs.aws.amazon.com/lake-formation/latest/dg/security-data-access.html">Security and Access Control to Metadata and Data</a>.</p>
28#[derive(::std::clone::Clone, ::std::fmt::Debug)]
29pub struct ListPermissionsFluentBuilder {
30    handle: ::std::sync::Arc<crate::client::Handle>,
31    inner: crate::operation::list_permissions::builders::ListPermissionsInputBuilder,
32    config_override: ::std::option::Option<crate::config::Builder>,
33}
34impl
35    crate::client::customize::internal::CustomizableSend<
36        crate::operation::list_permissions::ListPermissionsOutput,
37        crate::operation::list_permissions::ListPermissionsError,
38    > for ListPermissionsFluentBuilder
39{
40    fn send(
41        self,
42        config_override: crate::config::Builder,
43    ) -> crate::client::customize::internal::BoxFuture<
44        crate::client::customize::internal::SendResult<
45            crate::operation::list_permissions::ListPermissionsOutput,
46            crate::operation::list_permissions::ListPermissionsError,
47        >,
48    > {
49        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
50    }
51}
52impl ListPermissionsFluentBuilder {
53    /// Creates a new `ListPermissionsFluentBuilder`.
54    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
55        Self {
56            handle,
57            inner: ::std::default::Default::default(),
58            config_override: ::std::option::Option::None,
59        }
60    }
61    /// Access the ListPermissions as a reference.
62    pub fn as_input(&self) -> &crate::operation::list_permissions::builders::ListPermissionsInputBuilder {
63        &self.inner
64    }
65    /// Sends the request and returns the response.
66    ///
67    /// If an error occurs, an `SdkError` will be returned with additional details that
68    /// can be matched against.
69    ///
70    /// By default, any retryable failures will be retried twice. Retry behavior
71    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
72    /// set when configuring the client.
73    pub async fn send(
74        self,
75    ) -> ::std::result::Result<
76        crate::operation::list_permissions::ListPermissionsOutput,
77        ::aws_smithy_runtime_api::client::result::SdkError<
78            crate::operation::list_permissions::ListPermissionsError,
79            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
80        >,
81    > {
82        let input = self
83            .inner
84            .build()
85            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
86        let runtime_plugins = crate::operation::list_permissions::ListPermissions::operation_runtime_plugins(
87            self.handle.runtime_plugins.clone(),
88            &self.handle.conf,
89            self.config_override,
90        );
91        crate::operation::list_permissions::ListPermissions::orchestrate(&runtime_plugins, input).await
92    }
93
94    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
95    pub fn customize(
96        self,
97    ) -> crate::client::customize::CustomizableOperation<
98        crate::operation::list_permissions::ListPermissionsOutput,
99        crate::operation::list_permissions::ListPermissionsError,
100        Self,
101    > {
102        crate::client::customize::CustomizableOperation::new(self)
103    }
104    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
105        self.set_config_override(::std::option::Option::Some(config_override.into()));
106        self
107    }
108
109    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
110        self.config_override = config_override;
111        self
112    }
113    /// Create a paginator for this request
114    ///
115    /// Paginators are used by calling [`send().await`](crate::operation::list_permissions::paginator::ListPermissionsPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
116    pub fn into_paginator(self) -> crate::operation::list_permissions::paginator::ListPermissionsPaginator {
117        crate::operation::list_permissions::paginator::ListPermissionsPaginator::new(self.handle, self.inner)
118    }
119    /// <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.</p>
120    pub fn catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
121        self.inner = self.inner.catalog_id(input.into());
122        self
123    }
124    /// <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.</p>
125    pub fn set_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
126        self.inner = self.inner.set_catalog_id(input);
127        self
128    }
129    /// <p>The identifier for the Data Catalog. By default, the account ID. The Data Catalog is the persistent metadata store. It contains database definitions, table definitions, and other control information to manage your Lake Formation environment.</p>
130    pub fn get_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
131        self.inner.get_catalog_id()
132    }
133    /// <p>Specifies a principal to filter the permissions returned.</p>
134    pub fn principal(mut self, input: crate::types::DataLakePrincipal) -> Self {
135        self.inner = self.inner.principal(input);
136        self
137    }
138    /// <p>Specifies a principal to filter the permissions returned.</p>
139    pub fn set_principal(mut self, input: ::std::option::Option<crate::types::DataLakePrincipal>) -> Self {
140        self.inner = self.inner.set_principal(input);
141        self
142    }
143    /// <p>Specifies a principal to filter the permissions returned.</p>
144    pub fn get_principal(&self) -> &::std::option::Option<crate::types::DataLakePrincipal> {
145        self.inner.get_principal()
146    }
147    /// <p>Specifies a resource type to filter the permissions returned.</p>
148    pub fn resource_type(mut self, input: crate::types::DataLakeResourceType) -> Self {
149        self.inner = self.inner.resource_type(input);
150        self
151    }
152    /// <p>Specifies a resource type to filter the permissions returned.</p>
153    pub fn set_resource_type(mut self, input: ::std::option::Option<crate::types::DataLakeResourceType>) -> Self {
154        self.inner = self.inner.set_resource_type(input);
155        self
156    }
157    /// <p>Specifies a resource type to filter the permissions returned.</p>
158    pub fn get_resource_type(&self) -> &::std::option::Option<crate::types::DataLakeResourceType> {
159        self.inner.get_resource_type()
160    }
161    /// <p>A resource where you will get a list of the principal permissions.</p>
162    /// <p>This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.</p>
163    pub fn resource(mut self, input: crate::types::Resource) -> Self {
164        self.inner = self.inner.resource(input);
165        self
166    }
167    /// <p>A resource where you will get a list of the principal permissions.</p>
168    /// <p>This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.</p>
169    pub fn set_resource(mut self, input: ::std::option::Option<crate::types::Resource>) -> Self {
170        self.inner = self.inner.set_resource(input);
171        self
172    }
173    /// <p>A resource where you will get a list of the principal permissions.</p>
174    /// <p>This operation does not support getting privileges on a table with columns. Instead, call this operation on the table, and the operation returns the table and the table w columns.</p>
175    pub fn get_resource(&self) -> &::std::option::Option<crate::types::Resource> {
176        self.inner.get_resource()
177    }
178    /// <p>A continuation token, if this is not the first call to retrieve this list.</p>
179    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180        self.inner = self.inner.next_token(input.into());
181        self
182    }
183    /// <p>A continuation token, if this is not the first call to retrieve this list.</p>
184    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
185        self.inner = self.inner.set_next_token(input);
186        self
187    }
188    /// <p>A continuation token, if this is not the first call to retrieve this list.</p>
189    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
190        self.inner.get_next_token()
191    }
192    /// <p>The maximum number of results to return.</p>
193    pub fn max_results(mut self, input: i32) -> Self {
194        self.inner = self.inner.max_results(input);
195        self
196    }
197    /// <p>The maximum number of results to return.</p>
198    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
199        self.inner = self.inner.set_max_results(input);
200        self
201    }
202    /// <p>The maximum number of results to return.</p>
203    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
204        self.inner.get_max_results()
205    }
206    /// <p>Indicates that related permissions should be included in the results when listing permissions on a table resource.</p>
207    /// <p>Set the field to <code>TRUE</code> to show the cell filters on a table resource. Default is <code>FALSE</code>. The Principal parameter must not be specified when requesting cell filter information.</p>
208    pub fn include_related(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
209        self.inner = self.inner.include_related(input.into());
210        self
211    }
212    /// <p>Indicates that related permissions should be included in the results when listing permissions on a table resource.</p>
213    /// <p>Set the field to <code>TRUE</code> to show the cell filters on a table resource. Default is <code>FALSE</code>. The Principal parameter must not be specified when requesting cell filter information.</p>
214    pub fn set_include_related(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
215        self.inner = self.inner.set_include_related(input);
216        self
217    }
218    /// <p>Indicates that related permissions should be included in the results when listing permissions on a table resource.</p>
219    /// <p>Set the field to <code>TRUE</code> to show the cell filters on a table resource. Default is <code>FALSE</code>. The Principal parameter must not be specified when requesting cell filter information.</p>
220    pub fn get_include_related(&self) -> &::std::option::Option<::std::string::String> {
221        self.inner.get_include_related()
222    }
223}
aws_sdk_lakeformation/operation/list_permissions/builders.rs

aws_sdk_lakeformation/operation/list_permissions/
builders.rs
