| 1 | package Paws::SQS; | ||||||||||||||||||||||||||||
| 2 | 6 | ▶ | use Moose; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 3 | 28 | ▶ | sub service { 'sqs' } | ||||||||||||||||||||||||||
|
Subroutine
service: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 4 | 5 | ▶ | sub signing_name { 'sqs' } | ||||||||||||||||||||||||||
|
Subroutine
signing_name: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 5 | 5 | ▶ | sub version { '2012-11-05' } | ||||||||||||||||||||||||||
|
Subroutine
version: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 6 | 8 | ▶ | sub flattened_arrays { 1 } | ||||||||||||||||||||||||||
|
Subroutine
flattened_arrays: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||||||||||||||||||||
| 7 | 6 | has max_attempts => (is => 'ro', isa => 'Int', default => 5); | |||||||||||||||||||||||||||
| 8 | 28 | ▶ | has retry => (is => 'ro', isa => 'HashRef', default => sub { | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 9 | 28 | { base => 'rand', type => 'exponential', growth_factor => 2 } | |||||||||||||||||||||||||||
| 10 | 6 | }); | |||||||||||||||||||||||||||
| 11 | 28 | ▶ | has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.5
| |||||||||||||||||||||||||||||
| 12 | 4 | ▶ | sub { defined $_[0]->http_status and $_[0]->http_status == 403 and $_[0]->code eq 'RequestThrottled' }, | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=3 SCAR=14.2
Branch: 1 branch
Condition33%1/3
defined $_[0]->http_status and $_[0]->http_status == 403
MC/DC0%0/2
defined $_[0]->http_status and $_[0]->http_status == 403
defined $_[0]->http_status
$_[0]->http_status == 403
Truth table33%1/3
A and B
A= defined $_[0]->http_statusB= $_[0]->http_status == 403
| |||||||||||||||||||||||||||||
| 13 | 28 | ] }); | |||||||||||||||||||||||||||
| 14 | |||||||||||||||||||||||||||||
| 15 | 6 | with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::QueryCaller'; | |||||||||||||||||||||||||||
| 16 | |||||||||||||||||||||||||||||
| 17 | 28 | ▶ | has '+region_rules' => (default => sub { | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 18 | 28 | my $regioninfo; | |||||||||||||||||||||||||||
| 19 | 28 | $regioninfo = [ | |||||||||||||||||||||||||||
| 20 | { | ||||||||||||||||||||||||||||
| 21 | constraints => [ | ||||||||||||||||||||||||||||
| 22 | [ | ||||||||||||||||||||||||||||
| 23 | 'region', | ||||||||||||||||||||||||||||
| 24 | 'equals', | ||||||||||||||||||||||||||||
| 25 | 'us-east-1' | ||||||||||||||||||||||||||||
| 26 | ] | ||||||||||||||||||||||||||||
| 27 | ], | ||||||||||||||||||||||||||||
| 28 | uri => 'https://queue.amazonaws.com' | ||||||||||||||||||||||||||||
| 29 | }, | ||||||||||||||||||||||||||||
| 30 | { | ||||||||||||||||||||||||||||
| 31 | constraints => [ | ||||||||||||||||||||||||||||
| 32 | [ | ||||||||||||||||||||||||||||
| 33 | 'region', | ||||||||||||||||||||||||||||
| 34 | 'startsWith', | ||||||||||||||||||||||||||||
| 35 | 'cn-' | ||||||||||||||||||||||||||||
| 36 | ] | ||||||||||||||||||||||||||||
| 37 | ], | ||||||||||||||||||||||||||||
| 38 | uri => 'https://{region}.queue.amazonaws.com.cn' | ||||||||||||||||||||||||||||
| 39 | }, | ||||||||||||||||||||||||||||
| 40 | { | ||||||||||||||||||||||||||||
| 41 | constraints => [ | ||||||||||||||||||||||||||||
| 42 | [ | ||||||||||||||||||||||||||||
| 43 | 'region', | ||||||||||||||||||||||||||||
| 44 | 'notEquals', | ||||||||||||||||||||||||||||
| 45 | undef | ||||||||||||||||||||||||||||
| 46 | ] | ||||||||||||||||||||||||||||
| 47 | ], | ||||||||||||||||||||||||||||
| 48 | uri => 'https://{region}.queue.amazonaws.com' | ||||||||||||||||||||||||||||
| 49 | } | ||||||||||||||||||||||||||||
| 50 | ]; | ||||||||||||||||||||||||||||
| 51 | |||||||||||||||||||||||||||||
| 52 | 28 | return $regioninfo; | |||||||||||||||||||||||||||
| 53 | 6 | }); | |||||||||||||||||||||||||||
| 54 | |||||||||||||||||||||||||||||
| 55 | |||||||||||||||||||||||||||||
| 56 | 1 | ▶ | sub AddPermission { | ||||||||||||||||||||||||||
|
Subroutine
AddPermission: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 57 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 58 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::AddPermission', @_); | |||||||||||||||||||||||||||
| 59 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 60 | } | ||||||||||||||||||||||||||||
| 61 | 0 | ▶ | sub ChangeMessageVisibility { | ||||||||||||||||||||||||||
|
Subroutine
ChangeMessageVisibility: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 62 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 63 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::ChangeMessageVisibility', @_); | |||||||||||||||||||||||||||
| 64 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 65 | } | ||||||||||||||||||||||||||||
| 66 | 1 | ▶ | sub ChangeMessageVisibilityBatch { | ||||||||||||||||||||||||||
|
Subroutine
ChangeMessageVisibilityBatch: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 67 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 68 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::ChangeMessageVisibilityBatch', @_); | |||||||||||||||||||||||||||
| 69 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 70 | } | ||||||||||||||||||||||||||||
| 71 | 2 | ▶ | sub CreateQueue { | ||||||||||||||||||||||||||
|
Subroutine
CreateQueue: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 72 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 73 | 2 | my $call_object = $self->new_with_coercions('Paws::SQS::CreateQueue', @_); | |||||||||||||||||||||||||||
| 74 | 2 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 75 | } | ||||||||||||||||||||||||||||
| 76 | 0 | ▶ | sub DeleteMessage { | ||||||||||||||||||||||||||
|
Subroutine
DeleteMessage: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 77 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 78 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::DeleteMessage', @_); | |||||||||||||||||||||||||||
| 79 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 80 | } | ||||||||||||||||||||||||||||
| 81 | 1 | ▶ | sub DeleteMessageBatch { | ||||||||||||||||||||||||||
|
Subroutine
DeleteMessageBatch: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 82 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 83 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::DeleteMessageBatch', @_); | |||||||||||||||||||||||||||
| 84 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 85 | } | ||||||||||||||||||||||||||||
| 86 | 1 | ▶ | sub DeleteQueue { | ||||||||||||||||||||||||||
|
Subroutine
DeleteQueue: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 87 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 88 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::DeleteQueue', @_); | |||||||||||||||||||||||||||
| 89 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 90 | } | ||||||||||||||||||||||||||||
| 91 | 2 | ▶ | sub GetQueueAttributes { | ||||||||||||||||||||||||||
|
Subroutine
GetQueueAttributes: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 92 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 93 | 2 | my $call_object = $self->new_with_coercions('Paws::SQS::GetQueueAttributes', @_); | |||||||||||||||||||||||||||
| 94 | 2 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 95 | } | ||||||||||||||||||||||||||||
| 96 | 1 | ▶ | sub GetQueueUrl { | ||||||||||||||||||||||||||
|
Subroutine
GetQueueUrl: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 97 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 98 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::GetQueueUrl', @_); | |||||||||||||||||||||||||||
| 99 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 100 | } | ||||||||||||||||||||||||||||
| 101 | 0 | ▶ | sub ListDeadLetterSourceQueues { | ||||||||||||||||||||||||||
|
Subroutine
ListDeadLetterSourceQueues: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 102 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 103 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::ListDeadLetterSourceQueues', @_); | |||||||||||||||||||||||||||
| 104 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 105 | } | ||||||||||||||||||||||||||||
| 106 | 3 | ▶ | sub ListQueues { | ||||||||||||||||||||||||||
|
Subroutine
ListQueues: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 107 | 3 | my $self = shift; | |||||||||||||||||||||||||||
| 108 | 3 | my $call_object = $self->new_with_coercions('Paws::SQS::ListQueues', @_); | |||||||||||||||||||||||||||
| 109 | 3 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 110 | } | ||||||||||||||||||||||||||||
| 111 | 0 | ▶ | sub ListQueueTags { | ||||||||||||||||||||||||||
|
Subroutine
ListQueueTags: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 112 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 113 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::ListQueueTags', @_); | |||||||||||||||||||||||||||
| 114 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 115 | } | ||||||||||||||||||||||||||||
| 116 | 0 | ▶ | sub PurgeQueue { | ||||||||||||||||||||||||||
|
Subroutine
PurgeQueue: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 117 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 118 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::PurgeQueue', @_); | |||||||||||||||||||||||||||
| 119 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 120 | } | ||||||||||||||||||||||||||||
| 121 | 1 | ▶ | sub ReceiveMessage { | ||||||||||||||||||||||||||
|
Subroutine
ReceiveMessage: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 122 | 1 | my $self = shift; | |||||||||||||||||||||||||||
| 123 | 1 | my $call_object = $self->new_with_coercions('Paws::SQS::ReceiveMessage', @_); | |||||||||||||||||||||||||||
| 124 | 1 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 125 | } | ||||||||||||||||||||||||||||
| 126 | 0 | ▶ | sub RemovePermission { | ||||||||||||||||||||||||||
|
Subroutine
RemovePermission: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 127 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 128 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::RemovePermission', @_); | |||||||||||||||||||||||||||
| 129 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 130 | } | ||||||||||||||||||||||||||||
| 131 | 2 | ▶ | sub SendMessage { | ||||||||||||||||||||||||||
|
Subroutine
SendMessage: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 132 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 133 | 2 | my $call_object = $self->new_with_coercions('Paws::SQS::SendMessage', @_); | |||||||||||||||||||||||||||
| 134 | 2 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 135 | } | ||||||||||||||||||||||||||||
| 136 | 2 | ▶ | sub SendMessageBatch { | ||||||||||||||||||||||||||
|
Subroutine
SendMessageBatch: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 137 | 2 | my $self = shift; | |||||||||||||||||||||||||||
| 138 | 2 | my $call_object = $self->new_with_coercions('Paws::SQS::SendMessageBatch', @_); | |||||||||||||||||||||||||||
| 139 | 2 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 140 | } | ||||||||||||||||||||||||||||
| 141 | 0 | ▶ | sub SetQueueAttributes { | ||||||||||||||||||||||||||
|
Subroutine
SetQueueAttributes: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 142 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 143 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::SetQueueAttributes', @_); | |||||||||||||||||||||||||||
| 144 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 145 | } | ||||||||||||||||||||||||||||
| 146 | 0 | ▶ | sub TagQueue { | ||||||||||||||||||||||||||
|
Subroutine
TagQueue: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 147 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 148 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::TagQueue', @_); | |||||||||||||||||||||||||||
| 149 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 150 | } | ||||||||||||||||||||||||||||
| 151 | 0 | ▶ | sub UntagQueue { | ||||||||||||||||||||||||||
|
Subroutine
UntagQueue: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 152 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 153 | 0 | my $call_object = $self->new_with_coercions('Paws::SQS::UntagQueue', @_); | |||||||||||||||||||||||||||
| 154 | 0 | return $self->caller->do_call($self, $call_object); | |||||||||||||||||||||||||||
| 155 | } | ||||||||||||||||||||||||||||
| 156 | |||||||||||||||||||||||||||||
| 157 | 0 | ▶ | sub ListAllDeadLetterSourceQueues { | ||||||||||||||||||||||||||
|
Subroutine
ListAllDeadLetterSourceQueues: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||
| 158 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 159 | |||||||||||||||||||||||||||||
| 160 | 0 | ▶ | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 161 | 0 | my $result = $self->ListDeadLetterSourceQueues(@_); | |||||||||||||||||||||||||||
| 162 | 0 | my $next_result = $result; | |||||||||||||||||||||||||||
| 163 | |||||||||||||||||||||||||||||
| 164 | 0 | ▶ | if (not defined $callback) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 165 | 0 | ▶ | while ($next_result->NextToken) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 166 | 0 | $next_result = $self->ListDeadLetterSourceQueues(@_, NextToken => $next_result->NextToken); | |||||||||||||||||||||||||||
| 167 | 0 | push @{ $result->queueUrls }, @{ $next_result->queueUrls }; | |||||||||||||||||||||||||||
| 168 | } | ||||||||||||||||||||||||||||
| 169 | 0 | return $result; | |||||||||||||||||||||||||||
| 170 | } else { | ||||||||||||||||||||||||||||
| 171 | 0 | ▶ | while ($result->NextToken) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 172 | 0 | $callback->($_ => 'queueUrls') foreach (@{ $result->queueUrls }); | |||||||||||||||||||||||||||
| 173 | 0 | $result = $self->ListDeadLetterSourceQueues(@_, NextToken => $result->NextToken); | |||||||||||||||||||||||||||
| 174 | } | ||||||||||||||||||||||||||||
| 175 | 0 | $callback->($_ => 'queueUrls') foreach (@{ $result->queueUrls }); | |||||||||||||||||||||||||||
| 176 | } | ||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | return undef | ||||||||||||||||||||||||||||
| 179 | 0 | } | |||||||||||||||||||||||||||
| 180 | 0 | ▶ | sub ListAllQueues { | ||||||||||||||||||||||||||
|
Subroutine
ListAllQueues: not called CC=7 SCAR=40.3
Pod
documented
| |||||||||||||||||||||||||||||
| 181 | 0 | my $self = shift; | |||||||||||||||||||||||||||
| 182 | |||||||||||||||||||||||||||||
| 183 | 0 | ▶ | my $callback = shift @_ if (ref($_[0]) eq 'CODE'); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 184 | 0 | my $result = $self->ListQueues(@_); | |||||||||||||||||||||||||||
| 185 | 0 | my $next_result = $result; | |||||||||||||||||||||||||||
| 186 | |||||||||||||||||||||||||||||
| 187 | 0 | ▶ | if (not defined $callback) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 188 | 0 | ▶ | while ($next_result->NextToken) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 189 | 0 | $next_result = $self->ListQueues(@_, NextToken => $next_result->NextToken); | |||||||||||||||||||||||||||
| 190 | 0 | push @{ $result->QueueUrls }, @{ $next_result->QueueUrls }; | |||||||||||||||||||||||||||
| 191 | } | ||||||||||||||||||||||||||||
| 192 | 0 | return $result; | |||||||||||||||||||||||||||
| 193 | } else { | ||||||||||||||||||||||||||||
| 194 | 0 | ▶ | while ($result->NextToken) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 195 | 0 | $callback->($_ => 'QueueUrls') foreach (@{ $result->QueueUrls }); | |||||||||||||||||||||||||||
| 196 | 0 | $result = $self->ListQueues(@_, NextToken => $result->NextToken); | |||||||||||||||||||||||||||
| 197 | } | ||||||||||||||||||||||||||||
| 198 | 0 | $callback->($_ => 'QueueUrls') foreach (@{ $result->QueueUrls }); | |||||||||||||||||||||||||||
| 199 | } | ||||||||||||||||||||||||||||
| 200 | |||||||||||||||||||||||||||||
| 201 | return undef | ||||||||||||||||||||||||||||
| 202 | 0 | } | |||||||||||||||||||||||||||
| 203 | |||||||||||||||||||||||||||||
| 204 | |||||||||||||||||||||||||||||
| 205 | 0 | ▶ | sub operations { qw/AddPermission ChangeMessageVisibility ChangeMessageVisibilityBatch CreateQueue DeleteMessage DeleteMessageBatch DeleteQueue GetQueueAttributes GetQueueUrl ListDeadLetterSourceQueues ListQueues ListQueueTags PurgeQueue ReceiveMessage RemovePermission SendMessage SendMessageBatch SetQueueAttributes TagQueue UntagQueue / } | ||||||||||||||||||||||||||
|
Subroutine
operations: not called CC=1 SCAR=6.9
Pod
undocumented
| |||||||||||||||||||||||||||||
| 206 | |||||||||||||||||||||||||||||
| 207 | 6 | 1; | |||||||||||||||||||||||||||
| 208 | |||||||||||||||||||||||||||||
| 209 | ### main pod documentation begin ### | ||||||||||||||||||||||||||||
| 210 | |||||||||||||||||||||||||||||
| 211 | =head1 NAME | ||||||||||||||||||||||||||||
| 212 | |||||||||||||||||||||||||||||
| 213 | Paws::SQS - Perl Interface to AWS Amazon Simple Queue Service | ||||||||||||||||||||||||||||
| 214 | |||||||||||||||||||||||||||||
| 215 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 216 | |||||||||||||||||||||||||||||
| 217 | use Paws; | ||||||||||||||||||||||||||||
| 218 | |||||||||||||||||||||||||||||
| 219 | my $obj = Paws->service('SQS'); | ||||||||||||||||||||||||||||
| 220 | my $res = $obj->Method( | ||||||||||||||||||||||||||||
| 221 | Arg1 => $val1, | ||||||||||||||||||||||||||||
| 222 | Arg2 => [ 'V1', 'V2' ], | ||||||||||||||||||||||||||||
| 223 | # if Arg3 is an object, the HashRef will be used as arguments to the constructor | ||||||||||||||||||||||||||||
| 224 | # of the arguments type | ||||||||||||||||||||||||||||
| 225 | Arg3 => { Att1 => 'Val1' }, | ||||||||||||||||||||||||||||
| 226 | # if Arg4 is an array of objects, the HashRefs will be passed as arguments to | ||||||||||||||||||||||||||||
| 227 | # the constructor of the arguments type | ||||||||||||||||||||||||||||
| 228 | Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], | ||||||||||||||||||||||||||||
| 229 | ); | ||||||||||||||||||||||||||||
| 230 | |||||||||||||||||||||||||||||
| 231 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 232 | |||||||||||||||||||||||||||||
| 233 | Welcome to the I<Amazon SQS API Reference>. | ||||||||||||||||||||||||||||
| 234 | |||||||||||||||||||||||||||||
| 235 | Amazon SQS is a reliable, highly-scalable hosted queue for storing | ||||||||||||||||||||||||||||
| 236 | messages as they travel between applications or microservices. Amazon | ||||||||||||||||||||||||||||
| 237 | SQS moves data between distributed application components and helps you | ||||||||||||||||||||||||||||
| 238 | decouple these components. | ||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||
| 240 | For information on the permissions you need to use this API, see | ||||||||||||||||||||||||||||
| 241 | Identity and access management | ||||||||||||||||||||||||||||
| 242 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html) | ||||||||||||||||||||||||||||
| 243 | in the I<Amazon SQS Developer Guide.> | ||||||||||||||||||||||||||||
| 244 | |||||||||||||||||||||||||||||
| 245 | You can use Amazon Web Services SDKs (http://aws.amazon.com/tools/#sdk) | ||||||||||||||||||||||||||||
| 246 | to access Amazon SQS using your favorite programming language. The SDKs | ||||||||||||||||||||||||||||
| 247 | perform tasks such as the following automatically: | ||||||||||||||||||||||||||||
| 248 | |||||||||||||||||||||||||||||
| 249 | =over | ||||||||||||||||||||||||||||
| 250 | |||||||||||||||||||||||||||||
| 251 | =item * | ||||||||||||||||||||||||||||
| 252 | |||||||||||||||||||||||||||||
| 253 | Cryptographically sign your service requests | ||||||||||||||||||||||||||||
| 254 | |||||||||||||||||||||||||||||
| 255 | =item * | ||||||||||||||||||||||||||||
| 256 | |||||||||||||||||||||||||||||
| 257 | Retry requests | ||||||||||||||||||||||||||||
| 258 | |||||||||||||||||||||||||||||
| 259 | =item * | ||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||
| 261 | Handle error responses | ||||||||||||||||||||||||||||
| 262 | |||||||||||||||||||||||||||||
| 263 | =back | ||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||
| 265 | B<Additional information> | ||||||||||||||||||||||||||||
| 266 | |||||||||||||||||||||||||||||
| 267 | =over | ||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||
| 269 | =item * | ||||||||||||||||||||||||||||
| 270 | |||||||||||||||||||||||||||||
| 271 | Amazon SQS Product Page (http://aws.amazon.com/sqs/) | ||||||||||||||||||||||||||||
| 272 | |||||||||||||||||||||||||||||
| 273 | =item * | ||||||||||||||||||||||||||||
| 274 | |||||||||||||||||||||||||||||
| 275 | I<Amazon SQS Developer Guide> | ||||||||||||||||||||||||||||
| 276 | |||||||||||||||||||||||||||||
| 277 | =over | ||||||||||||||||||||||||||||
| 278 | |||||||||||||||||||||||||||||
| 279 | =item * | ||||||||||||||||||||||||||||
| 280 | |||||||||||||||||||||||||||||
| 281 | Making API Requests | ||||||||||||||||||||||||||||
| 282 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html) | ||||||||||||||||||||||||||||
| 283 | |||||||||||||||||||||||||||||
| 284 | =item * | ||||||||||||||||||||||||||||
| 285 | |||||||||||||||||||||||||||||
| 286 | Amazon SQS Message Attributes | ||||||||||||||||||||||||||||
| 287 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes) | ||||||||||||||||||||||||||||
| 288 | |||||||||||||||||||||||||||||
| 289 | =item * | ||||||||||||||||||||||||||||
| 290 | |||||||||||||||||||||||||||||
| 291 | Amazon SQS Dead-Letter Queues | ||||||||||||||||||||||||||||
| 292 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) | ||||||||||||||||||||||||||||
| 293 | |||||||||||||||||||||||||||||
| 294 | =back | ||||||||||||||||||||||||||||
| 295 | |||||||||||||||||||||||||||||
| 296 | =item * | ||||||||||||||||||||||||||||
| 297 | |||||||||||||||||||||||||||||
| 298 | Amazon SQS in the I<Command Line Interface> | ||||||||||||||||||||||||||||
| 299 | (http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html) | ||||||||||||||||||||||||||||
| 300 | |||||||||||||||||||||||||||||
| 301 | =item * | ||||||||||||||||||||||||||||
| 302 | |||||||||||||||||||||||||||||
| 303 | I<Amazon Web Services General Reference> | ||||||||||||||||||||||||||||
| 304 | |||||||||||||||||||||||||||||
| 305 | =over | ||||||||||||||||||||||||||||
| 306 | |||||||||||||||||||||||||||||
| 307 | =item * | ||||||||||||||||||||||||||||
| 308 | |||||||||||||||||||||||||||||
| 309 | Regions and Endpoints | ||||||||||||||||||||||||||||
| 310 | (https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region) | ||||||||||||||||||||||||||||
| 311 | |||||||||||||||||||||||||||||
| 312 | =back | ||||||||||||||||||||||||||||
| 313 | |||||||||||||||||||||||||||||
| 314 | =back | ||||||||||||||||||||||||||||
| 315 | |||||||||||||||||||||||||||||
| 316 | |||||||||||||||||||||||||||||
| 317 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05> | ||||||||||||||||||||||||||||
| 318 | |||||||||||||||||||||||||||||
| 319 | |||||||||||||||||||||||||||||
| 320 | =head1 METHODS | ||||||||||||||||||||||||||||
| 321 | |||||||||||||||||||||||||||||
| 322 | =head2 AddPermission | ||||||||||||||||||||||||||||
| 323 | |||||||||||||||||||||||||||||
| 324 | =over | ||||||||||||||||||||||||||||
| 325 | |||||||||||||||||||||||||||||
| 326 | =item Actions => ArrayRef[Str|Undef] | ||||||||||||||||||||||||||||
| 327 | |||||||||||||||||||||||||||||
| 328 | =item AWSAccountIds => ArrayRef[Str|Undef] | ||||||||||||||||||||||||||||
| 329 | |||||||||||||||||||||||||||||
| 330 | =item Label => Str | ||||||||||||||||||||||||||||
| 331 | |||||||||||||||||||||||||||||
| 332 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 333 | |||||||||||||||||||||||||||||
| 334 | |||||||||||||||||||||||||||||
| 335 | =back | ||||||||||||||||||||||||||||
| 336 | |||||||||||||||||||||||||||||
| 337 | Each argument is described in detail in: L<Paws::SQS::AddPermission> | ||||||||||||||||||||||||||||
| 338 | |||||||||||||||||||||||||||||
| 339 | Returns: nothing | ||||||||||||||||||||||||||||
| 340 | |||||||||||||||||||||||||||||
| 341 | Adds a permission to a queue for a specific principal | ||||||||||||||||||||||||||||
| 342 | (https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P). This | ||||||||||||||||||||||||||||
| 343 | allows sharing access to the queue. | ||||||||||||||||||||||||||||
| 344 | |||||||||||||||||||||||||||||
| 345 | When you create a queue, you have full control access rights for the | ||||||||||||||||||||||||||||
| 346 | queue. Only you, the owner of the queue, can grant or deny permissions | ||||||||||||||||||||||||||||
| 347 | to the queue. For more information about these permissions, see Allow | ||||||||||||||||||||||||||||
| 348 | Developers to Write Messages to a Shared Queue | ||||||||||||||||||||||||||||
| 349 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) | ||||||||||||||||||||||||||||
| 350 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 351 | |||||||||||||||||||||||||||||
| 352 | =over | ||||||||||||||||||||||||||||
| 353 | |||||||||||||||||||||||||||||
| 354 | =item * | ||||||||||||||||||||||||||||
| 355 | |||||||||||||||||||||||||||||
| 356 | C<AddPermission> generates a policy for you. You can use C< | ||||||||||||||||||||||||||||
| 357 | SetQueueAttributes > to upload your policy. For more information, see | ||||||||||||||||||||||||||||
| 358 | Using Custom Policies with the Amazon SQS Access Policy Language | ||||||||||||||||||||||||||||
| 359 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-creating-custom-policies.html) | ||||||||||||||||||||||||||||
| 360 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 361 | |||||||||||||||||||||||||||||
| 362 | =item * | ||||||||||||||||||||||||||||
| 363 | |||||||||||||||||||||||||||||
| 364 | An Amazon SQS policy can have a maximum of 7 actions. | ||||||||||||||||||||||||||||
| 365 | |||||||||||||||||||||||||||||
| 366 | =item * | ||||||||||||||||||||||||||||
| 367 | |||||||||||||||||||||||||||||
| 368 | To remove the ability to change queue permissions, you must deny | ||||||||||||||||||||||||||||
| 369 | permission to the C<AddPermission>, C<RemovePermission>, and | ||||||||||||||||||||||||||||
| 370 | C<SetQueueAttributes> actions in your IAM policy. | ||||||||||||||||||||||||||||
| 371 | |||||||||||||||||||||||||||||
| 372 | =back | ||||||||||||||||||||||||||||
| 373 | |||||||||||||||||||||||||||||
| 374 | Some actions take lists of parameters. These lists are specified using | ||||||||||||||||||||||||||||
| 375 | the C<param.n> notation. Values of C<n> are integers starting from 1. | ||||||||||||||||||||||||||||
| 376 | For example, a parameter list with two elements looks like this: | ||||||||||||||||||||||||||||
| 377 | |||||||||||||||||||||||||||||
| 378 | C<&AttributeName.1=first> | ||||||||||||||||||||||||||||
| 379 | |||||||||||||||||||||||||||||
| 380 | C<&AttributeName.2=second> | ||||||||||||||||||||||||||||
| 381 | |||||||||||||||||||||||||||||
| 382 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 383 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 384 | name | ||||||||||||||||||||||||||||
| 385 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 386 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 387 | |||||||||||||||||||||||||||||
| 388 | |||||||||||||||||||||||||||||
| 389 | =head2 ChangeMessageVisibility | ||||||||||||||||||||||||||||
| 390 | |||||||||||||||||||||||||||||
| 391 | =over | ||||||||||||||||||||||||||||
| 392 | |||||||||||||||||||||||||||||
| 393 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 394 | |||||||||||||||||||||||||||||
| 395 | =item ReceiptHandle => Str | ||||||||||||||||||||||||||||
| 396 | |||||||||||||||||||||||||||||
| 397 | =item VisibilityTimeout => Int | ||||||||||||||||||||||||||||
| 398 | |||||||||||||||||||||||||||||
| 399 | |||||||||||||||||||||||||||||
| 400 | =back | ||||||||||||||||||||||||||||
| 401 | |||||||||||||||||||||||||||||
| 402 | Each argument is described in detail in: L<Paws::SQS::ChangeMessageVisibility> | ||||||||||||||||||||||||||||
| 403 | |||||||||||||||||||||||||||||
| 404 | Returns: nothing | ||||||||||||||||||||||||||||
| 405 | |||||||||||||||||||||||||||||
| 406 | Changes the visibility timeout of a specified message in a queue to a | ||||||||||||||||||||||||||||
| 407 | new value. The default visibility timeout for a message is 30 seconds. | ||||||||||||||||||||||||||||
| 408 | The minimum is 0 seconds. The maximum is 12 hours. For more | ||||||||||||||||||||||||||||
| 409 | information, see Visibility Timeout | ||||||||||||||||||||||||||||
| 410 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) | ||||||||||||||||||||||||||||
| 411 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 412 | |||||||||||||||||||||||||||||
| 413 | For example, you have a message with a visibility timeout of 5 minutes. | ||||||||||||||||||||||||||||
| 414 | After 3 minutes, you call C<ChangeMessageVisibility> with a timeout of | ||||||||||||||||||||||||||||
| 415 | 10 minutes. You can continue to call C<ChangeMessageVisibility> to | ||||||||||||||||||||||||||||
| 416 | extend the visibility timeout to the maximum allowed time. If you try | ||||||||||||||||||||||||||||
| 417 | to extend the visibility timeout beyond the maximum, your request is | ||||||||||||||||||||||||||||
| 418 | rejected. | ||||||||||||||||||||||||||||
| 419 | |||||||||||||||||||||||||||||
| 420 | An Amazon SQS message has three basic states: | ||||||||||||||||||||||||||||
| 421 | |||||||||||||||||||||||||||||
| 422 | =over | ||||||||||||||||||||||||||||
| 423 | |||||||||||||||||||||||||||||
| 424 | =item 1. | ||||||||||||||||||||||||||||
| 425 | |||||||||||||||||||||||||||||
| 426 | Sent to a queue by a producer. | ||||||||||||||||||||||||||||
| 427 | |||||||||||||||||||||||||||||
| 428 | =item 2. | ||||||||||||||||||||||||||||
| 429 | |||||||||||||||||||||||||||||
| 430 | Received from the queue by a consumer. | ||||||||||||||||||||||||||||
| 431 | |||||||||||||||||||||||||||||
| 432 | =item 3. | ||||||||||||||||||||||||||||
| 433 | |||||||||||||||||||||||||||||
| 434 | Deleted from the queue. | ||||||||||||||||||||||||||||
| 435 | |||||||||||||||||||||||||||||
| 436 | =back | ||||||||||||||||||||||||||||
| 437 | |||||||||||||||||||||||||||||
| 438 | A message is considered to be I<stored> after it is sent to a queue by | ||||||||||||||||||||||||||||
| 439 | a producer, but not yet received from the queue by a consumer (that is, | ||||||||||||||||||||||||||||
| 440 | between states 1 and 2). There is no limit to the number of stored | ||||||||||||||||||||||||||||
| 441 | messages. A message is considered to be I<in flight> after it is | ||||||||||||||||||||||||||||
| 442 | received from a queue by a consumer, but not yet deleted from the queue | ||||||||||||||||||||||||||||
| 443 | (that is, between states 2 and 3). There is a limit to the number of | ||||||||||||||||||||||||||||
| 444 | inflight messages. | ||||||||||||||||||||||||||||
| 445 | |||||||||||||||||||||||||||||
| 446 | Limits that apply to inflight messages are unrelated to the | ||||||||||||||||||||||||||||
| 447 | I<unlimited> number of stored messages. | ||||||||||||||||||||||||||||
| 448 | |||||||||||||||||||||||||||||
| 449 | For most standard queues (depending on queue traffic and message | ||||||||||||||||||||||||||||
| 450 | backlog), there can be a maximum of approximately 120,000 inflight | ||||||||||||||||||||||||||||
| 451 | messages (received from a queue by a consumer, but not yet deleted from | ||||||||||||||||||||||||||||
| 452 | the queue). If you reach this limit, Amazon SQS returns the | ||||||||||||||||||||||||||||
| 453 | C<OverLimit> error message. To avoid reaching the limit, you should | ||||||||||||||||||||||||||||
| 454 | delete messages from the queue after they're processed. You can also | ||||||||||||||||||||||||||||
| 455 | increase the number of queues you use to process your messages. To | ||||||||||||||||||||||||||||
| 456 | request a limit increase, file a support request | ||||||||||||||||||||||||||||
| 457 | (https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs). | ||||||||||||||||||||||||||||
| 458 | |||||||||||||||||||||||||||||
| 459 | For FIFO queues, there can be a maximum of 20,000 inflight messages | ||||||||||||||||||||||||||||
| 460 | (received from a queue by a consumer, but not yet deleted from the | ||||||||||||||||||||||||||||
| 461 | queue). If you reach this limit, Amazon SQS returns no error messages. | ||||||||||||||||||||||||||||
| 462 | |||||||||||||||||||||||||||||
| 463 | If you attempt to set the C<VisibilityTimeout> to a value greater than | ||||||||||||||||||||||||||||
| 464 | the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't | ||||||||||||||||||||||||||||
| 465 | automatically recalculate and increase the timeout to the maximum | ||||||||||||||||||||||||||||
| 466 | remaining time. | ||||||||||||||||||||||||||||
| 467 | |||||||||||||||||||||||||||||
| 468 | Unlike with a queue, when you change the visibility timeout for a | ||||||||||||||||||||||||||||
| 469 | specific message the timeout value is applied immediately but isn't | ||||||||||||||||||||||||||||
| 470 | saved in memory for that message. If you don't delete a message after | ||||||||||||||||||||||||||||
| 471 | it is received, the visibility timeout for the message reverts to the | ||||||||||||||||||||||||||||
| 472 | original timeout value (not to the value you set using the | ||||||||||||||||||||||||||||
| 473 | C<ChangeMessageVisibility> action) the next time the message is | ||||||||||||||||||||||||||||
| 474 | received. | ||||||||||||||||||||||||||||
| 475 | |||||||||||||||||||||||||||||
| 476 | |||||||||||||||||||||||||||||
| 477 | =head2 ChangeMessageVisibilityBatch | ||||||||||||||||||||||||||||
| 478 | |||||||||||||||||||||||||||||
| 479 | =over | ||||||||||||||||||||||||||||
| 480 | |||||||||||||||||||||||||||||
| 481 | =item Entries => ArrayRef[L<Paws::SQS::ChangeMessageVisibilityBatchRequestEntry>] | ||||||||||||||||||||||||||||
| 482 | |||||||||||||||||||||||||||||
| 483 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 484 | |||||||||||||||||||||||||||||
| 485 | |||||||||||||||||||||||||||||
| 486 | =back | ||||||||||||||||||||||||||||
| 487 | |||||||||||||||||||||||||||||
| 488 | Each argument is described in detail in: L<Paws::SQS::ChangeMessageVisibilityBatch> | ||||||||||||||||||||||||||||
| 489 | |||||||||||||||||||||||||||||
| 490 | Returns: a L<Paws::SQS::ChangeMessageVisibilityBatchResult> instance | ||||||||||||||||||||||||||||
| 491 | |||||||||||||||||||||||||||||
| 492 | Changes the visibility timeout of multiple messages. This is a batch | ||||||||||||||||||||||||||||
| 493 | version of C< ChangeMessageVisibility.> The result of the action on | ||||||||||||||||||||||||||||
| 494 | each message is reported individually in the response. You can send up | ||||||||||||||||||||||||||||
| 495 | to 10 C< ChangeMessageVisibility > requests with each | ||||||||||||||||||||||||||||
| 496 | C<ChangeMessageVisibilityBatch> action. | ||||||||||||||||||||||||||||
| 497 | |||||||||||||||||||||||||||||
| 498 | Because the batch request can result in a combination of successful and | ||||||||||||||||||||||||||||
| 499 | unsuccessful actions, you should check for batch errors even when the | ||||||||||||||||||||||||||||
| 500 | call returns an HTTP status code of C<200>. | ||||||||||||||||||||||||||||
| 501 | |||||||||||||||||||||||||||||
| 502 | Some actions take lists of parameters. These lists are specified using | ||||||||||||||||||||||||||||
| 503 | the C<param.n> notation. Values of C<n> are integers starting from 1. | ||||||||||||||||||||||||||||
| 504 | For example, a parameter list with two elements looks like this: | ||||||||||||||||||||||||||||
| 505 | |||||||||||||||||||||||||||||
| 506 | C<&AttributeName.1=first> | ||||||||||||||||||||||||||||
| 507 | |||||||||||||||||||||||||||||
| 508 | C<&AttributeName.2=second> | ||||||||||||||||||||||||||||
| 509 | |||||||||||||||||||||||||||||
| 510 | |||||||||||||||||||||||||||||
| 511 | =head2 CreateQueue | ||||||||||||||||||||||||||||
| 512 | |||||||||||||||||||||||||||||
| 513 | =over | ||||||||||||||||||||||||||||
| 514 | |||||||||||||||||||||||||||||
| 515 | =item QueueName => Str | ||||||||||||||||||||||||||||
| 516 | |||||||||||||||||||||||||||||
| 517 | =item [Attributes => L<Paws::SQS::QueueAttributeMap>] | ||||||||||||||||||||||||||||
| 518 | |||||||||||||||||||||||||||||
| 519 | =item [Tags => L<Paws::SQS::TagMap>] | ||||||||||||||||||||||||||||
| 520 | |||||||||||||||||||||||||||||
| 521 | |||||||||||||||||||||||||||||
| 522 | =back | ||||||||||||||||||||||||||||
| 523 | |||||||||||||||||||||||||||||
| 524 | Each argument is described in detail in: L<Paws::SQS::CreateQueue> | ||||||||||||||||||||||||||||
| 525 | |||||||||||||||||||||||||||||
| 526 | Returns: a L<Paws::SQS::CreateQueueResult> instance | ||||||||||||||||||||||||||||
| 527 | |||||||||||||||||||||||||||||
| 528 | Creates a new standard or FIFO queue. You can pass one or more | ||||||||||||||||||||||||||||
| 529 | attributes in the request. Keep the following in mind: | ||||||||||||||||||||||||||||
| 530 | |||||||||||||||||||||||||||||
| 531 | =over | ||||||||||||||||||||||||||||
| 532 | |||||||||||||||||||||||||||||
| 533 | =item * | ||||||||||||||||||||||||||||
| 534 | |||||||||||||||||||||||||||||
| 535 | If you don't specify the C<FifoQueue> attribute, Amazon SQS creates a | ||||||||||||||||||||||||||||
| 536 | standard queue. | ||||||||||||||||||||||||||||
| 537 | |||||||||||||||||||||||||||||
| 538 | You can't change the queue type after you create it and you can't | ||||||||||||||||||||||||||||
| 539 | convert an existing standard queue into a FIFO queue. You must either | ||||||||||||||||||||||||||||
| 540 | create a new FIFO queue for your application or delete your existing | ||||||||||||||||||||||||||||
| 541 | standard queue and recreate it as a FIFO queue. For more information, | ||||||||||||||||||||||||||||
| 542 | see Moving From a Standard Queue to a FIFO Queue | ||||||||||||||||||||||||||||
| 543 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving) | ||||||||||||||||||||||||||||
| 544 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 545 | |||||||||||||||||||||||||||||
| 546 | =item * | ||||||||||||||||||||||||||||
| 547 | |||||||||||||||||||||||||||||
| 548 | If you don't provide a value for an attribute, the queue is created | ||||||||||||||||||||||||||||
| 549 | with the default value for the attribute. | ||||||||||||||||||||||||||||
| 550 | |||||||||||||||||||||||||||||
| 551 | =item * | ||||||||||||||||||||||||||||
| 552 | |||||||||||||||||||||||||||||
| 553 | If you delete a queue, you must wait at least 60 seconds before | ||||||||||||||||||||||||||||
| 554 | creating a queue with the same name. | ||||||||||||||||||||||||||||
| 555 | |||||||||||||||||||||||||||||
| 556 | =back | ||||||||||||||||||||||||||||
| 557 | |||||||||||||||||||||||||||||
| 558 | To successfully create a new queue, you must provide a queue name that | ||||||||||||||||||||||||||||
| 559 | adheres to the limits related to queues | ||||||||||||||||||||||||||||
| 560 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html) | ||||||||||||||||||||||||||||
| 561 | and is unique within the scope of your queues. | ||||||||||||||||||||||||||||
| 562 | |||||||||||||||||||||||||||||
| 563 | After you create a queue, you must wait at least one second after the | ||||||||||||||||||||||||||||
| 564 | queue is created to be able to use the queue. | ||||||||||||||||||||||||||||
| 565 | |||||||||||||||||||||||||||||
| 566 | To get the queue URL, use the C< GetQueueUrl > action. C< GetQueueUrl > | ||||||||||||||||||||||||||||
| 567 | requires only the C<QueueName> parameter. be aware of existing queue | ||||||||||||||||||||||||||||
| 568 | names: | ||||||||||||||||||||||||||||
| 569 | |||||||||||||||||||||||||||||
| 570 | =over | ||||||||||||||||||||||||||||
| 571 | |||||||||||||||||||||||||||||
| 572 | =item * | ||||||||||||||||||||||||||||
| 573 | |||||||||||||||||||||||||||||
| 574 | If you provide the name of an existing queue along with the exact names | ||||||||||||||||||||||||||||
| 575 | and values of all the queue's attributes, C<CreateQueue> returns the | ||||||||||||||||||||||||||||
| 576 | queue URL for the existing queue. | ||||||||||||||||||||||||||||
| 577 | |||||||||||||||||||||||||||||
| 578 | =item * | ||||||||||||||||||||||||||||
| 579 | |||||||||||||||||||||||||||||
| 580 | If the queue name, attribute names, or attribute values don't match an | ||||||||||||||||||||||||||||
| 581 | existing queue, C<CreateQueue> returns an error. | ||||||||||||||||||||||||||||
| 582 | |||||||||||||||||||||||||||||
| 583 | =back | ||||||||||||||||||||||||||||
| 584 | |||||||||||||||||||||||||||||
| 585 | Some actions take lists of parameters. These lists are specified using | ||||||||||||||||||||||||||||
| 586 | the C<param.n> notation. Values of C<n> are integers starting from 1. | ||||||||||||||||||||||||||||
| 587 | For example, a parameter list with two elements looks like this: | ||||||||||||||||||||||||||||
| 588 | |||||||||||||||||||||||||||||
| 589 | C<&AttributeName.1=first> | ||||||||||||||||||||||||||||
| 590 | |||||||||||||||||||||||||||||
| 591 | C<&AttributeName.2=second> | ||||||||||||||||||||||||||||
| 592 | |||||||||||||||||||||||||||||
| 593 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 594 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 595 | name | ||||||||||||||||||||||||||||
| 596 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 597 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 598 | |||||||||||||||||||||||||||||
| 599 | |||||||||||||||||||||||||||||
| 600 | =head2 DeleteMessage | ||||||||||||||||||||||||||||
| 601 | |||||||||||||||||||||||||||||
| 602 | =over | ||||||||||||||||||||||||||||
| 603 | |||||||||||||||||||||||||||||
| 604 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 605 | |||||||||||||||||||||||||||||
| 606 | =item ReceiptHandle => Str | ||||||||||||||||||||||||||||
| 607 | |||||||||||||||||||||||||||||
| 608 | |||||||||||||||||||||||||||||
| 609 | =back | ||||||||||||||||||||||||||||
| 610 | |||||||||||||||||||||||||||||
| 611 | Each argument is described in detail in: L<Paws::SQS::DeleteMessage> | ||||||||||||||||||||||||||||
| 612 | |||||||||||||||||||||||||||||
| 613 | Returns: nothing | ||||||||||||||||||||||||||||
| 614 | |||||||||||||||||||||||||||||
| 615 | Deletes the specified message from the specified queue. To select the | ||||||||||||||||||||||||||||
| 616 | message to delete, use the C<ReceiptHandle> of the message (I<not> the | ||||||||||||||||||||||||||||
| 617 | C<MessageId> which you receive when you send the message). Amazon SQS | ||||||||||||||||||||||||||||
| 618 | can delete a message from a queue even if a visibility timeout setting | ||||||||||||||||||||||||||||
| 619 | causes the message to be locked by another consumer. Amazon SQS | ||||||||||||||||||||||||||||
| 620 | automatically deletes messages left in a queue longer than the | ||||||||||||||||||||||||||||
| 621 | retention period configured for the queue. | ||||||||||||||||||||||||||||
| 622 | |||||||||||||||||||||||||||||
| 623 | The C<ReceiptHandle> is associated with a I<specific instance> of | ||||||||||||||||||||||||||||
| 624 | receiving a message. If you receive a message more than once, the | ||||||||||||||||||||||||||||
| 625 | C<ReceiptHandle> is different each time you receive a message. When you | ||||||||||||||||||||||||||||
| 626 | use the C<DeleteMessage> action, you must provide the most recently | ||||||||||||||||||||||||||||
| 627 | received C<ReceiptHandle> for the message (otherwise, the request | ||||||||||||||||||||||||||||
| 628 | succeeds, but the message might not be deleted). | ||||||||||||||||||||||||||||
| 629 | |||||||||||||||||||||||||||||
| 630 | For standard queues, it is possible to receive a message even after you | ||||||||||||||||||||||||||||
| 631 | delete it. This might happen on rare occasions if one of the servers | ||||||||||||||||||||||||||||
| 632 | which stores a copy of the message is unavailable when you send the | ||||||||||||||||||||||||||||
| 633 | request to delete the message. The copy remains on the server and might | ||||||||||||||||||||||||||||
| 634 | be returned to you during a subsequent receive request. You should | ||||||||||||||||||||||||||||
| 635 | ensure that your application is idempotent, so that receiving a message | ||||||||||||||||||||||||||||
| 636 | more than once does not cause issues. | ||||||||||||||||||||||||||||
| 637 | |||||||||||||||||||||||||||||
| 638 | |||||||||||||||||||||||||||||
| 639 | =head2 DeleteMessageBatch | ||||||||||||||||||||||||||||
| 640 | |||||||||||||||||||||||||||||
| 641 | =over | ||||||||||||||||||||||||||||
| 642 | |||||||||||||||||||||||||||||
| 643 | =item Entries => ArrayRef[L<Paws::SQS::DeleteMessageBatchRequestEntry>] | ||||||||||||||||||||||||||||
| 644 | |||||||||||||||||||||||||||||
| 645 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 646 | |||||||||||||||||||||||||||||
| 647 | |||||||||||||||||||||||||||||
| 648 | =back | ||||||||||||||||||||||||||||
| 649 | |||||||||||||||||||||||||||||
| 650 | Each argument is described in detail in: L<Paws::SQS::DeleteMessageBatch> | ||||||||||||||||||||||||||||
| 651 | |||||||||||||||||||||||||||||
| 652 | Returns: a L<Paws::SQS::DeleteMessageBatchResult> instance | ||||||||||||||||||||||||||||
| 653 | |||||||||||||||||||||||||||||
| 654 | Deletes up to ten messages from the specified queue. This is a batch | ||||||||||||||||||||||||||||
| 655 | version of C< DeleteMessage.> The result of the action on each message | ||||||||||||||||||||||||||||
| 656 | is reported individually in the response. | ||||||||||||||||||||||||||||
| 657 | |||||||||||||||||||||||||||||
| 658 | Because the batch request can result in a combination of successful and | ||||||||||||||||||||||||||||
| 659 | unsuccessful actions, you should check for batch errors even when the | ||||||||||||||||||||||||||||
| 660 | call returns an HTTP status code of C<200>. | ||||||||||||||||||||||||||||
| 661 | |||||||||||||||||||||||||||||
| 662 | Some actions take lists of parameters. These lists are specified using | ||||||||||||||||||||||||||||
| 663 | the C<param.n> notation. Values of C<n> are integers starting from 1. | ||||||||||||||||||||||||||||
| 664 | For example, a parameter list with two elements looks like this: | ||||||||||||||||||||||||||||
| 665 | |||||||||||||||||||||||||||||
| 666 | C<&AttributeName.1=first> | ||||||||||||||||||||||||||||
| 667 | |||||||||||||||||||||||||||||
| 668 | C<&AttributeName.2=second> | ||||||||||||||||||||||||||||
| 669 | |||||||||||||||||||||||||||||
| 670 | |||||||||||||||||||||||||||||
| 671 | =head2 DeleteQueue | ||||||||||||||||||||||||||||
| 672 | |||||||||||||||||||||||||||||
| 673 | =over | ||||||||||||||||||||||||||||
| 674 | |||||||||||||||||||||||||||||
| 675 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 676 | |||||||||||||||||||||||||||||
| 677 | |||||||||||||||||||||||||||||
| 678 | =back | ||||||||||||||||||||||||||||
| 679 | |||||||||||||||||||||||||||||
| 680 | Each argument is described in detail in: L<Paws::SQS::DeleteQueue> | ||||||||||||||||||||||||||||
| 681 | |||||||||||||||||||||||||||||
| 682 | Returns: nothing | ||||||||||||||||||||||||||||
| 683 | |||||||||||||||||||||||||||||
| 684 | Deletes the queue specified by the C<QueueUrl>, regardless of the | ||||||||||||||||||||||||||||
| 685 | queue's contents. | ||||||||||||||||||||||||||||
| 686 | |||||||||||||||||||||||||||||
| 687 | Be careful with the C<DeleteQueue> action: When you delete a queue, any | ||||||||||||||||||||||||||||
| 688 | messages in the queue are no longer available. | ||||||||||||||||||||||||||||
| 689 | |||||||||||||||||||||||||||||
| 690 | When you delete a queue, the deletion process takes up to 60 seconds. | ||||||||||||||||||||||||||||
| 691 | Requests you send involving that queue during the 60 seconds might | ||||||||||||||||||||||||||||
| 692 | succeed. For example, a C< SendMessage > request might succeed, but | ||||||||||||||||||||||||||||
| 693 | after 60 seconds the queue and the message you sent no longer exist. | ||||||||||||||||||||||||||||
| 694 | |||||||||||||||||||||||||||||
| 695 | When you delete a queue, you must wait at least 60 seconds before | ||||||||||||||||||||||||||||
| 696 | creating a queue with the same name. | ||||||||||||||||||||||||||||
| 697 | |||||||||||||||||||||||||||||
| 698 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 699 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 700 | name | ||||||||||||||||||||||||||||
| 701 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 702 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 703 | |||||||||||||||||||||||||||||
| 704 | |||||||||||||||||||||||||||||
| 705 | =head2 GetQueueAttributes | ||||||||||||||||||||||||||||
| 706 | |||||||||||||||||||||||||||||
| 707 | =over | ||||||||||||||||||||||||||||
| 708 | |||||||||||||||||||||||||||||
| 709 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 710 | |||||||||||||||||||||||||||||
| 711 | =item [AttributeNames => ArrayRef[Str|Undef]] | ||||||||||||||||||||||||||||
| 712 | |||||||||||||||||||||||||||||
| 713 | |||||||||||||||||||||||||||||
| 714 | =back | ||||||||||||||||||||||||||||
| 715 | |||||||||||||||||||||||||||||
| 716 | Each argument is described in detail in: L<Paws::SQS::GetQueueAttributes> | ||||||||||||||||||||||||||||
| 717 | |||||||||||||||||||||||||||||
| 718 | Returns: a L<Paws::SQS::GetQueueAttributesResult> instance | ||||||||||||||||||||||||||||
| 719 | |||||||||||||||||||||||||||||
| 720 | Gets attributes for the specified queue. | ||||||||||||||||||||||||||||
| 721 | |||||||||||||||||||||||||||||
| 722 | To determine whether a queue is FIFO | ||||||||||||||||||||||||||||
| 723 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html), | ||||||||||||||||||||||||||||
| 724 | you can check whether C<QueueName> ends with the C<.fifo> suffix. | ||||||||||||||||||||||||||||
| 725 | |||||||||||||||||||||||||||||
| 726 | |||||||||||||||||||||||||||||
| 727 | =head2 GetQueueUrl | ||||||||||||||||||||||||||||
| 728 | |||||||||||||||||||||||||||||
| 729 | =over | ||||||||||||||||||||||||||||
| 730 | |||||||||||||||||||||||||||||
| 731 | =item QueueName => Str | ||||||||||||||||||||||||||||
| 732 | |||||||||||||||||||||||||||||
| 733 | =item [QueueOwnerAWSAccountId => Str] | ||||||||||||||||||||||||||||
| 734 | |||||||||||||||||||||||||||||
| 735 | |||||||||||||||||||||||||||||
| 736 | =back | ||||||||||||||||||||||||||||
| 737 | |||||||||||||||||||||||||||||
| 738 | Each argument is described in detail in: L<Paws::SQS::GetQueueUrl> | ||||||||||||||||||||||||||||
| 739 | |||||||||||||||||||||||||||||
| 740 | Returns: a L<Paws::SQS::GetQueueUrlResult> instance | ||||||||||||||||||||||||||||
| 741 | |||||||||||||||||||||||||||||
| 742 | Returns the URL of an existing Amazon SQS queue. | ||||||||||||||||||||||||||||
| 743 | |||||||||||||||||||||||||||||
| 744 | To access a queue that belongs to another AWS account, use the | ||||||||||||||||||||||||||||
| 745 | C<QueueOwnerAWSAccountId> parameter to specify the account ID of the | ||||||||||||||||||||||||||||
| 746 | queue's owner. The queue's owner must grant you permission to access | ||||||||||||||||||||||||||||
| 747 | the queue. For more information about shared queue access, see C< | ||||||||||||||||||||||||||||
| 748 | AddPermission > or see Allow Developers to Write Messages to a Shared | ||||||||||||||||||||||||||||
| 749 | Queue | ||||||||||||||||||||||||||||
| 750 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue) | ||||||||||||||||||||||||||||
| 751 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 752 | |||||||||||||||||||||||||||||
| 753 | |||||||||||||||||||||||||||||
| 754 | =head2 ListDeadLetterSourceQueues | ||||||||||||||||||||||||||||
| 755 | |||||||||||||||||||||||||||||
| 756 | =over | ||||||||||||||||||||||||||||
| 757 | |||||||||||||||||||||||||||||
| 758 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 759 | |||||||||||||||||||||||||||||
| 760 | =item [MaxResults => Int] | ||||||||||||||||||||||||||||
| 761 | |||||||||||||||||||||||||||||
| 762 | =item [NextToken => Str] | ||||||||||||||||||||||||||||
| 763 | |||||||||||||||||||||||||||||
| 764 | |||||||||||||||||||||||||||||
| 765 | =back | ||||||||||||||||||||||||||||
| 766 | |||||||||||||||||||||||||||||
| 767 | Each argument is described in detail in: L<Paws::SQS::ListDeadLetterSourceQueues> | ||||||||||||||||||||||||||||
| 768 | |||||||||||||||||||||||||||||
| 769 | Returns: a L<Paws::SQS::ListDeadLetterSourceQueuesResult> instance | ||||||||||||||||||||||||||||
| 770 | |||||||||||||||||||||||||||||
| 771 | Returns a list of your queues that have the C<RedrivePolicy> queue | ||||||||||||||||||||||||||||
| 772 | attribute configured with a dead-letter queue. | ||||||||||||||||||||||||||||
| 773 | |||||||||||||||||||||||||||||
| 774 | The C<ListDeadLetterSourceQueues> methods supports pagination. Set | ||||||||||||||||||||||||||||
| 775 | parameter C<MaxResults> in the request to specify the maximum number of | ||||||||||||||||||||||||||||
| 776 | results to be returned in the response. If you do not set | ||||||||||||||||||||||||||||
| 777 | C<MaxResults>, the response includes a maximum of 1,000 results. If you | ||||||||||||||||||||||||||||
| 778 | set C<MaxResults> and there are additional results to display, the | ||||||||||||||||||||||||||||
| 779 | response includes a value for C<NextToken>. Use C<NextToken> as a | ||||||||||||||||||||||||||||
| 780 | parameter in your next request to C<ListDeadLetterSourceQueues> to | ||||||||||||||||||||||||||||
| 781 | receive the next page of results. | ||||||||||||||||||||||||||||
| 782 | |||||||||||||||||||||||||||||
| 783 | For more information about using dead-letter queues, see Using Amazon | ||||||||||||||||||||||||||||
| 784 | SQS Dead-Letter Queues | ||||||||||||||||||||||||||||
| 785 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html) | ||||||||||||||||||||||||||||
| 786 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 787 | |||||||||||||||||||||||||||||
| 788 | |||||||||||||||||||||||||||||
| 789 | =head2 ListQueues | ||||||||||||||||||||||||||||
| 790 | |||||||||||||||||||||||||||||
| 791 | =over | ||||||||||||||||||||||||||||
| 792 | |||||||||||||||||||||||||||||
| 793 | =item [MaxResults => Int] | ||||||||||||||||||||||||||||
| 794 | |||||||||||||||||||||||||||||
| 795 | =item [NextToken => Str] | ||||||||||||||||||||||||||||
| 796 | |||||||||||||||||||||||||||||
| 797 | =item [QueueNamePrefix => Str] | ||||||||||||||||||||||||||||
| 798 | |||||||||||||||||||||||||||||
| 799 | |||||||||||||||||||||||||||||
| 800 | =back | ||||||||||||||||||||||||||||
| 801 | |||||||||||||||||||||||||||||
| 802 | Each argument is described in detail in: L<Paws::SQS::ListQueues> | ||||||||||||||||||||||||||||
| 803 | |||||||||||||||||||||||||||||
| 804 | Returns: a L<Paws::SQS::ListQueuesResult> instance | ||||||||||||||||||||||||||||
| 805 | |||||||||||||||||||||||||||||
| 806 | Returns a list of your queues in the current region. The response | ||||||||||||||||||||||||||||
| 807 | includes a maximum of 1,000 results. If you specify a value for the | ||||||||||||||||||||||||||||
| 808 | optional C<QueueNamePrefix> parameter, only queues with a name that | ||||||||||||||||||||||||||||
| 809 | begins with the specified value are returned. | ||||||||||||||||||||||||||||
| 810 | |||||||||||||||||||||||||||||
| 811 | The C<listQueues> methods supports pagination. Set parameter | ||||||||||||||||||||||||||||
| 812 | C<MaxResults> in the request to specify the maximum number of results | ||||||||||||||||||||||||||||
| 813 | to be returned in the response. If you do not set C<MaxResults>, the | ||||||||||||||||||||||||||||
| 814 | response includes a maximum of 1,000 results. If you set C<MaxResults> | ||||||||||||||||||||||||||||
| 815 | and there are additional results to display, the response includes a | ||||||||||||||||||||||||||||
| 816 | value for C<NextToken>. Use C<NextToken> as a parameter in your next | ||||||||||||||||||||||||||||
| 817 | request to C<listQueues> to receive the next page of results. | ||||||||||||||||||||||||||||
| 818 | |||||||||||||||||||||||||||||
| 819 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 820 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 821 | name | ||||||||||||||||||||||||||||
| 822 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 823 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 824 | |||||||||||||||||||||||||||||
| 825 | |||||||||||||||||||||||||||||
| 826 | =head2 ListQueueTags | ||||||||||||||||||||||||||||
| 827 | |||||||||||||||||||||||||||||
| 828 | =over | ||||||||||||||||||||||||||||
| 829 | |||||||||||||||||||||||||||||
| 830 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 831 | |||||||||||||||||||||||||||||
| 832 | |||||||||||||||||||||||||||||
| 833 | =back | ||||||||||||||||||||||||||||
| 834 | |||||||||||||||||||||||||||||
| 835 | Each argument is described in detail in: L<Paws::SQS::ListQueueTags> | ||||||||||||||||||||||||||||
| 836 | |||||||||||||||||||||||||||||
| 837 | Returns: a L<Paws::SQS::ListQueueTagsResult> instance | ||||||||||||||||||||||||||||
| 838 | |||||||||||||||||||||||||||||
| 839 | List all cost allocation tags added to the specified Amazon SQS queue. | ||||||||||||||||||||||||||||
| 840 | For an overview, see Tagging Your Amazon SQS Queues | ||||||||||||||||||||||||||||
| 841 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) | ||||||||||||||||||||||||||||
| 842 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 843 | |||||||||||||||||||||||||||||
| 844 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 845 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 846 | name | ||||||||||||||||||||||||||||
| 847 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 848 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 849 | |||||||||||||||||||||||||||||
| 850 | |||||||||||||||||||||||||||||
| 851 | =head2 PurgeQueue | ||||||||||||||||||||||||||||
| 852 | |||||||||||||||||||||||||||||
| 853 | =over | ||||||||||||||||||||||||||||
| 854 | |||||||||||||||||||||||||||||
| 855 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 856 | |||||||||||||||||||||||||||||
| 857 | |||||||||||||||||||||||||||||
| 858 | =back | ||||||||||||||||||||||||||||
| 859 | |||||||||||||||||||||||||||||
| 860 | Each argument is described in detail in: L<Paws::SQS::PurgeQueue> | ||||||||||||||||||||||||||||
| 861 | |||||||||||||||||||||||||||||
| 862 | Returns: nothing | ||||||||||||||||||||||||||||
| 863 | |||||||||||||||||||||||||||||
| 864 | Deletes the messages in a queue specified by the C<QueueURL> parameter. | ||||||||||||||||||||||||||||
| 865 | |||||||||||||||||||||||||||||
| 866 | When you use the C<PurgeQueue> action, you can't retrieve any messages | ||||||||||||||||||||||||||||
| 867 | deleted from a queue. | ||||||||||||||||||||||||||||
| 868 | |||||||||||||||||||||||||||||
| 869 | The message deletion process takes up to 60 seconds. We recommend | ||||||||||||||||||||||||||||
| 870 | waiting for 60 seconds regardless of your queue's size. | ||||||||||||||||||||||||||||
| 871 | |||||||||||||||||||||||||||||
| 872 | Messages sent to the queue I<before> you call C<PurgeQueue> might be | ||||||||||||||||||||||||||||
| 873 | received but are deleted within the next minute. | ||||||||||||||||||||||||||||
| 874 | |||||||||||||||||||||||||||||
| 875 | Messages sent to the queue I<after> you call C<PurgeQueue> might be | ||||||||||||||||||||||||||||
| 876 | deleted while the queue is being purged. | ||||||||||||||||||||||||||||
| 877 | |||||||||||||||||||||||||||||
| 878 | |||||||||||||||||||||||||||||
| 879 | =head2 ReceiveMessage | ||||||||||||||||||||||||||||
| 880 | |||||||||||||||||||||||||||||
| 881 | =over | ||||||||||||||||||||||||||||
| 882 | |||||||||||||||||||||||||||||
| 883 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 884 | |||||||||||||||||||||||||||||
| 885 | =item [AttributeNames => ArrayRef[Str|Undef]] | ||||||||||||||||||||||||||||
| 886 | |||||||||||||||||||||||||||||
| 887 | =item [MaxNumberOfMessages => Int] | ||||||||||||||||||||||||||||
| 888 | |||||||||||||||||||||||||||||
| 889 | =item [MessageAttributeNames => ArrayRef[Str|Undef]] | ||||||||||||||||||||||||||||
| 890 | |||||||||||||||||||||||||||||
| 891 | =item [ReceiveRequestAttemptId => Str] | ||||||||||||||||||||||||||||
| 892 | |||||||||||||||||||||||||||||
| 893 | =item [VisibilityTimeout => Int] | ||||||||||||||||||||||||||||
| 894 | |||||||||||||||||||||||||||||
| 895 | =item [WaitTimeSeconds => Int] | ||||||||||||||||||||||||||||
| 896 | |||||||||||||||||||||||||||||
| 897 | |||||||||||||||||||||||||||||
| 898 | =back | ||||||||||||||||||||||||||||
| 899 | |||||||||||||||||||||||||||||
| 900 | Each argument is described in detail in: L<Paws::SQS::ReceiveMessage> | ||||||||||||||||||||||||||||
| 901 | |||||||||||||||||||||||||||||
| 902 | Returns: a L<Paws::SQS::ReceiveMessageResult> instance | ||||||||||||||||||||||||||||
| 903 | |||||||||||||||||||||||||||||
| 904 | Retrieves one or more messages (up to 10), from the specified queue. | ||||||||||||||||||||||||||||
| 905 | Using the C<WaitTimeSeconds> parameter enables long-poll support. For | ||||||||||||||||||||||||||||
| 906 | more information, see Amazon SQS Long Polling | ||||||||||||||||||||||||||||
| 907 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html) | ||||||||||||||||||||||||||||
| 908 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 909 | |||||||||||||||||||||||||||||
| 910 | Short poll is the default behavior where a weighted random set of | ||||||||||||||||||||||||||||
| 911 | machines is sampled on a C<ReceiveMessage> call. Thus, only the | ||||||||||||||||||||||||||||
| 912 | messages on the sampled machines are returned. If the number of | ||||||||||||||||||||||||||||
| 913 | messages in the queue is small (fewer than 1,000), you most likely get | ||||||||||||||||||||||||||||
| 914 | fewer messages than you requested per C<ReceiveMessage> call. If the | ||||||||||||||||||||||||||||
| 915 | number of messages in the queue is extremely small, you might not | ||||||||||||||||||||||||||||
| 916 | receive any messages in a particular C<ReceiveMessage> response. If | ||||||||||||||||||||||||||||
| 917 | this happens, repeat the request. | ||||||||||||||||||||||||||||
| 918 | |||||||||||||||||||||||||||||
| 919 | For each message returned, the response includes the following: | ||||||||||||||||||||||||||||
| 920 | |||||||||||||||||||||||||||||
| 921 | =over | ||||||||||||||||||||||||||||
| 922 | |||||||||||||||||||||||||||||
| 923 | =item * | ||||||||||||||||||||||||||||
| 924 | |||||||||||||||||||||||||||||
| 925 | The message body. | ||||||||||||||||||||||||||||
| 926 | |||||||||||||||||||||||||||||
| 927 | =item * | ||||||||||||||||||||||||||||
| 928 | |||||||||||||||||||||||||||||
| 929 | An MD5 digest of the message body. For information about MD5, see | ||||||||||||||||||||||||||||
| 930 | RFC1321 (https://www.ietf.org/rfc/rfc1321.txt). | ||||||||||||||||||||||||||||
| 931 | |||||||||||||||||||||||||||||
| 932 | =item * | ||||||||||||||||||||||||||||
| 933 | |||||||||||||||||||||||||||||
| 934 | The C<MessageId> you received when you sent the message to the queue. | ||||||||||||||||||||||||||||
| 935 | |||||||||||||||||||||||||||||
| 936 | =item * | ||||||||||||||||||||||||||||
| 937 | |||||||||||||||||||||||||||||
| 938 | The receipt handle. | ||||||||||||||||||||||||||||
| 939 | |||||||||||||||||||||||||||||
| 940 | =item * | ||||||||||||||||||||||||||||
| 941 | |||||||||||||||||||||||||||||
| 942 | The message attributes. | ||||||||||||||||||||||||||||
| 943 | |||||||||||||||||||||||||||||
| 944 | =item * | ||||||||||||||||||||||||||||
| 945 | |||||||||||||||||||||||||||||
| 946 | An MD5 digest of the message attributes. | ||||||||||||||||||||||||||||
| 947 | |||||||||||||||||||||||||||||
| 948 | =back | ||||||||||||||||||||||||||||
| 949 | |||||||||||||||||||||||||||||
| 950 | The receipt handle is the identifier you must provide when deleting the | ||||||||||||||||||||||||||||
| 951 | message. For more information, see Queue and Message Identifiers | ||||||||||||||||||||||||||||
| 952 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) | ||||||||||||||||||||||||||||
| 953 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 954 | |||||||||||||||||||||||||||||
| 955 | You can provide the C<VisibilityTimeout> parameter in your request. The | ||||||||||||||||||||||||||||
| 956 | parameter is applied to the messages that Amazon SQS returns in the | ||||||||||||||||||||||||||||
| 957 | response. If you don't include the parameter, the overall visibility | ||||||||||||||||||||||||||||
| 958 | timeout for the queue is used for the returned messages. For more | ||||||||||||||||||||||||||||
| 959 | information, see Visibility Timeout | ||||||||||||||||||||||||||||
| 960 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) | ||||||||||||||||||||||||||||
| 961 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 962 | |||||||||||||||||||||||||||||
| 963 | A message that isn't deleted or a message whose visibility isn't | ||||||||||||||||||||||||||||
| 964 | extended before the visibility timeout expires counts as a failed | ||||||||||||||||||||||||||||
| 965 | receive. Depending on the configuration of the queue, the message might | ||||||||||||||||||||||||||||
| 966 | be sent to the dead-letter queue. | ||||||||||||||||||||||||||||
| 967 | |||||||||||||||||||||||||||||
| 968 | In the future, new attributes might be added. If you write code that | ||||||||||||||||||||||||||||
| 969 | calls this action, we recommend that you structure your code so that it | ||||||||||||||||||||||||||||
| 970 | can handle new attributes gracefully. | ||||||||||||||||||||||||||||
| 971 | |||||||||||||||||||||||||||||
| 972 | |||||||||||||||||||||||||||||
| 973 | =head2 RemovePermission | ||||||||||||||||||||||||||||
| 974 | |||||||||||||||||||||||||||||
| 975 | =over | ||||||||||||||||||||||||||||
| 976 | |||||||||||||||||||||||||||||
| 977 | =item Label => Str | ||||||||||||||||||||||||||||
| 978 | |||||||||||||||||||||||||||||
| 979 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 980 | |||||||||||||||||||||||||||||
| 981 | |||||||||||||||||||||||||||||
| 982 | =back | ||||||||||||||||||||||||||||
| 983 | |||||||||||||||||||||||||||||
| 984 | Each argument is described in detail in: L<Paws::SQS::RemovePermission> | ||||||||||||||||||||||||||||
| 985 | |||||||||||||||||||||||||||||
| 986 | Returns: nothing | ||||||||||||||||||||||||||||
| 987 | |||||||||||||||||||||||||||||
| 988 | Revokes any permissions in the queue policy that matches the specified | ||||||||||||||||||||||||||||
| 989 | C<Label> parameter. | ||||||||||||||||||||||||||||
| 990 | |||||||||||||||||||||||||||||
| 991 | =over | ||||||||||||||||||||||||||||
| 992 | |||||||||||||||||||||||||||||
| 993 | =item * | ||||||||||||||||||||||||||||
| 994 | |||||||||||||||||||||||||||||
| 995 | Only the owner of a queue can remove permissions from it. | ||||||||||||||||||||||||||||
| 996 | |||||||||||||||||||||||||||||
| 997 | =item * | ||||||||||||||||||||||||||||
| 998 | |||||||||||||||||||||||||||||
| 999 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 1000 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 1001 | name | ||||||||||||||||||||||||||||
| 1002 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 1003 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1004 | |||||||||||||||||||||||||||||
| 1005 | =item * | ||||||||||||||||||||||||||||
| 1006 | |||||||||||||||||||||||||||||
| 1007 | To remove the ability to change queue permissions, you must deny | ||||||||||||||||||||||||||||
| 1008 | permission to the C<AddPermission>, C<RemovePermission>, and | ||||||||||||||||||||||||||||
| 1009 | C<SetQueueAttributes> actions in your IAM policy. | ||||||||||||||||||||||||||||
| 1010 | |||||||||||||||||||||||||||||
| 1011 | =back | ||||||||||||||||||||||||||||
| 1012 | |||||||||||||||||||||||||||||
| 1013 | |||||||||||||||||||||||||||||
| 1014 | |||||||||||||||||||||||||||||
| 1015 | =head2 SendMessage | ||||||||||||||||||||||||||||
| 1016 | |||||||||||||||||||||||||||||
| 1017 | =over | ||||||||||||||||||||||||||||
| 1018 | |||||||||||||||||||||||||||||
| 1019 | =item MessageBody => Str | ||||||||||||||||||||||||||||
| 1020 | |||||||||||||||||||||||||||||
| 1021 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 1022 | |||||||||||||||||||||||||||||
| 1023 | =item [DelaySeconds => Int] | ||||||||||||||||||||||||||||
| 1024 | |||||||||||||||||||||||||||||
| 1025 | =item [MessageAttributes => L<Paws::SQS::MessageBodyAttributeMap>] | ||||||||||||||||||||||||||||
| 1026 | |||||||||||||||||||||||||||||
| 1027 | =item [MessageDeduplicationId => Str] | ||||||||||||||||||||||||||||
| 1028 | |||||||||||||||||||||||||||||
| 1029 | =item [MessageGroupId => Str] | ||||||||||||||||||||||||||||
| 1030 | |||||||||||||||||||||||||||||
| 1031 | =item [MessageSystemAttributes => L<Paws::SQS::MessageBodySystemAttributeMap>] | ||||||||||||||||||||||||||||
| 1032 | |||||||||||||||||||||||||||||
| 1033 | |||||||||||||||||||||||||||||
| 1034 | =back | ||||||||||||||||||||||||||||
| 1035 | |||||||||||||||||||||||||||||
| 1036 | Each argument is described in detail in: L<Paws::SQS::SendMessage> | ||||||||||||||||||||||||||||
| 1037 | |||||||||||||||||||||||||||||
| 1038 | Returns: a L<Paws::SQS::SendMessageResult> instance | ||||||||||||||||||||||||||||
| 1039 | |||||||||||||||||||||||||||||
| 1040 | Delivers a message to the specified queue. | ||||||||||||||||||||||||||||
| 1041 | |||||||||||||||||||||||||||||
| 1042 | A message can include only XML, JSON, and unformatted text. The | ||||||||||||||||||||||||||||
| 1043 | following Unicode characters are allowed: | ||||||||||||||||||||||||||||
| 1044 | |||||||||||||||||||||||||||||
| 1045 | C<#x9> | C<#xA> | C<#xD> | C<#x20> to C<#xD7FF> | C<#xE000> to | ||||||||||||||||||||||||||||
| 1046 | C<#xFFFD> | C<#x10000> to C<#x10FFFF> | ||||||||||||||||||||||||||||
| 1047 | |||||||||||||||||||||||||||||
| 1048 | Any characters not included in this list will be rejected. For more | ||||||||||||||||||||||||||||
| 1049 | information, see the W3C specification for characters | ||||||||||||||||||||||||||||
| 1050 | (http://www.w3.org/TR/REC-xml/#charsets). | ||||||||||||||||||||||||||||
| 1051 | |||||||||||||||||||||||||||||
| 1052 | |||||||||||||||||||||||||||||
| 1053 | =head2 SendMessageBatch | ||||||||||||||||||||||||||||
| 1054 | |||||||||||||||||||||||||||||
| 1055 | =over | ||||||||||||||||||||||||||||
| 1056 | |||||||||||||||||||||||||||||
| 1057 | =item Entries => ArrayRef[L<Paws::SQS::SendMessageBatchRequestEntry>] | ||||||||||||||||||||||||||||
| 1058 | |||||||||||||||||||||||||||||
| 1059 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 1060 | |||||||||||||||||||||||||||||
| 1061 | |||||||||||||||||||||||||||||
| 1062 | =back | ||||||||||||||||||||||||||||
| 1063 | |||||||||||||||||||||||||||||
| 1064 | Each argument is described in detail in: L<Paws::SQS::SendMessageBatch> | ||||||||||||||||||||||||||||
| 1065 | |||||||||||||||||||||||||||||
| 1066 | Returns: a L<Paws::SQS::SendMessageBatchResult> instance | ||||||||||||||||||||||||||||
| 1067 | |||||||||||||||||||||||||||||
| 1068 | Delivers up to ten messages to the specified queue. This is a batch | ||||||||||||||||||||||||||||
| 1069 | version of C< SendMessage.> For a FIFO queue, multiple messages within | ||||||||||||||||||||||||||||
| 1070 | a single batch are enqueued in the order they are sent. | ||||||||||||||||||||||||||||
| 1071 | |||||||||||||||||||||||||||||
| 1072 | The result of sending each message is reported individually in the | ||||||||||||||||||||||||||||
| 1073 | response. Because the batch request can result in a combination of | ||||||||||||||||||||||||||||
| 1074 | successful and unsuccessful actions, you should check for batch errors | ||||||||||||||||||||||||||||
| 1075 | even when the call returns an HTTP status code of C<200>. | ||||||||||||||||||||||||||||
| 1076 | |||||||||||||||||||||||||||||
| 1077 | The maximum allowed individual message size and the maximum total | ||||||||||||||||||||||||||||
| 1078 | payload size (the sum of the individual lengths of all of the batched | ||||||||||||||||||||||||||||
| 1079 | messages) are both 256 KB (262,144 bytes). | ||||||||||||||||||||||||||||
| 1080 | |||||||||||||||||||||||||||||
| 1081 | A message can include only XML, JSON, and unformatted text. The | ||||||||||||||||||||||||||||
| 1082 | following Unicode characters are allowed: | ||||||||||||||||||||||||||||
| 1083 | |||||||||||||||||||||||||||||
| 1084 | C<#x9> | C<#xA> | C<#xD> | C<#x20> to C<#xD7FF> | C<#xE000> to | ||||||||||||||||||||||||||||
| 1085 | C<#xFFFD> | C<#x10000> to C<#x10FFFF> | ||||||||||||||||||||||||||||
| 1086 | |||||||||||||||||||||||||||||
| 1087 | Any characters not included in this list will be rejected. For more | ||||||||||||||||||||||||||||
| 1088 | information, see the W3C specification for characters | ||||||||||||||||||||||||||||
| 1089 | (http://www.w3.org/TR/REC-xml/#charsets). | ||||||||||||||||||||||||||||
| 1090 | |||||||||||||||||||||||||||||
| 1091 | If you don't specify the C<DelaySeconds> parameter for an entry, Amazon | ||||||||||||||||||||||||||||
| 1092 | SQS uses the default value for the queue. | ||||||||||||||||||||||||||||
| 1093 | |||||||||||||||||||||||||||||
| 1094 | Some actions take lists of parameters. These lists are specified using | ||||||||||||||||||||||||||||
| 1095 | the C<param.n> notation. Values of C<n> are integers starting from 1. | ||||||||||||||||||||||||||||
| 1096 | For example, a parameter list with two elements looks like this: | ||||||||||||||||||||||||||||
| 1097 | |||||||||||||||||||||||||||||
| 1098 | C<&AttributeName.1=first> | ||||||||||||||||||||||||||||
| 1099 | |||||||||||||||||||||||||||||
| 1100 | C<&AttributeName.2=second> | ||||||||||||||||||||||||||||
| 1101 | |||||||||||||||||||||||||||||
| 1102 | |||||||||||||||||||||||||||||
| 1103 | =head2 SetQueueAttributes | ||||||||||||||||||||||||||||
| 1104 | |||||||||||||||||||||||||||||
| 1105 | =over | ||||||||||||||||||||||||||||
| 1106 | |||||||||||||||||||||||||||||
| 1107 | =item Attributes => L<Paws::SQS::QueueAttributeMap> | ||||||||||||||||||||||||||||
| 1108 | |||||||||||||||||||||||||||||
| 1109 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 1110 | |||||||||||||||||||||||||||||
| 1111 | |||||||||||||||||||||||||||||
| 1112 | =back | ||||||||||||||||||||||||||||
| 1113 | |||||||||||||||||||||||||||||
| 1114 | Each argument is described in detail in: L<Paws::SQS::SetQueueAttributes> | ||||||||||||||||||||||||||||
| 1115 | |||||||||||||||||||||||||||||
| 1116 | Returns: nothing | ||||||||||||||||||||||||||||
| 1117 | |||||||||||||||||||||||||||||
| 1118 | Sets the value of one or more queue attributes. When you change a | ||||||||||||||||||||||||||||
| 1119 | queue's attributes, the change can take up to 60 seconds for most of | ||||||||||||||||||||||||||||
| 1120 | the attributes to propagate throughout the Amazon SQS system. Changes | ||||||||||||||||||||||||||||
| 1121 | made to the C<MessageRetentionPeriod> attribute can take up to 15 | ||||||||||||||||||||||||||||
| 1122 | minutes. | ||||||||||||||||||||||||||||
| 1123 | |||||||||||||||||||||||||||||
| 1124 | =over | ||||||||||||||||||||||||||||
| 1125 | |||||||||||||||||||||||||||||
| 1126 | =item * | ||||||||||||||||||||||||||||
| 1127 | |||||||||||||||||||||||||||||
| 1128 | In the future, new attributes might be added. If you write code that | ||||||||||||||||||||||||||||
| 1129 | calls this action, we recommend that you structure your code so that it | ||||||||||||||||||||||||||||
| 1130 | can handle new attributes gracefully. | ||||||||||||||||||||||||||||
| 1131 | |||||||||||||||||||||||||||||
| 1132 | =item * | ||||||||||||||||||||||||||||
| 1133 | |||||||||||||||||||||||||||||
| 1134 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 1135 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 1136 | name | ||||||||||||||||||||||||||||
| 1137 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 1138 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1139 | |||||||||||||||||||||||||||||
| 1140 | =item * | ||||||||||||||||||||||||||||
| 1141 | |||||||||||||||||||||||||||||
| 1142 | To remove the ability to change queue permissions, you must deny | ||||||||||||||||||||||||||||
| 1143 | permission to the C<AddPermission>, C<RemovePermission>, and | ||||||||||||||||||||||||||||
| 1144 | C<SetQueueAttributes> actions in your IAM policy. | ||||||||||||||||||||||||||||
| 1145 | |||||||||||||||||||||||||||||
| 1146 | =back | ||||||||||||||||||||||||||||
| 1147 | |||||||||||||||||||||||||||||
| 1148 | |||||||||||||||||||||||||||||
| 1149 | |||||||||||||||||||||||||||||
| 1150 | =head2 TagQueue | ||||||||||||||||||||||||||||
| 1151 | |||||||||||||||||||||||||||||
| 1152 | =over | ||||||||||||||||||||||||||||
| 1153 | |||||||||||||||||||||||||||||
| 1154 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 1155 | |||||||||||||||||||||||||||||
| 1156 | =item Tags => L<Paws::SQS::TagMap> | ||||||||||||||||||||||||||||
| 1157 | |||||||||||||||||||||||||||||
| 1158 | |||||||||||||||||||||||||||||
| 1159 | =back | ||||||||||||||||||||||||||||
| 1160 | |||||||||||||||||||||||||||||
| 1161 | Each argument is described in detail in: L<Paws::SQS::TagQueue> | ||||||||||||||||||||||||||||
| 1162 | |||||||||||||||||||||||||||||
| 1163 | Returns: nothing | ||||||||||||||||||||||||||||
| 1164 | |||||||||||||||||||||||||||||
| 1165 | Add cost allocation tags to the specified Amazon SQS queue. For an | ||||||||||||||||||||||||||||
| 1166 | overview, see Tagging Your Amazon SQS Queues | ||||||||||||||||||||||||||||
| 1167 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) | ||||||||||||||||||||||||||||
| 1168 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1169 | |||||||||||||||||||||||||||||
| 1170 | When you use queue tags, keep the following guidelines in mind: | ||||||||||||||||||||||||||||
| 1171 | |||||||||||||||||||||||||||||
| 1172 | =over | ||||||||||||||||||||||||||||
| 1173 | |||||||||||||||||||||||||||||
| 1174 | =item * | ||||||||||||||||||||||||||||
| 1175 | |||||||||||||||||||||||||||||
| 1176 | Adding more than 50 tags to a queue isn't recommended. | ||||||||||||||||||||||||||||
| 1177 | |||||||||||||||||||||||||||||
| 1178 | =item * | ||||||||||||||||||||||||||||
| 1179 | |||||||||||||||||||||||||||||
| 1180 | Tags don't have any semantic meaning. Amazon SQS interprets tags as | ||||||||||||||||||||||||||||
| 1181 | character strings. | ||||||||||||||||||||||||||||
| 1182 | |||||||||||||||||||||||||||||
| 1183 | =item * | ||||||||||||||||||||||||||||
| 1184 | |||||||||||||||||||||||||||||
| 1185 | Tags are case-sensitive. | ||||||||||||||||||||||||||||
| 1186 | |||||||||||||||||||||||||||||
| 1187 | =item * | ||||||||||||||||||||||||||||
| 1188 | |||||||||||||||||||||||||||||
| 1189 | A new tag with a key identical to that of an existing tag overwrites | ||||||||||||||||||||||||||||
| 1190 | the existing tag. | ||||||||||||||||||||||||||||
| 1191 | |||||||||||||||||||||||||||||
| 1192 | =back | ||||||||||||||||||||||||||||
| 1193 | |||||||||||||||||||||||||||||
| 1194 | For a full list of tag restrictions, see Quotas related to queues | ||||||||||||||||||||||||||||
| 1195 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues) | ||||||||||||||||||||||||||||
| 1196 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1197 | |||||||||||||||||||||||||||||
| 1198 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 1199 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 1200 | name | ||||||||||||||||||||||||||||
| 1201 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 1202 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1203 | |||||||||||||||||||||||||||||
| 1204 | |||||||||||||||||||||||||||||
| 1205 | =head2 UntagQueue | ||||||||||||||||||||||||||||
| 1206 | |||||||||||||||||||||||||||||
| 1207 | =over | ||||||||||||||||||||||||||||
| 1208 | |||||||||||||||||||||||||||||
| 1209 | =item QueueUrl => Str | ||||||||||||||||||||||||||||
| 1210 | |||||||||||||||||||||||||||||
| 1211 | =item TagKeys => ArrayRef[Str|Undef] | ||||||||||||||||||||||||||||
| 1212 | |||||||||||||||||||||||||||||
| 1213 | |||||||||||||||||||||||||||||
| 1214 | =back | ||||||||||||||||||||||||||||
| 1215 | |||||||||||||||||||||||||||||
| 1216 | Each argument is described in detail in: L<Paws::SQS::UntagQueue> | ||||||||||||||||||||||||||||
| 1217 | |||||||||||||||||||||||||||||
| 1218 | Returns: nothing | ||||||||||||||||||||||||||||
| 1219 | |||||||||||||||||||||||||||||
| 1220 | Remove cost allocation tags from the specified Amazon SQS queue. For an | ||||||||||||||||||||||||||||
| 1221 | overview, see Tagging Your Amazon SQS Queues | ||||||||||||||||||||||||||||
| 1222 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html) | ||||||||||||||||||||||||||||
| 1223 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1224 | |||||||||||||||||||||||||||||
| 1225 | Cross-account permissions don't apply to this action. For more | ||||||||||||||||||||||||||||
| 1226 | information, see Grant cross-account permissions to a role and a user | ||||||||||||||||||||||||||||
| 1227 | name | ||||||||||||||||||||||||||||
| 1228 | (https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name) | ||||||||||||||||||||||||||||
| 1229 | in the I<Amazon SQS Developer Guide>. | ||||||||||||||||||||||||||||
| 1230 | |||||||||||||||||||||||||||||
| 1231 | |||||||||||||||||||||||||||||
| 1232 | |||||||||||||||||||||||||||||
| 1233 | |||||||||||||||||||||||||||||
| 1234 | =head1 PAGINATORS | ||||||||||||||||||||||||||||
| 1235 | |||||||||||||||||||||||||||||
| 1236 | Paginator methods are helpers that repetively call methods that return partial results | ||||||||||||||||||||||||||||
| 1237 | |||||||||||||||||||||||||||||
| 1238 | =head2 ListAllDeadLetterSourceQueues(sub { },QueueUrl => Str, [MaxResults => Int, NextToken => Str]) | ||||||||||||||||||||||||||||
| 1239 | |||||||||||||||||||||||||||||
| 1240 | =head2 ListAllDeadLetterSourceQueues(QueueUrl => Str, [MaxResults => Int, NextToken => Str]) | ||||||||||||||||||||||||||||
| 1241 | |||||||||||||||||||||||||||||
| 1242 | |||||||||||||||||||||||||||||
| 1243 | If passed a sub as first parameter, it will call the sub for each element found in : | ||||||||||||||||||||||||||||
| 1244 | |||||||||||||||||||||||||||||
| 1245 | - queueUrls, passing the object as the first parameter, and the string 'queueUrls' as the second parameter | ||||||||||||||||||||||||||||
| 1246 | |||||||||||||||||||||||||||||
| 1247 | If not, it will return a a L<Paws::SQS::ListDeadLetterSourceQueuesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||||||||||||||||||||||||||||
| 1248 | |||||||||||||||||||||||||||||
| 1249 | |||||||||||||||||||||||||||||
| 1250 | =head2 ListAllQueues(sub { },[MaxResults => Int, NextToken => Str, QueueNamePrefix => Str]) | ||||||||||||||||||||||||||||
| 1251 | |||||||||||||||||||||||||||||
| 1252 | =head2 ListAllQueues([MaxResults => Int, NextToken => Str, QueueNamePrefix => Str]) | ||||||||||||||||||||||||||||
| 1253 | |||||||||||||||||||||||||||||
| 1254 | |||||||||||||||||||||||||||||
| 1255 | If passed a sub as first parameter, it will call the sub for each element found in : | ||||||||||||||||||||||||||||
| 1256 | |||||||||||||||||||||||||||||
| 1257 | - QueueUrls, passing the object as the first parameter, and the string 'QueueUrls' as the second parameter | ||||||||||||||||||||||||||||
| 1258 | |||||||||||||||||||||||||||||
| 1259 | If not, it will return a a L<Paws::SQS::ListQueuesResult> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. | ||||||||||||||||||||||||||||
| 1260 | |||||||||||||||||||||||||||||
| 1261 | |||||||||||||||||||||||||||||
| 1262 | |||||||||||||||||||||||||||||
| 1263 | |||||||||||||||||||||||||||||
| 1264 | |||||||||||||||||||||||||||||
| 1265 | =head1 SEE ALSO | ||||||||||||||||||||||||||||
| 1266 | |||||||||||||||||||||||||||||
| 1267 | This service class forms part of L<Paws> | ||||||||||||||||||||||||||||
| 1268 | |||||||||||||||||||||||||||||
| 1269 | =head1 BUGS and CONTRIBUTIONS | ||||||||||||||||||||||||||||
| 1270 | |||||||||||||||||||||||||||||
| 1271 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||||||||||||||||||||||||||||
| 1272 | |||||||||||||||||||||||||||||
| 1273 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||||||||||||||||||||||||||||
| 1274 | |||||||||||||||||||||||||||||
| 1275 | =cut | ||||||||||||||||||||||||||||
| 1276 | |||||||||||||||||||||||||||||