File Coverage

blib/lib/Paws/SQS/SetQueueAttributes.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::SQS::SetQueueAttributes;
3 1     1   289 use Moose;
  1         2  
  1         5  
4             has Attributes => (is => 'ro', isa => 'Paws::SQS::QueueAttributeMap', traits => ['NameInRequest'], request_name => 'Attribute' , required => 1);
5             has QueueUrl => (is => 'ro', isa => 'Str', required => 1);
6              
7 1     1   5382 use MooseX::ClassAttribute;
  1         2  
  1         6  
8              
9             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetQueueAttributes');
10             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response');
11             class_has _result_key => (isa => 'Str', is => 'ro');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::SQS::SetQueueAttributes - Arguments for method SetQueueAttributes on Paws::SQS
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method SetQueueAttributes on the
23             Amazon Simple Queue Service service. Use the attributes of this class
24             as arguments to method SetQueueAttributes.
25              
26             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetQueueAttributes.
27              
28             As an example:
29              
30             $service_obj->SetQueueAttributes(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 B<REQUIRED> Attributes => L<Paws::SQS::QueueAttributeMap>
38              
39             A map of attributes to set.
40              
41             The following lists the names, descriptions, and values of the special
42             request parameters that the C<SetQueueAttributes> action uses:
43              
44             =over
45              
46             =item *
47              
48             C<DelaySeconds> - The length of time, in seconds, for which the
49             delivery of all messages in the queue is delayed. Valid values: An
50             integer from 0 to 900 (15 minutes). The default is 0 (zero).
51              
52             =item *
53              
54             C<MaximumMessageSize> - The limit of how many bytes a message can
55             contain before Amazon SQS rejects it. Valid values: An integer from
56             1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). The default is
57             262,144 (256 KiB).
58              
59             =item *
60              
61             C<MessageRetentionPeriod> - The length of time, in seconds, for which
62             Amazon SQS retains a message. Valid values: An integer representing
63             seconds, from 60 (1 minute) to 1,209,600 (14 days). The default is
64             345,600 (4 days).
65              
66             =item *
67              
68             C<Policy> - The queue's policy. A valid AWS policy. For more
69             information about policy structure, see Overview of AWS IAM Policies in
70             the I<Amazon IAM User Guide>.
71              
72             =item *
73              
74             C<ReceiveMessageWaitTimeSeconds> - The length of time, in seconds, for
75             which a C< ReceiveMessage > action waits for a message to arrive. Valid
76             values: an integer from 0 to 20 (seconds). The default is 0.
77              
78             =item *
79              
80             C<RedrivePolicy> - The string that includes the parameters for the
81             dead-letter queue functionality of the source queue. For more
82             information about the redrive policy and dead-letter queues, see Using
83             Amazon SQS Dead-Letter Queues in the I<Amazon SQS Developer Guide>.
84              
85             =over
86              
87             =item *
88              
89             C<deadLetterTargetArn> - The Amazon Resource Name (ARN) of the
90             dead-letter queue to which Amazon SQS moves messages after the value of
91             C<maxReceiveCount> is exceeded.
92              
93             =item *
94              
95             C<maxReceiveCount> - The number of times a message is delivered to the
96             source queue before being moved to the dead-letter queue.
97              
98             =back
99              
100             The dead-letter queue of a FIFO queue must also be a FIFO queue.
101             Similarly, the dead-letter queue of a standard queue must also be a
102             standard queue.
103              
104             =item *
105              
106             C<VisibilityTimeout> - The visibility timeout for the queue. Valid
107             values: an integer from 0 to 43,200 (12 hours). The default is 30. For
108             more information about the visibility timeout, see Visibility Timeout
109             in the I<Amazon SQS Developer Guide>.
110              
111             =back
112              
113             The following attributes apply only to server-side-encryption:
114              
115             =over
116              
117             =item *
118              
119             C<KmsMasterKeyId> - The ID of an AWS-managed customer master key (CMK)
120             for Amazon SQS or a custom CMK. For more information, see Key Terms.
121             While the alias of the AWS-managed CMK for Amazon SQS is always
122             C<alias/aws/sqs>, the alias of a custom CMK can, for example, be
123             C<alias/I<MyAlias> >. For more examples, see KeyId in the I<AWS Key
124             Management Service API Reference>.
125              
126             =item *
127              
128             C<KmsDataKeyReusePeriodSeconds> - The length of time, in seconds, for
129             which Amazon SQS can reuse a data key to encrypt or decrypt messages
130             before calling AWS KMS again. An integer representing seconds, between
131             60 seconds (1 minute) and 86,400 seconds (24 hours). The default is 300
132             (5 minutes). A shorter time period provides better security but results
133             in more calls to KMS which might incur charges after Free Tier. For
134             more information, see How Does the Data Key Reuse Period Work?.
135              
136             =back
137              
138             The following attribute applies only to FIFO (first-in-first-out)
139             queues:
140              
141             =over
142              
143             =item *
144              
145             C<ContentBasedDeduplication> - Enables content-based deduplication. For
146             more information, see Exactly-Once Processing in the I<Amazon SQS
147             Developer Guide>.
148              
149             =over
150              
151             =item *
152              
153             Every message must have a unique C<MessageDeduplicationId>,
154              
155             =over
156              
157             =item *
158              
159             You may provide a C<MessageDeduplicationId> explicitly.
160              
161             =item *
162              
163             If you aren't able to provide a C<MessageDeduplicationId> and you
164             enable C<ContentBasedDeduplication> for your queue, Amazon SQS uses a
165             SHA-256 hash to generate the C<MessageDeduplicationId> using the body
166             of the message (but not the attributes of the message).
167              
168             =item *
169              
170             If you don't provide a C<MessageDeduplicationId> and the queue doesn't
171             have C<ContentBasedDeduplication> set, the action fails with an error.
172              
173             =item *
174              
175             If the queue has C<ContentBasedDeduplication> set, your
176             C<MessageDeduplicationId> overrides the generated one.
177              
178             =back
179              
180             =item *
181              
182             When C<ContentBasedDeduplication> is in effect, messages with identical
183             content sent within the deduplication interval are treated as
184             duplicates and only one copy of the message is delivered.
185              
186             =item *
187              
188             If you send one message with C<ContentBasedDeduplication> enabled and
189             then another message with a C<MessageDeduplicationId> that is the same
190             as the one generated for the first C<MessageDeduplicationId>, the two
191             messages are treated as duplicates and only one copy of the message is
192             delivered.
193              
194             =back
195              
196             =back
197              
198             Any other valid special request parameters (such as the following) are
199             ignored:
200              
201             =over
202              
203             =item *
204              
205             C<ApproximateNumberOfMessages>
206              
207             =item *
208              
209             C<ApproximateNumberOfMessagesDelayed>
210              
211             =item *
212              
213             C<ApproximateNumberOfMessagesNotVisible>
214              
215             =item *
216              
217             C<CreatedTimestamp>
218              
219             =item *
220              
221             C<LastModifiedTimestamp>
222              
223             =item *
224              
225             C<QueueArn>
226              
227             =back
228              
229              
230              
231              
232             =head2 B<REQUIRED> QueueUrl => Str
233              
234             The URL of the Amazon SQS queue whose attributes are set.
235              
236             Queue URLs are case-sensitive.
237              
238              
239              
240              
241             =head1 SEE ALSO
242              
243             This class forms part of L<Paws>, documenting arguments for method SetQueueAttributes in L<Paws::SQS>
244              
245             =head1 BUGS and CONTRIBUTIONS
246              
247             The source code is located here: https://github.com/pplu/aws-sdk-perl
248              
249             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
250              
251             =cut
252