@aws-sdk/client-chime-sdk-messaging 3.529.1 → 3.535.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 +2 -1
- package/dist-types/ChimeSDKMessagingClient.d.ts +1 -1
- package/dist-types/commands/AssociateChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/BatchCreateChannelMembershipCommand.d.ts +2 -1
- package/dist-types/commands/ChannelFlowCallbackCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelBanCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelMembershipCommand.d.ts +2 -1
- package/dist-types/commands/CreateChannelModeratorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelBanCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelMembershipCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelMessageCommand.d.ts +2 -1
- package/dist-types/commands/DeleteChannelModeratorCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelBanCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelMembershipCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +2 -1
- package/dist-types/commands/DescribeChannelModeratorCommand.d.ts +2 -1
- package/dist-types/commands/DisassociateChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelMembershipPreferencesCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelMessageCommand.d.ts +2 -1
- package/dist-types/commands/GetChannelMessageStatusCommand.d.ts +2 -1
- package/dist-types/commands/GetMessagingSessionEndpointCommand.d.ts +2 -1
- package/dist-types/commands/GetMessagingStreamingConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelBansCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelFlowsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelMembershipsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelMessagesCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelModeratorsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelsCommand.d.ts +2 -1
- package/dist-types/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +2 -1
- package/dist-types/commands/ListSubChannelsCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/PutChannelExpirationSettingsCommand.d.ts +2 -1
- package/dist-types/commands/PutChannelMembershipPreferencesCommand.d.ts +2 -1
- package/dist-types/commands/PutMessagingStreamingConfigurationsCommand.d.ts +2 -1
- package/dist-types/commands/RedactChannelMessageCommand.d.ts +2 -1
- package/dist-types/commands/SearchChannelsCommand.d.ts +2 -1
- package/dist-types/commands/SendChannelMessageCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateChannelCommand.d.ts +2 -1
- package/dist-types/commands/UpdateChannelFlowCommand.d.ts +2 -1
- package/dist-types/commands/UpdateChannelMessageCommand.d.ts +2 -1
- package/dist-types/commands/UpdateChannelReadMarkerCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +443 -443
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/ChimeSDKMessaging.d.ts +1 -0
- package/dist-types/ts3.4/commands/AssociateChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/BatchCreateChannelMembershipCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ChannelFlowCallbackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelBanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelMembershipCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateChannelModeratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelBanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelMembershipCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteChannelModeratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMessagingStreamingConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelBanCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelMembershipCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelMembershipForAppInstanceUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelModeratedByAppInstanceUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeChannelModeratorCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DisassociateChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetChannelMembershipPreferencesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetChannelMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetChannelMessageStatusCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMessagingSessionEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMessagingStreamingConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelBansCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelFlowsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelMembershipsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelMembershipsForAppInstanceUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelMessagesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelModeratorsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelsAssociatedWithChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListChannelsModeratedByAppInstanceUserCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListSubChannelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutChannelExpirationSettingsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutChannelMembershipPreferencesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutMessagingStreamingConfigurationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RedactChannelMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchChannelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SendChannelMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateChannelFlowCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateChannelMessageCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateChannelReadMarkerCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -26,23 +26,23 @@ export declare const ChannelMembershipType: {
|
|
|
26
26
|
*/
|
|
27
27
|
export type ChannelMembershipType = (typeof ChannelMembershipType)[keyof typeof ChannelMembershipType];
|
|
28
28
|
/**
|
|
29
|
-
* @public
|
|
30
29
|
* <p>Summary of the membership details of an <code>AppInstanceUser</code>.</p>
|
|
30
|
+
* @public
|
|
31
31
|
*/
|
|
32
32
|
export interface AppInstanceUserMembershipSummary {
|
|
33
33
|
/**
|
|
34
|
-
* @public
|
|
35
34
|
* <p>The type of <code>ChannelMembership</code>.</p>
|
|
35
|
+
* @public
|
|
36
36
|
*/
|
|
37
37
|
Type?: ChannelMembershipType;
|
|
38
38
|
/**
|
|
39
|
-
* @public
|
|
40
39
|
* <p>The time at which an <code>AppInstanceUser</code> last marked a channel as read.</p>
|
|
40
|
+
* @public
|
|
41
41
|
*/
|
|
42
42
|
ReadMarkerTimestamp?: Date;
|
|
43
43
|
/**
|
|
44
|
-
* @public
|
|
45
44
|
* <p>The ID of the SubChannel that the <code>AppInstanceUser</code> is a member of.</p>
|
|
45
|
+
* @public
|
|
46
46
|
*/
|
|
47
47
|
SubChannelId?: string;
|
|
48
48
|
}
|
|
@@ -51,18 +51,18 @@ export interface AppInstanceUserMembershipSummary {
|
|
|
51
51
|
*/
|
|
52
52
|
export interface AssociateChannelFlowRequest {
|
|
53
53
|
/**
|
|
54
|
-
* @public
|
|
55
54
|
* <p>The ARN of the channel.</p>
|
|
55
|
+
* @public
|
|
56
56
|
*/
|
|
57
57
|
ChannelArn: string | undefined;
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>The ARN of the channel flow.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
ChannelFlowArn: string | undefined;
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
65
|
+
* @public
|
|
66
66
|
*/
|
|
67
67
|
ChimeBearer: string | undefined;
|
|
68
68
|
}
|
|
@@ -92,8 +92,8 @@ export declare const ErrorCode: {
|
|
|
92
92
|
*/
|
|
93
93
|
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
94
94
|
/**
|
|
95
|
-
* @public
|
|
96
95
|
* <p>The input parameters don't match the service's restrictions.</p>
|
|
96
|
+
* @public
|
|
97
97
|
*/
|
|
98
98
|
export declare class BadRequestException extends __BaseException {
|
|
99
99
|
readonly name: "BadRequestException";
|
|
@@ -106,9 +106,9 @@ export declare class BadRequestException extends __BaseException {
|
|
|
106
106
|
constructor(opts: __ExceptionOptionType<BadRequestException, __BaseException>);
|
|
107
107
|
}
|
|
108
108
|
/**
|
|
109
|
-
* @public
|
|
110
109
|
* <p>The request could not be processed because of conflict in the current state of the
|
|
111
110
|
* resource.</p>
|
|
111
|
+
* @public
|
|
112
112
|
*/
|
|
113
113
|
export declare class ConflictException extends __BaseException {
|
|
114
114
|
readonly name: "ConflictException";
|
|
@@ -121,8 +121,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
121
121
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
|
-
* @public
|
|
125
124
|
* <p>The client is permanently forbidden from making the request.</p>
|
|
125
|
+
* @public
|
|
126
126
|
*/
|
|
127
127
|
export declare class ForbiddenException extends __BaseException {
|
|
128
128
|
readonly name: "ForbiddenException";
|
|
@@ -135,8 +135,8 @@ export declare class ForbiddenException extends __BaseException {
|
|
|
135
135
|
constructor(opts: __ExceptionOptionType<ForbiddenException, __BaseException>);
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
* @public
|
|
139
138
|
* <p>One or more of the resources in the request does not exist in the system.</p>
|
|
139
|
+
* @public
|
|
140
140
|
*/
|
|
141
141
|
export declare class NotFoundException extends __BaseException {
|
|
142
142
|
readonly name: "NotFoundException";
|
|
@@ -149,8 +149,8 @@ export declare class NotFoundException extends __BaseException {
|
|
|
149
149
|
constructor(opts: __ExceptionOptionType<NotFoundException, __BaseException>);
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>The service encountered an unexpected error.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
export declare class ServiceFailureException extends __BaseException {
|
|
156
156
|
readonly name: "ServiceFailureException";
|
|
@@ -163,8 +163,8 @@ export declare class ServiceFailureException extends __BaseException {
|
|
|
163
163
|
constructor(opts: __ExceptionOptionType<ServiceFailureException, __BaseException>);
|
|
164
164
|
}
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <p>The service is currently unavailable.</p>
|
|
167
|
+
* @public
|
|
168
168
|
*/
|
|
169
169
|
export declare class ServiceUnavailableException extends __BaseException {
|
|
170
170
|
readonly name: "ServiceUnavailableException";
|
|
@@ -177,8 +177,8 @@ export declare class ServiceUnavailableException extends __BaseException {
|
|
|
177
177
|
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>The client exceeded its request rate limit.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
export declare class ThrottledClientException extends __BaseException {
|
|
184
184
|
readonly name: "ThrottledClientException";
|
|
@@ -191,8 +191,8 @@ export declare class ThrottledClientException extends __BaseException {
|
|
|
191
191
|
constructor(opts: __ExceptionOptionType<ThrottledClientException, __BaseException>);
|
|
192
192
|
}
|
|
193
193
|
/**
|
|
194
|
-
* @public
|
|
195
194
|
* <p>The client is not currently authorized to make the request.</p>
|
|
195
|
+
* @public
|
|
196
196
|
*/
|
|
197
197
|
export declare class UnauthorizedClientException extends __BaseException {
|
|
198
198
|
readonly name: "UnauthorizedClientException";
|
|
@@ -205,50 +205,50 @@ export declare class UnauthorizedClientException extends __BaseException {
|
|
|
205
205
|
constructor(opts: __ExceptionOptionType<UnauthorizedClientException, __BaseException>);
|
|
206
206
|
}
|
|
207
207
|
/**
|
|
208
|
-
* @public
|
|
209
208
|
* <p>The details of a user or bot.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
export interface Identity {
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>The ARN in an Identity.</p>
|
|
214
|
+
* @public
|
|
215
215
|
*/
|
|
216
216
|
Arn?: string;
|
|
217
217
|
/**
|
|
218
|
-
* @public
|
|
219
218
|
* <p>The name in an Identity.</p>
|
|
219
|
+
* @public
|
|
220
220
|
*/
|
|
221
221
|
Name?: string;
|
|
222
222
|
}
|
|
223
223
|
/**
|
|
224
|
-
* @public
|
|
225
224
|
* <p>The membership information, including member ARNs, the channel ARN, and membership
|
|
226
225
|
* types.</p>
|
|
226
|
+
* @public
|
|
227
227
|
*/
|
|
228
228
|
export interface BatchChannelMemberships {
|
|
229
229
|
/**
|
|
230
|
-
* @public
|
|
231
230
|
* <p>The identifier of the member who invited another member.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
InvitedBy?: Identity;
|
|
234
234
|
/**
|
|
235
|
-
* @public
|
|
236
235
|
* <p>The membership types set for the channel members.</p>
|
|
236
|
+
* @public
|
|
237
237
|
*/
|
|
238
238
|
Type?: ChannelMembershipType;
|
|
239
239
|
/**
|
|
240
|
-
* @public
|
|
241
240
|
* <p>The users successfully added to the request.</p>
|
|
241
|
+
* @public
|
|
242
242
|
*/
|
|
243
243
|
Members?: Identity[];
|
|
244
244
|
/**
|
|
245
|
-
* @public
|
|
246
245
|
* <p>The ARN of the channel to which you're adding members.</p>
|
|
246
|
+
* @public
|
|
247
247
|
*/
|
|
248
248
|
ChannelArn?: string;
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>The ID of the SubChannel.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
SubChannelId?: string;
|
|
254
254
|
}
|
|
@@ -257,58 +257,58 @@ export interface BatchChannelMemberships {
|
|
|
257
257
|
*/
|
|
258
258
|
export interface BatchCreateChannelMembershipRequest {
|
|
259
259
|
/**
|
|
260
|
-
* @public
|
|
261
260
|
* <p>The ARN of the channel to which you're adding users or bots.</p>
|
|
261
|
+
* @public
|
|
262
262
|
*/
|
|
263
263
|
ChannelArn: string | undefined;
|
|
264
264
|
/**
|
|
265
|
-
* @public
|
|
266
265
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
267
266
|
* members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
|
|
268
267
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
269
268
|
* <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported
|
|
270
269
|
* by moderators.</p>
|
|
270
|
+
* @public
|
|
271
271
|
*/
|
|
272
272
|
Type?: ChannelMembershipType;
|
|
273
273
|
/**
|
|
274
|
-
* @public
|
|
275
274
|
* <p>The ARNs of the members you want to add to the channel. Only <code>AppInstanceUsers</code> and
|
|
276
275
|
* <code>AppInstanceBots</code> can be added as a channel member.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
MemberArns: string[] | undefined;
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
282
281
|
* that makes the API call.</p>
|
|
282
|
+
* @public
|
|
283
283
|
*/
|
|
284
284
|
ChimeBearer: string | undefined;
|
|
285
285
|
/**
|
|
286
|
-
* @public
|
|
287
286
|
* <p>The ID of the SubChannel in the request. </p>
|
|
288
287
|
* <note>
|
|
289
288
|
* <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p>
|
|
290
289
|
* </note>
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
SubChannelId?: string;
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>A list of failed member ARNs, error codes, and error messages.</p>
|
|
296
|
+
* @public
|
|
297
297
|
*/
|
|
298
298
|
export interface BatchCreateChannelMembershipError {
|
|
299
299
|
/**
|
|
300
|
-
* @public
|
|
301
300
|
* <p>The <code>AppInstanceUserArn</code> of the member that the service couldn't add.</p>
|
|
301
|
+
* @public
|
|
302
302
|
*/
|
|
303
303
|
MemberArn?: string;
|
|
304
304
|
/**
|
|
305
|
-
* @public
|
|
306
305
|
* <p>The error code.</p>
|
|
306
|
+
* @public
|
|
307
307
|
*/
|
|
308
308
|
ErrorCode?: ErrorCode;
|
|
309
309
|
/**
|
|
310
|
-
* @public
|
|
311
310
|
* <p>The error message.</p>
|
|
311
|
+
* @public
|
|
312
312
|
*/
|
|
313
313
|
ErrorMessage?: string;
|
|
314
314
|
}
|
|
@@ -317,20 +317,20 @@ export interface BatchCreateChannelMembershipError {
|
|
|
317
317
|
*/
|
|
318
318
|
export interface BatchCreateChannelMembershipResponse {
|
|
319
319
|
/**
|
|
320
|
-
* @public
|
|
321
320
|
* <p>The list of channel memberships in the response.</p>
|
|
321
|
+
* @public
|
|
322
322
|
*/
|
|
323
323
|
BatchChannelMemberships?: BatchChannelMemberships;
|
|
324
324
|
/**
|
|
325
|
-
* @public
|
|
326
325
|
* <p>If the action fails for one or more of the memberships in the request, a list of the
|
|
327
326
|
* memberships is returned, along with error codes and error messages.</p>
|
|
327
|
+
* @public
|
|
328
328
|
*/
|
|
329
329
|
Errors?: BatchCreateChannelMembershipError[];
|
|
330
330
|
}
|
|
331
331
|
/**
|
|
332
|
-
* @public
|
|
333
332
|
* <p>The request exceeds the resource limit.</p>
|
|
333
|
+
* @public
|
|
334
334
|
*/
|
|
335
335
|
export declare class ResourceLimitExceededException extends __BaseException {
|
|
336
336
|
readonly name: "ResourceLimitExceededException";
|
|
@@ -343,23 +343,23 @@ export declare class ResourceLimitExceededException extends __BaseException {
|
|
|
343
343
|
constructor(opts: __ExceptionOptionType<ResourceLimitExceededException, __BaseException>);
|
|
344
344
|
}
|
|
345
345
|
/**
|
|
346
|
-
* @public
|
|
347
346
|
* <p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
export interface ElasticChannelConfiguration {
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>The maximum number of SubChannels that you want to allow in the elastic channel.</p>
|
|
352
|
+
* @public
|
|
353
353
|
*/
|
|
354
354
|
MaximumSubChannels: number | undefined;
|
|
355
355
|
/**
|
|
356
|
-
* @public
|
|
357
356
|
* <p>The maximum number of members allowed in a SubChannel.</p>
|
|
357
|
+
* @public
|
|
358
358
|
*/
|
|
359
359
|
TargetMembershipsPerSubChannel: number | undefined;
|
|
360
360
|
/**
|
|
361
|
-
* @public
|
|
362
361
|
* <p>The minimum allowed percentage of TargetMembershipsPerSubChannel users. Ceil of the calculated value is used in balancing members among SubChannels of the elastic channel.</p>
|
|
362
|
+
* @public
|
|
363
363
|
*/
|
|
364
364
|
MinimumMembershipPercentage: number | undefined;
|
|
365
365
|
}
|
|
@@ -376,18 +376,18 @@ export declare const ExpirationCriterion: {
|
|
|
376
376
|
*/
|
|
377
377
|
export type ExpirationCriterion = (typeof ExpirationCriterion)[keyof typeof ExpirationCriterion];
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>Settings that control the interval after which a channel is deleted.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
export interface ExpirationSettings {
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>The period in days after which the system automatically deletes a channel.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
ExpirationDays: number | undefined;
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>The conditions that must be met for a channel to expire.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
ExpirationCriterion: ExpirationCriterion | undefined;
|
|
393
393
|
}
|
|
@@ -416,136 +416,136 @@ export declare const ChannelPrivacy: {
|
|
|
416
416
|
*/
|
|
417
417
|
export type ChannelPrivacy = (typeof ChannelPrivacy)[keyof typeof ChannelPrivacy];
|
|
418
418
|
/**
|
|
419
|
-
* @public
|
|
420
419
|
* <p>The details of a channel.</p>
|
|
420
|
+
* @public
|
|
421
421
|
*/
|
|
422
422
|
export interface Channel {
|
|
423
423
|
/**
|
|
424
|
-
* @public
|
|
425
424
|
* <p>The name of a channel.</p>
|
|
425
|
+
* @public
|
|
426
426
|
*/
|
|
427
427
|
Name?: string;
|
|
428
428
|
/**
|
|
429
|
-
* @public
|
|
430
429
|
* <p>The ARN of a channel.</p>
|
|
430
|
+
* @public
|
|
431
431
|
*/
|
|
432
432
|
ChannelArn?: string;
|
|
433
433
|
/**
|
|
434
|
-
* @public
|
|
435
434
|
* <p>The mode of the channel.</p>
|
|
435
|
+
* @public
|
|
436
436
|
*/
|
|
437
437
|
Mode?: ChannelMode;
|
|
438
438
|
/**
|
|
439
|
-
* @public
|
|
440
439
|
* <p>The channel's privacy setting.</p>
|
|
440
|
+
* @public
|
|
441
441
|
*/
|
|
442
442
|
Privacy?: ChannelPrivacy;
|
|
443
443
|
/**
|
|
444
|
-
* @public
|
|
445
444
|
* <p>The channel's metadata.</p>
|
|
445
|
+
* @public
|
|
446
446
|
*/
|
|
447
447
|
Metadata?: string;
|
|
448
448
|
/**
|
|
449
|
-
* @public
|
|
450
449
|
* <p>The <code>AppInstanceUser</code> who created the channel.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
CreatedBy?: Identity;
|
|
453
453
|
/**
|
|
454
|
-
* @public
|
|
455
454
|
* <p>The time at which the <code>AppInstanceUser</code> created the channel.</p>
|
|
455
|
+
* @public
|
|
456
456
|
*/
|
|
457
457
|
CreatedTimestamp?: Date;
|
|
458
458
|
/**
|
|
459
|
-
* @public
|
|
460
459
|
* <p>The time at which a member sent the last message in the channel.</p>
|
|
460
|
+
* @public
|
|
461
461
|
*/
|
|
462
462
|
LastMessageTimestamp?: Date;
|
|
463
463
|
/**
|
|
464
|
-
* @public
|
|
465
464
|
* <p>The time at which a channel was last updated.</p>
|
|
465
|
+
* @public
|
|
466
466
|
*/
|
|
467
467
|
LastUpdatedTimestamp?: Date;
|
|
468
468
|
/**
|
|
469
|
-
* @public
|
|
470
469
|
* <p>The ARN of the channel flow.</p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
ChannelFlowArn?: string;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million members.</p>
|
|
475
|
+
* @public
|
|
476
476
|
*/
|
|
477
477
|
ElasticChannelConfiguration?: ElasticChannelConfiguration;
|
|
478
478
|
/**
|
|
479
|
-
* @public
|
|
480
479
|
* <p>Settings that control when a channel expires.</p>
|
|
480
|
+
* @public
|
|
481
481
|
*/
|
|
482
482
|
ExpirationSettings?: ExpirationSettings;
|
|
483
483
|
}
|
|
484
484
|
/**
|
|
485
|
-
* @public
|
|
486
485
|
* <p>Summary of details of a channel associated with channel flow.</p>
|
|
486
|
+
* @public
|
|
487
487
|
*/
|
|
488
488
|
export interface ChannelAssociatedWithFlowSummary {
|
|
489
489
|
/**
|
|
490
|
-
* @public
|
|
491
490
|
* <p>The name of the channel flow.</p>
|
|
491
|
+
* @public
|
|
492
492
|
*/
|
|
493
493
|
Name?: string;
|
|
494
494
|
/**
|
|
495
|
-
* @public
|
|
496
495
|
* <p>The ARN of the channel.</p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
ChannelArn?: string;
|
|
499
499
|
/**
|
|
500
|
-
* @public
|
|
501
500
|
* <p>The mode of the channel.</p>
|
|
501
|
+
* @public
|
|
502
502
|
*/
|
|
503
503
|
Mode?: ChannelMode;
|
|
504
504
|
/**
|
|
505
|
-
* @public
|
|
506
505
|
* <p>The channel's privacy setting.</p>
|
|
506
|
+
* @public
|
|
507
507
|
*/
|
|
508
508
|
Privacy?: ChannelPrivacy;
|
|
509
509
|
/**
|
|
510
|
-
* @public
|
|
511
510
|
* <p>The channel's metadata.</p>
|
|
511
|
+
* @public
|
|
512
512
|
*/
|
|
513
513
|
Metadata?: string;
|
|
514
514
|
}
|
|
515
515
|
/**
|
|
516
|
-
* @public
|
|
517
516
|
* <p>The details of a channel ban.</p>
|
|
517
|
+
* @public
|
|
518
518
|
*/
|
|
519
519
|
export interface ChannelBan {
|
|
520
520
|
/**
|
|
521
|
-
* @public
|
|
522
521
|
* <p>The member being banned from the channel.</p>
|
|
522
|
+
* @public
|
|
523
523
|
*/
|
|
524
524
|
Member?: Identity;
|
|
525
525
|
/**
|
|
526
|
-
* @public
|
|
527
526
|
* <p>The ARN of the channel from which a member is being banned.</p>
|
|
527
|
+
* @public
|
|
528
528
|
*/
|
|
529
529
|
ChannelArn?: string;
|
|
530
530
|
/**
|
|
531
|
-
* @public
|
|
532
531
|
* <p>The time at which the ban was created.</p>
|
|
532
|
+
* @public
|
|
533
533
|
*/
|
|
534
534
|
CreatedTimestamp?: Date;
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The <code>AppInstanceUser</code> who created the ban.</p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
CreatedBy?: Identity;
|
|
540
540
|
}
|
|
541
541
|
/**
|
|
542
|
-
* @public
|
|
543
542
|
* <p>Summary of the details of a <code>ChannelBan</code>.</p>
|
|
543
|
+
* @public
|
|
544
544
|
*/
|
|
545
545
|
export interface ChannelBanSummary {
|
|
546
546
|
/**
|
|
547
|
-
* @public
|
|
548
547
|
* <p>The member being banned from a channel.</p>
|
|
548
|
+
* @public
|
|
549
549
|
*/
|
|
550
550
|
Member?: Identity;
|
|
551
551
|
}
|
|
@@ -561,29 +561,29 @@ export declare const InvocationType: {
|
|
|
561
561
|
*/
|
|
562
562
|
export type InvocationType = (typeof InvocationType)[keyof typeof InvocationType];
|
|
563
563
|
/**
|
|
564
|
-
* @public
|
|
565
564
|
* <p>Stores metadata about a Lambda processor.</p>
|
|
565
|
+
* @public
|
|
566
566
|
*/
|
|
567
567
|
export interface LambdaConfiguration {
|
|
568
568
|
/**
|
|
569
|
-
* @public
|
|
570
569
|
* <p>The ARN of the Lambda message processing function.</p>
|
|
570
|
+
* @public
|
|
571
571
|
*/
|
|
572
572
|
ResourceArn: string | undefined;
|
|
573
573
|
/**
|
|
574
|
-
* @public
|
|
575
574
|
* <p>Controls how the Lambda function is invoked.</p>
|
|
575
|
+
* @public
|
|
576
576
|
*/
|
|
577
577
|
InvocationType: InvocationType | undefined;
|
|
578
578
|
}
|
|
579
579
|
/**
|
|
580
|
-
* @public
|
|
581
580
|
* <p>A processor's metadata.</p>
|
|
581
|
+
* @public
|
|
582
582
|
*/
|
|
583
583
|
export interface ProcessorConfiguration {
|
|
584
584
|
/**
|
|
585
|
-
* @public
|
|
586
585
|
* <p>Indicates that the processor is of type Lambda.</p>
|
|
586
|
+
* @public
|
|
587
587
|
*/
|
|
588
588
|
Lambda: LambdaConfiguration | undefined;
|
|
589
589
|
}
|
|
@@ -600,73 +600,73 @@ export declare const FallbackAction: {
|
|
|
600
600
|
*/
|
|
601
601
|
export type FallbackAction = (typeof FallbackAction)[keyof typeof FallbackAction];
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>The information about a processor in a channel flow.</p>
|
|
604
|
+
* @public
|
|
605
605
|
*/
|
|
606
606
|
export interface Processor {
|
|
607
607
|
/**
|
|
608
|
-
* @public
|
|
609
608
|
* <p>The name of the channel flow.</p>
|
|
609
|
+
* @public
|
|
610
610
|
*/
|
|
611
611
|
Name: string | undefined;
|
|
612
612
|
/**
|
|
613
|
-
* @public
|
|
614
613
|
* <p>The information about the type of processor and its identifier.</p>
|
|
614
|
+
* @public
|
|
615
615
|
*/
|
|
616
616
|
Configuration: ProcessorConfiguration | undefined;
|
|
617
617
|
/**
|
|
618
|
-
* @public
|
|
619
618
|
* <p>The sequence in which processors run. If you have multiple processors in a channel flow, message processing goes through each processor in the sequence. The value determines the sequence.
|
|
620
619
|
* At this point, we support only 1 processor within a flow.</p>
|
|
620
|
+
* @public
|
|
621
621
|
*/
|
|
622
622
|
ExecutionOrder: number | undefined;
|
|
623
623
|
/**
|
|
624
|
-
* @public
|
|
625
624
|
* <p>Determines whether to continue with message processing or stop it in cases where communication with a processor fails. If a processor has a fallback action of <code>ABORT</code> and
|
|
626
625
|
* communication with it fails, the processor sets the message status to <code>FAILED</code> and does not send the message to any recipients. Note that if the last processor in the channel flow sequence
|
|
627
626
|
* has a fallback action of <code>CONTINUE</code> and communication with the processor fails, then the message is considered processed and sent to recipients of the channel.</p>
|
|
627
|
+
* @public
|
|
628
628
|
*/
|
|
629
629
|
FallbackAction: FallbackAction | undefined;
|
|
630
630
|
}
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>The details of a channel flow.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
export interface ChannelFlow {
|
|
636
636
|
/**
|
|
637
|
-
* @public
|
|
638
637
|
* <p>The ARN of the channel flow.</p>
|
|
638
|
+
* @public
|
|
639
639
|
*/
|
|
640
640
|
ChannelFlowArn?: string;
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>Information about the processor Lambda functions.</p>
|
|
643
|
+
* @public
|
|
644
644
|
*/
|
|
645
645
|
Processors?: Processor[];
|
|
646
646
|
/**
|
|
647
|
-
* @public
|
|
648
647
|
* <p>The name of the channel flow.</p>
|
|
648
|
+
* @public
|
|
649
649
|
*/
|
|
650
650
|
Name?: string;
|
|
651
651
|
/**
|
|
652
|
-
* @public
|
|
653
652
|
* <p>The time at which the channel flow was created.</p>
|
|
653
|
+
* @public
|
|
654
654
|
*/
|
|
655
655
|
CreatedTimestamp?: Date;
|
|
656
656
|
/**
|
|
657
|
-
* @public
|
|
658
657
|
* <p>The time at which a channel flow was updated.</p>
|
|
658
|
+
* @public
|
|
659
659
|
*/
|
|
660
660
|
LastUpdatedTimestamp?: Date;
|
|
661
661
|
}
|
|
662
662
|
/**
|
|
663
|
-
* @public
|
|
664
663
|
* <p>A list of message attribute values.</p>
|
|
664
|
+
* @public
|
|
665
665
|
*/
|
|
666
666
|
export interface MessageAttributeValue {
|
|
667
667
|
/**
|
|
668
|
-
* @public
|
|
669
668
|
* <p>The strings in a message attribute value.</p>
|
|
669
|
+
* @public
|
|
670
670
|
*/
|
|
671
671
|
StringValues?: string[];
|
|
672
672
|
}
|
|
@@ -683,73 +683,73 @@ export declare const PushNotificationType: {
|
|
|
683
683
|
*/
|
|
684
684
|
export type PushNotificationType = (typeof PushNotificationType)[keyof typeof PushNotificationType];
|
|
685
685
|
/**
|
|
686
|
-
* @public
|
|
687
686
|
* <p>The push notification configuration of the message.</p>
|
|
687
|
+
* @public
|
|
688
688
|
*/
|
|
689
689
|
export interface PushNotificationConfiguration {
|
|
690
690
|
/**
|
|
691
|
-
* @public
|
|
692
691
|
* <p>The title of the push notification.</p>
|
|
692
|
+
* @public
|
|
693
693
|
*/
|
|
694
694
|
Title?: string;
|
|
695
695
|
/**
|
|
696
|
-
* @public
|
|
697
696
|
* <p>The body of the push notification.</p>
|
|
697
|
+
* @public
|
|
698
698
|
*/
|
|
699
699
|
Body?: string;
|
|
700
700
|
/**
|
|
701
|
-
* @public
|
|
702
701
|
* <p>Enum value that indicates the type of the push notification for a message.
|
|
703
702
|
* <code>DEFAULT</code>: Normal mobile push notification.
|
|
704
703
|
* <code>VOIP</code>: VOIP mobile push notification.</p>
|
|
704
|
+
* @public
|
|
705
705
|
*/
|
|
706
706
|
Type?: PushNotificationType;
|
|
707
707
|
}
|
|
708
708
|
/**
|
|
709
|
-
* @public
|
|
710
709
|
* <p>Stores information about a callback.</p>
|
|
710
|
+
* @public
|
|
711
711
|
*/
|
|
712
712
|
export interface ChannelMessageCallback {
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>The message ID.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
MessageId: string | undefined;
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The message content. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
721
720
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
722
721
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
722
|
+
* @public
|
|
723
723
|
*/
|
|
724
724
|
Content?: string;
|
|
725
725
|
/**
|
|
726
|
-
* @public
|
|
727
726
|
* <p>The message metadata.</p>
|
|
727
|
+
* @public
|
|
728
728
|
*/
|
|
729
729
|
Metadata?: string;
|
|
730
730
|
/**
|
|
731
|
-
* @public
|
|
732
731
|
* <p>The push notification configuration of the message.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
PushNotification?: PushNotificationConfiguration;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
738
737
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
739
738
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
739
|
+
* @public
|
|
740
740
|
*/
|
|
741
741
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
742
742
|
/**
|
|
743
|
-
* @public
|
|
744
743
|
* <p>The ID of the SubChannel.</p>
|
|
744
|
+
* @public
|
|
745
745
|
*/
|
|
746
746
|
SubChannelId?: string;
|
|
747
747
|
/**
|
|
748
|
-
* @public
|
|
749
748
|
* <p>The content type of the call-back message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
750
749
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
751
750
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
752
751
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
752
|
+
* @public
|
|
753
753
|
*/
|
|
754
754
|
ContentType?: string;
|
|
755
755
|
}
|
|
@@ -758,23 +758,23 @@ export interface ChannelMessageCallback {
|
|
|
758
758
|
*/
|
|
759
759
|
export interface ChannelFlowCallbackRequest {
|
|
760
760
|
/**
|
|
761
|
-
* @public
|
|
762
761
|
* <p>The identifier passed to the processor by the service when invoked. Use the identifier to call back the service.</p>
|
|
762
|
+
* @public
|
|
763
763
|
*/
|
|
764
764
|
CallbackId?: string;
|
|
765
765
|
/**
|
|
766
|
-
* @public
|
|
767
766
|
* <p>The ARN of the channel.</p>
|
|
767
|
+
* @public
|
|
768
768
|
*/
|
|
769
769
|
ChannelArn: string | undefined;
|
|
770
770
|
/**
|
|
771
|
-
* @public
|
|
772
771
|
* <p>When a processor determines that a message needs to be <code>DENIED</code>, pass this parameter with a value of true.</p>
|
|
772
|
+
* @public
|
|
773
773
|
*/
|
|
774
774
|
DeleteResource?: boolean;
|
|
775
775
|
/**
|
|
776
|
-
* @public
|
|
777
776
|
* <p>Stores information about the processed message.</p>
|
|
777
|
+
* @public
|
|
778
778
|
*/
|
|
779
779
|
ChannelMessage: ChannelMessageCallback | undefined;
|
|
780
780
|
}
|
|
@@ -783,167 +783,167 @@ export interface ChannelFlowCallbackRequest {
|
|
|
783
783
|
*/
|
|
784
784
|
export interface ChannelFlowCallbackResponse {
|
|
785
785
|
/**
|
|
786
|
-
* @public
|
|
787
786
|
* <p>The ARN of the channel.</p>
|
|
787
|
+
* @public
|
|
788
788
|
*/
|
|
789
789
|
ChannelArn?: string;
|
|
790
790
|
/**
|
|
791
|
-
* @public
|
|
792
791
|
* <p>The call back ID passed in the request.</p>
|
|
792
|
+
* @public
|
|
793
793
|
*/
|
|
794
794
|
CallbackId?: string;
|
|
795
795
|
}
|
|
796
796
|
/**
|
|
797
|
-
* @public
|
|
798
797
|
* <p>Summary of details of a channel flow.</p>
|
|
798
|
+
* @public
|
|
799
799
|
*/
|
|
800
800
|
export interface ChannelFlowSummary {
|
|
801
801
|
/**
|
|
802
|
-
* @public
|
|
803
802
|
* <p>The ARN of the channel flow.</p>
|
|
803
|
+
* @public
|
|
804
804
|
*/
|
|
805
805
|
ChannelFlowArn?: string;
|
|
806
806
|
/**
|
|
807
|
-
* @public
|
|
808
807
|
* <p>The name of the channel flow.</p>
|
|
808
|
+
* @public
|
|
809
809
|
*/
|
|
810
810
|
Name?: string;
|
|
811
811
|
/**
|
|
812
|
-
* @public
|
|
813
812
|
* <p>Information about the processor Lambda functions.</p>
|
|
813
|
+
* @public
|
|
814
814
|
*/
|
|
815
815
|
Processors?: Processor[];
|
|
816
816
|
}
|
|
817
817
|
/**
|
|
818
|
-
* @public
|
|
819
818
|
* <p>The details of a channel member.</p>
|
|
819
|
+
* @public
|
|
820
820
|
*/
|
|
821
821
|
export interface ChannelMembership {
|
|
822
822
|
/**
|
|
823
|
-
* @public
|
|
824
823
|
* <p>The identifier of the member who invited another member.</p>
|
|
824
|
+
* @public
|
|
825
825
|
*/
|
|
826
826
|
InvitedBy?: Identity;
|
|
827
827
|
/**
|
|
828
|
-
* @public
|
|
829
828
|
* <p>The membership type set for the channel member.</p>
|
|
829
|
+
* @public
|
|
830
830
|
*/
|
|
831
831
|
Type?: ChannelMembershipType;
|
|
832
832
|
/**
|
|
833
|
-
* @public
|
|
834
833
|
* <p>The data of the channel member.</p>
|
|
834
|
+
* @public
|
|
835
835
|
*/
|
|
836
836
|
Member?: Identity;
|
|
837
837
|
/**
|
|
838
|
-
* @public
|
|
839
838
|
* <p>The ARN of the member's channel.</p>
|
|
839
|
+
* @public
|
|
840
840
|
*/
|
|
841
841
|
ChannelArn?: string;
|
|
842
842
|
/**
|
|
843
|
-
* @public
|
|
844
843
|
* <p>The time at which the channel membership was created.</p>
|
|
844
|
+
* @public
|
|
845
845
|
*/
|
|
846
846
|
CreatedTimestamp?: Date;
|
|
847
847
|
/**
|
|
848
|
-
* @public
|
|
849
848
|
* <p>The time at which a channel membership was last updated.</p>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
LastUpdatedTimestamp?: Date;
|
|
852
852
|
/**
|
|
853
|
-
* @public
|
|
854
853
|
* <p>The ID of the SubChannel that a user belongs to.</p>
|
|
854
|
+
* @public
|
|
855
855
|
*/
|
|
856
856
|
SubChannelId?: string;
|
|
857
857
|
}
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>Summary of the details of a <code>Channel</code>.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
export interface ChannelSummary {
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>The name of the channel.</p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
Name?: string;
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p>The ARN of the channel.</p>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
ChannelArn?: string;
|
|
873
873
|
/**
|
|
874
|
-
* @public
|
|
875
874
|
* <p>The mode of the channel.</p>
|
|
875
|
+
* @public
|
|
876
876
|
*/
|
|
877
877
|
Mode?: ChannelMode;
|
|
878
878
|
/**
|
|
879
|
-
* @public
|
|
880
879
|
* <p>The privacy setting of the channel.</p>
|
|
880
|
+
* @public
|
|
881
881
|
*/
|
|
882
882
|
Privacy?: ChannelPrivacy;
|
|
883
883
|
/**
|
|
884
|
-
* @public
|
|
885
884
|
* <p>The metadata of the channel.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
Metadata?: string;
|
|
888
888
|
/**
|
|
889
|
-
* @public
|
|
890
889
|
* <p>The time at which the last persistent message visible to the caller in a channel was sent.</p>
|
|
890
|
+
* @public
|
|
891
891
|
*/
|
|
892
892
|
LastMessageTimestamp?: Date;
|
|
893
893
|
}
|
|
894
894
|
/**
|
|
895
|
-
* @public
|
|
896
895
|
* <p>Summary of the channel membership details of an <code>AppInstanceUser</code>.</p>
|
|
896
|
+
* @public
|
|
897
897
|
*/
|
|
898
898
|
export interface ChannelMembershipForAppInstanceUserSummary {
|
|
899
899
|
/**
|
|
900
|
-
* @public
|
|
901
900
|
* <p>Returns the channel data for an <code>AppInstance</code>.</p>
|
|
901
|
+
* @public
|
|
902
902
|
*/
|
|
903
903
|
ChannelSummary?: ChannelSummary;
|
|
904
904
|
/**
|
|
905
|
-
* @public
|
|
906
905
|
* <p>Returns the channel membership data for an <code>AppInstance</code>.</p>
|
|
906
|
+
* @public
|
|
907
907
|
*/
|
|
908
908
|
AppInstanceUserMembershipSummary?: AppInstanceUserMembershipSummary;
|
|
909
909
|
}
|
|
910
910
|
/**
|
|
911
|
-
* @public
|
|
912
911
|
* <p>The channel membership preferences for push notification.</p>
|
|
912
|
+
* @public
|
|
913
913
|
*/
|
|
914
914
|
export interface PushNotificationPreferences {
|
|
915
915
|
/**
|
|
916
|
-
* @public
|
|
917
916
|
* <p>Enum value that indicates which push notifications to send to the requested member of a channel.
|
|
918
917
|
* <code>ALL</code> sends all push notifications, <code>NONE</code> sends no push notifications, <code>FILTERED</code> sends only filtered push notifications.
|
|
919
918
|
* </p>
|
|
919
|
+
* @public
|
|
920
920
|
*/
|
|
921
921
|
AllowNotifications: AllowNotifications | undefined;
|
|
922
922
|
/**
|
|
923
|
-
* @public
|
|
924
923
|
* <p>The simple JSON object used to send a subset of a push notification to the requested member.</p>
|
|
924
|
+
* @public
|
|
925
925
|
*/
|
|
926
926
|
FilterRule?: string;
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
|
-
* @public
|
|
930
929
|
* <p>The channel membership preferences for an <code>AppInstanceUser</code>.</p>
|
|
930
|
+
* @public
|
|
931
931
|
*/
|
|
932
932
|
export interface ChannelMembershipPreferences {
|
|
933
933
|
/**
|
|
934
|
-
* @public
|
|
935
934
|
* <p>The push notification configuration of a message.</p>
|
|
935
|
+
* @public
|
|
936
936
|
*/
|
|
937
937
|
PushNotifications?: PushNotificationPreferences;
|
|
938
938
|
}
|
|
939
939
|
/**
|
|
940
|
-
* @public
|
|
941
940
|
* <p>Summary of the details of a <code>ChannelMembership</code>.</p>
|
|
941
|
+
* @public
|
|
942
942
|
*/
|
|
943
943
|
export interface ChannelMembershipSummary {
|
|
944
944
|
/**
|
|
945
|
-
* @public
|
|
946
945
|
* <p>A member's summary data.</p>
|
|
946
|
+
* @public
|
|
947
947
|
*/
|
|
948
948
|
Member?: Identity;
|
|
949
949
|
}
|
|
@@ -974,30 +974,30 @@ export declare const ChannelMessageStatus: {
|
|
|
974
974
|
*/
|
|
975
975
|
export type ChannelMessageStatus = (typeof ChannelMessageStatus)[keyof typeof ChannelMessageStatus];
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>Stores information about a message status.</p>
|
|
978
|
+
* @public
|
|
979
979
|
*/
|
|
980
980
|
export interface ChannelMessageStatusStructure {
|
|
981
981
|
/**
|
|
982
|
-
* @public
|
|
983
982
|
* <p>The message status value.</p>
|
|
983
|
+
* @public
|
|
984
984
|
*/
|
|
985
985
|
Value?: ChannelMessageStatus;
|
|
986
986
|
/**
|
|
987
|
-
* @public
|
|
988
987
|
* <p>Contains more details about the message status.</p>
|
|
988
|
+
* @public
|
|
989
989
|
*/
|
|
990
990
|
Detail?: string;
|
|
991
991
|
}
|
|
992
992
|
/**
|
|
993
|
-
* @public
|
|
994
993
|
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
995
994
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
995
|
+
* @public
|
|
996
996
|
*/
|
|
997
997
|
export interface Target {
|
|
998
998
|
/**
|
|
999
|
-
* @public
|
|
1000
999
|
* <p>The ARN of the target channel member.</p>
|
|
1000
|
+
* @public
|
|
1001
1001
|
*/
|
|
1002
1002
|
MemberArn?: string;
|
|
1003
1003
|
}
|
|
@@ -1014,240 +1014,240 @@ export declare const ChannelMessageType: {
|
|
|
1014
1014
|
*/
|
|
1015
1015
|
export type ChannelMessageType = (typeof ChannelMessageType)[keyof typeof ChannelMessageType];
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>The details of a message in a channel.</p>
|
|
1018
|
+
* @public
|
|
1019
1019
|
*/
|
|
1020
1020
|
export interface ChannelMessage {
|
|
1021
1021
|
/**
|
|
1022
|
-
* @public
|
|
1023
1022
|
* <p>The ARN of the channel.</p>
|
|
1023
|
+
* @public
|
|
1024
1024
|
*/
|
|
1025
1025
|
ChannelArn?: string;
|
|
1026
1026
|
/**
|
|
1027
|
-
* @public
|
|
1028
1027
|
* <p>The ID of a message.</p>
|
|
1028
|
+
* @public
|
|
1029
1029
|
*/
|
|
1030
1030
|
MessageId?: string;
|
|
1031
1031
|
/**
|
|
1032
|
-
* @public
|
|
1033
1032
|
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
1034
1033
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1035
1034
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1035
|
+
* @public
|
|
1036
1036
|
*/
|
|
1037
1037
|
Content?: string;
|
|
1038
1038
|
/**
|
|
1039
|
-
* @public
|
|
1040
1039
|
* <p>The message metadata.</p>
|
|
1040
|
+
* @public
|
|
1041
1041
|
*/
|
|
1042
1042
|
Metadata?: string;
|
|
1043
1043
|
/**
|
|
1044
|
-
* @public
|
|
1045
1044
|
* <p>The message type.</p>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
Type?: ChannelMessageType;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>The time at which the message was created.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
CreatedTimestamp?: Date;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The time at which a message was edited.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
LastEditedTimestamp?: Date;
|
|
1058
1058
|
/**
|
|
1059
|
-
* @public
|
|
1060
1059
|
* <p>The time at which a message was updated.</p>
|
|
1060
|
+
* @public
|
|
1061
1061
|
*/
|
|
1062
1062
|
LastUpdatedTimestamp?: Date;
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The message sender.</p>
|
|
1065
|
+
* @public
|
|
1066
1066
|
*/
|
|
1067
1067
|
Sender?: Identity;
|
|
1068
1068
|
/**
|
|
1069
|
-
* @public
|
|
1070
1069
|
* <p>Hides the content of a message.</p>
|
|
1070
|
+
* @public
|
|
1071
1071
|
*/
|
|
1072
1072
|
Redacted?: boolean;
|
|
1073
1073
|
/**
|
|
1074
|
-
* @public
|
|
1075
1074
|
* <p>The persistence setting for a channel message.</p>
|
|
1075
|
+
* @public
|
|
1076
1076
|
*/
|
|
1077
1077
|
Persistence?: ChannelMessagePersistenceType;
|
|
1078
1078
|
/**
|
|
1079
|
-
* @public
|
|
1080
1079
|
* <p>The status of the channel message.</p>
|
|
1080
|
+
* @public
|
|
1081
1081
|
*/
|
|
1082
1082
|
Status?: ChannelMessageStatusStructure;
|
|
1083
1083
|
/**
|
|
1084
|
-
* @public
|
|
1085
1084
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
1086
1085
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1087
1086
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1090
1090
|
/**
|
|
1091
|
-
* @public
|
|
1092
1091
|
* <p>The ID of the SubChannel.</p>
|
|
1092
|
+
* @public
|
|
1093
1093
|
*/
|
|
1094
1094
|
SubChannelId?: string;
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The content type of the channel message. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
1098
1097
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
1099
1098
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1100
1099
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1100
|
+
* @public
|
|
1101
1101
|
*/
|
|
1102
1102
|
ContentType?: string;
|
|
1103
1103
|
/**
|
|
1104
|
-
* @public
|
|
1105
1104
|
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
1106
1105
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
1106
|
+
* @public
|
|
1107
1107
|
*/
|
|
1108
1108
|
Target?: Target[];
|
|
1109
1109
|
}
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>Summary of the messages in a <code>Channel</code>.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
export interface ChannelMessageSummary {
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The ID of the message.</p>
|
|
1117
|
+
* @public
|
|
1118
1118
|
*/
|
|
1119
1119
|
MessageId?: string;
|
|
1120
1120
|
/**
|
|
1121
|
-
* @public
|
|
1122
1121
|
* <p>The content of the channel message. For Amazon Lex V2 bot responses, this field holds a list of messages originating from the bot. For more information, refer to
|
|
1123
1122
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1124
1123
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1124
|
+
* @public
|
|
1125
1125
|
*/
|
|
1126
1126
|
Content?: string;
|
|
1127
1127
|
/**
|
|
1128
|
-
* @public
|
|
1129
1128
|
* <p>The metadata of the message.</p>
|
|
1129
|
+
* @public
|
|
1130
1130
|
*/
|
|
1131
1131
|
Metadata?: string;
|
|
1132
1132
|
/**
|
|
1133
|
-
* @public
|
|
1134
1133
|
* <p>The type of message.</p>
|
|
1134
|
+
* @public
|
|
1135
1135
|
*/
|
|
1136
1136
|
Type?: ChannelMessageType;
|
|
1137
1137
|
/**
|
|
1138
|
-
* @public
|
|
1139
1138
|
* <p>The time at which the message summary was created.</p>
|
|
1139
|
+
* @public
|
|
1140
1140
|
*/
|
|
1141
1141
|
CreatedTimestamp?: Date;
|
|
1142
1142
|
/**
|
|
1143
|
-
* @public
|
|
1144
1143
|
* <p>The time at which a message was last updated.</p>
|
|
1144
|
+
* @public
|
|
1145
1145
|
*/
|
|
1146
1146
|
LastUpdatedTimestamp?: Date;
|
|
1147
1147
|
/**
|
|
1148
|
-
* @public
|
|
1149
1148
|
* <p>The time at which a message was last edited.</p>
|
|
1149
|
+
* @public
|
|
1150
1150
|
*/
|
|
1151
1151
|
LastEditedTimestamp?: Date;
|
|
1152
1152
|
/**
|
|
1153
|
-
* @public
|
|
1154
1153
|
* <p>The message sender.</p>
|
|
1154
|
+
* @public
|
|
1155
1155
|
*/
|
|
1156
1156
|
Sender?: Identity;
|
|
1157
1157
|
/**
|
|
1158
|
-
* @public
|
|
1159
1158
|
* <p>Indicates whether a message was redacted.</p>
|
|
1159
|
+
* @public
|
|
1160
1160
|
*/
|
|
1161
1161
|
Redacted?: boolean;
|
|
1162
1162
|
/**
|
|
1163
|
-
* @public
|
|
1164
1163
|
* <p>The message status. The status value is <code>SENT</code> for messages sent to a channel without a channel flow. For channels associated with channel flow, the value determines the
|
|
1165
1164
|
* processing stage.</p>
|
|
1165
|
+
* @public
|
|
1166
1166
|
*/
|
|
1167
1167
|
Status?: ChannelMessageStatusStructure;
|
|
1168
1168
|
/**
|
|
1169
|
-
* @public
|
|
1170
1169
|
* <p>The attributes for the channel message. For Amazon Lex V2 bot responses, the attributes are mapped to specific fields from the bot. For more information, refer to
|
|
1171
1170
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1172
1171
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1172
|
+
* @public
|
|
1173
1173
|
*/
|
|
1174
1174
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>The content type of the channel message listed in the summary. For Amazon Lex V2 bot responses, the content type is <code>application/amz-chime-lex-msgs</code> for success responses and
|
|
1178
1177
|
* <code>application/amz-chime-lex-error</code> for failure responses. For more information, refer to
|
|
1179
1178
|
* <a href="https://docs.aws.amazon.com/chime-sdk/latest/dg/appinstance-bots#process-response.html">Processing responses from an AppInstanceBot</a> in the
|
|
1180
1179
|
* <i>Amazon Chime SDK Messaging Developer Guide</i>.</p>
|
|
1180
|
+
* @public
|
|
1181
1181
|
*/
|
|
1182
1182
|
ContentType?: string;
|
|
1183
1183
|
/**
|
|
1184
|
-
* @public
|
|
1185
1184
|
* <p>The target of a message, a sender, a user, or a bot. Only the target and the sender can view targeted messages.
|
|
1186
1185
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.</p>
|
|
1186
|
+
* @public
|
|
1187
1187
|
*/
|
|
1188
1188
|
Target?: Target[];
|
|
1189
1189
|
}
|
|
1190
1190
|
/**
|
|
1191
|
-
* @public
|
|
1192
1191
|
* <p>Summary of the details of a moderated channel.</p>
|
|
1192
|
+
* @public
|
|
1193
1193
|
*/
|
|
1194
1194
|
export interface ChannelModeratedByAppInstanceUserSummary {
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>Summary of the details of a <code>Channel</code>.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
ChannelSummary?: ChannelSummary;
|
|
1200
1200
|
}
|
|
1201
1201
|
/**
|
|
1202
|
-
* @public
|
|
1203
1202
|
* <p>The details of a channel moderator.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
export interface ChannelModerator {
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>The moderator's data.</p>
|
|
1208
|
+
* @public
|
|
1209
1209
|
*/
|
|
1210
1210
|
Moderator?: Identity;
|
|
1211
1211
|
/**
|
|
1212
|
-
* @public
|
|
1213
1212
|
* <p>The ARN of the moderator's channel.</p>
|
|
1213
|
+
* @public
|
|
1214
1214
|
*/
|
|
1215
1215
|
ChannelArn?: string;
|
|
1216
1216
|
/**
|
|
1217
|
-
* @public
|
|
1218
1217
|
* <p>The time at which the moderator was created.</p>
|
|
1218
|
+
* @public
|
|
1219
1219
|
*/
|
|
1220
1220
|
CreatedTimestamp?: Date;
|
|
1221
1221
|
/**
|
|
1222
|
-
* @public
|
|
1223
1222
|
* <p>The <code>AppInstanceUser</code> who created the moderator.</p>
|
|
1223
|
+
* @public
|
|
1224
1224
|
*/
|
|
1225
1225
|
CreatedBy?: Identity;
|
|
1226
1226
|
}
|
|
1227
1227
|
/**
|
|
1228
|
-
* @public
|
|
1229
1228
|
* <p>Summary of the details of a <code>ChannelModerator</code>.</p>
|
|
1229
|
+
* @public
|
|
1230
1230
|
*/
|
|
1231
1231
|
export interface ChannelModeratorSummary {
|
|
1232
1232
|
/**
|
|
1233
|
-
* @public
|
|
1234
1233
|
* <p>The data for a moderator.</p>
|
|
1234
|
+
* @public
|
|
1235
1235
|
*/
|
|
1236
1236
|
Moderator?: Identity;
|
|
1237
1237
|
}
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>A tag object containing a key-value pair.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
export interface Tag {
|
|
1243
1243
|
/**
|
|
1244
|
-
* @public
|
|
1245
1244
|
* <p>The key in a tag.</p>
|
|
1245
|
+
* @public
|
|
1246
1246
|
*/
|
|
1247
1247
|
Key: string | undefined;
|
|
1248
1248
|
/**
|
|
1249
|
-
* @public
|
|
1250
1249
|
* <p>The value in a tag.</p>
|
|
1250
|
+
* @public
|
|
1251
1251
|
*/
|
|
1252
1252
|
Value: string | undefined;
|
|
1253
1253
|
}
|
|
@@ -1256,72 +1256,72 @@ export interface Tag {
|
|
|
1256
1256
|
*/
|
|
1257
1257
|
export interface CreateChannelRequest {
|
|
1258
1258
|
/**
|
|
1259
|
-
* @public
|
|
1260
1259
|
* <p>The ARN of the channel request.</p>
|
|
1260
|
+
* @public
|
|
1261
1261
|
*/
|
|
1262
1262
|
AppInstanceArn: string | undefined;
|
|
1263
1263
|
/**
|
|
1264
|
-
* @public
|
|
1265
1264
|
* <p>The name of the channel.</p>
|
|
1265
|
+
* @public
|
|
1266
1266
|
*/
|
|
1267
1267
|
Name: string | undefined;
|
|
1268
1268
|
/**
|
|
1269
|
-
* @public
|
|
1270
1269
|
* <p>The channel mode: <code>UNRESTRICTED</code> or <code>RESTRICTED</code>. Administrators,
|
|
1271
1270
|
* moderators, and channel members can add themselves and other members to unrestricted
|
|
1272
1271
|
* channels. Only administrators and moderators can add members to restricted channels.</p>
|
|
1272
|
+
* @public
|
|
1273
1273
|
*/
|
|
1274
1274
|
Mode?: ChannelMode;
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>The channel's privacy level: <code>PUBLIC</code> or <code>PRIVATE</code>. Private
|
|
1278
1277
|
* channels aren't discoverable by users outside the channel. Public channels are discoverable
|
|
1279
1278
|
* by anyone in the <code>AppInstance</code>.</p>
|
|
1279
|
+
* @public
|
|
1280
1280
|
*/
|
|
1281
1281
|
Privacy?: ChannelPrivacy;
|
|
1282
1282
|
/**
|
|
1283
|
-
* @public
|
|
1284
1283
|
* <p>The metadata of the creation request. Limited to 1KB and UTF-8.</p>
|
|
1284
|
+
* @public
|
|
1285
1285
|
*/
|
|
1286
1286
|
Metadata?: string;
|
|
1287
1287
|
/**
|
|
1288
|
-
* @public
|
|
1289
1288
|
* <p>The client token for the request. An <code>Idempotency</code> token.</p>
|
|
1289
|
+
* @public
|
|
1290
1290
|
*/
|
|
1291
1291
|
ClientRequestToken?: string;
|
|
1292
1292
|
/**
|
|
1293
|
-
* @public
|
|
1294
1293
|
* <p>The tags for the creation request.</p>
|
|
1294
|
+
* @public
|
|
1295
1295
|
*/
|
|
1296
1296
|
Tags?: Tag[];
|
|
1297
1297
|
/**
|
|
1298
|
-
* @public
|
|
1299
1298
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1299
|
+
* @public
|
|
1300
1300
|
*/
|
|
1301
1301
|
ChimeBearer: string | undefined;
|
|
1302
1302
|
/**
|
|
1303
|
-
* @public
|
|
1304
1303
|
* <p>The ID of the channel in the request.</p>
|
|
1304
|
+
* @public
|
|
1305
1305
|
*/
|
|
1306
1306
|
ChannelId?: string;
|
|
1307
1307
|
/**
|
|
1308
|
-
* @public
|
|
1309
1308
|
* <p>The ARNs of the channel members in the request.</p>
|
|
1309
|
+
* @public
|
|
1310
1310
|
*/
|
|
1311
1311
|
MemberArns?: string[];
|
|
1312
1312
|
/**
|
|
1313
|
-
* @public
|
|
1314
1313
|
* <p>The ARNs of the channel moderators in the request.</p>
|
|
1314
|
+
* @public
|
|
1315
1315
|
*/
|
|
1316
1316
|
ModeratorArns?: string[];
|
|
1317
1317
|
/**
|
|
1318
|
-
* @public
|
|
1319
1318
|
* <p>The attributes required to configure and create an elastic channel. An elastic channel can support a maximum of 1-million users, excluding moderators.</p>
|
|
1319
|
+
* @public
|
|
1320
1320
|
*/
|
|
1321
1321
|
ElasticChannelConfiguration?: ElasticChannelConfiguration;
|
|
1322
1322
|
/**
|
|
1323
|
-
* @public
|
|
1324
1323
|
* <p>Settings that control the interval after which the channel is automatically deleted.</p>
|
|
1324
|
+
* @public
|
|
1325
1325
|
*/
|
|
1326
1326
|
ExpirationSettings?: ExpirationSettings;
|
|
1327
1327
|
}
|
|
@@ -1330,8 +1330,8 @@ export interface CreateChannelRequest {
|
|
|
1330
1330
|
*/
|
|
1331
1331
|
export interface CreateChannelResponse {
|
|
1332
1332
|
/**
|
|
1333
|
-
* @public
|
|
1334
1333
|
* <p>The ARN of the channel.</p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
ChannelArn?: string;
|
|
1337
1337
|
}
|
|
@@ -1340,18 +1340,18 @@ export interface CreateChannelResponse {
|
|
|
1340
1340
|
*/
|
|
1341
1341
|
export interface CreateChannelBanRequest {
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>The ARN of the ban request.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
ChannelArn: string | undefined;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>The <code>AppInstanceUserArn</code> of the member being banned.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
MemberArn: string | undefined;
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
ChimeBearer: string | undefined;
|
|
1357
1357
|
}
|
|
@@ -1360,14 +1360,14 @@ export interface CreateChannelBanRequest {
|
|
|
1360
1360
|
*/
|
|
1361
1361
|
export interface CreateChannelBanResponse {
|
|
1362
1362
|
/**
|
|
1363
|
-
* @public
|
|
1364
1363
|
* <p>The ARN of the response to the ban request.</p>
|
|
1364
|
+
* @public
|
|
1365
1365
|
*/
|
|
1366
1366
|
ChannelArn?: string;
|
|
1367
1367
|
/**
|
|
1368
|
-
* @public
|
|
1369
1368
|
* <p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban
|
|
1370
1369
|
* response.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
Member?: Identity;
|
|
1373
1373
|
}
|
|
@@ -1376,28 +1376,28 @@ export interface CreateChannelBanResponse {
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
export interface CreateChannelFlowRequest {
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The ARN of the channel flow request.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
AppInstanceArn: string | undefined;
|
|
1383
1383
|
/**
|
|
1384
|
-
* @public
|
|
1385
1384
|
* <p>Information about the processor Lambda functions.</p>
|
|
1385
|
+
* @public
|
|
1386
1386
|
*/
|
|
1387
1387
|
Processors: Processor[] | undefined;
|
|
1388
1388
|
/**
|
|
1389
|
-
* @public
|
|
1390
1389
|
* <p>The name of the channel flow.</p>
|
|
1390
|
+
* @public
|
|
1391
1391
|
*/
|
|
1392
1392
|
Name: string | undefined;
|
|
1393
1393
|
/**
|
|
1394
|
-
* @public
|
|
1395
1394
|
* <p>The tags for the creation request.</p>
|
|
1395
|
+
* @public
|
|
1396
1396
|
*/
|
|
1397
1397
|
Tags?: Tag[];
|
|
1398
1398
|
/**
|
|
1399
|
-
* @public
|
|
1400
1399
|
* <p>The client token for the request. An Idempotency token.</p>
|
|
1400
|
+
* @public
|
|
1401
1401
|
*/
|
|
1402
1402
|
ClientRequestToken?: string;
|
|
1403
1403
|
}
|
|
@@ -1406,8 +1406,8 @@ export interface CreateChannelFlowRequest {
|
|
|
1406
1406
|
*/
|
|
1407
1407
|
export interface CreateChannelFlowResponse {
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>The ARN of the channel flow.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
ChannelFlowArn?: string;
|
|
1413
1413
|
}
|
|
@@ -1416,36 +1416,36 @@ export interface CreateChannelFlowResponse {
|
|
|
1416
1416
|
*/
|
|
1417
1417
|
export interface CreateChannelMembershipRequest {
|
|
1418
1418
|
/**
|
|
1419
|
-
* @public
|
|
1420
1419
|
* <p>The ARN of the channel to which you're adding users.</p>
|
|
1420
|
+
* @public
|
|
1421
1421
|
*/
|
|
1422
1422
|
ChannelArn: string | undefined;
|
|
1423
1423
|
/**
|
|
1424
|
-
* @public
|
|
1425
1424
|
* <p>The <code>AppInstanceUserArn</code> of the member you want to add to the channel.</p>
|
|
1425
|
+
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
MemberArn: string | undefined;
|
|
1428
1428
|
/**
|
|
1429
|
-
* @public
|
|
1430
1429
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
1431
1430
|
* members are always returned as part of <code>ListChannelMemberships</code>. Hidden members
|
|
1432
1431
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
1433
1432
|
* <code>HIDDEN</code>. Otherwise hidden members are not returned. This is only supported
|
|
1434
1433
|
* by moderators.</p>
|
|
1434
|
+
* @public
|
|
1435
1435
|
*/
|
|
1436
1436
|
Type: ChannelMembershipType | undefined;
|
|
1437
1437
|
/**
|
|
1438
|
-
* @public
|
|
1439
1438
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1440
1439
|
* that makes the API call.</p>
|
|
1440
|
+
* @public
|
|
1441
1441
|
*/
|
|
1442
1442
|
ChimeBearer: string | undefined;
|
|
1443
1443
|
/**
|
|
1444
|
-
* @public
|
|
1445
1444
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1446
1445
|
* <note>
|
|
1447
1446
|
* <p>Only required when creating membership in a SubChannel for a moderator in an elastic channel.</p>
|
|
1448
1447
|
* </note>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
SubChannelId?: string;
|
|
1451
1451
|
}
|
|
@@ -1454,18 +1454,18 @@ export interface CreateChannelMembershipRequest {
|
|
|
1454
1454
|
*/
|
|
1455
1455
|
export interface CreateChannelMembershipResponse {
|
|
1456
1456
|
/**
|
|
1457
|
-
* @public
|
|
1458
1457
|
* <p>The ARN of the channel.</p>
|
|
1458
|
+
* @public
|
|
1459
1459
|
*/
|
|
1460
1460
|
ChannelArn?: string;
|
|
1461
1461
|
/**
|
|
1462
|
-
* @public
|
|
1463
1462
|
* <p>The ARN and metadata of the member being added.</p>
|
|
1463
|
+
* @public
|
|
1464
1464
|
*/
|
|
1465
1465
|
Member?: Identity;
|
|
1466
1466
|
/**
|
|
1467
|
-
* @public
|
|
1468
1467
|
* <p>The ID of the SubChannel in the response.</p>
|
|
1468
|
+
* @public
|
|
1469
1469
|
*/
|
|
1470
1470
|
SubChannelId?: string;
|
|
1471
1471
|
}
|
|
@@ -1474,19 +1474,19 @@ export interface CreateChannelMembershipResponse {
|
|
|
1474
1474
|
*/
|
|
1475
1475
|
export interface CreateChannelModeratorRequest {
|
|
1476
1476
|
/**
|
|
1477
|
-
* @public
|
|
1478
1477
|
* <p>The ARN of the channel.</p>
|
|
1478
|
+
* @public
|
|
1479
1479
|
*/
|
|
1480
1480
|
ChannelArn: string | undefined;
|
|
1481
1481
|
/**
|
|
1482
|
-
* @public
|
|
1483
1482
|
* <p>The <code>AppInstanceUserArn</code> of the moderator.</p>
|
|
1483
|
+
* @public
|
|
1484
1484
|
*/
|
|
1485
1485
|
ChannelModeratorArn: string | undefined;
|
|
1486
1486
|
/**
|
|
1487
|
-
* @public
|
|
1488
1487
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1489
1488
|
* that makes the API call.</p>
|
|
1489
|
+
* @public
|
|
1490
1490
|
*/
|
|
1491
1491
|
ChimeBearer: string | undefined;
|
|
1492
1492
|
}
|
|
@@ -1495,13 +1495,13 @@ export interface CreateChannelModeratorRequest {
|
|
|
1495
1495
|
*/
|
|
1496
1496
|
export interface CreateChannelModeratorResponse {
|
|
1497
1497
|
/**
|
|
1498
|
-
* @public
|
|
1499
1498
|
* <p>The ARN of the channel.</p>
|
|
1499
|
+
* @public
|
|
1500
1500
|
*/
|
|
1501
1501
|
ChannelArn?: string;
|
|
1502
1502
|
/**
|
|
1503
|
-
* @public
|
|
1504
1503
|
* <p>The ARNs of the channel and the moderator.</p>
|
|
1504
|
+
* @public
|
|
1505
1505
|
*/
|
|
1506
1506
|
ChannelModerator?: Identity;
|
|
1507
1507
|
}
|
|
@@ -1510,14 +1510,14 @@ export interface CreateChannelModeratorResponse {
|
|
|
1510
1510
|
*/
|
|
1511
1511
|
export interface DeleteChannelRequest {
|
|
1512
1512
|
/**
|
|
1513
|
-
* @public
|
|
1514
1513
|
* <p>The ARN of the channel being deleted.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
ChannelArn: string | undefined;
|
|
1517
1517
|
/**
|
|
1518
|
-
* @public
|
|
1519
1518
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1520
1519
|
* that makes the API call.</p>
|
|
1520
|
+
* @public
|
|
1521
1521
|
*/
|
|
1522
1522
|
ChimeBearer: string | undefined;
|
|
1523
1523
|
}
|
|
@@ -1526,19 +1526,19 @@ export interface DeleteChannelRequest {
|
|
|
1526
1526
|
*/
|
|
1527
1527
|
export interface DeleteChannelBanRequest {
|
|
1528
1528
|
/**
|
|
1529
|
-
* @public
|
|
1530
1529
|
* <p>The ARN of the channel from which the <code>AppInstanceUser</code> was banned.</p>
|
|
1530
|
+
* @public
|
|
1531
1531
|
*/
|
|
1532
1532
|
ChannelArn: string | undefined;
|
|
1533
1533
|
/**
|
|
1534
|
-
* @public
|
|
1535
1534
|
* <p>The ARN of the <code>AppInstanceUser</code> that you want to reinstate.</p>
|
|
1535
|
+
* @public
|
|
1536
1536
|
*/
|
|
1537
1537
|
MemberArn: string | undefined;
|
|
1538
1538
|
/**
|
|
1539
|
-
* @public
|
|
1540
1539
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1541
1540
|
* API call.</p>
|
|
1541
|
+
* @public
|
|
1542
1542
|
*/
|
|
1543
1543
|
ChimeBearer: string | undefined;
|
|
1544
1544
|
}
|
|
@@ -1547,8 +1547,8 @@ export interface DeleteChannelBanRequest {
|
|
|
1547
1547
|
*/
|
|
1548
1548
|
export interface DeleteChannelFlowRequest {
|
|
1549
1549
|
/**
|
|
1550
|
-
* @public
|
|
1551
1550
|
* <p>The ARN of the channel flow.</p>
|
|
1551
|
+
* @public
|
|
1552
1552
|
*/
|
|
1553
1553
|
ChannelFlowArn: string | undefined;
|
|
1554
1554
|
}
|
|
@@ -1557,27 +1557,27 @@ export interface DeleteChannelFlowRequest {
|
|
|
1557
1557
|
*/
|
|
1558
1558
|
export interface DeleteChannelMembershipRequest {
|
|
1559
1559
|
/**
|
|
1560
|
-
* @public
|
|
1561
1560
|
* <p>The ARN of the channel from which you want to remove the user.</p>
|
|
1561
|
+
* @public
|
|
1562
1562
|
*/
|
|
1563
1563
|
ChannelArn: string | undefined;
|
|
1564
1564
|
/**
|
|
1565
|
-
* @public
|
|
1566
1565
|
* <p>The <code>AppInstanceUserArn</code> of the member that you're removing from the channel.</p>
|
|
1566
|
+
* @public
|
|
1567
1567
|
*/
|
|
1568
1568
|
MemberArn: string | undefined;
|
|
1569
1569
|
/**
|
|
1570
|
-
* @public
|
|
1571
1570
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1572
1571
|
* API call.</p>
|
|
1572
|
+
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
ChimeBearer: string | undefined;
|
|
1575
1575
|
/**
|
|
1576
|
-
* @public
|
|
1577
1576
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1578
1577
|
* <note>
|
|
1579
1578
|
* <p>Only for use by moderators.</p>
|
|
1580
1579
|
* </note>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
SubChannelId?: string;
|
|
1583
1583
|
}
|
|
@@ -1586,27 +1586,27 @@ export interface DeleteChannelMembershipRequest {
|
|
|
1586
1586
|
*/
|
|
1587
1587
|
export interface DeleteChannelMessageRequest {
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>The ARN of the channel.</p>
|
|
1590
|
+
* @public
|
|
1591
1591
|
*/
|
|
1592
1592
|
ChannelArn: string | undefined;
|
|
1593
1593
|
/**
|
|
1594
|
-
* @public
|
|
1595
1594
|
* <p>The ID of the message being deleted.</p>
|
|
1595
|
+
* @public
|
|
1596
1596
|
*/
|
|
1597
1597
|
MessageId: string | undefined;
|
|
1598
1598
|
/**
|
|
1599
|
-
* @public
|
|
1600
1599
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1601
1600
|
* API call.</p>
|
|
1601
|
+
* @public
|
|
1602
1602
|
*/
|
|
1603
1603
|
ChimeBearer: string | undefined;
|
|
1604
1604
|
/**
|
|
1605
|
-
* @public
|
|
1606
1605
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1607
1606
|
* <note>
|
|
1608
1607
|
* <p>Only required when deleting messages in a SubChannel that the user belongs to.</p>
|
|
1609
1608
|
* </note>
|
|
1609
|
+
* @public
|
|
1610
1610
|
*/
|
|
1611
1611
|
SubChannelId?: string;
|
|
1612
1612
|
}
|
|
@@ -1615,19 +1615,19 @@ export interface DeleteChannelMessageRequest {
|
|
|
1615
1615
|
*/
|
|
1616
1616
|
export interface DeleteChannelModeratorRequest {
|
|
1617
1617
|
/**
|
|
1618
|
-
* @public
|
|
1619
1618
|
* <p>The ARN of the channel.</p>
|
|
1619
|
+
* @public
|
|
1620
1620
|
*/
|
|
1621
1621
|
ChannelArn: string | undefined;
|
|
1622
1622
|
/**
|
|
1623
|
-
* @public
|
|
1624
1623
|
* <p>The <code>AppInstanceUserArn</code> of the moderator being deleted.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
ChannelModeratorArn: string | undefined;
|
|
1627
1627
|
/**
|
|
1628
|
-
* @public
|
|
1629
1628
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1630
1629
|
* API call.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
ChimeBearer: string | undefined;
|
|
1633
1633
|
}
|
|
@@ -1636,8 +1636,8 @@ export interface DeleteChannelModeratorRequest {
|
|
|
1636
1636
|
*/
|
|
1637
1637
|
export interface DeleteMessagingStreamingConfigurationsRequest {
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>The ARN of the streaming configurations being deleted.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
AppInstanceArn: string | undefined;
|
|
1643
1643
|
}
|
|
@@ -1646,14 +1646,14 @@ export interface DeleteMessagingStreamingConfigurationsRequest {
|
|
|
1646
1646
|
*/
|
|
1647
1647
|
export interface DescribeChannelRequest {
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>The ARN of the channel.</p>
|
|
1650
|
+
* @public
|
|
1651
1651
|
*/
|
|
1652
1652
|
ChannelArn: string | undefined;
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1656
1655
|
* API call.</p>
|
|
1656
|
+
* @public
|
|
1657
1657
|
*/
|
|
1658
1658
|
ChimeBearer: string | undefined;
|
|
1659
1659
|
}
|
|
@@ -1662,8 +1662,8 @@ export interface DescribeChannelRequest {
|
|
|
1662
1662
|
*/
|
|
1663
1663
|
export interface DescribeChannelResponse {
|
|
1664
1664
|
/**
|
|
1665
|
-
* @public
|
|
1666
1665
|
* <p>The channel details.</p>
|
|
1666
|
+
* @public
|
|
1667
1667
|
*/
|
|
1668
1668
|
Channel?: Channel;
|
|
1669
1669
|
}
|
|
@@ -1672,19 +1672,19 @@ export interface DescribeChannelResponse {
|
|
|
1672
1672
|
*/
|
|
1673
1673
|
export interface DescribeChannelBanRequest {
|
|
1674
1674
|
/**
|
|
1675
|
-
* @public
|
|
1676
1675
|
* <p>The ARN of the channel from which the user is banned.</p>
|
|
1676
|
+
* @public
|
|
1677
1677
|
*/
|
|
1678
1678
|
ChannelArn: string | undefined;
|
|
1679
1679
|
/**
|
|
1680
|
-
* @public
|
|
1681
1680
|
* <p>The <code>AppInstanceUserArn</code> of the member being banned.</p>
|
|
1681
|
+
* @public
|
|
1682
1682
|
*/
|
|
1683
1683
|
MemberArn: string | undefined;
|
|
1684
1684
|
/**
|
|
1685
|
-
* @public
|
|
1686
1685
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1687
1686
|
* API call.</p>
|
|
1687
|
+
* @public
|
|
1688
1688
|
*/
|
|
1689
1689
|
ChimeBearer: string | undefined;
|
|
1690
1690
|
}
|
|
@@ -1693,8 +1693,8 @@ export interface DescribeChannelBanRequest {
|
|
|
1693
1693
|
*/
|
|
1694
1694
|
export interface DescribeChannelBanResponse {
|
|
1695
1695
|
/**
|
|
1696
|
-
* @public
|
|
1697
1696
|
* <p>The details of the ban.</p>
|
|
1697
|
+
* @public
|
|
1698
1698
|
*/
|
|
1699
1699
|
ChannelBan?: ChannelBan;
|
|
1700
1700
|
}
|
|
@@ -1703,8 +1703,8 @@ export interface DescribeChannelBanResponse {
|
|
|
1703
1703
|
*/
|
|
1704
1704
|
export interface DescribeChannelFlowRequest {
|
|
1705
1705
|
/**
|
|
1706
|
-
* @public
|
|
1707
1706
|
* <p>The ARN of the channel flow.</p>
|
|
1707
|
+
* @public
|
|
1708
1708
|
*/
|
|
1709
1709
|
ChannelFlowArn: string | undefined;
|
|
1710
1710
|
}
|
|
@@ -1713,8 +1713,8 @@ export interface DescribeChannelFlowRequest {
|
|
|
1713
1713
|
*/
|
|
1714
1714
|
export interface DescribeChannelFlowResponse {
|
|
1715
1715
|
/**
|
|
1716
|
-
* @public
|
|
1717
1716
|
* <p>The channel flow details.</p>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
ChannelFlow?: ChannelFlow;
|
|
1720
1720
|
}
|
|
@@ -1723,27 +1723,27 @@ export interface DescribeChannelFlowResponse {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface DescribeChannelMembershipRequest {
|
|
1725
1725
|
/**
|
|
1726
|
-
* @public
|
|
1727
1726
|
* <p>The ARN of the channel.</p>
|
|
1727
|
+
* @public
|
|
1728
1728
|
*/
|
|
1729
1729
|
ChannelArn: string | undefined;
|
|
1730
1730
|
/**
|
|
1731
|
-
* @public
|
|
1732
1731
|
* <p>The <code>AppInstanceUserArn</code> of the member.</p>
|
|
1732
|
+
* @public
|
|
1733
1733
|
*/
|
|
1734
1734
|
MemberArn: string | undefined;
|
|
1735
1735
|
/**
|
|
1736
|
-
* @public
|
|
1737
1736
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the
|
|
1738
1737
|
* API call.</p>
|
|
1738
|
+
* @public
|
|
1739
1739
|
*/
|
|
1740
1740
|
ChimeBearer: string | undefined;
|
|
1741
1741
|
/**
|
|
1742
|
-
* @public
|
|
1743
1742
|
* <p>The ID of the SubChannel in the request. The response contains an <code>ElasticChannelConfiguration</code> object.</p>
|
|
1744
1743
|
* <note>
|
|
1745
1744
|
* <p>Only required to get a user’s SubChannel membership details.</p>
|
|
1746
1745
|
* </note>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
SubChannelId?: string;
|
|
1749
1749
|
}
|
|
@@ -1752,8 +1752,8 @@ export interface DescribeChannelMembershipRequest {
|
|
|
1752
1752
|
*/
|
|
1753
1753
|
export interface DescribeChannelMembershipResponse {
|
|
1754
1754
|
/**
|
|
1755
|
-
* @public
|
|
1756
1755
|
* <p>The details of the membership.</p>
|
|
1756
|
+
* @public
|
|
1757
1757
|
*/
|
|
1758
1758
|
ChannelMembership?: ChannelMembership;
|
|
1759
1759
|
}
|
|
@@ -1762,19 +1762,19 @@ export interface DescribeChannelMembershipResponse {
|
|
|
1762
1762
|
*/
|
|
1763
1763
|
export interface DescribeChannelMembershipForAppInstanceUserRequest {
|
|
1764
1764
|
/**
|
|
1765
|
-
* @public
|
|
1766
1765
|
* <p>The ARN of the channel to which the user belongs.</p>
|
|
1766
|
+
* @public
|
|
1767
1767
|
*/
|
|
1768
1768
|
ChannelArn: string | undefined;
|
|
1769
1769
|
/**
|
|
1770
|
-
* @public
|
|
1771
1770
|
* <p>The ARN of the user or bot in a channel.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
AppInstanceUserArn: string | undefined;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1777
1776
|
* that makes the API call.</p>
|
|
1777
|
+
* @public
|
|
1778
1778
|
*/
|
|
1779
1779
|
ChimeBearer: string | undefined;
|
|
1780
1780
|
}
|
|
@@ -1783,8 +1783,8 @@ export interface DescribeChannelMembershipForAppInstanceUserRequest {
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
export interface DescribeChannelMembershipForAppInstanceUserResponse {
|
|
1785
1785
|
/**
|
|
1786
|
-
* @public
|
|
1787
1786
|
* <p>The channel to which a user belongs.</p>
|
|
1787
|
+
* @public
|
|
1788
1788
|
*/
|
|
1789
1789
|
ChannelMembership?: ChannelMembershipForAppInstanceUserSummary;
|
|
1790
1790
|
}
|
|
@@ -1793,19 +1793,19 @@ export interface DescribeChannelMembershipForAppInstanceUserResponse {
|
|
|
1793
1793
|
*/
|
|
1794
1794
|
export interface DescribeChannelModeratedByAppInstanceUserRequest {
|
|
1795
1795
|
/**
|
|
1796
|
-
* @public
|
|
1797
1796
|
* <p>The ARN of the moderated channel.</p>
|
|
1797
|
+
* @public
|
|
1798
1798
|
*/
|
|
1799
1799
|
ChannelArn: string | undefined;
|
|
1800
1800
|
/**
|
|
1801
|
-
* @public
|
|
1802
1801
|
* <p>The ARN of the user or bot in the moderated channel.</p>
|
|
1802
|
+
* @public
|
|
1803
1803
|
*/
|
|
1804
1804
|
AppInstanceUserArn: string | undefined;
|
|
1805
1805
|
/**
|
|
1806
|
-
* @public
|
|
1807
1806
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1808
1807
|
* that makes the API call.</p>
|
|
1808
|
+
* @public
|
|
1809
1809
|
*/
|
|
1810
1810
|
ChimeBearer: string | undefined;
|
|
1811
1811
|
}
|
|
@@ -1814,8 +1814,8 @@ export interface DescribeChannelModeratedByAppInstanceUserRequest {
|
|
|
1814
1814
|
*/
|
|
1815
1815
|
export interface DescribeChannelModeratedByAppInstanceUserResponse {
|
|
1816
1816
|
/**
|
|
1817
|
-
* @public
|
|
1818
1817
|
* <p>The moderated channel.</p>
|
|
1818
|
+
* @public
|
|
1819
1819
|
*/
|
|
1820
1820
|
Channel?: ChannelModeratedByAppInstanceUserSummary;
|
|
1821
1821
|
}
|
|
@@ -1824,19 +1824,19 @@ export interface DescribeChannelModeratedByAppInstanceUserResponse {
|
|
|
1824
1824
|
*/
|
|
1825
1825
|
export interface DescribeChannelModeratorRequest {
|
|
1826
1826
|
/**
|
|
1827
|
-
* @public
|
|
1828
1827
|
* <p>The ARN of the channel.</p>
|
|
1828
|
+
* @public
|
|
1829
1829
|
*/
|
|
1830
1830
|
ChannelArn: string | undefined;
|
|
1831
1831
|
/**
|
|
1832
|
-
* @public
|
|
1833
1832
|
* <p>The <code>AppInstanceUserArn</code> of the channel moderator.</p>
|
|
1833
|
+
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
ChannelModeratorArn: string | undefined;
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1839
1838
|
* that makes the API call.</p>
|
|
1839
|
+
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
ChimeBearer: string | undefined;
|
|
1842
1842
|
}
|
|
@@ -1845,8 +1845,8 @@ export interface DescribeChannelModeratorRequest {
|
|
|
1845
1845
|
*/
|
|
1846
1846
|
export interface DescribeChannelModeratorResponse {
|
|
1847
1847
|
/**
|
|
1848
|
-
* @public
|
|
1849
1848
|
* <p>The details of the channel moderator.</p>
|
|
1849
|
+
* @public
|
|
1850
1850
|
*/
|
|
1851
1851
|
ChannelModerator?: ChannelModerator;
|
|
1852
1852
|
}
|
|
@@ -1855,18 +1855,18 @@ export interface DescribeChannelModeratorResponse {
|
|
|
1855
1855
|
*/
|
|
1856
1856
|
export interface DisassociateChannelFlowRequest {
|
|
1857
1857
|
/**
|
|
1858
|
-
* @public
|
|
1859
1858
|
* <p>The ARN of the channel.</p>
|
|
1859
|
+
* @public
|
|
1860
1860
|
*/
|
|
1861
1861
|
ChannelArn: string | undefined;
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <p>The ARN of the channel flow.</p>
|
|
1864
|
+
* @public
|
|
1865
1865
|
*/
|
|
1866
1866
|
ChannelFlowArn: string | undefined;
|
|
1867
1867
|
/**
|
|
1868
|
-
* @public
|
|
1869
1868
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
1869
|
+
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
ChimeBearer: string | undefined;
|
|
1872
1872
|
}
|
|
@@ -1875,18 +1875,18 @@ export interface DisassociateChannelFlowRequest {
|
|
|
1875
1875
|
*/
|
|
1876
1876
|
export interface GetChannelMembershipPreferencesRequest {
|
|
1877
1877
|
/**
|
|
1878
|
-
* @public
|
|
1879
1878
|
* <p>The ARN of the channel.</p>
|
|
1879
|
+
* @public
|
|
1880
1880
|
*/
|
|
1881
1881
|
ChannelArn: string | undefined;
|
|
1882
1882
|
/**
|
|
1883
|
-
* @public
|
|
1884
1883
|
* <p>The <code>AppInstanceUserArn</code> of the member retrieving the preferences.</p>
|
|
1884
|
+
* @public
|
|
1885
1885
|
*/
|
|
1886
1886
|
MemberArn: string | undefined;
|
|
1887
1887
|
/**
|
|
1888
|
-
* @public
|
|
1889
1888
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
1889
|
+
* @public
|
|
1890
1890
|
*/
|
|
1891
1891
|
ChimeBearer: string | undefined;
|
|
1892
1892
|
}
|
|
@@ -1895,18 +1895,18 @@ export interface GetChannelMembershipPreferencesRequest {
|
|
|
1895
1895
|
*/
|
|
1896
1896
|
export interface GetChannelMembershipPreferencesResponse {
|
|
1897
1897
|
/**
|
|
1898
|
-
* @public
|
|
1899
1898
|
* <p>The ARN of the channel.</p>
|
|
1899
|
+
* @public
|
|
1900
1900
|
*/
|
|
1901
1901
|
ChannelArn?: string;
|
|
1902
1902
|
/**
|
|
1903
|
-
* @public
|
|
1904
1903
|
* <p>The details of a user.</p>
|
|
1904
|
+
* @public
|
|
1905
1905
|
*/
|
|
1906
1906
|
Member?: Identity;
|
|
1907
1907
|
/**
|
|
1908
|
-
* @public
|
|
1909
1908
|
* <p>The channel membership preferences for an <code>AppInstanceUser</code> .</p>
|
|
1909
|
+
* @public
|
|
1910
1910
|
*/
|
|
1911
1911
|
Preferences?: ChannelMembershipPreferences;
|
|
1912
1912
|
}
|
|
@@ -1915,27 +1915,27 @@ export interface GetChannelMembershipPreferencesResponse {
|
|
|
1915
1915
|
*/
|
|
1916
1916
|
export interface GetChannelMessageRequest {
|
|
1917
1917
|
/**
|
|
1918
|
-
* @public
|
|
1919
1918
|
* <p>The ARN of the channel.</p>
|
|
1919
|
+
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
ChannelArn: string | undefined;
|
|
1922
1922
|
/**
|
|
1923
|
-
* @public
|
|
1924
1923
|
* <p>The ID of the message.</p>
|
|
1924
|
+
* @public
|
|
1925
1925
|
*/
|
|
1926
1926
|
MessageId: string | undefined;
|
|
1927
1927
|
/**
|
|
1928
|
-
* @public
|
|
1929
1928
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
1930
1929
|
* that makes the API call.</p>
|
|
1930
|
+
* @public
|
|
1931
1931
|
*/
|
|
1932
1932
|
ChimeBearer: string | undefined;
|
|
1933
1933
|
/**
|
|
1934
|
-
* @public
|
|
1935
1934
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1936
1935
|
* <note>
|
|
1937
1936
|
* <p>Only required when getting messages in a SubChannel that the user belongs to.</p>
|
|
1938
1937
|
* </note>
|
|
1938
|
+
* @public
|
|
1939
1939
|
*/
|
|
1940
1940
|
SubChannelId?: string;
|
|
1941
1941
|
}
|
|
@@ -1944,8 +1944,8 @@ export interface GetChannelMessageRequest {
|
|
|
1944
1944
|
*/
|
|
1945
1945
|
export interface GetChannelMessageResponse {
|
|
1946
1946
|
/**
|
|
1947
|
-
* @public
|
|
1948
1947
|
* <p>The details of and content in the message.</p>
|
|
1948
|
+
* @public
|
|
1949
1949
|
*/
|
|
1950
1950
|
ChannelMessage?: ChannelMessage;
|
|
1951
1951
|
}
|
|
@@ -1954,26 +1954,26 @@ export interface GetChannelMessageResponse {
|
|
|
1954
1954
|
*/
|
|
1955
1955
|
export interface GetChannelMessageStatusRequest {
|
|
1956
1956
|
/**
|
|
1957
|
-
* @public
|
|
1958
1957
|
* <p>The ARN of the channel</p>
|
|
1958
|
+
* @public
|
|
1959
1959
|
*/
|
|
1960
1960
|
ChannelArn: string | undefined;
|
|
1961
1961
|
/**
|
|
1962
|
-
* @public
|
|
1963
1962
|
* <p>The ID of the message.</p>
|
|
1963
|
+
* @public
|
|
1964
1964
|
*/
|
|
1965
1965
|
MessageId: string | undefined;
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
ChimeBearer: string | undefined;
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>The ID of the SubChannel in the request.</p>
|
|
1974
1973
|
* <note>
|
|
1975
1974
|
* <p>Only required when getting message status in a SubChannel that the user belongs to.</p>
|
|
1976
1975
|
* </note>
|
|
1976
|
+
* @public
|
|
1977
1977
|
*/
|
|
1978
1978
|
SubChannelId?: string;
|
|
1979
1979
|
}
|
|
@@ -1982,8 +1982,8 @@ export interface GetChannelMessageStatusRequest {
|
|
|
1982
1982
|
*/
|
|
1983
1983
|
export interface GetChannelMessageStatusResponse {
|
|
1984
1984
|
/**
|
|
1985
|
-
* @public
|
|
1986
1985
|
* <p>The message status and details.</p>
|
|
1986
|
+
* @public
|
|
1987
1987
|
*/
|
|
1988
1988
|
Status?: ChannelMessageStatusStructure;
|
|
1989
1989
|
}
|
|
@@ -1993,13 +1993,13 @@ export interface GetChannelMessageStatusResponse {
|
|
|
1993
1993
|
export interface GetMessagingSessionEndpointRequest {
|
|
1994
1994
|
}
|
|
1995
1995
|
/**
|
|
1996
|
-
* @public
|
|
1997
1996
|
* <p>The websocket endpoint used to connect to Amazon Chime SDK messaging.</p>
|
|
1997
|
+
* @public
|
|
1998
1998
|
*/
|
|
1999
1999
|
export interface MessagingSessionEndpoint {
|
|
2000
2000
|
/**
|
|
2001
|
-
* @public
|
|
2002
2001
|
* <p>The endpoint to which you establish a websocket connection.</p>
|
|
2002
|
+
* @public
|
|
2003
2003
|
*/
|
|
2004
2004
|
Url?: string;
|
|
2005
2005
|
}
|
|
@@ -2008,8 +2008,8 @@ export interface MessagingSessionEndpoint {
|
|
|
2008
2008
|
*/
|
|
2009
2009
|
export interface GetMessagingSessionEndpointResponse {
|
|
2010
2010
|
/**
|
|
2011
|
-
* @public
|
|
2012
2011
|
* <p>The endpoint returned in the response.</p>
|
|
2012
|
+
* @public
|
|
2013
2013
|
*/
|
|
2014
2014
|
Endpoint?: MessagingSessionEndpoint;
|
|
2015
2015
|
}
|
|
@@ -2018,8 +2018,8 @@ export interface GetMessagingSessionEndpointResponse {
|
|
|
2018
2018
|
*/
|
|
2019
2019
|
export interface GetMessagingStreamingConfigurationsRequest {
|
|
2020
2020
|
/**
|
|
2021
|
-
* @public
|
|
2022
2021
|
* <p>The ARN of the streaming configurations.</p>
|
|
2022
|
+
* @public
|
|
2023
2023
|
*/
|
|
2024
2024
|
AppInstanceArn: string | undefined;
|
|
2025
2025
|
}
|
|
@@ -2036,18 +2036,18 @@ export declare const MessagingDataType: {
|
|
|
2036
2036
|
*/
|
|
2037
2037
|
export type MessagingDataType = (typeof MessagingDataType)[keyof typeof MessagingDataType];
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>The configuration for connecting a messaging stream to Amazon Kinesis.</p>
|
|
2040
|
+
* @public
|
|
2041
2041
|
*/
|
|
2042
2042
|
export interface StreamingConfiguration {
|
|
2043
2043
|
/**
|
|
2044
|
-
* @public
|
|
2045
2044
|
* <p>The data type of the configuration.</p>
|
|
2045
|
+
* @public
|
|
2046
2046
|
*/
|
|
2047
2047
|
DataType: MessagingDataType | undefined;
|
|
2048
2048
|
/**
|
|
2049
|
-
* @public
|
|
2050
2049
|
* <p>The ARN of the resource in the configuration. </p>
|
|
2050
|
+
* @public
|
|
2051
2051
|
*/
|
|
2052
2052
|
ResourceArn: string | undefined;
|
|
2053
2053
|
}
|
|
@@ -2056,8 +2056,8 @@ export interface StreamingConfiguration {
|
|
|
2056
2056
|
*/
|
|
2057
2057
|
export interface GetMessagingStreamingConfigurationsResponse {
|
|
2058
2058
|
/**
|
|
2059
|
-
* @public
|
|
2060
2059
|
* <p>The streaming settings.</p>
|
|
2060
|
+
* @public
|
|
2061
2061
|
*/
|
|
2062
2062
|
StreamingConfigurations?: StreamingConfiguration[];
|
|
2063
2063
|
}
|
|
@@ -2066,24 +2066,24 @@ export interface GetMessagingStreamingConfigurationsResponse {
|
|
|
2066
2066
|
*/
|
|
2067
2067
|
export interface ListChannelBansRequest {
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>The ARN of the channel.</p>
|
|
2070
|
+
* @public
|
|
2071
2071
|
*/
|
|
2072
2072
|
ChannelArn: string | undefined;
|
|
2073
2073
|
/**
|
|
2074
|
-
* @public
|
|
2075
2074
|
* <p>The maximum number of bans that you want returned.</p>
|
|
2075
|
+
* @public
|
|
2076
2076
|
*/
|
|
2077
2077
|
MaxResults?: number;
|
|
2078
2078
|
/**
|
|
2079
|
-
* @public
|
|
2080
2079
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
2080
|
+
* @public
|
|
2081
2081
|
*/
|
|
2082
2082
|
NextToken?: string;
|
|
2083
2083
|
/**
|
|
2084
|
-
* @public
|
|
2085
2084
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2086
2085
|
* that makes the API call.</p>
|
|
2086
|
+
* @public
|
|
2087
2087
|
*/
|
|
2088
2088
|
ChimeBearer: string | undefined;
|
|
2089
2089
|
}
|
|
@@ -2092,18 +2092,18 @@ export interface ListChannelBansRequest {
|
|
|
2092
2092
|
*/
|
|
2093
2093
|
export interface ListChannelBansResponse {
|
|
2094
2094
|
/**
|
|
2095
|
-
* @public
|
|
2096
2095
|
* <p>The ARN of the channel.</p>
|
|
2096
|
+
* @public
|
|
2097
2097
|
*/
|
|
2098
2098
|
ChannelArn?: string;
|
|
2099
2099
|
/**
|
|
2100
|
-
* @public
|
|
2101
2100
|
* <p>The token passed by previous API calls until all requested bans are returned.</p>
|
|
2101
|
+
* @public
|
|
2102
2102
|
*/
|
|
2103
2103
|
NextToken?: string;
|
|
2104
2104
|
/**
|
|
2105
|
-
* @public
|
|
2106
2105
|
* <p>The information for each requested ban.</p>
|
|
2106
|
+
* @public
|
|
2107
2107
|
*/
|
|
2108
2108
|
ChannelBans?: ChannelBanSummary[];
|
|
2109
2109
|
}
|
|
@@ -2112,18 +2112,18 @@ export interface ListChannelBansResponse {
|
|
|
2112
2112
|
*/
|
|
2113
2113
|
export interface ListChannelFlowsRequest {
|
|
2114
2114
|
/**
|
|
2115
|
-
* @public
|
|
2116
2115
|
* <p>The ARN of the app instance.</p>
|
|
2116
|
+
* @public
|
|
2117
2117
|
*/
|
|
2118
2118
|
AppInstanceArn: string | undefined;
|
|
2119
2119
|
/**
|
|
2120
|
-
* @public
|
|
2121
2120
|
* <p>The maximum number of channel flows that you want to return.</p>
|
|
2121
|
+
* @public
|
|
2122
2122
|
*/
|
|
2123
2123
|
MaxResults?: number;
|
|
2124
2124
|
/**
|
|
2125
|
-
* @public
|
|
2126
2125
|
* <p>The token passed by previous API calls until all requested channel flows are returned.</p>
|
|
2126
|
+
* @public
|
|
2127
2127
|
*/
|
|
2128
2128
|
NextToken?: string;
|
|
2129
2129
|
}
|
|
@@ -2132,13 +2132,13 @@ export interface ListChannelFlowsRequest {
|
|
|
2132
2132
|
*/
|
|
2133
2133
|
export interface ListChannelFlowsResponse {
|
|
2134
2134
|
/**
|
|
2135
|
-
* @public
|
|
2136
2135
|
* <p>The information about each channel flow.</p>
|
|
2136
|
+
* @public
|
|
2137
2137
|
*/
|
|
2138
2138
|
ChannelFlows?: ChannelFlowSummary[];
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2141
|
+
* @public
|
|
2142
2142
|
*/
|
|
2143
2143
|
NextToken?: string;
|
|
2144
2144
|
}
|
|
@@ -2147,41 +2147,41 @@ export interface ListChannelFlowsResponse {
|
|
|
2147
2147
|
*/
|
|
2148
2148
|
export interface ListChannelMembershipsRequest {
|
|
2149
2149
|
/**
|
|
2150
|
-
* @public
|
|
2151
2150
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
2151
|
+
* @public
|
|
2152
2152
|
*/
|
|
2153
2153
|
ChannelArn: string | undefined;
|
|
2154
2154
|
/**
|
|
2155
|
-
* @public
|
|
2156
2155
|
* <p>The membership type of a user, <code>DEFAULT</code> or <code>HIDDEN</code>. Default
|
|
2157
2156
|
* members are returned as part of <code>ListChannelMemberships</code> if no type is specified. Hidden members
|
|
2158
2157
|
* are only returned if the type filter in <code>ListChannelMemberships</code> equals
|
|
2159
2158
|
* <code>HIDDEN</code>.</p>
|
|
2159
|
+
* @public
|
|
2160
2160
|
*/
|
|
2161
2161
|
Type?: ChannelMembershipType;
|
|
2162
2162
|
/**
|
|
2163
|
-
* @public
|
|
2164
2163
|
* <p>The maximum number of channel memberships that you want returned.</p>
|
|
2164
|
+
* @public
|
|
2165
2165
|
*/
|
|
2166
2166
|
MaxResults?: number;
|
|
2167
2167
|
/**
|
|
2168
|
-
* @public
|
|
2169
2168
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
2170
2169
|
* returned.</p>
|
|
2170
|
+
* @public
|
|
2171
2171
|
*/
|
|
2172
2172
|
NextToken?: string;
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2176
2175
|
* that makes the API call.</p>
|
|
2176
|
+
* @public
|
|
2177
2177
|
*/
|
|
2178
2178
|
ChimeBearer: string | undefined;
|
|
2179
2179
|
/**
|
|
2180
|
-
* @public
|
|
2181
2180
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2182
2181
|
* <note>
|
|
2183
2182
|
* <p>Only required when listing a user's memberships in a particular sub-channel of an elastic channel.</p>
|
|
2184
2183
|
* </note>
|
|
2184
|
+
* @public
|
|
2185
2185
|
*/
|
|
2186
2186
|
SubChannelId?: string;
|
|
2187
2187
|
}
|
|
@@ -2190,19 +2190,19 @@ export interface ListChannelMembershipsRequest {
|
|
|
2190
2190
|
*/
|
|
2191
2191
|
export interface ListChannelMembershipsResponse {
|
|
2192
2192
|
/**
|
|
2193
|
-
* @public
|
|
2194
2193
|
* <p>The ARN of the channel.</p>
|
|
2194
|
+
* @public
|
|
2195
2195
|
*/
|
|
2196
2196
|
ChannelArn?: string;
|
|
2197
2197
|
/**
|
|
2198
|
-
* @public
|
|
2199
2198
|
* <p>The information for the requested channel memberships.</p>
|
|
2199
|
+
* @public
|
|
2200
2200
|
*/
|
|
2201
2201
|
ChannelMemberships?: ChannelMembershipSummary[];
|
|
2202
2202
|
/**
|
|
2203
|
-
* @public
|
|
2204
2203
|
* <p>The token passed by previous API calls until all requested channel memberships are
|
|
2205
2204
|
* returned.</p>
|
|
2205
|
+
* @public
|
|
2206
2206
|
*/
|
|
2207
2207
|
NextToken?: string;
|
|
2208
2208
|
}
|
|
@@ -2211,25 +2211,25 @@ export interface ListChannelMembershipsResponse {
|
|
|
2211
2211
|
*/
|
|
2212
2212
|
export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
2213
2213
|
/**
|
|
2214
|
-
* @public
|
|
2215
2214
|
* <p>The ARN of the user or bot.</p>
|
|
2215
|
+
* @public
|
|
2216
2216
|
*/
|
|
2217
2217
|
AppInstanceUserArn?: string;
|
|
2218
2218
|
/**
|
|
2219
|
-
* @public
|
|
2220
2219
|
* <p>The maximum number of users that you want returned.</p>
|
|
2220
|
+
* @public
|
|
2221
2221
|
*/
|
|
2222
2222
|
MaxResults?: number;
|
|
2223
2223
|
/**
|
|
2224
|
-
* @public
|
|
2225
2224
|
* <p>The token returned from previous API requests until the number of channel memberships is
|
|
2226
2225
|
* reached.</p>
|
|
2226
|
+
* @public
|
|
2227
2227
|
*/
|
|
2228
2228
|
NextToken?: string;
|
|
2229
2229
|
/**
|
|
2230
|
-
* @public
|
|
2231
2230
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2232
2231
|
* that makes the API call.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
ChimeBearer: string | undefined;
|
|
2235
2235
|
}
|
|
@@ -2238,13 +2238,13 @@ export interface ListChannelMembershipsForAppInstanceUserRequest {
|
|
|
2238
2238
|
*/
|
|
2239
2239
|
export interface ListChannelMembershipsForAppInstanceUserResponse {
|
|
2240
2240
|
/**
|
|
2241
|
-
* @public
|
|
2242
2241
|
* <p>The information for the requested channel memberships.</p>
|
|
2242
|
+
* @public
|
|
2243
2243
|
*/
|
|
2244
2244
|
ChannelMemberships?: ChannelMembershipForAppInstanceUserSummary[];
|
|
2245
2245
|
/**
|
|
2246
|
-
* @public
|
|
2247
2246
|
* <p>The token passed by previous API calls until all requested users are returned.</p>
|
|
2247
|
+
* @public
|
|
2248
2248
|
*/
|
|
2249
2249
|
NextToken?: string;
|
|
2250
2250
|
}
|
|
@@ -2265,48 +2265,48 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
2265
2265
|
*/
|
|
2266
2266
|
export interface ListChannelMessagesRequest {
|
|
2267
2267
|
/**
|
|
2268
|
-
* @public
|
|
2269
2268
|
* <p>The ARN of the channel.</p>
|
|
2269
|
+
* @public
|
|
2270
2270
|
*/
|
|
2271
2271
|
ChannelArn: string | undefined;
|
|
2272
2272
|
/**
|
|
2273
|
-
* @public
|
|
2274
2273
|
* <p>The order in which you want messages sorted. Default is Descending, based on time
|
|
2275
2274
|
* created.</p>
|
|
2275
|
+
* @public
|
|
2276
2276
|
*/
|
|
2277
2277
|
SortOrder?: SortOrder;
|
|
2278
2278
|
/**
|
|
2279
|
-
* @public
|
|
2280
2279
|
* <p>The initial or starting time stamp for your requested messages.</p>
|
|
2280
|
+
* @public
|
|
2281
2281
|
*/
|
|
2282
2282
|
NotBefore?: Date;
|
|
2283
2283
|
/**
|
|
2284
|
-
* @public
|
|
2285
2284
|
* <p>The final or ending time stamp for your requested messages.</p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
NotAfter?: Date;
|
|
2288
2288
|
/**
|
|
2289
|
-
* @public
|
|
2290
2289
|
* <p>The maximum number of messages that you want returned.</p>
|
|
2290
|
+
* @public
|
|
2291
2291
|
*/
|
|
2292
2292
|
MaxResults?: number;
|
|
2293
2293
|
/**
|
|
2294
|
-
* @public
|
|
2295
2294
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
2295
|
+
* @public
|
|
2296
2296
|
*/
|
|
2297
2297
|
NextToken?: string;
|
|
2298
2298
|
/**
|
|
2299
|
-
* @public
|
|
2300
2299
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2301
2300
|
* that makes the API call.</p>
|
|
2301
|
+
* @public
|
|
2302
2302
|
*/
|
|
2303
2303
|
ChimeBearer: string | undefined;
|
|
2304
2304
|
/**
|
|
2305
|
-
* @public
|
|
2306
2305
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2307
2306
|
* <note>
|
|
2308
2307
|
* <p>Only required when listing the messages in a SubChannel that the user belongs to.</p>
|
|
2309
2308
|
* </note>
|
|
2309
|
+
* @public
|
|
2310
2310
|
*/
|
|
2311
2311
|
SubChannelId?: string;
|
|
2312
2312
|
}
|
|
@@ -2315,23 +2315,23 @@ export interface ListChannelMessagesRequest {
|
|
|
2315
2315
|
*/
|
|
2316
2316
|
export interface ListChannelMessagesResponse {
|
|
2317
2317
|
/**
|
|
2318
|
-
* @public
|
|
2319
2318
|
* <p>The ARN of the channel containing the requested messages.</p>
|
|
2319
|
+
* @public
|
|
2320
2320
|
*/
|
|
2321
2321
|
ChannelArn?: string;
|
|
2322
2322
|
/**
|
|
2323
|
-
* @public
|
|
2324
2323
|
* <p>The token passed by previous API calls until all requested messages are returned.</p>
|
|
2324
|
+
* @public
|
|
2325
2325
|
*/
|
|
2326
2326
|
NextToken?: string;
|
|
2327
2327
|
/**
|
|
2328
|
-
* @public
|
|
2329
2328
|
* <p>The information about, and content of, each requested message.</p>
|
|
2329
|
+
* @public
|
|
2330
2330
|
*/
|
|
2331
2331
|
ChannelMessages?: ChannelMessageSummary[];
|
|
2332
2332
|
/**
|
|
2333
|
-
* @public
|
|
2334
2333
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2334
|
+
* @public
|
|
2335
2335
|
*/
|
|
2336
2336
|
SubChannelId?: string;
|
|
2337
2337
|
}
|
|
@@ -2340,25 +2340,25 @@ export interface ListChannelMessagesResponse {
|
|
|
2340
2340
|
*/
|
|
2341
2341
|
export interface ListChannelModeratorsRequest {
|
|
2342
2342
|
/**
|
|
2343
|
-
* @public
|
|
2344
2343
|
* <p>The ARN of the channel.</p>
|
|
2344
|
+
* @public
|
|
2345
2345
|
*/
|
|
2346
2346
|
ChannelArn: string | undefined;
|
|
2347
2347
|
/**
|
|
2348
|
-
* @public
|
|
2349
2348
|
* <p>The maximum number of moderators that you want returned.</p>
|
|
2349
|
+
* @public
|
|
2350
2350
|
*/
|
|
2351
2351
|
MaxResults?: number;
|
|
2352
2352
|
/**
|
|
2353
|
-
* @public
|
|
2354
2353
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
2355
2354
|
* returned.</p>
|
|
2355
|
+
* @public
|
|
2356
2356
|
*/
|
|
2357
2357
|
NextToken?: string;
|
|
2358
2358
|
/**
|
|
2359
|
-
* @public
|
|
2360
2359
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2361
2360
|
* that makes the API call.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
ChimeBearer: string | undefined;
|
|
2364
2364
|
}
|
|
@@ -2367,19 +2367,19 @@ export interface ListChannelModeratorsRequest {
|
|
|
2367
2367
|
*/
|
|
2368
2368
|
export interface ListChannelModeratorsResponse {
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>The ARN of the channel.</p>
|
|
2371
|
+
* @public
|
|
2372
2372
|
*/
|
|
2373
2373
|
ChannelArn?: string;
|
|
2374
2374
|
/**
|
|
2375
|
-
* @public
|
|
2376
2375
|
* <p>The token passed by previous API calls until all requested moderators are
|
|
2377
2376
|
* returned.</p>
|
|
2377
|
+
* @public
|
|
2378
2378
|
*/
|
|
2379
2379
|
NextToken?: string;
|
|
2380
2380
|
/**
|
|
2381
|
-
* @public
|
|
2382
2381
|
* <p>The information about and names of each moderator.</p>
|
|
2382
|
+
* @public
|
|
2383
2383
|
*/
|
|
2384
2384
|
ChannelModerators?: ChannelModeratorSummary[];
|
|
2385
2385
|
}
|
|
@@ -2388,31 +2388,31 @@ export interface ListChannelModeratorsResponse {
|
|
|
2388
2388
|
*/
|
|
2389
2389
|
export interface ListChannelsRequest {
|
|
2390
2390
|
/**
|
|
2391
|
-
* @public
|
|
2392
2391
|
* <p>The ARN of the <code>AppInstance</code>.</p>
|
|
2392
|
+
* @public
|
|
2393
2393
|
*/
|
|
2394
2394
|
AppInstanceArn: string | undefined;
|
|
2395
2395
|
/**
|
|
2396
|
-
* @public
|
|
2397
2396
|
* <p>The privacy setting. <code>PUBLIC</code> retrieves all the public channels.
|
|
2398
2397
|
* <code>PRIVATE</code> retrieves private channels. Only an <code>AppInstanceAdmin</code>
|
|
2399
2398
|
* can retrieve private channels. </p>
|
|
2399
|
+
* @public
|
|
2400
2400
|
*/
|
|
2401
2401
|
Privacy?: ChannelPrivacy;
|
|
2402
2402
|
/**
|
|
2403
|
-
* @public
|
|
2404
2403
|
* <p>The maximum number of channels that you want to return.</p>
|
|
2404
|
+
* @public
|
|
2405
2405
|
*/
|
|
2406
2406
|
MaxResults?: number;
|
|
2407
2407
|
/**
|
|
2408
|
-
* @public
|
|
2409
2408
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2409
|
+
* @public
|
|
2410
2410
|
*/
|
|
2411
2411
|
NextToken?: string;
|
|
2412
2412
|
/**
|
|
2413
|
-
* @public
|
|
2414
2413
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2415
2414
|
* that makes the API call.</p>
|
|
2415
|
+
* @public
|
|
2416
2416
|
*/
|
|
2417
2417
|
ChimeBearer: string | undefined;
|
|
2418
2418
|
}
|
|
@@ -2421,14 +2421,14 @@ export interface ListChannelsRequest {
|
|
|
2421
2421
|
*/
|
|
2422
2422
|
export interface ListChannelsResponse {
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p>The information about each channel.</p>
|
|
2425
|
+
* @public
|
|
2426
2426
|
*/
|
|
2427
2427
|
Channels?: ChannelSummary[];
|
|
2428
2428
|
/**
|
|
2429
|
-
* @public
|
|
2430
2429
|
* <p>The token returned from previous API requests until the number of channels is
|
|
2431
2430
|
* reached.</p>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
NextToken?: string;
|
|
2434
2434
|
}
|
|
@@ -2437,18 +2437,18 @@ export interface ListChannelsResponse {
|
|
|
2437
2437
|
*/
|
|
2438
2438
|
export interface ListChannelsAssociatedWithChannelFlowRequest {
|
|
2439
2439
|
/**
|
|
2440
|
-
* @public
|
|
2441
2440
|
* <p>The ARN of the channel flow.</p>
|
|
2441
|
+
* @public
|
|
2442
2442
|
*/
|
|
2443
2443
|
ChannelFlowArn: string | undefined;
|
|
2444
2444
|
/**
|
|
2445
|
-
* @public
|
|
2446
2445
|
* <p>The maximum number of channels that you want to return.</p>
|
|
2446
|
+
* @public
|
|
2447
2447
|
*/
|
|
2448
2448
|
MaxResults?: number;
|
|
2449
2449
|
/**
|
|
2450
|
-
* @public
|
|
2451
2450
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2451
|
+
* @public
|
|
2452
2452
|
*/
|
|
2453
2453
|
NextToken?: string;
|
|
2454
2454
|
}
|
|
@@ -2457,13 +2457,13 @@ export interface ListChannelsAssociatedWithChannelFlowRequest {
|
|
|
2457
2457
|
*/
|
|
2458
2458
|
export interface ListChannelsAssociatedWithChannelFlowResponse {
|
|
2459
2459
|
/**
|
|
2460
|
-
* @public
|
|
2461
2460
|
* <p>The information about each channel.</p>
|
|
2461
|
+
* @public
|
|
2462
2462
|
*/
|
|
2463
2463
|
Channels?: ChannelAssociatedWithFlowSummary[];
|
|
2464
2464
|
/**
|
|
2465
|
-
* @public
|
|
2466
2465
|
* <p>The token passed by previous API calls until all requested channels are returned.</p>
|
|
2466
|
+
* @public
|
|
2467
2467
|
*/
|
|
2468
2468
|
NextToken?: string;
|
|
2469
2469
|
}
|
|
@@ -2472,25 +2472,25 @@ export interface ListChannelsAssociatedWithChannelFlowResponse {
|
|
|
2472
2472
|
*/
|
|
2473
2473
|
export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
2474
2474
|
/**
|
|
2475
|
-
* @public
|
|
2476
2475
|
* <p>The ARN of the user or bot in the moderated channel.</p>
|
|
2476
|
+
* @public
|
|
2477
2477
|
*/
|
|
2478
2478
|
AppInstanceUserArn?: string;
|
|
2479
2479
|
/**
|
|
2480
|
-
* @public
|
|
2481
2480
|
* <p>The maximum number of channels in the request.</p>
|
|
2481
|
+
* @public
|
|
2482
2482
|
*/
|
|
2483
2483
|
MaxResults?: number;
|
|
2484
2484
|
/**
|
|
2485
|
-
* @public
|
|
2486
2485
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
2487
2486
|
* the user is reached.</p>
|
|
2487
|
+
* @public
|
|
2488
2488
|
*/
|
|
2489
2489
|
NextToken?: string;
|
|
2490
2490
|
/**
|
|
2491
|
-
* @public
|
|
2492
2491
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2493
2492
|
* that makes the API call.</p>
|
|
2493
|
+
* @public
|
|
2494
2494
|
*/
|
|
2495
2495
|
ChimeBearer: string | undefined;
|
|
2496
2496
|
}
|
|
@@ -2499,14 +2499,14 @@ export interface ListChannelsModeratedByAppInstanceUserRequest {
|
|
|
2499
2499
|
*/
|
|
2500
2500
|
export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
2501
2501
|
/**
|
|
2502
|
-
* @public
|
|
2503
2502
|
* <p>The moderated channels in the request.</p>
|
|
2503
|
+
* @public
|
|
2504
2504
|
*/
|
|
2505
2505
|
Channels?: ChannelModeratedByAppInstanceUserSummary[];
|
|
2506
2506
|
/**
|
|
2507
|
-
* @public
|
|
2508
2507
|
* <p>The token returned from previous API requests until the number of channels moderated by
|
|
2509
2508
|
* the user is reached.</p>
|
|
2509
|
+
* @public
|
|
2510
2510
|
*/
|
|
2511
2511
|
NextToken?: string;
|
|
2512
2512
|
}
|
|
@@ -2515,39 +2515,39 @@ export interface ListChannelsModeratedByAppInstanceUserResponse {
|
|
|
2515
2515
|
*/
|
|
2516
2516
|
export interface ListSubChannelsRequest {
|
|
2517
2517
|
/**
|
|
2518
|
-
* @public
|
|
2519
2518
|
* <p>The ARN of elastic channel.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
ChannelArn: string | undefined;
|
|
2522
2522
|
/**
|
|
2523
|
-
* @public
|
|
2524
2523
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
2524
|
+
* @public
|
|
2525
2525
|
*/
|
|
2526
2526
|
ChimeBearer: string | undefined;
|
|
2527
2527
|
/**
|
|
2528
|
-
* @public
|
|
2529
2528
|
* <p>The maximum number of sub-channels that you want to return.</p>
|
|
2529
|
+
* @public
|
|
2530
2530
|
*/
|
|
2531
2531
|
MaxResults?: number;
|
|
2532
2532
|
/**
|
|
2533
|
-
* @public
|
|
2534
2533
|
* <p>The token passed by previous API calls until all requested sub-channels are returned.</p>
|
|
2534
|
+
* @public
|
|
2535
2535
|
*/
|
|
2536
2536
|
NextToken?: string;
|
|
2537
2537
|
}
|
|
2538
2538
|
/**
|
|
2539
|
-
* @public
|
|
2540
2539
|
* <p>Summary of the sub-channels associated with the elastic channel.</p>
|
|
2540
|
+
* @public
|
|
2541
2541
|
*/
|
|
2542
2542
|
export interface SubChannelSummary {
|
|
2543
2543
|
/**
|
|
2544
|
-
* @public
|
|
2545
2544
|
* <p>The unique ID of a SubChannel.</p>
|
|
2545
|
+
* @public
|
|
2546
2546
|
*/
|
|
2547
2547
|
SubChannelId?: string;
|
|
2548
2548
|
/**
|
|
2549
|
-
* @public
|
|
2550
2549
|
* <p>The number of members in a SubChannel.</p>
|
|
2550
|
+
* @public
|
|
2551
2551
|
*/
|
|
2552
2552
|
MembershipCount?: number;
|
|
2553
2553
|
}
|
|
@@ -2556,18 +2556,18 @@ export interface SubChannelSummary {
|
|
|
2556
2556
|
*/
|
|
2557
2557
|
export interface ListSubChannelsResponse {
|
|
2558
2558
|
/**
|
|
2559
|
-
* @public
|
|
2560
2559
|
* <p>The ARN of elastic channel.</p>
|
|
2560
|
+
* @public
|
|
2561
2561
|
*/
|
|
2562
2562
|
ChannelArn?: string;
|
|
2563
2563
|
/**
|
|
2564
|
-
* @public
|
|
2565
2564
|
* <p>The information about each sub-channel.</p>
|
|
2565
|
+
* @public
|
|
2566
2566
|
*/
|
|
2567
2567
|
SubChannels?: SubChannelSummary[];
|
|
2568
2568
|
/**
|
|
2569
|
-
* @public
|
|
2570
2569
|
* <p>The token passed by previous API calls until all requested sub-channels are returned.</p>
|
|
2570
|
+
* @public
|
|
2571
2571
|
*/
|
|
2572
2572
|
NextToken?: string;
|
|
2573
2573
|
}
|
|
@@ -2576,8 +2576,8 @@ export interface ListSubChannelsResponse {
|
|
|
2576
2576
|
*/
|
|
2577
2577
|
export interface ListTagsForResourceRequest {
|
|
2578
2578
|
/**
|
|
2579
|
-
* @public
|
|
2580
2579
|
* <p>The ARN of the resource.</p>
|
|
2580
|
+
* @public
|
|
2581
2581
|
*/
|
|
2582
2582
|
ResourceARN: string | undefined;
|
|
2583
2583
|
}
|
|
@@ -2586,8 +2586,8 @@ export interface ListTagsForResourceRequest {
|
|
|
2586
2586
|
*/
|
|
2587
2587
|
export interface ListTagsForResourceResponse {
|
|
2588
2588
|
/**
|
|
2589
|
-
* @public
|
|
2590
2589
|
* <p>The tag key-value pairs.</p>
|
|
2590
|
+
* @public
|
|
2591
2591
|
*/
|
|
2592
2592
|
Tags?: Tag[];
|
|
2593
2593
|
}
|
|
@@ -2596,18 +2596,18 @@ export interface ListTagsForResourceResponse {
|
|
|
2596
2596
|
*/
|
|
2597
2597
|
export interface PutChannelExpirationSettingsRequest {
|
|
2598
2598
|
/**
|
|
2599
|
-
* @public
|
|
2600
2599
|
* <p>The ARN of the channel.</p>
|
|
2600
|
+
* @public
|
|
2601
2601
|
*/
|
|
2602
2602
|
ChannelArn: string | undefined;
|
|
2603
2603
|
/**
|
|
2604
|
-
* @public
|
|
2605
2604
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
2605
|
+
* @public
|
|
2606
2606
|
*/
|
|
2607
2607
|
ChimeBearer?: string;
|
|
2608
2608
|
/**
|
|
2609
|
-
* @public
|
|
2610
2609
|
* <p>Settings that control the interval after which a channel is deleted.</p>
|
|
2610
|
+
* @public
|
|
2611
2611
|
*/
|
|
2612
2612
|
ExpirationSettings?: ExpirationSettings;
|
|
2613
2613
|
}
|
|
@@ -2616,13 +2616,13 @@ export interface PutChannelExpirationSettingsRequest {
|
|
|
2616
2616
|
*/
|
|
2617
2617
|
export interface PutChannelExpirationSettingsResponse {
|
|
2618
2618
|
/**
|
|
2619
|
-
* @public
|
|
2620
2619
|
* <p>The channel ARN.</p>
|
|
2620
|
+
* @public
|
|
2621
2621
|
*/
|
|
2622
2622
|
ChannelArn?: string;
|
|
2623
2623
|
/**
|
|
2624
|
-
* @public
|
|
2625
2624
|
* <p>Settings that control the interval after which a channel is deleted.</p>
|
|
2625
|
+
* @public
|
|
2626
2626
|
*/
|
|
2627
2627
|
ExpirationSettings?: ExpirationSettings;
|
|
2628
2628
|
}
|
|
@@ -2631,23 +2631,23 @@ export interface PutChannelExpirationSettingsResponse {
|
|
|
2631
2631
|
*/
|
|
2632
2632
|
export interface PutChannelMembershipPreferencesRequest {
|
|
2633
2633
|
/**
|
|
2634
|
-
* @public
|
|
2635
2634
|
* <p>The ARN of the channel.</p>
|
|
2635
|
+
* @public
|
|
2636
2636
|
*/
|
|
2637
2637
|
ChannelArn: string | undefined;
|
|
2638
2638
|
/**
|
|
2639
|
-
* @public
|
|
2640
2639
|
* <p>The ARN of the member setting the preferences.</p>
|
|
2640
|
+
* @public
|
|
2641
2641
|
*/
|
|
2642
2642
|
MemberArn: string | undefined;
|
|
2643
2643
|
/**
|
|
2644
|
-
* @public
|
|
2645
2644
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code> that makes the API call.</p>
|
|
2645
|
+
* @public
|
|
2646
2646
|
*/
|
|
2647
2647
|
ChimeBearer: string | undefined;
|
|
2648
2648
|
/**
|
|
2649
|
-
* @public
|
|
2650
2649
|
* <p>The channel membership preferences of an <code>AppInstanceUser</code> .</p>
|
|
2650
|
+
* @public
|
|
2651
2651
|
*/
|
|
2652
2652
|
Preferences: ChannelMembershipPreferences | undefined;
|
|
2653
2653
|
}
|
|
@@ -2656,18 +2656,18 @@ export interface PutChannelMembershipPreferencesRequest {
|
|
|
2656
2656
|
*/
|
|
2657
2657
|
export interface PutChannelMembershipPreferencesResponse {
|
|
2658
2658
|
/**
|
|
2659
|
-
* @public
|
|
2660
2659
|
* <p>The ARN of the channel.</p>
|
|
2660
|
+
* @public
|
|
2661
2661
|
*/
|
|
2662
2662
|
ChannelArn?: string;
|
|
2663
2663
|
/**
|
|
2664
|
-
* @public
|
|
2665
2664
|
* <p>The details of a user.</p>
|
|
2665
|
+
* @public
|
|
2666
2666
|
*/
|
|
2667
2667
|
Member?: Identity;
|
|
2668
2668
|
/**
|
|
2669
|
-
* @public
|
|
2670
2669
|
* <p>The ARN and metadata of the member being added.</p>
|
|
2670
|
+
* @public
|
|
2671
2671
|
*/
|
|
2672
2672
|
Preferences?: ChannelMembershipPreferences;
|
|
2673
2673
|
}
|
|
@@ -2676,13 +2676,13 @@ export interface PutChannelMembershipPreferencesResponse {
|
|
|
2676
2676
|
*/
|
|
2677
2677
|
export interface PutMessagingStreamingConfigurationsRequest {
|
|
2678
2678
|
/**
|
|
2679
|
-
* @public
|
|
2680
2679
|
* <p>The ARN of the streaming configuration.</p>
|
|
2680
|
+
* @public
|
|
2681
2681
|
*/
|
|
2682
2682
|
AppInstanceArn: string | undefined;
|
|
2683
2683
|
/**
|
|
2684
|
-
* @public
|
|
2685
2684
|
* <p>The streaming configurations.</p>
|
|
2685
|
+
* @public
|
|
2686
2686
|
*/
|
|
2687
2687
|
StreamingConfigurations: StreamingConfiguration[] | undefined;
|
|
2688
2688
|
}
|
|
@@ -2691,8 +2691,8 @@ export interface PutMessagingStreamingConfigurationsRequest {
|
|
|
2691
2691
|
*/
|
|
2692
2692
|
export interface PutMessagingStreamingConfigurationsResponse {
|
|
2693
2693
|
/**
|
|
2694
|
-
* @public
|
|
2695
2694
|
* <p>The requested streaming configurations.</p>
|
|
2695
|
+
* @public
|
|
2696
2696
|
*/
|
|
2697
2697
|
StreamingConfigurations?: StreamingConfiguration[];
|
|
2698
2698
|
}
|
|
@@ -2701,24 +2701,24 @@ export interface PutMessagingStreamingConfigurationsResponse {
|
|
|
2701
2701
|
*/
|
|
2702
2702
|
export interface RedactChannelMessageRequest {
|
|
2703
2703
|
/**
|
|
2704
|
-
* @public
|
|
2705
2704
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
2705
|
+
* @public
|
|
2706
2706
|
*/
|
|
2707
2707
|
ChannelArn: string | undefined;
|
|
2708
2708
|
/**
|
|
2709
|
-
* @public
|
|
2710
2709
|
* <p>The ID of the message being redacted.</p>
|
|
2710
|
+
* @public
|
|
2711
2711
|
*/
|
|
2712
2712
|
MessageId: string | undefined;
|
|
2713
2713
|
/**
|
|
2714
|
-
* @public
|
|
2715
2714
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2716
2715
|
* that makes the API call.</p>
|
|
2716
|
+
* @public
|
|
2717
2717
|
*/
|
|
2718
2718
|
ChimeBearer: string | undefined;
|
|
2719
2719
|
/**
|
|
2720
|
-
* @public
|
|
2721
2720
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2721
|
+
* @public
|
|
2722
2722
|
*/
|
|
2723
2723
|
SubChannelId?: string;
|
|
2724
2724
|
}
|
|
@@ -2727,21 +2727,21 @@ export interface RedactChannelMessageRequest {
|
|
|
2727
2727
|
*/
|
|
2728
2728
|
export interface RedactChannelMessageResponse {
|
|
2729
2729
|
/**
|
|
2730
|
-
* @public
|
|
2731
2730
|
* <p>The ARN of the channel containing the messages that you want to redact.</p>
|
|
2731
|
+
* @public
|
|
2732
2732
|
*/
|
|
2733
2733
|
ChannelArn?: string;
|
|
2734
2734
|
/**
|
|
2735
|
-
* @public
|
|
2736
2735
|
* <p>The ID of the message being redacted.</p>
|
|
2736
|
+
* @public
|
|
2737
2737
|
*/
|
|
2738
2738
|
MessageId?: string;
|
|
2739
2739
|
/**
|
|
2740
|
-
* @public
|
|
2741
2740
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2742
2741
|
* <note>
|
|
2743
2742
|
* <p>Only required when redacting messages in a SubChannel that the user belongs to.</p>
|
|
2744
2743
|
* </note>
|
|
2744
|
+
* @public
|
|
2745
2745
|
*/
|
|
2746
2746
|
SubChannelId?: string;
|
|
2747
2747
|
}
|
|
@@ -2769,28 +2769,28 @@ export declare const SearchFieldOperator: {
|
|
|
2769
2769
|
*/
|
|
2770
2770
|
export type SearchFieldOperator = (typeof SearchFieldOperator)[keyof typeof SearchFieldOperator];
|
|
2771
2771
|
/**
|
|
2772
|
-
* @public
|
|
2773
2772
|
* <p>A <code>Field</code> of the channel that you want to search.</p>
|
|
2773
|
+
* @public
|
|
2774
2774
|
*/
|
|
2775
2775
|
export interface SearchField {
|
|
2776
2776
|
/**
|
|
2777
|
-
* @public
|
|
2778
2777
|
* <p>An <code>enum</code> value that indicates the key to search the channel on. <code>MEMBERS</code> allows you to search channels based on memberships. You can use it with the <code>EQUALS</code>
|
|
2779
2778
|
* operator to get channels whose memberships are equal to the specified values, and with the <code>INCLUDES</code> operator to get channels whose memberships include the specified values.</p>
|
|
2779
|
+
* @public
|
|
2780
2780
|
*/
|
|
2781
2781
|
Key: SearchFieldKey | undefined;
|
|
2782
2782
|
/**
|
|
2783
|
-
* @public
|
|
2784
2783
|
* <p>The values that you want to search for, a list of strings. The values must be <code>AppInstanceUserArns</code> specified as a list of strings.</p>
|
|
2785
2784
|
* <note>
|
|
2786
2785
|
* <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p>
|
|
2787
2786
|
* </note>
|
|
2787
|
+
* @public
|
|
2788
2788
|
*/
|
|
2789
2789
|
Values: string[] | undefined;
|
|
2790
2790
|
/**
|
|
2791
|
-
* @public
|
|
2792
2791
|
* <p>The operator used to compare field values, currently <code>EQUALS</code> or <code>INCLUDES</code>. Use the <code>EQUALS</code> operator to find channels whose memberships equal the specified values.
|
|
2793
2792
|
* Use the <code>INCLUDES</code> operator to find channels whose memberships include the specified values.</p>
|
|
2793
|
+
* @public
|
|
2794
2794
|
*/
|
|
2795
2795
|
Operator: SearchFieldOperator | undefined;
|
|
2796
2796
|
}
|
|
@@ -2799,23 +2799,23 @@ export interface SearchField {
|
|
|
2799
2799
|
*/
|
|
2800
2800
|
export interface SearchChannelsRequest {
|
|
2801
2801
|
/**
|
|
2802
|
-
* @public
|
|
2803
2802
|
* <p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>
|
|
2803
|
+
* @public
|
|
2804
2804
|
*/
|
|
2805
2805
|
ChimeBearer?: string;
|
|
2806
2806
|
/**
|
|
2807
|
-
* @public
|
|
2808
2807
|
* <p>A list of the <code>Field</code> objects in the channel being searched.</p>
|
|
2808
|
+
* @public
|
|
2809
2809
|
*/
|
|
2810
2810
|
Fields: SearchField[] | undefined;
|
|
2811
2811
|
/**
|
|
2812
|
-
* @public
|
|
2813
2812
|
* <p>The maximum number of channels that you want returned.</p>
|
|
2813
|
+
* @public
|
|
2814
2814
|
*/
|
|
2815
2815
|
MaxResults?: number;
|
|
2816
2816
|
/**
|
|
2817
|
-
* @public
|
|
2818
2817
|
* <p>The token returned from previous API requests until the number of channels is reached.</p>
|
|
2818
|
+
* @public
|
|
2819
2819
|
*/
|
|
2820
2820
|
NextToken?: string;
|
|
2821
2821
|
}
|
|
@@ -2824,13 +2824,13 @@ export interface SearchChannelsRequest {
|
|
|
2824
2824
|
*/
|
|
2825
2825
|
export interface SearchChannelsResponse {
|
|
2826
2826
|
/**
|
|
2827
|
-
* @public
|
|
2828
2827
|
* <p>A list of the channels in the request.</p>
|
|
2828
|
+
* @public
|
|
2829
2829
|
*/
|
|
2830
2830
|
Channels?: ChannelSummary[];
|
|
2831
2831
|
/**
|
|
2832
|
-
* @public
|
|
2833
2832
|
* <p>The token returned from previous API responses until the number of channels is reached.</p>
|
|
2833
|
+
* @public
|
|
2834
2834
|
*/
|
|
2835
2835
|
NextToken?: string;
|
|
2836
2836
|
}
|
|
@@ -2839,71 +2839,71 @@ export interface SearchChannelsResponse {
|
|
|
2839
2839
|
*/
|
|
2840
2840
|
export interface SendChannelMessageRequest {
|
|
2841
2841
|
/**
|
|
2842
|
-
* @public
|
|
2843
2842
|
* <p>The ARN of the channel.</p>
|
|
2843
|
+
* @public
|
|
2844
2844
|
*/
|
|
2845
2845
|
ChannelArn: string | undefined;
|
|
2846
2846
|
/**
|
|
2847
|
-
* @public
|
|
2848
2847
|
* <p>The content of the channel message.</p>
|
|
2848
|
+
* @public
|
|
2849
2849
|
*/
|
|
2850
2850
|
Content: string | undefined;
|
|
2851
2851
|
/**
|
|
2852
|
-
* @public
|
|
2853
2852
|
* <p>The type of message, <code>STANDARD</code> or <code>CONTROL</code>.</p>
|
|
2854
2853
|
* <p>
|
|
2855
2854
|
* <code>STANDARD</code> messages can be up to 4KB in size and contain metadata. Metadata is arbitrary,
|
|
2856
2855
|
* and you can use it in a variety of ways, such as containing a link to an attachment.</p>
|
|
2857
2856
|
* <p>
|
|
2858
2857
|
* <code>CONTROL</code> messages are limited to 30 bytes and do not contain metadata.</p>
|
|
2858
|
+
* @public
|
|
2859
2859
|
*/
|
|
2860
2860
|
Type: ChannelMessageType | undefined;
|
|
2861
2861
|
/**
|
|
2862
|
-
* @public
|
|
2863
2862
|
* <p>Boolean that controls whether the message is persisted on the back end. Required.</p>
|
|
2863
|
+
* @public
|
|
2864
2864
|
*/
|
|
2865
2865
|
Persistence: ChannelMessagePersistenceType | undefined;
|
|
2866
2866
|
/**
|
|
2867
|
-
* @public
|
|
2868
2867
|
* <p>The optional metadata for each message.</p>
|
|
2868
|
+
* @public
|
|
2869
2869
|
*/
|
|
2870
2870
|
Metadata?: string;
|
|
2871
2871
|
/**
|
|
2872
|
-
* @public
|
|
2873
2872
|
* <p>The <code>Idempotency</code> token for each client request.</p>
|
|
2873
|
+
* @public
|
|
2874
2874
|
*/
|
|
2875
2875
|
ClientRequestToken?: string;
|
|
2876
2876
|
/**
|
|
2877
|
-
* @public
|
|
2878
2877
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2879
2878
|
* that makes the API call.</p>
|
|
2879
|
+
* @public
|
|
2880
2880
|
*/
|
|
2881
2881
|
ChimeBearer: string | undefined;
|
|
2882
2882
|
/**
|
|
2883
|
-
* @public
|
|
2884
2883
|
* <p>The push notification configuration of the message.</p>
|
|
2884
|
+
* @public
|
|
2885
2885
|
*/
|
|
2886
2886
|
PushNotification?: PushNotificationConfiguration;
|
|
2887
2887
|
/**
|
|
2888
|
-
* @public
|
|
2889
2888
|
* <p>The attributes for the message, used for message filtering along with a <code>FilterRule</code> defined in the <code>PushNotificationPreferences</code>.</p>
|
|
2889
|
+
* @public
|
|
2890
2890
|
*/
|
|
2891
2891
|
MessageAttributes?: Record<string, MessageAttributeValue>;
|
|
2892
2892
|
/**
|
|
2893
|
-
* @public
|
|
2894
2893
|
* <p>The ID of the SubChannel in the request.</p>
|
|
2894
|
+
* @public
|
|
2895
2895
|
*/
|
|
2896
2896
|
SubChannelId?: string;
|
|
2897
2897
|
/**
|
|
2898
|
-
* @public
|
|
2899
2898
|
* <p>The content type of the channel message.</p>
|
|
2899
|
+
* @public
|
|
2900
2900
|
*/
|
|
2901
2901
|
ContentType?: string;
|
|
2902
2902
|
/**
|
|
2903
|
-
* @public
|
|
2904
2903
|
* <p>The target of a message. Must be a member of the channel, such as another user, a bot, or the sender. Only the target and the sender can view targeted messages.
|
|
2905
2904
|
* Only users who can see targeted messages can take actions on them. However, administrators can delete targeted messages that they can’t see.
|
|
2906
2905
|
* </p>
|
|
2906
|
+
* @public
|
|
2907
2907
|
*/
|
|
2908
2908
|
Target?: Target[];
|
|
2909
2909
|
}
|
|
@@ -2912,23 +2912,23 @@ export interface SendChannelMessageRequest {
|
|
|
2912
2912
|
*/
|
|
2913
2913
|
export interface SendChannelMessageResponse {
|
|
2914
2914
|
/**
|
|
2915
|
-
* @public
|
|
2916
2915
|
* <p>The ARN of the channel.</p>
|
|
2916
|
+
* @public
|
|
2917
2917
|
*/
|
|
2918
2918
|
ChannelArn?: string;
|
|
2919
2919
|
/**
|
|
2920
|
-
* @public
|
|
2921
2920
|
* <p>The ID string assigned to each message.</p>
|
|
2921
|
+
* @public
|
|
2922
2922
|
*/
|
|
2923
2923
|
MessageId?: string;
|
|
2924
2924
|
/**
|
|
2925
|
-
* @public
|
|
2926
2925
|
* <p>The status of the channel message.</p>
|
|
2926
|
+
* @public
|
|
2927
2927
|
*/
|
|
2928
2928
|
Status?: ChannelMessageStatusStructure;
|
|
2929
2929
|
/**
|
|
2930
|
-
* @public
|
|
2931
2930
|
* <p>The ID of the SubChannel in the response.</p>
|
|
2931
|
+
* @public
|
|
2932
2932
|
*/
|
|
2933
2933
|
SubChannelId?: string;
|
|
2934
2934
|
}
|
|
@@ -2937,13 +2937,13 @@ export interface SendChannelMessageResponse {
|
|
|
2937
2937
|
*/
|
|
2938
2938
|
export interface TagResourceRequest {
|
|
2939
2939
|
/**
|
|
2940
|
-
* @public
|
|
2941
2940
|
* <p>The resource ARN.</p>
|
|
2941
|
+
* @public
|
|
2942
2942
|
*/
|
|
2943
2943
|
ResourceARN: string | undefined;
|
|
2944
2944
|
/**
|
|
2945
|
-
* @public
|
|
2946
2945
|
* <p>The tag key-value pairs.</p>
|
|
2946
|
+
* @public
|
|
2947
2947
|
*/
|
|
2948
2948
|
Tags: Tag[] | undefined;
|
|
2949
2949
|
}
|
|
@@ -2952,13 +2952,13 @@ export interface TagResourceRequest {
|
|
|
2952
2952
|
*/
|
|
2953
2953
|
export interface UntagResourceRequest {
|
|
2954
2954
|
/**
|
|
2955
|
-
* @public
|
|
2956
2955
|
* <p>The resource ARN.</p>
|
|
2956
|
+
* @public
|
|
2957
2957
|
*/
|
|
2958
2958
|
ResourceARN: string | undefined;
|
|
2959
2959
|
/**
|
|
2960
|
-
* @public
|
|
2961
2960
|
* <p>The tag keys.</p>
|
|
2961
|
+
* @public
|
|
2962
2962
|
*/
|
|
2963
2963
|
TagKeys: string[] | undefined;
|
|
2964
2964
|
}
|
|
@@ -2967,29 +2967,29 @@ export interface UntagResourceRequest {
|
|
|
2967
2967
|
*/
|
|
2968
2968
|
export interface UpdateChannelRequest {
|
|
2969
2969
|
/**
|
|
2970
|
-
* @public
|
|
2971
2970
|
* <p>The ARN of the channel.</p>
|
|
2971
|
+
* @public
|
|
2972
2972
|
*/
|
|
2973
2973
|
ChannelArn: string | undefined;
|
|
2974
2974
|
/**
|
|
2975
|
-
* @public
|
|
2976
2975
|
* <p>The name of the channel.</p>
|
|
2976
|
+
* @public
|
|
2977
2977
|
*/
|
|
2978
2978
|
Name?: string;
|
|
2979
2979
|
/**
|
|
2980
|
-
* @public
|
|
2981
2980
|
* <p>The mode of the update request.</p>
|
|
2981
|
+
* @public
|
|
2982
2982
|
*/
|
|
2983
2983
|
Mode?: ChannelMode;
|
|
2984
2984
|
/**
|
|
2985
|
-
* @public
|
|
2986
2985
|
* <p>The metadata for the update request.</p>
|
|
2986
|
+
* @public
|
|
2987
2987
|
*/
|
|
2988
2988
|
Metadata?: string;
|
|
2989
2989
|
/**
|
|
2990
|
-
* @public
|
|
2991
2990
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
2992
2991
|
* that makes the API call.</p>
|
|
2992
|
+
* @public
|
|
2993
2993
|
*/
|
|
2994
2994
|
ChimeBearer: string | undefined;
|
|
2995
2995
|
}
|
|
@@ -2998,8 +2998,8 @@ export interface UpdateChannelRequest {
|
|
|
2998
2998
|
*/
|
|
2999
2999
|
export interface UpdateChannelResponse {
|
|
3000
3000
|
/**
|
|
3001
|
-
* @public
|
|
3002
3001
|
* <p>The ARN of the channel.</p>
|
|
3002
|
+
* @public
|
|
3003
3003
|
*/
|
|
3004
3004
|
ChannelArn?: string;
|
|
3005
3005
|
}
|
|
@@ -3008,18 +3008,18 @@ export interface UpdateChannelResponse {
|
|
|
3008
3008
|
*/
|
|
3009
3009
|
export interface UpdateChannelFlowRequest {
|
|
3010
3010
|
/**
|
|
3011
|
-
* @public
|
|
3012
3011
|
* <p>The ARN of the channel flow.</p>
|
|
3012
|
+
* @public
|
|
3013
3013
|
*/
|
|
3014
3014
|
ChannelFlowArn: string | undefined;
|
|
3015
3015
|
/**
|
|
3016
|
-
* @public
|
|
3017
3016
|
* <p>Information about the processor Lambda functions </p>
|
|
3017
|
+
* @public
|
|
3018
3018
|
*/
|
|
3019
3019
|
Processors: Processor[] | undefined;
|
|
3020
3020
|
/**
|
|
3021
|
-
* @public
|
|
3022
3021
|
* <p>The name of the channel flow.</p>
|
|
3022
|
+
* @public
|
|
3023
3023
|
*/
|
|
3024
3024
|
Name: string | undefined;
|
|
3025
3025
|
}
|
|
@@ -3028,8 +3028,8 @@ export interface UpdateChannelFlowRequest {
|
|
|
3028
3028
|
*/
|
|
3029
3029
|
export interface UpdateChannelFlowResponse {
|
|
3030
3030
|
/**
|
|
3031
|
-
* @public
|
|
3032
3031
|
* <p>The ARN of the channel flow.</p>
|
|
3032
|
+
* @public
|
|
3033
3033
|
*/
|
|
3034
3034
|
ChannelFlowArn?: string;
|
|
3035
3035
|
}
|
|
@@ -3038,42 +3038,42 @@ export interface UpdateChannelFlowResponse {
|
|
|
3038
3038
|
*/
|
|
3039
3039
|
export interface UpdateChannelMessageRequest {
|
|
3040
3040
|
/**
|
|
3041
|
-
* @public
|
|
3042
3041
|
* <p>The ARN of the channel.</p>
|
|
3042
|
+
* @public
|
|
3043
3043
|
*/
|
|
3044
3044
|
ChannelArn: string | undefined;
|
|
3045
3045
|
/**
|
|
3046
|
-
* @public
|
|
3047
3046
|
* <p>The ID string of the message being updated.</p>
|
|
3047
|
+
* @public
|
|
3048
3048
|
*/
|
|
3049
3049
|
MessageId: string | undefined;
|
|
3050
3050
|
/**
|
|
3051
|
-
* @public
|
|
3052
3051
|
* <p>The content of the channel message. </p>
|
|
3052
|
+
* @public
|
|
3053
3053
|
*/
|
|
3054
3054
|
Content: string | undefined;
|
|
3055
3055
|
/**
|
|
3056
|
-
* @public
|
|
3057
3056
|
* <p>The metadata of the message being updated.</p>
|
|
3057
|
+
* @public
|
|
3058
3058
|
*/
|
|
3059
3059
|
Metadata?: string;
|
|
3060
3060
|
/**
|
|
3061
|
-
* @public
|
|
3062
3061
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
3063
3062
|
* that makes the API call.</p>
|
|
3063
|
+
* @public
|
|
3064
3064
|
*/
|
|
3065
3065
|
ChimeBearer: string | undefined;
|
|
3066
3066
|
/**
|
|
3067
|
-
* @public
|
|
3068
3067
|
* <p>The ID of the SubChannel in the request.</p>
|
|
3069
3068
|
* <note>
|
|
3070
3069
|
* <p>Only required when updating messages in a SubChannel that the user belongs to.</p>
|
|
3071
3070
|
* </note>
|
|
3071
|
+
* @public
|
|
3072
3072
|
*/
|
|
3073
3073
|
SubChannelId?: string;
|
|
3074
3074
|
/**
|
|
3075
|
-
* @public
|
|
3076
3075
|
* <p>The content type of the channel message.</p>
|
|
3076
|
+
* @public
|
|
3077
3077
|
*/
|
|
3078
3078
|
ContentType?: string;
|
|
3079
3079
|
}
|
|
@@ -3082,23 +3082,23 @@ export interface UpdateChannelMessageRequest {
|
|
|
3082
3082
|
*/
|
|
3083
3083
|
export interface UpdateChannelMessageResponse {
|
|
3084
3084
|
/**
|
|
3085
|
-
* @public
|
|
3086
3085
|
* <p>The ARN of the channel.</p>
|
|
3086
|
+
* @public
|
|
3087
3087
|
*/
|
|
3088
3088
|
ChannelArn?: string;
|
|
3089
3089
|
/**
|
|
3090
|
-
* @public
|
|
3091
3090
|
* <p>The ID string of the message being updated.</p>
|
|
3091
|
+
* @public
|
|
3092
3092
|
*/
|
|
3093
3093
|
MessageId?: string;
|
|
3094
3094
|
/**
|
|
3095
|
-
* @public
|
|
3096
3095
|
* <p>The status of the message update.</p>
|
|
3096
|
+
* @public
|
|
3097
3097
|
*/
|
|
3098
3098
|
Status?: ChannelMessageStatusStructure;
|
|
3099
3099
|
/**
|
|
3100
|
-
* @public
|
|
3101
3100
|
* <p>The ID of the SubChannel in the response.</p>
|
|
3101
|
+
* @public
|
|
3102
3102
|
*/
|
|
3103
3103
|
SubChannelId?: string;
|
|
3104
3104
|
}
|
|
@@ -3107,14 +3107,14 @@ export interface UpdateChannelMessageResponse {
|
|
|
3107
3107
|
*/
|
|
3108
3108
|
export interface UpdateChannelReadMarkerRequest {
|
|
3109
3109
|
/**
|
|
3110
|
-
* @public
|
|
3111
3110
|
* <p>The ARN of the channel.</p>
|
|
3111
|
+
* @public
|
|
3112
3112
|
*/
|
|
3113
3113
|
ChannelArn: string | undefined;
|
|
3114
3114
|
/**
|
|
3115
|
-
* @public
|
|
3116
3115
|
* <p>The ARN of the <code>AppInstanceUser</code> or <code>AppInstanceBot</code>
|
|
3117
3116
|
* that makes the API call.</p>
|
|
3117
|
+
* @public
|
|
3118
3118
|
*/
|
|
3119
3119
|
ChimeBearer: string | undefined;
|
|
3120
3120
|
}
|
|
@@ -3123,8 +3123,8 @@ export interface UpdateChannelReadMarkerRequest {
|
|
|
3123
3123
|
*/
|
|
3124
3124
|
export interface UpdateChannelReadMarkerResponse {
|
|
3125
3125
|
/**
|
|
3126
|
-
* @public
|
|
3127
3126
|
* <p>The ARN of the channel.</p>
|
|
3127
|
+
* @public
|
|
3128
3128
|
*/
|
|
3129
3129
|
ChannelArn?: string;
|
|
3130
3130
|
}
|