aws-sdk-sqs 1.39.0 → 1.40.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.
@@ -43,7 +43,7 @@ module Aws::SQS
43
43
  end
44
44
 
45
45
  # A unique identifier for the message. A `MessageId`is considered unique
46
- # across all AWS accounts for an extended period of time.
46
+ # across all accounts for an extended period of time.
47
47
  # @return [String]
48
48
  def message_id
49
49
  data[:message_id]
@@ -104,8 +104,8 @@ module Aws::SQS
104
104
  end
105
105
 
106
106
  # Each message attribute consists of a `Name`, `Type`, and `Value`. For
107
- # more information, see [Amazon SQS Message Attributes][1] in the
108
- # *Amazon Simple Queue Service Developer Guide*.
107
+ # more information, see [Amazon SQS message attributes][1] in the
108
+ # *Amazon SQS Developer Guide*.
109
109
  #
110
110
  #
111
111
  #
@@ -94,11 +94,10 @@ module Aws::SQS
94
94
  # characters include alphanumeric characters, hyphens (`-`), and
95
95
  # underscores (`_`).
96
96
  # @option options [required, Array<String>] :aws_account_ids
97
- # The AWS account number of the [principal][1] who is given permission.
98
- # The principal must have an AWS account, but does not need to be signed
99
- # up for Amazon SQS. For information about locating the AWS account
100
- # identification, see [Your AWS Identifiers][2] in the *Amazon Simple
101
- # Queue Service Developer Guide*.
97
+ # The account numbers of the [principals][1] who are to receive
98
+ # permission. For information about locating the account identification,
99
+ # see [Your Amazon Web Services Identifiers][2] in the *Amazon SQS
100
+ # Developer Guide*.
102
101
  #
103
102
  #
104
103
  #
@@ -110,7 +109,7 @@ module Aws::SQS
110
109
  #
111
110
  # For more information about these actions, see [Overview of Managing
112
111
  # Access Permissions to Your Amazon Simple Queue Service Resource][1] in
113
- # the *Amazon Simple Queue Service Developer Guide*.
112
+ # the *Amazon SQS Developer Guide*.
114
113
  #
115
114
  # Specifying `SendMessage`, `DeleteMessage`, or
116
115
  # `ChangeMessageVisibility` for `ActionName.n` also grants permissions
@@ -215,7 +214,7 @@ module Aws::SQS
215
214
  # * `ApproximateReceiveCount` – Returns the number of times a message
216
215
  # has been received across all queues but not deleted.
217
216
  #
218
- # * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
217
+ # * `AWSTraceHeader` – Returns the X-Ray trace header string.
219
218
  #
220
219
  # * `SenderId`
221
220
  #
@@ -314,7 +313,7 @@ module Aws::SQS
314
313
  # `ReceiveRequestAttemptId` return the same messages and receipt
315
314
  # handles. If a retry occurs within the deduplication interval, it
316
315
  # resets the visibility timeout. For more information, see [Visibility
317
- # Timeout][1] in the *Amazon Simple Queue Service Developer Guide*.
316
+ # Timeout][1] in the *Amazon SQS Developer Guide*.
318
317
  #
319
318
  # If a caller of the `ReceiveMessage` action still processes messages
320
319
  # when the visibility timeout expires and messages become visible,
@@ -343,8 +342,8 @@ module Aws::SQS
343
342
  # ``).
344
343
  #
345
344
  # For best practices of using `ReceiveRequestAttemptId`, see [Using the
346
- # ReceiveRequestAttemptId Request Parameter][2] in the *Amazon Simple
347
- # Queue Service Developer Guide*.
345
+ # ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
346
+ # Developer Guide*.
348
347
  #
349
348
  #
350
349
  #
@@ -438,8 +437,8 @@ module Aws::SQS
438
437
  # </note>
439
438
  # @option options [Hash<String,Types::MessageAttributeValue>] :message_attributes
440
439
  # Each message attribute consists of a `Name`, `Type`, and `Value`. For
441
- # more information, see [Amazon SQS Message Attributes][1] in the
442
- # *Amazon Simple Queue Service Developer Guide*.
440
+ # more information, see [Amazon SQS message attributes][1] in the
441
+ # *Amazon SQS Developer Guide*.
443
442
  #
444
443
  #
445
444
  #
@@ -450,7 +449,7 @@ module Aws::SQS
450
449
  #
451
450
  # * Currently, the only supported message system attribute is
452
451
  # `AWSTraceHeader`. Its type must be `String` and its value must be a
453
- # correctly formatted AWS X-Ray trace header string.
452
+ # correctly formatted X-Ray trace header string.
454
453
  #
455
454
  # * The size of a message system attribute doesn't count towards the
456
455
  # total size of a message.
@@ -461,8 +460,8 @@ module Aws::SQS
461
460
  # particular `MessageDeduplicationId` is sent successfully, any messages
462
461
  # sent with the same `MessageDeduplicationId` are accepted successfully
463
462
  # but aren't delivered during the 5-minute deduplication interval. For
464
- # more information, see [ Exactly-once processing][1] in the *Amazon
465
- # Simple Queue Service Developer Guide*.
463
+ # more information, see [ Exactly-once processing][1] in the *Amazon SQS
464
+ # Developer Guide*.
466
465
  #
467
466
  # * Every message must have a unique `MessageDeduplicationId`,
468
467
  #
@@ -508,8 +507,8 @@ module Aws::SQS
508
507
  # ``).
509
508
  #
510
509
  # For best practices of using `MessageDeduplicationId`, see [Using the
511
- # MessageDeduplicationId Property][2] in the *Amazon Simple Queue
512
- # Service Developer Guide*.
510
+ # MessageDeduplicationId Property][2] in the *Amazon SQS Developer
511
+ # Guide*.
513
512
  #
514
513
  #
515
514
  #
@@ -539,8 +538,7 @@ module Aws::SQS
539
538
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
540
539
  #
541
540
  # For best practices of using `MessageGroupId`, see [Using the
542
- # MessageGroupId Property][1] in the *Amazon Simple Queue Service
543
- # Developer Guide*.
541
+ # MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
544
542
  #
545
543
  # `MessageGroupId` is required for FIFO queues. You can't use it for
546
544
  # Standard queues.
@@ -624,9 +622,10 @@ module Aws::SQS
624
622
  # seconds, from 60 (1 minute) to 1,209,600 (14 days). Default: 345,600
625
623
  # (4 days).
626
624
  #
627
- # * `Policy` – The queue's policy. A valid AWS policy. For more
628
- # information about policy structure, see [Overview of AWS IAM
629
- # Policies][1] in the *Amazon IAM User Guide*.
625
+ # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
626
+ # For more information about policy structure, see [Overview of Amazon
627
+ # Web Services IAM Policies][1] in the *Identity and Access Management
628
+ # User Guide*.
630
629
  #
631
630
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
632
631
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
@@ -636,7 +635,7 @@ module Aws::SQS
636
635
  # dead-letter queue functionality of the source queue as a JSON
637
636
  # object. For more information about the redrive policy and
638
637
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
639
- # the *Amazon Simple Queue Service Developer Guide*.
638
+ # the *Amazon SQS Developer Guide*.
640
639
  #
641
640
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
642
641
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -656,33 +655,32 @@ module Aws::SQS
656
655
  # * `VisibilityTimeout` – The visibility timeout for the queue, in
657
656
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
658
657
  # Default: 30. For more information about the visibility timeout, see
659
- # [Visibility Timeout][3] in the *Amazon Simple Queue Service
660
- # Developer Guide*.
658
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
661
659
  #
662
660
  # The following attributes apply only to [server-side-encryption][4]\:
663
661
  #
664
- # * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
665
- # (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
666
- # Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
667
- # always `alias/aws/sqs`, the alias of a custom CMK can, for example,
668
- # be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
669
- # Key Management Service API Reference*.
662
+ # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
663
+ # master key (CMK) for Amazon SQS or a custom CMK. For more
664
+ # information, see [Key Terms][5]. While the alias of the AWS-managed
665
+ # CMK for Amazon SQS is always `alias/aws/sqs`, the alias of a custom
666
+ # CMK can, for example, be `alias/MyAlias `. For more examples, see
667
+ # [KeyId][6] in the *Key Management Service API Reference*.
670
668
  #
671
669
  # * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
672
670
  # which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
673
- # messages before calling AWS KMS again. An integer representing
674
- # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
675
- # hours). Default: 300 (5 minutes). A shorter time period provides
676
- # better security but results in more calls to KMS which might incur
677
- # charges after Free Tier. For more information, see [How Does the
678
- # Data Key Reuse Period Work?][8].
671
+ # messages before calling KMS again. An integer representing seconds,
672
+ # between 60 seconds (1 minute) and 86,400 seconds (24 hours).
673
+ # Default: 300 (5 minutes). A shorter time period provides better
674
+ # security but results in more calls to KMS which might incur charges
675
+ # after Free Tier. For more information, see [How Does the Data Key
676
+ # Reuse Period Work?][8].
679
677
  #
680
678
  # The following attribute applies only to [FIFO (first-in-first-out)
681
679
  # queues][9]\:
682
680
  #
683
681
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
684
682
  # For more information, see [Exactly-once processing][10] in the
685
- # *Amazon Simple Queue Service Developer Guide*. Note the following:
683
+ # *Amazon SQS Developer Guide*. Note the following:
686
684
  #
687
685
  # * Every message must have a unique `MessageDeduplicationId`.
688
686
  #
@@ -736,7 +734,7 @@ module Aws::SQS
736
734
  # deduplication occurs as specified.
737
735
  #
738
736
  # For information on throughput quotas, see [Quotas related to
739
- # messages][12] in the *Amazon Simple Queue Service Developer Guide*.
737
+ # messages][12] in the *Amazon SQS Developer Guide*.
740
738
  #
741
739
  #
742
740
  #
@@ -78,9 +78,9 @@ module Aws::SQS
78
78
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
79
79
  # (4 days).
80
80
  #
81
- # * `Policy` – The queue's policy. A valid AWS policy. For more
82
- # information about policy structure, see [Overview of AWS IAM
83
- # Policies][1] in the *Amazon IAM User Guide*.
81
+ # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
82
+ # For more information about policy structure, see [Overview of Amazon
83
+ # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
84
84
  #
85
85
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
86
86
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
@@ -90,7 +90,7 @@ module Aws::SQS
90
90
  # dead-letter queue functionality of the source queue as a JSON
91
91
  # object. For more information about the redrive policy and
92
92
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
93
- # the *Amazon Simple Queue Service Developer Guide*.
93
+ # the *Amazon SQS Developer Guide*.
94
94
  #
95
95
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
96
96
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -110,26 +110,26 @@ module Aws::SQS
110
110
  # * `VisibilityTimeout` – The visibility timeout for the queue, in
111
111
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
112
112
  # Default: 30. For more information about the visibility timeout, see
113
- # [Visibility Timeout][3] in the *Amazon Simple Queue Service
114
- # Developer Guide*.
113
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
115
114
  #
116
115
  # The following attributes apply only to [server-side-encryption][4]\:
117
116
  #
118
- # * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
119
- # (CMK) for Amazon SQS or a custom CMK. For more information, see [Key
120
- # Terms][5]. While the alias of the AWS-managed CMK for Amazon SQS is
121
- # always `alias/aws/sqs`, the alias of a custom CMK can, for example,
122
- # be `alias/MyAlias `. For more examples, see [KeyId][6] in the *AWS
123
- # Key Management Service API Reference*.
117
+ # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
118
+ # master key (CMK) for Amazon SQS or a custom CMK. For more
119
+ # information, see [Key Terms][5]. While the alias of the Amazon Web
120
+ # Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
121
+ # alias of a custom CMK can, for example, be `alias/MyAlias `. For
122
+ # more examples, see [KeyId][6] in the *Key Management Service API
123
+ # Reference*.
124
124
  #
125
125
  # * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds, for
126
126
  # which Amazon SQS can reuse a [data key][7] to encrypt or decrypt
127
- # messages before calling AWS KMS again. An integer representing
128
- # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
129
- # hours). Default: 300 (5 minutes). A shorter time period provides
130
- # better security but results in more calls to KMS which might incur
131
- # charges after Free Tier. For more information, see [How Does the
132
- # Data Key Reuse Period Work?][8].
127
+ # messages before calling KMS again. An integer representing seconds,
128
+ # between 60 seconds (1 minute) and 86,400 seconds (24 hours).
129
+ # Default: 300 (5 minutes). A shorter time period provides better
130
+ # security but results in more calls to KMS which might incur charges
131
+ # after Free Tier. For more information, see [How Does the Data Key
132
+ # Reuse Period Work?][8].
133
133
  #
134
134
  # The following attributes apply only to [FIFO (first-in-first-out)
135
135
  # queues][9]\:
@@ -141,13 +141,13 @@ module Aws::SQS
141
141
  # When you set this attribute, you must also provide the
142
142
  # `MessageGroupId` for your messages explicitly.
143
143
  #
144
- # For more information, see [FIFO queue logic][10] in the *Amazon
145
- # Simple Queue Service Developer Guide*.
144
+ # For more information, see [FIFO queue logic][10] in the *Amazon SQS
145
+ # Developer Guide*.
146
146
  #
147
147
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
148
148
  # Valid values are `true` and `false`. For more information, see
149
- # [Exactly-once processing][11] in the *Amazon Simple Queue Service
150
- # Developer Guide*. Note the following:
149
+ # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
150
+ # Note the following:
151
151
  #
152
152
  # * Every message must have a unique `MessageDeduplicationId`.
153
153
  #
@@ -201,7 +201,7 @@ module Aws::SQS
201
201
  # deduplication occurs as specified.
202
202
  #
203
203
  # For information on throughput quotas, see [Quotas related to
204
- # messages][13] in the *Amazon Simple Queue Service Developer Guide*.
204
+ # messages][13] in the *Amazon SQS Developer Guide*.
205
205
  #
206
206
  #
207
207
  #
@@ -220,8 +220,8 @@ module Aws::SQS
220
220
  # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
221
221
  # @option options [Hash<String,String>] :tags
222
222
  # Add cost allocation tags to the specified Amazon SQS queue. For an
223
- # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
224
- # Simple Queue Service Developer Guide*.
223
+ # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
224
+ # Developer Guide*.
225
225
  #
226
226
  # When you use queue tags, keep the following guidelines in mind:
227
227
  #
@@ -235,15 +235,15 @@ module Aws::SQS
235
235
  # * A new tag with a key identical to that of an existing tag overwrites
236
236
  # the existing tag.
237
237
  #
238
- # For a full list of tag restrictions, see [Limits Related to Queues][2]
239
- # in the *Amazon Simple Queue Service Developer Guide*.
238
+ # For a full list of tag restrictions, see [Quotas related to queues][2]
239
+ # in the *Amazon SQS Developer Guide*.
240
240
  #
241
241
  # <note markdown="1"> To be able to tag a queue on creation, you must have the
242
242
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
243
243
  #
244
244
  # Cross-account permissions don't apply to this action. For more
245
245
  # information, see [Grant cross-account permissions to a role and a user
246
- # name][3] in the *Amazon Simple Queue Service Developer Guide*.
246
+ # name][3] in the *Amazon SQS Developer Guide*.
247
247
  #
248
248
  # </note>
249
249
  #
@@ -275,7 +275,7 @@ module Aws::SQS
275
275
  #
276
276
  # Queue URLs and names are case-sensitive.
277
277
  # @option options [String] :queue_owner_aws_account_id
278
- # The AWS account ID of the account that created the queue.
278
+ # The account ID of the account that created the queue.
279
279
  # @return [Queue]
280
280
  def get_queue_by_name(options = {})
281
281
  resp = @client.get_queue_url(options)
@@ -34,11 +34,10 @@ module Aws::SQS
34
34
  # @return [String]
35
35
  #
36
36
  # @!attribute [rw] aws_account_ids
37
- # The AWS account number of the [principal][1] who is given
38
- # permission. The principal must have an AWS account, but does not
39
- # need to be signed up for Amazon SQS. For information about locating
40
- # the AWS account identification, see [Your AWS Identifiers][2] in the
41
- # *Amazon Simple Queue Service Developer Guide*.
37
+ # The account numbers of the [principals][1] who are to receive
38
+ # permission. For information about locating the account
39
+ # identification, see [Your Amazon Web Services Identifiers][2] in the
40
+ # *Amazon SQS Developer Guide*.
42
41
  #
43
42
  #
44
43
  #
@@ -52,7 +51,7 @@ module Aws::SQS
52
51
  #
53
52
  # For more information about these actions, see [Overview of Managing
54
53
  # Access Permissions to Your Amazon Simple Queue Service Resource][1]
55
- # in the *Amazon Simple Queue Service Developer Guide*.
54
+ # in the *Amazon SQS Developer Guide*.
56
55
  #
57
56
  # Specifying `SendMessage`, `DeleteMessage`, or
58
57
  # `ChangeMessageVisibility` for `ActionName.n` also grants permissions
@@ -327,9 +326,10 @@ module Aws::SQS
327
326
  # 60 seconds (1 minute) to 1,209,600 seconds (14 days). Default:
328
327
  # 345,600 (4 days).
329
328
  #
330
- # * `Policy` – The queue's policy. A valid AWS policy. For more
331
- # information about policy structure, see [Overview of AWS IAM
332
- # Policies][1] in the *Amazon IAM User Guide*.
329
+ # * `Policy` – The queue's policy. A valid Amazon Web Services
330
+ # policy. For more information about policy structure, see [Overview
331
+ # of Amazon Web Services IAM Policies][1] in the *Amazon IAM User
332
+ # Guide*.
333
333
  #
334
334
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
335
335
  # for which a ` ReceiveMessage ` action waits for a message to
@@ -340,7 +340,7 @@ module Aws::SQS
340
340
  # dead-letter queue functionality of the source queue as a JSON
341
341
  # object. For more information about the redrive policy and
342
342
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
343
- # in the *Amazon Simple Queue Service Developer Guide*.
343
+ # in the *Amazon SQS Developer Guide*.
344
344
  #
345
345
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
346
346
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -361,26 +361,26 @@ module Aws::SQS
361
361
  # * `VisibilityTimeout` – The visibility timeout for the queue, in
362
362
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
363
363
  # Default: 30. For more information about the visibility timeout,
364
- # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
365
- # Developer Guide*.
364
+ # see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
366
365
  #
367
366
  # The following attributes apply only to [server-side-encryption][4]\:
368
367
  #
369
- # * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
370
- # (CMK) for Amazon SQS or a custom CMK. For more information, see
371
- # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
372
- # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
373
- # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
374
- # the *AWS Key Management Service API Reference*.
368
+ # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
369
+ # customer master key (CMK) for Amazon SQS or a custom CMK. For more
370
+ # information, see [Key Terms][5]. While the alias of the Amazon Web
371
+ # Services managed CMK for Amazon SQS is always `alias/aws/sqs`, the
372
+ # alias of a custom CMK can, for example, be `alias/MyAlias `. For
373
+ # more examples, see [KeyId][6] in the *Key Management Service API
374
+ # Reference*.
375
375
  #
376
376
  # * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
377
377
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
378
- # decrypt messages before calling AWS KMS again. An integer
379
- # representing seconds, between 60 seconds (1 minute) and 86,400
380
- # seconds (24 hours). Default: 300 (5 minutes). A shorter time
381
- # period provides better security but results in more calls to KMS
382
- # which might incur charges after Free Tier. For more information,
383
- # see [How Does the Data Key Reuse Period Work?][8].
378
+ # decrypt messages before calling KMS again. An integer representing
379
+ # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
380
+ # hours). Default: 300 (5 minutes). A shorter time period provides
381
+ # better security but results in more calls to KMS which might incur
382
+ # charges after Free Tier. For more information, see [How Does the
383
+ # Data Key Reuse Period Work?][8].
384
384
  #
385
385
  # The following attributes apply only to [FIFO (first-in-first-out)
386
386
  # queues][9]\:
@@ -393,12 +393,12 @@ module Aws::SQS
393
393
  # the `MessageGroupId` for your messages explicitly.
394
394
  #
395
395
  # For more information, see [FIFO queue logic][10] in the *Amazon
396
- # Simple Queue Service Developer Guide*.
396
+ # SQS Developer Guide*.
397
397
  #
398
398
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
399
399
  # Valid values are `true` and `false`. For more information, see
400
- # [Exactly-once processing][11] in the *Amazon Simple Queue Service
401
- # Developer Guide*. Note the following:
400
+ # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
401
+ # Note the following:
402
402
  #
403
403
  # * Every message must have a unique `MessageDeduplicationId`.
404
404
  #
@@ -452,7 +452,7 @@ module Aws::SQS
452
452
  # deduplication occurs as specified.
453
453
  #
454
454
  # For information on throughput quotas, see [Quotas related to
455
- # messages][13] in the *Amazon Simple Queue Service Developer Guide*.
455
+ # messages][13] in the *Amazon SQS Developer Guide*.
456
456
  #
457
457
  #
458
458
  #
@@ -473,8 +473,8 @@ module Aws::SQS
473
473
  #
474
474
  # @!attribute [rw] tags
475
475
  # Add cost allocation tags to the specified Amazon SQS queue. For an
476
- # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
477
- # Simple Queue Service Developer Guide*.
476
+ # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
477
+ # Developer Guide*.
478
478
  #
479
479
  # When you use queue tags, keep the following guidelines in mind:
480
480
  #
@@ -488,15 +488,15 @@ module Aws::SQS
488
488
  # * A new tag with a key identical to that of an existing tag
489
489
  # overwrites the existing tag.
490
490
  #
491
- # For a full list of tag restrictions, see [Limits Related to
492
- # Queues][2] in the *Amazon Simple Queue Service Developer Guide*.
491
+ # For a full list of tag restrictions, see [Quotas related to
492
+ # queues][2] in the *Amazon SQS Developer Guide*.
493
493
  #
494
494
  # <note markdown="1"> To be able to tag a queue on creation, you must have the
495
495
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
496
496
  #
497
497
  # Cross-account permissions don't apply to this action. For more
498
498
  # information, see [Grant cross-account permissions to a role and a
499
- # user name][3] in the *Amazon Simple Queue Service Developer Guide*.
499
+ # user name][3] in the *Amazon SQS Developer Guide*.
500
500
  #
501
501
  # </note>
502
502
  #
@@ -706,6 +706,10 @@ module Aws::SQS
706
706
  # @!attribute [rw] attribute_names
707
707
  # A list of attributes for which to retrieve information.
708
708
  #
709
+ # The `AttributeName.N` parameter is optional, but if you don't
710
+ # specify values for this parameter, the request returns empty
711
+ # results.
712
+ #
709
713
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
710
714
  # calls this action, we recommend that you structure your code so that
711
715
  # it can handle new attributes gracefully.
@@ -765,7 +769,7 @@ module Aws::SQS
765
769
  # dead-letter queue functionality of the source queue as a JSON
766
770
  # object. For more information about the redrive policy and
767
771
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
768
- # in the *Amazon Simple Queue Service Developer Guide*.
772
+ # in the *Amazon SQS Developer Guide*.
769
773
  #
770
774
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
771
775
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -779,26 +783,25 @@ module Aws::SQS
779
783
  #
780
784
  # * `VisibilityTimeout` – Returns the visibility timeout for the
781
785
  # queue. For more information about the visibility timeout, see
782
- # [Visibility Timeout][3] in the *Amazon Simple Queue Service
783
- # Developer Guide*.
786
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
784
787
  #
785
788
  # The following attributes apply only to [server-side-encryption][4]\:
786
789
  #
787
- # * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
788
- # master key (CMK) for Amazon SQS or a custom CMK. For more
789
- # information, see [Key Terms][5].
790
+ # * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
791
+ # managed customer master key (CMK) for Amazon SQS or a custom CMK.
792
+ # For more information, see [Key Terms][5].
790
793
  #
791
794
  # * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
792
795
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
793
- # decrypt messages before calling AWS KMS again. For more
794
- # information, see [How Does the Data Key Reuse Period Work?][6].
796
+ # decrypt messages before calling KMS again. For more information,
797
+ # see [How Does the Data Key Reuse Period Work?][6].
795
798
  #
796
799
  # The following attributes apply only to [FIFO (first-in-first-out)
797
800
  # queues][7]\:
798
801
  #
799
802
  # * `FifoQueue` – Returns information about whether the queue is FIFO.
800
- # For more information, see [FIFO queue logic][8] in the *Amazon
801
- # Simple Queue Service Developer Guide*.
803
+ # For more information, see [FIFO queue logic][8] in the *Amazon SQS
804
+ # Developer Guide*.
802
805
  #
803
806
  # <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
804
807
  # `QueueName` ends with the `.fifo` suffix.
@@ -807,8 +810,7 @@ module Aws::SQS
807
810
  #
808
811
  # * `ContentBasedDeduplication` – Returns whether content-based
809
812
  # deduplication is enabled for the queue. For more information, see
810
- # [Exactly-once processing][9] in the *Amazon Simple Queue Service
811
- # Developer Guide*.
813
+ # [Exactly-once processing][9] in the *Amazon SQS Developer Guide*.
812
814
  #
813
815
  # The following attributes apply only to [high throughput for FIFO
814
816
  # queues][10]\:
@@ -834,7 +836,7 @@ module Aws::SQS
834
836
  # deduplication occurs as specified.
835
837
  #
836
838
  # For information on throughput quotas, see [Quotas related to
837
- # messages][11] in the *Amazon Simple Queue Service Developer Guide*.
839
+ # messages][11] in the *Amazon SQS Developer Guide*.
838
840
  #
839
841
  #
840
842
  #
@@ -891,7 +893,7 @@ module Aws::SQS
891
893
  # @return [String]
892
894
  #
893
895
  # @!attribute [rw] queue_owner_aws_account_id
894
- # The AWS account ID of the account that created the queue.
896
+ # The account ID of the account that created the queue.
895
897
  # @return [String]
896
898
  #
897
899
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
@@ -904,7 +906,7 @@ module Aws::SQS
904
906
  end
905
907
 
906
908
  # For more information, see [Interpreting Responses][1] in the *Amazon
907
- # Simple Queue Service Developer Guide*.
909
+ # SQS Developer Guide*.
908
910
  #
909
911
  #
910
912
  #
@@ -1097,7 +1099,7 @@ module Aws::SQS
1097
1099
  #
1098
1100
  # @!attribute [rw] message_id
1099
1101
  # A unique identifier for the message. A `MessageId`is considered
1100
- # unique across all AWS accounts for an extended period of time.
1102
+ # unique across all accounts for an extended period of time.
1101
1103
  # @return [String]
1102
1104
  #
1103
1105
  # @!attribute [rw] receipt_handle
@@ -1156,8 +1158,8 @@ module Aws::SQS
1156
1158
  #
1157
1159
  # @!attribute [rw] message_attributes
1158
1160
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1159
- # For more information, see [Amazon SQS Message Attributes][1] in the
1160
- # *Amazon Simple Queue Service Developer Guide*.
1161
+ # For more information, see [Amazon SQS message attributes][1] in the
1162
+ # *Amazon SQS Developer Guide*.
1161
1163
  #
1162
1164
  #
1163
1165
  #
@@ -1226,8 +1228,7 @@ module Aws::SQS
1226
1228
  # `StringValue`.
1227
1229
  #
1228
1230
  # You can also append custom labels. For more information, see [Amazon
1229
- # SQS Message Attributes][1] in the *Amazon Simple Queue Service
1230
- # Developer Guide*.
1231
+ # SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
1231
1232
  #
1232
1233
  #
1233
1234
  #
@@ -1298,8 +1299,7 @@ module Aws::SQS
1298
1299
  # `StringValue`.
1299
1300
  #
1300
1301
  # You can also append custom labels. For more information, see [Amazon
1301
- # SQS Message Attributes][1] in the *Amazon Simple Queue Service
1302
- # Developer Guide*.
1302
+ # SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
1303
1303
  #
1304
1304
  #
1305
1305
  #
@@ -1416,7 +1416,7 @@ module Aws::SQS
1416
1416
  # * `ApproximateReceiveCount` – Returns the number of times a message
1417
1417
  # has been received across all queues but not deleted.
1418
1418
  #
1419
- # * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
1419
+ # * `AWSTraceHeader` – Returns the X-Ray trace header string.
1420
1420
  #
1421
1421
  # * `SenderId`
1422
1422
  #
@@ -1526,8 +1526,7 @@ module Aws::SQS
1526
1526
  # `ReceiveRequestAttemptId` return the same messages and receipt
1527
1527
  # handles. If a retry occurs within the deduplication interval, it
1528
1528
  # resets the visibility timeout. For more information, see
1529
- # [Visibility Timeout][1] in the *Amazon Simple Queue Service
1530
- # Developer Guide*.
1529
+ # [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
1531
1530
  #
1532
1531
  # If a caller of the `ReceiveMessage` action still processes
1533
1532
  # messages when the visibility timeout expires and messages become
@@ -1558,8 +1557,8 @@ module Aws::SQS
1558
1557
  # !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
1559
1558
  #
1560
1559
  # For best practices of using `ReceiveRequestAttemptId`, see [Using
1561
- # the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
1562
- # Simple Queue Service Developer Guide*.
1560
+ # the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
1561
+ # Developer Guide*.
1563
1562
  #
1564
1563
  #
1565
1564
  #
@@ -1740,8 +1739,8 @@ module Aws::SQS
1740
1739
  #
1741
1740
  # @!attribute [rw] message_attributes
1742
1741
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1743
- # For more information, see [Amazon SQS Message Attributes][1] in the
1744
- # *Amazon Simple Queue Service Developer Guide*.
1742
+ # For more information, see [Amazon SQS message attributes][1] in the
1743
+ # *Amazon SQS Developer Guide*.
1745
1744
  #
1746
1745
  #
1747
1746
  #
@@ -1754,7 +1753,7 @@ module Aws::SQS
1754
1753
  #
1755
1754
  # * Currently, the only supported message system attribute is
1756
1755
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1757
- # a correctly formatted AWS X-Ray trace header string.
1756
+ # a correctly formatted X-Ray trace header string.
1758
1757
  #
1759
1758
  # * The size of a message system attribute doesn't count towards the
1760
1759
  # total size of a message.
@@ -1768,7 +1767,7 @@ module Aws::SQS
1768
1767
  # `MessageDeduplicationId` is sent successfully, subsequent messages
1769
1768
  # with the same `MessageDeduplicationId` are accepted successfully but
1770
1769
  # aren't delivered. For more information, see [ Exactly-once
1771
- # processing][1] in the *Amazon Simple Queue Service Developer Guide*.
1770
+ # processing][1] in the *Amazon SQS Developer Guide*.
1772
1771
  #
1773
1772
  # * Every message must have a unique `MessageDeduplicationId`,
1774
1773
  #
@@ -1817,8 +1816,8 @@ module Aws::SQS
1817
1816
  # ``).
1818
1817
  #
1819
1818
  # For best practices of using `MessageDeduplicationId`, see [Using the
1820
- # MessageDeduplicationId Property][2] in the *Amazon Simple Queue
1821
- # Service Developer Guide*.
1819
+ # MessageDeduplicationId Property][2] in the *Amazon SQS Developer
1820
+ # Guide*.
1822
1821
  #
1823
1822
  #
1824
1823
  #
@@ -1851,8 +1850,7 @@ module Aws::SQS
1851
1850
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
1852
1851
  #
1853
1852
  # For best practices of using `MessageGroupId`, see [Using the
1854
- # MessageGroupId Property][1] in the *Amazon Simple Queue Service
1855
- # Developer Guide*.
1853
+ # MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
1856
1854
  #
1857
1855
  # `MessageGroupId` is required for FIFO queues. You can't use it for
1858
1856
  # Standard queues.
@@ -2035,8 +2033,8 @@ module Aws::SQS
2035
2033
  #
2036
2034
  # @!attribute [rw] message_attributes
2037
2035
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
2038
- # For more information, see [Amazon SQS Message Attributes][1] in the
2039
- # *Amazon Simple Queue Service Developer Guide*.
2036
+ # For more information, see [Amazon SQS message attributes][1] in the
2037
+ # *Amazon SQS Developer Guide*.
2040
2038
  #
2041
2039
  #
2042
2040
  #
@@ -2049,7 +2047,7 @@ module Aws::SQS
2049
2047
  #
2050
2048
  # * Currently, the only supported message system attribute is
2051
2049
  # `AWSTraceHeader`. Its type must be `String` and its value must be
2052
- # a correctly formatted AWS X-Ray trace header string.
2050
+ # a correctly formatted X-Ray trace header string.
2053
2051
  #
2054
2052
  # * The size of a message system attribute doesn't count towards the
2055
2053
  # total size of a message.
@@ -2063,7 +2061,7 @@ module Aws::SQS
2063
2061
  # messages sent with the same `MessageDeduplicationId` are accepted
2064
2062
  # successfully but aren't delivered during the 5-minute deduplication
2065
2063
  # interval. For more information, see [ Exactly-once processing][1] in
2066
- # the *Amazon Simple Queue Service Developer Guide*.
2064
+ # the *Amazon SQS Developer Guide*.
2067
2065
  #
2068
2066
  # * Every message must have a unique `MessageDeduplicationId`,
2069
2067
  #
@@ -2112,8 +2110,8 @@ module Aws::SQS
2112
2110
  # ``).
2113
2111
  #
2114
2112
  # For best practices of using `MessageDeduplicationId`, see [Using the
2115
- # MessageDeduplicationId Property][2] in the *Amazon Simple Queue
2116
- # Service Developer Guide*.
2113
+ # MessageDeduplicationId Property][2] in the *Amazon SQS Developer
2114
+ # Guide*.
2117
2115
  #
2118
2116
  #
2119
2117
  #
@@ -2146,8 +2144,7 @@ module Aws::SQS
2146
2144
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
2147
2145
  #
2148
2146
  # For best practices of using `MessageGroupId`, see [Using the
2149
- # MessageGroupId Property][1] in the *Amazon Simple Queue Service
2150
- # Developer Guide*.
2147
+ # MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
2151
2148
  #
2152
2149
  # `MessageGroupId` is required for FIFO queues. You can't use it for
2153
2150
  # Standard queues.
@@ -2206,7 +2203,7 @@ module Aws::SQS
2206
2203
  # @!attribute [rw] message_id
2207
2204
  # An attribute containing the `MessageId` of the message sent to the
2208
2205
  # queue. For more information, see [Queue and Message Identifiers][1]
2209
- # in the *Amazon Simple Queue Service Developer Guide*.
2206
+ # in the *Amazon SQS Developer Guide*.
2210
2207
  #
2211
2208
  #
2212
2209
  #
@@ -2272,9 +2269,10 @@ module Aws::SQS
2272
2269
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
2273
2270
  # Default: 345,600 (4 days).
2274
2271
  #
2275
- # * `Policy` – The queue's policy. A valid AWS policy. For more
2276
- # information about policy structure, see [Overview of AWS IAM
2277
- # Policies][1] in the *Amazon IAM User Guide*.
2272
+ # * `Policy` – The queue's policy. A valid Amazon Web Services
2273
+ # policy. For more information about policy structure, see [Overview
2274
+ # of Amazon Web Services IAM Policies][1] in the *Identity and
2275
+ # Access Management User Guide*.
2278
2276
  #
2279
2277
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
2280
2278
  # for which a ` ReceiveMessage ` action waits for a message to
@@ -2285,7 +2283,7 @@ module Aws::SQS
2285
2283
  # dead-letter queue functionality of the source queue as a JSON
2286
2284
  # object. For more information about the redrive policy and
2287
2285
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
2288
- # in the *Amazon Simple Queue Service Developer Guide*.
2286
+ # in the *Amazon SQS Developer Guide*.
2289
2287
  #
2290
2288
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2291
2289
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -2306,33 +2304,33 @@ module Aws::SQS
2306
2304
  # * `VisibilityTimeout` – The visibility timeout for the queue, in
2307
2305
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2308
2306
  # Default: 30. For more information about the visibility timeout,
2309
- # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
2310
- # Developer Guide*.
2307
+ # see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
2311
2308
  #
2312
2309
  # The following attributes apply only to [server-side-encryption][4]\:
2313
2310
  #
2314
- # * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
2315
- # (CMK) for Amazon SQS or a custom CMK. For more information, see
2316
- # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
2317
- # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
2318
- # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
2319
- # the *AWS Key Management Service API Reference*.
2311
+ # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
2312
+ # customer master key (CMK) for Amazon SQS or a custom CMK. For more
2313
+ # information, see [Key Terms][5]. While the alias of the
2314
+ # AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the
2315
+ # alias of a custom CMK can, for example, be `alias/MyAlias `. For
2316
+ # more examples, see [KeyId][6] in the *Key Management Service API
2317
+ # Reference*.
2320
2318
  #
2321
2319
  # * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
2322
2320
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
2323
- # decrypt messages before calling AWS KMS again. An integer
2324
- # representing seconds, between 60 seconds (1 minute) and 86,400
2325
- # seconds (24 hours). Default: 300 (5 minutes). A shorter time
2326
- # period provides better security but results in more calls to KMS
2327
- # which might incur charges after Free Tier. For more information,
2328
- # see [How Does the Data Key Reuse Period Work?][8].
2321
+ # decrypt messages before calling KMS again. An integer representing
2322
+ # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
2323
+ # hours). Default: 300 (5 minutes). A shorter time period provides
2324
+ # better security but results in more calls to KMS which might incur
2325
+ # charges after Free Tier. For more information, see [How Does the
2326
+ # Data Key Reuse Period Work?][8].
2329
2327
  #
2330
2328
  # The following attribute applies only to [FIFO (first-in-first-out)
2331
2329
  # queues][9]\:
2332
2330
  #
2333
2331
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
2334
2332
  # For more information, see [Exactly-once processing][10] in the
2335
- # *Amazon Simple Queue Service Developer Guide*. Note the following:
2333
+ # *Amazon SQS Developer Guide*. Note the following:
2336
2334
  #
2337
2335
  # * Every message must have a unique `MessageDeduplicationId`.
2338
2336
  #
@@ -2386,7 +2384,7 @@ module Aws::SQS
2386
2384
  # deduplication occurs as specified.
2387
2385
  #
2388
2386
  # For information on throughput quotas, see [Quotas related to
2389
- # messages][12] in the *Amazon Simple Queue Service Developer Guide*.
2387
+ # messages][12] in the *Amazon SQS Developer Guide*.
2390
2388
  #
2391
2389
  #
2392
2390
  #