@aws-sdk/client-sqs 3.326.0 → 3.328.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/README.md +0 -1
- package/dist-cjs/endpoint/ruleset.js +2 -2
- package/dist-cjs/models/models_0.js +38 -1
- package/dist-es/endpoint/ruleset.js +2 -2
- package/dist-es/models/models_0.js +37 -0
- package/dist-types/SQS.d.ts +17 -18
- package/dist-types/SQSClient.d.ts +17 -18
- package/dist-types/commands/AddPermissionCommand.d.ts +4 -4
- package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +1 -2
- package/dist-types/commands/CreateQueueCommand.d.ts +7 -8
- package/dist-types/commands/GetQueueAttributesCommand.d.ts +1 -1
- package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +0 -1
- package/dist-types/commands/ListQueueTagsCommand.d.ts +2 -2
- package/dist-types/commands/PurgeQueueCommand.d.ts +2 -3
- package/dist-types/commands/ReceiveMessageCommand.d.ts +1 -1
- package/dist-types/commands/RemovePermissionCommand.d.ts +3 -3
- package/dist-types/commands/SendMessageBatchCommand.d.ts +3 -3
- package/dist-types/commands/SendMessageCommand.d.ts +3 -3
- package/dist-types/commands/SetQueueAttributesCommand.d.ts +3 -3
- package/dist-types/commands/TagQueueCommand.d.ts +2 -3
- package/dist-types/commands/UntagQueueCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +147 -115
- package/dist-types/ts3.4/models/models_0.d.ts +41 -31
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -2,6 +2,6 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.ruleSet = void 0;
|
|
4
4
|
const s = "required", t = "fn", u = "argv", v = "ref";
|
|
5
|
-
const a = "
|
|
6
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
5
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = "getAttr", g = { [s]: false, "type": "String" }, h = { [s]: true, "default": false, "type": "Boolean" }, i = { [v]: "Endpoint" }, j = { [t]: "booleanEquals", [u]: [{ [v]: "UseFIPS" }, true] }, k = { [t]: "booleanEquals", [u]: [{ [v]: "UseDualStack" }, true] }, l = {}, m = { [t]: "booleanEquals", [u]: [true, { [t]: f, [u]: [{ [v]: e }, "supportsFIPS"] }] }, n = { [v]: e }, o = { [t]: "booleanEquals", [u]: [true, { [t]: f, [u]: [n, "supportsDualStack"] }] }, p = [j], q = [k], r = [{ [v]: "Region" }];
|
|
6
|
+
const _data = { version: "1.0", parameters: { Region: g, UseDualStack: h, UseFIPS: h, Endpoint: g }, rules: [{ conditions: [{ [t]: a, [u]: [i] }], type: b, rules: [{ conditions: p, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: q, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: i, properties: l, headers: l }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [t]: a, [u]: r }], type: b, rules: [{ conditions: [{ [t]: "aws.partition", [u]: r, assign: e }], type: b, rules: [{ conditions: [j, k], type: b, rules: [{ conditions: [m, o], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: p, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ conditions: [{ [t]: "stringEquals", [u]: ["aws-us-gov", { [t]: f, [u]: [n, "name"] }] }], endpoint: { url: "https://sqs.{Region}.amazonaws.com", properties: l, headers: l }, type: d }, { endpoint: { url: "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: q, type: b, rules: [{ conditions: [o], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://sqs.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
7
7
|
exports.ruleSet = _data;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.BatchRequestTooLong = exports.UnsupportedOperation = exports.InvalidMessageContents = exports.PurgeQueueInProgress = exports.QueueDoesNotExist = exports.InvalidAttributeName = exports.InvalidIdFormat = exports.QueueNameExists = exports.QueueDeletedRecently = exports.TooManyEntriesInBatchRequest = exports.InvalidBatchEntryId = exports.EmptyBatchRequest = exports.BatchEntryIdsNotDistinct = exports.ReceiptHandleIsInvalid = exports.MessageNotInflight = exports.OverLimit = void 0;
|
|
3
|
+
exports.BatchRequestTooLong = exports.UnsupportedOperation = exports.MessageSystemAttributeNameForSends = exports.InvalidMessageContents = exports.MessageSystemAttributeName = exports.PurgeQueueInProgress = exports.QueueDoesNotExist = exports.InvalidAttributeName = exports.InvalidIdFormat = exports.QueueNameExists = exports.QueueDeletedRecently = exports.QueueAttributeName = exports.TooManyEntriesInBatchRequest = exports.InvalidBatchEntryId = exports.EmptyBatchRequest = exports.BatchEntryIdsNotDistinct = exports.ReceiptHandleIsInvalid = exports.MessageNotInflight = exports.OverLimit = void 0;
|
|
4
4
|
const SQSServiceException_1 = require("./SQSServiceException");
|
|
5
5
|
class OverLimit extends SQSServiceException_1.SQSServiceException {
|
|
6
6
|
constructor(opts) {
|
|
@@ -93,6 +93,30 @@ class TooManyEntriesInBatchRequest extends SQSServiceException_1.SQSServiceExcep
|
|
|
93
93
|
}
|
|
94
94
|
}
|
|
95
95
|
exports.TooManyEntriesInBatchRequest = TooManyEntriesInBatchRequest;
|
|
96
|
+
exports.QueueAttributeName = {
|
|
97
|
+
All: "All",
|
|
98
|
+
ApproximateNumberOfMessages: "ApproximateNumberOfMessages",
|
|
99
|
+
ApproximateNumberOfMessagesDelayed: "ApproximateNumberOfMessagesDelayed",
|
|
100
|
+
ApproximateNumberOfMessagesNotVisible: "ApproximateNumberOfMessagesNotVisible",
|
|
101
|
+
ContentBasedDeduplication: "ContentBasedDeduplication",
|
|
102
|
+
CreatedTimestamp: "CreatedTimestamp",
|
|
103
|
+
DeduplicationScope: "DeduplicationScope",
|
|
104
|
+
DelaySeconds: "DelaySeconds",
|
|
105
|
+
FifoQueue: "FifoQueue",
|
|
106
|
+
FifoThroughputLimit: "FifoThroughputLimit",
|
|
107
|
+
KmsDataKeyReusePeriodSeconds: "KmsDataKeyReusePeriodSeconds",
|
|
108
|
+
KmsMasterKeyId: "KmsMasterKeyId",
|
|
109
|
+
LastModifiedTimestamp: "LastModifiedTimestamp",
|
|
110
|
+
MaximumMessageSize: "MaximumMessageSize",
|
|
111
|
+
MessageRetentionPeriod: "MessageRetentionPeriod",
|
|
112
|
+
Policy: "Policy",
|
|
113
|
+
QueueArn: "QueueArn",
|
|
114
|
+
ReceiveMessageWaitTimeSeconds: "ReceiveMessageWaitTimeSeconds",
|
|
115
|
+
RedriveAllowPolicy: "RedriveAllowPolicy",
|
|
116
|
+
RedrivePolicy: "RedrivePolicy",
|
|
117
|
+
SqsManagedSseEnabled: "SqsManagedSseEnabled",
|
|
118
|
+
VisibilityTimeout: "VisibilityTimeout",
|
|
119
|
+
};
|
|
96
120
|
class QueueDeletedRecently extends SQSServiceException_1.SQSServiceException {
|
|
97
121
|
constructor(opts) {
|
|
98
122
|
super({
|
|
@@ -171,6 +195,16 @@ class PurgeQueueInProgress extends SQSServiceException_1.SQSServiceException {
|
|
|
171
195
|
}
|
|
172
196
|
}
|
|
173
197
|
exports.PurgeQueueInProgress = PurgeQueueInProgress;
|
|
198
|
+
exports.MessageSystemAttributeName = {
|
|
199
|
+
AWSTraceHeader: "AWSTraceHeader",
|
|
200
|
+
ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp",
|
|
201
|
+
ApproximateReceiveCount: "ApproximateReceiveCount",
|
|
202
|
+
MessageDeduplicationId: "MessageDeduplicationId",
|
|
203
|
+
MessageGroupId: "MessageGroupId",
|
|
204
|
+
SenderId: "SenderId",
|
|
205
|
+
SentTimestamp: "SentTimestamp",
|
|
206
|
+
SequenceNumber: "SequenceNumber",
|
|
207
|
+
};
|
|
174
208
|
class InvalidMessageContents extends SQSServiceException_1.SQSServiceException {
|
|
175
209
|
constructor(opts) {
|
|
176
210
|
super({
|
|
@@ -184,6 +218,9 @@ class InvalidMessageContents extends SQSServiceException_1.SQSServiceException {
|
|
|
184
218
|
}
|
|
185
219
|
}
|
|
186
220
|
exports.InvalidMessageContents = InvalidMessageContents;
|
|
221
|
+
exports.MessageSystemAttributeNameForSends = {
|
|
222
|
+
AWSTraceHeader: "AWSTraceHeader",
|
|
223
|
+
};
|
|
187
224
|
class UnsupportedOperation extends SQSServiceException_1.SQSServiceException {
|
|
188
225
|
constructor(opts) {
|
|
189
226
|
super({
|
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
const s = "required", t = "fn", u = "argv", v = "ref";
|
|
2
|
-
const a = "
|
|
3
|
-
const _data = { version: "1.0", parameters: { Region:
|
|
2
|
+
const a = "isSet", b = "tree", c = "error", d = "endpoint", e = "PartitionResult", f = "getAttr", g = { [s]: false, "type": "String" }, h = { [s]: true, "default": false, "type": "Boolean" }, i = { [v]: "Endpoint" }, j = { [t]: "booleanEquals", [u]: [{ [v]: "UseFIPS" }, true] }, k = { [t]: "booleanEquals", [u]: [{ [v]: "UseDualStack" }, true] }, l = {}, m = { [t]: "booleanEquals", [u]: [true, { [t]: f, [u]: [{ [v]: e }, "supportsFIPS"] }] }, n = { [v]: e }, o = { [t]: "booleanEquals", [u]: [true, { [t]: f, [u]: [n, "supportsDualStack"] }] }, p = [j], q = [k], r = [{ [v]: "Region" }];
|
|
3
|
+
const _data = { version: "1.0", parameters: { Region: g, UseDualStack: h, UseFIPS: h, Endpoint: g }, rules: [{ conditions: [{ [t]: a, [u]: [i] }], type: b, rules: [{ conditions: p, error: "Invalid Configuration: FIPS and custom endpoint are not supported", type: c }, { type: b, rules: [{ conditions: q, error: "Invalid Configuration: Dualstack and custom endpoint are not supported", type: c }, { endpoint: { url: i, properties: l, headers: l }, type: d }] }] }, { type: b, rules: [{ conditions: [{ [t]: a, [u]: r }], type: b, rules: [{ conditions: [{ [t]: "aws.partition", [u]: r, assign: e }], type: b, rules: [{ conditions: [j, k], type: b, rules: [{ conditions: [m, o], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://sqs-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "FIPS and DualStack are enabled, but this partition does not support one or both", type: c }] }, { conditions: p, type: b, rules: [{ conditions: [m], type: b, rules: [{ type: b, rules: [{ conditions: [{ [t]: "stringEquals", [u]: ["aws-us-gov", { [t]: f, [u]: [n, "name"] }] }], endpoint: { url: "https://sqs.{Region}.amazonaws.com", properties: l, headers: l }, type: d }, { endpoint: { url: "https://sqs-fips.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "FIPS is enabled but this partition does not support FIPS", type: c }] }, { conditions: q, type: b, rules: [{ conditions: [o], type: b, rules: [{ type: b, rules: [{ endpoint: { url: "https://sqs.{Region}.{PartitionResult#dualStackDnsSuffix}", properties: l, headers: l }, type: d }] }] }, { error: "DualStack is enabled but this partition does not support DualStack", type: c }] }, { type: b, rules: [{ endpoint: { url: "https://sqs.{Region}.{PartitionResult#dnsSuffix}", properties: l, headers: l }, type: d }] }] }] }, { error: "Invalid Configuration: Missing Region", type: c }] }] };
|
|
4
4
|
export const ruleSet = _data;
|
|
@@ -83,6 +83,30 @@ export class TooManyEntriesInBatchRequest extends __BaseException {
|
|
|
83
83
|
Object.setPrototypeOf(this, TooManyEntriesInBatchRequest.prototype);
|
|
84
84
|
}
|
|
85
85
|
}
|
|
86
|
+
export const QueueAttributeName = {
|
|
87
|
+
All: "All",
|
|
88
|
+
ApproximateNumberOfMessages: "ApproximateNumberOfMessages",
|
|
89
|
+
ApproximateNumberOfMessagesDelayed: "ApproximateNumberOfMessagesDelayed",
|
|
90
|
+
ApproximateNumberOfMessagesNotVisible: "ApproximateNumberOfMessagesNotVisible",
|
|
91
|
+
ContentBasedDeduplication: "ContentBasedDeduplication",
|
|
92
|
+
CreatedTimestamp: "CreatedTimestamp",
|
|
93
|
+
DeduplicationScope: "DeduplicationScope",
|
|
94
|
+
DelaySeconds: "DelaySeconds",
|
|
95
|
+
FifoQueue: "FifoQueue",
|
|
96
|
+
FifoThroughputLimit: "FifoThroughputLimit",
|
|
97
|
+
KmsDataKeyReusePeriodSeconds: "KmsDataKeyReusePeriodSeconds",
|
|
98
|
+
KmsMasterKeyId: "KmsMasterKeyId",
|
|
99
|
+
LastModifiedTimestamp: "LastModifiedTimestamp",
|
|
100
|
+
MaximumMessageSize: "MaximumMessageSize",
|
|
101
|
+
MessageRetentionPeriod: "MessageRetentionPeriod",
|
|
102
|
+
Policy: "Policy",
|
|
103
|
+
QueueArn: "QueueArn",
|
|
104
|
+
ReceiveMessageWaitTimeSeconds: "ReceiveMessageWaitTimeSeconds",
|
|
105
|
+
RedriveAllowPolicy: "RedriveAllowPolicy",
|
|
106
|
+
RedrivePolicy: "RedrivePolicy",
|
|
107
|
+
SqsManagedSseEnabled: "SqsManagedSseEnabled",
|
|
108
|
+
VisibilityTimeout: "VisibilityTimeout",
|
|
109
|
+
};
|
|
86
110
|
export class QueueDeletedRecently extends __BaseException {
|
|
87
111
|
constructor(opts) {
|
|
88
112
|
super({
|
|
@@ -155,6 +179,16 @@ export class PurgeQueueInProgress extends __BaseException {
|
|
|
155
179
|
Object.setPrototypeOf(this, PurgeQueueInProgress.prototype);
|
|
156
180
|
}
|
|
157
181
|
}
|
|
182
|
+
export const MessageSystemAttributeName = {
|
|
183
|
+
AWSTraceHeader: "AWSTraceHeader",
|
|
184
|
+
ApproximateFirstReceiveTimestamp: "ApproximateFirstReceiveTimestamp",
|
|
185
|
+
ApproximateReceiveCount: "ApproximateReceiveCount",
|
|
186
|
+
MessageDeduplicationId: "MessageDeduplicationId",
|
|
187
|
+
MessageGroupId: "MessageGroupId",
|
|
188
|
+
SenderId: "SenderId",
|
|
189
|
+
SentTimestamp: "SentTimestamp",
|
|
190
|
+
SequenceNumber: "SequenceNumber",
|
|
191
|
+
};
|
|
158
192
|
export class InvalidMessageContents extends __BaseException {
|
|
159
193
|
constructor(opts) {
|
|
160
194
|
super({
|
|
@@ -167,6 +201,9 @@ export class InvalidMessageContents extends __BaseException {
|
|
|
167
201
|
Object.setPrototypeOf(this, InvalidMessageContents.prototype);
|
|
168
202
|
}
|
|
169
203
|
}
|
|
204
|
+
export const MessageSystemAttributeNameForSends = {
|
|
205
|
+
AWSTraceHeader: "AWSTraceHeader",
|
|
206
|
+
};
|
|
170
207
|
export class UnsupportedOperation extends __BaseException {
|
|
171
208
|
constructor(opts) {
|
|
172
209
|
super({
|
package/dist-types/SQS.d.ts
CHANGED
|
@@ -145,38 +145,37 @@ export interface SQS {
|
|
|
145
145
|
/**
|
|
146
146
|
* @public
|
|
147
147
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
148
|
-
*
|
|
149
|
-
*
|
|
148
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
|
|
149
|
+
* <p>For information on the permissions you need to use this API, see
|
|
150
150
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
|
|
151
151
|
* access management</a> in the <i>Amazon SQS Developer Guide.</i>
|
|
152
152
|
* </p>
|
|
153
|
-
*
|
|
154
|
-
*
|
|
153
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
|
|
154
|
+
* <ul>
|
|
155
155
|
* <li>
|
|
156
|
-
*
|
|
156
|
+
* <p>Cryptographically sign your service requests</p>
|
|
157
157
|
* </li>
|
|
158
158
|
* <li>
|
|
159
|
-
*
|
|
159
|
+
* <p>Retry requests</p>
|
|
160
160
|
* </li>
|
|
161
161
|
* <li>
|
|
162
|
-
*
|
|
162
|
+
* <p>Handle error responses</p>
|
|
163
163
|
* </li>
|
|
164
164
|
* </ul>
|
|
165
|
-
*
|
|
166
|
-
* <p>
|
|
165
|
+
* <p>
|
|
167
166
|
* <b>Additional information</b>
|
|
168
167
|
* </p>
|
|
169
|
-
*
|
|
168
|
+
* <ul>
|
|
170
169
|
* <li>
|
|
171
|
-
*
|
|
172
|
-
*
|
|
173
|
-
*
|
|
170
|
+
* <p>
|
|
171
|
+
* <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
|
|
172
|
+
* </p>
|
|
174
173
|
* </li>
|
|
175
174
|
* <li>
|
|
176
|
-
*
|
|
175
|
+
* <p>
|
|
177
176
|
* <i>Amazon SQS Developer Guide</i>
|
|
178
177
|
* </p>
|
|
179
|
-
*
|
|
178
|
+
* <ul>
|
|
180
179
|
* <li>
|
|
181
180
|
* <p>
|
|
182
181
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
|
|
@@ -195,16 +194,16 @@ export interface SQS {
|
|
|
195
194
|
* </ul>
|
|
196
195
|
* </li>
|
|
197
196
|
* <li>
|
|
198
|
-
*
|
|
197
|
+
* <p>
|
|
199
198
|
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
200
199
|
* </a>
|
|
201
200
|
* </p>
|
|
202
201
|
* </li>
|
|
203
202
|
* <li>
|
|
204
|
-
*
|
|
203
|
+
* <p>
|
|
205
204
|
* <i>Amazon Web Services General Reference</i>
|
|
206
205
|
* </p>
|
|
207
|
-
*
|
|
206
|
+
* <ul>
|
|
208
207
|
* <li>
|
|
209
208
|
* <p>
|
|
210
209
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
|
|
@@ -170,38 +170,37 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
170
170
|
/**
|
|
171
171
|
* @public
|
|
172
172
|
* <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
|
|
173
|
-
*
|
|
174
|
-
*
|
|
173
|
+
* <p>Amazon SQS is a reliable, highly-scalable hosted queue for storing messages as they travel between applications or microservices. Amazon SQS moves data between distributed application components and helps you decouple these components.</p>
|
|
174
|
+
* <p>For information on the permissions you need to use this API, see
|
|
175
175
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and
|
|
176
176
|
* access management</a> in the <i>Amazon SQS Developer Guide.</i>
|
|
177
177
|
* </p>
|
|
178
|
-
*
|
|
179
|
-
*
|
|
178
|
+
* <p>You can use <a href="http://aws.amazon.com/tools/#sdk">Amazon Web Services SDKs</a> to access Amazon SQS using your favorite programming language. The SDKs perform tasks such as the following automatically:</p>
|
|
179
|
+
* <ul>
|
|
180
180
|
* <li>
|
|
181
|
-
*
|
|
181
|
+
* <p>Cryptographically sign your service requests</p>
|
|
182
182
|
* </li>
|
|
183
183
|
* <li>
|
|
184
|
-
*
|
|
184
|
+
* <p>Retry requests</p>
|
|
185
185
|
* </li>
|
|
186
186
|
* <li>
|
|
187
|
-
*
|
|
187
|
+
* <p>Handle error responses</p>
|
|
188
188
|
* </li>
|
|
189
189
|
* </ul>
|
|
190
|
-
*
|
|
191
|
-
* <p>
|
|
190
|
+
* <p>
|
|
192
191
|
* <b>Additional information</b>
|
|
193
192
|
* </p>
|
|
194
|
-
*
|
|
193
|
+
* <ul>
|
|
195
194
|
* <li>
|
|
196
|
-
*
|
|
197
|
-
*
|
|
198
|
-
*
|
|
195
|
+
* <p>
|
|
196
|
+
* <a href="http://aws.amazon.com/sqs/">Amazon SQS Product Page</a>
|
|
197
|
+
* </p>
|
|
199
198
|
* </li>
|
|
200
199
|
* <li>
|
|
201
|
-
*
|
|
200
|
+
* <p>
|
|
202
201
|
* <i>Amazon SQS Developer Guide</i>
|
|
203
202
|
* </p>
|
|
204
|
-
*
|
|
203
|
+
* <ul>
|
|
205
204
|
* <li>
|
|
206
205
|
* <p>
|
|
207
206
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-making-api-requests.html">Making API Requests</a>
|
|
@@ -220,16 +219,16 @@ export interface SQSClientResolvedConfig extends SQSClientResolvedConfigType {
|
|
|
220
219
|
* </ul>
|
|
221
220
|
* </li>
|
|
222
221
|
* <li>
|
|
223
|
-
*
|
|
222
|
+
* <p>
|
|
224
223
|
* <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
|
|
225
224
|
* </a>
|
|
226
225
|
* </p>
|
|
227
226
|
* </li>
|
|
228
227
|
* <li>
|
|
229
|
-
*
|
|
228
|
+
* <p>
|
|
230
229
|
* <i>Amazon Web Services General Reference</i>
|
|
231
230
|
* </p>
|
|
232
|
-
*
|
|
231
|
+
* <ul>
|
|
233
232
|
* <li>
|
|
234
233
|
* <p>
|
|
235
234
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#sqs_region">Regions and Endpoints</a>
|
|
@@ -30,7 +30,7 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
30
30
|
* <note>
|
|
31
31
|
* <ul>
|
|
32
32
|
* <li>
|
|
33
|
-
*
|
|
33
|
+
* <p>
|
|
34
34
|
* <code>AddPermission</code> generates a policy for you. You can use
|
|
35
35
|
* <code>
|
|
36
36
|
* <a>SetQueueAttributes</a>
|
|
@@ -40,11 +40,11 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* the <i>Amazon SQS Developer Guide</i>.</p>
|
|
41
41
|
* </li>
|
|
42
42
|
* <li>
|
|
43
|
-
*
|
|
43
|
+
* <p>An Amazon SQS policy can have a maximum of 7 actions.</p>
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
|
-
*
|
|
47
|
-
*
|
|
46
|
+
* <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
47
|
+
* </li>
|
|
48
48
|
* </ul>
|
|
49
49
|
* </note>
|
|
50
50
|
* <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
|
|
@@ -27,7 +27,7 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
27
27
|
* can continue to call <code>ChangeMessageVisibility</code> to extend the visibility
|
|
28
28
|
* timeout to the maximum allowed time. If you try to extend the visibility timeout beyond
|
|
29
29
|
* the maximum, your request is rejected.</p>
|
|
30
|
-
*
|
|
30
|
+
* <p>An Amazon SQS message has three basic states:</p>
|
|
31
31
|
* <ol>
|
|
32
32
|
* <li>
|
|
33
33
|
* <p>Sent to a queue by a producer.</p>
|
|
@@ -47,7 +47,6 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
|
|
|
47
47
|
* To avoid reaching the limit, you should delete messages from the queue after they're processed. You can also increase the number of queues you use to process your messages.
|
|
48
48
|
* To request a limit increase, <a href="https://console.aws.amazon.com/support/home#/case/create?issueType=service-limit-increase&limitType=service-code-sqs">file a support request</a>.</p>
|
|
49
49
|
* <p>For FIFO queues, there can be a maximum of 20,000 inflight messages (received from a queue by a consumer, but not yet deleted from the queue). If you reach this limit, Amazon SQS returns no error messages.</p>
|
|
50
|
-
*
|
|
51
50
|
* <important>
|
|
52
51
|
* <p>If you attempt to set the <code>VisibilityTimeout</code> to a value greater than the maximum time left, Amazon SQS returns an error. Amazon SQS doesn't automatically recalculate and increase the timeout to the maximum remaining time.</p>
|
|
53
52
|
* <p>Unlike with a queue, when you change the visibility timeout for a specific message the timeout value is applied immediately but isn't saved in memory for that message. If you don't delete a message after it is received, the visibility timeout
|
|
@@ -23,28 +23,27 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
|
|
|
23
23
|
* the request. Keep the following in mind:</p>
|
|
24
24
|
* <ul>
|
|
25
25
|
* <li>
|
|
26
|
-
*
|
|
27
|
-
*
|
|
26
|
+
* <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
|
|
27
|
+
* <note>
|
|
28
28
|
* <p>You can't change the queue type after you create it and you can't convert
|
|
29
29
|
* an existing standard queue into a FIFO queue. You must either create a new
|
|
30
30
|
* FIFO queue for your application or delete your existing standard queue and
|
|
31
31
|
* recreate it as a FIFO queue. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html#FIFO-queues-moving">Moving From a Standard Queue to a FIFO Queue</a> in the
|
|
32
32
|
* <i>Amazon SQS Developer Guide</i>. </p>
|
|
33
|
-
*
|
|
33
|
+
* </note>
|
|
34
34
|
* </li>
|
|
35
35
|
* <li>
|
|
36
|
-
*
|
|
36
|
+
* <p>If you don't provide a value for an attribute, the queue is created with the default value for the attribute.</p>
|
|
37
37
|
* </li>
|
|
38
38
|
* <li>
|
|
39
|
-
*
|
|
39
|
+
* <p>If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
|
|
40
40
|
* </li>
|
|
41
41
|
* </ul>
|
|
42
|
-
*
|
|
43
42
|
* <p>To successfully create a new queue, you must provide a queue name that adheres to the <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits related to queues</a> and is unique within the scope of your queues.</p>
|
|
44
|
-
*
|
|
43
|
+
* <note>
|
|
45
44
|
* <p>After you create a queue, you must wait at least one second after the queue is
|
|
46
45
|
* created to be able to use the queue.</p>
|
|
47
|
-
*
|
|
46
|
+
* </note>
|
|
48
47
|
* <p>To get the queue URL, use the <code>
|
|
49
48
|
* <a>GetQueueUrl</a>
|
|
50
49
|
* </code> action. <code>
|
|
@@ -32,7 +32,7 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
|
|
|
32
32
|
* const input = { // GetQueueAttributesRequest
|
|
33
33
|
* QueueUrl: "STRING_VALUE", // required
|
|
34
34
|
* AttributeNames: [ // AttributeNameList
|
|
35
|
-
* "
|
|
35
|
+
* "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled",
|
|
36
36
|
* ],
|
|
37
37
|
* };
|
|
38
38
|
* const command = new GetQueueAttributesCommand(input);
|
|
@@ -27,7 +27,6 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
|
|
|
27
27
|
* display, the response includes a value for <code>NextToken</code>. Use
|
|
28
28
|
* <code>NextToken</code> as a parameter in your next request to
|
|
29
29
|
* <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
|
|
30
|
-
*
|
|
31
30
|
* <p>For more information about using dead-letter queues, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-dead-letter-queues.html">Using Amazon SQS Dead-Letter Queues</a>
|
|
32
31
|
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
32
|
* @example
|
|
@@ -21,11 +21,11 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>List all cost allocation tags added to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
23
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <note>
|
|
25
25
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
26
26
|
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
27
27
|
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|
|
@@ -21,17 +21,16 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
|
|
23
23
|
* parameter.</p>
|
|
24
|
-
*
|
|
25
24
|
* <important>
|
|
26
25
|
* <p>When you use the <code>PurgeQueue</code> action, you can't retrieve any messages
|
|
27
26
|
* deleted from a queue.</p>
|
|
28
27
|
* <p>The message deletion process takes up to 60 seconds. We recommend waiting for
|
|
29
28
|
* 60 seconds regardless of your queue's size. </p>
|
|
30
29
|
* </important>
|
|
31
|
-
*
|
|
30
|
+
* <p>Messages sent to the queue <i>before</i> you call
|
|
32
31
|
* <code>PurgeQueue</code> might be received but are deleted within the next
|
|
33
32
|
* minute.</p>
|
|
34
|
-
*
|
|
33
|
+
* <p>Messages sent to the queue <i>after</i> you call
|
|
35
34
|
* <code>PurgeQueue</code> might be deleted while the queue is being purged.</p>
|
|
36
35
|
* @example
|
|
37
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -64,7 +64,7 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
|
|
|
64
64
|
* const input = { // ReceiveMessageRequest
|
|
65
65
|
* QueueUrl: "STRING_VALUE", // required
|
|
66
66
|
* AttributeNames: [ // AttributeNameList
|
|
67
|
-
* "
|
|
67
|
+
* "All" || "Policy" || "VisibilityTimeout" || "MaximumMessageSize" || "MessageRetentionPeriod" || "ApproximateNumberOfMessages" || "ApproximateNumberOfMessagesNotVisible" || "CreatedTimestamp" || "LastModifiedTimestamp" || "QueueArn" || "ApproximateNumberOfMessagesDelayed" || "DelaySeconds" || "ReceiveMessageWaitTimeSeconds" || "RedrivePolicy" || "FifoQueue" || "ContentBasedDeduplication" || "KmsMasterKeyId" || "KmsDataKeyReusePeriodSeconds" || "DeduplicationScope" || "FifoThroughputLimit" || "RedriveAllowPolicy" || "SqsManagedSseEnabled",
|
|
68
68
|
* ],
|
|
69
69
|
* MessageAttributeNames: [ // MessageAttributeNameList
|
|
70
70
|
* "STRING_VALUE",
|
|
@@ -24,15 +24,15 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
* <ul>
|
|
25
25
|
* <li>
|
|
26
26
|
* <p>Only the owner of a queue can remove permissions from it.</p>
|
|
27
|
-
*
|
|
27
|
+
* </li>
|
|
28
28
|
* <li>
|
|
29
29
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
30
30
|
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
31
31
|
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
32
|
-
*
|
|
32
|
+
* </li>
|
|
33
33
|
* <li>
|
|
34
34
|
* <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
35
|
-
*
|
|
35
|
+
* </li>
|
|
36
36
|
* </ul>
|
|
37
37
|
* </note>
|
|
38
38
|
* @example
|
|
@@ -24,11 +24,11 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
|
|
|
24
24
|
* <p>The result of sending each message is reported individually in the response. Because the batch request can result in a combination of successful and unsuccessful actions, you should check for batch errors even when the call returns an HTTP status code of <code>200</code>.</p>
|
|
25
25
|
* <p>The maximum allowed individual message size and the maximum total payload size (the sum of the individual lengths of all of the batched messages) are both 256 KB (262,144 bytes).</p>
|
|
26
26
|
* <important>
|
|
27
|
-
*
|
|
28
|
-
*
|
|
27
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
28
|
+
* <p>
|
|
29
29
|
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
30
30
|
* </p>
|
|
31
|
-
*
|
|
31
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
32
32
|
* </important>
|
|
33
33
|
* <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses the default value for the queue.</p>
|
|
34
34
|
* <p>Some actions take lists of parameters. These lists are specified using the <code>param.n</code> notation. Values of <code>n</code> are integers starting from 1. For example, a parameter list with two elements looks like this:</p>
|
|
@@ -21,11 +21,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Delivers a message to the specified queue.</p>
|
|
23
23
|
* <important>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
|
|
25
|
+
* <p>
|
|
26
26
|
* <code>#x9</code> | <code>#xA</code> | <code>#xD</code> | <code>#x20</code> to <code>#xD7FF</code> | <code>#xE000</code> to <code>#xFFFD</code> | <code>#x10000</code> to <code>#x10FFFF</code>
|
|
27
27
|
* </p>
|
|
28
|
-
*
|
|
28
|
+
* <p>Any characters not included in this list will be rejected. For more information, see the <a href="http://www.w3.org/TR/REC-xml/#charsets">W3C specification for characters</a>.</p>
|
|
29
29
|
* </important>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,15 +25,15 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
* <ul>
|
|
26
26
|
* <li>
|
|
27
27
|
* <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>
|
|
28
|
-
*
|
|
28
|
+
* </li>
|
|
29
29
|
* <li>
|
|
30
30
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
31
31
|
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
32
32
|
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
33
|
-
*
|
|
33
|
+
* </li>
|
|
34
34
|
* <li>
|
|
35
35
|
* <p>To remove the ability to change queue permissions, you must deny permission to the <code>AddPermission</code>, <code>RemovePermission</code>, and <code>SetQueueAttributes</code> actions in your IAM policy.</p>
|
|
36
|
-
*
|
|
36
|
+
* </li>
|
|
37
37
|
* </ul>
|
|
38
38
|
* </note>
|
|
39
39
|
* @example
|
|
@@ -21,7 +21,6 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Add cost allocation tags to the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
23
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
25
24
|
* <p>When you use queue tags, keep the following guidelines in mind:</p>
|
|
26
25
|
* <ul>
|
|
27
26
|
* <li>
|
|
@@ -40,11 +39,11 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
|
|
|
40
39
|
* <p>For a full list of tag restrictions, see
|
|
41
40
|
* <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
|
|
42
41
|
* in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
43
|
-
*
|
|
42
|
+
* <note>
|
|
44
43
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
45
44
|
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
46
45
|
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
47
|
-
*
|
|
46
|
+
* </note>
|
|
48
47
|
* @example
|
|
49
48
|
* Use a bare-bones client and the command you need to make an API call.
|
|
50
49
|
* ```javascript
|
|
@@ -21,11 +21,11 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
* @public
|
|
22
22
|
* <p>Remove cost allocation tags from the specified Amazon SQS queue. For an overview, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-tags.html">Tagging
|
|
23
23
|
* Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
24
|
-
*
|
|
24
|
+
* <note>
|
|
25
25
|
* <p>Cross-account permissions don't apply to this action. For more information,
|
|
26
26
|
* see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-customer-managed-policy-examples.html#grant-cross-account-permissions-to-role-and-user-name">Grant
|
|
27
27
|
* cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
|
|
28
|
-
*
|
|
28
|
+
* </note>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
31
|
* ```javascript
|