@aws-sdk/client-sqs 3.295.0 → 3.297.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 (30) hide show
  1. package/dist-cjs/protocols/Aws_query.js +17 -78
  2. package/dist-es/protocols/Aws_query.js +17 -78
  3. package/dist-types/SQS.d.ts +21 -0
  4. package/dist-types/SQSClient.d.ts +24 -4
  5. package/dist-types/commands/AddPermissionCommand.d.ts +16 -0
  6. package/dist-types/commands/ChangeMessageVisibilityBatchCommand.d.ts +16 -0
  7. package/dist-types/commands/ChangeMessageVisibilityCommand.d.ts +16 -0
  8. package/dist-types/commands/CreateQueueCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteMessageBatchCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteMessageCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteQueueCommand.d.ts +16 -0
  12. package/dist-types/commands/GetQueueAttributesCommand.d.ts +16 -0
  13. package/dist-types/commands/GetQueueUrlCommand.d.ts +16 -0
  14. package/dist-types/commands/ListDeadLetterSourceQueuesCommand.d.ts +16 -0
  15. package/dist-types/commands/ListQueueTagsCommand.d.ts +16 -0
  16. package/dist-types/commands/ListQueuesCommand.d.ts +16 -0
  17. package/dist-types/commands/PurgeQueueCommand.d.ts +16 -0
  18. package/dist-types/commands/ReceiveMessageCommand.d.ts +16 -0
  19. package/dist-types/commands/RemovePermissionCommand.d.ts +16 -0
  20. package/dist-types/commands/SendMessageBatchCommand.d.ts +16 -0
  21. package/dist-types/commands/SendMessageCommand.d.ts +16 -0
  22. package/dist-types/commands/SetQueueAttributesCommand.d.ts +16 -0
  23. package/dist-types/commands/TagQueueCommand.d.ts +16 -0
  24. package/dist-types/commands/UntagQueueCommand.d.ts +16 -0
  25. package/dist-types/models/SQSServiceException.d.ts +2 -0
  26. package/dist-types/models/models_0.d.ts +81 -5
  27. package/dist-types/pagination/Interfaces.d.ts +3 -0
  28. package/dist-types/pagination/ListDeadLetterSourceQueuesPaginator.d.ts +3 -0
  29. package/dist-types/pagination/ListQueuesPaginator.d.ts +3 -0
  30. package/package.json +31 -31
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AddPermissionRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link AddPermissionCommand}.
8
10
  */
9
11
  export interface AddPermissionCommandInput extends AddPermissionRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link AddPermissionCommand}.
13
17
  */
14
18
  export interface AddPermissionCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Adds a permission to a queue for a specific
18
23
  * <a href="https://docs.aws.amazon.com/general/latest/gr/glos-chap.html#P">principal</a>.
19
24
  * This allows sharing access to the queue.</p>
@@ -64,6 +69,8 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
64
69
  * const response = await client.send(command);
65
70
  * ```
66
71
  *
72
+ * @param AddPermissionCommandInput - {@link AddPermissionCommandInput}
73
+ * @returns {@link AddPermissionCommandOutput}
67
74
  * @see {@link AddPermissionCommandInput} for command's `input` shape.
68
75
  * @see {@link AddPermissionCommandOutput} for command's `response` shape.
69
76
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -79,11 +86,20 @@ export interface AddPermissionCommandOutput extends __MetadataBearer {
79
86
  export declare class AddPermissionCommand extends $Command<AddPermissionCommandInput, AddPermissionCommandOutput, SQSClientResolvedConfig> {
80
87
  readonly input: AddPermissionCommandInput;
81
88
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
89
+ /**
90
+ * @public
91
+ */
82
92
  constructor(input: AddPermissionCommandInput);
83
93
  /**
84
94
  * @internal
85
95
  */
86
96
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AddPermissionCommandInput, AddPermissionCommandOutput>;
97
+ /**
98
+ * @internal
99
+ */
87
100
  private serialize;
101
+ /**
102
+ * @internal
103
+ */
88
104
  private deserialize;
89
105
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChangeMessageVisibilityBatchRequest, ChangeMessageVisibilityBatchResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ChangeMessageVisibilityBatchCommand}.
8
10
  */
9
11
  export interface ChangeMessageVisibilityBatchCommandInput extends ChangeMessageVisibilityBatchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ChangeMessageVisibilityBatchCommand}.
13
17
  */
14
18
  export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessageVisibilityBatchResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the visibility timeout of multiple messages. This is a batch version of <code>
18
23
  * <a>ChangeMessageVisibility</a>.</code> The result of the action on each message is reported individually in the response.
19
24
  * You can send up to 10 <code>
@@ -39,6 +44,8 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param ChangeMessageVisibilityBatchCommandInput - {@link ChangeMessageVisibilityBatchCommandInput}
48
+ * @returns {@link ChangeMessageVisibilityBatchCommandOutput}
42
49
  * @see {@link ChangeMessageVisibilityBatchCommandInput} for command's `input` shape.
43
50
  * @see {@link ChangeMessageVisibilityBatchCommandOutput} for command's `response` shape.
44
51
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ChangeMessageVisibilityBatchCommandOutput extends ChangeMessage
60
67
  export declare class ChangeMessageVisibilityBatchCommand extends $Command<ChangeMessageVisibilityBatchCommandInput, ChangeMessageVisibilityBatchCommandOutput, SQSClientResolvedConfig> {
61
68
  readonly input: ChangeMessageVisibilityBatchCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: ChangeMessageVisibilityBatchCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ChangeMessageVisibilityBatchCommandInput, ChangeMessageVisibilityBatchCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ChangeMessageVisibilityRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ChangeMessageVisibilityCommand}.
8
10
  */
9
11
  export interface ChangeMessageVisibilityCommandInput extends ChangeMessageVisibilityRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ChangeMessageVisibilityCommand}.
13
17
  */
14
18
  export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Changes the visibility timeout of a specified message in a queue to a new value. The
18
23
  * default visibility timeout for a message is 30 seconds. The minimum is 0 seconds. The
19
24
  * maximum is 12 hours. For more information, see <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html">Visibility Timeout</a> in the <i>Amazon SQS Developer Guide</i>.</p>
@@ -58,6 +63,8 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
58
63
  * const response = await client.send(command);
59
64
  * ```
60
65
  *
66
+ * @param ChangeMessageVisibilityCommandInput - {@link ChangeMessageVisibilityCommandInput}
67
+ * @returns {@link ChangeMessageVisibilityCommandOutput}
61
68
  * @see {@link ChangeMessageVisibilityCommandInput} for command's `input` shape.
62
69
  * @see {@link ChangeMessageVisibilityCommandOutput} for command's `response` shape.
63
70
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -73,11 +80,20 @@ export interface ChangeMessageVisibilityCommandOutput extends __MetadataBearer {
73
80
  export declare class ChangeMessageVisibilityCommand extends $Command<ChangeMessageVisibilityCommandInput, ChangeMessageVisibilityCommandOutput, SQSClientResolvedConfig> {
74
81
  readonly input: ChangeMessageVisibilityCommandInput;
75
82
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
83
+ /**
84
+ * @public
85
+ */
76
86
  constructor(input: ChangeMessageVisibilityCommandInput);
77
87
  /**
78
88
  * @internal
79
89
  */
80
90
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ChangeMessageVisibilityCommandInput, ChangeMessageVisibilityCommandOutput>;
91
+ /**
92
+ * @internal
93
+ */
81
94
  private serialize;
95
+ /**
96
+ * @internal
97
+ */
82
98
  private deserialize;
83
99
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { CreateQueueRequest, CreateQueueResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateQueueCommand}.
8
10
  */
9
11
  export interface CreateQueueCommandInput extends CreateQueueRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateQueueCommand}.
13
17
  */
14
18
  export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a new standard or FIFO queue. You can pass one or more attributes in
18
23
  * the request. Keep the following in mind:</p>
19
24
  * <ul>
@@ -76,6 +81,8 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
76
81
  * const response = await client.send(command);
77
82
  * ```
78
83
  *
84
+ * @param CreateQueueCommandInput - {@link CreateQueueCommandInput}
85
+ * @returns {@link CreateQueueCommandOutput}
79
86
  * @see {@link CreateQueueCommandInput} for command's `input` shape.
80
87
  * @see {@link CreateQueueCommandOutput} for command's `response` shape.
81
88
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -93,11 +100,20 @@ export interface CreateQueueCommandOutput extends CreateQueueResult, __MetadataB
93
100
  export declare class CreateQueueCommand extends $Command<CreateQueueCommandInput, CreateQueueCommandOutput, SQSClientResolvedConfig> {
94
101
  readonly input: CreateQueueCommandInput;
95
102
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
103
+ /**
104
+ * @public
105
+ */
96
106
  constructor(input: CreateQueueCommandInput);
97
107
  /**
98
108
  * @internal
99
109
  */
100
110
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateQueueCommandInput, CreateQueueCommandOutput>;
111
+ /**
112
+ * @internal
113
+ */
101
114
  private serialize;
115
+ /**
116
+ * @internal
117
+ */
102
118
  private deserialize;
103
119
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteMessageBatchRequest, DeleteMessageBatchResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMessageBatchCommand}.
8
10
  */
9
11
  export interface DeleteMessageBatchCommandInput extends DeleteMessageBatchRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMessageBatchCommand}.
13
17
  */
14
18
  export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes up to ten messages from the specified queue. This is a batch version of <code>
18
23
  * <a>DeleteMessage</a>.</code> The result of the action on each message is reported individually in the response.</p>
19
24
  * <important>
@@ -36,6 +41,8 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
36
41
  * const response = await client.send(command);
37
42
  * ```
38
43
  *
44
+ * @param DeleteMessageBatchCommandInput - {@link DeleteMessageBatchCommandInput}
45
+ * @returns {@link DeleteMessageBatchCommandOutput}
39
46
  * @see {@link DeleteMessageBatchCommandInput} for command's `input` shape.
40
47
  * @see {@link DeleteMessageBatchCommandOutput} for command's `response` shape.
41
48
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -57,11 +64,20 @@ export interface DeleteMessageBatchCommandOutput extends DeleteMessageBatchResul
57
64
  export declare class DeleteMessageBatchCommand extends $Command<DeleteMessageBatchCommandInput, DeleteMessageBatchCommandOutput, SQSClientResolvedConfig> {
58
65
  readonly input: DeleteMessageBatchCommandInput;
59
66
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
67
+ /**
68
+ * @public
69
+ */
60
70
  constructor(input: DeleteMessageBatchCommandInput);
61
71
  /**
62
72
  * @internal
63
73
  */
64
74
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessageBatchCommandInput, DeleteMessageBatchCommandOutput>;
75
+ /**
76
+ * @internal
77
+ */
65
78
  private serialize;
79
+ /**
80
+ * @internal
81
+ */
66
82
  private deserialize;
67
83
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteMessageRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteMessageCommand}.
8
10
  */
9
11
  export interface DeleteMessageCommandInput extends DeleteMessageRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteMessageCommand}.
13
17
  */
14
18
  export interface DeleteMessageCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified message from the specified queue. To select the message to
18
23
  * delete, use the <code>ReceiptHandle</code> of the message (<i>not</i> the
19
24
  * <code>MessageId</code> which you receive when you send the message). Amazon SQS can
@@ -44,6 +49,8 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
44
49
  * const response = await client.send(command);
45
50
  * ```
46
51
  *
52
+ * @param DeleteMessageCommandInput - {@link DeleteMessageCommandInput}
53
+ * @returns {@link DeleteMessageCommandOutput}
47
54
  * @see {@link DeleteMessageCommandInput} for command's `input` shape.
48
55
  * @see {@link DeleteMessageCommandOutput} for command's `response` shape.
49
56
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -59,11 +66,20 @@ export interface DeleteMessageCommandOutput extends __MetadataBearer {
59
66
  export declare class DeleteMessageCommand extends $Command<DeleteMessageCommandInput, DeleteMessageCommandOutput, SQSClientResolvedConfig> {
60
67
  readonly input: DeleteMessageCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: DeleteMessageCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteMessageCommandInput, DeleteMessageCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteQueueRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteQueueCommand}.
8
10
  */
9
11
  export interface DeleteQueueCommandInput extends DeleteQueueRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteQueueCommand}.
13
17
  */
14
18
  export interface DeleteQueueCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the queue specified by the <code>QueueUrl</code>, regardless of the queue's contents.</p>
18
23
  * <important>
19
24
  * <p>Be careful with the <code>DeleteQueue</code> action: When you delete a queue, any messages in the queue are no longer available.
@@ -39,6 +44,8 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
39
44
  * const response = await client.send(command);
40
45
  * ```
41
46
  *
47
+ * @param DeleteQueueCommandInput - {@link DeleteQueueCommandInput}
48
+ * @returns {@link DeleteQueueCommandOutput}
42
49
  * @see {@link DeleteQueueCommandInput} for command's `input` shape.
43
50
  * @see {@link DeleteQueueCommandOutput} for command's `response` shape.
44
51
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -48,11 +55,20 @@ export interface DeleteQueueCommandOutput extends __MetadataBearer {
48
55
  export declare class DeleteQueueCommand extends $Command<DeleteQueueCommandInput, DeleteQueueCommandOutput, SQSClientResolvedConfig> {
49
56
  readonly input: DeleteQueueCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: DeleteQueueCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteQueueCommandInput, DeleteQueueCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetQueueAttributesRequest, GetQueueAttributesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetQueueAttributesCommand}.
8
10
  */
9
11
  export interface GetQueueAttributesCommandInput extends GetQueueAttributesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetQueueAttributesCommand}.
13
17
  */
14
18
  export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Gets attributes for the specified queue.</p>
18
23
  * <note>
19
24
  * <p>To determine whether a queue is <a href="https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html">FIFO</a>, you can check whether <code>QueueName</code> ends with the <code>.fifo</code> suffix.</p>
@@ -28,6 +33,8 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetQueueAttributesCommandInput - {@link GetQueueAttributesCommandInput}
37
+ * @returns {@link GetQueueAttributesCommandOutput}
31
38
  * @see {@link GetQueueAttributesCommandInput} for command's `input` shape.
32
39
  * @see {@link GetQueueAttributesCommandOutput} for command's `response` shape.
33
40
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -40,11 +47,20 @@ export interface GetQueueAttributesCommandOutput extends GetQueueAttributesResul
40
47
  export declare class GetQueueAttributesCommand extends $Command<GetQueueAttributesCommandInput, GetQueueAttributesCommandOutput, SQSClientResolvedConfig> {
41
48
  readonly input: GetQueueAttributesCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: GetQueueAttributesCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQueueAttributesCommandInput, GetQueueAttributesCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { GetQueueUrlRequest, GetQueueUrlResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetQueueUrlCommand}.
8
10
  */
9
11
  export interface GetQueueUrlCommandInput extends GetQueueUrlRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetQueueUrlCommand}.
13
17
  */
14
18
  export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the URL of an existing Amazon SQS queue.</p>
18
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.
19
24
  * For more information about shared queue access, see <code>
@@ -30,6 +35,8 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
30
35
  * const response = await client.send(command);
31
36
  * ```
32
37
  *
38
+ * @param GetQueueUrlCommandInput - {@link GetQueueUrlCommandInput}
39
+ * @returns {@link GetQueueUrlCommandOutput}
33
40
  * @see {@link GetQueueUrlCommandInput} for command's `input` shape.
34
41
  * @see {@link GetQueueUrlCommandOutput} for command's `response` shape.
35
42
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -42,11 +49,20 @@ export interface GetQueueUrlCommandOutput extends GetQueueUrlResult, __MetadataB
42
49
  export declare class GetQueueUrlCommand extends $Command<GetQueueUrlCommandInput, GetQueueUrlCommandOutput, SQSClientResolvedConfig> {
43
50
  readonly input: GetQueueUrlCommandInput;
44
51
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
52
+ /**
53
+ * @public
54
+ */
45
55
  constructor(input: GetQueueUrlCommandInput);
46
56
  /**
47
57
  * @internal
48
58
  */
49
59
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetQueueUrlCommandInput, GetQueueUrlCommandOutput>;
60
+ /**
61
+ * @internal
62
+ */
50
63
  private serialize;
64
+ /**
65
+ * @internal
66
+ */
51
67
  private deserialize;
52
68
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListDeadLetterSourceQueuesRequest, ListDeadLetterSourceQueuesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListDeadLetterSourceQueuesCommand}.
8
10
  */
9
11
  export interface ListDeadLetterSourceQueuesCommandInput extends ListDeadLetterSourceQueuesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListDeadLetterSourceQueuesCommand}.
13
17
  */
14
18
  export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterSourceQueuesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of your queues that have the <code>RedrivePolicy</code> queue attribute configured with a dead-letter queue.</p>
18
23
  * <p> The <code>ListDeadLetterSourceQueues</code> methods supports
19
24
  * pagination. Set parameter <code>MaxResults</code> in the request to specify the maximum number of
@@ -35,6 +40,8 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
35
40
  * const response = await client.send(command);
36
41
  * ```
37
42
  *
43
+ * @param ListDeadLetterSourceQueuesCommandInput - {@link ListDeadLetterSourceQueuesCommandInput}
44
+ * @returns {@link ListDeadLetterSourceQueuesCommandOutput}
38
45
  * @see {@link ListDeadLetterSourceQueuesCommandInput} for command's `input` shape.
39
46
  * @see {@link ListDeadLetterSourceQueuesCommandOutput} for command's `response` shape.
40
47
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListDeadLetterSourceQueuesCommandOutput extends ListDeadLetterS
47
54
  export declare class ListDeadLetterSourceQueuesCommand extends $Command<ListDeadLetterSourceQueuesCommandInput, ListDeadLetterSourceQueuesCommandOutput, SQSClientResolvedConfig> {
48
55
  readonly input: ListDeadLetterSourceQueuesCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListDeadLetterSourceQueuesCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListDeadLetterSourceQueuesCommandInput, ListDeadLetterSourceQueuesCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListQueueTagsRequest, ListQueueTagsResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListQueueTagsCommand}.
8
10
  */
9
11
  export interface ListQueueTagsCommandInput extends ListQueueTagsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListQueueTagsCommand}.
13
17
  */
14
18
  export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>List all cost allocation tags added 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
18
23
  * Your Amazon SQS Queues</a> in the <i>Amazon SQS Developer Guide</i>.</p>
19
24
  * <note>
@@ -31,6 +36,8 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
31
36
  * const response = await client.send(command);
32
37
  * ```
33
38
  *
39
+ * @param ListQueueTagsCommandInput - {@link ListQueueTagsCommandInput}
40
+ * @returns {@link ListQueueTagsCommandOutput}
34
41
  * @see {@link ListQueueTagsCommandInput} for command's `input` shape.
35
42
  * @see {@link ListQueueTagsCommandOutput} for command's `response` shape.
36
43
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -40,11 +47,20 @@ export interface ListQueueTagsCommandOutput extends ListQueueTagsResult, __Metad
40
47
  export declare class ListQueueTagsCommand extends $Command<ListQueueTagsCommandInput, ListQueueTagsCommandOutput, SQSClientResolvedConfig> {
41
48
  readonly input: ListQueueTagsCommandInput;
42
49
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
50
+ /**
51
+ * @public
52
+ */
43
53
  constructor(input: ListQueueTagsCommandInput);
44
54
  /**
45
55
  * @internal
46
56
  */
47
57
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListQueueTagsCommandInput, ListQueueTagsCommandOutput>;
58
+ /**
59
+ * @internal
60
+ */
48
61
  private serialize;
62
+ /**
63
+ * @internal
64
+ */
49
65
  private deserialize;
50
66
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListQueuesRequest, ListQueuesResult } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListQueuesCommand}.
8
10
  */
9
11
  export interface ListQueuesCommandInput extends ListQueuesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListQueuesCommand}.
13
17
  */
14
18
  export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns a list of your queues in the current region. The response includes a maximum of 1,000 results. If you specify a value for the optional
18
23
  * <code>QueueNamePrefix</code> parameter, only queues with a name that begins with the specified value are returned.</p>
19
24
  * <p> The <code>listQueues</code> methods supports
@@ -38,6 +43,8 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param ListQueuesCommandInput - {@link ListQueuesCommandInput}
47
+ * @returns {@link ListQueuesCommandOutput}
41
48
  * @see {@link ListQueuesCommandInput} for command's `input` shape.
42
49
  * @see {@link ListQueuesCommandOutput} for command's `response` shape.
43
50
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -47,11 +54,20 @@ export interface ListQueuesCommandOutput extends ListQueuesResult, __MetadataBea
47
54
  export declare class ListQueuesCommand extends $Command<ListQueuesCommandInput, ListQueuesCommandOutput, SQSClientResolvedConfig> {
48
55
  readonly input: ListQueuesCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: ListQueuesCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListQueuesCommandInput, ListQueuesCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { PurgeQueueRequest } from "../models/models_0";
5
5
  import { ServiceInputTypes, ServiceOutputTypes, SQSClientResolvedConfig } from "../SQSClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link PurgeQueueCommand}.
8
10
  */
9
11
  export interface PurgeQueueCommandInput extends PurgeQueueRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link PurgeQueueCommand}.
13
17
  */
14
18
  export interface PurgeQueueCommandOutput extends __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the messages in a queue specified by the <code>QueueURL</code>
18
23
  * parameter.</p>
19
24
  *
@@ -38,6 +43,8 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
38
43
  * const response = await client.send(command);
39
44
  * ```
40
45
  *
46
+ * @param PurgeQueueCommandInput - {@link PurgeQueueCommandInput}
47
+ * @returns {@link PurgeQueueCommandOutput}
41
48
  * @see {@link PurgeQueueCommandInput} for command's `input` shape.
42
49
  * @see {@link PurgeQueueCommandOutput} for command's `response` shape.
43
50
  * @see {@link SQSClientResolvedConfig | config} for SQSClient's `config` shape.
@@ -53,11 +60,20 @@ export interface PurgeQueueCommandOutput extends __MetadataBearer {
53
60
  export declare class PurgeQueueCommand extends $Command<PurgeQueueCommandInput, PurgeQueueCommandOutput, SQSClientResolvedConfig> {
54
61
  readonly input: PurgeQueueCommandInput;
55
62
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
63
+ /**
64
+ * @public
65
+ */
56
66
  constructor(input: PurgeQueueCommandInput);
57
67
  /**
58
68
  * @internal
59
69
  */
60
70
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SQSClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PurgeQueueCommandInput, PurgeQueueCommandOutput>;
71
+ /**
72
+ * @internal
73
+ */
61
74
  private serialize;
75
+ /**
76
+ * @internal
77
+ */
62
78
  private deserialize;
63
79
  }