@aws-sdk/client-chime-sdk-messaging 3.296.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.
- package/dist-types/ChimeSDKMessaging.d.ts +51 -0
- package/dist-types/ChimeSDKMessagingClient.d.ts +24 -4
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelBanCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +16 -0
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +16 -0
- package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +16 -0
- package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +16 -0
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMessageCommand.d.ts +16 -0
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +16 -0
- package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +16 -0
- package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelBansCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelFlowsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +16 -0
- package/dist-types/commands/ListSubChannelsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +16 -0
- package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +16 -0
- package/dist-types/commands/SearchChannelsCommand.d.ts +16 -0
- package/dist-types/commands/SendChannelMessageCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelFlowCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +16 -0
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +16 -0
- package/dist-types/models/ChimeSDKMessagingServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +355 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListChannelBansPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelFlowsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMembershipsForAppInstanceUserPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMembershipsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelMessagesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelModeratorsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsAssociatedWithChannelFlowPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsModeratedByAppInstanceUserPaginator.d.ts +3 -0
- package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListSubChannelsPaginator.d.ts +3 -0
- package/dist-types/pagination/SearchChannelsPaginator.d.ts +3 -0
- package/package.json +3 -3
|
@@ -51,6 +51,7 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
|
|
|
51
51
|
import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
|
|
52
52
|
import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
|
|
53
53
|
/**
|
|
54
|
+
* @public
|
|
54
55
|
* <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
|
|
55
56
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
56
57
|
* provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
|
|
@@ -58,6 +59,7 @@ import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutp
|
|
|
58
59
|
*/
|
|
59
60
|
export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
60
61
|
/**
|
|
62
|
+
* @public
|
|
61
63
|
* <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
|
|
62
64
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
63
65
|
* <note>
|
|
@@ -69,12 +71,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
69
71
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
70
72
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
71
73
|
/**
|
|
74
|
+
* @public
|
|
72
75
|
* <p>Adds a specified number of users to a channel. </p>
|
|
73
76
|
*/
|
|
74
77
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateChannelMembershipCommandOutput>;
|
|
75
78
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
76
79
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
77
80
|
/**
|
|
81
|
+
* @public
|
|
78
82
|
* <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>
|
|
79
83
|
* <p>You can return one of the following processing responses:</p>
|
|
80
84
|
* <ul>
|
|
@@ -93,6 +97,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
93
97
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
94
98
|
channelFlowCallback(args: ChannelFlowCallbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ChannelFlowCallbackCommandOutput) => void): void;
|
|
95
99
|
/**
|
|
100
|
+
* @public
|
|
96
101
|
* <p>Creates a channel to which you can add users and send messages.</p>
|
|
97
102
|
* <p>
|
|
98
103
|
* <b>Restriction</b>: You can't change a channel's
|
|
@@ -107,6 +112,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
107
112
|
createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
108
113
|
createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
|
|
109
114
|
/**
|
|
115
|
+
* @public
|
|
110
116
|
* <p>Permanently bans a member from a channel. Moderators can't add banned members to a
|
|
111
117
|
* channel. To undo a ban, you first have to <code>DeleteChannelBan</code>, and then
|
|
112
118
|
* <code>CreateChannelMembership</code>. Bans are cleaned up when you delete users or
|
|
@@ -123,6 +129,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
123
129
|
createChannelBan(args: CreateChannelBanCommandInput, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
124
130
|
createChannelBan(args: CreateChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelBanCommandOutput) => void): void;
|
|
125
131
|
/**
|
|
132
|
+
* @public
|
|
126
133
|
* <p>Creates a channel flow, a container for processors. Processors are AWS Lambda functions
|
|
127
134
|
* that perform actions on chat messages, such as stripping out profanity. You can associate
|
|
128
135
|
* channel flows with channels, and the processors in the channel flow then take action on all
|
|
@@ -148,6 +155,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
148
155
|
createChannelFlow(args: CreateChannelFlowCommandInput, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
149
156
|
createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
150
157
|
/**
|
|
158
|
+
* @public
|
|
151
159
|
* <p>Adds a user to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code> is derived from the
|
|
152
160
|
* request header. A channel member can:</p>
|
|
153
161
|
* <ul>
|
|
@@ -187,6 +195,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
187
195
|
createChannelMembership(args: CreateChannelMembershipCommandInput, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
188
196
|
createChannelMembership(args: CreateChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelMembershipCommandOutput) => void): void;
|
|
189
197
|
/**
|
|
198
|
+
* @public
|
|
190
199
|
* <p>Creates a new <code>ChannelModerator</code>. A channel moderator can:</p>
|
|
191
200
|
* <ul>
|
|
192
201
|
* <li>
|
|
@@ -215,6 +224,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
215
224
|
createChannelModerator(args: CreateChannelModeratorCommandInput, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
216
225
|
createChannelModerator(args: CreateChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelModeratorCommandOutput) => void): void;
|
|
217
226
|
/**
|
|
227
|
+
* @public
|
|
218
228
|
* <p>Immediately makes a channel and its memberships inaccessible and marks them for
|
|
219
229
|
* deletion. This is an irreversible process.</p>
|
|
220
230
|
* <note>
|
|
@@ -227,6 +237,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
227
237
|
deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
228
238
|
deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
229
239
|
/**
|
|
240
|
+
* @public
|
|
230
241
|
* <p>Removes a user from a channel's ban list.</p>
|
|
231
242
|
* <note>
|
|
232
243
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -238,6 +249,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
238
249
|
deleteChannelBan(args: DeleteChannelBanCommandInput, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
239
250
|
deleteChannelBan(args: DeleteChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelBanCommandOutput) => void): void;
|
|
240
251
|
/**
|
|
252
|
+
* @public
|
|
241
253
|
* <p>Deletes a channel flow, an irreversible process. This is a developer API.</p>
|
|
242
254
|
* <note>
|
|
243
255
|
* <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
|
|
@@ -248,6 +260,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
248
260
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
249
261
|
deleteChannelFlow(args: DeleteChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelFlowCommandOutput) => void): void;
|
|
250
262
|
/**
|
|
263
|
+
* @public
|
|
251
264
|
* <p>Removes a member from a channel.</p>
|
|
252
265
|
* <note>
|
|
253
266
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -259,6 +272,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
259
272
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
260
273
|
deleteChannelMembership(args: DeleteChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMembershipCommandOutput) => void): void;
|
|
261
274
|
/**
|
|
275
|
+
* @public
|
|
262
276
|
* <p>Deletes a channel message. Only admins can perform this action. Deletion makes messages
|
|
263
277
|
* inaccessible immediately. A background process deletes any revisions created by
|
|
264
278
|
* <code>UpdateChannelMessage</code>.</p>
|
|
@@ -272,6 +286,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
272
286
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
273
287
|
deleteChannelMessage(args: DeleteChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelMessageCommandOutput) => void): void;
|
|
274
288
|
/**
|
|
289
|
+
* @public
|
|
275
290
|
* <p>Deletes a channel moderator.</p>
|
|
276
291
|
* <note>
|
|
277
292
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -283,6 +298,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
283
298
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
284
299
|
deleteChannelModerator(args: DeleteChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelModeratorCommandOutput) => void): void;
|
|
285
300
|
/**
|
|
301
|
+
* @public
|
|
286
302
|
* <p>Deletes the streaming configurations for an <code>AppInstance</code>. For more information, see
|
|
287
303
|
* <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>
|
|
288
304
|
*/
|
|
@@ -290,6 +306,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
290
306
|
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
291
307
|
deleteMessagingStreamingConfigurations(args: DeleteMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
292
308
|
/**
|
|
309
|
+
* @public
|
|
293
310
|
* <p>Returns the full details of a channel in an Amazon Chime
|
|
294
311
|
* <code>AppInstance</code>.</p>
|
|
295
312
|
* <note>
|
|
@@ -302,6 +319,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
302
319
|
describeChannel(args: DescribeChannelCommandInput, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
303
320
|
describeChannel(args: DescribeChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelCommandOutput) => void): void;
|
|
304
321
|
/**
|
|
322
|
+
* @public
|
|
305
323
|
* <p>Returns the full details of a channel ban.</p>
|
|
306
324
|
* <note>
|
|
307
325
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -313,12 +331,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
313
331
|
describeChannelBan(args: DescribeChannelBanCommandInput, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
314
332
|
describeChannelBan(args: DescribeChannelBanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelBanCommandOutput) => void): void;
|
|
315
333
|
/**
|
|
334
|
+
* @public
|
|
316
335
|
* <p>Returns the full details of a channel flow in an Amazon Chime <code>AppInstance</code>. This is a developer API.</p>
|
|
317
336
|
*/
|
|
318
337
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DescribeChannelFlowCommandOutput>;
|
|
319
338
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
320
339
|
describeChannelFlow(args: DescribeChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelFlowCommandOutput) => void): void;
|
|
321
340
|
/**
|
|
341
|
+
* @public
|
|
322
342
|
* <p>Returns the full details of a user's channel membership.</p>
|
|
323
343
|
* <note>
|
|
324
344
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -330,6 +350,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
330
350
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
331
351
|
describeChannelMembership(args: DescribeChannelMembershipCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipCommandOutput) => void): void;
|
|
332
352
|
/**
|
|
353
|
+
* @public
|
|
333
354
|
* <p> Returns the details of a channel based on the membership of the specified
|
|
334
355
|
* <code>AppInstanceUser</code>.</p>
|
|
335
356
|
* <note>
|
|
@@ -342,6 +363,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
342
363
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
343
364
|
describeChannelMembershipForAppInstanceUser(args: DescribeChannelMembershipForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelMembershipForAppInstanceUserCommandOutput) => void): void;
|
|
344
365
|
/**
|
|
366
|
+
* @public
|
|
345
367
|
* <p>Returns the full details of a channel moderated by the specified
|
|
346
368
|
* <code>AppInstanceUser</code>.</p>
|
|
347
369
|
* <note>
|
|
@@ -354,6 +376,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
354
376
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
355
377
|
describeChannelModeratedByAppInstanceUser(args: DescribeChannelModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
356
378
|
/**
|
|
379
|
+
* @public
|
|
357
380
|
* <p>Returns the full details of a single ChannelModerator.</p>
|
|
358
381
|
* <note>
|
|
359
382
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -365,6 +388,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
365
388
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
366
389
|
describeChannelModerator(args: DescribeChannelModeratorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeChannelModeratorCommandOutput) => void): void;
|
|
367
390
|
/**
|
|
391
|
+
* @public
|
|
368
392
|
* <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
|
|
369
393
|
* that channel stop going through the channel flow processor.</p>
|
|
370
394
|
* <note>
|
|
@@ -376,6 +400,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
376
400
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
377
401
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
378
402
|
/**
|
|
403
|
+
* @public
|
|
379
404
|
* <p>Gets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
|
|
380
405
|
* Only the <code>AppInstanceUser</code> who owns the membership can retrieve preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't retrieve preferences for other users.
|
|
381
406
|
* Banned users can't retrieve membership preferences for the channel from which they are banned.</p>
|
|
@@ -384,6 +409,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
384
409
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
385
410
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
386
411
|
/**
|
|
412
|
+
* @public
|
|
387
413
|
* <p>Gets the full details of a channel message.</p>
|
|
388
414
|
* <note>
|
|
389
415
|
* <p>The x-amz-chime-bearer request header is mandatory. Use the
|
|
@@ -395,6 +421,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
395
421
|
getChannelMessage(args: GetChannelMessageCommandInput, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
396
422
|
getChannelMessage(args: GetChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageCommandOutput) => void): void;
|
|
397
423
|
/**
|
|
424
|
+
* @public
|
|
398
425
|
* <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
|
|
399
426
|
* retrieving message status if the event was not received because a client wasn't connected to a websocket. </p>
|
|
400
427
|
* <p>Messages can have any one of these statuses.</p>
|
|
@@ -434,12 +461,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
434
461
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
435
462
|
getChannelMessageStatus(args: GetChannelMessageStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelMessageStatusCommandOutput) => void): void;
|
|
436
463
|
/**
|
|
464
|
+
* @public
|
|
437
465
|
* <p>The details of the endpoint for the messaging session.</p>
|
|
438
466
|
*/
|
|
439
467
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options?: __HttpHandlerOptions): Promise<GetMessagingSessionEndpointCommandOutput>;
|
|
440
468
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
441
469
|
getMessagingSessionEndpoint(args: GetMessagingSessionEndpointCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingSessionEndpointCommandOutput) => void): void;
|
|
442
470
|
/**
|
|
471
|
+
* @public
|
|
443
472
|
* <p>Retrieves the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
444
473
|
* <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>
|
|
445
474
|
*/
|
|
@@ -447,6 +476,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
447
476
|
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
448
477
|
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
449
478
|
/**
|
|
479
|
+
* @public
|
|
450
480
|
* <p>Lists all the users banned from a particular channel.</p>
|
|
451
481
|
* <note>
|
|
452
482
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -458,12 +488,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
458
488
|
listChannelBans(args: ListChannelBansCommandInput, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
459
489
|
listChannelBans(args: ListChannelBansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelBansCommandOutput) => void): void;
|
|
460
490
|
/**
|
|
491
|
+
* @public
|
|
461
492
|
* <p>Returns a paginated lists of all the channel flows created under a single Chime. This is a developer API.</p>
|
|
462
493
|
*/
|
|
463
494
|
listChannelFlows(args: ListChannelFlowsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelFlowsCommandOutput>;
|
|
464
495
|
listChannelFlows(args: ListChannelFlowsCommandInput, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
465
496
|
listChannelFlows(args: ListChannelFlowsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelFlowsCommandOutput) => void): void;
|
|
466
497
|
/**
|
|
498
|
+
* @public
|
|
467
499
|
* <p>Lists all channel memberships in a channel.</p>
|
|
468
500
|
* <note>
|
|
469
501
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -477,6 +509,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
477
509
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
478
510
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
479
511
|
/**
|
|
512
|
+
* @public
|
|
480
513
|
* <p> Lists all channels that a particular <code>AppInstanceUser</code> is a part of. Only an
|
|
481
514
|
* <code>AppInstanceAdmin</code> can call the API with a user ARN that is not their own. </p>
|
|
482
515
|
* <note>
|
|
@@ -489,6 +522,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
489
522
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
490
523
|
listChannelMembershipsForAppInstanceUser(args: ListChannelMembershipsForAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsForAppInstanceUserCommandOutput) => void): void;
|
|
491
524
|
/**
|
|
525
|
+
* @public
|
|
492
526
|
* <p>List all the messages in a channel. Returns a paginated list of
|
|
493
527
|
* <code>ChannelMessages</code>. By default, sorted by creation timestamp in descending
|
|
494
528
|
* order.</p>
|
|
@@ -505,6 +539,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
505
539
|
listChannelMessages(args: ListChannelMessagesCommandInput, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
506
540
|
listChannelMessages(args: ListChannelMessagesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMessagesCommandOutput) => void): void;
|
|
507
541
|
/**
|
|
542
|
+
* @public
|
|
508
543
|
* <p>Lists all the moderators for a channel.</p>
|
|
509
544
|
* <note>
|
|
510
545
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -516,6 +551,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
516
551
|
listChannelModerators(args: ListChannelModeratorsCommandInput, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
517
552
|
listChannelModerators(args: ListChannelModeratorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelModeratorsCommandOutput) => void): void;
|
|
518
553
|
/**
|
|
554
|
+
* @public
|
|
519
555
|
* <p>Lists all Channels created under a single Chime App as a paginated list. You can specify
|
|
520
556
|
* filters to narrow results.</p>
|
|
521
557
|
* <p class="title">
|
|
@@ -541,12 +577,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
541
577
|
listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
542
578
|
listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
|
|
543
579
|
/**
|
|
580
|
+
* @public
|
|
544
581
|
* <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>
|
|
545
582
|
*/
|
|
546
583
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsAssociatedWithChannelFlowCommandOutput>;
|
|
547
584
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
548
585
|
listChannelsAssociatedWithChannelFlow(args: ListChannelsAssociatedWithChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsAssociatedWithChannelFlowCommandOutput) => void): void;
|
|
549
586
|
/**
|
|
587
|
+
* @public
|
|
550
588
|
* <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
|
|
551
589
|
* <note>
|
|
552
590
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -558,18 +596,21 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
558
596
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
559
597
|
listChannelsModeratedByAppInstanceUser(args: ListChannelsModeratedByAppInstanceUserCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsModeratedByAppInstanceUserCommandOutput) => void): void;
|
|
560
598
|
/**
|
|
599
|
+
* @public
|
|
561
600
|
* <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>
|
|
562
601
|
*/
|
|
563
602
|
listSubChannels(args: ListSubChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListSubChannelsCommandOutput>;
|
|
564
603
|
listSubChannels(args: ListSubChannelsCommandInput, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
565
604
|
listSubChannels(args: ListSubChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListSubChannelsCommandOutput) => void): void;
|
|
566
605
|
/**
|
|
606
|
+
* @public
|
|
567
607
|
* <p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>
|
|
568
608
|
*/
|
|
569
609
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
570
610
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
571
611
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
572
612
|
/**
|
|
613
|
+
* @public
|
|
573
614
|
* <p>Sets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel.
|
|
574
615
|
* Only the <code>AppInstanceUser</code> who owns the membership can set preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users.
|
|
575
616
|
* Banned users can't set membership preferences for the channel from which they are banned.</p>
|
|
@@ -578,6 +619,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
578
619
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
579
620
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
580
621
|
/**
|
|
622
|
+
* @public
|
|
581
623
|
* <p>Sets the data streaming configuration for an <code>AppInstance</code>. For more information, see
|
|
582
624
|
* <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>
|
|
583
625
|
*/
|
|
@@ -585,6 +627,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
585
627
|
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
586
628
|
putMessagingStreamingConfigurations(args: PutMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
587
629
|
/**
|
|
630
|
+
* @public
|
|
588
631
|
* <p>Redacts message content, but not metadata. The message exists in the back end, but the
|
|
589
632
|
* action returns null content, and the state shows as redacted.</p>
|
|
590
633
|
* <note>
|
|
@@ -597,12 +640,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
597
640
|
redactChannelMessage(args: RedactChannelMessageCommandInput, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
598
641
|
redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
599
642
|
/**
|
|
643
|
+
* @public
|
|
600
644
|
* <p>Allows <code>ChimeBearer</code> to search channels by channel members. AppInstanceUsers can search across the channels that they belong to. AppInstanceAdmins can search across all channels.</p>
|
|
601
645
|
*/
|
|
602
646
|
searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
|
|
603
647
|
searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
604
648
|
searchChannels(args: SearchChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
605
649
|
/**
|
|
650
|
+
* @public
|
|
606
651
|
* <p>Sends a message to a particular channel that the member is a part of.</p>
|
|
607
652
|
* <note>
|
|
608
653
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -616,18 +661,21 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
616
661
|
sendChannelMessage(args: SendChannelMessageCommandInput, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
617
662
|
sendChannelMessage(args: SendChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendChannelMessageCommandOutput) => void): void;
|
|
618
663
|
/**
|
|
664
|
+
* @public
|
|
619
665
|
* <p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>
|
|
620
666
|
*/
|
|
621
667
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
622
668
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
623
669
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
624
670
|
/**
|
|
671
|
+
* @public
|
|
625
672
|
* <p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>
|
|
626
673
|
*/
|
|
627
674
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
628
675
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
629
676
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
630
677
|
/**
|
|
678
|
+
* @public
|
|
631
679
|
* <p>Update a channel's attributes.</p>
|
|
632
680
|
* <p>
|
|
633
681
|
* <b>Restriction</b>: You can't change a channel's privacy. </p>
|
|
@@ -641,12 +689,14 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
641
689
|
updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
642
690
|
updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
|
|
643
691
|
/**
|
|
692
|
+
* @public
|
|
644
693
|
* <p>Updates channel flow attributes. This is a developer API.</p>
|
|
645
694
|
*/
|
|
646
695
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelFlowCommandOutput>;
|
|
647
696
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
648
697
|
updateChannelFlow(args: UpdateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelFlowCommandOutput) => void): void;
|
|
649
698
|
/**
|
|
699
|
+
* @public
|
|
650
700
|
* <p>Updates the content of a message.</p>
|
|
651
701
|
* <note>
|
|
652
702
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -658,6 +708,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
658
708
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
659
709
|
updateChannelMessage(args: UpdateChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelMessageCommandOutput) => void): void;
|
|
660
710
|
/**
|
|
711
|
+
* @public
|
|
661
712
|
* <p>The details of the time when a user last read messages in a channel.</p>
|
|
662
713
|
* <note>
|
|
663
714
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
@@ -58,15 +58,24 @@ import { UpdateChannelFlowCommandInput, UpdateChannelFlowCommandOutput } from ".
|
|
|
58
58
|
import { UpdateChannelMessageCommandInput, UpdateChannelMessageCommandOutput } from "./commands/UpdateChannelMessageCommand";
|
|
59
59
|
import { UpdateChannelReadMarkerCommandInput, UpdateChannelReadMarkerCommandOutput } from "./commands/UpdateChannelReadMarkerCommand";
|
|
60
60
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
61
|
+
/**
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
61
64
|
export type ServiceInputTypes = AssociateChannelFlowCommandInput | BatchCreateChannelMembershipCommandInput | ChannelFlowCallbackCommandInput | CreateChannelBanCommandInput | CreateChannelCommandInput | CreateChannelFlowCommandInput | CreateChannelMembershipCommandInput | CreateChannelModeratorCommandInput | DeleteChannelBanCommandInput | DeleteChannelCommandInput | DeleteChannelFlowCommandInput | DeleteChannelMembershipCommandInput | DeleteChannelMessageCommandInput | DeleteChannelModeratorCommandInput | DeleteMessagingStreamingConfigurationsCommandInput | DescribeChannelBanCommandInput | DescribeChannelCommandInput | DescribeChannelFlowCommandInput | DescribeChannelMembershipCommandInput | DescribeChannelMembershipForAppInstanceUserCommandInput | DescribeChannelModeratedByAppInstanceUserCommandInput | DescribeChannelModeratorCommandInput | DisassociateChannelFlowCommandInput | GetChannelMembershipPreferencesCommandInput | GetChannelMessageCommandInput | GetChannelMessageStatusCommandInput | GetMessagingSessionEndpointCommandInput | GetMessagingStreamingConfigurationsCommandInput | ListChannelBansCommandInput | ListChannelFlowsCommandInput | ListChannelMembershipsCommandInput | ListChannelMembershipsForAppInstanceUserCommandInput | ListChannelMessagesCommandInput | ListChannelModeratorsCommandInput | ListChannelsAssociatedWithChannelFlowCommandInput | ListChannelsCommandInput | ListChannelsModeratedByAppInstanceUserCommandInput | ListSubChannelsCommandInput | ListTagsForResourceCommandInput | PutChannelMembershipPreferencesCommandInput | PutMessagingStreamingConfigurationsCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
62
68
|
export type ServiceOutputTypes = AssociateChannelFlowCommandOutput | BatchCreateChannelMembershipCommandOutput | ChannelFlowCallbackCommandOutput | CreateChannelBanCommandOutput | CreateChannelCommandOutput | CreateChannelFlowCommandOutput | CreateChannelMembershipCommandOutput | CreateChannelModeratorCommandOutput | DeleteChannelBanCommandOutput | DeleteChannelCommandOutput | DeleteChannelFlowCommandOutput | DeleteChannelMembershipCommandOutput | DeleteChannelMessageCommandOutput | DeleteChannelModeratorCommandOutput | DeleteMessagingStreamingConfigurationsCommandOutput | DescribeChannelBanCommandOutput | DescribeChannelCommandOutput | DescribeChannelFlowCommandOutput | DescribeChannelMembershipCommandOutput | DescribeChannelMembershipForAppInstanceUserCommandOutput | DescribeChannelModeratedByAppInstanceUserCommandOutput | DescribeChannelModeratorCommandOutput | DisassociateChannelFlowCommandOutput | GetChannelMembershipPreferencesCommandOutput | GetChannelMessageCommandOutput | GetChannelMessageStatusCommandOutput | GetMessagingSessionEndpointCommandOutput | GetMessagingStreamingConfigurationsCommandOutput | ListChannelBansCommandOutput | ListChannelFlowsCommandOutput | ListChannelMembershipsCommandOutput | ListChannelMembershipsForAppInstanceUserCommandOutput | ListChannelMessagesCommandOutput | ListChannelModeratorsCommandOutput | ListChannelsAssociatedWithChannelFlowCommandOutput | ListChannelsCommandOutput | ListChannelsModeratedByAppInstanceUserCommandOutput | ListSubChannelsCommandOutput | ListTagsForResourceCommandOutput | PutChannelMembershipPreferencesCommandOutput | PutMessagingStreamingConfigurationsCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
|
|
69
|
+
/**
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
63
72
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
64
73
|
/**
|
|
65
74
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
66
75
|
*/
|
|
67
76
|
requestHandler?: __HttpHandler;
|
|
68
77
|
/**
|
|
69
|
-
* A constructor for a class implementing the {@link
|
|
78
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
70
79
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
71
80
|
* @internal
|
|
72
81
|
*/
|
|
@@ -156,23 +165,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
156
165
|
*/
|
|
157
166
|
logger?: __Logger;
|
|
158
167
|
/**
|
|
159
|
-
* The {@link
|
|
168
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
160
169
|
*/
|
|
161
170
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
162
171
|
}
|
|
172
|
+
/**
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
163
175
|
type ChimeSDKMessagingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
164
176
|
/**
|
|
165
|
-
*
|
|
177
|
+
* @public
|
|
178
|
+
*
|
|
179
|
+
* The configuration interface of ChimeSDKMessagingClient class constructor that set the region, credentials and other options.
|
|
166
180
|
*/
|
|
167
181
|
export interface ChimeSDKMessagingClientConfig extends ChimeSDKMessagingClientConfigType {
|
|
168
182
|
}
|
|
183
|
+
/**
|
|
184
|
+
* @public
|
|
185
|
+
*/
|
|
169
186
|
type ChimeSDKMessagingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
170
187
|
/**
|
|
171
|
-
*
|
|
188
|
+
* @public
|
|
189
|
+
*
|
|
190
|
+
* The resolved configuration interface of ChimeSDKMessagingClient class. This is resolved and normalized from the {@link ChimeSDKMessagingClientConfig | constructor configuration interface}.
|
|
172
191
|
*/
|
|
173
192
|
export interface ChimeSDKMessagingClientResolvedConfig extends ChimeSDKMessagingClientResolvedConfigType {
|
|
174
193
|
}
|
|
175
194
|
/**
|
|
195
|
+
* @public
|
|
176
196
|
* <p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send
|
|
177
197
|
* and receive messages in custom messaging applications. These APIs depend on the frameworks
|
|
178
198
|
* provided by the Amazon Chime SDK Identity APIs. For more information about the messaging
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
|
|
5
5
|
import { AssociateChannelFlowRequest } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssociateChannelFlowCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssociateChannelFlowCommandInput extends AssociateChannelFlowRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssociateChannelFlowCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <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
|
|
18
23
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
19
24
|
* <note>
|
|
@@ -30,6 +35,8 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
30
35
|
* const response = await client.send(command);
|
|
31
36
|
* ```
|
|
32
37
|
*
|
|
38
|
+
* @param AssociateChannelFlowCommandInput - {@link AssociateChannelFlowCommandInput}
|
|
39
|
+
* @returns {@link AssociateChannelFlowCommandOutput}
|
|
33
40
|
* @see {@link AssociateChannelFlowCommandInput} for command's `input` shape.
|
|
34
41
|
* @see {@link AssociateChannelFlowCommandOutput} for command's `response` shape.
|
|
35
42
|
* @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
|
|
@@ -64,11 +71,20 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
64
71
|
export declare class AssociateChannelFlowCommand extends $Command<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
65
72
|
readonly input: AssociateChannelFlowCommandInput;
|
|
66
73
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
67
77
|
constructor(input: AssociateChannelFlowCommandInput);
|
|
68
78
|
/**
|
|
69
79
|
* @internal
|
|
70
80
|
*/
|
|
71
81
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateChannelFlowCommandInput, AssociateChannelFlowCommandOutput>;
|
|
82
|
+
/**
|
|
83
|
+
* @internal
|
|
84
|
+
*/
|
|
72
85
|
private serialize;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
73
89
|
private deserialize;
|
|
74
90
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
|
|
5
5
|
import { BatchCreateChannelMembershipRequest, BatchCreateChannelMembershipResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link BatchCreateChannelMembershipCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface BatchCreateChannelMembershipCommandInput extends BatchCreateChannelMembershipRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link BatchCreateChannelMembershipCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateChannelMembershipResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Adds a specified number of users to a channel. </p>
|
|
18
23
|
* @example
|
|
19
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,6 +30,8 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
25
30
|
* const response = await client.send(command);
|
|
26
31
|
* ```
|
|
27
32
|
*
|
|
33
|
+
* @param BatchCreateChannelMembershipCommandInput - {@link BatchCreateChannelMembershipCommandInput}
|
|
34
|
+
* @returns {@link BatchCreateChannelMembershipCommandOutput}
|
|
28
35
|
* @see {@link BatchCreateChannelMembershipCommandInput} for command's `input` shape.
|
|
29
36
|
* @see {@link BatchCreateChannelMembershipCommandOutput} for command's `response` shape.
|
|
30
37
|
* @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
|
|
@@ -58,11 +65,20 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
58
65
|
export declare class BatchCreateChannelMembershipCommand extends $Command<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
59
66
|
readonly input: BatchCreateChannelMembershipCommandInput;
|
|
60
67
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
68
|
+
/**
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
61
71
|
constructor(input: BatchCreateChannelMembershipCommandInput);
|
|
62
72
|
/**
|
|
63
73
|
* @internal
|
|
64
74
|
*/
|
|
65
75
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<BatchCreateChannelMembershipCommandInput, BatchCreateChannelMembershipCommandOutput>;
|
|
76
|
+
/**
|
|
77
|
+
* @internal
|
|
78
|
+
*/
|
|
66
79
|
private serialize;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
67
83
|
private deserialize;
|
|
68
84
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { ChimeSDKMessagingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ChimeSDKMessagingClient";
|
|
5
5
|
import { ChannelFlowCallbackRequest, ChannelFlowCallbackResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link ChannelFlowCallbackCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface ChannelFlowCallbackCommandInput extends ChannelFlowCallbackRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link ChannelFlowCallbackCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <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>
|
|
18
23
|
* <p>You can return one of the following processing responses:</p>
|
|
19
24
|
* <ul>
|
|
@@ -37,6 +42,8 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
|
|
|
37
42
|
* const response = await client.send(command);
|
|
38
43
|
* ```
|
|
39
44
|
*
|
|
45
|
+
* @param ChannelFlowCallbackCommandInput - {@link ChannelFlowCallbackCommandInput}
|
|
46
|
+
* @returns {@link ChannelFlowCallbackCommandOutput}
|
|
40
47
|
* @see {@link ChannelFlowCallbackCommandInput} for command's `input` shape.
|
|
41
48
|
* @see {@link ChannelFlowCallbackCommandOutput} for command's `response` shape.
|
|
42
49
|
* @see {@link ChimeSDKMessagingClientResolvedConfig | config} for ChimeSDKMessagingClient's `config` shape.
|
|
@@ -68,11 +75,20 @@ export interface ChannelFlowCallbackCommandOutput extends ChannelFlowCallbackRes
|
|
|
68
75
|
export declare class ChannelFlowCallbackCommand extends $Command<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput, ChimeSDKMessagingClientResolvedConfig> {
|
|
69
76
|
readonly input: ChannelFlowCallbackCommandInput;
|
|
70
77
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
71
81
|
constructor(input: ChannelFlowCallbackCommandInput);
|
|
72
82
|
/**
|
|
73
83
|
* @internal
|
|
74
84
|
*/
|
|
75
85
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ChimeSDKMessagingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ChannelFlowCallbackCommandInput, ChannelFlowCallbackCommandOutput>;
|
|
86
|
+
/**
|
|
87
|
+
* @internal
|
|
88
|
+
*/
|
|
76
89
|
private serialize;
|
|
90
|
+
/**
|
|
91
|
+
* @internal
|
|
92
|
+
*/
|
|
77
93
|
private deserialize;
|
|
78
94
|
}
|