aws-sdk-sqs 1.38.0 → 1.51.1

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.
@@ -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 Amazon Web Services account numbers of the [principals][1] who
38
+ # are to receive permission. For information about locating the Amazon
39
+ # Web Services account identification, see [Your Amazon Web Services
40
+ # Identifiers][2] in the *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,29 +361,34 @@ 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
+ #
385
+ # * `SqsManagedSseEnabled` – Enables server-side queue encryption
386
+ # using SQS owned encryption keys. Only one server-side encryption
387
+ # option is supported per queue (e.g. [SSE-KMS][9] or
388
+ # [SSE-SQS][10]).
384
389
  #
385
390
  # The following attributes apply only to [FIFO (first-in-first-out)
386
- # queues][9]\:
391
+ # queues][11]\:
387
392
  #
388
393
  # * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
389
394
  # and `false`. If you don't specify the `FifoQueue` attribute,
@@ -392,13 +397,13 @@ module Aws::SQS
392
397
  # existing queue. When you set this attribute, you must also provide
393
398
  # the `MessageGroupId` for your messages explicitly.
394
399
  #
395
- # For more information, see [FIFO Queue Logic][10] in the *Amazon
396
- # Simple Queue Service Developer Guide*.
400
+ # For more information, see [FIFO queue logic][12] in the *Amazon
401
+ # SQS Developer Guide*.
397
402
  #
398
403
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
399
404
  # 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:
405
+ # [Exactly-once processing][13] in the *Amazon SQS Developer Guide*.
406
+ # Note the following:
402
407
  #
403
408
  # * Every message must have a unique `MessageDeduplicationId`.
404
409
  #
@@ -428,15 +433,8 @@ module Aws::SQS
428
433
  # `MessageDeduplicationId`, the two messages are treated as
429
434
  # duplicates and only one copy of the message is delivered.
430
435
  #
431
- # **Preview: High throughput for FIFO queues**
432
- #
433
- # **High throughput for Amazon SQS FIFO queues is in preview release
434
- # and is subject to change.** This feature provides a high number of
435
- # transactions per second (TPS) for messages in FIFO queues. For
436
- # information on throughput quotas, see [Quotas related to
437
- # messages][12] in the *Amazon Simple Queue Service Developer Guide*.
438
- #
439
- # This preview includes two new attributes:
436
+ # The following attributes apply only to [high throughput for FIFO
437
+ # queues][14]\:
440
438
  #
441
439
  # * `DeduplicationScope` – Specifies whether message deduplication
442
440
  # occurs at the message group or queue level. Valid values are
@@ -455,22 +453,11 @@ module Aws::SQS
455
453
  # * Set `FifoThroughputLimit` to `perMessageGroupId`.
456
454
  #
457
455
  # If you set these attributes to anything other than the values shown
458
- # for enabling high throughput, standard throughput is in effect and
456
+ # for enabling high throughput, normal throughput is in effect and
459
457
  # deduplication occurs as specified.
460
458
  #
461
- # This preview is available in the following AWS Regions:
462
- #
463
- # * US East (Ohio); us-east-2
464
- #
465
- # * US East (N. Virginia); us-east-1
466
- #
467
- # * US West (Oregon); us-west-2
468
- #
469
- # * Europe (Ireland); eu-west-1
470
- #
471
- # For more information about high throughput for FIFO queues, see
472
- # [Preview: High throughput for FIFO queues][13] in the *Amazon Simple
473
- # Queue Service Developer Guide*.
459
+ # For information on throughput quotas, see [Quotas related to
460
+ # messages][15] in the *Amazon SQS Developer Guide*.
474
461
  #
475
462
  #
476
463
  #
@@ -482,17 +469,19 @@ module Aws::SQS
482
469
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
483
470
  # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
484
471
  # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
485
- # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
486
- # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
487
- # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
488
- # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
489
- # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
472
+ # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
473
+ # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
474
+ # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
475
+ # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
476
+ # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
477
+ # [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
478
+ # [15]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
490
479
  # @return [Hash<String,String>]
491
480
  #
492
481
  # @!attribute [rw] tags
493
482
  # Add cost allocation tags to the specified Amazon SQS queue. For an
494
- # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon
495
- # Simple Queue Service Developer Guide*.
483
+ # overview, see [Tagging Your Amazon SQS Queues][1] in the *Amazon SQS
484
+ # Developer Guide*.
496
485
  #
497
486
  # When you use queue tags, keep the following guidelines in mind:
498
487
  #
@@ -506,15 +495,15 @@ module Aws::SQS
506
495
  # * A new tag with a key identical to that of an existing tag
507
496
  # overwrites the existing tag.
508
497
  #
509
- # For a full list of tag restrictions, see [Limits Related to
510
- # Queues][2] in the *Amazon Simple Queue Service Developer Guide*.
498
+ # For a full list of tag restrictions, see [Quotas related to
499
+ # queues][2] in the *Amazon SQS Developer Guide*.
511
500
  #
512
501
  # <note markdown="1"> To be able to tag a queue on creation, you must have the
513
502
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
514
503
  #
515
504
  # Cross-account permissions don't apply to this action. For more
516
505
  # information, see [Grant cross-account permissions to a role and a
517
- # user name][3] in the *Amazon Simple Queue Service Developer Guide*.
506
+ # user name][3] in the *Amazon SQS Developer Guide*.
518
507
  #
519
508
  # </note>
520
509
  #
@@ -711,7 +700,7 @@ module Aws::SQS
711
700
  #
712
701
  # {
713
702
  # queue_url: "String", # required
714
- # attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
703
+ # 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
715
704
  # }
716
705
  #
717
706
  # @!attribute [rw] queue_url
@@ -724,6 +713,10 @@ module Aws::SQS
724
713
  # @!attribute [rw] attribute_names
725
714
  # A list of attributes for which to retrieve information.
726
715
  #
716
+ # The `AttributeName.N` parameter is optional, but if you don't
717
+ # specify values for this parameter, the request returns empty
718
+ # results.
719
+ #
727
720
  # <note markdown="1"> In the future, new attributes might be added. If you write code that
728
721
  # calls this action, we recommend that you structure your code so that
729
722
  # it can handle new attributes gracefully.
@@ -783,7 +776,7 @@ module Aws::SQS
783
776
  # dead-letter queue functionality of the source queue as a JSON
784
777
  # object. For more information about the redrive policy and
785
778
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
786
- # in the *Amazon Simple Queue Service Developer Guide*.
779
+ # in the *Amazon SQS Developer Guide*.
787
780
  #
788
781
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
789
782
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -797,46 +790,42 @@ module Aws::SQS
797
790
  #
798
791
  # * `VisibilityTimeout` – Returns the visibility timeout for the
799
792
  # queue. For more information about the visibility timeout, see
800
- # [Visibility Timeout][3] in the *Amazon Simple Queue Service
801
- # Developer Guide*.
793
+ # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
802
794
  #
803
795
  # The following attributes apply only to [server-side-encryption][4]\:
804
796
  #
805
- # * `KmsMasterKeyId` – Returns the ID of an AWS-managed customer
806
- # master key (CMK) for Amazon SQS or a custom CMK. For more
807
- # information, see [Key Terms][5].
797
+ # * `KmsMasterKeyId` – Returns the ID of an Amazon Web Services
798
+ # managed customer master key (CMK) for Amazon SQS or a custom CMK.
799
+ # For more information, see [Key Terms][5].
808
800
  #
809
801
  # * `KmsDataKeyReusePeriodSeconds` – Returns the length of time, in
810
802
  # seconds, for which Amazon SQS can reuse a data key to encrypt or
811
- # decrypt messages before calling AWS KMS again. For more
812
- # information, see [How Does the Data Key Reuse Period Work?][6].
803
+ # decrypt messages before calling KMS again. For more information,
804
+ # see [How Does the Data Key Reuse Period Work?][6].
805
+ #
806
+ # * `SqsManagedSseEnabled` – Returns information about whether the
807
+ # queue is using SSE-SQS encryption using SQS owned encryption keys.
808
+ # Only one server-side encryption option is supported per queue
809
+ # (e.g. [SSE-KMS][7] or [SSE-SQS][8]).
813
810
  #
814
811
  # The following attributes apply only to [FIFO (first-in-first-out)
815
- # queues][7]\:
812
+ # queues][9]\:
816
813
  #
817
814
  # * `FifoQueue` – Returns information about whether the queue is FIFO.
818
- # For more information, see [FIFO Queue Logic][8] in the *Amazon
819
- # Simple Queue Service Developer Guide*.
815
+ # For more information, see [FIFO queue logic][10] in the *Amazon
816
+ # SQS Developer Guide*.
820
817
  #
821
- # <note markdown="1"> To determine whether a queue is [FIFO][7], you can check whether
818
+ # <note markdown="1"> To determine whether a queue is [FIFO][9], you can check whether
822
819
  # `QueueName` ends with the `.fifo` suffix.
823
820
  #
824
821
  # </note>
825
822
  #
826
823
  # * `ContentBasedDeduplication` – Returns whether content-based
827
824
  # deduplication is enabled for the queue. For more information, see
828
- # [Exactly-Once Processing][9] in the *Amazon Simple Queue Service
829
- # Developer Guide*.
830
- #
831
- # **Preview: High throughput for FIFO queues**
825
+ # [Exactly-once processing][11] in the *Amazon SQS Developer Guide*.
832
826
  #
833
- # **High throughput for Amazon SQS FIFO queues is in preview release
834
- # and is subject to change.** This feature provides a high number of
835
- # transactions per second (TPS) for messages in FIFO queues. For
836
- # information on throughput quotas, see [Quotas related to
837
- # messages][10] in the *Amazon Simple Queue Service Developer Guide*.
838
- #
839
- # This preview includes two new attributes:
827
+ # The following attributes apply only to [high throughput for FIFO
828
+ # queues][12]\:
840
829
  #
841
830
  # * `DeduplicationScope` – Specifies whether message deduplication
842
831
  # occurs at the message group or queue level. Valid values are
@@ -855,22 +844,11 @@ module Aws::SQS
855
844
  # * Set `FifoThroughputLimit` to `perMessageGroupId`.
856
845
  #
857
846
  # If you set these attributes to anything other than the values shown
858
- # for enabling high throughput, standard throughput is in effect and
847
+ # for enabling high throughput, normal throughput is in effect and
859
848
  # deduplication occurs as specified.
860
849
  #
861
- # This preview is available in the following AWS Regions:
862
- #
863
- # * US East (Ohio); us-east-2
864
- #
865
- # * US East (N. Virginia); us-east-1
866
- #
867
- # * US West (Oregon); us-west-2
868
- #
869
- # * Europe (Ireland); eu-west-1
870
- #
871
- # For more information about high throughput for FIFO queues, see
872
- # [Preview: High throughput for FIFO queues][11] in the *Amazon Simple
873
- # Queue Service Developer Guide*.
850
+ # For information on throughput quotas, see [Quotas related to
851
+ # messages][13] in the *Amazon SQS Developer Guide*.
874
852
  #
875
853
  #
876
854
  #
@@ -880,11 +858,13 @@ module Aws::SQS
880
858
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
881
859
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
882
860
  # [6]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
883
- # [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
884
- # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-understanding-logic
885
- # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
886
- # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
887
- # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
861
+ # [7]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
862
+ # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
863
+ # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
864
+ # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-understanding-logic.html
865
+ # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
866
+ # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
867
+ # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
888
868
  # @return [Array<String>]
889
869
  #
890
870
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueAttributesRequest AWS API Documentation
@@ -927,7 +907,8 @@ module Aws::SQS
927
907
  # @return [String]
928
908
  #
929
909
  # @!attribute [rw] queue_owner_aws_account_id
930
- # The AWS account ID of the account that created the queue.
910
+ # The Amazon Web Services account ID of the account that created the
911
+ # queue.
931
912
  # @return [String]
932
913
  #
933
914
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/GetQueueUrlRequest AWS API Documentation
@@ -940,7 +921,7 @@ module Aws::SQS
940
921
  end
941
922
 
942
923
  # For more information, see [Interpreting Responses][1] in the *Amazon
943
- # Simple Queue Service Developer Guide*.
924
+ # SQS Developer Guide*.
944
925
  #
945
926
  #
946
927
  #
@@ -1133,7 +1114,8 @@ module Aws::SQS
1133
1114
  #
1134
1115
  # @!attribute [rw] message_id
1135
1116
  # A unique identifier for the message. A `MessageId`is considered
1136
- # unique across all AWS accounts for an extended period of time.
1117
+ # unique across all Amazon Web Services accounts for an extended
1118
+ # period of time.
1137
1119
  # @return [String]
1138
1120
  #
1139
1121
  # @!attribute [rw] receipt_handle
@@ -1192,8 +1174,8 @@ module Aws::SQS
1192
1174
  #
1193
1175
  # @!attribute [rw] message_attributes
1194
1176
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1195
- # For more information, see [Amazon SQS Message Attributes][1] in the
1196
- # *Amazon Simple Queue Service Developer Guide*.
1177
+ # For more information, see [Amazon SQS message attributes][1] in the
1178
+ # *Amazon SQS Developer Guide*.
1197
1179
  #
1198
1180
  #
1199
1181
  #
@@ -1262,8 +1244,7 @@ module Aws::SQS
1262
1244
  # `StringValue`.
1263
1245
  #
1264
1246
  # You can also append custom labels. For more information, see [Amazon
1265
- # SQS Message Attributes][1] in the *Amazon Simple Queue Service
1266
- # Developer Guide*.
1247
+ # SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
1267
1248
  #
1268
1249
  #
1269
1250
  #
@@ -1334,8 +1315,7 @@ module Aws::SQS
1334
1315
  # `StringValue`.
1335
1316
  #
1336
1317
  # You can also append custom labels. For more information, see [Amazon
1337
- # SQS Message Attributes][1] in the *Amazon Simple Queue Service
1338
- # Developer Guide*.
1318
+ # SQS Message Attributes][1] in the *Amazon SQS Developer Guide*.
1339
1319
  #
1340
1320
  #
1341
1321
  #
@@ -1425,7 +1405,7 @@ module Aws::SQS
1425
1405
  #
1426
1406
  # {
1427
1407
  # queue_url: "String", # required
1428
- # attribute_names: ["All"], # accepts All, Policy, VisibilityTimeout, MaximumMessageSize, MessageRetentionPeriod, ApproximateNumberOfMessages, ApproximateNumberOfMessagesNotVisible, CreatedTimestamp, LastModifiedTimestamp, QueueArn, ApproximateNumberOfMessagesDelayed, DelaySeconds, ReceiveMessageWaitTimeSeconds, RedrivePolicy, FifoQueue, ContentBasedDeduplication, KmsMasterKeyId, KmsDataKeyReusePeriodSeconds, DeduplicationScope, FifoThroughputLimit
1408
+ # 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
1429
1409
  # message_attribute_names: ["MessageAttributeName"],
1430
1410
  # max_number_of_messages: 1,
1431
1411
  # visibility_timeout: 1,
@@ -1452,7 +1432,7 @@ module Aws::SQS
1452
1432
  # * `ApproximateReceiveCount` – Returns the number of times a message
1453
1433
  # has been received across all queues but not deleted.
1454
1434
  #
1455
- # * `AWSTraceHeader` – Returns the AWS X-Ray trace header string.
1435
+ # * `AWSTraceHeader` – Returns the X-Ray trace header string.
1456
1436
  #
1457
1437
  # * `SenderId`
1458
1438
  #
@@ -1465,6 +1445,10 @@ module Aws::SQS
1465
1445
  # * `SentTimestamp` – Returns the time the message was sent to the
1466
1446
  # queue ([epoch time][1] in milliseconds).
1467
1447
  #
1448
+ # * `SqsManagedSseEnabled` – Enables server-side queue encryption
1449
+ # using SQS owned encryption keys. Only one server-side encryption
1450
+ # option is supported per queue (e.g. [SSE-KMS][2] or [SSE-SQS][3]).
1451
+ #
1468
1452
  # * `MessageDeduplicationId` – Returns the value provided by the
1469
1453
  # producer that calls the ` SendMessage ` action.
1470
1454
  #
@@ -1477,6 +1461,8 @@ module Aws::SQS
1477
1461
  #
1478
1462
  #
1479
1463
  # [1]: http://en.wikipedia.org/wiki/Unix_time
1464
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
1465
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
1480
1466
  # @return [Array<String>]
1481
1467
  #
1482
1468
  # @!attribute [rw] message_attribute_names
@@ -1562,8 +1548,7 @@ module Aws::SQS
1562
1548
  # `ReceiveRequestAttemptId` return the same messages and receipt
1563
1549
  # handles. If a retry occurs within the deduplication interval, it
1564
1550
  # resets the visibility timeout. For more information, see
1565
- # [Visibility Timeout][1] in the *Amazon Simple Queue Service
1566
- # Developer Guide*.
1551
+ # [Visibility Timeout][1] in the *Amazon SQS Developer Guide*.
1567
1552
  #
1568
1553
  # If a caller of the `ReceiveMessage` action still processes
1569
1554
  # messages when the visibility timeout expires and messages become
@@ -1594,8 +1579,8 @@ module Aws::SQS
1594
1579
  # !"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~ ``).
1595
1580
  #
1596
1581
  # For best practices of using `ReceiveRequestAttemptId`, see [Using
1597
- # the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon
1598
- # Simple Queue Service Developer Guide*.
1582
+ # the ReceiveRequestAttemptId Request Parameter][2] in the *Amazon SQS
1583
+ # Developer Guide*.
1599
1584
  #
1600
1585
  #
1601
1586
  #
@@ -1776,8 +1761,8 @@ module Aws::SQS
1776
1761
  #
1777
1762
  # @!attribute [rw] message_attributes
1778
1763
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
1779
- # For more information, see [Amazon SQS Message Attributes][1] in the
1780
- # *Amazon Simple Queue Service Developer Guide*.
1764
+ # For more information, see [Amazon SQS message attributes][1] in the
1765
+ # *Amazon SQS Developer Guide*.
1781
1766
  #
1782
1767
  #
1783
1768
  #
@@ -1790,7 +1775,7 @@ module Aws::SQS
1790
1775
  #
1791
1776
  # * Currently, the only supported message system attribute is
1792
1777
  # `AWSTraceHeader`. Its type must be `String` and its value must be
1793
- # a correctly formatted AWS X-Ray trace header string.
1778
+ # a correctly formatted X-Ray trace header string.
1794
1779
  #
1795
1780
  # * The size of a message system attribute doesn't count towards the
1796
1781
  # total size of a message.
@@ -1803,8 +1788,8 @@ module Aws::SQS
1803
1788
  # minimum deduplication interval. If a message with a particular
1804
1789
  # `MessageDeduplicationId` is sent successfully, subsequent messages
1805
1790
  # with the same `MessageDeduplicationId` are accepted successfully but
1806
- # aren't delivered. For more information, see [ Exactly-Once
1807
- # Processing][1] in the *Amazon Simple Queue Service Developer Guide*.
1791
+ # aren't delivered. For more information, see [ Exactly-once
1792
+ # processing][1] in the *Amazon SQS Developer Guide*.
1808
1793
  #
1809
1794
  # * Every message must have a unique `MessageDeduplicationId`,
1810
1795
  #
@@ -1853,12 +1838,12 @@ module Aws::SQS
1853
1838
  # ``).
1854
1839
  #
1855
1840
  # For best practices of using `MessageDeduplicationId`, see [Using the
1856
- # MessageDeduplicationId Property][2] in the *Amazon Simple Queue
1857
- # Service Developer Guide*.
1841
+ # MessageDeduplicationId Property][2] in the *Amazon SQS Developer
1842
+ # Guide*.
1858
1843
  #
1859
1844
  #
1860
1845
  #
1861
- # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
1846
+ # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
1862
1847
  # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
1863
1848
  # @return [String]
1864
1849
  #
@@ -1887,8 +1872,7 @@ module Aws::SQS
1887
1872
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
1888
1873
  #
1889
1874
  # For best practices of using `MessageGroupId`, see [Using the
1890
- # MessageGroupId Property][1] in the *Amazon Simple Queue Service
1891
- # Developer Guide*.
1875
+ # MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
1892
1876
  #
1893
1877
  # `MessageGroupId` is required for FIFO queues. You can't use it for
1894
1878
  # Standard queues.
@@ -2071,8 +2055,8 @@ module Aws::SQS
2071
2055
  #
2072
2056
  # @!attribute [rw] message_attributes
2073
2057
  # Each message attribute consists of a `Name`, `Type`, and `Value`.
2074
- # For more information, see [Amazon SQS Message Attributes][1] in the
2075
- # *Amazon Simple Queue Service Developer Guide*.
2058
+ # For more information, see [Amazon SQS message attributes][1] in the
2059
+ # *Amazon SQS Developer Guide*.
2076
2060
  #
2077
2061
  #
2078
2062
  #
@@ -2085,7 +2069,7 @@ module Aws::SQS
2085
2069
  #
2086
2070
  # * Currently, the only supported message system attribute is
2087
2071
  # `AWSTraceHeader`. Its type must be `String` and its value must be
2088
- # a correctly formatted AWS X-Ray trace header string.
2072
+ # a correctly formatted X-Ray trace header string.
2089
2073
  #
2090
2074
  # * The size of a message system attribute doesn't count towards the
2091
2075
  # total size of a message.
@@ -2098,8 +2082,8 @@ module Aws::SQS
2098
2082
  # a particular `MessageDeduplicationId` is sent successfully, any
2099
2083
  # messages sent with the same `MessageDeduplicationId` are accepted
2100
2084
  # successfully but aren't delivered during the 5-minute deduplication
2101
- # interval. For more information, see [ Exactly-Once Processing][1] in
2102
- # the *Amazon Simple Queue Service Developer Guide*.
2085
+ # interval. For more information, see [ Exactly-once processing][1] in
2086
+ # the *Amazon SQS Developer Guide*.
2103
2087
  #
2104
2088
  # * Every message must have a unique `MessageDeduplicationId`,
2105
2089
  #
@@ -2148,12 +2132,12 @@ module Aws::SQS
2148
2132
  # ``).
2149
2133
  #
2150
2134
  # For best practices of using `MessageDeduplicationId`, see [Using the
2151
- # MessageDeduplicationId Property][2] in the *Amazon Simple Queue
2152
- # Service Developer Guide*.
2135
+ # MessageDeduplicationId Property][2] in the *Amazon SQS Developer
2136
+ # Guide*.
2153
2137
  #
2154
2138
  #
2155
2139
  #
2156
- # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
2140
+ # [1]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
2157
2141
  # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/using-messagededuplicationid-property.html
2158
2142
  # @return [String]
2159
2143
  #
@@ -2182,8 +2166,7 @@ module Aws::SQS
2182
2166
  # (!"#$%&'()*+,-./:;<=>?@[\]^_`\{|\}~) ``.
2183
2167
  #
2184
2168
  # For best practices of using `MessageGroupId`, see [Using the
2185
- # MessageGroupId Property][1] in the *Amazon Simple Queue Service
2186
- # Developer Guide*.
2169
+ # MessageGroupId Property][1] in the *Amazon SQS Developer Guide*.
2187
2170
  #
2188
2171
  # `MessageGroupId` is required for FIFO queues. You can't use it for
2189
2172
  # Standard queues.
@@ -2242,7 +2225,7 @@ module Aws::SQS
2242
2225
  # @!attribute [rw] message_id
2243
2226
  # An attribute containing the `MessageId` of the message sent to the
2244
2227
  # queue. For more information, see [Queue and Message Identifiers][1]
2245
- # in the *Amazon Simple Queue Service Developer Guide*.
2228
+ # in the *Amazon SQS Developer Guide*.
2246
2229
  #
2247
2230
  #
2248
2231
  #
@@ -2308,9 +2291,10 @@ module Aws::SQS
2308
2291
  # representing seconds, from 60 (1 minute) to 1,209,600 (14 days).
2309
2292
  # Default: 345,600 (4 days).
2310
2293
  #
2311
- # * `Policy` – The queue's policy. A valid AWS policy. For more
2312
- # information about policy structure, see [Overview of AWS IAM
2313
- # Policies][1] in the *Amazon IAM User Guide*.
2294
+ # * `Policy` – The queue's policy. A valid Amazon Web Services
2295
+ # policy. For more information about policy structure, see [Overview
2296
+ # of Amazon Web Services IAM Policies][1] in the *Identity and
2297
+ # Access Management User Guide*.
2314
2298
  #
2315
2299
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
2316
2300
  # for which a ` ReceiveMessage ` action waits for a message to
@@ -2321,7 +2305,7 @@ module Aws::SQS
2321
2305
  # dead-letter queue functionality of the source queue as a JSON
2322
2306
  # object. For more information about the redrive policy and
2323
2307
  # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2]
2324
- # in the *Amazon Simple Queue Service Developer Guide*.
2308
+ # in the *Amazon SQS Developer Guide*.
2325
2309
  #
2326
2310
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
2327
2311
  # dead-letter queue to which Amazon SQS moves messages after the
@@ -2342,33 +2326,38 @@ module Aws::SQS
2342
2326
  # * `VisibilityTimeout` – The visibility timeout for the queue, in
2343
2327
  # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
2344
2328
  # Default: 30. For more information about the visibility timeout,
2345
- # see [Visibility Timeout][3] in the *Amazon Simple Queue Service
2346
- # Developer Guide*.
2329
+ # see [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
2347
2330
  #
2348
2331
  # The following attributes apply only to [server-side-encryption][4]\:
2349
2332
  #
2350
- # * `KmsMasterKeyId` – The ID of an AWS-managed customer master key
2351
- # (CMK) for Amazon SQS or a custom CMK. For more information, see
2352
- # [Key Terms][5]. While the alias of the AWS-managed CMK for Amazon
2353
- # SQS is always `alias/aws/sqs`, the alias of a custom CMK can, for
2354
- # example, be `alias/MyAlias `. For more examples, see [KeyId][6] in
2355
- # the *AWS Key Management Service API Reference*.
2333
+ # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed
2334
+ # customer master key (CMK) for Amazon SQS or a custom CMK. For more
2335
+ # information, see [Key Terms][5]. While the alias of the
2336
+ # AWS-managed CMK for Amazon SQS is always `alias/aws/sqs`, the
2337
+ # alias of a custom CMK can, for example, be `alias/MyAlias `. For
2338
+ # more examples, see [KeyId][6] in the *Key Management Service API
2339
+ # Reference*.
2356
2340
  #
2357
2341
  # * `KmsDataKeyReusePeriodSeconds` – The length of time, in seconds,
2358
2342
  # for which Amazon SQS can reuse a [data key][7] to encrypt or
2359
- # decrypt messages before calling AWS KMS again. An integer
2360
- # representing seconds, between 60 seconds (1 minute) and 86,400
2361
- # seconds (24 hours). Default: 300 (5 minutes). A shorter time
2362
- # period provides better security but results in more calls to KMS
2363
- # which might incur charges after Free Tier. For more information,
2364
- # see [How Does the Data Key Reuse Period Work?][8].
2343
+ # decrypt messages before calling KMS again. An integer representing
2344
+ # seconds, between 60 seconds (1 minute) and 86,400 seconds (24
2345
+ # hours). Default: 300 (5 minutes). A shorter time period provides
2346
+ # better security but results in more calls to KMS which might incur
2347
+ # charges after Free Tier. For more information, see [How Does the
2348
+ # Data Key Reuse Period Work?][8].
2349
+ #
2350
+ # * `SqsManagedSseEnabled` – Enables server-side queue encryption
2351
+ # using SQS owned encryption keys. Only one server-side encryption
2352
+ # option is supported per queue (e.g. [SSE-KMS][9] or
2353
+ # [SSE-SQS][10]).
2365
2354
  #
2366
2355
  # The following attribute applies only to [FIFO (first-in-first-out)
2367
- # queues][9]\:
2356
+ # queues][11]\:
2368
2357
  #
2369
2358
  # * `ContentBasedDeduplication` – Enables content-based deduplication.
2370
- # For more information, see [Exactly-Once Processing][10] in the
2371
- # *Amazon Simple Queue Service Developer Guide*. Note the following:
2359
+ # For more information, see [Exactly-once processing][12] in the
2360
+ # *Amazon SQS Developer Guide*. Note the following:
2372
2361
  #
2373
2362
  # * Every message must have a unique `MessageDeduplicationId`.
2374
2363
  #
@@ -2398,15 +2387,8 @@ module Aws::SQS
2398
2387
  # `MessageDeduplicationId`, the two messages are treated as
2399
2388
  # duplicates and only one copy of the message is delivered.
2400
2389
  #
2401
- # **Preview: High throughput for FIFO queues**
2402
- #
2403
- # **High throughput for Amazon SQS FIFO queues is in preview release
2404
- # and is subject to change.** This feature provides a high number of
2405
- # transactions per second (TPS) for messages in FIFO queues. For
2406
- # information on throughput quotas, see [Quotas related to
2407
- # messages][11] in the *Amazon Simple Queue Service Developer Guide*.
2408
- #
2409
- # This preview includes two new attributes:
2390
+ # The following attributes apply only to [high throughput for FIFO
2391
+ # queues][13]\:
2410
2392
  #
2411
2393
  # * `DeduplicationScope` – Specifies whether message deduplication
2412
2394
  # occurs at the message group or queue level. Valid values are
@@ -2425,22 +2407,11 @@ module Aws::SQS
2425
2407
  # * Set `FifoThroughputLimit` to `perMessageGroupId`.
2426
2408
  #
2427
2409
  # If you set these attributes to anything other than the values shown
2428
- # for enabling high throughput, standard throughput is in effect and
2410
+ # for enabling high throughput, normal throughput is in effect and
2429
2411
  # deduplication occurs as specified.
2430
2412
  #
2431
- # This preview is available in the following AWS Regions:
2432
- #
2433
- # * US East (Ohio); us-east-2
2434
- #
2435
- # * US East (N. Virginia); us-east-1
2436
- #
2437
- # * US West (Oregon); us-west-2
2438
- #
2439
- # * Europe (Ireland); eu-west-1
2440
- #
2441
- # For more information about high throughput for FIFO queues, see
2442
- # [Preview: High throughput for FIFO queues][12] in the *Amazon Simple
2443
- # Queue Service Developer Guide*.
2413
+ # For information on throughput quotas, see [Quotas related to
2414
+ # messages][14] in the *Amazon SQS Developer Guide*.
2444
2415
  #
2445
2416
  #
2446
2417
  #
@@ -2452,10 +2423,12 @@ module Aws::SQS
2452
2423
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
2453
2424
  # [7]: https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#data-keys
2454
2425
  # [8]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work
2455
- # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
2456
- # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-exactly-once-processing
2457
- # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
2458
- # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
2426
+ # [9]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html
2427
+ # [10]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html
2428
+ # [11]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html
2429
+ # [12]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues-exactly-once-processing.html
2430
+ # [13]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html
2431
+ # [14]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html
2459
2432
  # @return [Hash<String,String>]
2460
2433
  #
2461
2434
  # @see http://docs.aws.amazon.com/goto/WebAPI/sqs-2012-11-05/SetQueueAttributesRequest AWS API Documentation