@aws-sdk/client-sqs 3.325.0 → 3.327.0

package/dist-types/commands/SendMessageCommand.d.ts

@@ -21,11 +21,11 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
  * @public
  * <p>Delivers a message to the specified queue.</p>
  *          <important>
- *            <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
- *            <p>
+ *             <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
+ *             <p>
  *                <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>
  *             </p>
- * 	           <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>
+ *             <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>
  *          </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -68,6 +68,14 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
  * };
  * const command = new SendMessageCommand(input);
  * const response = await client.send(command);
+ * // { // SendMessageResult
+ * //   MD5OfMessageBody: "STRING_VALUE",
+ * //   MD5OfMessageAttributes: "STRING_VALUE",
+ * //   MD5OfMessageSystemAttributes: "STRING_VALUE",
+ * //   MessageId: "STRING_VALUE",
+ * //   SequenceNumber: "STRING_VALUE",
+ * // };
+ *
  * ```
  *
  * @param SendMessageCommandInput - {@link SendMessageCommandInput}
@@ -79,9 +87,70 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
  * @throws {@link InvalidMessageContents} (client fault)
  *  <p>The message contains characters outside the allowed set.</p>
  *
+ * @throws {@link InvalidSecurity} (client fault)
+ *  <p>When the request to a queue is not HTTPS and SigV4.</p>
+ *
+ * @throws {@link KmsAccessDenied} (client fault)
+ *  <p>The caller doesn't have the required KMS access.</p>
+ *
+ * @throws {@link KmsDisabled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link KmsInvalidKeyUsage} (client fault)
+ *  <p>The request was rejected for one of the following reasons:</p>
+ *          <ul>
+ *             <li>
+ *                <p>The KeyUsage value of the KMS key is incompatible with the API
+ *                     operation.</p>
+ *             </li>
+ *             <li>
+ *                <p>The encryption algorithm or signing algorithm specified for the operation is
+ *                     incompatible with the type of key material in the KMS key (KeySpec).</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link KmsInvalidState} (client fault)
+ *  <p>The request was rejected because the state of the specified resource is not valid for
+ *             this request.</p>
+ *
+ * @throws {@link KmsNotFound} (client fault)
+ *  <p>The request was rejected because the specified entity or resource could not be found.
+ *         </p>
+ *
+ * @throws {@link KmsOptInRequired} (client fault)
+ *  <p>The request was rejected because the specified key policy isn't syntactically or
+ *             semantically correct.</p>
+ *
+ * @throws {@link KmsThrottled} (client fault)
+ *  <p>Amazon Web Services KMS throttles requests for the following conditions.</p>
+ *
+ * @throws {@link QueueDoesNotExist} (client fault)
+ *  <p>The specified queue doesn't exist.</p>
+ *
+ * @throws {@link RequestThrottled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The rate of requests per second exceeds the AWS KMS request quota for an
+ *                     account and Region. </p>
+ *             </li>
+ *             <li>
+ *                <p>A burst or sustained high rate of requests to change the state of the same KMS
+ *                     key. This condition is often known as a "hot key."</p>
+ *             </li>
+ *             <li>
+ *                <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
+ *                     might be throttled at a lower-than-expected rate when the Amazon Web Services
+ *                     CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
+ *                     processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
+ *             </li>
+ *          </ul>
+ *
  * @throws {@link UnsupportedOperation} (client fault)
  *  <p>Error code 400. Unsupported operation.</p>
  *
+ * @throws {@link SQSServiceException}
+ * <p>Base exception class for all service exceptions from SQS service.</p>
  *
  */
 export declare class SendMessageCommand extends $Command<SendMessageCommandInput, SendMessageCommandOutput, SQSClientResolvedConfig> {

package/dist-types/commands/SetQueueAttributesCommand.d.ts

@@ -19,21 +19,25 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
 }
 /**
  * @public
- * <p>Sets the value of one or more queue attributes. When you change a queue's attributes, the change can take up to 60 seconds for most of the attributes to propagate throughout the Amazon SQS system.
- *       Changes made to the <code>MessageRetentionPeriod</code> attribute can take up to 15 minutes.</p>
+ * <p>Sets the value of one or more queue attributes. When you change a queue's attributes,
+ *             the change can take up to 60 seconds for most of the attributes to propagate throughout
+ *             the Amazon SQS system. Changes made to the <code>MessageRetentionPeriod</code> attribute can
+ *             take up to 15 minutes and will impact existing messages in the queue potentially causing
+ *             them to be expired and deleted if the <code>MessageRetentionPeriod</code> is reduced
+ *             below the age of existing messages.</p>
  *          <note>
  *             <ul>
  *                <li>
  *                   <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>
- *               </li>
+ *                </li>
  *                <li>
  *                   <p>Cross-account permissions don't apply to this action. For more information,
  * 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
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
- *               </li>
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ *                </li>
  *                <li>
  *                   <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>
- *               </li>
+ *                </li>
  *             </ul>
  *          </note>
  * @example
@@ -50,6 +54,8 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
  * };
  * const command = new SetQueueAttributesCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param SetQueueAttributesCommandInput - {@link SetQueueAttributesCommandInput}
@@ -58,9 +64,51 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
  * @see {@link SetQueueAttributesCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
  *
+ * @throws {@link InvalidAddress} (client fault)
+ *  <p>The <code>accountId</code> is invalid.</p>
+ *
  * @throws {@link InvalidAttributeName} (client fault)
  *  <p>The specified attribute doesn't exist.</p>
  *
+ * @throws {@link InvalidAttributeValue} (client fault)
+ *  <p>A queue attribute value is invalid.</p>
+ *
+ * @throws {@link InvalidSecurity} (client fault)
+ *  <p>When the request to a queue is not HTTPS and SigV4.</p>
+ *
+ * @throws {@link OverLimit} (client fault)
+ *  <p>The specified action violates a limit. For example, <code>ReceiveMessage</code>
+ *             returns this error if the maximum number of in flight messages is reached and
+ *                 <code>AddPermission</code> returns this error if the maximum number of permissions
+ *             for the queue is reached.</p>
+ *
+ * @throws {@link QueueDoesNotExist} (client fault)
+ *  <p>The specified queue doesn't exist.</p>
+ *
+ * @throws {@link RequestThrottled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The rate of requests per second exceeds the AWS KMS request quota for an
+ *                     account and Region. </p>
+ *             </li>
+ *             <li>
+ *                <p>A burst or sustained high rate of requests to change the state of the same KMS
+ *                     key. This condition is often known as a "hot key."</p>
+ *             </li>
+ *             <li>
+ *                <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
+ *                     might be throttled at a lower-than-expected rate when the Amazon Web Services
+ *                     CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
+ *                     processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link UnsupportedOperation} (client fault)
+ *  <p>Error code 400. Unsupported operation.</p>
+ *
+ * @throws {@link SQSServiceException}
+ * <p>Base exception class for all service exceptions from SQS service.</p>
  *
  */
 export declare class SetQueueAttributesCommand extends $Command<SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput, SQSClientResolvedConfig> {

package/dist-types/commands/TagQueueCommand.d.ts

@@ -21,7 +21,6 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  * @public
  * <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
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
- *
  *          <p>When you use queue tags, keep the following guidelines in mind:</p>
  *          <ul>
  *             <li>
@@ -40,11 +39,11 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  *          <p>For a full list of tag restrictions, see
  * <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-limits.html#limits-queues">Quotas related to queues</a>
  * in the <i>Amazon SQS Developer Guide</i>.</p>
- *         <note>
+ *          <note>
  *             <p>Cross-account permissions don't apply to this action. For more information,
  * 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
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
- *         </note>
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -59,6 +58,8 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  * };
  * const command = new TagQueueCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param TagQueueCommandInput - {@link TagQueueCommandInput}
@@ -67,6 +68,39 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  * @see {@link TagQueueCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
  *
+ * @throws {@link InvalidAddress} (client fault)
+ *  <p>The <code>accountId</code> is invalid.</p>
+ *
+ * @throws {@link InvalidSecurity} (client fault)
+ *  <p>When the request to a queue is not HTTPS and SigV4.</p>
+ *
+ * @throws {@link QueueDoesNotExist} (client fault)
+ *  <p>The specified queue doesn't exist.</p>
+ *
+ * @throws {@link RequestThrottled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The rate of requests per second exceeds the AWS KMS request quota for an
+ *                     account and Region. </p>
+ *             </li>
+ *             <li>
+ *                <p>A burst or sustained high rate of requests to change the state of the same KMS
+ *                     key. This condition is often known as a "hot key."</p>
+ *             </li>
+ *             <li>
+ *                <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
+ *                     might be throttled at a lower-than-expected rate when the Amazon Web Services
+ *                     CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
+ *                     processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link UnsupportedOperation} (client fault)
+ *  <p>Error code 400. Unsupported operation.</p>
+ *
+ * @throws {@link SQSServiceException}
+ * <p>Base exception class for all service exceptions from SQS service.</p>
  *
  */
 export declare class TagQueueCommand extends $Command<TagQueueCommandInput, TagQueueCommandOutput, SQSClientResolvedConfig> {

package/dist-types/commands/UntagQueueCommand.d.ts

@@ -21,11 +21,11 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  * @public
  * <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
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
- *         <note>
+ *          <note>
  *             <p>Cross-account permissions don't apply to this action. For more information,
  * 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
- * cross-account permissions to a role and a user name</a> in the <i>Amazon SQS Developer Guide</i>.</p>
- *         </note>
+ * cross-account permissions to a role and a username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -40,6 +40,8 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  * };
  * const command = new UntagQueueCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param UntagQueueCommandInput - {@link UntagQueueCommandInput}
@@ -48,6 +50,39 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  * @see {@link UntagQueueCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
  *
+ * @throws {@link InvalidAddress} (client fault)
+ *  <p>The <code>accountId</code> is invalid.</p>
+ *
+ * @throws {@link InvalidSecurity} (client fault)
+ *  <p>When the request to a queue is not HTTPS and SigV4.</p>
+ *
+ * @throws {@link QueueDoesNotExist} (client fault)
+ *  <p>The specified queue doesn't exist.</p>
+ *
+ * @throws {@link RequestThrottled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The rate of requests per second exceeds the AWS KMS request quota for an
+ *                     account and Region. </p>
+ *             </li>
+ *             <li>
+ *                <p>A burst or sustained high rate of requests to change the state of the same KMS
+ *                     key. This condition is often known as a "hot key."</p>
+ *             </li>
+ *             <li>
+ *                <p>Requests for operations on KMS keys in a Amazon Web Services CloudHSM key store
+ *                     might be throttled at a lower-than-expected rate when the Amazon Web Services
+ *                     CloudHSM cluster associated with the Amazon Web Services CloudHSM key store is
+ *                     processing numerous commands, including those unrelated to the Amazon Web Services CloudHSM key store.</p>
+ *             </li>
+ *          </ul>
+ *
+ * @throws {@link UnsupportedOperation} (client fault)
+ *  <p>Error code 400. Unsupported operation.</p>
+ *
+ * @throws {@link SQSServiceException}
+ * <p>Base exception class for all service exceptions from SQS service.</p>
  *
  */
 export declare class UntagQueueCommand extends $Command<UntagQueueCommandInput, UntagQueueCommandOutput, SQSClientResolvedConfig> {