aws_sdk_workmail/client/
put_mailbox_permissions.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`PutMailboxPermissions`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`organization_id(impl Into<String>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::organization_id) / [`set_organization_id(Option<String>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::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::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::entity_id) / [`set_entity_id(Option<String>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::set_entity_id):<br>required: **true**<br><p>The identifier of the user or resource for which to update mailbox permissions.</p> <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p> <ul>  <li>   <p>Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: entity@domain.tld</p></li>  <li>   <p>Entity name: entity</p></li> </ul><br>
    ///   - [`grantee_id(impl Into<String>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::grantee_id) / [`set_grantee_id(Option<String>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::set_grantee_id):<br>required: **true**<br><p>The identifier of the user, group, or resource to which to grant the permissions.</p> <p>The identifier can be <i>UserId, ResourceID, or Group Id</i>, <i>Username, Resourcename, or Groupname</i>, or <i>email</i>.</p> <ul>  <li>   <p>Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234</p></li>  <li>   <p>Email address: grantee@domain.tld</p></li>  <li>   <p>Grantee name: grantee</p></li> </ul><br>
    ///   - [`permission_values(PermissionType)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::permission_values) / [`set_permission_values(Option<Vec::<PermissionType>>)`](crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::set_permission_values):<br>required: **true**<br><p>The permissions granted to the grantee. SEND_AS allows the grantee to send email as the owner of the mailbox (the grantee is not mentioned on these emails). SEND_ON_BEHALF allows the grantee to send email on behalf of the owner of the mailbox (the grantee is not mentioned as the physical sender of these emails). FULL_ACCESS allows the grantee full access to the mailbox, irrespective of other folder-level permissions set on the mailbox.</p><br>
    /// - On success, responds with [`PutMailboxPermissionsOutput`](crate::operation::put_mailbox_permissions::PutMailboxPermissionsOutput)
    /// - On failure, responds with [`SdkError<PutMailboxPermissionsError>`](crate::operation::put_mailbox_permissions::PutMailboxPermissionsError)
    pub fn put_mailbox_permissions(&self) -> crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder {
        crate::operation::put_mailbox_permissions::builders::PutMailboxPermissionsFluentBuilder::new(self.handle.clone())
    }
}