|
1 | 1 | { |
2 | 2 | "version": "2.0", |
3 | | - "service": "<p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging\">Amazon Chime SDK messaging</a> </p>", |
| 3 | + "service": "<p>The Amazon Chime SDK Messaging APIs in this section allow software developers to send and receive messages in custom messaging applications. These APIs depend on the frameworks provided by the Amazon Chime SDK Identity APIs. For more information about the messaging APIs, see <a href=\"https://docs.aws.amazon.com/chime/latest/APIReference/API_Operations_Amazon_Chime_SDK_Messaging.html\">Amazon Chime SDK messaging</a>.</p>", |
4 | 4 | "operations": { |
5 | 5 | "AssociateChannelFlow": "<p>Associates a channel flow with a channel. Once associated, all messages to that channel go through channel flow processors. To stop processing, use the <code>DisassociateChannelFlow</code> API.</p> <note> <p>Only administrators or channel moderators can associate a channel flow. The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>", |
6 | 6 | "BatchCreateChannelMembership": "<p>Adds a specified number of users to a channel. </p>", |
|
40 | 40 | "ListTagsForResource": "<p>Lists the tags applied to an Amazon Chime SDK messaging resource.</p>", |
41 | 41 | "PutChannelMembershipPreferences": "<p>Sets the membership preferences of an <code>AppInstanceUser</code> for the specified channel. The <code>AppInstanceUser</code> must be a member of the channel. Only the <code>AppInstanceUser</code> who owns the membership can set preferences. Users in the <code>AppInstanceAdmin</code> and channel moderator roles can't set preferences for other users. Banned users can't set membership preferences for the channel from which they are banned.</p>", |
42 | 42 | "RedactChannelMessage": "<p>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.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> </note>", |
| 43 | + "SearchChannels": "<p>Allows an <code>AppInstanceUser</code> to search the channels that they belong to. The <code>AppInstanceUser</code> can search by membership or external ID. An <code>AppInstanceAdmin</code> can search across all channels within the <code>AppInstance</code>.</p>", |
43 | 44 | "SendChannelMessage": "<p>Sends a message to a particular channel that the member is a part of.</p> <note> <p>The <code>x-amz-chime-bearer</code> request header is mandatory. Use the <code>AppInstanceUserArn</code> of the user that makes the API call as the value in the header.</p> <p>Also, <code>STANDARD</code> messages can contain 4KB of data and the 1KB of metadata. <code>CONTROL</code> messages can contain 30 bytes of data and no metadata.</p> </note>", |
44 | 45 | "TagResource": "<p>Applies the specified tags to the specified Amazon Chime SDK messaging resource.</p>", |
45 | 46 | "UntagResource": "<p>Removes the specified tags from the specified Amazon Chime SDK messaging resource.</p>", |
|
176 | 177 | "ListChannelFlowsResponse$ChannelFlows": "<p>The information about each channel flow.</p>" |
177 | 178 | } |
178 | 179 | }, |
| 180 | + "ChannelId": { |
| 181 | + "base": null, |
| 182 | + "refs": { |
| 183 | + "CreateChannelRequest$ChannelId": "<p>The ID of the channel in the request.</p>" |
| 184 | + } |
| 185 | + }, |
| 186 | + "ChannelMemberArns": { |
| 187 | + "base": null, |
| 188 | + "refs": { |
| 189 | + "CreateChannelRequest$MemberArns": "<p>The ARNs of the channel members in the request.</p>" |
| 190 | + } |
| 191 | + }, |
179 | 192 | "ChannelMembership": { |
180 | 193 | "base": "<p>The details of a channel member.</p>", |
181 | 194 | "refs": { |
|
192 | 205 | "ChannelMembershipForAppInstanceUserSummaryList": { |
193 | 206 | "base": null, |
194 | 207 | "refs": { |
195 | | - "ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "<p>The token passed by previous API calls until all requested users are returned.</p>" |
| 208 | + "ListChannelMembershipsForAppInstanceUserResponse$ChannelMemberships": "<p>The information for the requested channel memberships.</p>" |
196 | 209 | } |
197 | 210 | }, |
198 | 211 | "ChannelMembershipPreferences": { |
|
310 | 323 | "DescribeChannelModeratorResponse$ChannelModerator": "<p>The details of the channel moderator.</p>" |
311 | 324 | } |
312 | 325 | }, |
| 326 | + "ChannelModeratorArns": { |
| 327 | + "base": null, |
| 328 | + "refs": { |
| 329 | + "CreateChannelRequest$ModeratorArns": "<p>The ARNs of the channel moderators in the request.</p>" |
| 330 | + } |
| 331 | + }, |
313 | 332 | "ChannelModeratorSummary": { |
314 | 333 | "base": "<p>Summary of the details of a <code>ChannelModerator</code>.</p>", |
315 | 334 | "refs": { |
|
343 | 362 | "ChannelSummaryList": { |
344 | 363 | "base": null, |
345 | 364 | "refs": { |
346 | | - "ListChannelsResponse$Channels": "<p>The information about each channel.</p>" |
| 365 | + "ListChannelsResponse$Channels": "<p>The information about each channel.</p>", |
| 366 | + "SearchChannelsResponse$Channels": "<p>A list of the channels in the request.</p>" |
347 | 367 | } |
348 | 368 | }, |
349 | 369 | "ChimeArn": { |
|
364 | 384 | "ChannelFlowCallbackRequest$ChannelArn": "<p>The ARN of the channel.</p>", |
365 | 385 | "ChannelFlowCallbackResponse$ChannelArn": "<p>The ARN of the channel.</p>", |
366 | 386 | "ChannelFlowSummary$ChannelFlowArn": "<p>The ARN of the channel flow.</p>", |
| 387 | + "ChannelMemberArns$member": null, |
367 | 388 | "ChannelMembership$ChannelArn": "<p>The ARN of the member's channel.</p>", |
368 | 389 | "ChannelMessage$ChannelArn": "<p>The ARN of the channel.</p>", |
369 | 390 | "ChannelModerator$ChannelArn": "<p>The ARN of the moderator's channel.</p>", |
| 391 | + "ChannelModeratorArns$member": null, |
370 | 392 | "ChannelSummary$ChannelArn": "<p>The ARN of the channel.</p>", |
371 | 393 | "CreateChannelBanRequest$ChannelArn": "<p>The ARN of the ban request.</p>", |
372 | 394 | "CreateChannelBanRequest$MemberArn": "<p>The <code>AppInstanceUserArn</code> of the member being banned.</p>", |
|
458 | 480 | "RedactChannelMessageRequest$ChannelArn": "<p>The ARN of the channel containing the messages that you want to redact.</p>", |
459 | 481 | "RedactChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>", |
460 | 482 | "RedactChannelMessageResponse$ChannelArn": "<p>The ARN of the channel containing the messages that you want to redact.</p>", |
| 483 | + "SearchChannelsRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user making the API call.</p>", |
461 | 484 | "SendChannelMessageRequest$ChannelArn": "<p>The ARN of the channel.</p>", |
462 | 485 | "SendChannelMessageRequest$ChimeBearer": "<p>The <code>AppInstanceUserArn</code> of the user that makes the API call.</p>", |
463 | 486 | "SendChannelMessageResponse$ChannelArn": "<p>The ARN of the channel.</p>", |
|
676 | 699 | "FilterRule": { |
677 | 700 | "base": null, |
678 | 701 | "refs": { |
679 | | - "PushNotificationPreferences$FilterRule": "<p>The simple JSON object used to send a subset of a push notification to the requsted member.</p>" |
| 702 | + "PushNotificationPreferences$FilterRule": "<p>The simple JSON object used to send a subset of a push notification to the requested member.</p>" |
680 | 703 | } |
681 | 704 | }, |
682 | 705 | "ForbiddenException": { |
|
743 | 766 | "CreateChannelBanResponse$Member": "<p>The <code>ChannelArn</code> and <code>BannedIdentity</code> of the member in the ban response.</p>", |
744 | 767 | "CreateChannelMembershipResponse$Member": "<p>The ARN and metadata of the member being added.</p>", |
745 | 768 | "CreateChannelModeratorResponse$ChannelModerator": "<p>The ARNs of the channel and the moderator.</p>", |
746 | | - "GetChannelMembershipPreferencesResponse$Member": null, |
| 769 | + "GetChannelMembershipPreferencesResponse$Member": "<p>The details of a user.</p>", |
747 | 770 | "Members$member": null, |
748 | | - "PutChannelMembershipPreferencesResponse$Member": null |
| 771 | + "PutChannelMembershipPreferencesResponse$Member": "<p>The details of a user.</p>" |
749 | 772 | } |
750 | 773 | }, |
751 | 774 | "InvocationType": { |
|
877 | 900 | "ListChannelModeratorsRequest$MaxResults": "<p>The maximum number of moderators that you want returned.</p>", |
878 | 901 | "ListChannelsAssociatedWithChannelFlowRequest$MaxResults": "<p>The maximum number of channels that you want to return.</p>", |
879 | 902 | "ListChannelsModeratedByAppInstanceUserRequest$MaxResults": "<p>The maximum number of channels in the request.</p>", |
880 | | - "ListChannelsRequest$MaxResults": "<p>The maximum number of channels that you want to return.</p>" |
| 903 | + "ListChannelsRequest$MaxResults": "<p>The maximum number of channels that you want to return.</p>", |
| 904 | + "SearchChannelsRequest$MaxResults": "<p>The maximum number of channels that you want returned.</p>" |
881 | 905 | } |
882 | 906 | }, |
883 | 907 | "MemberArns": { |
|
982 | 1006 | "ListChannelsModeratedByAppInstanceUserRequest$NextToken": "<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>", |
983 | 1007 | "ListChannelsModeratedByAppInstanceUserResponse$NextToken": "<p>The token returned from previous API requests until the number of channels moderated by the user is reached.</p>", |
984 | 1008 | "ListChannelsRequest$NextToken": "<p>The token passed by previous API calls until all requested channels are returned.</p>", |
985 | | - "ListChannelsResponse$NextToken": "<p>The token returned from previous API requests until the number of channels is reached.</p>" |
| 1009 | + "ListChannelsResponse$NextToken": "<p>The token returned from previous API requests until the number of channels is reached.</p>", |
| 1010 | + "SearchChannelsRequest$NextToken": "<p>The token returned from previous API requests until the number of channels is reached.</p>", |
| 1011 | + "SearchChannelsResponse$NextToken": "<p>The token returned from previous API responses until the number of channels is reached.</p>" |
986 | 1012 | } |
987 | 1013 | }, |
988 | 1014 | "NonEmptyContent": { |
|
1103 | 1129 | "Identity$Name": "<p>The name in an Identity.</p>" |
1104 | 1130 | } |
1105 | 1131 | }, |
| 1132 | + "SearchChannelsRequest": { |
| 1133 | + "base": null, |
| 1134 | + "refs": { |
| 1135 | + } |
| 1136 | + }, |
| 1137 | + "SearchChannelsResponse": { |
| 1138 | + "base": null, |
| 1139 | + "refs": { |
| 1140 | + } |
| 1141 | + }, |
| 1142 | + "SearchField": { |
| 1143 | + "base": "<p>A <code>Field</code> of the channel that you want to search.</p>", |
| 1144 | + "refs": { |
| 1145 | + "SearchFields$member": null |
| 1146 | + } |
| 1147 | + }, |
| 1148 | + "SearchFieldKey": { |
| 1149 | + "base": null, |
| 1150 | + "refs": { |
| 1151 | + "SearchField$Key": "<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> 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>" |
| 1152 | + } |
| 1153 | + }, |
| 1154 | + "SearchFieldOperator": { |
| 1155 | + "base": null, |
| 1156 | + "refs": { |
| 1157 | + "SearchField$Operator": "<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. Use the <code>INCLUDES</code> operator to find channels whose memberships include the specified values.</p>" |
| 1158 | + } |
| 1159 | + }, |
| 1160 | + "SearchFieldValue": { |
| 1161 | + "base": null, |
| 1162 | + "refs": { |
| 1163 | + "SearchFieldValues$member": null |
| 1164 | + } |
| 1165 | + }, |
| 1166 | + "SearchFieldValues": { |
| 1167 | + "base": null, |
| 1168 | + "refs": { |
| 1169 | + "SearchField$Values": "<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> <note> <p>This operation isn't supported for <code>AppInstanceUsers</code> with large number of memberships.</p> </note>" |
| 1170 | + } |
| 1171 | + }, |
| 1172 | + "SearchFields": { |
| 1173 | + "base": null, |
| 1174 | + "refs": { |
| 1175 | + "SearchChannelsRequest$Fields": "<p>A list of the <code>Field</code> objects in the channel being searched.</p>" |
| 1176 | + } |
| 1177 | + }, |
1106 | 1178 | "SendChannelMessageRequest": { |
1107 | 1179 | "base": null, |
1108 | 1180 | "refs": { |
|
1197 | 1269 | "Timestamp": { |
1198 | 1270 | "base": null, |
1199 | 1271 | "refs": { |
1200 | | - "AppInstanceUserMembershipSummary$ReadMarkerTimestamp": "<p>The time at which a message was last read.</p>", |
| 1272 | + "AppInstanceUserMembershipSummary$ReadMarkerTimestamp": "<p>The time at which an <code>AppInstanceUser</code> last marked a channel as read.</p>", |
1201 | 1273 | "Channel$CreatedTimestamp": "<p>The time at which the <code>AppInstanceUser</code> created the channel.</p>", |
1202 | 1274 | "Channel$LastMessageTimestamp": "<p>The time at which a member sent the last message in the channel.</p>", |
1203 | 1275 | "Channel$LastUpdatedTimestamp": "<p>The time at which a channel was last updated.</p>", |
|
0 commit comments