aws-sdk 2.962.0 → 2.966.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +19 -1
  2. package/README.md +1 -1
  3. package/apis/chime-sdk-identity-2021-04-20.examples.json +5 -0
  4. package/apis/chime-sdk-identity-2021-04-20.min.json +644 -0
  5. package/apis/chime-sdk-identity-2021-04-20.paginators.json +19 -0
  6. package/apis/chime-sdk-messaging-2021-05-15.examples.json +5 -0
  7. package/apis/chime-sdk-messaging-2021-05-15.min.json +1413 -0
  8. package/apis/chime-sdk-messaging-2021-05-15.paginators.json +39 -0
  9. package/apis/codebuild-2016-10-06.examples.json +0 -276
  10. package/apis/codebuild-2016-10-06.min.json +51 -26
  11. package/apis/connect-2017-08-08.min.json +364 -101
  12. package/apis/connect-2017-08-08.paginators.json +6 -0
  13. package/apis/lightsail-2016-11-28.min.json +154 -144
  14. package/apis/metadata.json +12 -0
  15. package/apis/nimble-2020-08-01.min.json +13 -0
  16. package/apis/rekognition-2016-06-27.min.json +51 -30
  17. package/apis/snow-device-management-2021-08-04.examples.json +5 -0
  18. package/apis/snow-device-management-2021-08-04.min.json +638 -0
  19. package/apis/snow-device-management-2021-08-04.paginators.json +28 -0
  20. package/apis/wafv2-2019-07-29.min.json +306 -98
  21. package/clients/all.d.ts +3 -0
  22. package/clients/all.js +4 -1
  23. package/clients/athena.d.ts +28 -28
  24. package/clients/chime.d.ts +17 -14
  25. package/clients/chimesdkidentity.d.ts +591 -0
  26. package/clients/chimesdkidentity.js +18 -0
  27. package/clients/chimesdkmessaging.d.ts +1344 -0
  28. package/clients/chimesdkmessaging.js +18 -0
  29. package/clients/codebuild.d.ts +166 -126
  30. package/clients/connect.d.ts +310 -9
  31. package/clients/ebs.d.ts +10 -10
  32. package/clients/ecs.d.ts +18 -18
  33. package/clients/lightsail.d.ts +19 -1
  34. package/clients/nimble.d.ts +31 -15
  35. package/clients/rekognition.d.ts +59 -26
  36. package/clients/route53.d.ts +57 -57
  37. package/clients/snowdevicemanagement.d.ts +767 -0
  38. package/clients/snowdevicemanagement.js +18 -0
  39. package/clients/ssm.d.ts +110 -110
  40. package/clients/synthetics.d.ts +25 -1
  41. package/clients/wafv2.d.ts +325 -6
  42. package/dist/aws-sdk-core-react-native.js +2 -2
  43. package/dist/aws-sdk-react-native.js +122 -11
  44. package/dist/aws-sdk.js +487 -160
  45. package/dist/aws-sdk.min.js +76 -76
  46. package/lib/config_service_placeholders.d.ts +6 -0
  47. package/lib/core.js +1 -1
  48. package/package.json +1 -1
@@ -0,0 +1,1344 @@
1
+ import {Request} from '../lib/request';
2
+ import {Response} from '../lib/response';
3
+ import {AWSError} from '../lib/error';
4
+ import {Service} from '../lib/service';
5
+ import {ServiceConfigurationOptions} from '../lib/service';
6
+ import {ConfigBase as Config} from '../lib/config-base';
7
+ interface Blob {}
8
+ declare class ChimeSDKMessaging extends Service {
9
+ /**
10
+ * Constructs a service object. This object has one method for each API operation.
11
+ */
12
+ constructor(options?: ChimeSDKMessaging.Types.ClientConfiguration)
13
+ config: Config & ChimeSDKMessaging.Types.ClientConfiguration;
14
+ /**
15
+ * Adds a specified number of users to a channel.
16
+ */
17
+ batchCreateChannelMembership(params: ChimeSDKMessaging.Types.BatchCreateChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse, AWSError>;
18
+ /**
19
+ * Adds a specified number of users to a channel.
20
+ */
21
+ batchCreateChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.BatchCreateChannelMembershipResponse, AWSError>;
22
+ /**
23
+ * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
24
+ */
25
+ createChannel(params: ChimeSDKMessaging.Types.CreateChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelResponse, AWSError>;
26
+ /**
27
+ * Creates a channel to which you can add users and send messages. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
28
+ */
29
+ createChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelResponse, AWSError>;
30
+ /**
31
+ * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
32
+ */
33
+ createChannelBan(params: ChimeSDKMessaging.Types.CreateChannelBanRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelBanResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelBanResponse, AWSError>;
34
+ /**
35
+ * Permanently bans a member from a channel. Moderators can't add banned members to a channel. To undo a ban, you first have to DeleteChannelBan, and then CreateChannelMembership. Bans are cleaned up when you delete users or channels. If you ban a user who is already part of a channel, that user is automatically kicked from the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
36
+ */
37
+ createChannelBan(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelBanResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelBanResponse, AWSError>;
38
+ /**
39
+ * Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
40
+ */
41
+ createChannelMembership(params: ChimeSDKMessaging.Types.CreateChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelMembershipResponse, AWSError>;
42
+ /**
43
+ * Adds a user to a channel. The InvitedBy response field is derived from the request header. A channel member can: List messages Send messages Receive messages Edit their own messages Leave the channel Privacy settings impact this action as follows: Public Channels: You do not need to be a member to list messages, but you must be a member to send messages. Private Channels: You must be a member to list or send messages. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
44
+ */
45
+ createChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelMembershipResponse, AWSError>;
46
+ /**
47
+ * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
48
+ */
49
+ createChannelModerator(params: ChimeSDKMessaging.Types.CreateChannelModeratorRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelModeratorResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelModeratorResponse, AWSError>;
50
+ /**
51
+ * Creates a new ChannelModerator. A channel moderator can: Add and remove other members of the channel. Add and remove other moderators of the channel. Add and remove user bans for the channel. Redact messages in the channel. List messages in the channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
52
+ */
53
+ createChannelModerator(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.CreateChannelModeratorResponse) => void): Request<ChimeSDKMessaging.Types.CreateChannelModeratorResponse, AWSError>;
54
+ /**
55
+ * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
56
+ */
57
+ deleteChannel(params: ChimeSDKMessaging.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
58
+ /**
59
+ * Immediately makes a channel and its memberships inaccessible and marks them for deletion. This is an irreversible process. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
60
+ */
61
+ deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
62
+ /**
63
+ * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
64
+ */
65
+ deleteChannelBan(params: ChimeSDKMessaging.Types.DeleteChannelBanRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
66
+ /**
67
+ * Removes a user from a channel's ban list. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
68
+ */
69
+ deleteChannelBan(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
70
+ /**
71
+ * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
72
+ */
73
+ deleteChannelMembership(params: ChimeSDKMessaging.Types.DeleteChannelMembershipRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
74
+ /**
75
+ * Removes a member from a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
76
+ */
77
+ deleteChannelMembership(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
78
+ /**
79
+ * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
80
+ */
81
+ deleteChannelMessage(params: ChimeSDKMessaging.Types.DeleteChannelMessageRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
82
+ /**
83
+ * Deletes a channel message. Only admins can perform this action. Deletion makes messages inaccessible immediately. A background process deletes any revisions created by UpdateChannelMessage. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
84
+ */
85
+ deleteChannelMessage(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
86
+ /**
87
+ * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
88
+ */
89
+ deleteChannelModerator(params: ChimeSDKMessaging.Types.DeleteChannelModeratorRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
90
+ /**
91
+ * Deletes a channel moderator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
92
+ */
93
+ deleteChannelModerator(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
94
+ /**
95
+ * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
96
+ */
97
+ describeChannel(params: ChimeSDKMessaging.Types.DescribeChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelResponse, AWSError>;
98
+ /**
99
+ * Returns the full details of a channel in an Amazon Chime AppInstance. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
100
+ */
101
+ describeChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelResponse, AWSError>;
102
+ /**
103
+ * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
104
+ */
105
+ describeChannelBan(params: ChimeSDKMessaging.Types.DescribeChannelBanRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelBanResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelBanResponse, AWSError>;
106
+ /**
107
+ * Returns the full details of a channel ban. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
108
+ */
109
+ describeChannelBan(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelBanResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelBanResponse, AWSError>;
110
+ /**
111
+ * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
112
+ */
113
+ describeChannelMembership(params: ChimeSDKMessaging.Types.DescribeChannelMembershipRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelMembershipResponse, AWSError>;
114
+ /**
115
+ * Returns the full details of a user's channel membership. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
116
+ */
117
+ describeChannelMembership(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelMembershipResponse, AWSError>;
118
+ /**
119
+ * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
120
+ */
121
+ describeChannelMembershipForAppInstanceUser(params: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse, AWSError>;
122
+ /**
123
+ * Returns the details of a channel based on the membership of the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
124
+ */
125
+ describeChannelMembershipForAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelMembershipForAppInstanceUserResponse, AWSError>;
126
+ /**
127
+ * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
128
+ */
129
+ describeChannelModeratedByAppInstanceUser(params: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse, AWSError>;
130
+ /**
131
+ * Returns the full details of a channel moderated by the specified AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
132
+ */
133
+ describeChannelModeratedByAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelModeratedByAppInstanceUserResponse, AWSError>;
134
+ /**
135
+ * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
136
+ */
137
+ describeChannelModerator(params: ChimeSDKMessaging.Types.DescribeChannelModeratorRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratorResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelModeratorResponse, AWSError>;
138
+ /**
139
+ * Returns the full details of a single ChannelModerator. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
140
+ */
141
+ describeChannelModerator(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.DescribeChannelModeratorResponse) => void): Request<ChimeSDKMessaging.Types.DescribeChannelModeratorResponse, AWSError>;
142
+ /**
143
+ * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
144
+ */
145
+ getChannelMessage(params: ChimeSDKMessaging.Types.GetChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.GetChannelMessageResponse, AWSError>;
146
+ /**
147
+ * Gets the full details of a channel message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
148
+ */
149
+ getChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.GetChannelMessageResponse, AWSError>;
150
+ /**
151
+ * The details of the endpoint for the messaging session.
152
+ */
153
+ getMessagingSessionEndpoint(params: ChimeSDKMessaging.Types.GetMessagingSessionEndpointRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse) => void): Request<ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse, AWSError>;
154
+ /**
155
+ * The details of the endpoint for the messaging session.
156
+ */
157
+ getMessagingSessionEndpoint(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse) => void): Request<ChimeSDKMessaging.Types.GetMessagingSessionEndpointResponse, AWSError>;
158
+ /**
159
+ * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
160
+ */
161
+ listChannelBans(params: ChimeSDKMessaging.Types.ListChannelBansRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelBansResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelBansResponse, AWSError>;
162
+ /**
163
+ * Lists all the users banned from a particular channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
164
+ */
165
+ listChannelBans(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelBansResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelBansResponse, AWSError>;
166
+ /**
167
+ * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
168
+ */
169
+ listChannelMemberships(params: ChimeSDKMessaging.Types.ListChannelMembershipsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMembershipsResponse, AWSError>;
170
+ /**
171
+ * Lists all channel memberships in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
172
+ */
173
+ listChannelMemberships(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMembershipsResponse, AWSError>;
174
+ /**
175
+ * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
176
+ */
177
+ listChannelMembershipsForAppInstanceUser(params: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse, AWSError>;
178
+ /**
179
+ * Lists all channels that a particular AppInstanceUser is a part of. Only an AppInstanceAdmin can call the API with a user ARN that is not their own. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
180
+ */
181
+ listChannelMembershipsForAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMembershipsForAppInstanceUserResponse, AWSError>;
182
+ /**
183
+ * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
184
+ */
185
+ listChannelMessages(params: ChimeSDKMessaging.Types.ListChannelMessagesRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMessagesResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMessagesResponse, AWSError>;
186
+ /**
187
+ * List all the messages in a channel. Returns a paginated list of ChannelMessages. By default, sorted by creation timestamp in descending order. Redacted messages appear in the results as empty, since they are only redacted, not deleted. Deleted messages do not appear in the results. This action always returns the latest version of an edited message. Also, the x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
188
+ */
189
+ listChannelMessages(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelMessagesResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelMessagesResponse, AWSError>;
190
+ /**
191
+ * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
192
+ */
193
+ listChannelModerators(params: ChimeSDKMessaging.Types.ListChannelModeratorsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelModeratorsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelModeratorsResponse, AWSError>;
194
+ /**
195
+ * Lists all the moderators for a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
196
+ */
197
+ listChannelModerators(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelModeratorsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelModeratorsResponse, AWSError>;
198
+ /**
199
+ * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality &amp; restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
200
+ */
201
+ listChannels(params: ChimeSDKMessaging.Types.ListChannelsRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelsResponse, AWSError>;
202
+ /**
203
+ * Lists all Channels created under a single Chime App as a paginated list. You can specify filters to narrow results. Functionality &amp; restrictions Use privacy = PUBLIC to retrieve all public channels in the account. Only an AppInstanceAdmin can set privacy = PRIVATE to list the private channels in an account. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
204
+ */
205
+ listChannels(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelsResponse, AWSError>;
206
+ /**
207
+ * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
208
+ */
209
+ listChannelsModeratedByAppInstanceUser(params: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse, AWSError>;
210
+ /**
211
+ * A list of the channels moderated by an AppInstanceUser. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
212
+ */
213
+ listChannelsModeratedByAppInstanceUser(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse) => void): Request<ChimeSDKMessaging.Types.ListChannelsModeratedByAppInstanceUserResponse, AWSError>;
214
+ /**
215
+ * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
216
+ */
217
+ redactChannelMessage(params: ChimeSDKMessaging.Types.RedactChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.RedactChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.RedactChannelMessageResponse, AWSError>;
218
+ /**
219
+ * Redacts message content, but not metadata. The message exists in the back end, but the action returns null content, and the state shows as redacted. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
220
+ */
221
+ redactChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.RedactChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.RedactChannelMessageResponse, AWSError>;
222
+ /**
223
+ * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
224
+ */
225
+ sendChannelMessage(params: ChimeSDKMessaging.Types.SendChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.SendChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.SendChannelMessageResponse, AWSError>;
226
+ /**
227
+ * Sends a message to a particular channel that the member is a part of. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header. Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.
228
+ */
229
+ sendChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.SendChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.SendChannelMessageResponse, AWSError>;
230
+ /**
231
+ * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
232
+ */
233
+ updateChannel(params: ChimeSDKMessaging.Types.UpdateChannelRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelResponse, AWSError>;
234
+ /**
235
+ * Update a channel's attributes. Restriction: You can't change a channel's privacy. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
236
+ */
237
+ updateChannel(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelResponse, AWSError>;
238
+ /**
239
+ * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
240
+ */
241
+ updateChannelMessage(params: ChimeSDKMessaging.Types.UpdateChannelMessageRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelMessageResponse, AWSError>;
242
+ /**
243
+ * Updates the content of a message. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
244
+ */
245
+ updateChannelMessage(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelMessageResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelMessageResponse, AWSError>;
246
+ /**
247
+ * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
248
+ */
249
+ updateChannelReadMarker(params: ChimeSDKMessaging.Types.UpdateChannelReadMarkerRequest, callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse, AWSError>;
250
+ /**
251
+ * The details of the time when a user last read messages in a channel. The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.
252
+ */
253
+ updateChannelReadMarker(callback?: (err: AWSError, data: ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse) => void): Request<ChimeSDKMessaging.Types.UpdateChannelReadMarkerResponse, AWSError>;
254
+ }
255
+ declare namespace ChimeSDKMessaging {
256
+ export interface AppInstanceUserMembershipSummary {
257
+ /**
258
+ * The type of ChannelMembership.
259
+ */
260
+ Type?: ChannelMembershipType;
261
+ /**
262
+ * The time at which a message was last read.
263
+ */
264
+ ReadMarkerTimestamp?: Timestamp;
265
+ }
266
+ export interface BatchChannelMemberships {
267
+ /**
268
+ * The identifier of the member who invited another member.
269
+ */
270
+ InvitedBy?: Identity;
271
+ /**
272
+ * The membership types set for the channel users.
273
+ */
274
+ Type?: ChannelMembershipType;
275
+ /**
276
+ * The users successfully added to the request.
277
+ */
278
+ Members?: Members;
279
+ /**
280
+ * The ARN of the channel to which you're adding users.
281
+ */
282
+ ChannelArn?: ChimeArn;
283
+ }
284
+ export interface BatchCreateChannelMembershipError {
285
+ /**
286
+ * The ARN of the member that the service couldn't add.
287
+ */
288
+ MemberArn?: ChimeArn;
289
+ /**
290
+ * The error code.
291
+ */
292
+ ErrorCode?: ErrorCode;
293
+ /**
294
+ * The error message.
295
+ */
296
+ ErrorMessage?: String;
297
+ }
298
+ export type BatchCreateChannelMembershipErrors = BatchCreateChannelMembershipError[];
299
+ export interface BatchCreateChannelMembershipRequest {
300
+ /**
301
+ * The ARN of the channel to which you're adding users.
302
+ */
303
+ ChannelArn: ChimeArn;
304
+ /**
305
+ * The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
306
+ */
307
+ Type?: ChannelMembershipType;
308
+ /**
309
+ * The ARNs of the members you want to add to the channel.
310
+ */
311
+ MemberArns: MemberArns;
312
+ /**
313
+ * The AppInstanceUserArn of the user that makes the API call.
314
+ */
315
+ ChimeBearer: ChimeArn;
316
+ }
317
+ export interface BatchCreateChannelMembershipResponse {
318
+ /**
319
+ * The list of channel memberships in the response.
320
+ */
321
+ BatchChannelMemberships?: BatchChannelMemberships;
322
+ /**
323
+ * If the action fails for one or more of the memberships in the request, a list of the memberships is returned, along with error codes and error messages.
324
+ */
325
+ Errors?: BatchCreateChannelMembershipErrors;
326
+ }
327
+ export interface Channel {
328
+ /**
329
+ * The name of a channel.
330
+ */
331
+ Name?: NonEmptyResourceName;
332
+ /**
333
+ * The ARN of a channel.
334
+ */
335
+ ChannelArn?: ChimeArn;
336
+ /**
337
+ * The mode of the channel.
338
+ */
339
+ Mode?: ChannelMode;
340
+ /**
341
+ * The channel's privacy setting.
342
+ */
343
+ Privacy?: ChannelPrivacy;
344
+ /**
345
+ * The channel's metadata.
346
+ */
347
+ Metadata?: Metadata;
348
+ /**
349
+ * The AppInstanceUser who created the channel.
350
+ */
351
+ CreatedBy?: Identity;
352
+ /**
353
+ * The time at which the AppInstanceUser created the channel.
354
+ */
355
+ CreatedTimestamp?: Timestamp;
356
+ /**
357
+ * The time at which a member sent the last message in the channel.
358
+ */
359
+ LastMessageTimestamp?: Timestamp;
360
+ /**
361
+ * The time at which a channel was last updated.
362
+ */
363
+ LastUpdatedTimestamp?: Timestamp;
364
+ }
365
+ export interface ChannelBan {
366
+ /**
367
+ * The member being banned from the channel.
368
+ */
369
+ Member?: Identity;
370
+ /**
371
+ * The ARN of the channel from which a member is being banned.
372
+ */
373
+ ChannelArn?: ChimeArn;
374
+ /**
375
+ * The time at which the ban was created.
376
+ */
377
+ CreatedTimestamp?: Timestamp;
378
+ /**
379
+ * The AppInstanceUser who created the ban.
380
+ */
381
+ CreatedBy?: Identity;
382
+ }
383
+ export interface ChannelBanSummary {
384
+ /**
385
+ * The member being banned from a channel.
386
+ */
387
+ Member?: Identity;
388
+ }
389
+ export type ChannelBanSummaryList = ChannelBanSummary[];
390
+ export interface ChannelMembership {
391
+ /**
392
+ * The identifier of the member who invited another member.
393
+ */
394
+ InvitedBy?: Identity;
395
+ /**
396
+ * The membership type set for the channel member.
397
+ */
398
+ Type?: ChannelMembershipType;
399
+ /**
400
+ * The data of the channel member.
401
+ */
402
+ Member?: Identity;
403
+ /**
404
+ * The ARN of the member's channel.
405
+ */
406
+ ChannelArn?: ChimeArn;
407
+ /**
408
+ * The time at which the channel membership was created.
409
+ */
410
+ CreatedTimestamp?: Timestamp;
411
+ /**
412
+ * The time at which a channel membership was last updated.
413
+ */
414
+ LastUpdatedTimestamp?: Timestamp;
415
+ }
416
+ export interface ChannelMembershipForAppInstanceUserSummary {
417
+ /**
418
+ * Returns the channel data for an AppInstance.
419
+ */
420
+ ChannelSummary?: ChannelSummary;
421
+ /**
422
+ * Returns the channel membership data for an AppInstance.
423
+ */
424
+ AppInstanceUserMembershipSummary?: AppInstanceUserMembershipSummary;
425
+ }
426
+ export type ChannelMembershipForAppInstanceUserSummaryList = ChannelMembershipForAppInstanceUserSummary[];
427
+ export interface ChannelMembershipSummary {
428
+ /**
429
+ * A member's summary data.
430
+ */
431
+ Member?: Identity;
432
+ }
433
+ export type ChannelMembershipSummaryList = ChannelMembershipSummary[];
434
+ export type ChannelMembershipType = "DEFAULT"|"HIDDEN"|string;
435
+ export interface ChannelMessage {
436
+ /**
437
+ * The ARN of the channel.
438
+ */
439
+ ChannelArn?: ChimeArn;
440
+ /**
441
+ * The ID of a message.
442
+ */
443
+ MessageId?: MessageId;
444
+ /**
445
+ * The message content.
446
+ */
447
+ Content?: Content;
448
+ /**
449
+ * The message metadata.
450
+ */
451
+ Metadata?: Metadata;
452
+ /**
453
+ * The message type.
454
+ */
455
+ Type?: ChannelMessageType;
456
+ /**
457
+ * The time at which the message was created.
458
+ */
459
+ CreatedTimestamp?: Timestamp;
460
+ /**
461
+ * The time at which a message was edited.
462
+ */
463
+ LastEditedTimestamp?: Timestamp;
464
+ /**
465
+ * The time at which a message was updated.
466
+ */
467
+ LastUpdatedTimestamp?: Timestamp;
468
+ /**
469
+ * The message sender.
470
+ */
471
+ Sender?: Identity;
472
+ /**
473
+ * Hides the content of a message.
474
+ */
475
+ Redacted?: NonNullableBoolean;
476
+ /**
477
+ * The persistence setting for a channel message.
478
+ */
479
+ Persistence?: ChannelMessagePersistenceType;
480
+ }
481
+ export type ChannelMessagePersistenceType = "PERSISTENT"|"NON_PERSISTENT"|string;
482
+ export interface ChannelMessageSummary {
483
+ /**
484
+ * The ID of the message.
485
+ */
486
+ MessageId?: MessageId;
487
+ /**
488
+ * The content of the message.
489
+ */
490
+ Content?: Content;
491
+ /**
492
+ * The metadata of the message.
493
+ */
494
+ Metadata?: Metadata;
495
+ /**
496
+ * The type of message.
497
+ */
498
+ Type?: ChannelMessageType;
499
+ /**
500
+ * The time at which the message summary was created.
501
+ */
502
+ CreatedTimestamp?: Timestamp;
503
+ /**
504
+ * The time at which a message was last updated.
505
+ */
506
+ LastUpdatedTimestamp?: Timestamp;
507
+ /**
508
+ * The time at which a message was last edited.
509
+ */
510
+ LastEditedTimestamp?: Timestamp;
511
+ /**
512
+ * The message sender.
513
+ */
514
+ Sender?: Identity;
515
+ /**
516
+ * Indicates whether a message was redacted.
517
+ */
518
+ Redacted?: NonNullableBoolean;
519
+ }
520
+ export type ChannelMessageSummaryList = ChannelMessageSummary[];
521
+ export type ChannelMessageType = "STANDARD"|"CONTROL"|string;
522
+ export type ChannelMode = "UNRESTRICTED"|"RESTRICTED"|string;
523
+ export interface ChannelModeratedByAppInstanceUserSummary {
524
+ /**
525
+ * Summary of the details of a Channel.
526
+ */
527
+ ChannelSummary?: ChannelSummary;
528
+ }
529
+ export type ChannelModeratedByAppInstanceUserSummaryList = ChannelModeratedByAppInstanceUserSummary[];
530
+ export interface ChannelModerator {
531
+ /**
532
+ * The moderator's data.
533
+ */
534
+ Moderator?: Identity;
535
+ /**
536
+ * The ARN of the moderator's channel.
537
+ */
538
+ ChannelArn?: ChimeArn;
539
+ /**
540
+ * The time at which the moderator was created.
541
+ */
542
+ CreatedTimestamp?: Timestamp;
543
+ /**
544
+ * The AppInstanceUser who created the moderator.
545
+ */
546
+ CreatedBy?: Identity;
547
+ }
548
+ export interface ChannelModeratorSummary {
549
+ /**
550
+ * The data for a moderator.
551
+ */
552
+ Moderator?: Identity;
553
+ }
554
+ export type ChannelModeratorSummaryList = ChannelModeratorSummary[];
555
+ export type ChannelPrivacy = "PUBLIC"|"PRIVATE"|string;
556
+ export interface ChannelSummary {
557
+ /**
558
+ * The name of the channel.
559
+ */
560
+ Name?: NonEmptyResourceName;
561
+ /**
562
+ * The ARN of the channel.
563
+ */
564
+ ChannelArn?: ChimeArn;
565
+ /**
566
+ * The mode of the channel.
567
+ */
568
+ Mode?: ChannelMode;
569
+ /**
570
+ * The privacy setting of the channel.
571
+ */
572
+ Privacy?: ChannelPrivacy;
573
+ /**
574
+ * The metadata of the channel.
575
+ */
576
+ Metadata?: Metadata;
577
+ /**
578
+ * The time at which the last message in a channel was sent.
579
+ */
580
+ LastMessageTimestamp?: Timestamp;
581
+ }
582
+ export type ChannelSummaryList = ChannelSummary[];
583
+ export type ChimeArn = string;
584
+ export type ClientRequestToken = string;
585
+ export type Content = string;
586
+ export interface CreateChannelBanRequest {
587
+ /**
588
+ * The ARN of the ban request.
589
+ */
590
+ ChannelArn: ChimeArn;
591
+ /**
592
+ * The ARN of the member being banned.
593
+ */
594
+ MemberArn: ChimeArn;
595
+ /**
596
+ * The AppInstanceUserArn of the user that makes the API call.
597
+ */
598
+ ChimeBearer: ChimeArn;
599
+ }
600
+ export interface CreateChannelBanResponse {
601
+ /**
602
+ * The ARN of the response to the ban request.
603
+ */
604
+ ChannelArn?: ChimeArn;
605
+ /**
606
+ * The ChannelArn and BannedIdentity of the member in the ban response.
607
+ */
608
+ Member?: Identity;
609
+ }
610
+ export interface CreateChannelMembershipRequest {
611
+ /**
612
+ * The ARN of the channel to which you're adding users.
613
+ */
614
+ ChannelArn: ChimeArn;
615
+ /**
616
+ * The ARN of the member you want to add to the channel.
617
+ */
618
+ MemberArn: ChimeArn;
619
+ /**
620
+ * The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned. This is only supported by moderators.
621
+ */
622
+ Type: ChannelMembershipType;
623
+ /**
624
+ * The AppInstanceUserArn of the user that makes the API call.
625
+ */
626
+ ChimeBearer: ChimeArn;
627
+ }
628
+ export interface CreateChannelMembershipResponse {
629
+ /**
630
+ * The ARN of the channel.
631
+ */
632
+ ChannelArn?: ChimeArn;
633
+ /**
634
+ * The ARN and metadata of the member being added.
635
+ */
636
+ Member?: Identity;
637
+ }
638
+ export interface CreateChannelModeratorRequest {
639
+ /**
640
+ * The ARN of the channel.
641
+ */
642
+ ChannelArn: ChimeArn;
643
+ /**
644
+ * The ARN of the moderator.
645
+ */
646
+ ChannelModeratorArn: ChimeArn;
647
+ /**
648
+ * The AppInstanceUserArn of the user that makes the API call.
649
+ */
650
+ ChimeBearer: ChimeArn;
651
+ }
652
+ export interface CreateChannelModeratorResponse {
653
+ /**
654
+ * The ARN of the channel.
655
+ */
656
+ ChannelArn?: ChimeArn;
657
+ /**
658
+ * The ARNs of the channel and the moderator.
659
+ */
660
+ ChannelModerator?: Identity;
661
+ }
662
+ export interface CreateChannelRequest {
663
+ /**
664
+ * The ARN of the channel request.
665
+ */
666
+ AppInstanceArn: ChimeArn;
667
+ /**
668
+ * The name of the channel.
669
+ */
670
+ Name: NonEmptyResourceName;
671
+ /**
672
+ * The channel mode: UNRESTRICTED or RESTRICTED. Administrators, moderators, and channel members can add themselves and other members to unrestricted channels. Only administrators and moderators can add members to restricted channels.
673
+ */
674
+ Mode?: ChannelMode;
675
+ /**
676
+ * The channel's privacy level: PUBLIC or PRIVATE. Private channels aren't discoverable by users outside the channel. Public channels are discoverable by anyone in the AppInstance.
677
+ */
678
+ Privacy?: ChannelPrivacy;
679
+ /**
680
+ * The metadata of the creation request. Limited to 1KB and UTF-8.
681
+ */
682
+ Metadata?: Metadata;
683
+ /**
684
+ * The client token for the request. An Idempotency token.
685
+ */
686
+ ClientRequestToken: ClientRequestToken;
687
+ /**
688
+ * The tags for the creation request.
689
+ */
690
+ Tags?: TagList;
691
+ /**
692
+ * The AppInstanceUserArn of the user that makes the API call.
693
+ */
694
+ ChimeBearer: ChimeArn;
695
+ }
696
+ export interface CreateChannelResponse {
697
+ /**
698
+ * The ARN of the channel.
699
+ */
700
+ ChannelArn?: ChimeArn;
701
+ }
702
+ export interface DeleteChannelBanRequest {
703
+ /**
704
+ * The ARN of the channel from which the AppInstanceUser was banned.
705
+ */
706
+ ChannelArn: ChimeArn;
707
+ /**
708
+ * The ARN of the AppInstanceUser that you want to reinstate.
709
+ */
710
+ MemberArn: ChimeArn;
711
+ /**
712
+ * The AppInstanceUserArn of the user that makes the API call.
713
+ */
714
+ ChimeBearer: ChimeArn;
715
+ }
716
+ export interface DeleteChannelMembershipRequest {
717
+ /**
718
+ * The ARN of the channel from which you want to remove the user.
719
+ */
720
+ ChannelArn: ChimeArn;
721
+ /**
722
+ * The ARN of the member that you're removing from the channel.
723
+ */
724
+ MemberArn: ChimeArn;
725
+ /**
726
+ * The AppInstanceUserArn of the user that makes the API call.
727
+ */
728
+ ChimeBearer: ChimeArn;
729
+ }
730
+ export interface DeleteChannelMessageRequest {
731
+ /**
732
+ * The ARN of the channel.
733
+ */
734
+ ChannelArn: ChimeArn;
735
+ /**
736
+ * The ID of the message being deleted.
737
+ */
738
+ MessageId: MessageId;
739
+ /**
740
+ * The AppInstanceUserArn of the user that makes the API call.
741
+ */
742
+ ChimeBearer: ChimeArn;
743
+ }
744
+ export interface DeleteChannelModeratorRequest {
745
+ /**
746
+ * The ARN of the channel.
747
+ */
748
+ ChannelArn: ChimeArn;
749
+ /**
750
+ * The ARN of the moderator being deleted.
751
+ */
752
+ ChannelModeratorArn: ChimeArn;
753
+ /**
754
+ * The AppInstanceUserArn of the user that makes the API call.
755
+ */
756
+ ChimeBearer: ChimeArn;
757
+ }
758
+ export interface DeleteChannelRequest {
759
+ /**
760
+ * The ARN of the channel being deleted.
761
+ */
762
+ ChannelArn: ChimeArn;
763
+ /**
764
+ * The AppInstanceUserArn of the user that makes the API call.
765
+ */
766
+ ChimeBearer: ChimeArn;
767
+ }
768
+ export interface DescribeChannelBanRequest {
769
+ /**
770
+ * The ARN of the channel from which the user is banned.
771
+ */
772
+ ChannelArn: ChimeArn;
773
+ /**
774
+ * The ARN of the member being banned.
775
+ */
776
+ MemberArn: ChimeArn;
777
+ /**
778
+ * The AppInstanceUserArn of the user that makes the API call.
779
+ */
780
+ ChimeBearer: ChimeArn;
781
+ }
782
+ export interface DescribeChannelBanResponse {
783
+ /**
784
+ * The details of the ban.
785
+ */
786
+ ChannelBan?: ChannelBan;
787
+ }
788
+ export interface DescribeChannelMembershipForAppInstanceUserRequest {
789
+ /**
790
+ * The ARN of the channel to which the user belongs.
791
+ */
792
+ ChannelArn: ChimeArn;
793
+ /**
794
+ * The ARN of the user in a channel.
795
+ */
796
+ AppInstanceUserArn: ChimeArn;
797
+ /**
798
+ * The AppInstanceUserArn of the user that makes the API call.
799
+ */
800
+ ChimeBearer: ChimeArn;
801
+ }
802
+ export interface DescribeChannelMembershipForAppInstanceUserResponse {
803
+ /**
804
+ * The channel to which a user belongs.
805
+ */
806
+ ChannelMembership?: ChannelMembershipForAppInstanceUserSummary;
807
+ }
808
+ export interface DescribeChannelMembershipRequest {
809
+ /**
810
+ * The ARN of the channel.
811
+ */
812
+ ChannelArn: ChimeArn;
813
+ /**
814
+ * The ARN of the member.
815
+ */
816
+ MemberArn: ChimeArn;
817
+ /**
818
+ * The AppInstanceUserArn of the user that makes the API call.
819
+ */
820
+ ChimeBearer: ChimeArn;
821
+ }
822
+ export interface DescribeChannelMembershipResponse {
823
+ /**
824
+ * The details of the membership.
825
+ */
826
+ ChannelMembership?: ChannelMembership;
827
+ }
828
+ export interface DescribeChannelModeratedByAppInstanceUserRequest {
829
+ /**
830
+ * The ARN of the moderated channel.
831
+ */
832
+ ChannelArn: ChimeArn;
833
+ /**
834
+ * The ARN of the AppInstanceUser in the moderated channel.
835
+ */
836
+ AppInstanceUserArn: ChimeArn;
837
+ /**
838
+ * The AppInstanceUserArn of the user that makes the API call.
839
+ */
840
+ ChimeBearer: ChimeArn;
841
+ }
842
+ export interface DescribeChannelModeratedByAppInstanceUserResponse {
843
+ /**
844
+ * The moderated channel.
845
+ */
846
+ Channel?: ChannelModeratedByAppInstanceUserSummary;
847
+ }
848
+ export interface DescribeChannelModeratorRequest {
849
+ /**
850
+ * The ARN of the channel.
851
+ */
852
+ ChannelArn: ChimeArn;
853
+ /**
854
+ * The ARN of the channel moderator.
855
+ */
856
+ ChannelModeratorArn: ChimeArn;
857
+ /**
858
+ * The AppInstanceUserArn of the user that makes the API call.
859
+ */
860
+ ChimeBearer: ChimeArn;
861
+ }
862
+ export interface DescribeChannelModeratorResponse {
863
+ /**
864
+ * The details of the channel moderator.
865
+ */
866
+ ChannelModerator?: ChannelModerator;
867
+ }
868
+ export interface DescribeChannelRequest {
869
+ /**
870
+ * The ARN of the channel.
871
+ */
872
+ ChannelArn: ChimeArn;
873
+ /**
874
+ * The AppInstanceUserArn of the user that makes the API call.
875
+ */
876
+ ChimeBearer: ChimeArn;
877
+ }
878
+ export interface DescribeChannelResponse {
879
+ /**
880
+ * The channel details.
881
+ */
882
+ Channel?: Channel;
883
+ }
884
+ export type ErrorCode = "BadRequest"|"Conflict"|"Forbidden"|"NotFound"|"PreconditionFailed"|"ResourceLimitExceeded"|"ServiceFailure"|"AccessDenied"|"ServiceUnavailable"|"Throttled"|"Throttling"|"Unauthorized"|"Unprocessable"|"VoiceConnectorGroupAssociationsExist"|"PhoneNumberAssociationsExist"|string;
885
+ export interface GetChannelMessageRequest {
886
+ /**
887
+ * The ARN of the channel.
888
+ */
889
+ ChannelArn: ChimeArn;
890
+ /**
891
+ * The ID of the message.
892
+ */
893
+ MessageId: MessageId;
894
+ /**
895
+ * The AppInstanceUserArn of the user that makes the API call.
896
+ */
897
+ ChimeBearer: ChimeArn;
898
+ }
899
+ export interface GetChannelMessageResponse {
900
+ /**
901
+ * The details of and content in the message.
902
+ */
903
+ ChannelMessage?: ChannelMessage;
904
+ }
905
+ export interface GetMessagingSessionEndpointRequest {
906
+ }
907
+ export interface GetMessagingSessionEndpointResponse {
908
+ /**
909
+ * The endpoint returned in the response.
910
+ */
911
+ Endpoint?: MessagingSessionEndpoint;
912
+ }
913
+ export interface Identity {
914
+ /**
915
+ * The ARN in an Identity.
916
+ */
917
+ Arn?: ChimeArn;
918
+ /**
919
+ * The name in an Identity.
920
+ */
921
+ Name?: ResourceName;
922
+ }
923
+ export interface ListChannelBansRequest {
924
+ /**
925
+ * The ARN of the channel.
926
+ */
927
+ ChannelArn: ChimeArn;
928
+ /**
929
+ * The maximum number of bans that you want returned.
930
+ */
931
+ MaxResults?: MaxResults;
932
+ /**
933
+ * The token passed by previous API calls until all requested bans are returned.
934
+ */
935
+ NextToken?: NextToken;
936
+ /**
937
+ * The AppInstanceUserArn of the user that makes the API call.
938
+ */
939
+ ChimeBearer: ChimeArn;
940
+ }
941
+ export interface ListChannelBansResponse {
942
+ /**
943
+ * The ARN of the channel.
944
+ */
945
+ ChannelArn?: ChimeArn;
946
+ /**
947
+ * The token passed by previous API calls until all requested bans are returned.
948
+ */
949
+ NextToken?: NextToken;
950
+ /**
951
+ * The information for each requested ban.
952
+ */
953
+ ChannelBans?: ChannelBanSummaryList;
954
+ }
955
+ export interface ListChannelMembershipsForAppInstanceUserRequest {
956
+ /**
957
+ * The ARN of the AppInstanceUsers
958
+ */
959
+ AppInstanceUserArn?: ChimeArn;
960
+ /**
961
+ * The maximum number of users that you want returned.
962
+ */
963
+ MaxResults?: MaxResults;
964
+ /**
965
+ * The token returned from previous API requests until the number of channel memberships is reached.
966
+ */
967
+ NextToken?: NextToken;
968
+ /**
969
+ * The AppInstanceUserArn of the user that makes the API call.
970
+ */
971
+ ChimeBearer: ChimeArn;
972
+ }
973
+ export interface ListChannelMembershipsForAppInstanceUserResponse {
974
+ /**
975
+ * The token passed by previous API calls until all requested users are returned.
976
+ */
977
+ ChannelMemberships?: ChannelMembershipForAppInstanceUserSummaryList;
978
+ /**
979
+ * The token passed by previous API calls until all requested users are returned.
980
+ */
981
+ NextToken?: NextToken;
982
+ }
983
+ export interface ListChannelMembershipsRequest {
984
+ /**
985
+ * The maximum number of channel memberships that you want returned.
986
+ */
987
+ ChannelArn: ChimeArn;
988
+ /**
989
+ * The membership type of a user, DEFAULT or HIDDEN. Default members are always returned as part of ListChannelMemberships. Hidden members are only returned if the type filter in ListChannelMemberships equals HIDDEN. Otherwise hidden members are not returned.
990
+ */
991
+ Type?: ChannelMembershipType;
992
+ /**
993
+ * The maximum number of channel memberships that you want returned.
994
+ */
995
+ MaxResults?: MaxResults;
996
+ /**
997
+ * The token passed by previous API calls until all requested channel memberships are returned.
998
+ */
999
+ NextToken?: NextToken;
1000
+ /**
1001
+ * The AppInstanceUserArn of the user that makes the API call.
1002
+ */
1003
+ ChimeBearer: ChimeArn;
1004
+ }
1005
+ export interface ListChannelMembershipsResponse {
1006
+ /**
1007
+ * The ARN of the channel.
1008
+ */
1009
+ ChannelArn?: ChimeArn;
1010
+ /**
1011
+ * The information for the requested channel memberships.
1012
+ */
1013
+ ChannelMemberships?: ChannelMembershipSummaryList;
1014
+ /**
1015
+ * The token passed by previous API calls until all requested channel memberships are returned.
1016
+ */
1017
+ NextToken?: NextToken;
1018
+ }
1019
+ export interface ListChannelMessagesRequest {
1020
+ /**
1021
+ * The ARN of the channel.
1022
+ */
1023
+ ChannelArn: ChimeArn;
1024
+ /**
1025
+ * The order in which you want messages sorted. Default is Descending, based on time created.
1026
+ */
1027
+ SortOrder?: SortOrder;
1028
+ /**
1029
+ * The initial or starting time stamp for your requested messages.
1030
+ */
1031
+ NotBefore?: Timestamp;
1032
+ /**
1033
+ * The final or ending time stamp for your requested messages.
1034
+ */
1035
+ NotAfter?: Timestamp;
1036
+ /**
1037
+ * The maximum number of messages that you want returned.
1038
+ */
1039
+ MaxResults?: MaxResults;
1040
+ /**
1041
+ * The token passed by previous API calls until all requested messages are returned.
1042
+ */
1043
+ NextToken?: NextToken;
1044
+ /**
1045
+ * The AppInstanceUserArn of the user that makes the API call.
1046
+ */
1047
+ ChimeBearer: ChimeArn;
1048
+ }
1049
+ export interface ListChannelMessagesResponse {
1050
+ /**
1051
+ * The ARN of the channel containing the requested messages.
1052
+ */
1053
+ ChannelArn?: ChimeArn;
1054
+ /**
1055
+ * The token passed by previous API calls until all requested messages are returned.
1056
+ */
1057
+ NextToken?: NextToken;
1058
+ /**
1059
+ * The information about, and content of, each requested message.
1060
+ */
1061
+ ChannelMessages?: ChannelMessageSummaryList;
1062
+ }
1063
+ export interface ListChannelModeratorsRequest {
1064
+ /**
1065
+ * The ARN of the channel.
1066
+ */
1067
+ ChannelArn: ChimeArn;
1068
+ /**
1069
+ * The maximum number of moderators that you want returned.
1070
+ */
1071
+ MaxResults?: MaxResults;
1072
+ /**
1073
+ * The token passed by previous API calls until all requested moderators are returned.
1074
+ */
1075
+ NextToken?: NextToken;
1076
+ /**
1077
+ * The AppInstanceUserArn of the user that makes the API call.
1078
+ */
1079
+ ChimeBearer: ChimeArn;
1080
+ }
1081
+ export interface ListChannelModeratorsResponse {
1082
+ /**
1083
+ * The ARN of the channel.
1084
+ */
1085
+ ChannelArn?: ChimeArn;
1086
+ /**
1087
+ * The token passed by previous API calls until all requested moderators are returned.
1088
+ */
1089
+ NextToken?: NextToken;
1090
+ /**
1091
+ * The information about and names of each moderator.
1092
+ */
1093
+ ChannelModerators?: ChannelModeratorSummaryList;
1094
+ }
1095
+ export interface ListChannelsModeratedByAppInstanceUserRequest {
1096
+ /**
1097
+ * The ARN of the user in the moderated channel.
1098
+ */
1099
+ AppInstanceUserArn?: ChimeArn;
1100
+ /**
1101
+ * The maximum number of channels in the request.
1102
+ */
1103
+ MaxResults?: MaxResults;
1104
+ /**
1105
+ * The token returned from previous API requests until the number of channels moderated by the user is reached.
1106
+ */
1107
+ NextToken?: NextToken;
1108
+ /**
1109
+ * The AppInstanceUserArn of the user that makes the API call.
1110
+ */
1111
+ ChimeBearer: ChimeArn;
1112
+ }
1113
+ export interface ListChannelsModeratedByAppInstanceUserResponse {
1114
+ /**
1115
+ * The moderated channels in the request.
1116
+ */
1117
+ Channels?: ChannelModeratedByAppInstanceUserSummaryList;
1118
+ /**
1119
+ * The token returned from previous API requests until the number of channels moderated by the user is reached.
1120
+ */
1121
+ NextToken?: NextToken;
1122
+ }
1123
+ export interface ListChannelsRequest {
1124
+ /**
1125
+ * The ARN of the AppInstance.
1126
+ */
1127
+ AppInstanceArn: ChimeArn;
1128
+ /**
1129
+ * The privacy setting. PUBLIC retrieves all the public channels. PRIVATE retrieves private channels. Only an AppInstanceAdmin can retrieve private channels.
1130
+ */
1131
+ Privacy?: ChannelPrivacy;
1132
+ /**
1133
+ * The maximum number of channels that you want to return.
1134
+ */
1135
+ MaxResults?: MaxResults;
1136
+ /**
1137
+ * The token passed by previous API calls until all requested channels are returned.
1138
+ */
1139
+ NextToken?: NextToken;
1140
+ /**
1141
+ * The AppInstanceUserArn of the user that makes the API call.
1142
+ */
1143
+ ChimeBearer: ChimeArn;
1144
+ }
1145
+ export interface ListChannelsResponse {
1146
+ /**
1147
+ * The information about each channel.
1148
+ */
1149
+ Channels?: ChannelSummaryList;
1150
+ /**
1151
+ * The token returned from previous API requests until the number of channels is reached.
1152
+ */
1153
+ NextToken?: NextToken;
1154
+ }
1155
+ export type MaxResults = number;
1156
+ export type MemberArns = ChimeArn[];
1157
+ export type Members = Identity[];
1158
+ export type MessageId = string;
1159
+ export interface MessagingSessionEndpoint {
1160
+ /**
1161
+ * The endpoint to which you establish a websocket connection.
1162
+ */
1163
+ Url?: UrlType;
1164
+ }
1165
+ export type Metadata = string;
1166
+ export type NextToken = string;
1167
+ export type NonEmptyContent = string;
1168
+ export type NonEmptyResourceName = string;
1169
+ export type NonNullableBoolean = boolean;
1170
+ export interface RedactChannelMessageRequest {
1171
+ /**
1172
+ * The ARN of the channel containing the messages that you want to redact.
1173
+ */
1174
+ ChannelArn: ChimeArn;
1175
+ /**
1176
+ * The ID of the message being redacted.
1177
+ */
1178
+ MessageId: MessageId;
1179
+ /**
1180
+ * The AppInstanceUserArn of the user that makes the API call.
1181
+ */
1182
+ ChimeBearer: ChimeArn;
1183
+ }
1184
+ export interface RedactChannelMessageResponse {
1185
+ /**
1186
+ * The ARN of the channel containing the messages that you want to redact.
1187
+ */
1188
+ ChannelArn?: ChimeArn;
1189
+ /**
1190
+ * The ID of the message being redacted.
1191
+ */
1192
+ MessageId?: MessageId;
1193
+ }
1194
+ export type ResourceName = string;
1195
+ export interface SendChannelMessageRequest {
1196
+ /**
1197
+ * The ARN of the channel.
1198
+ */
1199
+ ChannelArn: ChimeArn;
1200
+ /**
1201
+ * The content of the message.
1202
+ */
1203
+ Content: NonEmptyContent;
1204
+ /**
1205
+ * The type of message, STANDARD or CONTROL.
1206
+ */
1207
+ Type: ChannelMessageType;
1208
+ /**
1209
+ * Boolean that controls whether the message is persisted on the back end. Required.
1210
+ */
1211
+ Persistence: ChannelMessagePersistenceType;
1212
+ /**
1213
+ * The optional metadata for each message.
1214
+ */
1215
+ Metadata?: Metadata;
1216
+ /**
1217
+ * The Idempotency token for each client request.
1218
+ */
1219
+ ClientRequestToken: ClientRequestToken;
1220
+ /**
1221
+ * The AppInstanceUserArn of the user that makes the API call.
1222
+ */
1223
+ ChimeBearer: ChimeArn;
1224
+ }
1225
+ export interface SendChannelMessageResponse {
1226
+ /**
1227
+ * The ARN of the channel.
1228
+ */
1229
+ ChannelArn?: ChimeArn;
1230
+ /**
1231
+ * The ID string assigned to each message.
1232
+ */
1233
+ MessageId?: MessageId;
1234
+ }
1235
+ export type SortOrder = "ASCENDING"|"DESCENDING"|string;
1236
+ export type String = string;
1237
+ export interface Tag {
1238
+ /**
1239
+ * The key of the tag.
1240
+ */
1241
+ Key: TagKey;
1242
+ /**
1243
+ * The value of the tag.
1244
+ */
1245
+ Value: TagValue;
1246
+ }
1247
+ export type TagKey = string;
1248
+ export type TagList = Tag[];
1249
+ export type TagValue = string;
1250
+ export type Timestamp = Date;
1251
+ export interface UpdateChannelMessageRequest {
1252
+ /**
1253
+ * The ARN of the channel.
1254
+ */
1255
+ ChannelArn: ChimeArn;
1256
+ /**
1257
+ * The ID string of the message being updated.
1258
+ */
1259
+ MessageId: MessageId;
1260
+ /**
1261
+ * The content of the message being updated.
1262
+ */
1263
+ Content?: Content;
1264
+ /**
1265
+ * The metadata of the message being updated.
1266
+ */
1267
+ Metadata?: Metadata;
1268
+ /**
1269
+ * The AppInstanceUserArn of the user that makes the API call.
1270
+ */
1271
+ ChimeBearer: ChimeArn;
1272
+ }
1273
+ export interface UpdateChannelMessageResponse {
1274
+ /**
1275
+ * The ARN of the channel.
1276
+ */
1277
+ ChannelArn?: ChimeArn;
1278
+ /**
1279
+ * The ID string of the message being updated.
1280
+ */
1281
+ MessageId?: MessageId;
1282
+ }
1283
+ export interface UpdateChannelReadMarkerRequest {
1284
+ /**
1285
+ * The ARN of the channel.
1286
+ */
1287
+ ChannelArn: ChimeArn;
1288
+ /**
1289
+ * The AppInstanceUserArn of the user that makes the API call.
1290
+ */
1291
+ ChimeBearer: ChimeArn;
1292
+ }
1293
+ export interface UpdateChannelReadMarkerResponse {
1294
+ /**
1295
+ * The ARN of the channel.
1296
+ */
1297
+ ChannelArn?: ChimeArn;
1298
+ }
1299
+ export interface UpdateChannelRequest {
1300
+ /**
1301
+ * The ARN of the channel.
1302
+ */
1303
+ ChannelArn: ChimeArn;
1304
+ /**
1305
+ * The name of the channel.
1306
+ */
1307
+ Name: NonEmptyResourceName;
1308
+ /**
1309
+ * The mode of the update request.
1310
+ */
1311
+ Mode: ChannelMode;
1312
+ /**
1313
+ * The metadata for the update request.
1314
+ */
1315
+ Metadata?: Metadata;
1316
+ /**
1317
+ * The AppInstanceUserArn of the user that makes the API call.
1318
+ */
1319
+ ChimeBearer: ChimeArn;
1320
+ }
1321
+ export interface UpdateChannelResponse {
1322
+ /**
1323
+ * The ARN of the channel.
1324
+ */
1325
+ ChannelArn?: ChimeArn;
1326
+ }
1327
+ export type UrlType = string;
1328
+ /**
1329
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1330
+ */
1331
+ export type apiVersion = "2021-05-15"|"latest"|string;
1332
+ export interface ClientApiVersions {
1333
+ /**
1334
+ * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1335
+ */
1336
+ apiVersion?: apiVersion;
1337
+ }
1338
+ export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1339
+ /**
1340
+ * Contains interfaces for use with the ChimeSDKMessaging client.
1341
+ */
1342
+ export import Types = ChimeSDKMessaging;
1343
+ }
1344
+ export = ChimeSDKMessaging;