@aws-sdk/client-sqs 3.441.0 → 3.446.0

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

@@ -25,11 +25,16 @@ 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>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>
+ *                <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.
@@ -88,9 +93,71 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
  * @see {@link SendMessageCommandOutput} 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 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 Amazon Web Services 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

@@ -25,22 +25,26 @@ 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>
+ *             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>
+ *                   <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>
- *                   <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>
+ *                   <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>
  *                </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>
+ *                   <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>
  *             </ul>
  *          </note>
@@ -68,9 +72,49 @@ 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 Amazon Web Services 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/StartMessageMoveTaskCommand.d.ts

@@ -74,6 +74,31 @@ export interface StartMessageMoveTaskCommandOutput extends StartMessageMoveTaskR
  * @see {@link StartMessageMoveTaskCommandOutput} 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 RequestThrottled} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *          <ul>
+ *             <li>
+ *                <p>The rate of requests per second exceeds the Amazon Web Services 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 ResourceNotFoundException} (client fault)
  *  <p>One or more specified resources don't exist.</p>
  *

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

@@ -23,30 +23,33 @@ 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>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>
  *                <p>Adding more than 50 tags to a queue isn't recommended.</p>
  *             </li>
  *             <li>
- *                <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character strings.</p>
+ *                <p>Tags don't have any semantic meaning. Amazon SQS interprets tags as character
+ *                     strings.</p>
  *             </li>
  *             <li>
  *                <p>Tags are case-sensitive.</p>
  *             </li>
  *             <li>
- *                <p>A new tag with a key identical to that of an existing tag overwrites the existing tag.</p>
+ *                <p>A new tag with a key identical to that of an existing tag overwrites the
+ *                     existing tag.</p>
  *             </li>
  *          </ul>
- *          <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>
+ *          <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>
- *             <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>
+ *             <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>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -72,6 +75,37 @@ 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 Amazon Web Services 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

@@ -23,12 +23,14 @@ 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>
+ * <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>
- *             <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>
+ *             <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>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -54,6 +56,37 @@ 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 Amazon Web Services 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/index.d.ts

@@ -1,14 +1,14 @@
 /**
  * <p>Welcome to the <i>Amazon SQS API Reference</i>.</p>
- *          <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>
+ *          <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>
  *          <p>For information on the permissions you need to use this API, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-authentication-and-access-control.html">Identity and access management</a> in the <i>Amazon SQS Developer
  *                 Guide.</i>
  *          </p>
- *          <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>
+ *          <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>
  *          <ul>
  *             <li>
  *                <p>Cryptographically sign your service requests</p>
@@ -53,7 +53,8 @@
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line Interface</i>
+ *                   <a href="http://docs.aws.amazon.com/cli/latest/reference/sqs/index.html">Amazon SQS in the <i>Command Line
+ *                             Interface</i>
  *                   </a>
  *                </p>
  *             </li>
@@ -77,6 +78,8 @@
 export * from "./SQSClient";
 export * from "./SQS";
 export { ClientInputEndpointParameters } from "./endpoint/EndpointParameters";
+export { RuntimeExtension } from "./runtimeExtensions";
+export { SQSExtensionConfiguration } from "./extensionConfiguration";
 export * from "./commands";
 export * from "./pagination";
 export * from "./models";