@aws-sdk/client-chime-sdk-messaging 3.315.0 → 3.319.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.
@@ -51,722 +51,320 @@ import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./command
51
51
  import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from "./commands/UpdateChannelFlowCommand";
52
52
  import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
53
53
  import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
54
- /**
55
- * @public
56
- * <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
57
- * and receive messages in custom messaging applications. These APIs depend on the frameworks
58
- * provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
59
- * APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
60
- */
61
- export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
62
- /**
63
- * @public
64
- * <p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the
65
- * <code>DisassociateChannelFlow</code> API.</p>
66
- * <note>
67
- * <p>Only administrators or channel moderators can associate a channel flow. The
68
- * <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the
69
- * <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
70
- * that makes the API call as the value in the header.</p>
71
- * </note>
54
+ export interface ChimeSDKMessaging {
55
+ /**
56
+ * @see {@link AssociateChannelFlowCommand}
72
57
  */
73
58
  associateChannelFlow(args: AssociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<AssociateChannelFlowCommandOutput>;
74
59
  associateChannelFlow(args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
75
60
  associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
76
61
  /**
77
- * @public
78
- * <p>Adds a specified number of users and bots to a channel. </p>
62
+ * @see {@link BatchCreateChannelMembershipCommand}
79
63
  */
80
64
  batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateChannelMembershipCommandOutput>;
81
65
  batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
82
66
  batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
83
67
  /**
84
- * @public
85
- * <p>Calls back Chime SDK Messaging with a processing response message. This should be invoked from the processor Lambda. This is a developer API.</p>
86
- * <p>You can return one of the following processing responses:</p>
87
- * <ul>
88
- * <li>
89
- * <p>Update message content or metadata</p>
90
- * </li>
91
- * <li>
92
- * <p>Deny a message</p>
93
- * </li>
94
- * <li>
95
- * <p>Make no changes to the message</p>
96
- * </li>
97
- * </ul>
68
+ * @see {@link ChannelFlowCallbackCommand}
98
69
  */
99
70
  channelFlowCallback(args: ChannelFlowCallbackCommandInput, options?: __HttpHandlerOptions): Promise<ChannelFlowCallbackCommandOutput>;
100
71
  channelFlowCallback(args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
101
72
  channelFlowCallback(args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
102
73
  /**
103
- * @public
104
- * <p>Creates a channel to which you can add users and send messages.</p>
105
- * <p>
106
- * <b>Restriction</b>: You can't change a channel's
107
- * privacy.</p>
108
- * <note>
109
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
110
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
111
- * the header.</p>
112
- * </note>
74
+ * @see {@link CreateChannelCommand}
113
75
  */
114
76
  createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
115
77
  createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
116
78
  createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
117
79
  /**
118
- * @public
119
- * <p>Permanently bans a member from a channel. Moderators can't add banned members to a
120
- * channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
121
- * <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
122
- * channels.</p>
123
- * <p>If you ban a user who is already part of a channel, that user is automatically kicked
124
- * from the channel.</p>
125
- * <note>
126
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
127
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
128
- * the header.</p>
129
- * </note>
80
+ * @see {@link CreateChannelBanCommand}
130
81
  */
131
82
  createChannelBan(args: CreateChannelBanCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelBanCommandOutput>;
132
83
  createChannelBan(args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
133
84
  createChannelBan(args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
134
85
  /**
135
- * @public
136
- * <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
137
- * that perform actions on chat messages, such as stripping out profanity. You can associate
138
- * channel flows with channels, and the processors in the channel flow then take action on all
139
- * messages sent to that channel. This is a developer API.</p>
140
- * <p>Channel flows process the following items:</p>
141
- * <ol>
142
- * <li>
143
- * <p>New and updated messages</p>
144
- * </li>
145
- * <li>
146
- * <p>Persistent and non-persistent messages</p>
147
- * </li>
148
- * <li>
149
- * <p>The Standard message type</p>
150
- * </li>
151
- * </ol>
152
- * <note>
153
- * <p>Channel flows don't process Control or System messages. For more information about the message types provided by Chime SDK Messaging, refer to
154
- * <a href="https://docs.aws.amazon.com/chime/latest/dg/using-the-messaging-sdk.html#msg-types">Message types</a> in the <i>Amazon Chime developer guide</i>.</p>
155
- * </note>
86
+ * @see {@link CreateChannelFlowCommand}
156
87
  */
157
88
  createChannelFlow(args: CreateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelFlowCommandOutput>;
158
89
  createChannelFlow(args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
159
90
  createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
160
91
  /**
161
- * @public
162
- * <p>Adds a member to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code>
163
- * is derived from the request header. A channel member can:</p>
164
- * <ul>
165
- * <li>
166
- * <p>List messages</p>
167
- * </li>
168
- * <li>
169
- * <p>Send messages</p>
170
- * </li>
171
- * <li>
172
- * <p>Receive messages</p>
173
- * </li>
174
- * <li>
175
- * <p>Edit their own messages</p>
176
- * </li>
177
- * <li>
178
- * <p>Leave the channel</p>
179
- * </li>
180
- * </ul>
181
- * <p>Privacy settings impact this action as follows:</p>
182
- * <ul>
183
- * <li>
184
- * <p>Public Channels: You do not need to be a member to list messages, but you must be
185
- * a member to send messages.</p>
186
- * </li>
187
- * <li>
188
- * <p>Private Channels: You must be a member to list or send messages.</p>
189
- * </li>
190
- * </ul>
191
- * <note>
192
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
193
- * ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call
194
- * as the value in the header.</p>
195
- * </note>
92
+ * @see {@link CreateChannelMembershipCommand}
196
93
  */
197
94
  createChannelMembership(args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelMembershipCommandOutput>;
198
95
  createChannelMembership(args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
199
96
  createChannelMembership(args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
200
97
  /**
201
- * @public
202
- * <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
203
- * <ul>
204
- * <li>
205
- * <p>Add and remove other members of the channel.</p>
206
- * </li>
207
- * <li>
208
- * <p>Add and remove other moderators of the channel.</p>
209
- * </li>
210
- * <li>
211
- * <p>Add and remove user bans for the channel.</p>
212
- * </li>
213
- * <li>
214
- * <p>Redact messages in the channel.</p>
215
- * </li>
216
- * <li>
217
- * <p>List messages in the channel.</p>
218
- * </li>
219
- * </ul>
220
- * <note>
221
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
222
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in
223
- * the header.</p>
224
- * </note>
98
+ * @see {@link CreateChannelModeratorCommand}
225
99
  */
226
100
  createChannelModerator(args: CreateChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelModeratorCommandOutput>;
227
101
  createChannelModerator(args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
228
102
  createChannelModerator(args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
229
103
  /**
230
- * @public
231
- * <p>Immediately makes a channel and its memberships inaccessible and marks them for
232
- * deletion. This is an irreversible process.</p>
233
- * <note>
234
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
235
- * ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in
236
- * the header.</p>
237
- * </note>
104
+ * @see {@link DeleteChannelCommand}
238
105
  */
239
106
  deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
240
107
  deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
241
108
  deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
242
109
  /**
243
- * @public
244
- * <p>Removes a member from a channel's ban list.</p>
245
- * <note>
246
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
247
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
248
- * the header.</p>
249
- * </note>
110
+ * @see {@link DeleteChannelBanCommand}
250
111
  */
251
112
  deleteChannelBan(args: DeleteChannelBanCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelBanCommandOutput>;
252
113
  deleteChannelBan(args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
253
114
  deleteChannelBan(args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
254
115
  /**
255
- * @public
256
- * <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
257
- * <note>
258
- * <p> This API works only when the channel flow is not associated with any channel. To get a list of all channels that a channel flow is associated with, use the
259
- * <code>ListChannelsAssociatedWithChannelFlow</code> API. Use the <code>DisassociateChannelFlow</code> API to disassociate a channel flow from all channels. </p>
260
- * </note>
116
+ * @see {@link DeleteChannelFlowCommand}
261
117
  */
262
118
  deleteChannelFlow(args: DeleteChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelFlowCommandOutput>;
263
119
  deleteChannelFlow(args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
264
120
  deleteChannelFlow(args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
265
121
  /**
266
- * @public
267
- * <p>Removes a member from a channel.</p>
268
- * <note>
269
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
270
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
271
- * the header.</p>
272
- * </note>
122
+ * @see {@link DeleteChannelMembershipCommand}
273
123
  */
274
124
  deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelMembershipCommandOutput>;
275
125
  deleteChannelMembership(args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
276
126
  deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
277
127
  /**
278
- * @public
279
- * <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
280
- * inaccessible immediately. A background process deletes any revisions created by
281
- * <code>UpdateChannelMessage</code>.</p>
282
- * <note>
283
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
284
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
285
- * the header.</p>
286
- * </note>
128
+ * @see {@link DeleteChannelMessageCommand}
287
129
  */
288
130
  deleteChannelMessage(args: DeleteChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelMessageCommandOutput>;
289
131
  deleteChannelMessage(args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
290
132
  deleteChannelMessage(args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
291
133
  /**
292
- * @public
293
- * <p>Deletes a channel moderator.</p>
294
- * <note>
295
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
296
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
297
- * the header.</p>
298
- * </note>
134
+ * @see {@link DeleteChannelModeratorCommand}
299
135
  */
300
136
  deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelModeratorCommandOutput>;
301
137
  deleteChannelModerator(args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
302
138
  deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
303
139
  /**
304
- * @public
305
- * <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
306
- * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
140
+ * @see {@link DeleteMessagingStreamingConfigurationsCommand}
307
141
  */
308
142
  deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMessagingStreamingConfigurationsCommandOutput>;
309
143
  deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
310
144
  deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
311
145
  /**
312
- * @public
313
- * <p>Returns the full details of a channel in an Amazon Chime
314
- * <code>AppInstance</code>.</p>
315
- * <note>
316
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
317
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
318
- * the header.</p>
319
- * </note>
146
+ * @see {@link DescribeChannelCommand}
320
147
  */
321
148
  describeChannel(args: DescribeChannelCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelCommandOutput>;
322
149
  describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
323
150
  describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
324
151
  /**
325
- * @public
326
- * <p>Returns the full details of a channel ban.</p>
327
- * <note>
328
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
329
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
330
- * the header.</p>
331
- * </note>
152
+ * @see {@link DescribeChannelBanCommand}
332
153
  */
333
154
  describeChannelBan(args: DescribeChannelBanCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelBanCommandOutput>;
334
155
  describeChannelBan(args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
335
156
  describeChannelBan(args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
336
157
  /**
337
- * @public
338
- * <p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</p>
158
+ * @see {@link DescribeChannelFlowCommand}
339
159
  */
340
160
  describeChannelFlow(args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelFlowCommandOutput>;
341
161
  describeChannelFlow(args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
342
162
  describeChannelFlow(args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
343
163
  /**
344
- * @public
345
- * <p>Returns the full details of a user's channel membership.</p>
346
- * <note>
347
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
348
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
349
- * the header.</p>
350
- * </note>
164
+ * @see {@link DescribeChannelMembershipCommand}
351
165
  */
352
166
  describeChannelMembership(args: DescribeChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelMembershipCommandOutput>;
353
167
  describeChannelMembership(args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
354
168
  describeChannelMembership(args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
355
169
  /**
356
- * @public
357
- * <p> Returns the details of a channel based on the membership of the specified
358
- * <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
359
- * <note>
360
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
361
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
362
- * the header.</p>
363
- * </note>
170
+ * @see {@link DescribeChannelMembershipForAppInstanceUserCommand}
364
171
  */
365
172
  describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelMembershipForAppInstanceUserCommandOutput>;
366
173
  describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
367
174
  describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
368
175
  /**
369
- * @public
370
- * <p>Returns the full details of a channel moderated by the specified
371
- * <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
372
- * <note>
373
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
374
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
375
- * the header.</p>
376
- * </note>
176
+ * @see {@link DescribeChannelModeratedByAppInstanceUserCommand}
377
177
  */
378
178
  describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelModeratedByAppInstanceUserCommandOutput>;
379
179
  describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
380
180
  describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
381
181
  /**
382
- * @public
383
- * <p>Returns the full details of a single ChannelModerator.</p>
384
- * <note>
385
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
386
- * <code>AppInstanceUserArn</code> of the user that makes the API call as the value in
387
- * the header.</p>
388
- * </note>
182
+ * @see {@link DescribeChannelModeratorCommand}
389
183
  */
390
184
  describeChannelModerator(args: DescribeChannelModeratorCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelModeratorCommandOutput>;
391
185
  describeChannelModerator(args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
392
186
  describeChannelModerator(args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
393
187
  /**
394
- * @public
395
- * <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
396
- * that channel stop going through the channel flow processor.</p>
397
- * <note>
398
- * <p>Only administrators or channel moderators can disassociate a channel flow.</p>
399
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
400
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
401
- * the header.</p>
402
- * </note>
188
+ * @see {@link DisassociateChannelFlowCommand}
403
189
  */
404
190
  disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateChannelFlowCommandOutput>;
405
191
  disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
406
192
  disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
407
193
  /**
408
- * @public
409
- * <p>Gets the membership preferences of an <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
410
- * for the specified channel. A user or a bot must be a member of the channel and own the membership to be able
411
- * to retrieve membership preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't
412
- * retrieve preferences for other users or bots. Banned users or bots can't retrieve membership preferences for the
413
- * channel from which they are banned.</p>
414
- * <note>
415
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
416
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
417
- * the header.</p>
418
- * </note>
194
+ * @see {@link GetChannelMembershipPreferencesCommand}
419
195
  */
420
196
  getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMembershipPreferencesCommandOutput>;
421
197
  getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
422
198
  getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
423
199
  /**
424
- * @public
425
- * <p>Gets the full details of a channel message.</p>
426
- * <note>
427
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
428
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
429
- * the header.</p>
430
- * </note>
200
+ * @see {@link GetChannelMessageCommand}
431
201
  */
432
202
  getChannelMessage(args: GetChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMessageCommandOutput>;
433
203
  getChannelMessage(args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
434
204
  getChannelMessage(args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
435
205
  /**
436
- * @public
437
- * <p>Gets message status for a specified <code>messageId</code>. Use this API to determine the intermediate status of messages going through channel flow processing. The API provides an alternative to
438
- * retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
439
- * <p>Messages can have any one of these statuses.</p>
440
- * <dl>
441
- * <dt>SENT</dt>
442
- * <dd>
443
- * <p>Message processed successfully</p>
444
- * </dd>
445
- * <dt>PENDING</dt>
446
- * <dd>
447
- * <p>Ongoing processing</p>
448
- * </dd>
449
- * <dt>FAILED</dt>
450
- * <dd>
451
- * <p>Processing failed</p>
452
- * </dd>
453
- * <dt>DENIED</dt>
454
- * <dd>
455
- * <p>Messasge denied by the processor</p>
456
- * </dd>
457
- * </dl>
458
- * <note>
459
- * <ul>
460
- * <li>
461
- * <p>This API does not return statuses for denied messages, because we don't store them once the processor denies them. </p>
462
- * </li>
463
- * <li>
464
- * <p>Only the message sender can invoke this API.</p>
465
- * </li>
466
- * <li>
467
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
468
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
469
- * the header.</p>
470
- * </li>
471
- * </ul>
472
- * </note>
206
+ * @see {@link GetChannelMessageStatusCommand}
473
207
  */
474
208
  getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMessageStatusCommandOutput>;
475
209
  getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
476
210
  getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
477
211
  /**
478
- * @public
479
- * <p>The details of the endpoint for the messaging session.</p>
212
+ * @see {@link GetMessagingSessionEndpointCommand}
480
213
  */
481
214
  getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingSessionEndpointCommandOutput>;
482
215
  getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
483
216
  getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
484
217
  /**
485
- * @public
486
- * <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
487
- * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
218
+ * @see {@link GetMessagingStreamingConfigurationsCommand}
488
219
  */
489
220
  getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingStreamingConfigurationsCommandOutput>;
490
221
  getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
491
222
  getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
492
223
  /**
493
- * @public
494
- * <p>Lists all the users and bots banned from a particular channel.</p>
495
- * <note>
496
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
497
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
498
- * the header.</p>
499
- * </note>
224
+ * @see {@link ListChannelBansCommand}
500
225
  */
501
226
  listChannelBans(args: ListChannelBansCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelBansCommandOutput>;
502
227
  listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
503
228
  listChannelBans(args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
504
229
  /**
505
- * @public
506
- * <p>Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.</p>
230
+ * @see {@link ListChannelFlowsCommand}
507
231
  */
508
232
  listChannelFlows(args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelFlowsCommandOutput>;
509
233
  listChannelFlows(args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
510
234
  listChannelFlows(args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
511
235
  /**
512
- * @public
513
- * <p>Lists all channel memberships in a channel.</p>
514
- * <note>
515
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
516
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
517
- * the header.</p>
518
- * </note>
519
- * <p>If you want to list the channels to which a specific app instance user belongs, see the
520
- * <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html">ListChannelMembershipsForAppInstanceUser</a> API.</p>
236
+ * @see {@link ListChannelMembershipsCommand}
521
237
  */
522
238
  listChannelMemberships(args: ListChannelMembershipsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelMembershipsCommandOutput>;
523
239
  listChannelMemberships(args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
524
240
  listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
525
241
  /**
526
- * @public
527
- * <p> Lists all channels that anr <code>AppInstanceUser</code> or <code>AppInstanceBot</code> is a part of.
528
- * Only an <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
529
- * <note>
530
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
531
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
532
- * the header.</p>
533
- * </note>
242
+ * @see {@link ListChannelMembershipsForAppInstanceUserCommand}
534
243
  */
535
244
  listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelMembershipsForAppInstanceUserCommandOutput>;
536
245
  listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
537
246
  listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
538
247
  /**
539
- * @public
540
- * <p>List all the messages in a channel. Returns a paginated list of
541
- * <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending
542
- * order.</p>
543
- * <note>
544
- * <p>Redacted messages appear in the results as empty, since they are only redacted, not
545
- * deleted. Deleted messages do not appear in the results. This action always returns the
546
- * latest version of an edited message.</p>
547
- * <p>Also, the <code>x-amz-chime-bearer</code> request header is mandatory. Use the
548
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
549
- * the header.</p>
550
- * </note>
248
+ * @see {@link ListChannelMessagesCommand}
551
249
  */
552
250
  listChannelMessages(args: ListChannelMessagesCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelMessagesCommandOutput>;
553
251
  listChannelMessages(args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
554
252
  listChannelMessages(args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
555
253
  /**
556
- * @public
557
- * <p>Lists all the moderators for a channel.</p>
558
- * <note>
559
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
560
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
561
- * the header.</p>
562
- * </note>
254
+ * @see {@link ListChannelModeratorsCommand}
563
255
  */
564
256
  listChannelModerators(args: ListChannelModeratorsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelModeratorsCommandOutput>;
565
257
  listChannelModerators(args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
566
258
  listChannelModerators(args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
567
259
  /**
568
- * @public
569
- * <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
570
- * filters to narrow results.</p>
571
- * <p class="title">
572
- * <b>Functionality & restrictions</b>
573
- * </p>
574
- * <ul>
575
- * <li>
576
- * <p>Use privacy = <code>PUBLIC</code> to retrieve all public channels in the
577
- * account.</p>
578
- * </li>
579
- * <li>
580
- * <p>Only an <code>AppInstanceAdmin</code> can set privacy = <code>PRIVATE</code> to
581
- * list the private channels in an account.</p>
582
- * </li>
583
- * </ul>
584
- * <note>
585
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
586
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
587
- * the header.</p>
588
- * </note>
260
+ * @see {@link ListChannelsCommand}
589
261
  */
590
262
  listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsCommandOutput>;
591
263
  listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
592
264
  listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
593
265
  /**
594
- * @public
595
- * <p>Lists all channels associated with a specified channel flow. You can associate a channel flow with multiple channels, but you can only associate a channel with one channel flow. This is a developer API.</p>
266
+ * @see {@link ListChannelsAssociatedWithChannelFlowCommand}
596
267
  */
597
268
  listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsAssociatedWithChannelFlowCommandOutput>;
598
269
  listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
599
270
  listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
600
271
  /**
601
- * @public
602
- * <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
603
- * <note>
604
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
605
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
606
- * the header.</p>
607
- * </note>
272
+ * @see {@link ListChannelsModeratedByAppInstanceUserCommand}
608
273
  */
609
274
  listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsModeratedByAppInstanceUserCommandOutput>;
610
275
  listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
611
276
  listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
612
277
  /**
613
- * @public
614
- * <p>Lists all the SubChannels in an elastic channel when given a channel ID. Available only to the app instance admins and channel moderators of elastic channels.</p>
278
+ * @see {@link ListSubChannelsCommand}
615
279
  */
616
280
  listSubChannels(args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubChannelsCommandOutput>;
617
281
  listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
618
282
  listSubChannels(args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
619
283
  /**
620
- * @public
621
- * <p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>
284
+ * @see {@link ListTagsForResourceCommand}
622
285
  */
623
286
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
624
287
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
625
288
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
626
289
  /**
627
- * @public
628
- * <p>Sets the number of days before the channel is automatically deleted.</p>
629
- * <note>
630
- * <ul>
631
- * <li>
632
- * <p>A background process deletes expired channels within 6 hours of expiration.
633
- * Actual deletion times may vary.</p>
634
- * </li>
635
- * <li>
636
- * <p>Expired channels that have not yet been deleted appear as active, and you can update
637
- * their expiration settings. The system honors the new settings.</p>
638
- * </li>
639
- * <li>
640
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
641
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
642
- * the header.</p>
643
- * </li>
644
- * </ul>
645
- * </note>
290
+ * @see {@link PutChannelExpirationSettingsCommand}
646
291
  */
647
292
  putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelExpirationSettingsCommandOutput>;
648
293
  putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
649
294
  putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
650
295
  /**
651
- * @public
652
- * <p>Sets the membership preferences of an <code>AppInstanceUser</code> or <code>AppIntanceBot</code>
653
- * for the specified channel. The user or bot must be a member of the channel. Only the user or bot who owns the
654
- * membership can set preferences. Users or bots in the <code>AppInstanceAdmin</code> and channel moderator roles can't set
655
- * preferences for other users or users. Banned users or bots can't set membership preferences for the channel from
656
- * which they are banned.</p>
657
- * <note>
658
- * <p>The x-amz-chime-bearer request header is mandatory. Use the ARN of an
659
- * <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in the
660
- * header.</p>
661
- * </note>
296
+ * @see {@link PutChannelMembershipPreferencesCommand}
662
297
  */
663
298
  putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelMembershipPreferencesCommandOutput>;
664
299
  putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
665
300
  putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
666
301
  /**
667
- * @public
668
- * <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
669
- * <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html">Streaming messaging data</a> in the <i>Amazon Chime SDK Developer Guide</i>.</p>
302
+ * @see {@link PutMessagingStreamingConfigurationsCommand}
670
303
  */
671
304
  putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<PutMessagingStreamingConfigurationsCommandOutput>;
672
305
  putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
673
306
  putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
674
307
  /**
675
- * @public
676
- * <p>Redacts message content, but not metadata. The message exists in the back end, but the
677
- * action returns null content, and the state shows as redacted.</p>
678
- * <note>
679
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
680
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
681
- * the header.</p>
682
- * </note>
308
+ * @see {@link RedactChannelMessageCommand}
683
309
  */
684
310
  redactChannelMessage(args: RedactChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise<RedactChannelMessageCommandOutput>;
685
311
  redactChannelMessage(args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
686
312
  redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
687
313
  /**
688
- * @public
689
- * <p>Allows the <code>ChimeBearer</code> to search channels by channel members. Users or bots can search
690
- * across the channels that they belong to. Users in the <code>AppInstanceAdmin</code> role can search across
691
- * all channels.</p>
692
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
693
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
694
- * the header.</p>
314
+ * @see {@link SearchChannelsCommand}
695
315
  */
696
316
  searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
697
317
  searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
698
318
  searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
699
319
  /**
700
- * @public
701
- * <p>Sends a message to a particular channel that the member is a part of.</p>
702
- * <note>
703
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
704
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
705
- * the header.</p>
706
- * <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
707
- * <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
708
- * </note>
320
+ * @see {@link SendChannelMessageCommand}
709
321
  */
710
322
  sendChannelMessage(args: SendChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise<SendChannelMessageCommandOutput>;
711
323
  sendChannelMessage(args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
712
324
  sendChannelMessage(args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
713
325
  /**
714
- * @public
715
- * <p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>
326
+ * @see {@link TagResourceCommand}
716
327
  */
717
328
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
718
329
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
719
330
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
720
331
  /**
721
- * @public
722
- * <p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>
332
+ * @see {@link UntagResourceCommand}
723
333
  */
724
334
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
725
335
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
726
336
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
727
337
  /**
728
- * @public
729
- * <p>Update a channel's attributes.</p>
730
- * <p>
731
- * <b>Restriction</b>: You can't change a channel's privacy. </p>
732
- * <note>
733
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
734
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
735
- * the header.</p>
736
- * </note>
338
+ * @see {@link UpdateChannelCommand}
737
339
  */
738
340
  updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelCommandOutput>;
739
341
  updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
740
342
  updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
741
343
  /**
742
- * @public
743
- * <p>Updates channel flow attributes. This is a developer API.</p>
344
+ * @see {@link UpdateChannelFlowCommand}
744
345
  */
745
346
  updateChannelFlow(args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelFlowCommandOutput>;
746
347
  updateChannelFlow(args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
747
348
  updateChannelFlow(args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
748
349
  /**
749
- * @public
750
- * <p>Updates the content of a message.</p>
751
- * <note>
752
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
753
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
754
- * the header.</p>
755
- * </note>
350
+ * @see {@link UpdateChannelMessageCommand}
756
351
  */
757
352
  updateChannelMessage(args: UpdateChannelMessageCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelMessageCommandOutput>;
758
353
  updateChannelMessage(args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
759
354
  updateChannelMessage(args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
760
355
  /**
761
- * @public
762
- * <p>The details of the time when a user last read messages in a channel.</p>
763
- * <note>
764
- * <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
765
- * ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
766
- * the header.</p>
767
- * </note>
356
+ * @see {@link UpdateChannelReadMarkerCommand}
768
357
  */
769
358
  updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelReadMarkerCommandOutput>;
770
359
  updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void): void;
771
360
  updateChannelReadMarker(args: UpdateChannelReadMarkerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelReadMarkerCommandOutput) => void): void;
772
361
  }
362
+ /**
363
+ * @public
364
+ * <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
365
+ * and receive messages in custom messaging applications. These APIs depend on the frameworks
366
+ * provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
367
+ * APIs, see <a href="https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html">Amazon Chime SDK messaging</a>.</p>
368
+ */
369
+ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient implements ChimeSDKMessaging {
370
+ }