aws-sdk-sqs 1.70.0 → 1.93.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 +4 -4
- data/CHANGELOG.md +115 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-sqs/client.rb +338 -176
- data/lib/aws-sdk-sqs/client_api.rb +8 -1
- data/lib/aws-sdk-sqs/customizations.rb +5 -1
- data/lib/aws-sdk-sqs/endpoint_parameters.rb +9 -6
- data/lib/aws-sdk-sqs/endpoint_provider.rb +14 -18
- data/lib/aws-sdk-sqs/endpoints.rb +2 -320
- data/lib/aws-sdk-sqs/message.rb +3 -3
- data/lib/aws-sdk-sqs/plugins/endpoints.rb +19 -58
- data/lib/aws-sdk-sqs/plugins/md5s.rb +84 -35
- data/lib/aws-sdk-sqs/queue.rb +106 -31
- data/lib/aws-sdk-sqs/queue_poller.rb +1 -1
- data/lib/aws-sdk-sqs/resource.rb +10 -13
- data/lib/aws-sdk-sqs/types.rb +139 -50
- data/lib/aws-sdk-sqs.rb +17 -13
- data/sig/client.rbs +6 -0
- data/sig/message.rbs +1 -1
- data/sig/queue.rbs +1 -0
- data/sig/resource.rbs +5 -0
- data/sig/types.rbs +2 -1
- metadata +6 -6
data/lib/aws-sdk-sqs/client.rb
CHANGED
@@ -7,36 +7,36 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
-
require 'seahorse/client/plugins/content_length
|
11
|
-
require 'aws-sdk-core/plugins/credentials_configuration
|
12
|
-
require 'aws-sdk-core/plugins/logging
|
13
|
-
require 'aws-sdk-core/plugins/param_converter
|
14
|
-
require 'aws-sdk-core/plugins/param_validator
|
15
|
-
require 'aws-sdk-core/plugins/user_agent
|
16
|
-
require 'aws-sdk-core/plugins/helpful_socket_errors
|
17
|
-
require 'aws-sdk-core/plugins/retry_errors
|
18
|
-
require 'aws-sdk-core/plugins/global_configuration
|
19
|
-
require 'aws-sdk-core/plugins/regional_endpoint
|
20
|
-
require 'aws-sdk-core/plugins/endpoint_discovery
|
21
|
-
require 'aws-sdk-core/plugins/endpoint_pattern
|
22
|
-
require 'aws-sdk-core/plugins/response_paging
|
23
|
-
require 'aws-sdk-core/plugins/stub_responses
|
24
|
-
require 'aws-sdk-core/plugins/idempotency_token
|
25
|
-
require 'aws-sdk-core/plugins/
|
26
|
-
require 'aws-sdk-core/plugins/
|
27
|
-
require 'aws-sdk-core/plugins/
|
28
|
-
require 'aws-sdk-core/plugins/
|
29
|
-
require 'aws-sdk-core/plugins/
|
30
|
-
require 'aws-sdk-core/plugins/
|
31
|
-
require 'aws-sdk-core/plugins/
|
32
|
-
require 'aws-sdk-core/plugins/
|
33
|
-
require 'aws-sdk-core/plugins/
|
34
|
-
require 'aws-sdk-core/plugins/
|
35
|
-
require 'aws-sdk-core/plugins/
|
36
|
-
require 'aws-sdk-
|
37
|
-
require 'aws-sdk-
|
38
|
-
|
39
|
-
|
10
|
+
require 'seahorse/client/plugins/content_length'
|
11
|
+
require 'aws-sdk-core/plugins/credentials_configuration'
|
12
|
+
require 'aws-sdk-core/plugins/logging'
|
13
|
+
require 'aws-sdk-core/plugins/param_converter'
|
14
|
+
require 'aws-sdk-core/plugins/param_validator'
|
15
|
+
require 'aws-sdk-core/plugins/user_agent'
|
16
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors'
|
17
|
+
require 'aws-sdk-core/plugins/retry_errors'
|
18
|
+
require 'aws-sdk-core/plugins/global_configuration'
|
19
|
+
require 'aws-sdk-core/plugins/regional_endpoint'
|
20
|
+
require 'aws-sdk-core/plugins/endpoint_discovery'
|
21
|
+
require 'aws-sdk-core/plugins/endpoint_pattern'
|
22
|
+
require 'aws-sdk-core/plugins/response_paging'
|
23
|
+
require 'aws-sdk-core/plugins/stub_responses'
|
24
|
+
require 'aws-sdk-core/plugins/idempotency_token'
|
25
|
+
require 'aws-sdk-core/plugins/invocation_id'
|
26
|
+
require 'aws-sdk-core/plugins/jsonvalue_converter'
|
27
|
+
require 'aws-sdk-core/plugins/client_metrics_plugin'
|
28
|
+
require 'aws-sdk-core/plugins/client_metrics_send_plugin'
|
29
|
+
require 'aws-sdk-core/plugins/transfer_encoding'
|
30
|
+
require 'aws-sdk-core/plugins/http_checksum'
|
31
|
+
require 'aws-sdk-core/plugins/checksum_algorithm'
|
32
|
+
require 'aws-sdk-core/plugins/request_compression'
|
33
|
+
require 'aws-sdk-core/plugins/defaults_mode'
|
34
|
+
require 'aws-sdk-core/plugins/recursion_detection'
|
35
|
+
require 'aws-sdk-core/plugins/telemetry'
|
36
|
+
require 'aws-sdk-core/plugins/sign'
|
37
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc'
|
38
|
+
require 'aws-sdk-sqs/plugins/queue_urls'
|
39
|
+
require 'aws-sdk-sqs/plugins/md5s'
|
40
40
|
|
41
41
|
module Aws::SQS
|
42
42
|
# An API client for SQS. To construct a client, you need to configure a `:region` and `:credentials`.
|
@@ -74,6 +74,7 @@ module Aws::SQS
|
|
74
74
|
add_plugin(Aws::Plugins::ResponsePaging)
|
75
75
|
add_plugin(Aws::Plugins::StubResponses)
|
76
76
|
add_plugin(Aws::Plugins::IdempotencyToken)
|
77
|
+
add_plugin(Aws::Plugins::InvocationId)
|
77
78
|
add_plugin(Aws::Plugins::JsonvalueConverter)
|
78
79
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
79
80
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
@@ -83,6 +84,7 @@ module Aws::SQS
|
|
83
84
|
add_plugin(Aws::Plugins::RequestCompression)
|
84
85
|
add_plugin(Aws::Plugins::DefaultsMode)
|
85
86
|
add_plugin(Aws::Plugins::RecursionDetection)
|
87
|
+
add_plugin(Aws::Plugins::Telemetry)
|
86
88
|
add_plugin(Aws::Plugins::Sign)
|
87
89
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
88
90
|
add_plugin(Aws::SQS::Plugins::QueueUrls)
|
@@ -91,6 +93,11 @@ module Aws::SQS
|
|
91
93
|
|
92
94
|
# @overload initialize(options)
|
93
95
|
# @param [Hash] options
|
96
|
+
#
|
97
|
+
# @option options [Array<Seahorse::Client::Plugin>] :plugins ([]])
|
98
|
+
# A list of plugins to apply to the client. Each plugin is either a
|
99
|
+
# class name or an instance of a plugin class.
|
100
|
+
#
|
94
101
|
# @option options [required, Aws::CredentialProvider] :credentials
|
95
102
|
# Your AWS credentials. This can be an instance of any one of the
|
96
103
|
# following classes:
|
@@ -125,13 +132,15 @@ module Aws::SQS
|
|
125
132
|
# locations will be searched for credentials:
|
126
133
|
#
|
127
134
|
# * `Aws.config[:credentials]`
|
128
|
-
# * The `:access_key_id`, `:secret_access_key`,
|
129
|
-
#
|
135
|
+
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
136
|
+
# `:account_id` options.
|
137
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'],
|
138
|
+
# ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
|
130
139
|
# * `~/.aws/credentials`
|
131
140
|
# * `~/.aws/config`
|
132
141
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
133
142
|
# are very aggressive. Construct and pass an instance of
|
134
|
-
# `Aws::
|
143
|
+
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
135
144
|
# enable retries and extended timeouts. Instance profile credential
|
136
145
|
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
137
146
|
# to true.
|
@@ -150,6 +159,8 @@ module Aws::SQS
|
|
150
159
|
#
|
151
160
|
# @option options [String] :access_key_id
|
152
161
|
#
|
162
|
+
# @option options [String] :account_id
|
163
|
+
#
|
153
164
|
# @option options [Boolean] :active_endpoint_cache (false)
|
154
165
|
# When set to `true`, a thread polling for endpoints will be running in
|
155
166
|
# the background every 60 secs (default). Defaults to `false`.
|
@@ -200,10 +211,16 @@ module Aws::SQS
|
|
200
211
|
# When set to 'true' the request body will not be compressed
|
201
212
|
# for supported operations.
|
202
213
|
#
|
203
|
-
# @option options [String] :endpoint
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
214
|
+
# @option options [String, URI::HTTPS, URI::HTTP] :endpoint
|
215
|
+
# Normally you should not configure the `:endpoint` option
|
216
|
+
# directly. This is normally constructed from the `:region`
|
217
|
+
# option. Configuring `:endpoint` is normally reserved for
|
218
|
+
# connecting to test or custom endpoints. The endpoint should
|
219
|
+
# be a URI formatted like:
|
220
|
+
#
|
221
|
+
# 'http://example.com'
|
222
|
+
# 'https://example.com'
|
223
|
+
# 'http://example.com:123'
|
207
224
|
#
|
208
225
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
209
226
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -244,11 +261,34 @@ module Aws::SQS
|
|
244
261
|
# Used when loading credentials from the shared credentials file
|
245
262
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
246
263
|
#
|
264
|
+
# @option options [String] :request_checksum_calculation ("when_supported")
|
265
|
+
# Determines when a checksum will be calculated for request payloads. Values are:
|
266
|
+
#
|
267
|
+
# * `when_supported` - (default) When set, a checksum will be
|
268
|
+
# calculated for all request payloads of operations modeled with the
|
269
|
+
# `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a
|
270
|
+
# `requestAlgorithmMember` is modeled.
|
271
|
+
# * `when_required` - When set, a checksum will only be calculated for
|
272
|
+
# request payloads of operations modeled with the `httpChecksum` trait where
|
273
|
+
# `requestChecksumRequired` is `true` or where a `requestAlgorithmMember`
|
274
|
+
# is modeled and supplied.
|
275
|
+
#
|
247
276
|
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
248
277
|
# The minimum size in bytes that triggers compression for request
|
249
278
|
# bodies. The value must be non-negative integer value between 0
|
250
279
|
# and 10485780 bytes inclusive.
|
251
280
|
#
|
281
|
+
# @option options [String] :response_checksum_validation ("when_supported")
|
282
|
+
# Determines when checksum validation will be performed on response payloads. Values are:
|
283
|
+
#
|
284
|
+
# * `when_supported` - (default) When set, checksum validation is performed on all
|
285
|
+
# response payloads of operations modeled with the `httpChecksum` trait where
|
286
|
+
# `responseAlgorithms` is modeled, except when no modeled checksum algorithms
|
287
|
+
# are supported.
|
288
|
+
# * `when_required` - When set, checksum validation is not performed on
|
289
|
+
# response payloads of operations unless the checksum algorithm is supported and
|
290
|
+
# the `requestValidationModeMember` member is set to `ENABLED`.
|
291
|
+
#
|
252
292
|
# @option options [Proc] :retry_backoff
|
253
293
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
254
294
|
# This option is only used in the `legacy` retry mode.
|
@@ -293,25 +333,31 @@ module Aws::SQS
|
|
293
333
|
# throttling. This is a provisional mode that may change behavior
|
294
334
|
# in the future.
|
295
335
|
#
|
296
|
-
#
|
297
336
|
# @option options [String] :sdk_ua_app_id
|
298
337
|
# A unique and opaque application ID that is appended to the
|
299
|
-
# User-Agent header as app
|
300
|
-
# maximum length of 50.
|
338
|
+
# User-Agent header as app/sdk_ua_app_id. It should have a
|
339
|
+
# maximum length of 50. This variable is sourced from environment
|
340
|
+
# variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.
|
301
341
|
#
|
302
342
|
# @option options [String] :secret_access_key
|
303
343
|
#
|
304
344
|
# @option options [String] :session_token
|
305
345
|
#
|
346
|
+
# @option options [Array] :sigv4a_signing_region_set
|
347
|
+
# A list of regions that should be signed with SigV4a signing. When
|
348
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
349
|
+
# in the following locations:
|
350
|
+
#
|
351
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
352
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
353
|
+
# * `~/.aws/config`
|
354
|
+
#
|
306
355
|
# @option options [Boolean] :simple_json (false)
|
307
356
|
# Disables request parameter conversion, validation, and formatting.
|
308
|
-
# Also
|
309
|
-
#
|
310
|
-
#
|
311
|
-
# structures.
|
312
|
-
#
|
313
|
-
# When `:simple_json` is enabled, the request parameters hash must
|
314
|
-
# be formatted exactly as the DynamoDB API expects.
|
357
|
+
# Also disables response data type conversions. The request parameters
|
358
|
+
# hash must be formatted exactly as the API expects.This option is useful
|
359
|
+
# when you want to ensure the highest level of performance by avoiding
|
360
|
+
# overhead of walking request parameters and response data structures.
|
315
361
|
#
|
316
362
|
# @option options [Boolean] :stub_responses (false)
|
317
363
|
# Causes the client to return stubbed responses. By default
|
@@ -322,6 +368,16 @@ module Aws::SQS
|
|
322
368
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
323
369
|
# requests are made, and retries are disabled.
|
324
370
|
#
|
371
|
+
# @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider)
|
372
|
+
# Allows you to provide a telemetry provider, which is used to
|
373
|
+
# emit telemetry data. By default, uses `NoOpTelemetryProvider` which
|
374
|
+
# will not record or emit any telemetry data. The SDK supports the
|
375
|
+
# following telemetry providers:
|
376
|
+
#
|
377
|
+
# * OpenTelemetry (OTel) - To use the OTel provider, install and require the
|
378
|
+
# `opentelemetry-sdk` gem and then, pass in an instance of a
|
379
|
+
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
380
|
+
#
|
325
381
|
# @option options [Aws::TokenProvider] :token_provider
|
326
382
|
# A Bearer Token Provider. This can be an instance of any one of the
|
327
383
|
# following classes:
|
@@ -355,52 +411,75 @@ module Aws::SQS
|
|
355
411
|
# not match.
|
356
412
|
#
|
357
413
|
# @option options [Aws::SQS::EndpointProvider] :endpoint_provider
|
358
|
-
# The endpoint provider used to resolve endpoints. Any object that responds to
|
359
|
-
#
|
360
|
-
#
|
361
|
-
#
|
362
|
-
#
|
363
|
-
#
|
364
|
-
#
|
365
|
-
# `
|
366
|
-
#
|
367
|
-
#
|
368
|
-
#
|
369
|
-
#
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
374
|
-
#
|
375
|
-
#
|
376
|
-
#
|
377
|
-
#
|
378
|
-
#
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
414
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to
|
415
|
+
# `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to
|
416
|
+
# `Aws::SQS::EndpointParameters`.
|
417
|
+
#
|
418
|
+
# @option options [Float] :http_continue_timeout (1)
|
419
|
+
# The number of seconds to wait for a 100-continue response before sending the
|
420
|
+
# request body. This option has no effect unless the request has "Expect"
|
421
|
+
# header set to "100-continue". Defaults to `nil` which disables this
|
422
|
+
# behaviour. This value can safely be set per request on the session.
|
423
|
+
#
|
424
|
+
# @option options [Float] :http_idle_timeout (5)
|
425
|
+
# The number of seconds a connection is allowed to sit idle before it
|
426
|
+
# is considered stale. Stale connections are closed and removed from the
|
427
|
+
# pool before making a request.
|
428
|
+
#
|
429
|
+
# @option options [Float] :http_open_timeout (15)
|
430
|
+
# The default number of seconds to wait for response data.
|
431
|
+
# This value can safely be set per-request on the session.
|
432
|
+
#
|
433
|
+
# @option options [URI::HTTP,String] :http_proxy
|
434
|
+
# A proxy to send requests through. Formatted like 'http://proxy.com:123'.
|
435
|
+
#
|
436
|
+
# @option options [Float] :http_read_timeout (60)
|
437
|
+
# The default number of seconds to wait for response data.
|
438
|
+
# This value can safely be set per-request on the session.
|
439
|
+
#
|
440
|
+
# @option options [Boolean] :http_wire_trace (false)
|
441
|
+
# When `true`, HTTP debug output will be sent to the `:logger`.
|
442
|
+
#
|
443
|
+
# @option options [Proc] :on_chunk_received
|
444
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
445
|
+
# of the response body is received. It provides three arguments: the chunk,
|
446
|
+
# the number of bytes received, and the total number of
|
447
|
+
# bytes in the response (or nil if the server did not send a `content-length`).
|
448
|
+
#
|
449
|
+
# @option options [Proc] :on_chunk_sent
|
450
|
+
# When a Proc object is provided, it will be used as callback when each chunk
|
451
|
+
# of the request body is sent. It provides three arguments: the chunk,
|
452
|
+
# the number of bytes read from the body, and the total number of
|
453
|
+
# bytes in the body.
|
454
|
+
#
|
455
|
+
# @option options [Boolean] :raise_response_errors (true)
|
456
|
+
# When `true`, response errors are raised.
|
457
|
+
#
|
458
|
+
# @option options [String] :ssl_ca_bundle
|
459
|
+
# Full path to the SSL certificate authority bundle file that should be used when
|
460
|
+
# verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
|
461
|
+
# `:ssl_ca_directory` the the system default will be used if available.
|
462
|
+
#
|
463
|
+
# @option options [String] :ssl_ca_directory
|
464
|
+
# Full path of the directory that contains the unbundled SSL certificate
|
465
|
+
# authority files for verifying peer certificates. If you do
|
466
|
+
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
|
467
|
+
# default will be used if available.
|
382
468
|
#
|
383
|
-
# @option options [
|
384
|
-
#
|
469
|
+
# @option options [String] :ssl_ca_store
|
470
|
+
# Sets the X509::Store to verify peer certificate.
|
385
471
|
#
|
386
|
-
# @option options [
|
387
|
-
#
|
472
|
+
# @option options [OpenSSL::X509::Certificate] :ssl_cert
|
473
|
+
# Sets a client certificate when creating http connections.
|
388
474
|
#
|
389
|
-
# @option options [
|
390
|
-
#
|
391
|
-
# connection.
|
475
|
+
# @option options [OpenSSL::PKey] :ssl_key
|
476
|
+
# Sets a client key when creating http connections.
|
392
477
|
#
|
393
|
-
# @option options [
|
394
|
-
#
|
395
|
-
# verifying peer certificates. If you do not pass
|
396
|
-
# `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
|
397
|
-
# will be used if available.
|
478
|
+
# @option options [Float] :ssl_timeout
|
479
|
+
# Sets the SSL timeout in seconds
|
398
480
|
#
|
399
|
-
# @option options [
|
400
|
-
#
|
401
|
-
# authority files for verifying peer certificates. If you do
|
402
|
-
# not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
|
403
|
-
# system default will be used if available.
|
481
|
+
# @option options [Boolean] :ssl_verify_peer (true)
|
482
|
+
# When `true`, SSL peer certificates are verified when establishing a connection.
|
404
483
|
#
|
405
484
|
def initialize(*args)
|
406
485
|
super
|
@@ -518,8 +597,6 @@ module Aws::SQS
|
|
518
597
|
# can be the original source queue (from which the messages were
|
519
598
|
# driven to the dead-letter-queue), or a custom destination queue.
|
520
599
|
#
|
521
|
-
# * Currently, only standard queues are supported.
|
522
|
-
#
|
523
600
|
# * Only one active message movement task is supported per queue at any
|
524
601
|
# given time.
|
525
602
|
#
|
@@ -598,7 +675,7 @@ module Aws::SQS
|
|
598
675
|
# increase the number of queues you use to process your messages. To
|
599
676
|
# request a limit increase, [file a support request][2].
|
600
677
|
#
|
601
|
-
# For FIFO queues, there can be a maximum of
|
678
|
+
# For FIFO queues, there can be a maximum of 120,000 in flight messages
|
602
679
|
# (received from a queue by a consumer, but not yet deleted from the
|
603
680
|
# queue). If you reach this limit, Amazon SQS returns no error messages.
|
604
681
|
#
|
@@ -741,20 +818,24 @@ module Aws::SQS
|
|
741
818
|
#
|
742
819
|
# </note>
|
743
820
|
#
|
744
|
-
# To
|
745
|
-
#
|
746
|
-
# names:
|
821
|
+
# To retrieve the URL of a queue, use the [ `GetQueueUrl` ][3] action.
|
822
|
+
# This action only requires the [ `QueueName` ][4] parameter.
|
747
823
|
#
|
748
|
-
#
|
749
|
-
# names and values of all the queue's attributes, `CreateQueue`
|
750
|
-
# returns the queue URL for the existing queue.
|
824
|
+
# When creating queues, keep the following points in mind:
|
751
825
|
#
|
752
|
-
# * If the
|
753
|
-
#
|
826
|
+
# * If you specify the name of an existing queue and provide the exact
|
827
|
+
# same names and values for all its attributes, the [ `CreateQueue`
|
828
|
+
# ][5] action will return the URL of the existing queue instead of
|
829
|
+
# creating a new one.
|
830
|
+
#
|
831
|
+
# * If you attempt to create a queue with a name that already exists but
|
832
|
+
# with different attribute names or values, the `CreateQueue` action
|
833
|
+
# will return an error. This ensures that existing queues are not
|
834
|
+
# inadvertently altered.
|
754
835
|
#
|
755
836
|
# <note markdown="1"> Cross-account permissions don't apply to this action. For more
|
756
837
|
# information, see [Grant cross-account permissions to a role and a
|
757
|
-
# username][
|
838
|
+
# username][6] in the *Amazon SQS Developer Guide*.
|
758
839
|
#
|
759
840
|
# </note>
|
760
841
|
#
|
@@ -762,7 +843,10 @@ module Aws::SQS
|
|
762
843
|
#
|
763
844
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving
|
764
845
|
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html
|
765
|
-
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/
|
846
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_GetQueueUrl.html
|
847
|
+
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html#API_CreateQueue_RequestSyntax
|
848
|
+
# [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html
|
849
|
+
# [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name
|
766
850
|
#
|
767
851
|
# @option params [required, String] :queue_name
|
768
852
|
# The name of the new queue. The following limits apply to this name:
|
@@ -830,7 +914,6 @@ module Aws::SQS
|
|
830
914
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
831
915
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
832
916
|
# dead-letter-queue.
|
833
|
-
#
|
834
917
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
835
918
|
# the permissions for the dead-letter queue redrive permission and
|
836
919
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -849,7 +932,6 @@ module Aws::SQS
|
|
849
932
|
#
|
850
933
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
851
934
|
# parameter can specify this queue as the dead-letter queue.
|
852
|
-
#
|
853
935
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
854
936
|
# queues that can specify this queue as the dead-letter queue and
|
855
937
|
# redrive messages. You can specify this parameter only when the
|
@@ -921,7 +1003,6 @@ module Aws::SQS
|
|
921
1003
|
#
|
922
1004
|
# * If the queue has `ContentBasedDeduplication` set, your
|
923
1005
|
# `MessageDeduplicationId` overrides the generated one.
|
924
|
-
#
|
925
1006
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
926
1007
|
# identical content sent within the deduplication interval are
|
927
1008
|
# treated as duplicates and only one copy of the message is
|
@@ -1049,12 +1130,14 @@ module Aws::SQS
|
|
1049
1130
|
# automatically deletes messages left in a queue longer than the
|
1050
1131
|
# retention period configured for the queue.
|
1051
1132
|
#
|
1052
|
-
# <note markdown="1">
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
#
|
1056
|
-
#
|
1057
|
-
#
|
1133
|
+
# <note markdown="1"> Each time you receive a message, meaning when a consumer retrieves a
|
1134
|
+
# message from the queue, it comes with a unique `ReceiptHandle`. If you
|
1135
|
+
# receive the same message more than once, you will get a different
|
1136
|
+
# `ReceiptHandle` each time. When you want to delete a message using the
|
1137
|
+
# `DeleteMessage` action, you must use the `ReceiptHandle` from the most
|
1138
|
+
# recent time you received the message. If you use an old
|
1139
|
+
# `ReceiptHandle`, the request will succeed, but the message might not
|
1140
|
+
# be deleted.
|
1058
1141
|
#
|
1059
1142
|
# For standard queues, it is possible to receive a message even after
|
1060
1143
|
# you delete it. This might happen on rare occasions if one of the
|
@@ -1294,7 +1377,6 @@ module Aws::SQS
|
|
1294
1377
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
1295
1378
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
1296
1379
|
# dead-letter-queue.
|
1297
|
-
#
|
1298
1380
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
1299
1381
|
# the permissions for the dead-letter queue redrive permission and
|
1300
1382
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -1313,7 +1395,6 @@ module Aws::SQS
|
|
1313
1395
|
#
|
1314
1396
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
1315
1397
|
# parameter can specify this queue as the dead-letter queue.
|
1316
|
-
#
|
1317
1398
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
1318
1399
|
# queues that can specify this queue as the dead-letter queue and
|
1319
1400
|
# redrive messages. You can specify this parameter only when the
|
@@ -1427,29 +1508,32 @@ module Aws::SQS
|
|
1427
1508
|
req.send_request(options)
|
1428
1509
|
end
|
1429
1510
|
|
1430
|
-
#
|
1431
|
-
#
|
1432
|
-
#
|
1433
|
-
#
|
1434
|
-
#
|
1435
|
-
# the
|
1436
|
-
#
|
1437
|
-
#
|
1511
|
+
# The `GetQueueUrl` API returns the URL of an existing Amazon SQS queue.
|
1512
|
+
# This is useful when you know the queue's name but need to retrieve
|
1513
|
+
# its URL for further operations.
|
1514
|
+
#
|
1515
|
+
# To access a queue owned by another Amazon Web Services account, use
|
1516
|
+
# the `QueueOwnerAWSAccountId` parameter to specify the account ID of
|
1517
|
+
# the queue's owner. Note that the queue owner must grant you the
|
1518
|
+
# necessary permissions to access the queue. For more information about
|
1519
|
+
# accessing shared queues, see the ` AddPermission ` API or [Allow
|
1520
|
+
# developers to write messages to a shared queue][1] in the *Amazon SQS
|
1521
|
+
# Developer Guide*.
|
1438
1522
|
#
|
1439
1523
|
#
|
1440
1524
|
#
|
1441
1525
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue
|
1442
1526
|
#
|
1443
1527
|
# @option params [required, String] :queue_name
|
1444
|
-
# The name of the queue
|
1445
|
-
#
|
1446
|
-
# underscores (
|
1447
|
-
#
|
1448
|
-
# Queue URLs and names are case-sensitive.
|
1528
|
+
# (Required) The name of the queue for which you want to fetch the URL.
|
1529
|
+
# The name can be up to 80 characters long and can include alphanumeric
|
1530
|
+
# characters, hyphens (-), and underscores (\_). Queue URLs and names
|
1531
|
+
# are case-sensitive.
|
1449
1532
|
#
|
1450
1533
|
# @option params [String] :queue_owner_aws_account_id
|
1451
|
-
# The Amazon Web Services account ID of the account that
|
1452
|
-
# queue.
|
1534
|
+
# (Optional) The Amazon Web Services account ID of the account that
|
1535
|
+
# created the queue. This is only required when you are attempting to
|
1536
|
+
# access a queue owned by another Amazon Web Services account.
|
1453
1537
|
#
|
1454
1538
|
# @return [Types::GetQueueUrlResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1455
1539
|
#
|
@@ -1546,8 +1630,6 @@ module Aws::SQS
|
|
1546
1630
|
# can be the original source queue (from which the messages were
|
1547
1631
|
# driven to the dead-letter-queue), or a custom destination queue.
|
1548
1632
|
#
|
1549
|
-
# * Currently, only standard queues are supported.
|
1550
|
-
#
|
1551
1633
|
# * Only one active message movement task is supported per queue at any
|
1552
1634
|
# given time.
|
1553
1635
|
#
|
@@ -1751,7 +1833,7 @@ module Aws::SQS
|
|
1751
1833
|
# Developer Guide*.
|
1752
1834
|
#
|
1753
1835
|
# Short poll is the default behavior where a weighted random set of
|
1754
|
-
# machines is sampled on a `ReceiveMessage` call.
|
1836
|
+
# machines is sampled on a `ReceiveMessage` call. Therefore, only the
|
1755
1837
|
# messages on the sampled machines are returned. If the number of
|
1756
1838
|
# messages in the queue is small (fewer than 1,000), you most likely get
|
1757
1839
|
# fewer messages than you requested per `ReceiveMessage` call. If the
|
@@ -1781,14 +1863,8 @@ module Aws::SQS
|
|
1781
1863
|
# You can provide the `VisibilityTimeout` parameter in your request. The
|
1782
1864
|
# parameter is applied to the messages that Amazon SQS returns in the
|
1783
1865
|
# response. If you don't include the parameter, the overall visibility
|
1784
|
-
# timeout for the queue is used for the returned messages.
|
1785
|
-
#
|
1786
|
-
# Guide*.
|
1787
|
-
#
|
1788
|
-
# A message that isn't deleted or a message whose visibility isn't
|
1789
|
-
# extended before the visibility timeout expires counts as a failed
|
1790
|
-
# receive. Depending on the configuration of the queue, the message
|
1791
|
-
# might be sent to the dead-letter queue.
|
1866
|
+
# timeout for the queue is used for the returned messages. The default
|
1867
|
+
# visibility timeout for a queue is 30 seconds.
|
1792
1868
|
#
|
1793
1869
|
# <note markdown="1"> In the future, new attributes might be added. If you write code that
|
1794
1870
|
# calls this action, we recommend that you structure your code so that
|
@@ -1801,7 +1877,6 @@ module Aws::SQS
|
|
1801
1877
|
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html
|
1802
1878
|
# [2]: https://www.ietf.org/rfc/rfc1321.txt
|
1803
1879
|
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html
|
1804
|
-
# [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1805
1880
|
#
|
1806
1881
|
# @option params [required, String] :queue_url
|
1807
1882
|
# The URL of the Amazon SQS queue from which messages are received.
|
@@ -1809,6 +1884,10 @@ module Aws::SQS
|
|
1809
1884
|
# Queue URLs and names are case-sensitive.
|
1810
1885
|
#
|
1811
1886
|
# @option params [Array<String>] :attribute_names
|
1887
|
+
# This parameter has been discontinued but will be supported for
|
1888
|
+
# backward compatibility. To provide attribute names, you are encouraged
|
1889
|
+
# to use `MessageSystemAttributeNames`.
|
1890
|
+
#
|
1812
1891
|
# A list of attributes that need to be returned along with each message.
|
1813
1892
|
# These attributes include:
|
1814
1893
|
#
|
@@ -1829,7 +1908,49 @@ module Aws::SQS
|
|
1829
1908
|
#
|
1830
1909
|
# * For an IAM role, returns the IAM role ID, for example
|
1831
1910
|
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1911
|
+
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1912
|
+
# ([epoch time][1] in milliseconds).
|
1913
|
+
#
|
1914
|
+
# * `SqsManagedSseEnabled` – Enables server-side queue encryption using
|
1915
|
+
# SQS owned encryption keys. Only one server-side encryption option is
|
1916
|
+
# supported per queue (for example, [SSE-KMS][2] or [SSE-SQS][3]).
|
1917
|
+
#
|
1918
|
+
# * `MessageDeduplicationId` – Returns the value provided by the
|
1919
|
+
# producer that calls the ` SendMessage ` action.
|
1920
|
+
#
|
1921
|
+
# * `MessageGroupId` – Returns the value provided by the producer that
|
1922
|
+
# calls the ` SendMessage ` action. Messages with the same
|
1923
|
+
# `MessageGroupId` are returned in sequence.
|
1924
|
+
#
|
1925
|
+
# * `SequenceNumber` – Returns the value provided by Amazon SQS.
|
1926
|
+
#
|
1927
|
+
#
|
1928
|
+
#
|
1929
|
+
# [1]: http://en.wikipedia.org/wiki/Unix_time
|
1930
|
+
# [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
|
1931
|
+
# [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
|
1932
|
+
#
|
1933
|
+
# @option params [Array<String>] :message_system_attribute_names
|
1934
|
+
# A list of attributes that need to be returned along with each message.
|
1935
|
+
# These attributes include:
|
1936
|
+
#
|
1937
|
+
# * `All` – Returns all values.
|
1938
|
+
#
|
1939
|
+
# * `ApproximateFirstReceiveTimestamp` – Returns the time the message
|
1940
|
+
# was first received from the queue ([epoch time][1] in milliseconds).
|
1941
|
+
#
|
1942
|
+
# * `ApproximateReceiveCount` – Returns the number of times a message
|
1943
|
+
# has been received across all queues but not deleted.
|
1944
|
+
#
|
1945
|
+
# * `AWSTraceHeader` – Returns the X-Ray trace header string.
|
1946
|
+
#
|
1947
|
+
# * `SenderId`
|
1832
1948
|
#
|
1949
|
+
# * For a user, returns the user ID, for example
|
1950
|
+
# `ABCDEFGHI1JKLMNOPQ23R`.
|
1951
|
+
#
|
1952
|
+
# * For an IAM role, returns the IAM role ID, for example
|
1953
|
+
# `ABCDE1F2GH3I4JK5LMNOP:i-a123b456`.
|
1833
1954
|
# * `SentTimestamp` – Returns the time the message was sent to the queue
|
1834
1955
|
# ([epoch time][1] in milliseconds).
|
1835
1956
|
#
|
@@ -1882,14 +2003,47 @@ module Aws::SQS
|
|
1882
2003
|
# @option params [Integer] :visibility_timeout
|
1883
2004
|
# The duration (in seconds) that the received messages are hidden from
|
1884
2005
|
# subsequent retrieve requests after being retrieved by a
|
1885
|
-
# `ReceiveMessage` request.
|
2006
|
+
# `ReceiveMessage` request. If not specified, the default visibility
|
2007
|
+
# timeout for the queue is used, which is 30 seconds.
|
2008
|
+
#
|
2009
|
+
# Understanding `VisibilityTimeout`:
|
2010
|
+
#
|
2011
|
+
# * When a message is received from a queue, it becomes temporarily
|
2012
|
+
# invisible to other consumers for the duration of the visibility
|
2013
|
+
# timeout. This prevents multiple consumers from processing the same
|
2014
|
+
# message simultaneously. If the message is not deleted or its
|
2015
|
+
# visibility timeout is not extended before the timeout expires, it
|
2016
|
+
# becomes visible again and can be retrieved by other consumers.
|
2017
|
+
#
|
2018
|
+
# * Setting an appropriate visibility timeout is crucial. If it's too
|
2019
|
+
# short, the message might become visible again before processing is
|
2020
|
+
# complete, leading to duplicate processing. If it's too long, it
|
2021
|
+
# delays the reprocessing of messages if the initial processing fails.
|
2022
|
+
#
|
2023
|
+
# * You can adjust the visibility timeout using the
|
2024
|
+
# `--visibility-timeout` parameter in the `receive-message` command to
|
2025
|
+
# match the processing time required by your application.
|
2026
|
+
#
|
2027
|
+
# * A message that isn't deleted or a message whose visibility isn't
|
2028
|
+
# extended before the visibility timeout expires counts as a failed
|
2029
|
+
# receive. Depending on the configuration of the queue, the message
|
2030
|
+
# might be sent to the dead-letter queue.
|
2031
|
+
#
|
2032
|
+
# For more information, see [Visibility Timeout][1] in the *Amazon SQS
|
2033
|
+
# Developer Guide*.
|
2034
|
+
#
|
2035
|
+
#
|
2036
|
+
#
|
2037
|
+
# [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
|
1886
2038
|
#
|
1887
2039
|
# @option params [Integer] :wait_time_seconds
|
1888
2040
|
# The duration (in seconds) for which the call waits for a message to
|
1889
2041
|
# arrive in the queue before returning. If a message is available, the
|
1890
2042
|
# call returns sooner than `WaitTimeSeconds`. If no messages are
|
1891
|
-
# available and the wait time expires, the call
|
1892
|
-
#
|
2043
|
+
# available and the wait time expires, the call does not return a
|
2044
|
+
# message list. If you are using the Java SDK, it returns a
|
2045
|
+
# `ReceiveMessageResponse` object, which has a empty list instead of a
|
2046
|
+
# Null object.
|
1893
2047
|
#
|
1894
2048
|
# To avoid HTTP errors, ensure that the HTTP response timeout for
|
1895
2049
|
# `ReceiveMessage` requests is longer than the `WaitTimeSeconds`
|
@@ -1918,10 +2072,6 @@ module Aws::SQS
|
|
1918
2072
|
# * When you set `FifoQueue`, a caller of the `ReceiveMessage` action
|
1919
2073
|
# can provide a `ReceiveRequestAttemptId` explicitly.
|
1920
2074
|
#
|
1921
|
-
# * If a caller of the `ReceiveMessage` action doesn't provide a
|
1922
|
-
# `ReceiveRequestAttemptId`, Amazon SQS generates a
|
1923
|
-
# `ReceiveRequestAttemptId`.
|
1924
|
-
#
|
1925
2075
|
# * It is possible to retry the `ReceiveMessage` action with the same
|
1926
2076
|
# `ReceiveRequestAttemptId` if none of the messages have been modified
|
1927
2077
|
# (deleted or had their visibility changes).
|
@@ -1955,7 +2105,7 @@ module Aws::SQS
|
|
1955
2105
|
#
|
1956
2106
|
# The maximum length of `ReceiveRequestAttemptId` is 128 characters.
|
1957
2107
|
# `ReceiveRequestAttemptId` can contain alphanumeric characters (`a-z`,
|
1958
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
2108
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
1959
2109
|
# ``).
|
1960
2110
|
#
|
1961
2111
|
# For best practices of using `ReceiveRequestAttemptId`, see [Using the
|
@@ -1976,6 +2126,7 @@ module Aws::SQS
|
|
1976
2126
|
# resp = client.receive_message({
|
1977
2127
|
# queue_url: "String", # required
|
1978
2128
|
# attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit, RedriveAllowPolicy, SqsManagedSseEnabled
|
2129
|
+
# message_system_attribute_names: ["All"], # accepts All, SenderId, SentTimestamp, ApproximateReceiveCount, ApproximateFirstReceiveTimestamp, SequenceNumber, MessageDeduplicationId, MessageGroupId, AWSTraceHeader, DeadLetterQueueSourceArn
|
1979
2130
|
# message_attribute_names: ["MessageAttributeName"],
|
1980
2131
|
# max_number_of_messages: 1,
|
1981
2132
|
# visibility_timeout: 1,
|
@@ -2060,13 +2211,17 @@ module Aws::SQS
|
|
2060
2211
|
# Delivers a message to the specified queue.
|
2061
2212
|
#
|
2062
2213
|
# A message can include only XML, JSON, and unformatted text. The
|
2063
|
-
# following Unicode characters are allowed
|
2214
|
+
# following Unicode characters are allowed. For more information, see
|
2215
|
+
# the [W3C specification for characters][1].
|
2064
2216
|
#
|
2065
2217
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
2066
2218
|
# \| `#x10000` to `#x10FFFF`
|
2067
2219
|
#
|
2068
|
-
#
|
2069
|
-
#
|
2220
|
+
# Amazon SQS does not throw an exception or completely reject the
|
2221
|
+
# message if it contains invalid characters. Instead, it replaces those
|
2222
|
+
# invalid characters with `U+FFFD` before storing the message in the
|
2223
|
+
# queue, as long as the message body contains at least one valid
|
2224
|
+
# character.
|
2070
2225
|
#
|
2071
2226
|
#
|
2072
2227
|
#
|
@@ -2082,13 +2237,17 @@ module Aws::SQS
|
|
2082
2237
|
# size is 256 KiB.
|
2083
2238
|
#
|
2084
2239
|
# A message can include only XML, JSON, and unformatted text. The
|
2085
|
-
# following Unicode characters are allowed
|
2240
|
+
# following Unicode characters are allowed. For more information, see
|
2241
|
+
# the [W3C specification for characters][1].
|
2086
2242
|
#
|
2087
2243
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
2088
2244
|
# \| `#x10000` to `#x10FFFF`
|
2089
2245
|
#
|
2090
|
-
#
|
2091
|
-
#
|
2246
|
+
# Amazon SQS does not throw an exception or completely reject the
|
2247
|
+
# message if it contains invalid characters. Instead, it replaces those
|
2248
|
+
# invalid characters with `U+FFFD` before storing the message in the
|
2249
|
+
# queue, as long as the message body contains at least one valid
|
2250
|
+
# character.
|
2092
2251
|
#
|
2093
2252
|
#
|
2094
2253
|
#
|
@@ -2151,7 +2310,6 @@ module Aws::SQS
|
|
2151
2310
|
#
|
2152
2311
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2153
2312
|
# `MessageDeduplicationId` overrides the generated one.
|
2154
|
-
#
|
2155
2313
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2156
2314
|
# identical content sent within the deduplication interval are treated
|
2157
2315
|
# as duplicates and only one copy of the message is delivered.
|
@@ -2176,7 +2334,7 @@ module Aws::SQS
|
|
2176
2334
|
#
|
2177
2335
|
# The maximum length of `MessageDeduplicationId` is 128 characters.
|
2178
2336
|
# `MessageDeduplicationId` can contain alphanumeric characters (`a-z`,
|
2179
|
-
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_
|
2337
|
+
# `A-Z`, `0-9`) and punctuation (`` !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
|
2180
2338
|
# ``).
|
2181
2339
|
#
|
2182
2340
|
# For best practices of using `MessageDeduplicationId`, see [Using the
|
@@ -2207,9 +2365,9 @@ module Aws::SQS
|
|
2207
2365
|
# `MessageGroupId` values. For each `MessageGroupId`, the messages are
|
2208
2366
|
# sorted by time sent. The caller can't specify a `MessageGroupId`.
|
2209
2367
|
#
|
2210
|
-
# The length of `MessageGroupId` is 128 characters. Valid
|
2211
|
-
# alphanumeric characters and punctuation ``
|
2212
|
-
# (!"#$%&'()*+,-./:;<=>?@[\]^_
|
2368
|
+
# The maximum length of `MessageGroupId` is 128 characters. Valid
|
2369
|
+
# values: alphanumeric characters and punctuation ``
|
2370
|
+
# (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~) ``.
|
2213
2371
|
#
|
2214
2372
|
# For best practices of using `MessageGroupId`, see [Using the
|
2215
2373
|
# MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
|
@@ -2290,13 +2448,17 @@ module Aws::SQS
|
|
2290
2448
|
# messages) are both 256 KiB (262,144 bytes).
|
2291
2449
|
#
|
2292
2450
|
# A message can include only XML, JSON, and unformatted text. The
|
2293
|
-
# following Unicode characters are allowed
|
2451
|
+
# following Unicode characters are allowed. For more information, see
|
2452
|
+
# the [W3C specification for characters][1].
|
2294
2453
|
#
|
2295
2454
|
# `#x9` \| `#xA` \| `#xD` \| `#x20` to `#xD7FF` \| `#xE000` to `#xFFFD`
|
2296
2455
|
# \| `#x10000` to `#x10FFFF`
|
2297
2456
|
#
|
2298
|
-
#
|
2299
|
-
#
|
2457
|
+
# Amazon SQS does not throw an exception or completely reject the
|
2458
|
+
# message if it contains invalid characters. Instead, it replaces those
|
2459
|
+
# invalid characters with `U+FFFD` before storing the message in the
|
2460
|
+
# queue, as long as the message body contains at least one valid
|
2461
|
+
# character.
|
2300
2462
|
#
|
2301
2463
|
# If you don't specify the `DelaySeconds` parameter for an entry,
|
2302
2464
|
# Amazon SQS uses the default value for the queue.
|
@@ -2375,13 +2537,14 @@ module Aws::SQS
|
|
2375
2537
|
req.send_request(options)
|
2376
2538
|
end
|
2377
2539
|
|
2378
|
-
# Sets the value of one or more queue attributes
|
2379
|
-
# queue's attributes, the change can take up to 60 seconds
|
2380
|
-
# the attributes to propagate throughout the Amazon SQS
|
2381
|
-
# made to the `MessageRetentionPeriod` attribute can
|
2382
|
-
# minutes and will impact existing messages in the queue
|
2383
|
-
# causing them to be expired and deleted if the
|
2384
|
-
# is reduced below the age of existing
|
2540
|
+
# Sets the value of one or more queue attributes, like a policy. When
|
2541
|
+
# you change a queue's attributes, the change can take up to 60 seconds
|
2542
|
+
# for most of the attributes to propagate throughout the Amazon SQS
|
2543
|
+
# system. Changes made to the `MessageRetentionPeriod` attribute can
|
2544
|
+
# take up to 15 minutes and will impact existing messages in the queue
|
2545
|
+
# potentially causing them to be expired and deleted if the
|
2546
|
+
# `MessageRetentionPeriod` is reduced below the age of existing
|
2547
|
+
# messages.
|
2385
2548
|
#
|
2386
2549
|
# <note markdown="1"> * In the future, new attributes might be added. If you write code that
|
2387
2550
|
# calls this action, we recommend that you structure your code so that
|
@@ -2461,7 +2624,6 @@ module Aws::SQS
|
|
2461
2624
|
# Default: 10. When the `ReceiveCount` for a message exceeds the
|
2462
2625
|
# `maxReceiveCount` for a queue, Amazon SQS moves the message to the
|
2463
2626
|
# dead-letter-queue.
|
2464
|
-
#
|
2465
2627
|
# * `RedriveAllowPolicy` – The string that includes the parameters for
|
2466
2628
|
# the permissions for the dead-letter queue redrive permission and
|
2467
2629
|
# which source queues can specify dead-letter queues as a JSON object.
|
@@ -2480,7 +2642,6 @@ module Aws::SQS
|
|
2480
2642
|
#
|
2481
2643
|
# * `byQueue` – Only queues specified by the `sourceQueueArns`
|
2482
2644
|
# parameter can specify this queue as the dead-letter queue.
|
2483
|
-
#
|
2484
2645
|
# * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
|
2485
2646
|
# queues that can specify this queue as the dead-letter queue and
|
2486
2647
|
# redrive messages. You can specify this parameter only when the
|
@@ -2540,7 +2701,6 @@ module Aws::SQS
|
|
2540
2701
|
#
|
2541
2702
|
# * If the queue has `ContentBasedDeduplication` set, your
|
2542
2703
|
# `MessageDeduplicationId` overrides the generated one.
|
2543
|
-
#
|
2544
2704
|
# * When `ContentBasedDeduplication` is in effect, messages with
|
2545
2705
|
# identical content sent within the deduplication interval are
|
2546
2706
|
# treated as duplicates and only one copy of the message is
|
@@ -2629,9 +2789,6 @@ module Aws::SQS
|
|
2629
2789
|
# original source queue (from which the messages were driven to the
|
2630
2790
|
# dead-letter-queue), or a custom destination queue.
|
2631
2791
|
#
|
2632
|
-
# * Currently, only standard queues support redrive. FIFO queues don't
|
2633
|
-
# support redrive.
|
2634
|
-
#
|
2635
2792
|
# * Only one active message movement task is supported per queue at any
|
2636
2793
|
# given time.
|
2637
2794
|
#
|
@@ -2789,14 +2946,19 @@ module Aws::SQS
|
|
2789
2946
|
# @api private
|
2790
2947
|
def build_request(operation_name, params = {})
|
2791
2948
|
handlers = @handlers.for(operation_name)
|
2949
|
+
tracer = config.telemetry_provider.tracer_provider.tracer(
|
2950
|
+
Aws::Telemetry.module_to_tracer_name('Aws::SQS')
|
2951
|
+
)
|
2792
2952
|
context = Seahorse::Client::RequestContext.new(
|
2793
2953
|
operation_name: operation_name,
|
2794
2954
|
operation: config.api.operation(operation_name),
|
2795
2955
|
client: self,
|
2796
2956
|
params: params,
|
2797
|
-
config: config
|
2957
|
+
config: config,
|
2958
|
+
tracer: tracer
|
2959
|
+
)
|
2798
2960
|
context[:gem_name] = 'aws-sdk-sqs'
|
2799
|
-
context[:gem_version] = '1.
|
2961
|
+
context[:gem_version] = '1.93.0'
|
2800
2962
|
Seahorse::Client::Request.new(handlers, context)
|
2801
2963
|
end
|
2802
2964
|
|