« blib/lib/Paws/WorkDocs/Activity.pm
↑ Summary
blib/lib/Paws/WorkDocs/AddResourcePermissionsResponse.pm »
| 1 | |||
| 2 | package Paws::WorkDocs::AddResourcePermissions; | ||
| 3 | use Moose; | ||
| 4 | has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication'); | ||
| 5 | has NotificationOptions => (is => 'ro', isa => 'Paws::WorkDocs::NotificationOptions'); | ||
| 6 | has Principals => (is => 'ro', isa => 'ArrayRef[Paws::WorkDocs::SharePrincipal]', required => 1); | ||
| 7 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'ResourceId', required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'AddResourcePermissions'); | ||
| 12 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/resources/{ResourceId}/permissions'); | ||
| 13 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::AddResourcePermissionsResponse'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::WorkDocs::AddResourcePermissions - Arguments for method AddResourcePermissions on L<Paws::WorkDocs> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method AddResourcePermissions on the | ||
| 26 | L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class | ||
| 27 | as arguments to method AddResourcePermissions. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AddResourcePermissions. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $workdocs = Paws->service('WorkDocs'); | ||
| 34 | my $AddResourcePermissionsResponse = $workdocs->AddResourcePermissions( | ||
| 35 | Principals => [ | ||
| 36 | { | ||
| 37 | Id => 'MyIdType', # min: 1, max: 256 | ||
| 38 | Role => 'VIEWER', # values: VIEWER, CONTRIBUTOR, OWNER, COOWNER | ||
| 39 | Type => 'USER', # values: USER, GROUP, INVITE, ANONYMOUS, ORGANIZATION | ||
| 40 | |||
| 41 | }, | ||
| 42 | ... | ||
| 43 | ], | ||
| 44 | ResourceId => 'MyResourceIdType', | ||
| 45 | AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL | ||
| 46 | NotificationOptions => { | ||
| 47 | EmailMessage => 'MyMessageType', # max: 2048; OPTIONAL | ||
| 48 | SendEmail => 1, # OPTIONAL | ||
| 49 | }, # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $ShareResults = $AddResourcePermissionsResponse->ShareResults; | ||
| 54 | |||
| 55 | # Returns a L<Paws::WorkDocs::AddResourcePermissionsResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/AddResourcePermissions> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 AuthenticationToken => Str | ||
| 64 | |||
| 65 | Amazon WorkDocs authentication token. Not required when using AWS | ||
| 66 | administrator credentials to access the API. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 NotificationOptions => L<Paws::WorkDocs::NotificationOptions> | ||
| 71 | |||
| 72 | The notification options. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Principals => ArrayRef[L<Paws::WorkDocs::SharePrincipal>] | ||
| 77 | |||
| 78 | The users, groups, or organization being granted permission. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 B<REQUIRED> ResourceId => Str | ||
| 83 | |||
| 84 | The ID of the resource. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, documenting arguments for method AddResourcePermissions in L<Paws::WorkDocs> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |