@aws-sdk/client-chime-sdk-messaging 3.297.0 → 3.299.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/README.md +8 -0
- package/dist-cjs/ChimeSDKMessaging.js +15 -0
- package/dist-cjs/commands/AssociateChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/BatchCreateChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/ChannelFlowCallbackCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelBanCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/CreateChannelModeratorCommand.js +1 -1
- package/dist-cjs/commands/DeleteChannelBanCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelMembershipCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelMessageCommand.js +2 -3
- package/dist-cjs/commands/DeleteChannelModeratorCommand.js +2 -3
- package/dist-cjs/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/DescribeChannelBanCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelMembershipCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +1 -1
- package/dist-cjs/commands/DescribeChannelModeratorCommand.js +1 -1
- package/dist-cjs/commands/DisassociateChannelFlowCommand.js +2 -3
- package/dist-cjs/commands/GetChannelMembershipPreferencesCommand.js +1 -1
- package/dist-cjs/commands/GetChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/GetChannelMessageStatusCommand.js +2 -3
- package/dist-cjs/commands/GetMessagingSessionEndpointCommand.js +2 -3
- package/dist-cjs/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/ListTagsForResourceCommand.js +1 -1
- package/dist-cjs/commands/PutChannelExpirationSettingsCommand.js +45 -0
- package/dist-cjs/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-cjs/commands/RedactChannelMessageCommand.js +2 -3
- package/dist-cjs/commands/SendChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/TagResourceCommand.js +1 -1
- package/dist-cjs/commands/UntagResourceCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelFlowCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelMessageCommand.js +1 -1
- package/dist-cjs/commands/UpdateChannelReadMarkerCommand.js +2 -3
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +12 -211
- package/dist-cjs/protocols/Aws_restJson1.js +107 -2
- package/dist-es/ChimeSDKMessaging.js +15 -0
- package/dist-es/commands/AssociateChannelFlowCommand.js +2 -3
- package/dist-es/commands/BatchCreateChannelMembershipCommand.js +2 -2
- package/dist-es/commands/ChannelFlowCallbackCommand.js +2 -2
- package/dist-es/commands/CreateChannelBanCommand.js +2 -2
- package/dist-es/commands/CreateChannelCommand.js +2 -2
- package/dist-es/commands/CreateChannelFlowCommand.js +2 -2
- package/dist-es/commands/CreateChannelMembershipCommand.js +2 -2
- package/dist-es/commands/CreateChannelModeratorCommand.js +2 -2
- package/dist-es/commands/DeleteChannelBanCommand.js +2 -3
- package/dist-es/commands/DeleteChannelCommand.js +2 -3
- package/dist-es/commands/DeleteChannelFlowCommand.js +2 -3
- package/dist-es/commands/DeleteChannelMembershipCommand.js +2 -3
- package/dist-es/commands/DeleteChannelMessageCommand.js +2 -3
- package/dist-es/commands/DeleteChannelModeratorCommand.js +2 -3
- package/dist-es/commands/DeleteMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/DescribeChannelBanCommand.js +2 -2
- package/dist-es/commands/DescribeChannelCommand.js +2 -2
- package/dist-es/commands/DescribeChannelFlowCommand.js +2 -2
- package/dist-es/commands/DescribeChannelMembershipCommand.js +2 -2
- package/dist-es/commands/DescribeChannelMembershipForAppInstanceUserCommand.js +2 -2
- package/dist-es/commands/DescribeChannelModeratedByAppInstanceUserCommand.js +2 -2
- package/dist-es/commands/DescribeChannelModeratorCommand.js +2 -2
- package/dist-es/commands/DisassociateChannelFlowCommand.js +2 -3
- package/dist-es/commands/GetChannelMembershipPreferencesCommand.js +2 -2
- package/dist-es/commands/GetChannelMessageCommand.js +2 -2
- package/dist-es/commands/GetChannelMessageStatusCommand.js +2 -3
- package/dist-es/commands/GetMessagingSessionEndpointCommand.js +2 -3
- package/dist-es/commands/GetMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/ListTagsForResourceCommand.js +2 -2
- package/dist-es/commands/PutChannelExpirationSettingsCommand.js +41 -0
- package/dist-es/commands/PutMessagingStreamingConfigurationsCommand.js +2 -3
- package/dist-es/commands/RedactChannelMessageCommand.js +2 -3
- package/dist-es/commands/SendChannelMessageCommand.js +2 -2
- package/dist-es/commands/TagResourceCommand.js +1 -1
- package/dist-es/commands/UntagResourceCommand.js +1 -1
- package/dist-es/commands/UpdateChannelCommand.js +2 -2
- package/dist-es/commands/UpdateChannelFlowCommand.js +2 -2
- package/dist-es/commands/UpdateChannelMessageCommand.js +2 -2
- package/dist-es/commands/UpdateChannelReadMarkerCommand.js +2 -3
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +10 -156
- package/dist-es/protocols/Aws_restJson1.js +102 -0
- package/dist-types/ChimeSDKMessaging.d.ts +100 -50
- package/dist-types/ChimeSDKMessagingClient.d.ts +3 -2
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +4 -2
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +1 -1
- package/dist-types/commands/CreateChannelBanCommand.d.ts +1 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +1 -1
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +4 -4
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +1 -1
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +2 -2
- package/dist-types/commands/DeleteChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +1 -1
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +1 -1
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +1 -1
- package/dist-types/commands/DescribeChannelCommand.d.ts +1 -1
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +1 -1
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +2 -2
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +2 -2
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +4 -2
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +10 -3
- package/dist-types/commands/GetChannelMessageCommand.d.ts +2 -2
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +3 -1
- package/dist-types/commands/ListChannelBansCommand.d.ts +2 -2
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +3 -3
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +2 -2
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelsCommand.d.ts +1 -1
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +1 -1
- package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts +99 -0
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +10 -3
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +1 -1
- package/dist-types/commands/SearchChannelsCommand.d.ts +6 -1
- package/dist-types/commands/SendChannelMessageCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChannelCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +149 -250
- package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
- package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +17 -0
- package/dist-types/ts3.4/ChimeSDKMessagingClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/PutChannelExpirationSettingsCommand.d.ts +41 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +25 -155
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +11 -10
|
@@ -39,6 +39,7 @@ import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/
|
|
|
39
39
|
import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput } from "./commands/ListChannelsModeratedByAppInstanceUserCommand";
|
|
40
40
|
import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
|
|
41
41
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
42
|
+
import { PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput } from "./commands/PutChannelExpirationSettingsCommand";
|
|
42
43
|
import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
|
|
43
44
|
import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
|
|
44
45
|
import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
|
|
@@ -63,8 +64,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
63
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
|
|
64
65
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
65
66
|
* <note>
|
|
66
|
-
* <p>Only administrators or channel moderators can associate a channel flow. The
|
|
67
|
-
*
|
|
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>
|
|
68
71
|
* </note>
|
|
69
72
|
*/
|
|
70
73
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<AssociateChannelFlowCommandOutput>;
|
|
@@ -72,7 +75,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
72
75
|
associateChannelFlow(args: AssociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateChannelFlowCommandOutput) => void): void;
|
|
73
76
|
/**
|
|
74
77
|
* @public
|
|
75
|
-
* <p>Adds a specified number of users to a channel. </p>
|
|
78
|
+
* <p>Adds a specified number of users and bots to a channel. </p>
|
|
76
79
|
*/
|
|
77
80
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<BatchCreateChannelMembershipCommandOutput>;
|
|
78
81
|
batchCreateChannelMembership(args: BatchCreateChannelMembershipCommandInput, cb: (err: any, data?: BatchCreateChannelMembershipCommandOutput) => void): void;
|
|
@@ -104,7 +107,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
104
107
|
* privacy.</p>
|
|
105
108
|
* <note>
|
|
106
109
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
107
|
-
*
|
|
110
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
108
111
|
* the header.</p>
|
|
109
112
|
* </note>
|
|
110
113
|
*/
|
|
@@ -121,7 +124,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
121
124
|
* from the channel.</p>
|
|
122
125
|
* <note>
|
|
123
126
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
124
|
-
* <code>
|
|
127
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
125
128
|
* the header.</p>
|
|
126
129
|
* </note>
|
|
127
130
|
*/
|
|
@@ -156,8 +159,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
156
159
|
createChannelFlow(args: CreateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelFlowCommandOutput) => void): void;
|
|
157
160
|
/**
|
|
158
161
|
* @public
|
|
159
|
-
* <p>Adds a
|
|
160
|
-
* request header. A channel member can:</p>
|
|
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>
|
|
161
164
|
* <ul>
|
|
162
165
|
* <li>
|
|
163
166
|
* <p>List messages</p>
|
|
@@ -187,8 +190,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
187
190
|
* </ul>
|
|
188
191
|
* <note>
|
|
189
192
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
190
|
-
* <code>AppInstanceUserArn</code>
|
|
191
|
-
* the header.</p>
|
|
193
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call
|
|
194
|
+
* as the value in the header.</p>
|
|
192
195
|
* </note>
|
|
193
196
|
*/
|
|
194
197
|
createChannelMembership(args: CreateChannelMembershipCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelMembershipCommandOutput>;
|
|
@@ -216,7 +219,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
216
219
|
* </ul>
|
|
217
220
|
* <note>
|
|
218
221
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
219
|
-
* <code>
|
|
222
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in
|
|
220
223
|
* the header.</p>
|
|
221
224
|
* </note>
|
|
222
225
|
*/
|
|
@@ -229,7 +232,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
229
232
|
* deletion. This is an irreversible process.</p>
|
|
230
233
|
* <note>
|
|
231
234
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
232
|
-
* <code>AppInstanceUserArn</code>
|
|
235
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
233
236
|
* the header.</p>
|
|
234
237
|
* </note>
|
|
235
238
|
*/
|
|
@@ -238,10 +241,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
238
241
|
deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
|
|
239
242
|
/**
|
|
240
243
|
* @public
|
|
241
|
-
* <p>Removes a
|
|
244
|
+
* <p>Removes a member from a channel's ban list.</p>
|
|
242
245
|
* <note>
|
|
243
246
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
244
|
-
*
|
|
247
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
245
248
|
* the header.</p>
|
|
246
249
|
* </note>
|
|
247
250
|
*/
|
|
@@ -278,7 +281,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
278
281
|
* <code>UpdateChannelMessage</code>.</p>
|
|
279
282
|
* <note>
|
|
280
283
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
281
|
-
*
|
|
284
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
282
285
|
* the header.</p>
|
|
283
286
|
* </note>
|
|
284
287
|
*/
|
|
@@ -290,7 +293,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
290
293
|
* <p>Deletes a channel moderator.</p>
|
|
291
294
|
* <note>
|
|
292
295
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
293
|
-
*
|
|
296
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
294
297
|
* the header.</p>
|
|
295
298
|
* </note>
|
|
296
299
|
*/
|
|
@@ -311,7 +314,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
311
314
|
* <code>AppInstance</code>.</p>
|
|
312
315
|
* <note>
|
|
313
316
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
314
|
-
*
|
|
317
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
315
318
|
* the header.</p>
|
|
316
319
|
* </note>
|
|
317
320
|
*/
|
|
@@ -323,7 +326,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
323
326
|
* <p>Returns the full details of a channel ban.</p>
|
|
324
327
|
* <note>
|
|
325
328
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
326
|
-
*
|
|
329
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
327
330
|
* the header.</p>
|
|
328
331
|
* </note>
|
|
329
332
|
*/
|
|
@@ -342,7 +345,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
342
345
|
* <p>Returns the full details of a user's channel membership.</p>
|
|
343
346
|
* <note>
|
|
344
347
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
345
|
-
*
|
|
348
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
346
349
|
* the header.</p>
|
|
347
350
|
* </note>
|
|
348
351
|
*/
|
|
@@ -352,10 +355,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
352
355
|
/**
|
|
353
356
|
* @public
|
|
354
357
|
* <p> Returns the details of a channel based on the membership of the specified
|
|
355
|
-
* <code>AppInstanceUser</code>.</p>
|
|
358
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
|
|
356
359
|
* <note>
|
|
357
360
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
358
|
-
*
|
|
361
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
359
362
|
* the header.</p>
|
|
360
363
|
* </note>
|
|
361
364
|
*/
|
|
@@ -365,10 +368,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
365
368
|
/**
|
|
366
369
|
* @public
|
|
367
370
|
* <p>Returns the full details of a channel moderated by the specified
|
|
368
|
-
* <code>AppInstanceUser</code>.</p>
|
|
371
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>.</p>
|
|
369
372
|
* <note>
|
|
370
373
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
371
|
-
*
|
|
374
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
372
375
|
* the header.</p>
|
|
373
376
|
* </note>
|
|
374
377
|
*/
|
|
@@ -392,8 +395,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
392
395
|
* <p>Disassociates a channel flow from all its channels. Once disassociated, all messages to
|
|
393
396
|
* that channel stop going through the channel flow processor.</p>
|
|
394
397
|
* <note>
|
|
395
|
-
* <p>Only administrators or channel moderators can disassociate a channel flow
|
|
396
|
-
*
|
|
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>
|
|
397
402
|
* </note>
|
|
398
403
|
*/
|
|
399
404
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateChannelFlowCommandOutput>;
|
|
@@ -401,9 +406,16 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
401
406
|
disassociateChannelFlow(args: DisassociateChannelFlowCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateChannelFlowCommandOutput) => void): void;
|
|
402
407
|
/**
|
|
403
408
|
* @public
|
|
404
|
-
* <p>Gets the membership preferences of an <code>AppInstanceUser</code>
|
|
405
|
-
*
|
|
406
|
-
*
|
|
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>
|
|
407
419
|
*/
|
|
408
420
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelMembershipPreferencesCommandOutput>;
|
|
409
421
|
getChannelMembershipPreferences(args: GetChannelMembershipPreferencesCommandInput, cb: (err: any, data?: GetChannelMembershipPreferencesCommandOutput) => void): void;
|
|
@@ -412,8 +424,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
412
424
|
* @public
|
|
413
425
|
* <p>Gets the full details of a channel message.</p>
|
|
414
426
|
* <note>
|
|
415
|
-
* <p>The x-amz-chime-bearer request header is mandatory. Use the
|
|
416
|
-
*
|
|
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
|
|
417
429
|
* the header.</p>
|
|
418
430
|
* </note>
|
|
419
431
|
*/
|
|
@@ -452,7 +464,9 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
452
464
|
* <p>Only the message sender can invoke this API.</p>
|
|
453
465
|
* </li>
|
|
454
466
|
* <li>
|
|
455
|
-
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
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>
|
|
456
470
|
* </li>
|
|
457
471
|
* </ul>
|
|
458
472
|
* </note>
|
|
@@ -477,10 +491,10 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
477
491
|
getMessagingStreamingConfigurations(args: GetMessagingStreamingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMessagingStreamingConfigurationsCommandOutput) => void): void;
|
|
478
492
|
/**
|
|
479
493
|
* @public
|
|
480
|
-
* <p>Lists all the users banned from a particular channel.</p>
|
|
494
|
+
* <p>Lists all the users and bots banned from a particular channel.</p>
|
|
481
495
|
* <note>
|
|
482
496
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
483
|
-
*
|
|
497
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
484
498
|
* the header.</p>
|
|
485
499
|
* </note>
|
|
486
500
|
*/
|
|
@@ -499,7 +513,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
499
513
|
* <p>Lists all channel memberships in a channel.</p>
|
|
500
514
|
* <note>
|
|
501
515
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
502
|
-
*
|
|
516
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
503
517
|
* the header.</p>
|
|
504
518
|
* </note>
|
|
505
519
|
* <p>If you want to list the channels to which a specific app instance user belongs, see the
|
|
@@ -510,11 +524,11 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
510
524
|
listChannelMemberships(args: ListChannelMembershipsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelMembershipsCommandOutput) => void): void;
|
|
511
525
|
/**
|
|
512
526
|
* @public
|
|
513
|
-
* <p> Lists all channels that
|
|
514
|
-
*
|
|
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>
|
|
515
529
|
* <note>
|
|
516
530
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
517
|
-
*
|
|
531
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
518
532
|
* the header.</p>
|
|
519
533
|
* </note>
|
|
520
534
|
*/
|
|
@@ -530,8 +544,8 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
530
544
|
* <p>Redacted messages appear in the results as empty, since they are only redacted, not
|
|
531
545
|
* deleted. Deleted messages do not appear in the results. This action always returns the
|
|
532
546
|
* latest version of an edited message.</p>
|
|
533
|
-
* <p>Also, the x-amz-chime-bearer request header is mandatory. Use the
|
|
534
|
-
*
|
|
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
|
|
535
549
|
* the header.</p>
|
|
536
550
|
* </note>
|
|
537
551
|
*/
|
|
@@ -543,7 +557,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
543
557
|
* <p>Lists all the moderators for a channel.</p>
|
|
544
558
|
* <note>
|
|
545
559
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
546
|
-
*
|
|
560
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
547
561
|
* the header.</p>
|
|
548
562
|
* </note>
|
|
549
563
|
*/
|
|
@@ -569,7 +583,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
569
583
|
* </ul>
|
|
570
584
|
* <note>
|
|
571
585
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
572
|
-
*
|
|
586
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
573
587
|
* the header.</p>
|
|
574
588
|
* </note>
|
|
575
589
|
*/
|
|
@@ -588,7 +602,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
588
602
|
* <p>A list of the channels moderated by an <code>AppInstanceUser</code>.</p>
|
|
589
603
|
* <note>
|
|
590
604
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
591
|
-
*
|
|
605
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
592
606
|
* the header.</p>
|
|
593
607
|
* </note>
|
|
594
608
|
*/
|
|
@@ -611,9 +625,40 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
611
625
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
612
626
|
/**
|
|
613
627
|
* @public
|
|
614
|
-
* <p>Sets the
|
|
615
|
-
*
|
|
616
|
-
*
|
|
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>
|
|
646
|
+
*/
|
|
647
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelExpirationSettingsCommandOutput>;
|
|
648
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
|
|
649
|
+
putChannelExpirationSettings(args: PutChannelExpirationSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutChannelExpirationSettingsCommandOutput) => void): void;
|
|
650
|
+
/**
|
|
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>
|
|
617
662
|
*/
|
|
618
663
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, options?: __HttpHandlerOptions): Promise<PutChannelMembershipPreferencesCommandOutput>;
|
|
619
664
|
putChannelMembershipPreferences(args: PutChannelMembershipPreferencesCommandInput, cb: (err: any, data?: PutChannelMembershipPreferencesCommandOutput) => void): void;
|
|
@@ -632,7 +677,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
632
677
|
* action returns null content, and the state shows as redacted.</p>
|
|
633
678
|
* <note>
|
|
634
679
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
635
|
-
*
|
|
680
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
636
681
|
* the header.</p>
|
|
637
682
|
* </note>
|
|
638
683
|
*/
|
|
@@ -641,7 +686,12 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
641
686
|
redactChannelMessage(args: RedactChannelMessageCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedactChannelMessageCommandOutput) => void): void;
|
|
642
687
|
/**
|
|
643
688
|
* @public
|
|
644
|
-
* <p>Allows <code>ChimeBearer</code> to search channels by channel members.
|
|
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>
|
|
645
695
|
*/
|
|
646
696
|
searchChannels(args: SearchChannelsCommandInput, options?: __HttpHandlerOptions): Promise<SearchChannelsCommandOutput>;
|
|
647
697
|
searchChannels(args: SearchChannelsCommandInput, cb: (err: any, data?: SearchChannelsCommandOutput) => void): void;
|
|
@@ -651,7 +701,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
651
701
|
* <p>Sends a message to a particular channel that the member is a part of.</p>
|
|
652
702
|
* <note>
|
|
653
703
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
654
|
-
*
|
|
704
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
655
705
|
* the header.</p>
|
|
656
706
|
* <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata.
|
|
657
707
|
* <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p>
|
|
@@ -681,7 +731,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
681
731
|
* <b>Restriction</b>: You can't change a channel's privacy. </p>
|
|
682
732
|
* <note>
|
|
683
733
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
684
|
-
*
|
|
734
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
685
735
|
* the header.</p>
|
|
686
736
|
* </note>
|
|
687
737
|
*/
|
|
@@ -700,7 +750,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
700
750
|
* <p>Updates the content of a message.</p>
|
|
701
751
|
* <note>
|
|
702
752
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
703
|
-
*
|
|
753
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
704
754
|
* the header.</p>
|
|
705
755
|
* </note>
|
|
706
756
|
*/
|
|
@@ -712,7 +762,7 @@ export declare class ChimeSDKMessaging extends ChimeSDKMessagingClient {
|
|
|
712
762
|
* <p>The details of the time when a user last read messages in a channel.</p>
|
|
713
763
|
* <note>
|
|
714
764
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
715
|
-
*
|
|
765
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
716
766
|
* the header.</p>
|
|
717
767
|
* </note>
|
|
718
768
|
*/
|
|
@@ -46,6 +46,7 @@ import { ListChannelsCommandInput, ListChannelsCommandOutput } from "./commands/
|
|
|
46
46
|
import { ListChannelsModeratedByAppInstanceUserCommandInput, ListChannelsModeratedByAppInstanceUserCommandOutput } from "./commands/ListChannelsModeratedByAppInstanceUserCommand";
|
|
47
47
|
import { ListSubChannelsCommandInput, ListSubChannelsCommandOutput } from "./commands/ListSubChannelsCommand";
|
|
48
48
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
49
|
+
import { PutChannelExpirationSettingsCommandInput, PutChannelExpirationSettingsCommandOutput } from "./commands/PutChannelExpirationSettingsCommand";
|
|
49
50
|
import { PutChannelMembershipPreferencesCommandInput, PutChannelMembershipPreferencesCommandOutput } from "./commands/PutChannelMembershipPreferencesCommand";
|
|
50
51
|
import { PutMessagingStreamingConfigurationsCommandInput, PutMessagingStreamingConfigurationsCommandOutput } from "./commands/PutMessagingStreamingConfigurationsCommand";
|
|
51
52
|
import { RedactChannelMessageCommandInput, RedactChannelMessageCommandOutput } from "./commands/RedactChannelMessageCommand";
|
|
@@ -61,11 +62,11 @@ import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, Endpoi
|
|
|
61
62
|
/**
|
|
62
63
|
* @public
|
|
63
64
|
*/
|
|
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
|
+
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 | PutChannelExpirationSettingsCommandInput | PutChannelMembershipPreferencesCommandInput | PutMessagingStreamingConfigurationsCommandInput | RedactChannelMessageCommandInput | SearchChannelsCommandInput | SendChannelMessageCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateChannelCommandInput | UpdateChannelFlowCommandInput | UpdateChannelMessageCommandInput | UpdateChannelReadMarkerCommandInput;
|
|
65
66
|
/**
|
|
66
67
|
* @public
|
|
67
68
|
*/
|
|
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
|
+
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 | PutChannelExpirationSettingsCommandOutput | PutChannelMembershipPreferencesCommandOutput | PutMessagingStreamingConfigurationsCommandOutput | RedactChannelMessageCommandOutput | SearchChannelsCommandOutput | SendChannelMessageCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateChannelCommandOutput | UpdateChannelFlowCommandOutput | UpdateChannelMessageCommandOutput | UpdateChannelReadMarkerCommandOutput;
|
|
69
70
|
/**
|
|
70
71
|
* @public
|
|
71
72
|
*/
|
|
@@ -22,8 +22,10 @@ export interface AssociateChannelFlowCommandOutput extends __MetadataBearer {
|
|
|
22
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
|
|
23
23
|
* <code>DisassociateChannelFlow</code> API.</p>
|
|
24
24
|
* <note>
|
|
25
|
-
* <p>Only administrators or channel moderators can associate a channel flow. The
|
|
26
|
-
*
|
|
25
|
+
* <p>Only administrators or channel moderators can associate a channel flow. The
|
|
26
|
+
* <code>x-amz-chime-bearer</code> request header is mandatory. Use the ARN of the
|
|
27
|
+
* <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
28
|
+
* that makes the API call as the value in the header.</p>
|
|
27
29
|
* </note>
|
|
28
30
|
* @example
|
|
29
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -19,7 +19,7 @@ export interface BatchCreateChannelMembershipCommandOutput extends BatchCreateCh
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Adds a specified number of users to a channel. </p>
|
|
22
|
+
* <p>Adds a specified number of users and bots to a channel. </p>
|
|
23
23
|
* @example
|
|
24
24
|
* Use a bare-bones client and the command you need to make an API call.
|
|
25
25
|
* ```javascript
|
|
@@ -27,7 +27,7 @@ export interface CreateChannelBanCommandOutput extends CreateChannelBanResponse,
|
|
|
27
27
|
* from the channel.</p>
|
|
28
28
|
* <note>
|
|
29
29
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
30
|
-
* <code>
|
|
30
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
31
31
|
* the header.</p>
|
|
32
32
|
* </note>
|
|
33
33
|
* @example
|
|
@@ -25,7 +25,7 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
|
|
|
25
25
|
* privacy.</p>
|
|
26
26
|
* <note>
|
|
27
27
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
28
|
-
*
|
|
28
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
29
29
|
* the header.</p>
|
|
30
30
|
* </note>
|
|
31
31
|
* @example
|
|
@@ -19,8 +19,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Adds a
|
|
23
|
-
* request header. A channel member can:</p>
|
|
22
|
+
* <p>Adds a member to a channel. The <code>InvitedBy</code> field in <code>ChannelMembership</code>
|
|
23
|
+
* is derived from the request header. A channel member can:</p>
|
|
24
24
|
* <ul>
|
|
25
25
|
* <li>
|
|
26
26
|
* <p>List messages</p>
|
|
@@ -50,8 +50,8 @@ export interface CreateChannelMembershipCommandOutput extends CreateChannelMembe
|
|
|
50
50
|
* </ul>
|
|
51
51
|
* <note>
|
|
52
52
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
53
|
-
* <code>AppInstanceUserArn</code>
|
|
54
|
-
* the header.</p>
|
|
53
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call
|
|
54
|
+
* as the value in the header.</p>
|
|
55
55
|
* </note>
|
|
56
56
|
* @example
|
|
57
57
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -39,7 +39,7 @@ export interface CreateChannelModeratorCommandOutput extends CreateChannelModera
|
|
|
39
39
|
* </ul>
|
|
40
40
|
* <note>
|
|
41
41
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
42
|
-
* <code>
|
|
42
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>of the user that makes the API call as the value in
|
|
43
43
|
* the header.</p>
|
|
44
44
|
* </note>
|
|
45
45
|
* @example
|
|
@@ -19,10 +19,10 @@ export interface DeleteChannelBanCommandOutput extends __MetadataBearer {
|
|
|
19
19
|
}
|
|
20
20
|
/**
|
|
21
21
|
* @public
|
|
22
|
-
* <p>Removes a
|
|
22
|
+
* <p>Removes a member from a channel's ban list.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
25
|
-
*
|
|
25
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
26
26
|
* the header.</p>
|
|
27
27
|
* </note>
|
|
28
28
|
* @example
|
|
@@ -23,7 +23,7 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
|
|
|
23
23
|
* deletion. This is an irreversible process.</p>
|
|
24
24
|
* <note>
|
|
25
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
26
|
-
* <code>AppInstanceUserArn</code>
|
|
26
|
+
* ARN of the <code>AppInstanceUserArn</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
27
27
|
* the header.</p>
|
|
28
28
|
* </note>
|
|
29
29
|
* @example
|
|
@@ -24,7 +24,7 @@ export interface DeleteChannelMessageCommandOutput extends __MetadataBearer {
|
|
|
24
24
|
* <code>UpdateChannelMessage</code>.</p>
|
|
25
25
|
* <note>
|
|
26
26
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
27
|
-
*
|
|
27
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
28
28
|
* the header.</p>
|
|
29
29
|
* </note>
|
|
30
30
|
* @example
|
|
@@ -22,7 +22,7 @@ export interface DeleteChannelModeratorCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
* <p>Deletes a channel moderator.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
25
|
-
*
|
|
25
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
26
26
|
* the header.</p>
|
|
27
27
|
* </note>
|
|
28
28
|
* @example
|
|
@@ -22,7 +22,7 @@ export interface DescribeChannelBanCommandOutput extends DescribeChannelBanRespo
|
|
|
22
22
|
* <p>Returns the full details of a channel ban.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
25
|
-
*
|
|
25
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
26
26
|
* the header.</p>
|
|
27
27
|
* </note>
|
|
28
28
|
* @example
|
|
@@ -23,7 +23,7 @@ export interface DescribeChannelCommandOutput extends DescribeChannelResponse, _
|
|
|
23
23
|
* <code>AppInstance</code>.</p>
|
|
24
24
|
* <note>
|
|
25
25
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
26
|
-
*
|
|
26
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
27
27
|
* the header.</p>
|
|
28
28
|
* </note>
|
|
29
29
|
* @example
|
|
@@ -22,7 +22,7 @@ export interface DescribeChannelMembershipCommandOutput extends DescribeChannelM
|
|
|
22
22
|
* <p>Returns the full details of a user's channel membership.</p>
|
|
23
23
|
* <note>
|
|
24
24
|
* <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the
|
|
25
|
-
*
|
|
25
|
+
* ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call as the value in
|
|
26
26
|
* the header.</p>
|
|
27
27
|
* </note>
|
|
28
28
|
* @example
|