@aws-sdk/client-sqs 3.327.0 → 3.328.0

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

@@ -19,16 +19,10 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
 }
 /**
  * @public
- * <p>You can use <code>SendMessageBatch</code> to send up to 10 messages to the specified
- *             queue by assigning either identical or different values to each message (or by not
- *             assigning values at all). This is a batch version of <code>
- *                <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued
- *             in the order they are sent.</p>
- *          <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>
- *          <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 KiB (262,144
- *             bytes).</p>
+ * <p>Delivers up to ten messages to the specified queue. This is a batch version of <code>
+ *                <a>SendMessage</a>.</code> For a FIFO queue, multiple messages within a single batch are enqueued in the order they are sent.</p>
+ *          <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>
+ *          <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>
  *          <important>
  *             <p>A message can include only XML, JSON, and unformatted text. The following Unicode characters are allowed:</p>
  *             <p>
@@ -36,8 +30,14 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
  *             </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>
- *          <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses
- *             the default value for the queue.</p>
+ *          <p>If you don't specify the <code>DelaySeconds</code> parameter for an entry, Amazon SQS uses the default value for the queue.</p>
+ *          <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>
+ *          <p>
+ *             <code>&AttributeName.1=first</code>
+ *          </p>
+ *          <p>
+ *             <code>&AttributeName.2=second</code>
+ *          </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -123,67 +123,7 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
  *  <p>The batch request doesn't contain any entries.</p>
  *
  * @throws {@link InvalidBatchEntryId} (client fault)
- *  <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the
- *             specification.</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>
+ *  <p>The <code>Id</code> of a batch entry in a batch request doesn't abide by the specification.</p>
  *
  * @throws {@link TooManyEntriesInBatchRequest} (client fault)
  *  <p>The batch request contains more entries than permissible.</p>

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

@@ -87,65 +87,6 @@ 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>
  *

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

@@ -19,12 +19,8 @@ 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 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>
+ * <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>
  *          <note>
  *             <ul>
  *                <li>
@@ -33,7 +29,7 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
  *                <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 username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * cross-account permissions to a role and a user name</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>
@@ -64,49 +60,9 @@ 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>
  *

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

@@ -42,7 +42,7 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  *          <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 username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * cross-account permissions to a role and a user name</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.
@@ -68,37 +68,6 @@ 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>
  *

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

@@ -24,7 +24,7 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  *          <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 username</a> in the <i>Amazon SQS Developer Guide</i>.</p>
+ * cross-account permissions to a role and a user name</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.
@@ -50,37 +50,6 @@ 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>
  *