« blib/lib/Paws/WorkMail/PutAccessControlRuleResponse.pm
↑ Summary
blib/lib/Paws/WorkMail/PutMailboxPermissionsResponse.pm »
| 1 | |||
| 2 | package Paws::WorkMail::PutMailboxPermissions; | ||
| 3 | use Moose; | ||
| 4 | has EntityId => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has GranteeId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has OrganizationId => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has PermissionValues => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutMailboxPermissions'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkMail::PutMailboxPermissionsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::WorkMail::PutMailboxPermissions - Arguments for method PutMailboxPermissions on L<Paws::WorkMail> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method PutMailboxPermissions on the | ||
| 25 | L<Amazon WorkMail|Paws::WorkMail> service. Use the attributes of this class | ||
| 26 | as arguments to method PutMailboxPermissions. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutMailboxPermissions. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $workmail = Paws->service('WorkMail'); | ||
| 33 | my $PutMailboxPermissionsResponse = $workmail->PutMailboxPermissions( | ||
| 34 | EntityId => 'MyWorkMailIdentifier', | ||
| 35 | GranteeId => 'MyWorkMailIdentifier', | ||
| 36 | OrganizationId => 'MyOrganizationId', | ||
| 37 | PermissionValues => [ | ||
| 38 | 'FULL_ACCESS', ... # values: FULL_ACCESS, SEND_AS, SEND_ON_BEHALF | ||
| 39 | ], | ||
| 40 | |||
| 41 | ); | ||
| 42 | |||
| 43 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workmail/PutMailboxPermissions> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 B<REQUIRED> EntityId => Str | ||
| 50 | |||
| 51 | The identifier of the user, group, or resource for which to update | ||
| 52 | mailbox permissions. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> GranteeId => Str | ||
| 57 | |||
| 58 | The identifier of the user, group, or resource to which to grant the | ||
| 59 | permissions. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> OrganizationId => Str | ||
| 64 | |||
| 65 | The identifier of the organization under which the user, group, or | ||
| 66 | resource exists. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> PermissionValues => ArrayRef[Str|Undef] | ||
| 71 | |||
| 72 | The permissions granted to the grantee. SEND_AS allows the grantee to | ||
| 73 | send email as the owner of the mailbox (the grantee is not mentioned on | ||
| 74 | these emails). SEND_ON_BEHALF allows the grantee to send email on | ||
| 75 | behalf of the owner of the mailbox (the grantee is not mentioned as the | ||
| 76 | physical sender of these emails). FULL_ACCESS allows the grantee full | ||
| 77 | access to the mailbox, irrespective of other folder-level permissions | ||
| 78 | set on the mailbox. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method PutMailboxPermissions in L<Paws::WorkMail> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |