forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.go
1948 lines (1604 loc) · 70.8 KB
/
api.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// THIS FILE IS AUTOMATICALLY GENERATED. DO NOT EDIT.
// Package sqs provides a client for Amazon Simple Queue Service.
package sqs
import (
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/awsutil"
)
const opAddPermission = "AddPermission"
// AddPermissionRequest generates a request for the AddPermission operation.
func (c *SQS) AddPermissionRequest(input *AddPermissionInput) (req *aws.Request, output *AddPermissionOutput) {
op := &aws.Operation{
Name: opAddPermission,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &AddPermissionInput{}
}
req = c.newRequest(op, input, output)
output = &AddPermissionOutput{}
req.Data = output
return
}
// Adds a permission to a queue for a specific principal (http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P).
// This allows for sharing access to the queue.
//
// When you create a queue, you have full control access rights for the queue.
// Only you (as owner of the queue) can grant or deny permissions to the queue.
// For more information about these permissions, see Shared Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html)
// in the Amazon SQS Developer Guide.
//
// AddPermission writes an Amazon SQS-generated policy. If you want to write
// your own policy, use SetQueueAttributes to upload your policy. For more information
// about writing your own policy, see Using The Access Policy Language (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AccessPolicyLanguage.html)
// in the Amazon SQS Developer Guide.
//
// Some API actions take lists of parameters. These lists are specified using
// the param.n notation. Values of n are integers starting from 1. For example,
// a parameter list with two elements looks like this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) AddPermission(input *AddPermissionInput) (*AddPermissionOutput, error) {
req, out := c.AddPermissionRequest(input)
err := req.Send()
return out, err
}
const opChangeMessageVisibility = "ChangeMessageVisibility"
// ChangeMessageVisibilityRequest generates a request for the ChangeMessageVisibility operation.
func (c *SQS) ChangeMessageVisibilityRequest(input *ChangeMessageVisibilityInput) (req *aws.Request, output *ChangeMessageVisibilityOutput) {
op := &aws.Operation{
Name: opChangeMessageVisibility,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ChangeMessageVisibilityInput{}
}
req = c.newRequest(op, input, output)
output = &ChangeMessageVisibilityOutput{}
req.Data = output
return
}
// Changes the visibility timeout of a specified message in a queue to a new
// value. The maximum allowed timeout value you can set the value to is 12 hours.
// This means you can't extend the timeout of a message in an existing queue
// to more than a total visibility timeout of 12 hours. (For more information
// visibility timeout, see Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html)
// in the Amazon SQS Developer Guide.)
//
// For example, let's say you have a message and its default message visibility
// timeout is 30 minutes. You could call ChangeMessageVisiblity with a value
// of two hours and the effective timeout would be two hours and 30 minutes.
// When that time comes near you could again extend the time out by calling
// ChangeMessageVisiblity, but this time the maximum allowed timeout would be
// 9 hours and 30 minutes.
//
// There is a 120,000 limit for the number of inflight messages per queue.
// Messages are inflight after they have been received from the queue by a consuming
// component, but have not yet been deleted from the queue. If you reach the
// 120,000 limit, you will receive an OverLimit error message from Amazon SQS.
// To help avoid reaching the limit, you should delete the messages from the
// queue after they have been processed. You can also increase the number of
// queues you use to process the messages.
//
// If you attempt to set the VisibilityTimeout to an amount more than the maximum
// time left, Amazon SQS returns an error. It will not automatically recalculate
// and increase the timeout to the maximum time remaining. Unlike with a queue,
// when you change the visibility timeout for a specific message, that timeout
// value is applied immediately but is not saved in memory for that message.
// If you don't delete a message after it is received, the visibility timeout
// for the message the next time it is received reverts to the original timeout
// value, not the value you set with the ChangeMessageVisibility action.
func (c *SQS) ChangeMessageVisibility(input *ChangeMessageVisibilityInput) (*ChangeMessageVisibilityOutput, error) {
req, out := c.ChangeMessageVisibilityRequest(input)
err := req.Send()
return out, err
}
const opChangeMessageVisibilityBatch = "ChangeMessageVisibilityBatch"
// ChangeMessageVisibilityBatchRequest generates a request for the ChangeMessageVisibilityBatch operation.
func (c *SQS) ChangeMessageVisibilityBatchRequest(input *ChangeMessageVisibilityBatchInput) (req *aws.Request, output *ChangeMessageVisibilityBatchOutput) {
op := &aws.Operation{
Name: opChangeMessageVisibilityBatch,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ChangeMessageVisibilityBatchInput{}
}
req = c.newRequest(op, input, output)
output = &ChangeMessageVisibilityBatchOutput{}
req.Data = output
return
}
// Changes the visibility timeout of multiple messages. This is a batch version
// of ChangeMessageVisibility. The result of the action on each message is reported
// individually in the response. You can send up to 10 ChangeMessageVisibility
// requests with each ChangeMessageVisibilityBatch action.
//
// Because the batch request can result in a combination of successful and
// unsuccessful actions, you should check for batch errors even when the call
// returns an HTTP status code of 200. Some API actions take lists of parameters.
// These lists are specified using the param.n notation. Values of n are integers
// starting from 1. For example, a parameter list with two elements looks like
// this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) ChangeMessageVisibilityBatch(input *ChangeMessageVisibilityBatchInput) (*ChangeMessageVisibilityBatchOutput, error) {
req, out := c.ChangeMessageVisibilityBatchRequest(input)
err := req.Send()
return out, err
}
const opCreateQueue = "CreateQueue"
// CreateQueueRequest generates a request for the CreateQueue operation.
func (c *SQS) CreateQueueRequest(input *CreateQueueInput) (req *aws.Request, output *CreateQueueOutput) {
op := &aws.Operation{
Name: opCreateQueue,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreateQueueInput{}
}
req = c.newRequest(op, input, output)
output = &CreateQueueOutput{}
req.Data = output
return
}
// Creates a new queue, or returns the URL of an existing one. When you request
// CreateQueue, you provide a name for the queue. To successfully create a new
// queue, you must provide a name that is unique within the scope of your own
// queues.
//
// If you delete a queue, you must wait at least 60 seconds before creating
// a queue with the same name.
//
// You may pass one or more attributes in the request. If you do not provide
// a value for any attribute, the queue will have the default value for that
// attribute. Permitted attributes are the same that can be set using SetQueueAttributes.
//
// Use GetQueueUrl to get a queue's URL. GetQueueUrl requires only the QueueName
// parameter.
//
// If you provide the name of an existing queue, along with the exact names
// and values of all the queue's attributes, CreateQueue returns the queue URL
// for the existing queue. If the queue name, attribute names, or attribute
// values do not match an existing queue, CreateQueue returns an error.
//
// Some API actions take lists of parameters. These lists are specified using
// the param.n notation. Values of n are integers starting from 1. For example,
// a parameter list with two elements looks like this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) CreateQueue(input *CreateQueueInput) (*CreateQueueOutput, error) {
req, out := c.CreateQueueRequest(input)
err := req.Send()
return out, err
}
const opDeleteMessage = "DeleteMessage"
// DeleteMessageRequest generates a request for the DeleteMessage operation.
func (c *SQS) DeleteMessageRequest(input *DeleteMessageInput) (req *aws.Request, output *DeleteMessageOutput) {
op := &aws.Operation{
Name: opDeleteMessage,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteMessageInput{}
}
req = c.newRequest(op, input, output)
output = &DeleteMessageOutput{}
req.Data = output
return
}
// Deletes the specified message from the specified queue. You specify the message
// by using the message's receipt handle and not the message ID you received
// when you sent the message. Even if the message is locked by another reader
// due to the visibility timeout setting, it is still deleted from the queue.
// If you leave a message in the queue for longer than the queue's configured
// retention period, Amazon SQS automatically deletes it.
//
// The receipt handle is associated with a specific instance of receiving
// the message. If you receive a message more than once, the receipt handle
// you get each time you receive the message is different. When you request
// DeleteMessage, if you don't provide the most recently received receipt handle
// for the message, the request will still succeed, but the message might not
// be deleted.
//
// It is possible you will receive a message even after you have deleted
// it. This might happen on rare occasions if one of the servers storing a copy
// of the message is unavailable when you request to delete the message. The
// copy remains on the server and might be returned to you again on a subsequent
// receive request. You should create your system to be idempotent so that receiving
// a particular message more than once is not a problem.
func (c *SQS) DeleteMessage(input *DeleteMessageInput) (*DeleteMessageOutput, error) {
req, out := c.DeleteMessageRequest(input)
err := req.Send()
return out, err
}
const opDeleteMessageBatch = "DeleteMessageBatch"
// DeleteMessageBatchRequest generates a request for the DeleteMessageBatch operation.
func (c *SQS) DeleteMessageBatchRequest(input *DeleteMessageBatchInput) (req *aws.Request, output *DeleteMessageBatchOutput) {
op := &aws.Operation{
Name: opDeleteMessageBatch,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteMessageBatchInput{}
}
req = c.newRequest(op, input, output)
output = &DeleteMessageBatchOutput{}
req.Data = output
return
}
// Deletes up to ten messages from the specified queue. This is a batch version
// of DeleteMessage. The result of the delete action on each message is reported
// individually in the response.
//
// Because the batch request can result in a combination of successful and
// unsuccessful actions, you should check for batch errors even when the call
// returns an HTTP status code of 200.
//
// Some API actions take lists of parameters. These lists are specified using
// the param.n notation. Values of n are integers starting from 1. For example,
// a parameter list with two elements looks like this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) DeleteMessageBatch(input *DeleteMessageBatchInput) (*DeleteMessageBatchOutput, error) {
req, out := c.DeleteMessageBatchRequest(input)
err := req.Send()
return out, err
}
const opDeleteQueue = "DeleteQueue"
// DeleteQueueRequest generates a request for the DeleteQueue operation.
func (c *SQS) DeleteQueueRequest(input *DeleteQueueInput) (req *aws.Request, output *DeleteQueueOutput) {
op := &aws.Operation{
Name: opDeleteQueue,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &DeleteQueueInput{}
}
req = c.newRequest(op, input, output)
output = &DeleteQueueOutput{}
req.Data = output
return
}
// Deletes the queue specified by the queue URL, regardless of whether the queue
// is empty. If the specified queue does not exist, Amazon SQS returns a successful
// response.
//
// Use DeleteQueue with care; once you delete your queue, any messages in
// the queue are no longer available.
//
// When you delete a queue, the deletion process takes up to 60 seconds.
// Requests you send involving that queue during the 60 seconds might succeed.
// For example, a SendMessage request might succeed, but after the 60 seconds,
// the queue and that message you sent no longer exist. Also, when you delete
// a queue, you must wait at least 60 seconds before creating a queue with the
// same name.
//
// We reserve the right to delete queues that have had no activity for more
// than 30 days. For more information, see How Amazon SQS Queues Work (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSConcepts.html)
// in the Amazon SQS Developer Guide.
func (c *SQS) DeleteQueue(input *DeleteQueueInput) (*DeleteQueueOutput, error) {
req, out := c.DeleteQueueRequest(input)
err := req.Send()
return out, err
}
const opGetQueueAttributes = "GetQueueAttributes"
// GetQueueAttributesRequest generates a request for the GetQueueAttributes operation.
func (c *SQS) GetQueueAttributesRequest(input *GetQueueAttributesInput) (req *aws.Request, output *GetQueueAttributesOutput) {
op := &aws.Operation{
Name: opGetQueueAttributes,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetQueueAttributesInput{}
}
req = c.newRequest(op, input, output)
output = &GetQueueAttributesOutput{}
req.Data = output
return
}
// Gets attributes for the specified queue. The following attributes are supported:
// All - returns all values. ApproximateNumberOfMessages - returns the approximate
// number of visible messages in a queue. For more information, see Resources
// Required to Process Messages (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html)
// in the Amazon SQS Developer Guide. ApproximateNumberOfMessagesNotVisible
// - returns the approximate number of messages that are not timed-out and not
// deleted. For more information, see Resources Required to Process Messages
// (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ApproximateNumber.html)
// in the Amazon SQS Developer Guide. VisibilityTimeout - returns the visibility
// timeout for the queue. For more information about visibility timeout, see
// Visibility Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html)
// in the Amazon SQS Developer Guide. CreatedTimestamp - returns the time when
// the queue was created (epoch time in seconds). LastModifiedTimestamp - returns
// the time when the queue was last changed (epoch time in seconds). Policy
// - returns the queue's policy. MaximumMessageSize - returns the limit of
// how many bytes a message can contain before Amazon SQS rejects it. MessageRetentionPeriod
// - returns the number of seconds Amazon SQS retains a message. QueueArn -
// returns the queue's Amazon resource name (ARN). ApproximateNumberOfMessagesDelayed
// - returns the approximate number of messages that are pending to be added
// to the queue. DelaySeconds - returns the default delay on the queue in seconds.
// ReceiveMessageWaitTimeSeconds - returns the time for which a ReceiveMessage
// call will wait for a message to arrive. RedrivePolicy - returns the parameters
// for dead letter queue functionality of the source queue. For more information
// about RedrivePolicy and dead letter queues, see Using Amazon SQS Dead Letter
// Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html)
// in the Amazon SQS Developer Guide.
//
// Going forward, new attributes might be added. If you are writing code that
// calls this action, we recommend that you structure your code so that it can
// handle new attributes gracefully. Some API actions take lists of parameters.
// These lists are specified using the param.n notation. Values of n are integers
// starting from 1. For example, a parameter list with two elements looks like
// this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) GetQueueAttributes(input *GetQueueAttributesInput) (*GetQueueAttributesOutput, error) {
req, out := c.GetQueueAttributesRequest(input)
err := req.Send()
return out, err
}
const opGetQueueURL = "GetQueueUrl"
// GetQueueURLRequest generates a request for the GetQueueURL operation.
func (c *SQS) GetQueueURLRequest(input *GetQueueURLInput) (req *aws.Request, output *GetQueueURLOutput) {
op := &aws.Operation{
Name: opGetQueueURL,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &GetQueueURLInput{}
}
req = c.newRequest(op, input, output)
output = &GetQueueURLOutput{}
req.Data = output
return
}
// Returns the URL of an existing queue. This action provides a simple way to
// retrieve the URL of an Amazon SQS queue.
//
// To access a queue that belongs to another AWS account, use the QueueOwnerAWSAccountId
// parameter to specify the account ID of the queue's owner. The queue's owner
// must grant you permission to access the queue. For more information about
// shared queue access, see AddPermission or go to Shared Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html)
// in the Amazon SQS Developer Guide.
func (c *SQS) GetQueueURL(input *GetQueueURLInput) (*GetQueueURLOutput, error) {
req, out := c.GetQueueURLRequest(input)
err := req.Send()
return out, err
}
const opListDeadLetterSourceQueues = "ListDeadLetterSourceQueues"
// ListDeadLetterSourceQueuesRequest generates a request for the ListDeadLetterSourceQueues operation.
func (c *SQS) ListDeadLetterSourceQueuesRequest(input *ListDeadLetterSourceQueuesInput) (req *aws.Request, output *ListDeadLetterSourceQueuesOutput) {
op := &aws.Operation{
Name: opListDeadLetterSourceQueues,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListDeadLetterSourceQueuesInput{}
}
req = c.newRequest(op, input, output)
output = &ListDeadLetterSourceQueuesOutput{}
req.Data = output
return
}
// Returns a list of your queues that have the RedrivePolicy queue attribute
// configured with a dead letter queue.
//
// For more information about using dead letter queues, see Using Amazon SQS
// Dead Letter Queues (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/SQSDeadLetterQueue.html).
func (c *SQS) ListDeadLetterSourceQueues(input *ListDeadLetterSourceQueuesInput) (*ListDeadLetterSourceQueuesOutput, error) {
req, out := c.ListDeadLetterSourceQueuesRequest(input)
err := req.Send()
return out, err
}
const opListQueues = "ListQueues"
// ListQueuesRequest generates a request for the ListQueues operation.
func (c *SQS) ListQueuesRequest(input *ListQueuesInput) (req *aws.Request, output *ListQueuesOutput) {
op := &aws.Operation{
Name: opListQueues,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ListQueuesInput{}
}
req = c.newRequest(op, input, output)
output = &ListQueuesOutput{}
req.Data = output
return
}
// Returns a list of your queues. The maximum number of queues that can be returned
// is 1000. If you specify a value for the optional QueueNamePrefix parameter,
// only queues with a name beginning with the specified value are returned.
func (c *SQS) ListQueues(input *ListQueuesInput) (*ListQueuesOutput, error) {
req, out := c.ListQueuesRequest(input)
err := req.Send()
return out, err
}
const opPurgeQueue = "PurgeQueue"
// PurgeQueueRequest generates a request for the PurgeQueue operation.
func (c *SQS) PurgeQueueRequest(input *PurgeQueueInput) (req *aws.Request, output *PurgeQueueOutput) {
op := &aws.Operation{
Name: opPurgeQueue,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &PurgeQueueInput{}
}
req = c.newRequest(op, input, output)
output = &PurgeQueueOutput{}
req.Data = output
return
}
// Deletes the messages in a queue specified by the queue URL.
//
// When you use the PurgeQueue API, the deleted messages in the queue cannot
// be retrieved. When you purge a queue, the message deletion process takes
// up to 60 seconds. All messages sent to the queue before calling PurgeQueue
// will be deleted; messages sent to the queue while it is being purged may
// be deleted. While the queue is being purged, messages sent to the queue before
// PurgeQueue was called may be received, but will be deleted within the next
// minute.
func (c *SQS) PurgeQueue(input *PurgeQueueInput) (*PurgeQueueOutput, error) {
req, out := c.PurgeQueueRequest(input)
err := req.Send()
return out, err
}
const opReceiveMessage = "ReceiveMessage"
// ReceiveMessageRequest generates a request for the ReceiveMessage operation.
func (c *SQS) ReceiveMessageRequest(input *ReceiveMessageInput) (req *aws.Request, output *ReceiveMessageOutput) {
op := &aws.Operation{
Name: opReceiveMessage,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &ReceiveMessageInput{}
}
req = c.newRequest(op, input, output)
output = &ReceiveMessageOutput{}
req.Data = output
return
}
// Retrieves one or more messages, with a maximum limit of 10 messages, from
// the specified queue. Long poll support is enabled by using the WaitTimeSeconds
// parameter. For more information, see Amazon SQS Long Poll (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html)
// in the Amazon SQS Developer Guide.
//
// Short poll is the default behavior where a weighted random set of machines
// is sampled on a ReceiveMessage call. This means only the messages on the
// sampled machines are returned. If the number of messages in the queue is
// small (less than 1000), it is likely you will get fewer messages than you
// requested per ReceiveMessage call. If the number of messages in the queue
// is extremely small, you might not receive any messages in a particular ReceiveMessage
// response; in which case you should repeat the request.
//
// For each message returned, the response includes the following:
//
// Message body
//
// MD5 digest of the message body. For information about MD5, go to http://www.faqs.org/rfcs/rfc1321.html
// (http://www.faqs.org/rfcs/rfc1321.html).
//
// Message ID you received when you sent the message to the queue.
//
// Receipt handle.
//
// Message attributes.
//
// MD5 digest of the message attributes.
//
// The receipt handle is the identifier you must provide when deleting the
// message. For more information, see Queue and Message Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/ImportantIdentifiers.html)
// in the Amazon SQS Developer Guide.
//
// You can provide the VisibilityTimeout parameter in your request, which
// will be applied to the messages that Amazon SQS returns in the response.
// If you do not include the parameter, the overall visibility timeout for the
// queue is used for the returned messages. For more information, see Visibility
// Timeout (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AboutVT.html)
// in the Amazon SQS Developer Guide.
//
// Going forward, new attributes might be added. If you are writing code
// that calls this action, we recommend that you structure your code so that
// it can handle new attributes gracefully.
func (c *SQS) ReceiveMessage(input *ReceiveMessageInput) (*ReceiveMessageOutput, error) {
req, out := c.ReceiveMessageRequest(input)
err := req.Send()
return out, err
}
const opRemovePermission = "RemovePermission"
// RemovePermissionRequest generates a request for the RemovePermission operation.
func (c *SQS) RemovePermissionRequest(input *RemovePermissionInput) (req *aws.Request, output *RemovePermissionOutput) {
op := &aws.Operation{
Name: opRemovePermission,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &RemovePermissionInput{}
}
req = c.newRequest(op, input, output)
output = &RemovePermissionOutput{}
req.Data = output
return
}
// Revokes any permissions in the queue policy that matches the specified Label
// parameter. Only the owner of the queue can remove permissions.
func (c *SQS) RemovePermission(input *RemovePermissionInput) (*RemovePermissionOutput, error) {
req, out := c.RemovePermissionRequest(input)
err := req.Send()
return out, err
}
const opSendMessage = "SendMessage"
// SendMessageRequest generates a request for the SendMessage operation.
func (c *SQS) SendMessageRequest(input *SendMessageInput) (req *aws.Request, output *SendMessageOutput) {
op := &aws.Operation{
Name: opSendMessage,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SendMessageInput{}
}
req = c.newRequest(op, input, output)
output = &SendMessageOutput{}
req.Data = output
return
}
// Delivers a message to the specified queue. With Amazon SQS, you now have
// the ability to send large payload messages that are up to 256KB (262,144
// bytes) in size. To send large payloads, you must use an AWS SDK that supports
// SigV4 signing. To verify whether SigV4 is supported for an AWS SDK, check
// the SDK release notes.
//
// The following list shows the characters (in Unicode) allowed in your message,
// according to the W3C XML specification. For more information, go to http://www.w3.org/TR/REC-xml/#charsets
// (http://www.w3.org/TR/REC-xml/#charsets) If you send any characters not included
// in the list, your request will be rejected.
//
// #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD] | [#x10000 to #x10FFFF]
func (c *SQS) SendMessage(input *SendMessageInput) (*SendMessageOutput, error) {
req, out := c.SendMessageRequest(input)
err := req.Send()
return out, err
}
const opSendMessageBatch = "SendMessageBatch"
// SendMessageBatchRequest generates a request for the SendMessageBatch operation.
func (c *SQS) SendMessageBatchRequest(input *SendMessageBatchInput) (req *aws.Request, output *SendMessageBatchOutput) {
op := &aws.Operation{
Name: opSendMessageBatch,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SendMessageBatchInput{}
}
req = c.newRequest(op, input, output)
output = &SendMessageBatchOutput{}
req.Data = output
return
}
// Delivers up to ten messages to the specified queue. This is a batch version
// of SendMessage. The result of the send action on each message is reported
// individually in the response. The maximum allowed individual message size
// is 256 KB (262,144 bytes).
//
// The maximum total payload size (i.e., the sum of all a batch's individual
// message lengths) is also 256 KB (262,144 bytes).
//
// If the DelaySeconds parameter is not specified for an entry, the default
// for the queue is used.
//
// The following list shows the characters (in Unicode) that are allowed in
// your message, according to the W3C XML specification. For more information,
// go to http://www.faqs.org/rfcs/rfc1321.html (http://www.faqs.org/rfcs/rfc1321.html).
// If you send any characters that are not included in the list, your request
// will be rejected. #x9 | #xA | #xD | [#x20 to #xD7FF] | [#xE000 to #xFFFD]
// | [#x10000 to #x10FFFF]
//
// Because the batch request can result in a combination of successful and
// unsuccessful actions, you should check for batch errors even when the call
// returns an HTTP status code of 200. Some API actions take lists of parameters.
// These lists are specified using the param.n notation. Values of n are integers
// starting from 1. For example, a parameter list with two elements looks like
// this: &Attribute.1=this
//
// &Attribute.2=that
func (c *SQS) SendMessageBatch(input *SendMessageBatchInput) (*SendMessageBatchOutput, error) {
req, out := c.SendMessageBatchRequest(input)
err := req.Send()
return out, err
}
const opSetQueueAttributes = "SetQueueAttributes"
// SetQueueAttributesRequest generates a request for the SetQueueAttributes operation.
func (c *SQS) SetQueueAttributesRequest(input *SetQueueAttributesInput) (req *aws.Request, output *SetQueueAttributesOutput) {
op := &aws.Operation{
Name: opSetQueueAttributes,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &SetQueueAttributesInput{}
}
req = c.newRequest(op, input, output)
output = &SetQueueAttributesOutput{}
req.Data = output
return
}
// Sets the value of one or more queue attributes. When you change a queue's
// attributes, the change can take up to 60 seconds for most of the attributes
// to propagate throughout the SQS system. Changes made to the MessageRetentionPeriod
// attribute can take up to 15 minutes.
//
// Going forward, new attributes might be added. If you are writing code that
// calls this action, we recommend that you structure your code so that it can
// handle new attributes gracefully.
func (c *SQS) SetQueueAttributes(input *SetQueueAttributesInput) (*SetQueueAttributesOutput, error) {
req, out := c.SetQueueAttributesRequest(input)
err := req.Send()
return out, err
}
type AddPermissionInput struct {
// The AWS account number of the principal (http://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P)
// who will be given permission. The principal must have an AWS account, but
// does not need to be signed up for Amazon SQS. For information about locating
// the AWS account identification, see Your AWS Identifiers (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/AWSCredentials.html)
// in the Amazon SQS Developer Guide.
AWSAccountIDs []*string `locationName:"AWSAccountIds" locationNameList:"AWSAccountId" type:"list" flattened:"true" required:"true"`
// The action the client wants to allow for the specified principal. The following
// are valid values: * | SendMessage | ReceiveMessage | DeleteMessage | ChangeMessageVisibility
// | GetQueueAttributes | GetQueueUrl. For more information about these actions,
// see Understanding Permissions (http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/acp-overview.html#PermissionTypes)
// in the Amazon SQS Developer Guide.
//
// Specifying SendMessage, DeleteMessage, or ChangeMessageVisibility for the
// ActionName.n also grants permissions for the corresponding batch versions
// of those actions: SendMessageBatch, DeleteMessageBatch, and ChangeMessageVisibilityBatch.
Actions []*string `locationNameList:"ActionName" type:"list" flattened:"true" required:"true"`
// The unique identification of the permission you're setting (e.g., AliceSendMessage).
// Constraints: Maximum 80 characters; alphanumeric characters, hyphens (-),
// and underscores (_) are allowed.
Label *string `type:"string" required:"true"`
// The URL of the Amazon SQS queue to take action on.
QueueURL *string `locationName:"QueueUrl" type:"string" required:"true"`
metadataAddPermissionInput `json:"-" xml:"-"`
}
type metadataAddPermissionInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s AddPermissionInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s AddPermissionInput) GoString() string {
return s.String()
}
type AddPermissionOutput struct {
metadataAddPermissionOutput `json:"-" xml:"-"`
}
type metadataAddPermissionOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s AddPermissionOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s AddPermissionOutput) GoString() string {
return s.String()
}
// This is used in the responses of batch API to give a detailed description
// of the result of an action on each entry in the request.
type BatchResultErrorEntry struct {
// An error code representing why the action failed on this entry.
Code *string `type:"string" required:"true"`
// The id of an entry in a batch request.
ID *string `locationName:"Id" type:"string" required:"true"`
// A message explaining why the action failed on this entry.
Message *string `type:"string"`
// Whether the error happened due to the sender's fault.
SenderFault *bool `type:"boolean" required:"true"`
metadataBatchResultErrorEntry `json:"-" xml:"-"`
}
type metadataBatchResultErrorEntry struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s BatchResultErrorEntry) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s BatchResultErrorEntry) GoString() string {
return s.String()
}
type ChangeMessageVisibilityBatchInput struct {
// A list of receipt handles of the messages for which the visibility timeout
// must be changed.
Entries []*ChangeMessageVisibilityBatchRequestEntry `locationNameList:"ChangeMessageVisibilityBatchRequestEntry" type:"list" flattened:"true" required:"true"`
// The URL of the Amazon SQS queue to take action on.
QueueURL *string `locationName:"QueueUrl" type:"string" required:"true"`
metadataChangeMessageVisibilityBatchInput `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityBatchInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityBatchInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityBatchInput) GoString() string {
return s.String()
}
// For each message in the batch, the response contains a ChangeMessageVisibilityBatchResultEntry
// tag if the message succeeds or a BatchResultErrorEntry tag if the message
// fails.
type ChangeMessageVisibilityBatchOutput struct {
// A list of BatchResultErrorEntry items.
Failed []*BatchResultErrorEntry `locationNameList:"BatchResultErrorEntry" type:"list" flattened:"true" required:"true"`
// A list of ChangeMessageVisibilityBatchResultEntry items.
Successful []*ChangeMessageVisibilityBatchResultEntry `locationNameList:"ChangeMessageVisibilityBatchResultEntry" type:"list" flattened:"true" required:"true"`
metadataChangeMessageVisibilityBatchOutput `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityBatchOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityBatchOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityBatchOutput) GoString() string {
return s.String()
}
// Encloses a receipt handle and an entry id for each message in ChangeMessageVisibilityBatch.
//
// All of the following parameters are list parameters that must be prefixed
// with ChangeMessageVisibilityBatchRequestEntry.n, where n is an integer value
// starting with 1. For example, a parameter list for this action might look
// like this:
//
// &ChangeMessageVisibilityBatchRequestEntry.1.Id=change_visibility_msg_2
//
// &ChangeMessageVisibilityBatchRequestEntry.1.ReceiptHandle=Your_Receipt_Handle
//
// &ChangeMessageVisibilityBatchRequestEntry.1.VisibilityTimeout=45
type ChangeMessageVisibilityBatchRequestEntry struct {
// An identifier for this particular receipt handle. This is used to communicate
// the result. Note that the Ids of a batch request need to be unique within
// the request.
ID *string `locationName:"Id" type:"string" required:"true"`
// A receipt handle.
ReceiptHandle *string `type:"string" required:"true"`
// The new value (in seconds) for the message's visibility timeout.
VisibilityTimeout *int64 `type:"integer"`
metadataChangeMessageVisibilityBatchRequestEntry `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityBatchRequestEntry struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityBatchRequestEntry) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityBatchRequestEntry) GoString() string {
return s.String()
}
// Encloses the id of an entry in ChangeMessageVisibilityBatch.
type ChangeMessageVisibilityBatchResultEntry struct {
// Represents a message whose visibility timeout has been changed successfully.
ID *string `locationName:"Id" type:"string" required:"true"`
metadataChangeMessageVisibilityBatchResultEntry `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityBatchResultEntry struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityBatchResultEntry) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityBatchResultEntry) GoString() string {
return s.String()
}
type ChangeMessageVisibilityInput struct {
// The URL of the Amazon SQS queue to take action on.
QueueURL *string `locationName:"QueueUrl" type:"string" required:"true"`
// The receipt handle associated with the message whose visibility timeout should
// be changed. This parameter is returned by the ReceiveMessage action.
ReceiptHandle *string `type:"string" required:"true"`
// The new value (in seconds - from 0 to 43200 - maximum 12 hours) for the message's
// visibility timeout.
VisibilityTimeout *int64 `type:"integer" required:"true"`
metadataChangeMessageVisibilityInput `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityInput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityInput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityInput) GoString() string {
return s.String()
}
type ChangeMessageVisibilityOutput struct {
metadataChangeMessageVisibilityOutput `json:"-" xml:"-"`
}
type metadataChangeMessageVisibilityOutput struct {
SDKShapeTraits bool `type:"structure"`
}
// String returns the string representation
func (s ChangeMessageVisibilityOutput) String() string {
return awsutil.StringValue(s)
}
// GoString returns the string representation
func (s ChangeMessageVisibilityOutput) GoString() string {
return s.String()
}
type CreateQueueInput struct {
// A map of attributes with their corresponding values.
//
// The following lists the names, descriptions, and values of the special request
// parameters the CreateQueue action uses:
//