aws_sdk_workmail/client/
list_mailbox_permissions.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListMailboxPermissions`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::set_organization_id):<br>required: **true**<br><p>The identifier of the organization under which the user, group, or resource exists.</p><br>
    ///   - [`entity_id(impl Into<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::set_entity_id):<br>required: **true**<br><p>The identifier of the user, or resource for which to list mailbox permissions.</p> <p>The entity ID can accept <i>UserId or ResourceId</i>, <i>Username or Resourcename</i>, or <i>email</i>.</p> <ul>  <li>   <p>Entity ID: 12345678-1234-1234-1234-123456789012, or r-0123456789a0123456789b0123456789</p></li>  <li>   <p>Email address: entity@domain.tld</p></li>  <li>   <p>Entity name: entity</p></li> </ul><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next page of results. The first call does not contain any tokens.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in a single call.</p><br>
    /// - On success, responds with [`ListMailboxPermissionsOutput`](crate::operation::list_mailbox_permissions::ListMailboxPermissionsOutput) with field(s):
    ///   - [`permissions(Option<Vec::<Permission>>)`](crate::operation::list_mailbox_permissions::ListMailboxPermissionsOutput::permissions): <p>One page of the user, group, or resource mailbox permissions.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_mailbox_permissions::ListMailboxPermissionsOutput::next_token): <p>The token to use to retrieve the next page of results. The value is "null" when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListMailboxPermissionsError>`](crate::operation::list_mailbox_permissions::ListMailboxPermissionsError)
    pub fn list_mailbox_permissions(&self) -> crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder {
        crate::operation::list_mailbox_permissions::builders::ListMailboxPermissionsFluentBuilder::new(self.handle.clone())
    }
}