@aws-sdk/client-sqs 3.325.0 → 3.327.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.
Files changed (76) hide show
  1. package/README.md +10 -7
  2. package/dist-cjs/commands/AddPermissionCommand.js +3 -3
  3. package/dist-cjs/commands/ChangeMessageVisibilityBatchCommand.js +3 -3
  4. package/dist-cjs/commands/ChangeMessageVisibilityCommand.js +3 -3
  5. package/dist-cjs/commands/CreateQueueCommand.js +3 -3
  6. package/dist-cjs/commands/DeleteMessageBatchCommand.js +3 -3
  7. package/dist-cjs/commands/DeleteMessageCommand.js +3 -3
  8. package/dist-cjs/commands/DeleteQueueCommand.js +3 -3
  9. package/dist-cjs/commands/GetQueueAttributesCommand.js +3 -3
  10. package/dist-cjs/commands/GetQueueUrlCommand.js +3 -3
  11. package/dist-cjs/commands/ListDeadLetterSourceQueuesCommand.js +3 -3
  12. package/dist-cjs/commands/ListQueueTagsCommand.js +3 -3
  13. package/dist-cjs/commands/ListQueuesCommand.js +3 -3
  14. package/dist-cjs/commands/PurgeQueueCommand.js +3 -3
  15. package/dist-cjs/commands/ReceiveMessageCommand.js +3 -3
  16. package/dist-cjs/commands/RemovePermissionCommand.js +3 -3
  17. package/dist-cjs/commands/SendMessageBatchCommand.js +3 -3
  18. package/dist-cjs/commands/SendMessageCommand.js +3 -3
  19. package/dist-cjs/commands/SetQueueAttributesCommand.js +3 -3
  20. package/dist-cjs/commands/TagQueueCommand.js +3 -3
  21. package/dist-cjs/commands/UntagQueueCommand.js +3 -3
  22. package/dist-cjs/endpoint/ruleset.js +2 -2
  23. package/dist-cjs/models/models_0.js +206 -26
  24. package/dist-cjs/protocols/Aws_json1_0.js +1608 -0
  25. package/dist-es/commands/AddPermissionCommand.js +1 -1
  26. package/dist-es/commands/ChangeMessageVisibilityBatchCommand.js +1 -1
  27. package/dist-es/commands/ChangeMessageVisibilityCommand.js +1 -1
  28. package/dist-es/commands/CreateQueueCommand.js +1 -1
  29. package/dist-es/commands/DeleteMessageBatchCommand.js +1 -1
  30. package/dist-es/commands/DeleteMessageCommand.js +1 -1
  31. package/dist-es/commands/DeleteQueueCommand.js +1 -1
  32. package/dist-es/commands/GetQueueAttributesCommand.js +1 -1
  33. package/dist-es/commands/GetQueueUrlCommand.js +1 -1
  34. package/dist-es/commands/ListDeadLetterSourceQueuesCommand.js +1 -1
  35. package/dist-es/commands/ListQueueTagsCommand.js +1 -1
  36. package/dist-es/commands/ListQueuesCommand.js +1 -1
  37. package/dist-es/commands/PurgeQueueCommand.js +1 -1
  38. package/dist-es/commands/ReceiveMessageCommand.js +1 -1
  39. package/dist-es/commands/RemovePermissionCommand.js +1 -1
  40. package/dist-es/commands/SendMessageBatchCommand.js +1 -1
  41. package/dist-es/commands/SendMessageCommand.js +1 -1
  42. package/dist-es/commands/SetQueueAttributesCommand.js +1 -1
  43. package/dist-es/commands/TagQueueCommand.js +1 -1
  44. package/dist-es/commands/UntagQueueCommand.js +1 -1
  45. package/dist-es/endpoint/ruleset.js +2 -2
  46. package/dist-es/models/models_0.js +189 -20
  47. package/dist-es/protocols/Aws_json1_0.js +1565 -0
  48. package/dist-types/SQS.d.ts +24 -21
  49. package/dist-types/SQSClient.d.ts +24 -21
  50. package/dist-types/commands/AddPermissionCommand.d.ts +55 -26
  51. package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +52 -12
  52. package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +52 -15
  53. package/dist-types/commands/CreateQueueCommand.d.ts +64 -24
  54. package/dist-types/commands/DeleteMessageBatchCommand.d.ts +49 -10
  55. package/dist-types/commands/DeleteMessageCommand.d.ts +33 -1
  56. package/dist-types/commands/DeleteQueueCommand.d.ts +48 -8
  57. package/dist-types/commands/GetQueueAttributesCommand.d.ts +37 -1
  58. package/dist-types/commands/GetQueueUrlCommand.d.ts +41 -4
  59. package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +48 -11
  60. package/dist-types/commands/ListQueueTagsCommand.d.ts +44 -4
  61. package/dist-types/commands/ListQueuesCommand.d.ts +49 -10
  62. package/dist-types/commands/PurgeQueueCommand.d.ts +40 -7
  63. package/dist-types/commands/ReceiveMessageCommand.d.ts +118 -15
  64. package/dist-types/commands/RemovePermissionCommand.d.ts +41 -5
  65. package/dist-types/commands/SendMessageBatchCommand.d.ts +99 -16
  66. package/dist-types/commands/SendMessageCommand.d.ts +72 -3
  67. package/dist-types/commands/SetQueueAttributesCommand.d.ts +54 -6
  68. package/dist-types/commands/TagQueueCommand.d.ts +38 -4
  69. package/dist-types/commands/UntagQueueCommand.d.ts +38 -3
  70. package/dist-types/models/models_0.d.ts +1039 -493
  71. package/dist-types/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +40 -40
  72. package/dist-types/ts3.4/models/models_0.d.ts +119 -52
  73. package/package.json +8 -9
  74. package/dist-cjs/protocols/Aws_query.js +0 -2127
  75. package/dist-es/protocols/Aws_query.js +0 -2084
  76. /package/dist-types/ts3.4/protocols/{Aws_query.d.ts → Aws_json1_0.d.ts} +0 -0
@@ -23,53 +23,53 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
23
23
  * the request. Keep the following in mind:</p>
24
24
  * <ul>
25
25
  * <li>
26
- * <p>If you don't specify the <code>FifoQueue</code> attribute, Amazon SQS creates a standard queue.</p>
27
- * <note>
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
- * </note>
33
+ * </note>
34
34
  * </li>
35
35
  * <li>
36
- * <p>If you don't provide a value for an attribute, the queue is created with the default value for the attribute.</p>
36
+ * <p>If you don't provide a value for an attribute, the queue is created with the
37
+ * default value for the attribute.</p>
37
38
  * </li>
38
39
  * <li>
39
- * <p>If you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
40
+ * <p>If you delete a queue, you must wait at least 60 seconds before creating a
41
+ * queue with the same name.</p>
40
42
  * </li>
41
43
  * </ul>
42
- *
43
- * <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
- * <note>
44
+ * <p>To successfully create a new queue, you must provide a queue name that adheres to the
45
+ * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-queues.html">limits
46
+ * related to queues</a> and is unique within the scope of your queues.</p>
47
+ * <note>
45
48
  * <p>After you create a queue, you must wait at least one second after the queue is
46
49
  * created to be able to use the queue.</p>
47
- * </note>
50
+ * </note>
48
51
  * <p>To get the queue URL, use the <code>
49
52
  * <a>GetQueueUrl</a>
50
- * </code> action. <code>
53
+ * </code> action.
54
+ * <code>
51
55
  * <a>GetQueueUrl</a>
52
- * </code> requires only the <code>QueueName</code> parameter.
53
- * be aware of existing queue names:</p>
56
+ * </code> requires only the
57
+ * <code>QueueName</code> parameter. be aware of existing queue names:</p>
54
58
  * <ul>
55
59
  * <li>
56
- * <p>If you provide the name of an existing queue along with the exact names and values of all the queue's attributes, <code>CreateQueue</code> returns the queue URL for the existing queue.</p>
60
+ * <p>If you provide the name of an existing queue along with the exact names and
61
+ * values of all the queue's attributes, <code>CreateQueue</code> returns the queue
62
+ * URL for the existing queue.</p>
57
63
  * </li>
58
64
  * <li>
59
- * <p>If the queue name, attribute names, or attribute values don't match an existing queue, <code>CreateQueue</code> returns an error.</p>
65
+ * <p>If the queue name, attribute names, or attribute values don't match an
66
+ * existing queue, <code>CreateQueue</code> returns an error.</p>
60
67
  * </li>
61
68
  * </ul>
62
- * <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>
63
- * <p>
64
- * <code>&AttributeName.1=first</code>
65
- * </p>
66
- * <p>
67
- * <code>&AttributeName.2=second</code>
68
- * </p>
69
69
  * <note>
70
70
  * <p>Cross-account permissions don't apply to this action. For more information,
71
71
  * 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
72
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
72
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
73
73
  * </note>
74
74
  * @example
75
75
  * Use a bare-bones client and the command you need to make an API call.
@@ -79,15 +79,19 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
79
79
  * const client = new SQSClient(config);
80
80
  * const input = { // CreateQueueRequest
81
81
  * QueueName: "STRING_VALUE", // required
82
- * tags: { // TagMap
82
+ * Attributes: { // QueueAttributeMap
83
83
  * "<keys>": "STRING_VALUE",
84
84
  * },
85
- * Attributes: { // QueueAttributeMap
85
+ * tags: { // TagMap
86
86
  * "<keys>": "STRING_VALUE",
87
87
  * },
88
88
  * };
89
89
  * const command = new CreateQueueCommand(input);
90
90
  * const response = await client.send(command);
91
+ * // { // CreateQueueResult
92
+ * // QueueUrl: "STRING_VALUE",
93
+ * // };
94
+ *
91
95
  * ```
92
96
  *
93
97
  * @param CreateQueueCommandInput - {@link CreateQueueCommandInput}
@@ -96,6 +100,18 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
96
100
  * @see {@link CreateQueueCommandOutput} for command's `response` shape.
97
101
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
98
102
  *
103
+ * @throws {@link InvalidAddress} (client fault)
104
+ * <p>The <code>accountId</code> is invalid.</p>
105
+ *
106
+ * @throws {@link InvalidAttributeName} (client fault)
107
+ * <p>The specified attribute doesn't exist.</p>
108
+ *
109
+ * @throws {@link InvalidAttributeValue} (client fault)
110
+ * <p>A queue attribute value is invalid.</p>
111
+ *
112
+ * @throws {@link InvalidSecurity} (client fault)
113
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
114
+ *
99
115
  * @throws {@link QueueDeletedRecently} (client fault)
100
116
  * <p>You must wait 60 seconds after deleting a queue before you can create another queue
101
117
  * with the same name.</p>
@@ -104,6 +120,30 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
104
120
  * <p>A queue with this name already exists. Amazon SQS returns this error only if the request
105
121
  * includes attributes whose values differ from those of the existing queue.</p>
106
122
  *
123
+ * @throws {@link RequestThrottled} (client fault)
124
+ * <p>The request was denied due to request throttling.</p>
125
+ * <ul>
126
+ * <li>
127
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
128
+ * account and Region. </p>
129
+ * </li>
130
+ * <li>
131
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
132
+ * key. This condition is often known as a "hot key."</p>
133
+ * </li>
134
+ * <li>
135
+ * <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
136
+ * might be throttled at a lower-than-expected rate when the Amazon Web Services
137
+ * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
138
+ * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
139
+ * </li>
140
+ * </ul>
141
+ *
142
+ * @throws {@link UnsupportedOperation} (client fault)
143
+ * <p>Error code 400. Unsupported operation.</p>
144
+ *
145
+ * @throws {@link SQSServiceException}
146
+ * <p>Base exception class for all service exceptions from SQS service.</p>
107
147
  *
108
148
  */
109
149
  export declare class CreateQueueCommand extends $Command<CreateQueueCommandInput, CreateQueueCommandOutput, SQSClientResolvedConfig> {
@@ -19,18 +19,13 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
23
- * <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
22
+ * <p>Deletes up to ten messages from the specified queue. This is a batch version of
23
+ * <code>
24
+ * <a>DeleteMessage</a>.</code> The result of the action on each
25
+ * message is reported individually in the response.</p>
24
26
  * <important>
25
27
  * <p>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>
26
28
  * </important>
27
- * <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>
28
- * <p>
29
- * <code>&AttributeName.1=first</code>
30
- * </p>
31
- * <p>
32
- * <code>&AttributeName.2=second</code>
33
- * </p>
34
29
  * @example
35
30
  * Use a bare-bones client and the command you need to make an API call.
36
31
  * ```javascript
@@ -48,6 +43,22 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
48
43
  * };
49
44
  * const command = new DeleteMessageBatchCommand(input);
50
45
  * const response = await client.send(command);
46
+ * // { // DeleteMessageBatchResult
47
+ * // Successful: [ // DeleteMessageBatchResultEntryList // required
48
+ * // { // DeleteMessageBatchResultEntry
49
+ * // Id: "STRING_VALUE", // required
50
+ * // },
51
+ * // ],
52
+ * // Failed: [ // BatchResultErrorEntryList // required
53
+ * // { // BatchResultErrorEntry
54
+ * // Id: "STRING_VALUE", // required
55
+ * // SenderFault: true || false, // required
56
+ * // Code: "STRING_VALUE", // required
57
+ * // Message: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // };
61
+ *
51
62
  * ```
52
63
  *
53
64
  * @param DeleteMessageBatchCommandInput - {@link DeleteMessageBatchCommandInput}
@@ -63,11 +74,39 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
63
74
  * <p>The batch request doesn't contain any entries.</p>
64
75
  *
65
76
  * @throws {@link InvalidBatchEntryId} (client fault)
66
- * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
77
+ * <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
78
+ * specification.</p>
79
+ *
80
+ * @throws {@link QueueDoesNotExist} (client fault)
81
+ * <p>The specified queue doesn't exist.</p>
82
+ *
83
+ * @throws {@link RequestThrottled} (client fault)
84
+ * <p>The request was denied due to request throttling.</p>
85
+ * <ul>
86
+ * <li>
87
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
88
+ * account and Region. </p>
89
+ * </li>
90
+ * <li>
91
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
92
+ * key. This condition is often known as a "hot key."</p>
93
+ * </li>
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>
99
+ * </li>
100
+ * </ul>
67
101
  *
68
102
  * @throws {@link TooManyEntriesInBatchRequest} (client fault)
69
103
  * <p>The batch request contains more entries than permissible.</p>
70
104
  *
105
+ * @throws {@link UnsupportedOperation} (client fault)
106
+ * <p>Error code 400. Unsupported operation.</p>
107
+ *
108
+ * @throws {@link SQSServiceException}
109
+ * <p>Base exception class for all service exceptions from SQS service.</p>
71
110
  *
72
111
  */
73
112
  export declare class DeleteMessageBatchCommand extends $Command<DeleteMessageBatchCommandInput, DeleteMessageBatchCommandOutput, SQSClientResolvedConfig> {
@@ -31,7 +31,7 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
31
31
  * once, the <code>ReceiptHandle</code> is different each time you receive a message.
32
32
  * When you use the <code>DeleteMessage</code> action, you must provide the most
33
33
  * recently received <code>ReceiptHandle</code> for the message (otherwise, the request
34
- * succeeds, but the message might not be deleted).</p>
34
+ * succeeds, but the message will not be deleted).</p>
35
35
  * <p>For standard queues, it is possible to receive a message even after you
36
36
  * delete it. This might happen on rare occasions if one of the servers which stores a
37
37
  * copy of the message is unavailable when you send the request to delete the message.
@@ -51,6 +51,8 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
51
51
  * };
52
52
  * const command = new DeleteMessageCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // {};
55
+ *
54
56
  * ```
55
57
  *
56
58
  * @param DeleteMessageCommandInput - {@link DeleteMessageCommandInput}
@@ -62,9 +64,39 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
62
64
  * @throws {@link InvalidIdFormat} (client fault)
63
65
  * <p>The specified receipt handle isn't valid for the current version.</p>
64
66
  *
67
+ * @throws {@link InvalidSecurity} (client fault)
68
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
69
+ *
70
+ * @throws {@link QueueDoesNotExist} (client fault)
71
+ * <p>The specified queue doesn't exist.</p>
72
+ *
65
73
  * @throws {@link ReceiptHandleIsInvalid} (client fault)
66
74
  * <p>The specified receipt handle isn't valid.</p>
67
75
  *
76
+ * @throws {@link RequestThrottled} (client fault)
77
+ * <p>The request was denied due to request throttling.</p>
78
+ * <ul>
79
+ * <li>
80
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
81
+ * account and Region. </p>
82
+ * </li>
83
+ * <li>
84
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
85
+ * key. This condition is often known as a "hot key."</p>
86
+ * </li>
87
+ * <li>
88
+ * <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
89
+ * might be throttled at a lower-than-expected rate when the Amazon Web Services
90
+ * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
91
+ * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
92
+ * </li>
93
+ * </ul>
94
+ *
95
+ * @throws {@link UnsupportedOperation} (client fault)
96
+ * <p>Error code 400. Unsupported operation.</p>
97
+ *
98
+ * @throws {@link SQSServiceException}
99
+ * <p>Base exception class for all service exceptions from SQS service.</p>
68
100
  *
69
101
  */
70
102
  export declare class DeleteMessageCommand extends $Command<DeleteMessageCommandInput, DeleteMessageCommandOutput, SQSClientResolvedConfig> {
@@ -19,20 +19,25 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
22
+ * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's
23
+ * contents.</p>
23
24
  * <important>
24
- * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
25
- * </p>
25
+ * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any
26
+ * messages in the queue are no longer available. </p>
26
27
  * </important>
27
- * <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you send involving that queue during the 60 seconds might succeed. For example, a
28
- * <code>
28
+ * <p>When you delete a queue, the deletion process takes up to 60 seconds. Requests you
29
+ * send involving that queue during the 60 seconds might succeed. For example, a
30
+ * <code>
29
31
  * <a>SendMessage</a>
30
- * </code> request might succeed, but after 60 seconds the queue and the message you sent no longer exist.</p>
31
- * <p>When you delete a queue, you must wait at least 60 seconds before creating a queue with the same name.</p>
32
+ * </code> request might succeed, but after 60
33
+ * seconds the queue and the message you sent no longer exist.</p>
34
+ * <p>When you delete a queue, you must wait at least 60 seconds before creating a queue
35
+ * with the same name.</p>
32
36
  * <note>
33
37
  * <p>Cross-account permissions don't apply to this action. For more information,
34
38
  * 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
35
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
39
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
40
+ * <p>The delete operation uses the HTTP <code>GET</code> verb.</p>
36
41
  * </note>
37
42
  * @example
38
43
  * Use a bare-bones client and the command you need to make an API call.
@@ -45,6 +50,8 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
45
50
  * };
46
51
  * const command = new DeleteQueueCommand(input);
47
52
  * const response = await client.send(command);
53
+ * // {};
54
+ *
48
55
  * ```
49
56
  *
50
57
  * @param DeleteQueueCommandInput - {@link DeleteQueueCommandInput}
@@ -53,6 +60,39 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
53
60
  * @see {@link DeleteQueueCommandOutput} for command's `response` shape.
54
61
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
55
62
  *
63
+ * @throws {@link InvalidAddress} (client fault)
64
+ * <p>The <code>accountId</code> is invalid.</p>
65
+ *
66
+ * @throws {@link InvalidSecurity} (client fault)
67
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
68
+ *
69
+ * @throws {@link QueueDoesNotExist} (client fault)
70
+ * <p>The specified queue doesn't exist.</p>
71
+ *
72
+ * @throws {@link RequestThrottled} (client fault)
73
+ * <p>The request was denied due to request throttling.</p>
74
+ * <ul>
75
+ * <li>
76
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
77
+ * account and Region. </p>
78
+ * </li>
79
+ * <li>
80
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
81
+ * key. This condition is often known as a "hot key."</p>
82
+ * </li>
83
+ * <li>
84
+ * <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
85
+ * might be throttled at a lower-than-expected rate when the Amazon Web Services
86
+ * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
87
+ * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
88
+ * </li>
89
+ * </ul>
90
+ *
91
+ * @throws {@link UnsupportedOperation} (client fault)
92
+ * <p>Error code 400. Unsupported operation.</p>
93
+ *
94
+ * @throws {@link SQSServiceException}
95
+ * <p>Base exception class for all service exceptions from SQS service.</p>
56
96
  *
57
97
  */
58
98
  export declare class DeleteQueueCommand extends $Command<DeleteQueueCommandInput, DeleteQueueCommandOutput, SQSClientResolvedConfig> {
@@ -32,11 +32,17 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
32
32
  * const input = { // GetQueueAttributesRequest
33
33
  * QueueUrl: "STRING_VALUE", // required
34
34
  * AttributeNames: [ // AttributeNameList
35
- * "STRING_VALUE",
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);
39
39
  * const response = await client.send(command);
40
+ * // { // GetQueueAttributesResult
41
+ * // Attributes: { // QueueAttributeMap
42
+ * // "<keys>": "STRING_VALUE",
43
+ * // },
44
+ * // };
45
+ *
40
46
  * ```
41
47
  *
42
48
  * @param GetQueueAttributesCommandInput - {@link GetQueueAttributesCommandInput}
@@ -48,6 +54,36 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
48
54
  * @throws {@link InvalidAttributeName} (client fault)
49
55
  * <p>The specified attribute doesn't exist.</p>
50
56
  *
57
+ * @throws {@link InvalidSecurity} (client fault)
58
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
59
+ *
60
+ * @throws {@link QueueDoesNotExist} (client fault)
61
+ * <p>The specified queue doesn't exist.</p>
62
+ *
63
+ * @throws {@link RequestThrottled} (client fault)
64
+ * <p>The request was denied due to request throttling.</p>
65
+ * <ul>
66
+ * <li>
67
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
68
+ * account and Region. </p>
69
+ * </li>
70
+ * <li>
71
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
72
+ * key. This condition is often known as a "hot key."</p>
73
+ * </li>
74
+ * <li>
75
+ * <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
76
+ * might be throttled at a lower-than-expected rate when the Amazon Web Services
77
+ * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
78
+ * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
79
+ * </li>
80
+ * </ul>
81
+ *
82
+ * @throws {@link UnsupportedOperation} (client fault)
83
+ * <p>Error code 400. Unsupported operation.</p>
84
+ *
85
+ * @throws {@link SQSServiceException}
86
+ * <p>Base exception class for all service exceptions from SQS service.</p>
51
87
  *
52
88
  */
53
89
  export declare class GetQueueAttributesCommand extends $Command<GetQueueAttributesCommandInput, GetQueueAttributesCommandOutput, SQSClientResolvedConfig> {
@@ -20,11 +20,14 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
20
20
  /**
21
21
  * @public
22
22
  * <p>Returns the URL of an existing Amazon SQS queue.</p>
23
- * <p>To access a queue that belongs to another AWS account, use the <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the queue's owner. The queue's owner must grant you permission to access the queue.
24
- * For more information about shared queue access, see <code>
23
+ * <p>To access a queue that belongs to another AWS account, use the
24
+ * <code>QueueOwnerAWSAccountId</code> parameter to specify the account ID of the
25
+ * queue's owner. The queue's owner must grant you permission to access the queue. For more
26
+ * information about shared queue access, see <code>
25
27
  * <a>AddPermission</a>
26
- * </code> or see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue">Allow Developers to Write Messages to a Shared Queue</a> in the <i>Amazon SQS Developer Guide</i>.
27
- * </p>
28
+ * </code>
29
+ * or see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-writing-an-sqs-policy.html#write-messages-to-shared-queue">Allow Developers to Write Messages to a Shared Queue</a> in the <i>Amazon SQS
30
+ * Developer Guide</i>. </p>
28
31
  * @example
29
32
  * Use a bare-bones client and the command you need to make an API call.
30
33
  * ```javascript
@@ -37,6 +40,10 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
37
40
  * };
38
41
  * const command = new GetQueueUrlCommand(input);
39
42
  * const response = await client.send(command);
43
+ * // { // GetQueueUrlResult
44
+ * // QueueUrl: "STRING_VALUE",
45
+ * // };
46
+ *
40
47
  * ```
41
48
  *
42
49
  * @param GetQueueUrlCommandInput - {@link GetQueueUrlCommandInput}
@@ -45,9 +52,39 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
45
52
  * @see {@link GetQueueUrlCommandOutput} for command's `response` shape.
46
53
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
47
54
  *
55
+ * @throws {@link InvalidAddress} (client fault)
56
+ * <p>The <code>accountId</code> is invalid.</p>
57
+ *
58
+ * @throws {@link InvalidSecurity} (client fault)
59
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
60
+ *
48
61
  * @throws {@link QueueDoesNotExist} (client fault)
49
62
  * <p>The specified queue doesn't exist.</p>
50
63
  *
64
+ * @throws {@link RequestThrottled} (client fault)
65
+ * <p>The request was denied due to request throttling.</p>
66
+ * <ul>
67
+ * <li>
68
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
69
+ * account and Region. </p>
70
+ * </li>
71
+ * <li>
72
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
73
+ * key. This condition is often known as a "hot key."</p>
74
+ * </li>
75
+ * <li>
76
+ * <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
77
+ * might be throttled at a lower-than-expected rate when the Amazon Web Services
78
+ * CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
79
+ * processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
80
+ * </li>
81
+ * </ul>
82
+ *
83
+ * @throws {@link UnsupportedOperation} (client fault)
84
+ * <p>Error code 400. Unsupported operation.</p>
85
+ *
86
+ * @throws {@link SQSServiceException}
87
+ * <p>Base exception class for all service exceptions from SQS service.</p>
51
88
  *
52
89
  */
53
90
  export declare class GetQueueUrlCommand extends $Command<GetQueueUrlCommandInput, GetQueueUrlCommandOutput, SQSClientResolvedConfig> {
@@ -19,17 +19,17 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
19
19
  }
20
20
  /**
21
21
  * @public
22
- * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
23
- * <p> The <code>ListDeadLetterSourceQueues</code> methods supports
24
- * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
25
- * results to be returned in the response. If you do not set <code>MaxResults</code>,
26
- * the response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and there are additional results to
27
- * display, the response includes a value for <code>NextToken</code>. Use
28
- * <code>NextToken</code> as a parameter in your next request to
29
- * <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
30
- *
31
- * <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
- * in the <i>Amazon SQS Developer Guide</i>.</p>
22
+ * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute
23
+ * configured with a dead-letter queue.</p>
24
+ * <p> The <code>ListDeadLetterSourceQueues</code> methods supports pagination. Set
25
+ * parameter <code>MaxResults</code> in the request to specify the maximum number of
26
+ * results to be returned in the response. If you do not set <code>MaxResults</code>, the
27
+ * response includes a maximum of 1,000 results. If you set <code>MaxResults</code> and
28
+ * there are additional results to display, the response includes a value for
29
+ * <code>NextToken</code>. Use <code>NextToken</code> as a parameter in your next
30
+ * request to <code>ListDeadLetterSourceQueues</code> to receive the next page of results. </p>
31
+ * <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> in the <i>Amazon SQS Developer
32
+ * Guide</i>.</p>
33
33
  * @example
34
34
  * Use a bare-bones client and the command you need to make an API call.
35
35
  * ```javascript
@@ -43,6 +43,13 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
43
43
  * };
44
44
  * const command = new ListDeadLetterSourceQueuesCommand(input);
45
45
  * const response = await client.send(command);
46
+ * // { // ListDeadLetterSourceQueuesResult
47
+ * // queueUrls: [ // QueueUrlList // required
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // NextToken: "STRING_VALUE",
51
+ * // };
52
+ *
46
53
  * ```
47
54
  *
48
55
  * @param ListDeadLetterSourceQueuesCommandInput - {@link ListDeadLetterSourceQueuesCommandInput}
@@ -51,9 +58,39 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
51
58
  * @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape.
52
59
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
53
60
  *
61
+ * @throws {@link InvalidAddress} (client fault)
62
+ * <p>The <code>accountId</code> is invalid.</p>
63
+ *
64
+ * @throws {@link InvalidSecurity} (client fault)
65
+ * <p>When the request to a queue is not HTTPS and SigV4.</p>
66
+ *
54
67
  * @throws {@link QueueDoesNotExist} (client fault)
55
68
  * <p>The specified queue doesn't exist.</p>
56
69
  *
70
+ * @throws {@link RequestThrottled} (client fault)
71
+ * <p>The request was denied due to request throttling.</p>
72
+ * <ul>
73
+ * <li>
74
+ * <p>The rate of requests per second exceeds the AWS KMS request quota for an
75
+ * account and Region. </p>
76
+ * </li>
77
+ * <li>
78
+ * <p>A burst or sustained high rate of requests to change the state of the same KMS
79
+ * key. This condition is often known as a "hot key."</p>
80
+ * </li>
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>
86
+ * </li>
87
+ * </ul>
88
+ *
89
+ * @throws {@link UnsupportedOperation} (client fault)
90
+ * <p>Error code 400. Unsupported operation.</p>
91
+ *
92
+ * @throws {@link SQSServiceException}
93
+ * <p>Base exception class for all service exceptions from SQS service.</p>
57
94
  *
58
95
  */
59
96
  export declare class ListDeadLetterSourceQueuesCommand extends $Command<ListDeadLetterSourceQueuesCommandInput, ListDeadLetterSourceQueuesCommandOutput, SQSClientResolvedConfig> {