File Coverage

blib/lib/Paws/SQS/AddPermission.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SQS::AddPermission;
3 1     1   633 use Moose;
  1     1   3  
  1         11  
  1         679  
  1         3  
  1         9  
4             has Actions => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
5             has AWSAccountIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
6             has Label => (is => 'ro', isa => 'Str', required => 1);
7             has QueueUrl => (is => 'ro', isa => 'Str', required => 1);
8              
9 1     1   8717 use MooseX::ClassAttribute;
  1     1   5  
  1         16  
  1         7244  
  1         3  
  1         8  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'AddPermission');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
13             class_has _result_key => (isa => 'Str', is => 'ro');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::SQS::AddPermission - Arguments for method AddPermission on Paws::SQS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method AddPermission on the
25             Amazon Simple Queue Service service. Use the attributes of this class
26             as arguments to method AddPermission.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to AddPermission.
29              
30             As an example:
31              
32             $service_obj->AddPermission(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> Actions => ArrayRef[Str|Undef]
40              
41             The action the client wants to allow for the specified principal. The
42             following values are valid:
43              
44             =over
45              
46             =item *
47              
48             C<*>
49              
50             =item *
51              
52             C<ChangeMessageVisibility>
53              
54             =item *
55              
56             C<DeleteMessage>
57              
58             =item *
59              
60             C<GetQueueAttributes>
61              
62             =item *
63              
64             C<GetQueueUrl>
65              
66             =item *
67              
68             C<ReceiveMessage>
69              
70             =item *
71              
72             C<SendMessage>
73              
74             =back
75              
76             For more information about these actions, see Understanding Permissions
77             in the I<Amazon SQS Developer Guide>.
78              
79             Specifying C<SendMessage>, C<DeleteMessage>, or
80             C<ChangeMessageVisibility> for C<ActionName.n> also grants permissions
81             for the corresponding batch versions of those actions:
82             C<SendMessageBatch>, C<DeleteMessageBatch>, and
83             C<ChangeMessageVisibilityBatch>.
84              
85              
86              
87             =head2 B<REQUIRED> AWSAccountIds => ArrayRef[Str|Undef]
88              
89             The AWS account number of the principal who is given permission. The
90             principal must have an AWS account, but does not need to be signed up
91             for Amazon SQS. For information about locating the AWS account
92             identification, see Your AWS Identifiers in the I<Amazon SQS Developer
93             Guide>.
94              
95              
96              
97             =head2 B<REQUIRED> Label => Str
98              
99             The unique identification of the permission you're setting (for
100             example, C<AliceSendMessage>). Maximum 80 characters. Allowed
101             characters include alphanumeric characters, hyphens (C<->), and
102             underscores (C<_>).
103              
104              
105              
106             =head2 B<REQUIRED> QueueUrl => Str
107              
108             The URL of the Amazon SQS queue to which permissions are added.
109              
110             Queue URLs are case-sensitive.
111              
112              
113              
114              
115             =head1 SEE ALSO
116              
117             This class forms part of L<Paws>, documenting arguments for method AddPermission in L<Paws::SQS>
118              
119             =head1 BUGS and CONTRIBUTIONS
120              
121             The source code is located here: https://github.com/pplu/aws-sdk-perl
122              
123             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
124              
125             =cut
126