aws-sdk-sqs 1.10.0 → 1.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +5 -5
- data/lib/aws-sdk-sqs.rb +11 -5
- data/lib/aws-sdk-sqs/client.rb +514 -274
- data/lib/aws-sdk-sqs/client_api.rb +72 -0
- data/lib/aws-sdk-sqs/customizations.rb +2 -0
- data/lib/aws-sdk-sqs/errors.rb +200 -0
- data/lib/aws-sdk-sqs/message.rb +6 -2
- data/lib/aws-sdk-sqs/plugins/md5s.rb +9 -7
- data/lib/aws-sdk-sqs/plugins/queue_urls.rb +13 -1
- data/lib/aws-sdk-sqs/queue.rb +109 -61
- data/lib/aws-sdk-sqs/queue_poller.rb +4 -2
- data/lib/aws-sdk-sqs/resource.rb +93 -39
- data/lib/aws-sdk-sqs/types.rb +540 -138
- metadata +8 -8
data/lib/aws-sdk-sqs/resource.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -6,6 +8,18 @@
|
|
6
8
|
# WARNING ABOUT GENERATED CODE
|
7
9
|
|
8
10
|
module Aws::SQS
|
11
|
+
|
12
|
+
# This class provides a resource oriented interface for SQS.
|
13
|
+
# To create a resource object:
|
14
|
+
#
|
15
|
+
# resource = Aws::SQS::Resource.new(region: 'us-west-2')
|
16
|
+
#
|
17
|
+
# You can supply a client object with custom configuration that will be used for all resource operations.
|
18
|
+
# If you do not pass `:client`, a default client will be constructed.
|
19
|
+
#
|
20
|
+
# client = Aws::SQS::Client.new(region: 'us-west-2')
|
21
|
+
# resource = Aws::SQS::Resource.new(client: client)
|
22
|
+
#
|
9
23
|
class Resource
|
10
24
|
|
11
25
|
# @param options ({})
|
@@ -28,6 +42,9 @@ module Aws::SQS
|
|
28
42
|
# attributes: {
|
29
43
|
# "All" => "String",
|
30
44
|
# },
|
45
|
+
# tags: {
|
46
|
+
# "TagKey" => "TagValue",
|
47
|
+
# },
|
31
48
|
# })
|
32
49
|
# @param [Hash] options ({})
|
33
50
|
# @option options [required, String] :queue_name
|
@@ -47,39 +64,39 @@ module Aws::SQS
|
|
47
64
|
# The following lists the names, descriptions, and values of the special
|
48
65
|
# request parameters that the `CreateQueue` action uses:
|
49
66
|
#
|
50
|
-
# * `DelaySeconds`
|
67
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
51
68
|
# delivery of all messages in the queue is delayed. Valid values: An
|
52
69
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
53
70
|
#
|
54
|
-
# * `MaximumMessageSize`
|
71
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
55
72
|
# contain before Amazon SQS rejects it. Valid values: An integer from
|
56
73
|
# 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default: 262,144
|
57
74
|
# (256 KiB).
|
58
75
|
#
|
59
|
-
# * `MessageRetentionPeriod`
|
76
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for which
|
60
77
|
# Amazon SQS retains a message. Valid values: An integer from 60
|
61
78
|
# seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
|
62
79
|
# (4 days).
|
63
80
|
#
|
64
|
-
# * `Policy`
|
81
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
65
82
|
# information about policy structure, see [Overview of AWS IAM
|
66
83
|
# Policies][1] in the *Amazon IAM User Guide*.
|
67
84
|
#
|
68
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
85
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
69
86
|
# for which a ` ReceiveMessage ` action waits for a message to arrive.
|
70
87
|
# Valid values: An integer from 0 to 20 (seconds). Default: 0.
|
71
88
|
#
|
72
|
-
# * `RedrivePolicy`
|
73
|
-
# dead-letter queue functionality of the source queue
|
74
|
-
# information about the redrive policy and
|
75
|
-
# [Using Amazon SQS Dead-Letter Queues][2] in
|
76
|
-
# Service Developer Guide*.
|
89
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
90
|
+
# dead-letter queue functionality of the source queue as a JSON
|
91
|
+
# object. For more information about the redrive policy and
|
92
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
|
93
|
+
# the *Amazon Simple Queue Service Developer Guide*.
|
77
94
|
#
|
78
|
-
# * `deadLetterTargetArn`
|
95
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
79
96
|
# dead-letter queue to which Amazon SQS moves messages after the
|
80
97
|
# value of `maxReceiveCount` is exceeded.
|
81
98
|
#
|
82
|
-
# * `maxReceiveCount`
|
99
|
+
# * `maxReceiveCount` – The number of times a message is delivered to
|
83
100
|
# the source queue before being moved to the dead-letter queue. When
|
84
101
|
# the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
|
85
102
|
# a queue, Amazon SQS moves the message to the dead-letter-queue.
|
@@ -90,7 +107,7 @@ module Aws::SQS
|
|
90
107
|
#
|
91
108
|
# </note>
|
92
109
|
#
|
93
|
-
# * `VisibilityTimeout`
|
110
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
94
111
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
95
112
|
# Default: 30. For more information about the visibility timeout, see
|
96
113
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -98,14 +115,14 @@ module Aws::SQS
|
|
98
115
|
#
|
99
116
|
# The following attributes apply only to [server-side-encryption][4]\:
|
100
117
|
#
|
101
|
-
# * `KmsMasterKeyId`
|
118
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
102
119
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
|
103
120
|
# Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
|
104
121
|
# always `alias/aws/sqs`, the alias of a custom CMK can, for example,
|
105
122
|
# be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
|
106
123
|
# Key Management Service API Reference*.
|
107
124
|
#
|
108
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
125
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
|
109
126
|
# which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
|
110
127
|
# messages before calling AWS KMS again. An integer representing
|
111
128
|
# seconds, between 60 seconds (1 minute) and 86,400 seconds (24
|
@@ -117,16 +134,17 @@ module Aws::SQS
|
|
117
134
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
118
135
|
# queues][9]\:
|
119
136
|
#
|
120
|
-
# * `FifoQueue`
|
121
|
-
# `false`.
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
137
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
138
|
+
# `false`. If you don't specify the `FifoQueue` attribute, Amazon SQS
|
139
|
+
# creates a standard queue. You can provide this attribute only during
|
140
|
+
# queue creation. You can't change it for an existing queue. When you
|
141
|
+
# set this attribute, you must also provide the `MessageGroupId` for
|
142
|
+
# your messages explicitly.
|
125
143
|
#
|
126
144
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
127
145
|
# Simple Queue Service Developer Guide*.
|
128
146
|
#
|
129
|
-
# * `ContentBasedDeduplication`
|
147
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
130
148
|
# Valid values: `true`, `false`. For more information, see
|
131
149
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
132
150
|
# Developer Guide*.
|
@@ -161,17 +179,51 @@ module Aws::SQS
|
|
161
179
|
#
|
162
180
|
#
|
163
181
|
#
|
164
|
-
# [1]:
|
165
|
-
# [2]:
|
166
|
-
# [3]:
|
167
|
-
# [4]:
|
168
|
-
# [5]:
|
169
|
-
# [6]:
|
170
|
-
# [7]:
|
171
|
-
# [8]:
|
172
|
-
# [9]:
|
173
|
-
# [10]:
|
174
|
-
# [11]:
|
182
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
183
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
184
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
185
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
186
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
187
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
188
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
189
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
190
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
191
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
192
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
193
|
+
# @option options [Hash<String,String>] :tags
|
194
|
+
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
195
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
196
|
+
# Simple Queue Service Developer Guide*.
|
197
|
+
#
|
198
|
+
# When you use queue tags, keep the following guidelines in mind:
|
199
|
+
#
|
200
|
+
# * Adding more than 50 tags to a queue isn't recommended.
|
201
|
+
#
|
202
|
+
# * Tags don't have any semantic meaning. Amazon SQS interprets tags as
|
203
|
+
# character strings.
|
204
|
+
#
|
205
|
+
# * Tags are case-sensitive.
|
206
|
+
#
|
207
|
+
# * A new tag with a key identical to that of an existing tag overwrites
|
208
|
+
# the existing tag.
|
209
|
+
#
|
210
|
+
# For a full list of tag restrictions, see [Limits Related to Queues][2]
|
211
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
212
|
+
#
|
213
|
+
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
214
|
+
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
215
|
+
#
|
216
|
+
# Cross-account permissions don't apply to this action. For more
|
217
|
+
# information, see [Grant Cross-Account Permissions to a Role and a User
|
218
|
+
# Name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
219
|
+
#
|
220
|
+
# </note>
|
221
|
+
#
|
222
|
+
#
|
223
|
+
#
|
224
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html
|
225
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues
|
226
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
175
227
|
# @return [Queue]
|
176
228
|
def create_queue(options = {})
|
177
229
|
resp = @client.create_queue(options)
|
@@ -230,15 +282,17 @@ module Aws::SQS
|
|
230
282
|
# @return [Queue::Collection]
|
231
283
|
def queues(options = {})
|
232
284
|
batches = Enumerator.new do |y|
|
233
|
-
batch = []
|
234
285
|
resp = @client.list_queues(options)
|
235
|
-
resp.
|
236
|
-
batch
|
237
|
-
|
238
|
-
|
239
|
-
|
286
|
+
resp.each_page do |page|
|
287
|
+
batch = []
|
288
|
+
page.data.queue_urls.each do |q|
|
289
|
+
batch << Queue.new(
|
290
|
+
url: q,
|
291
|
+
client: @client
|
292
|
+
)
|
293
|
+
end
|
294
|
+
y.yield(batch)
|
240
295
|
end
|
241
|
-
y.yield(batch)
|
242
296
|
end
|
243
297
|
Queue::Collection.new(batches)
|
244
298
|
end
|
data/lib/aws-sdk-sqs/types.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -40,8 +42,8 @@ module Aws::SQS
|
|
40
42
|
#
|
41
43
|
#
|
42
44
|
#
|
43
|
-
# [1]:
|
44
|
-
# [2]:
|
45
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P
|
46
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html#sqs-api-request-authentication
|
45
47
|
# @return [Array<String>]
|
46
48
|
#
|
47
49
|
# @!attribute [rw] actions
|
@@ -60,7 +62,7 @@ module Aws::SQS
|
|
60
62
|
#
|
61
63
|
#
|
62
64
|
#
|
63
|
-
# [1]:
|
65
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-overview-of-managing-access.html
|
64
66
|
# @return [Array<String>]
|
65
67
|
#
|
66
68
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/AddPermissionRequest AWS API Documentation
|
@@ -70,9 +72,22 @@ module Aws::SQS
|
|
70
72
|
:label,
|
71
73
|
:aws_account_ids,
|
72
74
|
:actions)
|
75
|
+
SENSITIVE = []
|
73
76
|
include Aws::Structure
|
74
77
|
end
|
75
78
|
|
79
|
+
# Two or more batch entries in the request have the same `Id`.
|
80
|
+
#
|
81
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchEntryIdsNotDistinct AWS API Documentation
|
82
|
+
#
|
83
|
+
class BatchEntryIdsNotDistinct < Aws::EmptyStructure; end
|
84
|
+
|
85
|
+
# The length of all the messages put together is more than the limit.
|
86
|
+
#
|
87
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/BatchRequestTooLong AWS API Documentation
|
88
|
+
#
|
89
|
+
class BatchRequestTooLong < Aws::EmptyStructure; end
|
90
|
+
|
76
91
|
# Gives a detailed description of the result of an action on each entry
|
77
92
|
# in the request.
|
78
93
|
#
|
@@ -81,7 +96,8 @@ module Aws::SQS
|
|
81
96
|
# @return [String]
|
82
97
|
#
|
83
98
|
# @!attribute [rw] sender_fault
|
84
|
-
# Specifies whether the error happened due to the
|
99
|
+
# Specifies whether the error happened due to the caller of the batch
|
100
|
+
# API action.
|
85
101
|
# @return [Boolean]
|
86
102
|
#
|
87
103
|
# @!attribute [rw] code
|
@@ -99,6 +115,7 @@ module Aws::SQS
|
|
99
115
|
:sender_fault,
|
100
116
|
:code,
|
101
117
|
:message)
|
118
|
+
SENSITIVE = []
|
102
119
|
include Aws::Structure
|
103
120
|
end
|
104
121
|
|
@@ -133,6 +150,7 @@ module Aws::SQS
|
|
133
150
|
class ChangeMessageVisibilityBatchRequest < Struct.new(
|
134
151
|
:queue_url,
|
135
152
|
:entries)
|
153
|
+
SENSITIVE = []
|
136
154
|
include Aws::Structure
|
137
155
|
end
|
138
156
|
|
@@ -163,7 +181,11 @@ module Aws::SQS
|
|
163
181
|
# An identifier for this particular receipt handle used to communicate
|
164
182
|
# the result.
|
165
183
|
#
|
166
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
184
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
185
|
+
#
|
186
|
+
# This identifier can have up to 80 characters. The following
|
187
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
188
|
+
# underscores (\_).
|
167
189
|
#
|
168
190
|
# </note>
|
169
191
|
# @return [String]
|
@@ -182,6 +204,7 @@ module Aws::SQS
|
|
182
204
|
:id,
|
183
205
|
:receipt_handle,
|
184
206
|
:visibility_timeout)
|
207
|
+
SENSITIVE = []
|
185
208
|
include Aws::Structure
|
186
209
|
end
|
187
210
|
|
@@ -202,6 +225,7 @@ module Aws::SQS
|
|
202
225
|
class ChangeMessageVisibilityBatchResult < Struct.new(
|
203
226
|
:successful,
|
204
227
|
:failed)
|
228
|
+
SENSITIVE = []
|
205
229
|
include Aws::Structure
|
206
230
|
end
|
207
231
|
|
@@ -216,6 +240,7 @@ module Aws::SQS
|
|
216
240
|
#
|
217
241
|
class ChangeMessageVisibilityBatchResultEntry < Struct.new(
|
218
242
|
:id)
|
243
|
+
SENSITIVE = []
|
219
244
|
include Aws::Structure
|
220
245
|
end
|
221
246
|
|
@@ -243,7 +268,7 @@ module Aws::SQS
|
|
243
268
|
#
|
244
269
|
# @!attribute [rw] visibility_timeout
|
245
270
|
# The new value for the message's visibility timeout (in seconds).
|
246
|
-
# Values
|
271
|
+
# Values range: `0` to `43200`. Maximum: 12 hours.
|
247
272
|
# @return [Integer]
|
248
273
|
#
|
249
274
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ChangeMessageVisibilityRequest AWS API Documentation
|
@@ -252,6 +277,7 @@ module Aws::SQS
|
|
252
277
|
:queue_url,
|
253
278
|
:receipt_handle,
|
254
279
|
:visibility_timeout)
|
280
|
+
SENSITIVE = []
|
255
281
|
include Aws::Structure
|
256
282
|
end
|
257
283
|
|
@@ -263,6 +289,9 @@ module Aws::SQS
|
|
263
289
|
# attributes: {
|
264
290
|
# "All" => "String",
|
265
291
|
# },
|
292
|
+
# tags: {
|
293
|
+
# "TagKey" => "TagValue",
|
294
|
+
# },
|
266
295
|
# }
|
267
296
|
#
|
268
297
|
# @!attribute [rw] queue_name
|
@@ -284,40 +313,40 @@ module Aws::SQS
|
|
284
313
|
# The following lists the names, descriptions, and values of the
|
285
314
|
# special request parameters that the `CreateQueue` action uses:
|
286
315
|
#
|
287
|
-
# * `DelaySeconds`
|
316
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
288
317
|
# delivery of all messages in the queue is delayed. Valid values: An
|
289
318
|
# integer from 0 to 900 seconds (15 minutes). Default: 0.
|
290
319
|
#
|
291
|
-
# * `MaximumMessageSize`
|
320
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
292
321
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
293
322
|
# from 1,024 bytes (1 KiB) to 262,144 bytes (256 KiB). Default:
|
294
323
|
# 262,144 (256 KiB).
|
295
324
|
#
|
296
|
-
# * `MessageRetentionPeriod`
|
325
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
297
326
|
# which Amazon SQS retains a message. Valid values: An integer from
|
298
327
|
# 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
|
299
328
|
# 345,600 (4 days).
|
300
329
|
#
|
301
|
-
# * `Policy`
|
330
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
302
331
|
# information about policy structure, see [Overview of AWS IAM
|
303
332
|
# Policies][1] in the *Amazon IAM User Guide*.
|
304
333
|
#
|
305
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
334
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
306
335
|
# for which a ` ReceiveMessage ` action waits for a message to
|
307
336
|
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
308
337
|
# 0.
|
309
338
|
#
|
310
|
-
# * `RedrivePolicy`
|
311
|
-
# dead-letter queue functionality of the source queue
|
312
|
-
# information about the redrive policy and
|
313
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
314
|
-
# Queue Service Developer Guide*.
|
339
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
340
|
+
# dead-letter queue functionality of the source queue as a JSON
|
341
|
+
# object. For more information about the redrive policy and
|
342
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
343
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
315
344
|
#
|
316
|
-
# * `deadLetterTargetArn`
|
345
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
317
346
|
# dead-letter queue to which Amazon SQS moves messages after the
|
318
347
|
# value of `maxReceiveCount` is exceeded.
|
319
348
|
#
|
320
|
-
# * `maxReceiveCount`
|
349
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
321
350
|
# to the source queue before being moved to the dead-letter queue.
|
322
351
|
# When the `ReceiveCount` for a message exceeds the
|
323
352
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -329,7 +358,7 @@ module Aws::SQS
|
|
329
358
|
#
|
330
359
|
# </note>
|
331
360
|
#
|
332
|
-
# * `VisibilityTimeout`
|
361
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
333
362
|
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
334
363
|
# Default: 30. For more information about the visibility timeout,
|
335
364
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
@@ -337,14 +366,14 @@ module Aws::SQS
|
|
337
366
|
#
|
338
367
|
# The following attributes apply only to [server-side-encryption][4]\:
|
339
368
|
#
|
340
|
-
# * `KmsMasterKeyId`
|
369
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
341
370
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
342
371
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
343
372
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
344
373
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
345
374
|
# the *AWS Key Management Service API Reference*.
|
346
375
|
#
|
347
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
376
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
348
377
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
349
378
|
# decrypt messages before calling AWS KMS again. An integer
|
350
379
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -356,16 +385,17 @@ module Aws::SQS
|
|
356
385
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
357
386
|
# queues][9]\:
|
358
387
|
#
|
359
|
-
# * `FifoQueue`
|
360
|
-
# `false`.
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
388
|
+
# * `FifoQueue` – Designates a queue as FIFO. Valid values: `true`,
|
389
|
+
# `false`. If you don't specify the `FifoQueue` attribute, Amazon
|
390
|
+
# SQS creates a standard queue. You can provide this attribute only
|
391
|
+
# during queue creation. You can't change it for an existing queue.
|
392
|
+
# When you set this attribute, you must also provide the
|
393
|
+
# `MessageGroupId` for your messages explicitly.
|
364
394
|
#
|
365
395
|
# For more information, see [FIFO Queue Logic][10] in the *Amazon
|
366
396
|
# Simple Queue Service Developer Guide*.
|
367
397
|
#
|
368
|
-
# * `ContentBasedDeduplication`
|
398
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
369
399
|
# Valid values: `true`, `false`. For more information, see
|
370
400
|
# [Exactly-Once Processing][11] in the *Amazon Simple Queue Service
|
371
401
|
# Developer Guide*.
|
@@ -400,24 +430,62 @@ module Aws::SQS
|
|
400
430
|
#
|
401
431
|
#
|
402
432
|
#
|
403
|
-
# [1]:
|
404
|
-
# [2]:
|
405
|
-
# [3]:
|
406
|
-
# [4]:
|
407
|
-
# [5]:
|
408
|
-
# [6]:
|
409
|
-
# [7]:
|
410
|
-
# [8]:
|
411
|
-
# [9]:
|
412
|
-
# [10]:
|
413
|
-
# [11]:
|
433
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
434
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
435
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
436
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
437
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
438
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
439
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
440
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
441
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
442
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
443
|
+
# [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
444
|
+
# @return [Hash<String,String>]
|
445
|
+
#
|
446
|
+
# @!attribute [rw] tags
|
447
|
+
# Add cost allocation tags to the specified Amazon SQS queue. For an
|
448
|
+
# overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
|
449
|
+
# Simple Queue Service Developer Guide*.
|
450
|
+
#
|
451
|
+
# When you use queue tags, keep the following guidelines in mind:
|
452
|
+
#
|
453
|
+
# * Adding more than 50 tags to a queue isn't recommended.
|
454
|
+
#
|
455
|
+
# * Tags don't have any semantic meaning. Amazon SQS interprets tags
|
456
|
+
# as character strings.
|
457
|
+
#
|
458
|
+
# * Tags are case-sensitive.
|
459
|
+
#
|
460
|
+
# * A new tag with a key identical to that of an existing tag
|
461
|
+
# overwrites the existing tag.
|
462
|
+
#
|
463
|
+
# For a full list of tag restrictions, see [Limits Related to
|
464
|
+
# Queues][2] in the *Amazon Simple Queue Service Developer Guide*.
|
465
|
+
#
|
466
|
+
# <note markdown="1"> To be able to tag a queue on creation, you must have the
|
467
|
+
# `sqs:CreateQueue` and `sqs:TagQueue` permissions.
|
468
|
+
#
|
469
|
+
# Cross-account permissions don't apply to this action. For more
|
470
|
+
# information, see [Grant Cross-Account Permissions to a Role and a
|
471
|
+
# User Name][3] in the *Amazon Simple Queue Service Developer Guide*.
|
472
|
+
#
|
473
|
+
# </note>
|
474
|
+
#
|
475
|
+
#
|
476
|
+
#
|
477
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html
|
478
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues
|
479
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
414
480
|
# @return [Hash<String,String>]
|
415
481
|
#
|
416
482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/CreateQueueRequest AWS API Documentation
|
417
483
|
#
|
418
484
|
class CreateQueueRequest < Struct.new(
|
419
485
|
:queue_name,
|
420
|
-
:attributes
|
486
|
+
:attributes,
|
487
|
+
:tags)
|
488
|
+
SENSITIVE = []
|
421
489
|
include Aws::Structure
|
422
490
|
end
|
423
491
|
|
@@ -431,6 +499,7 @@ module Aws::SQS
|
|
431
499
|
#
|
432
500
|
class CreateQueueResult < Struct.new(
|
433
501
|
:queue_url)
|
502
|
+
SENSITIVE = []
|
434
503
|
include Aws::Structure
|
435
504
|
end
|
436
505
|
|
@@ -462,6 +531,7 @@ module Aws::SQS
|
|
462
531
|
class DeleteMessageBatchRequest < Struct.new(
|
463
532
|
:queue_url,
|
464
533
|
:entries)
|
534
|
+
SENSITIVE = []
|
465
535
|
include Aws::Structure
|
466
536
|
end
|
467
537
|
|
@@ -479,7 +549,11 @@ module Aws::SQS
|
|
479
549
|
# An identifier for this particular receipt handle. This is used to
|
480
550
|
# communicate the result.
|
481
551
|
#
|
482
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
552
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
553
|
+
#
|
554
|
+
# This identifier can have up to 80 characters. The following
|
555
|
+
# characters are accepted: alphanumeric characters, hyphens(-), and
|
556
|
+
# underscores (\_).
|
483
557
|
#
|
484
558
|
# </note>
|
485
559
|
# @return [String]
|
@@ -493,6 +567,7 @@ module Aws::SQS
|
|
493
567
|
class DeleteMessageBatchRequestEntry < Struct.new(
|
494
568
|
:id,
|
495
569
|
:receipt_handle)
|
570
|
+
SENSITIVE = []
|
496
571
|
include Aws::Structure
|
497
572
|
end
|
498
573
|
|
@@ -513,6 +588,7 @@ module Aws::SQS
|
|
513
588
|
class DeleteMessageBatchResult < Struct.new(
|
514
589
|
:successful,
|
515
590
|
:failed)
|
591
|
+
SENSITIVE = []
|
516
592
|
include Aws::Structure
|
517
593
|
end
|
518
594
|
|
@@ -526,6 +602,7 @@ module Aws::SQS
|
|
526
602
|
#
|
527
603
|
class DeleteMessageBatchResultEntry < Struct.new(
|
528
604
|
:id)
|
605
|
+
SENSITIVE = []
|
529
606
|
include Aws::Structure
|
530
607
|
end
|
531
608
|
|
@@ -552,6 +629,7 @@ module Aws::SQS
|
|
552
629
|
class DeleteMessageRequest < Struct.new(
|
553
630
|
:queue_url,
|
554
631
|
:receipt_handle)
|
632
|
+
SENSITIVE = []
|
555
633
|
include Aws::Structure
|
556
634
|
end
|
557
635
|
|
@@ -572,9 +650,16 @@ module Aws::SQS
|
|
572
650
|
#
|
573
651
|
class DeleteQueueRequest < Struct.new(
|
574
652
|
:queue_url)
|
653
|
+
SENSITIVE = []
|
575
654
|
include Aws::Structure
|
576
655
|
end
|
577
656
|
|
657
|
+
# The batch request doesn't contain any entries.
|
658
|
+
#
|
659
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/EmptyBatchRequest AWS API Documentation
|
660
|
+
#
|
661
|
+
class EmptyBatchRequest < Aws::EmptyStructure; end
|
662
|
+
|
578
663
|
# @note When making an API call, you may pass GetQueueAttributesRequest
|
579
664
|
# data as a hash:
|
580
665
|
#
|
@@ -601,74 +686,81 @@ module Aws::SQS
|
|
601
686
|
#
|
602
687
|
# The following attributes are supported:
|
603
688
|
#
|
604
|
-
#
|
689
|
+
# The `ApproximateNumberOfMessagesDelayed`,
|
690
|
+
# `ApproximateNumberOfMessagesNotVisible`, and
|
691
|
+
# `ApproximateNumberOfMessagesVisible` metrics may not achieve
|
692
|
+
# consistency until at least 1 minute after the producers stop sending
|
693
|
+
# messages. This period is required for the queue metadata to reach
|
694
|
+
# eventual consistency.
|
605
695
|
#
|
606
|
-
# * `
|
696
|
+
# * `All` – Returns all values.
|
697
|
+
#
|
698
|
+
# * `ApproximateNumberOfMessages` – Returns the approximate number of
|
607
699
|
# messages available for retrieval from the queue.
|
608
700
|
#
|
609
|
-
# * `ApproximateNumberOfMessagesDelayed`
|
701
|
+
# * `ApproximateNumberOfMessagesDelayed` – Returns the approximate
|
610
702
|
# number of messages in the queue that are delayed and not available
|
611
703
|
# for reading immediately. This can happen when the queue is
|
612
704
|
# configured as a delay queue or when a message has been sent with a
|
613
705
|
# delay parameter.
|
614
706
|
#
|
615
|
-
# * `ApproximateNumberOfMessagesNotVisible`
|
707
|
+
# * `ApproximateNumberOfMessagesNotVisible` – Returns the approximate
|
616
708
|
# number of messages that are in flight. Messages are considered to
|
617
709
|
# be *in flight* if they have been sent to a client but have not yet
|
618
710
|
# been deleted or have not yet reached the end of their visibility
|
619
711
|
# window.
|
620
712
|
#
|
621
|
-
# * `CreatedTimestamp`
|
713
|
+
# * `CreatedTimestamp` – Returns the time when the queue was created
|
622
714
|
# in seconds ([epoch time][1]).
|
623
715
|
#
|
624
|
-
# * `DelaySeconds`
|
716
|
+
# * `DelaySeconds` – Returns the default delay on the queue in
|
625
717
|
# seconds.
|
626
718
|
#
|
627
|
-
# * `LastModifiedTimestamp`
|
719
|
+
# * `LastModifiedTimestamp` – Returns the time when the queue was last
|
628
720
|
# changed in seconds ([epoch time][1]).
|
629
721
|
#
|
630
|
-
# * `MaximumMessageSize`
|
722
|
+
# * `MaximumMessageSize` – Returns the limit of how many bytes a
|
631
723
|
# message can contain before Amazon SQS rejects it.
|
632
724
|
#
|
633
|
-
# * `MessageRetentionPeriod`
|
725
|
+
# * `MessageRetentionPeriod` – Returns the length of time, in seconds,
|
634
726
|
# for which Amazon SQS retains a message.
|
635
727
|
#
|
636
|
-
# * `Policy`
|
728
|
+
# * `Policy` – Returns the policy of the queue.
|
637
729
|
#
|
638
|
-
# * `QueueArn`
|
730
|
+
# * `QueueArn` – Returns the Amazon resource name (ARN) of the queue.
|
639
731
|
#
|
640
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
732
|
+
# * `ReceiveMessageWaitTimeSeconds` – Returns the length of time, in
|
641
733
|
# seconds, for which the `ReceiveMessage` action waits for a message
|
642
734
|
# to arrive.
|
643
735
|
#
|
644
|
-
# * `RedrivePolicy`
|
645
|
-
#
|
646
|
-
# information about the redrive policy and
|
647
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
648
|
-
# Queue Service Developer Guide*.
|
736
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
737
|
+
# dead-letter queue functionality of the source queue as a JSON
|
738
|
+
# object. For more information about the redrive policy and
|
739
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
740
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
649
741
|
#
|
650
|
-
# * `deadLetterTargetArn`
|
742
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
651
743
|
# dead-letter queue to which Amazon SQS moves messages after the
|
652
744
|
# value of `maxReceiveCount` is exceeded.
|
653
745
|
#
|
654
|
-
# * `maxReceiveCount`
|
746
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
655
747
|
# to the source queue before being moved to the dead-letter queue.
|
656
748
|
# When the `ReceiveCount` for a message exceeds the
|
657
749
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
658
750
|
# the dead-letter-queue.
|
659
751
|
#
|
660
|
-
# * `VisibilityTimeout`
|
752
|
+
# * `VisibilityTimeout` – Returns the visibility timeout for the
|
661
753
|
# queue. For more information about the visibility timeout, see
|
662
754
|
# [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
663
755
|
# Developer Guide*.
|
664
756
|
#
|
665
757
|
# The following attributes apply only to [server-side-encryption][4]\:
|
666
758
|
#
|
667
|
-
# * `KmsMasterKeyId`
|
759
|
+
# * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
|
668
760
|
# master key (CMK) for Amazon SQS or a custom CMK. For more
|
669
761
|
# information, see [Key Terms][5].
|
670
762
|
#
|
671
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
763
|
+
# * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
|
672
764
|
# seconds, for which Amazon SQS can reuse a data key to encrypt or
|
673
765
|
# decrypt messages before calling AWS KMS again. For more
|
674
766
|
# information, see [How Does the Data Key Reuse Period Work?][6].
|
@@ -676,7 +768,7 @@ module Aws::SQS
|
|
676
768
|
# The following attributes apply only to [FIFO (first-in-first-out)
|
677
769
|
# queues][7]\:
|
678
770
|
#
|
679
|
-
# * `FifoQueue`
|
771
|
+
# * `FifoQueue` – Returns whether the queue is FIFO. For more
|
680
772
|
# information, see [FIFO Queue Logic][8] in the *Amazon Simple Queue
|
681
773
|
# Service Developer Guide*.
|
682
774
|
#
|
@@ -685,7 +777,7 @@ module Aws::SQS
|
|
685
777
|
#
|
686
778
|
# </note>
|
687
779
|
#
|
688
|
-
# * `ContentBasedDeduplication`
|
780
|
+
# * `ContentBasedDeduplication` – Returns whether content-based
|
689
781
|
# deduplication is enabled for the queue. For more information, see
|
690
782
|
# [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
|
691
783
|
# Developer Guide*.
|
@@ -693,14 +785,14 @@ module Aws::SQS
|
|
693
785
|
#
|
694
786
|
#
|
695
787
|
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
696
|
-
# [2]:
|
697
|
-
# [3]:
|
698
|
-
# [4]:
|
699
|
-
# [5]:
|
700
|
-
# [6]:
|
701
|
-
# [7]:
|
702
|
-
# [8]:
|
703
|
-
# [9]:
|
788
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
789
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
790
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
791
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
792
|
+
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
793
|
+
# [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
794
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
|
795
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
704
796
|
# @return [Array<String>]
|
705
797
|
#
|
706
798
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
|
@@ -708,6 +800,7 @@ module Aws::SQS
|
|
708
800
|
class GetQueueAttributesRequest < Struct.new(
|
709
801
|
:queue_url,
|
710
802
|
:attribute_names)
|
803
|
+
SENSITIVE = []
|
711
804
|
include Aws::Structure
|
712
805
|
end
|
713
806
|
|
@@ -721,6 +814,7 @@ module Aws::SQS
|
|
721
814
|
#
|
722
815
|
class GetQueueAttributesResult < Struct.new(
|
723
816
|
:attributes)
|
817
|
+
SENSITIVE = []
|
724
818
|
include Aws::Structure
|
725
819
|
end
|
726
820
|
|
@@ -749,6 +843,7 @@ module Aws::SQS
|
|
749
843
|
class GetQueueUrlRequest < Struct.new(
|
750
844
|
:queue_name,
|
751
845
|
:queue_owner_aws_account_id)
|
846
|
+
SENSITIVE = []
|
752
847
|
include Aws::Structure
|
753
848
|
end
|
754
849
|
|
@@ -757,7 +852,7 @@ module Aws::SQS
|
|
757
852
|
#
|
758
853
|
#
|
759
854
|
#
|
760
|
-
# [1]:
|
855
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-api-responses.html
|
761
856
|
#
|
762
857
|
# @!attribute [rw] queue_url
|
763
858
|
# The URL of the queue.
|
@@ -767,14 +862,42 @@ module Aws::SQS
|
|
767
862
|
#
|
768
863
|
class GetQueueUrlResult < Struct.new(
|
769
864
|
:queue_url)
|
865
|
+
SENSITIVE = []
|
770
866
|
include Aws::Structure
|
771
867
|
end
|
772
868
|
|
869
|
+
# The specified attribute doesn't exist.
|
870
|
+
#
|
871
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidAttributeName AWS API Documentation
|
872
|
+
#
|
873
|
+
class InvalidAttributeName < Aws::EmptyStructure; end
|
874
|
+
|
875
|
+
# The `Id` of a batch entry in a batch request doesn't abide by the
|
876
|
+
# specification.
|
877
|
+
#
|
878
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidBatchEntryId AWS API Documentation
|
879
|
+
#
|
880
|
+
class InvalidBatchEntryId < Aws::EmptyStructure; end
|
881
|
+
|
882
|
+
# The specified receipt handle isn't valid for the current version.
|
883
|
+
#
|
884
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidIdFormat AWS API Documentation
|
885
|
+
#
|
886
|
+
class InvalidIdFormat < Aws::EmptyStructure; end
|
887
|
+
|
888
|
+
# The message contains characters outside the allowed set.
|
889
|
+
#
|
890
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/InvalidMessageContents AWS API Documentation
|
891
|
+
#
|
892
|
+
class InvalidMessageContents < Aws::EmptyStructure; end
|
893
|
+
|
773
894
|
# @note When making an API call, you may pass ListDeadLetterSourceQueuesRequest
|
774
895
|
# data as a hash:
|
775
896
|
#
|
776
897
|
# {
|
777
898
|
# queue_url: "String", # required
|
899
|
+
# next_token: "Token",
|
900
|
+
# max_results: 1,
|
778
901
|
# }
|
779
902
|
#
|
780
903
|
# @!attribute [rw] queue_url
|
@@ -783,10 +906,23 @@ module Aws::SQS
|
|
783
906
|
# Queue URLs and names are case-sensitive.
|
784
907
|
# @return [String]
|
785
908
|
#
|
909
|
+
# @!attribute [rw] next_token
|
910
|
+
# Pagination token to request the next set of results.
|
911
|
+
# @return [String]
|
912
|
+
#
|
913
|
+
# @!attribute [rw] max_results
|
914
|
+
# Maximum number of results to include in the response. Value range is
|
915
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
916
|
+
# `NextToken` in the response.
|
917
|
+
# @return [Integer]
|
918
|
+
#
|
786
919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesRequest AWS API Documentation
|
787
920
|
#
|
788
921
|
class ListDeadLetterSourceQueuesRequest < Struct.new(
|
789
|
-
:queue_url
|
922
|
+
:queue_url,
|
923
|
+
:next_token,
|
924
|
+
:max_results)
|
925
|
+
SENSITIVE = []
|
790
926
|
include Aws::Structure
|
791
927
|
end
|
792
928
|
|
@@ -797,10 +933,18 @@ module Aws::SQS
|
|
797
933
|
# attribute configured with a dead-letter queue.
|
798
934
|
# @return [Array<String>]
|
799
935
|
#
|
936
|
+
# @!attribute [rw] next_token
|
937
|
+
# Pagination token to include in the next request. Token value is
|
938
|
+
# `null` if there are no additional results to request, or if you did
|
939
|
+
# not set `MaxResults` in the request.
|
940
|
+
# @return [String]
|
941
|
+
#
|
800
942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListDeadLetterSourceQueuesResult AWS API Documentation
|
801
943
|
#
|
802
944
|
class ListDeadLetterSourceQueuesResult < Struct.new(
|
803
|
-
:queue_urls
|
945
|
+
:queue_urls,
|
946
|
+
:next_token)
|
947
|
+
SENSITIVE = []
|
804
948
|
include Aws::Structure
|
805
949
|
end
|
806
950
|
|
@@ -819,6 +963,7 @@ module Aws::SQS
|
|
819
963
|
#
|
820
964
|
class ListQueueTagsRequest < Struct.new(
|
821
965
|
:queue_url)
|
966
|
+
SENSITIVE = []
|
822
967
|
include Aws::Structure
|
823
968
|
end
|
824
969
|
|
@@ -830,6 +975,7 @@ module Aws::SQS
|
|
830
975
|
#
|
831
976
|
class ListQueueTagsResult < Struct.new(
|
832
977
|
:tags)
|
978
|
+
SENSITIVE = []
|
833
979
|
include Aws::Structure
|
834
980
|
end
|
835
981
|
|
@@ -838,6 +984,8 @@ module Aws::SQS
|
|
838
984
|
#
|
839
985
|
# {
|
840
986
|
# queue_name_prefix: "String",
|
987
|
+
# next_token: "Token",
|
988
|
+
# max_results: 1,
|
841
989
|
# }
|
842
990
|
#
|
843
991
|
# @!attribute [rw] queue_name_prefix
|
@@ -847,23 +995,45 @@ module Aws::SQS
|
|
847
995
|
# Queue URLs and names are case-sensitive.
|
848
996
|
# @return [String]
|
849
997
|
#
|
998
|
+
# @!attribute [rw] next_token
|
999
|
+
# Pagination token to request the next set of results.
|
1000
|
+
# @return [String]
|
1001
|
+
#
|
1002
|
+
# @!attribute [rw] max_results
|
1003
|
+
# Maximum number of results to include in the response. Value range is
|
1004
|
+
# 1 to 1000. You must set `MaxResults` to receive a value for
|
1005
|
+
# `NextToken` in the response.
|
1006
|
+
# @return [Integer]
|
1007
|
+
#
|
850
1008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesRequest AWS API Documentation
|
851
1009
|
#
|
852
1010
|
class ListQueuesRequest < Struct.new(
|
853
|
-
:queue_name_prefix
|
1011
|
+
:queue_name_prefix,
|
1012
|
+
:next_token,
|
1013
|
+
:max_results)
|
1014
|
+
SENSITIVE = []
|
854
1015
|
include Aws::Structure
|
855
1016
|
end
|
856
1017
|
|
857
1018
|
# A list of your queues.
|
858
1019
|
#
|
859
1020
|
# @!attribute [rw] queue_urls
|
860
|
-
# A list of queue URLs, up to 1,000 entries
|
1021
|
+
# A list of queue URLs, up to 1,000 entries, or the value of
|
1022
|
+
# MaxResults that you sent in the request.
|
861
1023
|
# @return [Array<String>]
|
862
1024
|
#
|
1025
|
+
# @!attribute [rw] next_token
|
1026
|
+
# Pagination token to include in the next request. Token value is
|
1027
|
+
# `null` if there are no additional results to request, or if you did
|
1028
|
+
# not set `MaxResults` in the request.
|
1029
|
+
# @return [String]
|
1030
|
+
#
|
863
1031
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ListQueuesResult AWS API Documentation
|
864
1032
|
#
|
865
1033
|
class ListQueuesResult < Struct.new(
|
866
|
-
:queue_urls
|
1034
|
+
:queue_urls,
|
1035
|
+
:next_token)
|
1036
|
+
SENSITIVE = []
|
867
1037
|
include Aws::Structure
|
868
1038
|
end
|
869
1039
|
|
@@ -935,7 +1105,7 @@ module Aws::SQS
|
|
935
1105
|
#
|
936
1106
|
#
|
937
1107
|
#
|
938
|
-
# [1]:
|
1108
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
939
1109
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
940
1110
|
#
|
941
1111
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/Message AWS API Documentation
|
@@ -948,6 +1118,7 @@ module Aws::SQS
|
|
948
1118
|
:attributes,
|
949
1119
|
:md5_of_message_attributes,
|
950
1120
|
:message_attributes)
|
1121
|
+
SENSITIVE = []
|
951
1122
|
include Aws::Structure
|
952
1123
|
end
|
953
1124
|
|
@@ -1004,7 +1175,7 @@ module Aws::SQS
|
|
1004
1175
|
#
|
1005
1176
|
#
|
1006
1177
|
#
|
1007
|
-
# [1]:
|
1178
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1008
1179
|
# @return [String]
|
1009
1180
|
#
|
1010
1181
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageAttributeValue AWS API Documentation
|
@@ -1015,9 +1186,99 @@ module Aws::SQS
|
|
1015
1186
|
:string_list_values,
|
1016
1187
|
:binary_list_values,
|
1017
1188
|
:data_type)
|
1189
|
+
SENSITIVE = []
|
1018
1190
|
include Aws::Structure
|
1019
1191
|
end
|
1020
1192
|
|
1193
|
+
# The specified message isn't in flight.
|
1194
|
+
#
|
1195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageNotInflight AWS API Documentation
|
1196
|
+
#
|
1197
|
+
class MessageNotInflight < Aws::EmptyStructure; end
|
1198
|
+
|
1199
|
+
# The user-specified message system attribute value. For string data
|
1200
|
+
# types, the `Value` attribute has the same restrictions on the content
|
1201
|
+
# as the message body. For more information, see ` SendMessage.`
|
1202
|
+
#
|
1203
|
+
# `Name`, `type`, `value` and the message body must not be empty or
|
1204
|
+
# null.
|
1205
|
+
#
|
1206
|
+
# @note When making an API call, you may pass MessageSystemAttributeValue
|
1207
|
+
# data as a hash:
|
1208
|
+
#
|
1209
|
+
# {
|
1210
|
+
# string_value: "String",
|
1211
|
+
# binary_value: "data",
|
1212
|
+
# string_list_values: ["String"],
|
1213
|
+
# binary_list_values: ["data"],
|
1214
|
+
# data_type: "String", # required
|
1215
|
+
# }
|
1216
|
+
#
|
1217
|
+
# @!attribute [rw] string_value
|
1218
|
+
# Strings are Unicode with UTF-8 binary encoding. For a list of code
|
1219
|
+
# values, see [ASCII Printable Characters][1].
|
1220
|
+
#
|
1221
|
+
#
|
1222
|
+
#
|
1223
|
+
# [1]: http://en.wikipedia.org/wiki/ASCII#ASCII_printable_characters
|
1224
|
+
# @return [String]
|
1225
|
+
#
|
1226
|
+
# @!attribute [rw] binary_value
|
1227
|
+
# Binary type attributes can store any binary data, such as compressed
|
1228
|
+
# data, encrypted data, or images.
|
1229
|
+
# @return [String]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] string_list_values
|
1232
|
+
# Not implemented. Reserved for future use.
|
1233
|
+
# @return [Array<String>]
|
1234
|
+
#
|
1235
|
+
# @!attribute [rw] binary_list_values
|
1236
|
+
# Not implemented. Reserved for future use.
|
1237
|
+
# @return [Array<String>]
|
1238
|
+
#
|
1239
|
+
# @!attribute [rw] data_type
|
1240
|
+
# Amazon SQS supports the following logical data types: `String`,
|
1241
|
+
# `Number`, and `Binary`. For the `Number` data type, you must use
|
1242
|
+
# `StringValue`.
|
1243
|
+
#
|
1244
|
+
# You can also append custom labels. For more information, see [Amazon
|
1245
|
+
# SQS Message Attributes][1] in the *Amazon Simple Queue Service
|
1246
|
+
# Developer Guide*.
|
1247
|
+
#
|
1248
|
+
#
|
1249
|
+
#
|
1250
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1253
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/MessageSystemAttributeValue AWS API Documentation
|
1254
|
+
#
|
1255
|
+
class MessageSystemAttributeValue < Struct.new(
|
1256
|
+
:string_value,
|
1257
|
+
:binary_value,
|
1258
|
+
:string_list_values,
|
1259
|
+
:binary_list_values,
|
1260
|
+
:data_type)
|
1261
|
+
SENSITIVE = []
|
1262
|
+
include Aws::Structure
|
1263
|
+
end
|
1264
|
+
|
1265
|
+
# The specified action violates a limit. For example, `ReceiveMessage`
|
1266
|
+
# returns this error if the maximum number of inflight messages is
|
1267
|
+
# reached and `AddPermission` returns this error if the maximum number
|
1268
|
+
# of permissions for the queue is reached.
|
1269
|
+
#
|
1270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/OverLimit AWS API Documentation
|
1271
|
+
#
|
1272
|
+
class OverLimit < Aws::EmptyStructure; end
|
1273
|
+
|
1274
|
+
# Indicates that the specified queue previously received a `PurgeQueue`
|
1275
|
+
# request within the last 60 seconds (the time it can take to delete the
|
1276
|
+
# messages in the queue).
|
1277
|
+
#
|
1278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/PurgeQueueInProgress AWS API Documentation
|
1279
|
+
#
|
1280
|
+
class PurgeQueueInProgress < Aws::EmptyStructure; end
|
1281
|
+
|
1021
1282
|
# @note When making an API call, you may pass PurgeQueueRequest
|
1022
1283
|
# data as a hash:
|
1023
1284
|
#
|
@@ -1036,9 +1297,37 @@ module Aws::SQS
|
|
1036
1297
|
#
|
1037
1298
|
class PurgeQueueRequest < Struct.new(
|
1038
1299
|
:queue_url)
|
1300
|
+
SENSITIVE = []
|
1039
1301
|
include Aws::Structure
|
1040
1302
|
end
|
1041
1303
|
|
1304
|
+
# You must wait 60 seconds after deleting a queue before you can create
|
1305
|
+
# another queue with the same name.
|
1306
|
+
#
|
1307
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDeletedRecently AWS API Documentation
|
1308
|
+
#
|
1309
|
+
class QueueDeletedRecently < Aws::EmptyStructure; end
|
1310
|
+
|
1311
|
+
# The specified queue doesn't exist.
|
1312
|
+
#
|
1313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueDoesNotExist AWS API Documentation
|
1314
|
+
#
|
1315
|
+
class QueueDoesNotExist < Aws::EmptyStructure; end
|
1316
|
+
|
1317
|
+
# A queue with this name already exists. Amazon SQS returns this error
|
1318
|
+
# only if the request includes attributes whose values differ from those
|
1319
|
+
# of the existing queue.
|
1320
|
+
#
|
1321
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/QueueNameExists AWS API Documentation
|
1322
|
+
#
|
1323
|
+
class QueueNameExists < Aws::EmptyStructure; end
|
1324
|
+
|
1325
|
+
# The specified receipt handle isn't valid.
|
1326
|
+
#
|
1327
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiptHandleIsInvalid AWS API Documentation
|
1328
|
+
#
|
1329
|
+
class ReceiptHandleIsInvalid < Aws::EmptyStructure; end
|
1330
|
+
|
1042
1331
|
# @note When making an API call, you may pass ReceiveMessageRequest
|
1043
1332
|
# data as a hash:
|
1044
1333
|
#
|
@@ -1059,17 +1348,19 @@ module Aws::SQS
|
|
1059
1348
|
# @return [String]
|
1060
1349
|
#
|
1061
1350
|
# @!attribute [rw] attribute_names
|
1062
|
-
# A list of
|
1063
|
-
# attributes include:
|
1351
|
+
# A list of attributes that need to be returned along with each
|
1352
|
+
# message. These attributes include:
|
1064
1353
|
#
|
1065
|
-
# * `All`
|
1354
|
+
# * `All` – Returns all values.
|
1066
1355
|
#
|
1067
|
-
# * `ApproximateFirstReceiveTimestamp`
|
1356
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1068
1357
|
# was first received from the queue ([epoch time][1] in
|
1069
1358
|
# milliseconds).
|
1070
1359
|
#
|
1071
|
-
# * `ApproximateReceiveCount`
|
1072
|
-
# has been received
|
1360
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1361
|
+
# has been received across all queues but not deleted.
|
1362
|
+
#
|
1363
|
+
# * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
|
1073
1364
|
#
|
1074
1365
|
# * `SenderId`
|
1075
1366
|
#
|
@@ -1079,17 +1370,17 @@ module Aws::SQS
|
|
1079
1370
|
# * For an IAM role, returns the IAM role ID, for example
|
1080
1371
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1081
1372
|
#
|
1082
|
-
# * `SentTimestamp`
|
1373
|
+
# * `SentTimestamp` – Returns the time the message was sent to the
|
1083
1374
|
# queue ([epoch time][1] in milliseconds).
|
1084
1375
|
#
|
1085
|
-
# * `MessageDeduplicationId`
|
1376
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1086
1377
|
# producer that calls the ` SendMessage ` action.
|
1087
1378
|
#
|
1088
|
-
# * `MessageGroupId`
|
1379
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1089
1380
|
# calls the ` SendMessage ` action. Messages with the same
|
1090
1381
|
# `MessageGroupId` are returned in sequence.
|
1091
1382
|
#
|
1092
|
-
# * `SequenceNumber`
|
1383
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1093
1384
|
#
|
1094
1385
|
#
|
1095
1386
|
#
|
@@ -1137,6 +1428,18 @@ module Aws::SQS
|
|
1137
1428
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1138
1429
|
# available and the wait time expires, the call returns successfully
|
1139
1430
|
# with an empty list of messages.
|
1431
|
+
#
|
1432
|
+
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1433
|
+
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
1434
|
+
# parameter. For example, with the Java SDK, you can set HTTP
|
1435
|
+
# transport settings using the [ NettyNioAsyncHttpClient][1] for
|
1436
|
+
# asynchronous clients, or the [ ApacheHttpClient][2] for synchronous
|
1437
|
+
# clients.
|
1438
|
+
#
|
1439
|
+
#
|
1440
|
+
#
|
1441
|
+
# [1]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.html
|
1442
|
+
# [2]: https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/http/apache/ApacheHttpClient.html
|
1140
1443
|
# @return [Integer]
|
1141
1444
|
#
|
1142
1445
|
# @!attribute [rw] receive_request_attempt_id
|
@@ -1144,10 +1447,10 @@ module Aws::SQS
|
|
1144
1447
|
#
|
1145
1448
|
# The token used for deduplication of `ReceiveMessage` calls. If a
|
1146
1449
|
# networking issue occurs after a `ReceiveMessage` action, and instead
|
1147
|
-
# of a response you receive a generic error,
|
1148
|
-
# action with an identical `ReceiveRequestAttemptId` to
|
1149
|
-
# same set of messages, even if their visibility timeout
|
1150
|
-
# expired.
|
1450
|
+
# of a response you receive a generic error, it is possible to retry
|
1451
|
+
# the same action with an identical `ReceiveRequestAttemptId` to
|
1452
|
+
# retrieve the same set of messages, even if their visibility timeout
|
1453
|
+
# has not yet expired.
|
1151
1454
|
#
|
1152
1455
|
# * You can use `ReceiveRequestAttemptId` only for 5 minutes after a
|
1153
1456
|
# `ReceiveMessage` action.
|
@@ -1159,7 +1462,7 @@ module Aws::SQS
|
|
1159
1462
|
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1160
1463
|
# `ReceiveRequestAttemptId`.
|
1161
1464
|
#
|
1162
|
-
# *
|
1465
|
+
# * It is possible to retry the `ReceiveMessage` action with the same
|
1163
1466
|
# `ReceiveRequestAttemptId` if none of the messages have been
|
1164
1467
|
# modified (deleted or had their visibility changes).
|
1165
1468
|
#
|
@@ -1193,7 +1496,7 @@ module Aws::SQS
|
|
1193
1496
|
# visibility timeout expires. As a result, delays might occur but
|
1194
1497
|
# the messages in the queue remain in a strict order.
|
1195
1498
|
#
|
1196
|
-
# The length of `ReceiveRequestAttemptId` is 128 characters.
|
1499
|
+
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1197
1500
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters
|
1198
1501
|
# (`a-z`, `A-Z`, `0-9`) and punctuation (``
|
1199
1502
|
# !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
|
@@ -1204,8 +1507,8 @@ module Aws::SQS
|
|
1204
1507
|
#
|
1205
1508
|
#
|
1206
1509
|
#
|
1207
|
-
# [1]:
|
1208
|
-
# [2]:
|
1510
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1511
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-receiverequestattemptid-request-parameter.html
|
1209
1512
|
# @return [String]
|
1210
1513
|
#
|
1211
1514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/ReceiveMessageRequest AWS API Documentation
|
@@ -1218,6 +1521,7 @@ module Aws::SQS
|
|
1218
1521
|
:visibility_timeout,
|
1219
1522
|
:wait_time_seconds,
|
1220
1523
|
:receive_request_attempt_id)
|
1524
|
+
SENSITIVE = []
|
1221
1525
|
include Aws::Structure
|
1222
1526
|
end
|
1223
1527
|
|
@@ -1231,6 +1535,7 @@ module Aws::SQS
|
|
1231
1535
|
#
|
1232
1536
|
class ReceiveMessageResult < Struct.new(
|
1233
1537
|
:messages)
|
1538
|
+
SENSITIVE = []
|
1234
1539
|
include Aws::Structure
|
1235
1540
|
end
|
1236
1541
|
|
@@ -1258,6 +1563,7 @@ module Aws::SQS
|
|
1258
1563
|
class RemovePermissionRequest < Struct.new(
|
1259
1564
|
:queue_url,
|
1260
1565
|
:label)
|
1566
|
+
SENSITIVE = []
|
1261
1567
|
include Aws::Structure
|
1262
1568
|
end
|
1263
1569
|
|
@@ -1280,6 +1586,15 @@ module Aws::SQS
|
|
1280
1586
|
# data_type: "String", # required
|
1281
1587
|
# },
|
1282
1588
|
# },
|
1589
|
+
# message_system_attributes: {
|
1590
|
+
# "AWSTraceHeader" => {
|
1591
|
+
# string_value: "String",
|
1592
|
+
# binary_value: "data",
|
1593
|
+
# string_list_values: ["String"],
|
1594
|
+
# binary_list_values: ["data"],
|
1595
|
+
# data_type: "String", # required
|
1596
|
+
# },
|
1597
|
+
# },
|
1283
1598
|
# message_deduplication_id: "String",
|
1284
1599
|
# message_group_id: "String",
|
1285
1600
|
# },
|
@@ -1301,6 +1616,7 @@ module Aws::SQS
|
|
1301
1616
|
class SendMessageBatchRequest < Struct.new(
|
1302
1617
|
:queue_url,
|
1303
1618
|
:entries)
|
1619
|
+
SENSITIVE = []
|
1304
1620
|
include Aws::Structure
|
1305
1621
|
end
|
1306
1622
|
|
@@ -1323,6 +1639,15 @@ module Aws::SQS
|
|
1323
1639
|
# data_type: "String", # required
|
1324
1640
|
# },
|
1325
1641
|
# },
|
1642
|
+
# message_system_attributes: {
|
1643
|
+
# "AWSTraceHeader" => {
|
1644
|
+
# string_value: "String",
|
1645
|
+
# binary_value: "data",
|
1646
|
+
# string_list_values: ["String"],
|
1647
|
+
# binary_list_values: ["data"],
|
1648
|
+
# data_type: "String", # required
|
1649
|
+
# },
|
1650
|
+
# },
|
1326
1651
|
# message_deduplication_id: "String",
|
1327
1652
|
# message_group_id: "String",
|
1328
1653
|
# }
|
@@ -1331,7 +1656,7 @@ module Aws::SQS
|
|
1331
1656
|
# An identifier for a message in this batch used to communicate the
|
1332
1657
|
# result.
|
1333
1658
|
#
|
1334
|
-
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request
|
1659
|
+
# <note markdown="1"> The `Id`s of a batch request need to be unique within a request.
|
1335
1660
|
#
|
1336
1661
|
# This identifier can have up to 80 characters. The following
|
1337
1662
|
# characters are accepted: alphanumeric characters, hyphens(-), and
|
@@ -1364,9 +1689,21 @@ module Aws::SQS
|
|
1364
1689
|
#
|
1365
1690
|
#
|
1366
1691
|
#
|
1367
|
-
# [1]:
|
1692
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1368
1693
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1369
1694
|
#
|
1695
|
+
# @!attribute [rw] message_system_attributes
|
1696
|
+
# The message system attribute to send Each message system attribute
|
1697
|
+
# consists of a `Name`, `Type`, and `Value`.
|
1698
|
+
#
|
1699
|
+
# * Currently, the only supported message system attribute is
|
1700
|
+
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1701
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1702
|
+
#
|
1703
|
+
# * The size of a message system attribute doesn't count towards the
|
1704
|
+
# total size of a message.
|
1705
|
+
# @return [Hash<String,Types::MessageSystemAttributeValue>]
|
1706
|
+
#
|
1370
1707
|
# @!attribute [rw] message_deduplication_id
|
1371
1708
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1372
1709
|
#
|
@@ -1429,8 +1766,8 @@ module Aws::SQS
|
|
1429
1766
|
#
|
1430
1767
|
#
|
1431
1768
|
#
|
1432
|
-
# [1]:
|
1433
|
-
# [2]:
|
1769
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
1770
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1434
1771
|
# @return [String]
|
1435
1772
|
#
|
1436
1773
|
# @!attribute [rw] message_group_id
|
@@ -1466,7 +1803,7 @@ module Aws::SQS
|
|
1466
1803
|
#
|
1467
1804
|
#
|
1468
1805
|
#
|
1469
|
-
# [1]:
|
1806
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
1470
1807
|
# @return [String]
|
1471
1808
|
#
|
1472
1809
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageBatchRequestEntry AWS API Documentation
|
@@ -1476,8 +1813,10 @@ module Aws::SQS
|
|
1476
1813
|
:message_body,
|
1477
1814
|
:delay_seconds,
|
1478
1815
|
:message_attributes,
|
1816
|
+
:message_system_attributes,
|
1479
1817
|
:message_deduplication_id,
|
1480
1818
|
:message_group_id)
|
1819
|
+
SENSITIVE = []
|
1481
1820
|
include Aws::Structure
|
1482
1821
|
end
|
1483
1822
|
|
@@ -1499,6 +1838,7 @@ module Aws::SQS
|
|
1499
1838
|
class SendMessageBatchResult < Struct.new(
|
1500
1839
|
:successful,
|
1501
1840
|
:failed)
|
1841
|
+
SENSITIVE = []
|
1502
1842
|
include Aws::Structure
|
1503
1843
|
end
|
1504
1844
|
|
@@ -1537,6 +1877,18 @@ module Aws::SQS
|
|
1537
1877
|
# [1]: https://www.ietf.org/rfc/rfc1321.txt
|
1538
1878
|
# @return [String]
|
1539
1879
|
#
|
1880
|
+
# @!attribute [rw] md5_of_message_system_attributes
|
1881
|
+
# An MD5 digest of the non-URL-encoded message system attribute
|
1882
|
+
# string. You can use this attribute to verify that Amazon SQS
|
1883
|
+
# received the message correctly. Amazon SQS URL-decodes the message
|
1884
|
+
# before creating the MD5 digest. For information about MD5, see
|
1885
|
+
# [RFC1321][1].
|
1886
|
+
#
|
1887
|
+
#
|
1888
|
+
#
|
1889
|
+
# [1]: https://www.ietf.org/rfc/rfc1321.txt
|
1890
|
+
# @return [String]
|
1891
|
+
#
|
1540
1892
|
# @!attribute [rw] sequence_number
|
1541
1893
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1542
1894
|
#
|
@@ -1554,7 +1906,9 @@ module Aws::SQS
|
|
1554
1906
|
:message_id,
|
1555
1907
|
:md5_of_message_body,
|
1556
1908
|
:md5_of_message_attributes,
|
1909
|
+
:md5_of_message_system_attributes,
|
1557
1910
|
:sequence_number)
|
1911
|
+
SENSITIVE = []
|
1558
1912
|
include Aws::Structure
|
1559
1913
|
end
|
1560
1914
|
|
@@ -1574,6 +1928,15 @@ module Aws::SQS
|
|
1574
1928
|
# data_type: "String", # required
|
1575
1929
|
# },
|
1576
1930
|
# },
|
1931
|
+
# message_system_attributes: {
|
1932
|
+
# "AWSTraceHeader" => {
|
1933
|
+
# string_value: "String",
|
1934
|
+
# binary_value: "data",
|
1935
|
+
# string_list_values: ["String"],
|
1936
|
+
# binary_list_values: ["data"],
|
1937
|
+
# data_type: "String", # required
|
1938
|
+
# },
|
1939
|
+
# },
|
1577
1940
|
# message_deduplication_id: "String",
|
1578
1941
|
# message_group_id: "String",
|
1579
1942
|
# }
|
@@ -1585,7 +1948,8 @@ module Aws::SQS
|
|
1585
1948
|
# @return [String]
|
1586
1949
|
#
|
1587
1950
|
# @!attribute [rw] message_body
|
1588
|
-
# The message to send. The
|
1951
|
+
# The message to send. The minimum size is one character. The maximum
|
1952
|
+
# size is 256 KB.
|
1589
1953
|
#
|
1590
1954
|
# A message can include only XML, JSON, and unformatted text. The
|
1591
1955
|
# following Unicode characters are allowed:
|
@@ -1621,9 +1985,21 @@ module Aws::SQS
|
|
1621
1985
|
#
|
1622
1986
|
#
|
1623
1987
|
#
|
1624
|
-
# [1]:
|
1988
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-message-metadata.html#sqs-message-attributes
|
1625
1989
|
# @return [Hash<String,Types::MessageAttributeValue>]
|
1626
1990
|
#
|
1991
|
+
# @!attribute [rw] message_system_attributes
|
1992
|
+
# The message system attribute to send. Each message system attribute
|
1993
|
+
# consists of a `Name`, `Type`, and `Value`.
|
1994
|
+
#
|
1995
|
+
# * Currently, the only supported message system attribute is
|
1996
|
+
# `AWSTraceHeader`. Its type must be `String` and its value must be
|
1997
|
+
# a correctly formatted AWS X-Ray trace header string.
|
1998
|
+
#
|
1999
|
+
# * The size of a message system attribute doesn't count towards the
|
2000
|
+
# total size of a message.
|
2001
|
+
# @return [Hash<String,Types::MessageSystemAttributeValue>]
|
2002
|
+
#
|
1627
2003
|
# @!attribute [rw] message_deduplication_id
|
1628
2004
|
# This parameter applies only to FIFO (first-in-first-out) queues.
|
1629
2005
|
#
|
@@ -1675,7 +2051,7 @@ module Aws::SQS
|
|
1675
2051
|
#
|
1676
2052
|
# </note>
|
1677
2053
|
#
|
1678
|
-
# The length of `MessageDeduplicationId` is 128 characters.
|
2054
|
+
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
1679
2055
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
1680
2056
|
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~
|
1681
2057
|
# ``).
|
@@ -1686,8 +2062,8 @@ module Aws::SQS
|
|
1686
2062
|
#
|
1687
2063
|
#
|
1688
2064
|
#
|
1689
|
-
# [1]:
|
1690
|
-
# [2]:
|
2065
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
2066
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
|
1691
2067
|
# @return [String]
|
1692
2068
|
#
|
1693
2069
|
# @!attribute [rw] message_group_id
|
@@ -1723,7 +2099,7 @@ module Aws::SQS
|
|
1723
2099
|
#
|
1724
2100
|
#
|
1725
2101
|
#
|
1726
|
-
# [1]:
|
2102
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagegroupid-property.html
|
1727
2103
|
# @return [String]
|
1728
2104
|
#
|
1729
2105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SendMessageRequest AWS API Documentation
|
@@ -1733,8 +2109,10 @@ module Aws::SQS
|
|
1733
2109
|
:message_body,
|
1734
2110
|
:delay_seconds,
|
1735
2111
|
:message_attributes,
|
2112
|
+
:message_system_attributes,
|
1736
2113
|
:message_deduplication_id,
|
1737
2114
|
:message_group_id)
|
2115
|
+
SENSITIVE = []
|
1738
2116
|
include Aws::Structure
|
1739
2117
|
end
|
1740
2118
|
|
@@ -1764,6 +2142,13 @@ module Aws::SQS
|
|
1764
2142
|
# [1]: https://www.ietf.org/rfc/rfc1321.txt
|
1765
2143
|
# @return [String]
|
1766
2144
|
#
|
2145
|
+
# @!attribute [rw] md5_of_message_system_attributes
|
2146
|
+
# An MD5 digest of the non-URL-encoded message system attribute
|
2147
|
+
# string. You can use this attribute to verify that Amazon SQS
|
2148
|
+
# received the message correctly. Amazon SQS URL-decodes the message
|
2149
|
+
# before creating the MD5 digest.
|
2150
|
+
# @return [String]
|
2151
|
+
#
|
1767
2152
|
# @!attribute [rw] message_id
|
1768
2153
|
# An attribute containing the `MessageId` of the message sent to the
|
1769
2154
|
# queue. For more information, see [Queue and Message Identifiers][1]
|
@@ -1771,7 +2156,7 @@ module Aws::SQS
|
|
1771
2156
|
#
|
1772
2157
|
#
|
1773
2158
|
#
|
1774
|
-
# [1]:
|
2159
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html
|
1775
2160
|
# @return [String]
|
1776
2161
|
#
|
1777
2162
|
# @!attribute [rw] sequence_number
|
@@ -1789,8 +2174,10 @@ module Aws::SQS
|
|
1789
2174
|
class SendMessageResult < Struct.new(
|
1790
2175
|
:md5_of_message_body,
|
1791
2176
|
:md5_of_message_attributes,
|
2177
|
+
:md5_of_message_system_attributes,
|
1792
2178
|
:message_id,
|
1793
2179
|
:sequence_number)
|
2180
|
+
SENSITIVE = []
|
1794
2181
|
include Aws::Structure
|
1795
2182
|
end
|
1796
2183
|
|
@@ -1817,40 +2204,40 @@ module Aws::SQS
|
|
1817
2204
|
# special request parameters that the `SetQueueAttributes` action
|
1818
2205
|
# uses:
|
1819
2206
|
#
|
1820
|
-
# * `DelaySeconds`
|
2207
|
+
# * `DelaySeconds` – The length of time, in seconds, for which the
|
1821
2208
|
# delivery of all messages in the queue is delayed. Valid values: An
|
1822
2209
|
# integer from 0 to 900 (15 minutes). Default: 0.
|
1823
2210
|
#
|
1824
|
-
# * `MaximumMessageSize`
|
2211
|
+
# * `MaximumMessageSize` – The limit of how many bytes a message can
|
1825
2212
|
# contain before Amazon SQS rejects it. Valid values: An integer
|
1826
2213
|
# from 1,024 bytes (1 KiB) up to 262,144 bytes (256 KiB). Default:
|
1827
2214
|
# 262,144 (256 KiB).
|
1828
2215
|
#
|
1829
|
-
# * `MessageRetentionPeriod`
|
2216
|
+
# * `MessageRetentionPeriod` – The length of time, in seconds, for
|
1830
2217
|
# which Amazon SQS retains a message. Valid values: An integer
|
1831
2218
|
# representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
|
1832
2219
|
# Default: 345,600 (4 days).
|
1833
2220
|
#
|
1834
|
-
# * `Policy`
|
2221
|
+
# * `Policy` – The queue's policy. A valid AWS policy. For more
|
1835
2222
|
# information about policy structure, see [Overview of AWS IAM
|
1836
2223
|
# Policies][1] in the *Amazon IAM User Guide*.
|
1837
2224
|
#
|
1838
|
-
# * `ReceiveMessageWaitTimeSeconds`
|
2225
|
+
# * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
|
1839
2226
|
# for which a ` ReceiveMessage ` action waits for a message to
|
1840
|
-
# arrive. Valid values:
|
2227
|
+
# arrive. Valid values: An integer from 0 to 20 (seconds). Default:
|
1841
2228
|
# 0.
|
1842
2229
|
#
|
1843
|
-
# * `RedrivePolicy`
|
1844
|
-
# dead-letter queue functionality of the source queue
|
1845
|
-
# information about the redrive policy and
|
1846
|
-
# [Using Amazon SQS Dead-Letter Queues][2]
|
1847
|
-
# Queue Service Developer Guide*.
|
2230
|
+
# * `RedrivePolicy` – The string that includes the parameters for the
|
2231
|
+
# dead-letter queue functionality of the source queue as a JSON
|
2232
|
+
# object. For more information about the redrive policy and
|
2233
|
+
# dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
|
2234
|
+
# in the *Amazon Simple Queue Service Developer Guide*.
|
1848
2235
|
#
|
1849
|
-
# * `deadLetterTargetArn`
|
2236
|
+
# * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
|
1850
2237
|
# dead-letter queue to which Amazon SQS moves messages after the
|
1851
2238
|
# value of `maxReceiveCount` is exceeded.
|
1852
2239
|
#
|
1853
|
-
# * `maxReceiveCount`
|
2240
|
+
# * `maxReceiveCount` – The number of times a message is delivered
|
1854
2241
|
# to the source queue before being moved to the dead-letter queue.
|
1855
2242
|
# When the `ReceiveCount` for a message exceeds the
|
1856
2243
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to
|
@@ -1862,22 +2249,22 @@ module Aws::SQS
|
|
1862
2249
|
#
|
1863
2250
|
# </note>
|
1864
2251
|
#
|
1865
|
-
# * `VisibilityTimeout`
|
1866
|
-
# seconds. Valid values:
|
2252
|
+
# * `VisibilityTimeout` – The visibility timeout for the queue, in
|
2253
|
+
# seconds. Valid values: An integer from 0 to 43,200 (12 hours).
|
1867
2254
|
# Default: 30. For more information about the visibility timeout,
|
1868
2255
|
# see [Visibility Timeout][3] in the *Amazon Simple Queue Service
|
1869
2256
|
# Developer Guide*.
|
1870
2257
|
#
|
1871
2258
|
# The following attributes apply only to [server-side-encryption][4]\:
|
1872
2259
|
#
|
1873
|
-
# * `KmsMasterKeyId`
|
2260
|
+
# * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
|
1874
2261
|
# (CMK) for Amazon SQS or a custom CMK. For more information, see
|
1875
2262
|
# [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
|
1876
2263
|
# SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
|
1877
2264
|
# example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
|
1878
2265
|
# the *AWS Key Management Service API Reference*.
|
1879
2266
|
#
|
1880
|
-
# * `KmsDataKeyReusePeriodSeconds`
|
2267
|
+
# * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
|
1881
2268
|
# for which Amazon SQS can reuse a [data key][7] to encrypt or
|
1882
2269
|
# decrypt messages before calling AWS KMS again. An integer
|
1883
2270
|
# representing seconds, between 60 seconds (1 minute) and 86,400
|
@@ -1889,7 +2276,7 @@ module Aws::SQS
|
|
1889
2276
|
# The following attribute applies only to [FIFO (first-in-first-out)
|
1890
2277
|
# queues][9]\:
|
1891
2278
|
#
|
1892
|
-
# * `ContentBasedDeduplication`
|
2279
|
+
# * `ContentBasedDeduplication` – Enables content-based deduplication.
|
1893
2280
|
# For more information, see [Exactly-Once Processing][10] in the
|
1894
2281
|
# *Amazon Simple Queue Service Developer Guide*.
|
1895
2282
|
#
|
@@ -1923,16 +2310,16 @@ module Aws::SQS
|
|
1923
2310
|
#
|
1924
2311
|
#
|
1925
2312
|
#
|
1926
|
-
# [1]:
|
1927
|
-
# [2]:
|
1928
|
-
# [3]:
|
1929
|
-
# [4]:
|
1930
|
-
# [5]:
|
1931
|
-
# [6]:
|
1932
|
-
# [7]:
|
1933
|
-
# [8]:
|
1934
|
-
# [9]:
|
1935
|
-
# [10]:
|
2313
|
+
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
|
2314
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
|
2315
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
2316
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
|
2317
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
|
2318
|
+
# [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
|
2319
|
+
# [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
|
2320
|
+
# [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
|
2321
|
+
# [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
|
2322
|
+
# [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
|
1936
2323
|
# @return [Hash<String,String>]
|
1937
2324
|
#
|
1938
2325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation
|
@@ -1940,6 +2327,7 @@ module Aws::SQS
|
|
1940
2327
|
class SetQueueAttributesRequest < Struct.new(
|
1941
2328
|
:queue_url,
|
1942
2329
|
:attributes)
|
2330
|
+
SENSITIVE = []
|
1943
2331
|
include Aws::Structure
|
1944
2332
|
end
|
1945
2333
|
|
@@ -1966,9 +2354,22 @@ module Aws::SQS
|
|
1966
2354
|
class TagQueueRequest < Struct.new(
|
1967
2355
|
:queue_url,
|
1968
2356
|
:tags)
|
2357
|
+
SENSITIVE = []
|
1969
2358
|
include Aws::Structure
|
1970
2359
|
end
|
1971
2360
|
|
2361
|
+
# The batch request contains more entries than permissible.
|
2362
|
+
#
|
2363
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/TooManyEntriesInBatchRequest AWS API Documentation
|
2364
|
+
#
|
2365
|
+
class TooManyEntriesInBatchRequest < Aws::EmptyStructure; end
|
2366
|
+
|
2367
|
+
# Error code 400. Unsupported operation.
|
2368
|
+
#
|
2369
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/UnsupportedOperation AWS API Documentation
|
2370
|
+
#
|
2371
|
+
class UnsupportedOperation < Aws::EmptyStructure; end
|
2372
|
+
|
1972
2373
|
# @note When making an API call, you may pass UntagQueueRequest
|
1973
2374
|
# data as a hash:
|
1974
2375
|
#
|
@@ -1990,6 +2391,7 @@ module Aws::SQS
|
|
1990
2391
|
class UntagQueueRequest < Struct.new(
|
1991
2392
|
:queue_url,
|
1992
2393
|
:tag_keys)
|
2394
|
+
SENSITIVE = []
|
1993
2395
|
include Aws::Structure
|
1994
2396
|
end
|
1995
2397
|
|