@aws-sdk/client-sqs 3.295.0 → 3.297.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { ReceiveMessageRequest, ReceiveMessageResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link ReceiveMessageCommand}.
  */
 export interface ReceiveMessageCommandInput extends ReceiveMessageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link ReceiveMessageCommand}.
  */
 export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Retrieves one or more messages (up to 10), from the specified queue. Using the <code>WaitTimeSeconds</code> parameter enables long-poll support.
  *          For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-long-polling.html">Amazon SQS Long Polling</a> in the <i>Amazon SQS Developer Guide</i>.
  *     </p>
@@ -60,6 +65,8 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param ReceiveMessageCommandInput - {@link ReceiveMessageCommandInput}
+ * @returns {@link ReceiveMessageCommandOutput}
  * @see {@link ReceiveMessageCommandInput} for command's `input` shape.
  * @see {@link ReceiveMessageCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -75,11 +82,20 @@ export interface ReceiveMessageCommandOutput extends ReceiveMessageResult, __Met
 export declare class ReceiveMessageCommand extends $Command<ReceiveMessageCommandInput, ReceiveMessageCommandOutput, SQSClientResolvedConfig> {
     readonly input: ReceiveMessageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: ReceiveMessageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ReceiveMessageCommandInput, ReceiveMessageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { RemovePermissionRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link RemovePermissionCommand}.
  */
 export interface RemovePermissionCommandInput extends RemovePermissionRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link RemovePermissionCommand}.
  */
 export interface RemovePermissionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Revokes any permissions in the queue policy that matches the specified <code>Label</code> parameter.</p>
  *          <note>
  *             <ul>
@@ -40,6 +45,8 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param RemovePermissionCommandInput - {@link RemovePermissionCommandInput}
+ * @returns {@link RemovePermissionCommandOutput}
  * @see {@link RemovePermissionCommandInput} for command's `input` shape.
  * @see {@link RemovePermissionCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -49,11 +56,20 @@ export interface RemovePermissionCommandOutput extends __MetadataBearer {
 export declare class RemovePermissionCommand extends $Command<RemovePermissionCommandInput, RemovePermissionCommandOutput, SQSClientResolvedConfig> {
     readonly input: RemovePermissionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: RemovePermissionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RemovePermissionCommandInput, RemovePermissionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SendMessageBatchRequest, SendMessageBatchResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link SendMessageBatchCommand}.
  */
 export interface SendMessageBatchCommandInput extends SendMessageBatchRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendMessageBatchCommand}.
  */
 export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, __MetadataBearer {
 }
 /**
+ * @public
  * <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>
@@ -43,6 +48,8 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
  * const response = await client.send(command);
  * ```
  *
+ * @param SendMessageBatchCommandInput - {@link SendMessageBatchCommandInput}
+ * @returns {@link SendMessageBatchCommandOutput}
  * @see {@link SendMessageBatchCommandInput} for command's `input` shape.
  * @see {@link SendMessageBatchCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -70,11 +77,20 @@ export interface SendMessageBatchCommandOutput extends SendMessageBatchResult, _
 export declare class SendMessageBatchCommand extends $Command<SendMessageBatchCommandInput, SendMessageBatchCommandOutput, SQSClientResolvedConfig> {
     readonly input: SendMessageBatchCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendMessageBatchCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendMessageBatchCommandInput, SendMessageBatchCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SendMessageRequest, SendMessageResult } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link SendMessageCommand}.
  */
 export interface SendMessageCommandInput extends SendMessageRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SendMessageCommand}.
  */
 export interface SendMessageCommandOutput extends SendMessageResult, __MetadataBearer {
 }
 /**
+ * @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>
@@ -32,6 +37,8 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
  * const response = await client.send(command);
  * ```
  *
+ * @param SendMessageCommandInput - {@link SendMessageCommandInput}
+ * @returns {@link SendMessageCommandOutput}
  * @see {@link SendMessageCommandInput} for command's `input` shape.
  * @see {@link SendMessageCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -47,11 +54,20 @@ export interface SendMessageCommandOutput extends SendMessageResult, __MetadataB
 export declare class SendMessageCommand extends $Command<SendMessageCommandInput, SendMessageCommandOutput, SQSClientResolvedConfig> {
     readonly input: SendMessageCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SendMessageCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SendMessageCommandInput, SendMessageCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { SetQueueAttributesRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link SetQueueAttributesCommand}.
  */
 export interface SetQueueAttributesCommandInput extends SetQueueAttributesRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link SetQueueAttributesCommand}.
  */
 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>
  *          <note>
@@ -41,6 +46,8 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param SetQueueAttributesCommandInput - {@link SetQueueAttributesCommandInput}
+ * @returns {@link SetQueueAttributesCommandOutput}
  * @see {@link SetQueueAttributesCommandInput} for command's `input` shape.
  * @see {@link SetQueueAttributesCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface SetQueueAttributesCommandOutput extends __MetadataBearer {
 export declare class SetQueueAttributesCommand extends $Command<SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput, SQSClientResolvedConfig> {
     readonly input: SetQueueAttributesCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: SetQueueAttributesCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<SetQueueAttributesCommandInput, SetQueueAttributesCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagQueueRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link TagQueueCommand}.
  */
 export interface TagQueueCommandInput extends TagQueueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagQueueCommand}.
  */
 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>
  *
@@ -50,6 +55,8 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagQueueCommandInput - {@link TagQueueCommandInput}
+ * @returns {@link TagQueueCommandOutput}
  * @see {@link TagQueueCommandInput} for command's `input` shape.
  * @see {@link TagQueueCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -59,11 +66,20 @@ export interface TagQueueCommandOutput extends __MetadataBearer {
 export declare class TagQueueCommand extends $Command<TagQueueCommandInput, TagQueueCommandOutput, SQSClientResolvedConfig> {
     readonly input: TagQueueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagQueueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagQueueCommandInput, TagQueueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagQueueRequest } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
 /**
+ * @public
+ *
  * The input for {@link UntagQueueCommand}.
  */
 export interface UntagQueueCommandInput extends UntagQueueRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagQueueCommand}.
  */
 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>
@@ -31,6 +36,8 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagQueueCommandInput - {@link UntagQueueCommandInput}
+ * @returns {@link UntagQueueCommandOutput}
  * @see {@link UntagQueueCommandInput} for command's `input` shape.
  * @see {@link UntagQueueCommandOutput} for command's `response` shape.
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -40,11 +47,20 @@ export interface UntagQueueCommandOutput extends __MetadataBearer {
 export declare class UntagQueueCommand extends $Command<UntagQueueCommandInput, UntagQueueCommandOutput, SQSClientResolvedConfig> {
     readonly input: UntagQueueCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagQueueCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagQueueCommandInput, UntagQueueCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SQSServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from SQS service.
  */
 export declare class SQSServiceException extends __ServiceException {