aws-sdk-sqs 1.52.0 → 1.54.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -76,43 +76,77 @@ module Aws::SQS
76
76
  # * `MessageRetentionPeriod` – The length of time, in seconds, for which
77
77
  # Amazon SQS retains a message. Valid values: An integer from 60
78
78
  # seconds (1 minute) to 1,209,600 seconds (14 days). Default: 345,600
79
- # (4 days).
79
+ # (4 days). When you change a queue's attributes, the change can take
80
+ # up to 60 seconds for most of the attributes to propagate throughout
81
+ # the Amazon SQS system. Changes made to the `MessageRetentionPeriod`
82
+ # attribute can take up to 15 minutes and will impact existing
83
+ # messages in the queue potentially causing them to be expired and
84
+ # deleted if the `MessageRetentionPeriod` is reduced below the age of
85
+ # existing messages.
80
86
  #
81
87
  # * `Policy` – The queue's policy. A valid Amazon Web Services policy.
82
88
  # For more information about policy structure, see [Overview of Amazon
83
- # Web Services IAM Policies][1] in the *Amazon IAM User Guide*.
89
+ # Web Services IAM Policies][1] in the *IAM User Guide*.
84
90
  #
85
91
  # * `ReceiveMessageWaitTimeSeconds` – The length of time, in seconds,
86
92
  # for which a ` ReceiveMessage ` action waits for a message to arrive.
87
93
  # Valid values: An integer from 0 to 20 (seconds). Default: 0.
88
94
  #
95
+ # * `VisibilityTimeout` – The visibility timeout for the queue, in
96
+ # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
97
+ # Default: 30. For more information about the visibility timeout, see
98
+ # [Visibility Timeout][2] in the *Amazon SQS Developer Guide*.
99
+ #
100
+ # The following attributes apply only to [dead-letter queues:][3]
101
+ #
89
102
  # * `RedrivePolicy` – The string that includes the parameters for the
90
103
  # dead-letter queue functionality of the source queue as a JSON
91
- # object. For more information about the redrive policy and
92
- # dead-letter queues, see [Using Amazon SQS Dead-Letter Queues][2] in
93
- # the *Amazon SQS Developer Guide*.
104
+ # object. The parameters are as follows:
94
105
  #
95
106
  # * `deadLetterTargetArn` – The Amazon Resource Name (ARN) of the
96
107
  # dead-letter queue to which Amazon SQS moves messages after the
97
108
  # value of `maxReceiveCount` is exceeded.
98
109
  #
99
110
  # * `maxReceiveCount` – The number of times a message is delivered to
100
- # the source queue before being moved to the dead-letter queue. When
101
- # the `ReceiveCount` for a message exceeds the `maxReceiveCount` for
102
- # a queue, Amazon SQS moves the message to the dead-letter-queue.
103
- #
104
- # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
105
- # Similarly, the dead-letter queue of a standard queue must also be a
106
- # standard queue.
111
+ # the source queue before being moved to the dead-letter queue.
112
+ # Default: 10. When the `ReceiveCount` for a message exceeds the
113
+ # `maxReceiveCount` for a queue, Amazon SQS moves the message to the
114
+ # dead-letter-queue.
115
+ #
116
+ # * `RedriveAllowPolicy` The string that includes the parameters for
117
+ # the permissions for the dead-letter queue redrive permission and
118
+ # which source queues can specify dead-letter queues as a JSON object.
119
+ # The parameters are as follows:
120
+ #
121
+ # * `redrivePermission` – The permission type that defines which
122
+ # source queues can specify the current queue as the dead-letter
123
+ # queue. Valid values are:
124
+ #
125
+ # * `allowAll` – (Default) Any source queues in this Amazon Web
126
+ # Services account in the same Region can specify this queue as
127
+ # the dead-letter queue.
128
+ #
129
+ # * `denyAll` – No source queues can specify this queue as the
130
+ # dead-letter queue.
131
+ #
132
+ # * `byQueue` – Only queues specified by the `sourceQueueArns`
133
+ # parameter can specify this queue as the dead-letter queue.
134
+ #
135
+ # * `sourceQueueArns` – The Amazon Resource Names (ARN)s of the source
136
+ # queues that can specify this queue as the dead-letter queue and
137
+ # redrive messages. You can specify this parameter only when the
138
+ # `redrivePermission` parameter is set to `byQueue`. You can specify
139
+ # up to 10 source queue ARNs. To allow more than 10 source queues to
140
+ # specify dead-letter queues, set the `redrivePermission` parameter
141
+ # to `allowAll`.
142
+ #
143
+ # <note markdown="1"> The dead-letter queue of a FIFO queue must also be a FIFO queue.
144
+ # Similarly, the dead-letter queue of a standard queue must also be a
145
+ # standard queue.
107
146
  #
108
- # </note>
109
- #
110
- # * `VisibilityTimeout` – The visibility timeout for the queue, in
111
- # seconds. Valid values: An integer from 0 to 43,200 (12 hours).
112
- # Default: 30. For more information about the visibility timeout, see
113
- # [Visibility Timeout][3] in the *Amazon SQS Developer Guide*.
147
+ # </note>
114
148
  #
115
- # The following attributes apply only to [server-side-encryption][4]\:
149
+ # The following attributes apply only to [server-side-encryption][4]:
116
150
  #
117
151
  # * `KmsMasterKeyId` – The ID of an Amazon Web Services managed customer
118
152
  # master key (CMK) for Amazon SQS or a custom CMK. For more
@@ -129,14 +163,14 @@ module Aws::SQS
129
163
  # Default: 300 (5 minutes). A shorter time period provides better
130
164
  # security but results in more calls to KMS which might incur charges
131
165
  # after Free Tier. For more information, see [How Does the Data Key
132
- # Reuse Period Work?][8].
166
+ # Reuse Period Work?][8]
133
167
  #
134
168
  # * `SqsManagedSseEnabled` – Enables server-side queue encryption using
135
169
  # SQS owned encryption keys. Only one server-side encryption option is
136
- # supported per queue (e.g. [SSE-KMS][9] or [SSE-SQS][10]).
170
+ # supported per queue (for example, [SSE-KMS][9] or [SSE-SQS][10]).
137
171
  #
138
172
  # The following attributes apply only to [FIFO (first-in-first-out)
139
- # queues][11]\:
173
+ # queues][11]:
140
174
  #
141
175
  # * `FifoQueue` – Designates a queue as FIFO. Valid values are `true`
142
176
  # and `false`. If you don't specify the `FifoQueue` attribute, Amazon
@@ -182,7 +216,7 @@ module Aws::SQS
182
216
  # duplicates and only one copy of the message is delivered.
183
217
  #
184
218
  # The following attributes apply only to [high throughput for FIFO
185
- # queues][14]\:
219
+ # queues][14]:
186
220
  #
187
221
  # * `DeduplicationScope` – Specifies whether message deduplication
188
222
  # occurs at the message group or queue level. Valid values are
@@ -210,8 +244,8 @@ module Aws::SQS
210
244
  #
211
245
  #
212
246
  # [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/PoliciesOverview.html
213
- # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
214
- # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
247
+ # [2]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html
248
+ # [3]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html
215
249
  # [4]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html
216
250
  # [5]: https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-sse-key-terms
217
251
  # [6]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters
@@ -248,8 +282,8 @@ module Aws::SQS
248
282
  # `sqs:CreateQueue` and `sqs:TagQueue` permissions.
249
283
  #
250
284
  # Cross-account permissions don't apply to this action. For more
251
- # information, see [Grant cross-account permissions to a role and a user
252
- # name][3] in the *Amazon SQS Developer Guide*.
285
+ # information, see [Grant cross-account permissions to a role and a
286
+ # username][3] in the *Amazon SQS Developer Guide*.
253
287
  #
254
288
  # </note>
255
289
  #