Class: Aws::WorkMail::Types::PutMailboxPermissionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#entity_id ⇒ String

The identifier of the user or resource for which to update mailbox permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

  • Entity ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: entity@domain.tld

  • Entity name: entity

Returns:

  • (String) 


4170
4171
4172
4173
4174
4175
4176
4177
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 4170

class PutMailboxPermissionsRequest < Struct.new(
  :organization_id,
  :entity_id,
  :grantee_id,
  :permission_values)
  SENSITIVE = []
  include Aws::Structure
end

#grantee_id ⇒ String

The identifier of the user, group, or resource to which to grant the permissions.

The identifier can be UserId, ResourceID, or Group Id, Username, Resourcename, or Groupname, or email.

  • Grantee ID: 12345678-1234-1234-1234-123456789012, r-0123456789a0123456789b0123456789, or S-1-1-12-1234567890-123456789-123456789-1234

  • Email address: grantee@domain.tld

  • Grantee name: grantee

Returns:

  • (String) 


4170
4171
4172
4173
4174
4175
4176
4177
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 4170

class PutMailboxPermissionsRequest < Struct.new(
  :organization_id,
  :entity_id,
  :grantee_id,
  :permission_values)
  SENSITIVE = []
  include Aws::Structure
end

#organization_id ⇒ String

The identifier of the organization under which the user, group, or resource exists.

Returns:

  • (String) 


4170
4171
4172
4173
4174
4175
4176
4177
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 4170

class PutMailboxPermissionsRequest < Struct.new(
  :organization_id,
  :entity_id,
  :grantee_id,
  :permission_values)
  SENSITIVE = []
  include Aws::Structure
end

#permission_values ⇒ Array<String>

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.

Returns:

  • (Array<String>) 


4170
4171
4172
4173
4174
4175
4176
4177
 
# File 'gems/aws-sdk-workmail/lib/aws-sdk-workmail/types.rb', line 4170

class PutMailboxPermissionsRequest < Struct.new(
  :organization_id,
  :entity_id,
  :grantee_id,
  :permission_values)
  SENSITIVE = []
  include Aws::Structure
end