File Coverage

blib/lib/Paws/SQS/GetQueueAttributes.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	sub	time	code
1
2				package Paws::SQS::GetQueueAttributes;
3	1	1	698	use Moose;
	1	1	3
	1		12
	1		630
	1		3
	1		8
4				has AttributeNames => (is => 'ro', isa => 'ArrayRef[Str\|Undef]');
5				has QueueUrl => (is => 'ro', isa => 'Str', required => 1);
6
7	1	1	10648	use MooseX::ClassAttribute;
	1	1	6
	1		15
	1		7702
	1		5
	1		13
8
9				class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetQueueAttributes');
10				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SQS::GetQueueAttributesResult');
11				class_has _result_key => (isa => 'Str', is => 'ro', default => 'GetQueueAttributesResult');
12				1;
13
14				### main pod documentation begin ###
15
16				=head1 NAME
17
18				Paws::SQS::GetQueueAttributes - Arguments for method GetQueueAttributes on Paws::SQS
19
20				=head1 DESCRIPTION
21
22				This class represents the parameters used for calling the method GetQueueAttributes on the
23				Amazon Simple Queue Service service. Use the attributes of this class
24				as arguments to method GetQueueAttributes.
25
26				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetQueueAttributes.
27
28				As an example:
29
30				$service_obj->GetQueueAttributes(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 AttributeNames => ArrayRef[Str\|Undef]
38
39				A list of attributes for which to retrieve information.
40
41				In the future, new attributes might be added. If you write code that
42				calls this action, we recommend that you structure your code so that it
43				can handle new attributes gracefully.
44
45				The following attributes are supported:
46
47				=over
48
49				=item *
50
51				C<All> - Returns all values.
52
53				=item *
54
55				C<ApproximateNumberOfMessages> - Returns the approximate number of
56				visible messages in a queue. For more information, see Resources
57				Required to Process Messages in the I<Amazon SQS Developer Guide>.
58
59				=item *
60
61				C<ApproximateNumberOfMessagesDelayed> - Returns the approximate number
62				of messages that are waiting to be added to the queue.
63
64				=item *
65
66				C<ApproximateNumberOfMessagesNotVisible> - Returns the approximate
67				number of messages that have not timed-out and aren't deleted. For more
68				information, see Resources Required to Process Messages in the I<Amazon
69				SQS Developer Guide>.
70
71				=item *
72
73				C<CreatedTimestamp> - Returns the time when the queue was created in
74				seconds (epoch time).
75
76				=item *
77
78				C<DelaySeconds> - Returns the default delay on the queue in seconds.
79
80				=item *
81
82				C<LastModifiedTimestamp> - Returns the time when the queue was last
83				changed in seconds (epoch time).
84
85				=item *
86
87				C<MaximumMessageSize> - Returns the limit of how many bytes a message
88				can contain before Amazon SQS rejects it.
89
90				=item *
91
92				C<MessageRetentionPeriod> - Returns the length of time, in seconds, for
93				which Amazon SQS retains a message.
94
95				=item *
96
97				C<Policy> - Returns the policy of the queue.
98
99				=item *
100
101				C<QueueArn> - Returns the Amazon resource name (ARN) of the queue.
102
103				=item *
104
105				C<ReceiveMessageWaitTimeSeconds> - Returns the length of time, in
106				seconds, for which the C<ReceiveMessage> action waits for a message to
107				arrive.
108
109				=item *
110
111				C<RedrivePolicy> - Returns the parameters for dead letter queue
112				functionality of the source queue. For more information about the
113				redrive policy and dead letter queues, see Using Amazon SQS Dead Letter
114				Queues in the I<Amazon SQS Developer Guide>.
115
116				=item *
117
118				C<VisibilityTimeout> - Returns the visibility timeout for the queue.
119				For more information about the visibility timeout, see Visibility
120				Timeout in the I<Amazon SQS Developer Guide>.
121
122				=back
123
124				The following attributes apply only to server-side-encryption:
125
126				=over
127
128				=item *
129
130				C<KmsMasterKeyId> - Returns the ID of an AWS-managed customer master
131				key (CMK) for Amazon SQS or a custom CMK. For more information, see Key
132				Terms.
133
134				=item *
135
136				C<KmsDataKeyReusePeriodSeconds> - Returns the length of time, in
137				seconds, for which Amazon SQS can reuse a data key to encrypt or
138				decrypt messages before calling AWS KMS again.
139
140				=back
141
142				The following attributes apply only to FIFO (first-in-first-out)
143				queues:
144
145				=over
146
147				=item *
148
149				C<FifoQueue> - Returns whether the queue is FIFO. For more information,
150				see FIFO Queue Logic in the I<Amazon SQS Developer Guide>.
151
152				To determine whether a queue is FIFO, you can check whether
153				C<QueueName> ends with the C<.fifo> suffix.
154
155				=item *
156
157				C<ContentBasedDeduplication> - Returns whether content-based
158				deduplication is enabled for the queue. For more information, see
159				Exactly-Once Processing in the I<Amazon SQS Developer Guide>.
160
161				=back
162
163
164
165
166				=head2 B<REQUIRED> QueueUrl => Str
167
168				The URL of the Amazon SQS queue whose attribute information is
169				retrieved.
170
171				Queue URLs are case-sensitive.
172
173
174
175
176				=head1 SEE ALSO
177
178				This class forms part of L<Paws>, documenting arguments for method GetQueueAttributes in L<Paws::SQS>
179
180				=head1 BUGS and CONTRIBUTIONS
181
182				The source code is located here: https://github.com/pplu/aws-sdk-perl
183
184				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
185
186				=cut
187