@aws-sdk/client-sqs 3.716.0 → 3.723.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.
- package/dist-cjs/index.js +277 -219
- package/dist-es/SQSClient.js +1 -0
- package/dist-es/models/models_0.js +56 -56
- package/dist-types/commands/AddPermissionCommand.d.ts +9 -13
- package/dist-types/commands/CancelMessageMoveTaskCommand.d.ts +7 -12
- package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +11 -14
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +10 -14
- package/dist-types/commands/CreateQueueCommand.d.ts +22 -24
- package/dist-types/commands/DeleteMessageBatchCommand.d.ts +11 -14
- package/dist-types/commands/DeleteMessageCommand.d.ts +16 -19
- package/dist-types/commands/DeleteQueueCommand.d.ts +9 -13
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +9 -13
- package/dist-types/commands/GetQueueUrlCommand.d.ts +17 -19
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +9 -13
- package/dist-types/commands/ListMessageMoveTasksCommand.d.ts +7 -12
- package/dist-types/commands/ListQueueTagsCommand.d.ts +9 -13
- package/dist-types/commands/ListQueuesCommand.d.ts +7 -12
- package/dist-types/commands/PurgeQueueCommand.d.ts +9 -13
- package/dist-types/commands/ReceiveMessageCommand.d.ts +16 -24
- package/dist-types/commands/RemovePermissionCommand.d.ts +9 -13
- package/dist-types/commands/SendMessageBatchCommand.d.ts +11 -14
- package/dist-types/commands/SendMessageCommand.d.ts +9 -13
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +9 -13
- package/dist-types/commands/StartMessageMoveTaskCommand.d.ts +7 -12
- package/dist-types/commands/TagQueueCommand.d.ts +9 -13
- package/dist-types/commands/UntagQueueCommand.d.ts +9 -13
- package/dist-types/models/models_0.d.ts +58 -24
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +5 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +9 -7
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +20 -8
- package/package.json +45 -45
|
@@ -32,12 +32,12 @@ declare const ReceiveMessageCommand_base: {
|
|
|
32
32
|
* information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS
|
|
33
33
|
* Long Polling</a> in the <i>Amazon SQS Developer Guide</i>. </p>
|
|
34
34
|
* <p>Short poll is the default behavior where a weighted random set of machines is sampled
|
|
35
|
-
* on a <code>ReceiveMessage</code> call.
|
|
36
|
-
* are returned. If the number of messages in the queue is small (fewer than
|
|
37
|
-
* most likely get fewer messages than you requested per
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
35
|
+
* on a <code>ReceiveMessage</code> call. Therefore, only the messages on the sampled
|
|
36
|
+
* machines are returned. If the number of messages in the queue is small (fewer than
|
|
37
|
+
* 1,000), you most likely get fewer messages than you requested per
|
|
38
|
+
* <code>ReceiveMessage</code> call. If the number of messages in the queue is
|
|
39
|
+
* extremely small, you might not receive any messages in a particular
|
|
40
|
+
* <code>ReceiveMessage</code> response. If this happens, repeat the request.</p>
|
|
41
41
|
* <p>For each message returned, the response includes the following:</p>
|
|
42
42
|
* <ul>
|
|
43
43
|
* <li>
|
|
@@ -66,11 +66,7 @@ declare const ReceiveMessageCommand_base: {
|
|
|
66
66
|
* <p>You can provide the <code>VisibilityTimeout</code> parameter in your request. The
|
|
67
67
|
* parameter is applied to the messages that Amazon SQS returns in the response. If you don't
|
|
68
68
|
* include the parameter, the overall visibility timeout for the queue is used for the
|
|
69
|
-
* returned messages.
|
|
70
|
-
* Guide</i>.</p>
|
|
71
|
-
* <p>A message that isn't deleted or a message whose visibility isn't extended before the
|
|
72
|
-
* visibility timeout expires counts as a failed receive. Depending on the configuration of
|
|
73
|
-
* the queue, the message might be sent to the dead-letter queue.</p>
|
|
69
|
+
* returned messages. The default visibility timeout for a queue is 30 seconds. </p>
|
|
74
70
|
* <note>
|
|
75
71
|
* <p>In the future, new attributes might be added. If you write code that calls this action, we recommend that you structure your code so that it can handle new attributes gracefully.</p>
|
|
76
72
|
* </note>
|
|
@@ -135,10 +131,10 @@ declare const ReceiveMessageCommand_base: {
|
|
|
135
131
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
136
132
|
*
|
|
137
133
|
* @throws {@link InvalidAddress} (client fault)
|
|
138
|
-
* <p>The
|
|
134
|
+
* <p>The specified ID is invalid.</p>
|
|
139
135
|
*
|
|
140
136
|
* @throws {@link InvalidSecurity} (client fault)
|
|
141
|
-
* <p>
|
|
137
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
142
138
|
*
|
|
143
139
|
* @throws {@link KmsAccessDenied} (client fault)
|
|
144
140
|
* <p>The caller doesn't have the required KMS access.</p>
|
|
@@ -181,24 +177,20 @@ declare const ReceiveMessageCommand_base: {
|
|
|
181
177
|
* for the queue is reached.</p>
|
|
182
178
|
*
|
|
183
179
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
184
|
-
* <p>
|
|
180
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
181
|
+
* deleted.</p>
|
|
185
182
|
*
|
|
186
183
|
* @throws {@link RequestThrottled} (client fault)
|
|
187
184
|
* <p>The request was denied due to request throttling.</p>
|
|
188
185
|
* <ul>
|
|
189
186
|
* <li>
|
|
190
|
-
* <p>
|
|
191
|
-
*
|
|
187
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
188
|
+
* request.</p>
|
|
192
189
|
* </li>
|
|
193
190
|
* <li>
|
|
194
|
-
* <p>
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
* <li>
|
|
198
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
199
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
200
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
201
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
191
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
192
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
193
|
+
* Developer Guide</i>.</p>
|
|
202
194
|
* </li>
|
|
203
195
|
* </ul>
|
|
204
196
|
*
|
|
@@ -67,30 +67,26 @@ declare const RemovePermissionCommand_base: {
|
|
|
67
67
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link InvalidAddress} (client fault)
|
|
70
|
-
* <p>The
|
|
70
|
+
* <p>The specified ID is invalid.</p>
|
|
71
71
|
*
|
|
72
72
|
* @throws {@link InvalidSecurity} (client fault)
|
|
73
|
-
* <p>
|
|
73
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
74
74
|
*
|
|
75
75
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
76
|
-
* <p>
|
|
76
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
77
|
+
* deleted.</p>
|
|
77
78
|
*
|
|
78
79
|
* @throws {@link RequestThrottled} (client fault)
|
|
79
80
|
* <p>The request was denied due to request throttling.</p>
|
|
80
81
|
* <ul>
|
|
81
82
|
* <li>
|
|
82
|
-
* <p>
|
|
83
|
-
*
|
|
83
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
84
|
+
* request.</p>
|
|
84
85
|
* </li>
|
|
85
86
|
* <li>
|
|
86
|
-
* <p>
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
* <li>
|
|
90
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
91
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
92
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
93
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
87
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
88
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
89
|
+
* Developer Guide</i>.</p>
|
|
94
90
|
* </li>
|
|
95
91
|
* </ul>
|
|
96
92
|
*
|
|
@@ -131,14 +131,14 @@ declare const SendMessageBatchCommand_base: {
|
|
|
131
131
|
* <p>The batch request doesn't contain any entries.</p>
|
|
132
132
|
*
|
|
133
133
|
* @throws {@link InvalidAddress} (client fault)
|
|
134
|
-
* <p>The
|
|
134
|
+
* <p>The specified ID is invalid.</p>
|
|
135
135
|
*
|
|
136
136
|
* @throws {@link InvalidBatchEntryId} (client fault)
|
|
137
137
|
* <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
|
|
138
138
|
* specification.</p>
|
|
139
139
|
*
|
|
140
140
|
* @throws {@link InvalidSecurity} (client fault)
|
|
141
|
-
* <p>
|
|
141
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
142
142
|
*
|
|
143
143
|
* @throws {@link KmsAccessDenied} (client fault)
|
|
144
144
|
* <p>The caller doesn't have the required KMS access.</p>
|
|
@@ -175,29 +175,26 @@ declare const SendMessageBatchCommand_base: {
|
|
|
175
175
|
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
176
176
|
*
|
|
177
177
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
178
|
-
* <p>
|
|
178
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
179
|
+
* deleted.</p>
|
|
179
180
|
*
|
|
180
181
|
* @throws {@link RequestThrottled} (client fault)
|
|
181
182
|
* <p>The request was denied due to request throttling.</p>
|
|
182
183
|
* <ul>
|
|
183
184
|
* <li>
|
|
184
|
-
* <p>
|
|
185
|
-
*
|
|
185
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
186
|
+
* request.</p>
|
|
186
187
|
* </li>
|
|
187
188
|
* <li>
|
|
188
|
-
* <p>
|
|
189
|
-
*
|
|
190
|
-
*
|
|
191
|
-
* <li>
|
|
192
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
193
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
194
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
195
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
189
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
190
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
191
|
+
* Developer Guide</i>.</p>
|
|
196
192
|
* </li>
|
|
197
193
|
* </ul>
|
|
198
194
|
*
|
|
199
195
|
* @throws {@link TooManyEntriesInBatchRequest} (client fault)
|
|
200
|
-
* <p>The batch request contains more entries than permissible
|
|
196
|
+
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
|
|
197
|
+
* maximum number of entries you can include in a single <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html">SendMessageBatch</a>, <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html">DeleteMessageBatch</a>, or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html">ChangeMessageVisibilityBatch</a> request is 10.</p>
|
|
201
198
|
*
|
|
202
199
|
* @throws {@link UnsupportedOperation} (client fault)
|
|
203
200
|
* <p>Error code 400. Unsupported operation.</p>
|
|
@@ -93,13 +93,13 @@ declare const SendMessageCommand_base: {
|
|
|
93
93
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
94
94
|
*
|
|
95
95
|
* @throws {@link InvalidAddress} (client fault)
|
|
96
|
-
* <p>The
|
|
96
|
+
* <p>The specified ID is invalid.</p>
|
|
97
97
|
*
|
|
98
98
|
* @throws {@link InvalidMessageContents} (client fault)
|
|
99
99
|
* <p>The message contains characters outside the allowed set.</p>
|
|
100
100
|
*
|
|
101
101
|
* @throws {@link InvalidSecurity} (client fault)
|
|
102
|
-
* <p>
|
|
102
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
103
103
|
*
|
|
104
104
|
* @throws {@link KmsAccessDenied} (client fault)
|
|
105
105
|
* <p>The caller doesn't have the required KMS access.</p>
|
|
@@ -136,24 +136,20 @@ declare const SendMessageCommand_base: {
|
|
|
136
136
|
* <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
|
|
137
137
|
*
|
|
138
138
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
139
|
-
* <p>
|
|
139
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
140
|
+
* deleted.</p>
|
|
140
141
|
*
|
|
141
142
|
* @throws {@link RequestThrottled} (client fault)
|
|
142
143
|
* <p>The request was denied due to request throttling.</p>
|
|
143
144
|
* <ul>
|
|
144
145
|
* <li>
|
|
145
|
-
* <p>
|
|
146
|
-
*
|
|
146
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
147
|
+
* request.</p>
|
|
147
148
|
* </li>
|
|
148
149
|
* <li>
|
|
149
|
-
* <p>
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
* <li>
|
|
153
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
154
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
155
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
156
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
150
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
151
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
152
|
+
* Developer Guide</i>.</p>
|
|
157
153
|
* </li>
|
|
158
154
|
* </ul>
|
|
159
155
|
*
|
|
@@ -74,7 +74,7 @@ declare const SetQueueAttributesCommand_base: {
|
|
|
74
74
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
75
75
|
*
|
|
76
76
|
* @throws {@link InvalidAddress} (client fault)
|
|
77
|
-
* <p>The
|
|
77
|
+
* <p>The specified ID is invalid.</p>
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link InvalidAttributeName} (client fault)
|
|
80
80
|
* <p>The specified attribute doesn't exist.</p>
|
|
@@ -83,7 +83,7 @@ declare const SetQueueAttributesCommand_base: {
|
|
|
83
83
|
* <p>A queue attribute value is invalid.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link InvalidSecurity} (client fault)
|
|
86
|
-
* <p>
|
|
86
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
87
87
|
*
|
|
88
88
|
* @throws {@link OverLimit} (client fault)
|
|
89
89
|
* <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
|
|
@@ -92,24 +92,20 @@ declare const SetQueueAttributesCommand_base: {
|
|
|
92
92
|
* for the queue is reached.</p>
|
|
93
93
|
*
|
|
94
94
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
95
|
-
* <p>
|
|
95
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
96
|
+
* deleted.</p>
|
|
96
97
|
*
|
|
97
98
|
* @throws {@link RequestThrottled} (client fault)
|
|
98
99
|
* <p>The request was denied due to request throttling.</p>
|
|
99
100
|
* <ul>
|
|
100
101
|
* <li>
|
|
101
|
-
* <p>
|
|
102
|
-
*
|
|
102
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
103
|
+
* request.</p>
|
|
103
104
|
* </li>
|
|
104
105
|
* <li>
|
|
105
|
-
* <p>
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
* <li>
|
|
109
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
110
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
111
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
112
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
106
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
107
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
108
|
+
* Developer Guide</i>.</p>
|
|
113
109
|
* </li>
|
|
114
110
|
* </ul>
|
|
115
111
|
*
|
|
@@ -75,27 +75,22 @@ declare const StartMessageMoveTaskCommand_base: {
|
|
|
75
75
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
76
76
|
*
|
|
77
77
|
* @throws {@link InvalidAddress} (client fault)
|
|
78
|
-
* <p>The
|
|
78
|
+
* <p>The specified ID is invalid.</p>
|
|
79
79
|
*
|
|
80
80
|
* @throws {@link InvalidSecurity} (client fault)
|
|
81
|
-
* <p>
|
|
81
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
82
82
|
*
|
|
83
83
|
* @throws {@link RequestThrottled} (client fault)
|
|
84
84
|
* <p>The request was denied due to request throttling.</p>
|
|
85
85
|
* <ul>
|
|
86
86
|
* <li>
|
|
87
|
-
* <p>
|
|
88
|
-
*
|
|
87
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
88
|
+
* request.</p>
|
|
89
89
|
* </li>
|
|
90
90
|
* <li>
|
|
91
|
-
* <p>
|
|
92
|
-
*
|
|
93
|
-
*
|
|
94
|
-
* <li>
|
|
95
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
96
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
97
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
98
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
91
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
92
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
93
|
+
* Developer Guide</i>.</p>
|
|
99
94
|
* </li>
|
|
100
95
|
* </ul>
|
|
101
96
|
*
|
|
@@ -77,30 +77,26 @@ declare const TagQueueCommand_base: {
|
|
|
77
77
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
78
78
|
*
|
|
79
79
|
* @throws {@link InvalidAddress} (client fault)
|
|
80
|
-
* <p>The
|
|
80
|
+
* <p>The specified ID is invalid.</p>
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link InvalidSecurity} (client fault)
|
|
83
|
-
* <p>
|
|
83
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
84
84
|
*
|
|
85
85
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
86
|
-
* <p>
|
|
86
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
87
|
+
* deleted.</p>
|
|
87
88
|
*
|
|
88
89
|
* @throws {@link RequestThrottled} (client fault)
|
|
89
90
|
* <p>The request was denied due to request throttling.</p>
|
|
90
91
|
* <ul>
|
|
91
92
|
* <li>
|
|
92
|
-
* <p>
|
|
93
|
-
*
|
|
93
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
94
|
+
* request.</p>
|
|
94
95
|
* </li>
|
|
95
96
|
* <li>
|
|
96
|
-
* <p>
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
* <li>
|
|
100
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
101
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
102
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
103
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
97
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
98
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
99
|
+
* Developer Guide</i>.</p>
|
|
104
100
|
* </li>
|
|
105
101
|
* </ul>
|
|
106
102
|
*
|
|
@@ -59,30 +59,26 @@ declare const UntagQueueCommand_base: {
|
|
|
59
59
|
* @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
|
|
60
60
|
*
|
|
61
61
|
* @throws {@link InvalidAddress} (client fault)
|
|
62
|
-
* <p>The
|
|
62
|
+
* <p>The specified ID is invalid.</p>
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link InvalidSecurity} (client fault)
|
|
65
|
-
* <p>
|
|
65
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
66
66
|
*
|
|
67
67
|
* @throws {@link QueueDoesNotExist} (client fault)
|
|
68
|
-
* <p>
|
|
68
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
69
|
+
* deleted.</p>
|
|
69
70
|
*
|
|
70
71
|
* @throws {@link RequestThrottled} (client fault)
|
|
71
72
|
* <p>The request was denied due to request throttling.</p>
|
|
72
73
|
* <ul>
|
|
73
74
|
* <li>
|
|
74
|
-
* <p>
|
|
75
|
-
*
|
|
75
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
76
|
+
* request.</p>
|
|
76
77
|
* </li>
|
|
77
78
|
* <li>
|
|
78
|
-
* <p>
|
|
79
|
-
*
|
|
80
|
-
*
|
|
81
|
-
* <li>
|
|
82
|
-
* <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
|
|
83
|
-
* might be throttled at a lower-than-expected rate when the Amazon Web Services
|
|
84
|
-
* CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
|
|
85
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
79
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
80
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
81
|
+
* Developer Guide</i>.</p>
|
|
86
82
|
* </li>
|
|
87
83
|
* </ul>
|
|
88
84
|
*
|
|
@@ -41,7 +41,7 @@ export interface AddPermissionRequest {
|
|
|
41
41
|
Actions: string[] | undefined;
|
|
42
42
|
}
|
|
43
43
|
/**
|
|
44
|
-
* <p>The
|
|
44
|
+
* <p>The specified ID is invalid.</p>
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
47
|
export declare class InvalidAddress extends __BaseException {
|
|
@@ -53,7 +53,7 @@ export declare class InvalidAddress extends __BaseException {
|
|
|
53
53
|
constructor(opts: __ExceptionOptionType<InvalidAddress, __BaseException>);
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
|
-
* <p>
|
|
56
|
+
* <p>The request was not made over HTTPS or did not use SigV4 for signing.</p>
|
|
57
57
|
* @public
|
|
58
58
|
*/
|
|
59
59
|
export declare class InvalidSecurity extends __BaseException {
|
|
@@ -80,7 +80,8 @@ export declare class OverLimit extends __BaseException {
|
|
|
80
80
|
constructor(opts: __ExceptionOptionType<OverLimit, __BaseException>);
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* <p>
|
|
83
|
+
* <p>Ensure that the <code>QueueUrl</code> is correct and that the queue has not been
|
|
84
|
+
* deleted.</p>
|
|
84
85
|
* @public
|
|
85
86
|
*/
|
|
86
87
|
export declare class QueueDoesNotExist extends __BaseException {
|
|
@@ -95,18 +96,13 @@ export declare class QueueDoesNotExist extends __BaseException {
|
|
|
95
96
|
* <p>The request was denied due to request throttling.</p>
|
|
96
97
|
* <ul>
|
|
97
98
|
* <li>
|
|
98
|
-
* <p>
|
|
99
|
-
*
|
|
100
|
-
* </li>
|
|
101
|
-
* <li>
|
|
102
|
-
* <p>A burst or sustained high rate of requests to change the state of the same KMS
|
|
103
|
-
* key. This condition is often known as a "hot key."</p>
|
|
99
|
+
* <p>Exceeds the permitted request rate for the queue or for the recipient of the
|
|
100
|
+
* request.</p>
|
|
104
101
|
* </li>
|
|
105
102
|
* <li>
|
|
106
|
-
* <p>
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
* processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
|
|
103
|
+
* <p>Ensure that the request rate is within the Amazon SQS limits for
|
|
104
|
+
* sending messages. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-quotas.html#quotas-requests">Amazon SQS quotas</a> in the <i>Amazon SQS
|
|
105
|
+
* Developer Guide</i>.</p>
|
|
110
106
|
* </li>
|
|
111
107
|
* </ul>
|
|
112
108
|
* @public
|
|
@@ -364,7 +360,8 @@ export declare class InvalidBatchEntryId extends __BaseException {
|
|
|
364
360
|
constructor(opts: __ExceptionOptionType<InvalidBatchEntryId, __BaseException>);
|
|
365
361
|
}
|
|
366
362
|
/**
|
|
367
|
-
* <p>The batch request contains more entries than permissible
|
|
363
|
+
* <p>The batch request contains more entries than permissible. For Amazon SQS, the
|
|
364
|
+
* maximum number of entries you can include in a single <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html">SendMessageBatch</a>, <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_DeleteMessageBatch.html">DeleteMessageBatch</a>, or <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_ChangeMessageVisibilityBatch.html">ChangeMessageVisibilityBatch</a> request is 10.</p>
|
|
368
365
|
* @public
|
|
369
366
|
*/
|
|
370
367
|
export declare class TooManyEntriesInBatchRequest extends __BaseException {
|
|
@@ -1142,20 +1139,22 @@ export interface GetQueueAttributesResult {
|
|
|
1142
1139
|
Attributes?: Partial<Record<QueueAttributeName, string>> | undefined;
|
|
1143
1140
|
}
|
|
1144
1141
|
/**
|
|
1145
|
-
* <p
|
|
1142
|
+
* <p>Retrieves the URL of an existing queue based on its name and, optionally, the Amazon Web Services
|
|
1143
|
+
* account ID. </p>
|
|
1146
1144
|
* @public
|
|
1147
1145
|
*/
|
|
1148
1146
|
export interface GetQueueUrlRequest {
|
|
1149
1147
|
/**
|
|
1150
|
-
* <p>The name of the queue
|
|
1151
|
-
* alphanumeric characters, hyphens (
|
|
1152
|
-
* (
|
|
1153
|
-
* <p>Queue URLs and names are case-sensitive.</p>
|
|
1148
|
+
* <p>(Required) The name of the queue for which you want to fetch the URL. The name can be
|
|
1149
|
+
* up to 80 characters long and can include alphanumeric characters, hyphens (-), and
|
|
1150
|
+
* underscores (_). Queue URLs and names are case-sensitive.</p>
|
|
1154
1151
|
* @public
|
|
1155
1152
|
*/
|
|
1156
1153
|
QueueName: string | undefined;
|
|
1157
1154
|
/**
|
|
1158
|
-
* <p>The Amazon Web Services account ID of the account that created the queue
|
|
1155
|
+
* <p>(Optional) The Amazon Web Services account ID of the account that created the queue. This is only
|
|
1156
|
+
* required when you are attempting to access a queue owned by another
|
|
1157
|
+
* Amazon Web Services account.</p>
|
|
1159
1158
|
* @public
|
|
1160
1159
|
*/
|
|
1161
1160
|
QueueOwnerAWSAccountId?: string | undefined;
|
|
@@ -1512,7 +1511,7 @@ export declare const MessageSystemAttributeName: {
|
|
|
1512
1511
|
*/
|
|
1513
1512
|
export type MessageSystemAttributeName = (typeof MessageSystemAttributeName)[keyof typeof MessageSystemAttributeName];
|
|
1514
1513
|
/**
|
|
1515
|
-
* <p
|
|
1514
|
+
* <p>Retrieves one or more messages from a specified queue.</p>
|
|
1516
1515
|
* @public
|
|
1517
1516
|
*/
|
|
1518
1517
|
export interface ReceiveMessageRequest {
|
|
@@ -1526,7 +1525,7 @@ export interface ReceiveMessageRequest {
|
|
|
1526
1525
|
* @deprecated
|
|
1527
1526
|
*
|
|
1528
1527
|
* <important>
|
|
1529
|
-
* <p>
|
|
1528
|
+
* <p>This parameter has been discontinued but will be supported for backward
|
|
1530
1529
|
* compatibility. To provide attribute names, you are encouraged to use
|
|
1531
1530
|
* <code>MessageSystemAttributeNames</code>. </p>
|
|
1532
1531
|
* </important>
|
|
@@ -1723,7 +1722,40 @@ export interface ReceiveMessageRequest {
|
|
|
1723
1722
|
MaxNumberOfMessages?: number | undefined;
|
|
1724
1723
|
/**
|
|
1725
1724
|
* <p>The duration (in seconds) that the received messages are hidden from subsequent
|
|
1726
|
-
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request
|
|
1725
|
+
* retrieve requests after being retrieved by a <code>ReceiveMessage</code> request. If not
|
|
1726
|
+
* specified, the default visibility timeout for the queue is used, which is 30
|
|
1727
|
+
* seconds.</p>
|
|
1728
|
+
* <p>Understanding <code>VisibilityTimeout</code>:</p>
|
|
1729
|
+
* <ul>
|
|
1730
|
+
* <li>
|
|
1731
|
+
* <p>When a message is received from a queue, it becomes temporarily invisible to
|
|
1732
|
+
* other consumers for the duration of the visibility timeout. This prevents
|
|
1733
|
+
* multiple consumers from processing the same message simultaneously. If the
|
|
1734
|
+
* message is not deleted or its visibility timeout is not extended before the
|
|
1735
|
+
* timeout expires, it becomes visible again and can be retrieved by other
|
|
1736
|
+
* consumers.</p>
|
|
1737
|
+
* </li>
|
|
1738
|
+
* <li>
|
|
1739
|
+
* <p>Setting an appropriate visibility timeout is crucial. If it's too short, the
|
|
1740
|
+
* message might become visible again before processing is complete, leading to
|
|
1741
|
+
* duplicate processing. If it's too long, it delays the reprocessing of messages
|
|
1742
|
+
* if the initial processing fails.</p>
|
|
1743
|
+
* </li>
|
|
1744
|
+
* <li>
|
|
1745
|
+
* <p>You can adjust the visibility timeout using the
|
|
1746
|
+
* <code>--visibility-timeout</code> parameter in the
|
|
1747
|
+
* <code>receive-message</code> command to match the processing time required
|
|
1748
|
+
* by your application.</p>
|
|
1749
|
+
* </li>
|
|
1750
|
+
* <li>
|
|
1751
|
+
* <p>A message that isn't deleted or a message whose visibility isn't extended
|
|
1752
|
+
* before the visibility timeout expires counts as a failed receive. Depending on
|
|
1753
|
+
* the configuration of the queue, the message might be sent to the dead-letter
|
|
1754
|
+
* queue.</p>
|
|
1755
|
+
* </li>
|
|
1756
|
+
* </ul>
|
|
1757
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer
|
|
1758
|
+
* Guide</i>.</p>
|
|
1727
1759
|
* @public
|
|
1728
1760
|
*/
|
|
1729
1761
|
VisibilityTimeout?: number | undefined;
|
|
@@ -1731,7 +1763,9 @@ export interface ReceiveMessageRequest {
|
|
|
1731
1763
|
* <p>The duration (in seconds) for which the call waits for a message to arrive in the
|
|
1732
1764
|
* queue before returning. If a message is available, the call returns sooner than
|
|
1733
1765
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time
|
|
1734
|
-
* expires, the call does not return a message list
|
|
1766
|
+
* expires, the call does not return a message list. If you are using the Java SDK, it
|
|
1767
|
+
* returns a <code>ReceiveMessageResponse</code> object, which has a empty list instead of
|
|
1768
|
+
* a Null object.</p>
|
|
1735
1769
|
* <important>
|
|
1736
1770
|
* <p>To avoid HTTP errors, ensure that the HTTP response timeout for
|
|
1737
1771
|
* <code>ReceiveMessage</code> requests is longer than the
|
|
@@ -7,7 +7,7 @@ export declare const getRuntimeConfig: (config: SQSClientConfig) => {
|
|
|
7
7
|
runtime: string;
|
|
8
8
|
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
9
9
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
10
|
-
credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
|
|
10
|
+
credentialDefaultProvider: ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider) | ((_: unknown) => () => Promise<import("@smithy/types").AwsCredentialIdentity>);
|
|
11
11
|
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
|
|
12
12
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
13
13
|
md5: false | import("@smithy/types").HashConstructor;
|
|
@@ -8,7 +8,7 @@ export declare const getRuntimeConfig: (config: SQSClientConfig) => {
|
|
|
8
8
|
runtime: string;
|
|
9
9
|
defaultsMode: import("@smithy/types").Provider<import("@smithy/smithy-client").ResolvedDefaultsMode>;
|
|
10
10
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
11
|
-
credentialDefaultProvider: (init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit | undefined) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity
|
|
11
|
+
credentialDefaultProvider: ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider) | ((init?: import("@aws-sdk/credential-provider-node").DefaultProviderInit | undefined) => import("@smithy/types").MemoizedProvider<import("@smithy/types").AwsCredentialIdentity>);
|
|
12
12
|
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-node").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
|
|
13
13
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
14
14
|
md5: false | __HashConstructor;
|
|
@@ -22,7 +22,7 @@ export declare const getRuntimeConfig: (config: SQSClientConfig) => {
|
|
|
22
22
|
region: string | import("@smithy/types").Provider<any>;
|
|
23
23
|
profile?: string | undefined;
|
|
24
24
|
defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved | undefined) => Promise<import("@smithy/types").UserAgent>;
|
|
25
|
-
credentialDefaultProvider: (input: any) => import("@smithy/types").AwsCredentialIdentityProvider;
|
|
25
|
+
credentialDefaultProvider: ((input: any) => import("@smithy/types").AwsCredentialIdentityProvider) | ((_: unknown) => () => Promise<import("@smithy/types").AwsCredentialIdentity>);
|
|
26
26
|
md5: false | import("@smithy/types").HashConstructor;
|
|
27
27
|
maxAttempts: number | import("@smithy/types").Provider<number>;
|
|
28
28
|
retryMode: string | import("@smithy/types").Provider<string>;
|
|
@@ -32,7 +32,7 @@ export declare const getRuntimeConfig: (config: SQSClientConfig) => {
|
|
|
32
32
|
customUserAgent?: string | import("@smithy/types").UserAgent | undefined;
|
|
33
33
|
userAgentAppId?: string | import("@smithy/types").Provider<string | undefined> | undefined;
|
|
34
34
|
retryStrategy?: import("@smithy/types").RetryStrategy | import("@smithy/types").RetryStrategyV2 | undefined;
|
|
35
|
-
endpoint?: string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2> | undefined;
|
|
35
|
+
endpoint?: ((string | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>) & (string | import("@smithy/types").Provider<string> | import("@smithy/types").Endpoint | import("@smithy/types").Provider<import("@smithy/types").Endpoint> | import("@smithy/types").EndpointV2 | import("@smithy/types").Provider<import("@smithy/types").EndpointV2>)) | undefined;
|
|
36
36
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
37
37
|
logger?: import("@smithy/types").Logger | undefined;
|
|
38
38
|
}) => import("@smithy/types").EndpointV2;
|