aws-sdk-chime 1.38.0 → 1.39.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.
- checksums.yaml +4 -4
- data/lib/aws-sdk-chime.rb +1 -1
- data/lib/aws-sdk-chime/client.rb +1993 -104
- data/lib/aws-sdk-chime/client_api.rb +1634 -70
- data/lib/aws-sdk-chime/types.rb +4206 -1555
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8f36acfcf4078f3d498117b912792043673a8a638a67d68d627c133a720d90cf
|
4
|
+
data.tar.gz: 6b577c579dbd897ba7f48d0c784b7f6ec49d62b253c56ada1c49c9b780622306
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1efe07c5806b6aebba8fe1b210786aaaee7d63f028939683e5791e5cb622cd757ec663d2ad3c6f2cd382e811c9168c5d53621de4ad803c91718a2c18325fdbe8
|
7
|
+
data.tar.gz: d5c47c36cd7fafbd5298f1ebd83d86b6523106bc7f16c36c77a503f991aacc78e30abe55c7b6408a34912c963d8d5cfe5d1c7c09562913d3fb27828ce6af7f17
|
data/lib/aws-sdk-chime.rb
CHANGED
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -855,6 +855,139 @@ module Aws::Chime
|
|
855
855
|
req.send_request(options)
|
856
856
|
end
|
857
857
|
|
858
|
+
# Creates an Amazon Chime Messaging SDK `AppInstance` under an AWS
|
859
|
+
# Account. Only Messaging SDK customers use this API.
|
860
|
+
# `CreateAppInstance` supports `idempotency` behavior as described in
|
861
|
+
# the AWS API Standard.
|
862
|
+
#
|
863
|
+
# @option params [required, String] :name
|
864
|
+
# The name of the app instance.
|
865
|
+
#
|
866
|
+
# @option params [String] :metadata
|
867
|
+
# The metadata of the app instance. Limited to a 1KB string in UTF-8.
|
868
|
+
#
|
869
|
+
# @option params [required, String] :client_request_token
|
870
|
+
# The `ClientRequestToken` of the app instance.
|
871
|
+
#
|
872
|
+
# **A suitable default value is auto-generated.** You should normally
|
873
|
+
# not need to pass this option.**
|
874
|
+
#
|
875
|
+
# @return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
876
|
+
#
|
877
|
+
# * {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
878
|
+
#
|
879
|
+
# @example Request syntax with placeholder values
|
880
|
+
#
|
881
|
+
# resp = client.create_app_instance({
|
882
|
+
# name: "NonEmptyResourceName", # required
|
883
|
+
# metadata: "Metadata",
|
884
|
+
# client_request_token: "ClientRequestToken", # required
|
885
|
+
# })
|
886
|
+
#
|
887
|
+
# @example Response structure
|
888
|
+
#
|
889
|
+
# resp.app_instance_arn #=> String
|
890
|
+
#
|
891
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstance AWS API Documentation
|
892
|
+
#
|
893
|
+
# @overload create_app_instance(params = {})
|
894
|
+
# @param [Hash] params ({})
|
895
|
+
def create_app_instance(params = {}, options = {})
|
896
|
+
req = build_request(:create_app_instance, params)
|
897
|
+
req.send_request(options)
|
898
|
+
end
|
899
|
+
|
900
|
+
# Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted
|
901
|
+
# user can perform the following actions.
|
902
|
+
#
|
903
|
+
# * `ChannelModerator` actions across all channels in the app instance.
|
904
|
+
#
|
905
|
+
# * `DeleteChannelMessage` actions.
|
906
|
+
#
|
907
|
+
# Only an `AppInstanceUser` can be promoted to an `AppInstanceAdmin`
|
908
|
+
# role.
|
909
|
+
#
|
910
|
+
# @option params [required, String] :app_instance_admin_arn
|
911
|
+
# The ARN of the administrator of the current app instance.
|
912
|
+
#
|
913
|
+
# @option params [required, String] :app_instance_arn
|
914
|
+
# The ARN of the app instance.
|
915
|
+
#
|
916
|
+
# @return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
917
|
+
#
|
918
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::Identity
|
919
|
+
# * {Types::CreateAppInstanceAdminResponse#app_instance_arn #app_instance_arn} => String
|
920
|
+
#
|
921
|
+
# @example Request syntax with placeholder values
|
922
|
+
#
|
923
|
+
# resp = client.create_app_instance_admin({
|
924
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
925
|
+
# app_instance_arn: "ChimeArn", # required
|
926
|
+
# })
|
927
|
+
#
|
928
|
+
# @example Response structure
|
929
|
+
#
|
930
|
+
# resp.app_instance_admin.arn #=> String
|
931
|
+
# resp.app_instance_admin.name #=> String
|
932
|
+
# resp.app_instance_arn #=> String
|
933
|
+
#
|
934
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceAdmin AWS API Documentation
|
935
|
+
#
|
936
|
+
# @overload create_app_instance_admin(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def create_app_instance_admin(params = {}, options = {})
|
939
|
+
req = build_request(:create_app_instance_admin, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Creates a user under an Amazon Chime `AppInstance`. The request
|
944
|
+
# consists of a unique `appInstanceUserId` and `Name` for that user.
|
945
|
+
#
|
946
|
+
# @option params [required, String] :app_instance_arn
|
947
|
+
# The ARN of the app instance request.
|
948
|
+
#
|
949
|
+
# @option params [required, String] :app_instance_user_id
|
950
|
+
# The user ID of the app instance.
|
951
|
+
#
|
952
|
+
# @option params [required, String] :name
|
953
|
+
# The user's name.
|
954
|
+
#
|
955
|
+
# @option params [String] :metadata
|
956
|
+
# The request's metadata. Limited to a 1KB string in UTF-8.
|
957
|
+
#
|
958
|
+
# @option params [required, String] :client_request_token
|
959
|
+
# The token assigned to the user requesting an app instance.
|
960
|
+
#
|
961
|
+
# **A suitable default value is auto-generated.** You should normally
|
962
|
+
# not need to pass this option.**
|
963
|
+
#
|
964
|
+
# @return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
965
|
+
#
|
966
|
+
# * {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
967
|
+
#
|
968
|
+
# @example Request syntax with placeholder values
|
969
|
+
#
|
970
|
+
# resp = client.create_app_instance_user({
|
971
|
+
# app_instance_arn: "ChimeArn", # required
|
972
|
+
# app_instance_user_id: "UserId", # required
|
973
|
+
# name: "UserName", # required
|
974
|
+
# metadata: "Metadata",
|
975
|
+
# client_request_token: "ClientRequestToken", # required
|
976
|
+
# })
|
977
|
+
#
|
978
|
+
# @example Response structure
|
979
|
+
#
|
980
|
+
# resp.app_instance_user_arn #=> String
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateAppInstanceUser AWS API Documentation
|
983
|
+
#
|
984
|
+
# @overload create_app_instance_user(params = {})
|
985
|
+
# @param [Hash] params ({})
|
986
|
+
def create_app_instance_user(params = {}, options = {})
|
987
|
+
req = build_request(:create_app_instance_user, params)
|
988
|
+
req.send_request(options)
|
989
|
+
end
|
990
|
+
|
858
991
|
# Creates a new attendee for an active Amazon Chime SDK meeting. For
|
859
992
|
# more information about the Amazon Chime SDK, see [Using the Amazon
|
860
993
|
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
@@ -951,6 +1084,219 @@ module Aws::Chime
|
|
951
1084
|
req.send_request(options)
|
952
1085
|
end
|
953
1086
|
|
1087
|
+
# Creates a channel to which you can add users and send messages.
|
1088
|
+
#
|
1089
|
+
# **Restriction**\: You can't change a channel's privacy.
|
1090
|
+
#
|
1091
|
+
# @option params [required, String] :app_instance_arn
|
1092
|
+
# The ARN of the channel request.
|
1093
|
+
#
|
1094
|
+
# @option params [required, String] :name
|
1095
|
+
# The name of the channel.
|
1096
|
+
#
|
1097
|
+
# @option params [String] :mode
|
1098
|
+
# The channel mode: `UNRESTRICTED` or `RESTRICTED`. Administrators,
|
1099
|
+
# moderators, and channel members can add themselves and other members
|
1100
|
+
# to unrestricted channels. Only administrators and moderators can add
|
1101
|
+
# members to restricted channels.
|
1102
|
+
#
|
1103
|
+
# @option params [String] :privacy
|
1104
|
+
# The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels
|
1105
|
+
# aren't discoverable by users outside the channel. Public channels are
|
1106
|
+
# discoverable by anyone in the app instance.
|
1107
|
+
#
|
1108
|
+
# @option params [String] :metadata
|
1109
|
+
# The metadata of the creation request. Limited to 1KB and UTF-8.
|
1110
|
+
#
|
1111
|
+
# @option params [required, String] :client_request_token
|
1112
|
+
# The client token for the request. An `Idempotency` token.
|
1113
|
+
#
|
1114
|
+
# **A suitable default value is auto-generated.** You should normally
|
1115
|
+
# not need to pass this option.**
|
1116
|
+
#
|
1117
|
+
# @option params [Array<Types::Tag>] :tags
|
1118
|
+
#
|
1119
|
+
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1120
|
+
#
|
1121
|
+
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
1122
|
+
#
|
1123
|
+
# @example Request syntax with placeholder values
|
1124
|
+
#
|
1125
|
+
# resp = client.create_channel({
|
1126
|
+
# app_instance_arn: "ChimeArn", # required
|
1127
|
+
# name: "NonEmptyResourceName", # required
|
1128
|
+
# mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
|
1129
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
1130
|
+
# metadata: "Metadata",
|
1131
|
+
# client_request_token: "ClientRequestToken", # required
|
1132
|
+
# tags: [
|
1133
|
+
# {
|
1134
|
+
# key: "TagKey", # required
|
1135
|
+
# value: "TagValue", # required
|
1136
|
+
# },
|
1137
|
+
# ],
|
1138
|
+
# })
|
1139
|
+
#
|
1140
|
+
# @example Response structure
|
1141
|
+
#
|
1142
|
+
# resp.channel_arn #=> String
|
1143
|
+
#
|
1144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannel AWS API Documentation
|
1145
|
+
#
|
1146
|
+
# @overload create_channel(params = {})
|
1147
|
+
# @param [Hash] params ({})
|
1148
|
+
def create_channel(params = {}, options = {})
|
1149
|
+
req = build_request(:create_channel, params)
|
1150
|
+
req.send_request(options)
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Permanently bans a member from a channel. Moderators can't add banned
|
1154
|
+
# members to a channel. To undo a ban, you first have to
|
1155
|
+
# `DeleteChannelBan`, and then `CreateChannelMembership`. Bans are
|
1156
|
+
# cleaned up when you delete users or channels.
|
1157
|
+
#
|
1158
|
+
# If you ban a user who is already part of a channel, that user is
|
1159
|
+
# automatically kicked from the channel.
|
1160
|
+
#
|
1161
|
+
# @option params [required, String] :channel_arn
|
1162
|
+
# The ARN of the ban request.
|
1163
|
+
#
|
1164
|
+
# @option params [required, String] :member_arn
|
1165
|
+
# The ARN of the member being banned.
|
1166
|
+
#
|
1167
|
+
# @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1168
|
+
#
|
1169
|
+
# * {Types::CreateChannelBanResponse#channel_arn #channel_arn} => String
|
1170
|
+
# * {Types::CreateChannelBanResponse#member #member} => Types::Identity
|
1171
|
+
#
|
1172
|
+
# @example Request syntax with placeholder values
|
1173
|
+
#
|
1174
|
+
# resp = client.create_channel_ban({
|
1175
|
+
# channel_arn: "ChimeArn", # required
|
1176
|
+
# member_arn: "ChimeArn", # required
|
1177
|
+
# })
|
1178
|
+
#
|
1179
|
+
# @example Response structure
|
1180
|
+
#
|
1181
|
+
# resp.channel_arn #=> String
|
1182
|
+
# resp.member.arn #=> String
|
1183
|
+
# resp.member.name #=> String
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelBan AWS API Documentation
|
1186
|
+
#
|
1187
|
+
# @overload create_channel_ban(params = {})
|
1188
|
+
# @param [Hash] params ({})
|
1189
|
+
def create_channel_ban(params = {}, options = {})
|
1190
|
+
req = build_request(:create_channel_ban, params)
|
1191
|
+
req.send_request(options)
|
1192
|
+
end
|
1193
|
+
|
1194
|
+
# Adds a user to a channel. The `InvitedBy` response field is derived
|
1195
|
+
# from the request header. A channel member can:
|
1196
|
+
#
|
1197
|
+
# * List messages
|
1198
|
+
#
|
1199
|
+
# * Send messages
|
1200
|
+
#
|
1201
|
+
# * Receive messages
|
1202
|
+
#
|
1203
|
+
# * Edit their own messages
|
1204
|
+
#
|
1205
|
+
# * Leave the channel
|
1206
|
+
#
|
1207
|
+
# Privacy settings impact this action as follows:
|
1208
|
+
#
|
1209
|
+
# * Public Channels: You do not need to be a member to list messages,
|
1210
|
+
# but you must be a member to send messages.
|
1211
|
+
#
|
1212
|
+
# * Private Channels: You must be a member to list or send messages.
|
1213
|
+
#
|
1214
|
+
# @option params [required, String] :channel_arn
|
1215
|
+
# The ARN of the channel to which you're adding users.
|
1216
|
+
#
|
1217
|
+
# @option params [required, String] :member_arn
|
1218
|
+
# The ARN of the member you want to add to the channel.
|
1219
|
+
#
|
1220
|
+
# @option params [required, String] :type
|
1221
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
1222
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
1223
|
+
# members are only returned if the type filter in
|
1224
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
1225
|
+
# not returned. This is only supported by moderators.
|
1226
|
+
#
|
1227
|
+
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1228
|
+
#
|
1229
|
+
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
1230
|
+
# * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
|
1231
|
+
#
|
1232
|
+
# @example Request syntax with placeholder values
|
1233
|
+
#
|
1234
|
+
# resp = client.create_channel_membership({
|
1235
|
+
# channel_arn: "ChimeArn", # required
|
1236
|
+
# member_arn: "ChimeArn", # required
|
1237
|
+
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
1238
|
+
# })
|
1239
|
+
#
|
1240
|
+
# @example Response structure
|
1241
|
+
#
|
1242
|
+
# resp.channel_arn #=> String
|
1243
|
+
# resp.member.arn #=> String
|
1244
|
+
# resp.member.name #=> String
|
1245
|
+
#
|
1246
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelMembership AWS API Documentation
|
1247
|
+
#
|
1248
|
+
# @overload create_channel_membership(params = {})
|
1249
|
+
# @param [Hash] params ({})
|
1250
|
+
def create_channel_membership(params = {}, options = {})
|
1251
|
+
req = build_request(:create_channel_membership, params)
|
1252
|
+
req.send_request(options)
|
1253
|
+
end
|
1254
|
+
|
1255
|
+
# Creates a new `ChannelModerator`. A channel moderator can:
|
1256
|
+
#
|
1257
|
+
# * Add and remove other members of the channel.
|
1258
|
+
#
|
1259
|
+
# * Add and remove other moderators of the channel.
|
1260
|
+
#
|
1261
|
+
# * Add and remove user bans for the channel.
|
1262
|
+
#
|
1263
|
+
# * Redact messages in the channel.
|
1264
|
+
#
|
1265
|
+
# * List messages in the channel.
|
1266
|
+
#
|
1267
|
+
# @option params [required, String] :channel_arn
|
1268
|
+
# The ARN of the channel.
|
1269
|
+
#
|
1270
|
+
# @option params [required, String] :channel_moderator_arn
|
1271
|
+
# The ARN of the moderator.
|
1272
|
+
#
|
1273
|
+
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
|
+
#
|
1275
|
+
# * {Types::CreateChannelModeratorResponse#channel_arn #channel_arn} => String
|
1276
|
+
# * {Types::CreateChannelModeratorResponse#channel_moderator #channel_moderator} => Types::Identity
|
1277
|
+
#
|
1278
|
+
# @example Request syntax with placeholder values
|
1279
|
+
#
|
1280
|
+
# resp = client.create_channel_moderator({
|
1281
|
+
# channel_arn: "ChimeArn", # required
|
1282
|
+
# channel_moderator_arn: "ChimeArn", # required
|
1283
|
+
# })
|
1284
|
+
#
|
1285
|
+
# @example Response structure
|
1286
|
+
#
|
1287
|
+
# resp.channel_arn #=> String
|
1288
|
+
# resp.channel_moderator.arn #=> String
|
1289
|
+
# resp.channel_moderator.name #=> String
|
1290
|
+
#
|
1291
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/CreateChannelModerator AWS API Documentation
|
1292
|
+
#
|
1293
|
+
# @overload create_channel_moderator(params = {})
|
1294
|
+
# @param [Hash] params ({})
|
1295
|
+
def create_channel_moderator(params = {}, options = {})
|
1296
|
+
req = build_request(:create_channel_moderator, params)
|
1297
|
+
req.send_request(options)
|
1298
|
+
end
|
1299
|
+
|
954
1300
|
# Creates a new Amazon Chime SDK meeting in the specified media Region
|
955
1301
|
# with no initial attendees. For more information about specifying media
|
956
1302
|
# Regions, see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime
|
@@ -1770,6 +2116,99 @@ module Aws::Chime
|
|
1770
2116
|
req.send_request(options)
|
1771
2117
|
end
|
1772
2118
|
|
2119
|
+
# Deletes an `AppInstance` and all associated data asynchronously.
|
2120
|
+
#
|
2121
|
+
# @option params [required, String] :app_instance_arn
|
2122
|
+
# The ARN of the app instance.
|
2123
|
+
#
|
2124
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2125
|
+
#
|
2126
|
+
# @example Request syntax with placeholder values
|
2127
|
+
#
|
2128
|
+
# resp = client.delete_app_instance({
|
2129
|
+
# app_instance_arn: "ChimeArn", # required
|
2130
|
+
# })
|
2131
|
+
#
|
2132
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstance AWS API Documentation
|
2133
|
+
#
|
2134
|
+
# @overload delete_app_instance(params = {})
|
2135
|
+
# @param [Hash] params ({})
|
2136
|
+
def delete_app_instance(params = {}, options = {})
|
2137
|
+
req = build_request(:delete_app_instance, params)
|
2138
|
+
req.send_request(options)
|
2139
|
+
end
|
2140
|
+
|
2141
|
+
# Demotes an `AppInstanceAdmin` to an `AppInstanceUser`. This action
|
2142
|
+
# does not delete the user.
|
2143
|
+
#
|
2144
|
+
# @option params [required, String] :app_instance_admin_arn
|
2145
|
+
# The ARN of the app instance's administrator.
|
2146
|
+
#
|
2147
|
+
# @option params [required, String] :app_instance_arn
|
2148
|
+
# The ARN of the app instance.
|
2149
|
+
#
|
2150
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2151
|
+
#
|
2152
|
+
# @example Request syntax with placeholder values
|
2153
|
+
#
|
2154
|
+
# resp = client.delete_app_instance_admin({
|
2155
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2156
|
+
# app_instance_arn: "ChimeArn", # required
|
2157
|
+
# })
|
2158
|
+
#
|
2159
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceAdmin AWS API Documentation
|
2160
|
+
#
|
2161
|
+
# @overload delete_app_instance_admin(params = {})
|
2162
|
+
# @param [Hash] params ({})
|
2163
|
+
def delete_app_instance_admin(params = {}, options = {})
|
2164
|
+
req = build_request(:delete_app_instance_admin, params)
|
2165
|
+
req.send_request(options)
|
2166
|
+
end
|
2167
|
+
|
2168
|
+
# Deletes the streaming configurations of an app instance.
|
2169
|
+
#
|
2170
|
+
# @option params [required, String] :app_instance_arn
|
2171
|
+
# The ARN of the streaming configurations being deleted.
|
2172
|
+
#
|
2173
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2174
|
+
#
|
2175
|
+
# @example Request syntax with placeholder values
|
2176
|
+
#
|
2177
|
+
# resp = client.delete_app_instance_streaming_configurations({
|
2178
|
+
# app_instance_arn: "ChimeArn", # required
|
2179
|
+
# })
|
2180
|
+
#
|
2181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceStreamingConfigurations AWS API Documentation
|
2182
|
+
#
|
2183
|
+
# @overload delete_app_instance_streaming_configurations(params = {})
|
2184
|
+
# @param [Hash] params ({})
|
2185
|
+
def delete_app_instance_streaming_configurations(params = {}, options = {})
|
2186
|
+
req = build_request(:delete_app_instance_streaming_configurations, params)
|
2187
|
+
req.send_request(options)
|
2188
|
+
end
|
2189
|
+
|
2190
|
+
# Deletes an `AppInstanceUser`.
|
2191
|
+
#
|
2192
|
+
# @option params [required, String] :app_instance_user_arn
|
2193
|
+
# The ARN of the user request being deleted.
|
2194
|
+
#
|
2195
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2196
|
+
#
|
2197
|
+
# @example Request syntax with placeholder values
|
2198
|
+
#
|
2199
|
+
# resp = client.delete_app_instance_user({
|
2200
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2201
|
+
# })
|
2202
|
+
#
|
2203
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteAppInstanceUser AWS API Documentation
|
2204
|
+
#
|
2205
|
+
# @overload delete_app_instance_user(params = {})
|
2206
|
+
# @param [Hash] params ({})
|
2207
|
+
def delete_app_instance_user(params = {}, options = {})
|
2208
|
+
req = build_request(:delete_app_instance_user, params)
|
2209
|
+
req.send_request(options)
|
2210
|
+
end
|
2211
|
+
|
1773
2212
|
# Deletes an attendee from the specified Amazon Chime SDK meeting and
|
1774
2213
|
# deletes their `JoinToken`. Attendees are automatically deleted when a
|
1775
2214
|
# Amazon Chime SDK meeting is deleted. For more information about the
|
@@ -1804,64 +2243,193 @@ module Aws::Chime
|
|
1804
2243
|
req.send_request(options)
|
1805
2244
|
end
|
1806
2245
|
|
1807
|
-
#
|
1808
|
-
#
|
1809
|
-
#
|
1810
|
-
# @option params [required, String] :account_id
|
1811
|
-
# The Amazon Chime account ID.
|
2246
|
+
# Immediately makes a channel and its memberships inaccessible and marks
|
2247
|
+
# them for deletion. This is an irreversible process.
|
1812
2248
|
#
|
1813
|
-
# @option params [required, String] :
|
1814
|
-
# The
|
2249
|
+
# @option params [required, String] :channel_arn
|
2250
|
+
# The ARN of the channel being deleted.
|
1815
2251
|
#
|
1816
2252
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1817
2253
|
#
|
1818
2254
|
# @example Request syntax with placeholder values
|
1819
2255
|
#
|
1820
|
-
# resp = client.
|
1821
|
-
#
|
1822
|
-
# bot_id: "NonEmptyString", # required
|
2256
|
+
# resp = client.delete_channel({
|
2257
|
+
# channel_arn: "ChimeArn", # required
|
1823
2258
|
# })
|
1824
2259
|
#
|
1825
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
2260
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannel AWS API Documentation
|
1826
2261
|
#
|
1827
|
-
# @overload
|
2262
|
+
# @overload delete_channel(params = {})
|
1828
2263
|
# @param [Hash] params ({})
|
1829
|
-
def
|
1830
|
-
req = build_request(:
|
2264
|
+
def delete_channel(params = {}, options = {})
|
2265
|
+
req = build_request(:delete_channel, params)
|
1831
2266
|
req.send_request(options)
|
1832
2267
|
end
|
1833
2268
|
|
1834
|
-
#
|
1835
|
-
# deleted, its attendees are also deleted and clients can no longer join
|
1836
|
-
# it. For more information about the Amazon Chime SDK, see [Using the
|
1837
|
-
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
1838
|
-
#
|
2269
|
+
# Removes a user from a channel's ban list.
|
1839
2270
|
#
|
2271
|
+
# @option params [required, String] :channel_arn
|
2272
|
+
# The ARN of the channel from which the app instance user was banned.
|
1840
2273
|
#
|
1841
|
-
# [
|
1842
|
-
#
|
1843
|
-
# @option params [required, String] :meeting_id
|
1844
|
-
# The Amazon Chime SDK meeting ID.
|
2274
|
+
# @option params [required, String] :member_arn
|
2275
|
+
# The ARN of the app instance user that you want to reinstate.
|
1845
2276
|
#
|
1846
2277
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1847
2278
|
#
|
1848
2279
|
# @example Request syntax with placeholder values
|
1849
2280
|
#
|
1850
|
-
# resp = client.
|
1851
|
-
#
|
2281
|
+
# resp = client.delete_channel_ban({
|
2282
|
+
# channel_arn: "ChimeArn", # required
|
2283
|
+
# member_arn: "ChimeArn", # required
|
1852
2284
|
# })
|
1853
2285
|
#
|
1854
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
2286
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelBan AWS API Documentation
|
1855
2287
|
#
|
1856
|
-
# @overload
|
2288
|
+
# @overload delete_channel_ban(params = {})
|
1857
2289
|
# @param [Hash] params ({})
|
1858
|
-
def
|
1859
|
-
req = build_request(:
|
2290
|
+
def delete_channel_ban(params = {}, options = {})
|
2291
|
+
req = build_request(:delete_channel_ban, params)
|
1860
2292
|
req.send_request(options)
|
1861
2293
|
end
|
1862
2294
|
|
1863
|
-
#
|
1864
|
-
#
|
2295
|
+
# Removes a member from a channel.
|
2296
|
+
#
|
2297
|
+
# @option params [required, String] :channel_arn
|
2298
|
+
# The ARN of the channel from which you want to remove the user.
|
2299
|
+
#
|
2300
|
+
# @option params [required, String] :member_arn
|
2301
|
+
# The ARN of the member that you're removing from the channel.
|
2302
|
+
#
|
2303
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2304
|
+
#
|
2305
|
+
# @example Request syntax with placeholder values
|
2306
|
+
#
|
2307
|
+
# resp = client.delete_channel_membership({
|
2308
|
+
# channel_arn: "ChimeArn", # required
|
2309
|
+
# member_arn: "ChimeArn", # required
|
2310
|
+
# })
|
2311
|
+
#
|
2312
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMembership AWS API Documentation
|
2313
|
+
#
|
2314
|
+
# @overload delete_channel_membership(params = {})
|
2315
|
+
# @param [Hash] params ({})
|
2316
|
+
def delete_channel_membership(params = {}, options = {})
|
2317
|
+
req = build_request(:delete_channel_membership, params)
|
2318
|
+
req.send_request(options)
|
2319
|
+
end
|
2320
|
+
|
2321
|
+
# Deletes a channel message. Only admins can perform this action.
|
2322
|
+
# Deletion makes messages inaccessible immediately. A background process
|
2323
|
+
# deletes any revisions created by `UpdateChannelMessage`.
|
2324
|
+
#
|
2325
|
+
# @option params [required, String] :channel_arn
|
2326
|
+
# The ARN of the channel.
|
2327
|
+
#
|
2328
|
+
# @option params [required, String] :message_id
|
2329
|
+
# The ID of the message being deleted.
|
2330
|
+
#
|
2331
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2332
|
+
#
|
2333
|
+
# @example Request syntax with placeholder values
|
2334
|
+
#
|
2335
|
+
# resp = client.delete_channel_message({
|
2336
|
+
# channel_arn: "ChimeArn", # required
|
2337
|
+
# message_id: "MessageId", # required
|
2338
|
+
# })
|
2339
|
+
#
|
2340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMessage AWS API Documentation
|
2341
|
+
#
|
2342
|
+
# @overload delete_channel_message(params = {})
|
2343
|
+
# @param [Hash] params ({})
|
2344
|
+
def delete_channel_message(params = {}, options = {})
|
2345
|
+
req = build_request(:delete_channel_message, params)
|
2346
|
+
req.send_request(options)
|
2347
|
+
end
|
2348
|
+
|
2349
|
+
# Deletes a channel moderator.
|
2350
|
+
#
|
2351
|
+
# @option params [required, String] :channel_arn
|
2352
|
+
# The ARN of the channel.
|
2353
|
+
#
|
2354
|
+
# @option params [required, String] :channel_moderator_arn
|
2355
|
+
# The ARN of the moderator being deleted.
|
2356
|
+
#
|
2357
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2358
|
+
#
|
2359
|
+
# @example Request syntax with placeholder values
|
2360
|
+
#
|
2361
|
+
# resp = client.delete_channel_moderator({
|
2362
|
+
# channel_arn: "ChimeArn", # required
|
2363
|
+
# channel_moderator_arn: "ChimeArn", # required
|
2364
|
+
# })
|
2365
|
+
#
|
2366
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelModerator AWS API Documentation
|
2367
|
+
#
|
2368
|
+
# @overload delete_channel_moderator(params = {})
|
2369
|
+
# @param [Hash] params ({})
|
2370
|
+
def delete_channel_moderator(params = {}, options = {})
|
2371
|
+
req = build_request(:delete_channel_moderator, params)
|
2372
|
+
req.send_request(options)
|
2373
|
+
end
|
2374
|
+
|
2375
|
+
# Deletes the events configuration that allows a bot to receive outgoing
|
2376
|
+
# events.
|
2377
|
+
#
|
2378
|
+
# @option params [required, String] :account_id
|
2379
|
+
# The Amazon Chime account ID.
|
2380
|
+
#
|
2381
|
+
# @option params [required, String] :bot_id
|
2382
|
+
# The bot ID.
|
2383
|
+
#
|
2384
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2385
|
+
#
|
2386
|
+
# @example Request syntax with placeholder values
|
2387
|
+
#
|
2388
|
+
# resp = client.delete_events_configuration({
|
2389
|
+
# account_id: "NonEmptyString", # required
|
2390
|
+
# bot_id: "NonEmptyString", # required
|
2391
|
+
# })
|
2392
|
+
#
|
2393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteEventsConfiguration AWS API Documentation
|
2394
|
+
#
|
2395
|
+
# @overload delete_events_configuration(params = {})
|
2396
|
+
# @param [Hash] params ({})
|
2397
|
+
def delete_events_configuration(params = {}, options = {})
|
2398
|
+
req = build_request(:delete_events_configuration, params)
|
2399
|
+
req.send_request(options)
|
2400
|
+
end
|
2401
|
+
|
2402
|
+
# Deletes the specified Amazon Chime SDK meeting. When a meeting is
|
2403
|
+
# deleted, its attendees are also deleted and clients can no longer join
|
2404
|
+
# it. For more information about the Amazon Chime SDK, see [Using the
|
2405
|
+
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
2406
|
+
#
|
2407
|
+
#
|
2408
|
+
#
|
2409
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
|
2410
|
+
#
|
2411
|
+
# @option params [required, String] :meeting_id
|
2412
|
+
# The Amazon Chime SDK meeting ID.
|
2413
|
+
#
|
2414
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2415
|
+
#
|
2416
|
+
# @example Request syntax with placeholder values
|
2417
|
+
#
|
2418
|
+
# resp = client.delete_meeting({
|
2419
|
+
# meeting_id: "GuidString", # required
|
2420
|
+
# })
|
2421
|
+
#
|
2422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteMeeting AWS API Documentation
|
2423
|
+
#
|
2424
|
+
# @overload delete_meeting(params = {})
|
2425
|
+
# @param [Hash] params ({})
|
2426
|
+
def delete_meeting(params = {}, options = {})
|
2427
|
+
req = build_request(:delete_meeting, params)
|
2428
|
+
req.send_request(options)
|
2429
|
+
end
|
2430
|
+
|
2431
|
+
# Moves the specified phone number into the **Deletion queue**. A phone
|
2432
|
+
# number must be disassociated from any users or Amazon Chime Voice
|
1865
2433
|
# Connectors before it can be deleted.
|
1866
2434
|
#
|
1867
2435
|
# Deleted phone numbers remain in the **Deletion queue** for 7 days
|
@@ -2219,6 +2787,333 @@ module Aws::Chime
|
|
2219
2787
|
req.send_request(options)
|
2220
2788
|
end
|
2221
2789
|
|
2790
|
+
# Returns the full details of an `AppInstance`.
|
2791
|
+
#
|
2792
|
+
# @option params [required, String] :app_instance_arn
|
2793
|
+
# The ARN of the app instance.
|
2794
|
+
#
|
2795
|
+
# @return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2796
|
+
#
|
2797
|
+
# * {Types::DescribeAppInstanceResponse#app_instance #app_instance} => Types::AppInstance
|
2798
|
+
#
|
2799
|
+
# @example Request syntax with placeholder values
|
2800
|
+
#
|
2801
|
+
# resp = client.describe_app_instance({
|
2802
|
+
# app_instance_arn: "ChimeArn", # required
|
2803
|
+
# })
|
2804
|
+
#
|
2805
|
+
# @example Response structure
|
2806
|
+
#
|
2807
|
+
# resp.app_instance.app_instance_arn #=> String
|
2808
|
+
# resp.app_instance.name #=> String
|
2809
|
+
# resp.app_instance.metadata #=> String
|
2810
|
+
# resp.app_instance.created_timestamp #=> Time
|
2811
|
+
# resp.app_instance.last_updated_timestamp #=> Time
|
2812
|
+
#
|
2813
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstance AWS API Documentation
|
2814
|
+
#
|
2815
|
+
# @overload describe_app_instance(params = {})
|
2816
|
+
# @param [Hash] params ({})
|
2817
|
+
def describe_app_instance(params = {}, options = {})
|
2818
|
+
req = build_request(:describe_app_instance, params)
|
2819
|
+
req.send_request(options)
|
2820
|
+
end
|
2821
|
+
|
2822
|
+
# Returns the full details of an `AppInstanceAdmin`.
|
2823
|
+
#
|
2824
|
+
# @option params [required, String] :app_instance_admin_arn
|
2825
|
+
# The ARN of the app instance administrator.
|
2826
|
+
#
|
2827
|
+
# @option params [required, String] :app_instance_arn
|
2828
|
+
# The ARN of the app instance.
|
2829
|
+
#
|
2830
|
+
# @return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2831
|
+
#
|
2832
|
+
# * {Types::DescribeAppInstanceAdminResponse#app_instance_admin #app_instance_admin} => Types::AppInstanceAdmin
|
2833
|
+
#
|
2834
|
+
# @example Request syntax with placeholder values
|
2835
|
+
#
|
2836
|
+
# resp = client.describe_app_instance_admin({
|
2837
|
+
# app_instance_admin_arn: "ChimeArn", # required
|
2838
|
+
# app_instance_arn: "ChimeArn", # required
|
2839
|
+
# })
|
2840
|
+
#
|
2841
|
+
# @example Response structure
|
2842
|
+
#
|
2843
|
+
# resp.app_instance_admin.admin.arn #=> String
|
2844
|
+
# resp.app_instance_admin.admin.name #=> String
|
2845
|
+
# resp.app_instance_admin.app_instance_arn #=> String
|
2846
|
+
# resp.app_instance_admin.created_timestamp #=> Time
|
2847
|
+
#
|
2848
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceAdmin AWS API Documentation
|
2849
|
+
#
|
2850
|
+
# @overload describe_app_instance_admin(params = {})
|
2851
|
+
# @param [Hash] params ({})
|
2852
|
+
def describe_app_instance_admin(params = {}, options = {})
|
2853
|
+
req = build_request(:describe_app_instance_admin, params)
|
2854
|
+
req.send_request(options)
|
2855
|
+
end
|
2856
|
+
|
2857
|
+
# Returns the full details of an `AppInstanceUser`.
|
2858
|
+
#
|
2859
|
+
# @option params [required, String] :app_instance_user_arn
|
2860
|
+
# The ARN of the app instance user.
|
2861
|
+
#
|
2862
|
+
# @return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2863
|
+
#
|
2864
|
+
# * {Types::DescribeAppInstanceUserResponse#app_instance_user #app_instance_user} => Types::AppInstanceUser
|
2865
|
+
#
|
2866
|
+
# @example Request syntax with placeholder values
|
2867
|
+
#
|
2868
|
+
# resp = client.describe_app_instance_user({
|
2869
|
+
# app_instance_user_arn: "ChimeArn", # required
|
2870
|
+
# })
|
2871
|
+
#
|
2872
|
+
# @example Response structure
|
2873
|
+
#
|
2874
|
+
# resp.app_instance_user.app_instance_user_arn #=> String
|
2875
|
+
# resp.app_instance_user.name #=> String
|
2876
|
+
# resp.app_instance_user.created_timestamp #=> Time
|
2877
|
+
# resp.app_instance_user.metadata #=> String
|
2878
|
+
# resp.app_instance_user.last_updated_timestamp #=> Time
|
2879
|
+
#
|
2880
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeAppInstanceUser AWS API Documentation
|
2881
|
+
#
|
2882
|
+
# @overload describe_app_instance_user(params = {})
|
2883
|
+
# @param [Hash] params ({})
|
2884
|
+
def describe_app_instance_user(params = {}, options = {})
|
2885
|
+
req = build_request(:describe_app_instance_user, params)
|
2886
|
+
req.send_request(options)
|
2887
|
+
end
|
2888
|
+
|
2889
|
+
# Returns the full details of a channel in an Amazon Chime app instance.
|
2890
|
+
#
|
2891
|
+
# @option params [required, String] :channel_arn
|
2892
|
+
# The ARN of the channel.
|
2893
|
+
#
|
2894
|
+
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2895
|
+
#
|
2896
|
+
# * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
|
2897
|
+
#
|
2898
|
+
# @example Request syntax with placeholder values
|
2899
|
+
#
|
2900
|
+
# resp = client.describe_channel({
|
2901
|
+
# channel_arn: "ChimeArn", # required
|
2902
|
+
# })
|
2903
|
+
#
|
2904
|
+
# @example Response structure
|
2905
|
+
#
|
2906
|
+
# resp.channel.name #=> String
|
2907
|
+
# resp.channel.channel_arn #=> String
|
2908
|
+
# resp.channel.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
2909
|
+
# resp.channel.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
2910
|
+
# resp.channel.metadata #=> String
|
2911
|
+
# resp.channel.created_by.arn #=> String
|
2912
|
+
# resp.channel.created_by.name #=> String
|
2913
|
+
# resp.channel.created_timestamp #=> Time
|
2914
|
+
# resp.channel.last_message_timestamp #=> Time
|
2915
|
+
# resp.channel.last_updated_timestamp #=> Time
|
2916
|
+
#
|
2917
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannel AWS API Documentation
|
2918
|
+
#
|
2919
|
+
# @overload describe_channel(params = {})
|
2920
|
+
# @param [Hash] params ({})
|
2921
|
+
def describe_channel(params = {}, options = {})
|
2922
|
+
req = build_request(:describe_channel, params)
|
2923
|
+
req.send_request(options)
|
2924
|
+
end
|
2925
|
+
|
2926
|
+
# Returns the full details of a channel ban.
|
2927
|
+
#
|
2928
|
+
# @option params [required, String] :channel_arn
|
2929
|
+
# The ARN of the channel from which the user is banned.
|
2930
|
+
#
|
2931
|
+
# @option params [required, String] :member_arn
|
2932
|
+
# The ARN of the member being banned.
|
2933
|
+
#
|
2934
|
+
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2935
|
+
#
|
2936
|
+
# * {Types::DescribeChannelBanResponse#channel_ban #channel_ban} => Types::ChannelBan
|
2937
|
+
#
|
2938
|
+
# @example Request syntax with placeholder values
|
2939
|
+
#
|
2940
|
+
# resp = client.describe_channel_ban({
|
2941
|
+
# channel_arn: "ChimeArn", # required
|
2942
|
+
# member_arn: "ChimeArn", # required
|
2943
|
+
# })
|
2944
|
+
#
|
2945
|
+
# @example Response structure
|
2946
|
+
#
|
2947
|
+
# resp.channel_ban.member.arn #=> String
|
2948
|
+
# resp.channel_ban.member.name #=> String
|
2949
|
+
# resp.channel_ban.channel_arn #=> String
|
2950
|
+
# resp.channel_ban.created_timestamp #=> Time
|
2951
|
+
# resp.channel_ban.created_by.arn #=> String
|
2952
|
+
# resp.channel_ban.created_by.name #=> String
|
2953
|
+
#
|
2954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelBan AWS API Documentation
|
2955
|
+
#
|
2956
|
+
# @overload describe_channel_ban(params = {})
|
2957
|
+
# @param [Hash] params ({})
|
2958
|
+
def describe_channel_ban(params = {}, options = {})
|
2959
|
+
req = build_request(:describe_channel_ban, params)
|
2960
|
+
req.send_request(options)
|
2961
|
+
end
|
2962
|
+
|
2963
|
+
# Returns the full details of a user's channel membership.
|
2964
|
+
#
|
2965
|
+
# @option params [required, String] :channel_arn
|
2966
|
+
# The ARN of the channel.
|
2967
|
+
#
|
2968
|
+
# @option params [required, String] :member_arn
|
2969
|
+
# The ARN of the member.
|
2970
|
+
#
|
2971
|
+
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2972
|
+
#
|
2973
|
+
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
2974
|
+
#
|
2975
|
+
# @example Request syntax with placeholder values
|
2976
|
+
#
|
2977
|
+
# resp = client.describe_channel_membership({
|
2978
|
+
# channel_arn: "ChimeArn", # required
|
2979
|
+
# member_arn: "ChimeArn", # required
|
2980
|
+
# })
|
2981
|
+
#
|
2982
|
+
# @example Response structure
|
2983
|
+
#
|
2984
|
+
# resp.channel_membership.invited_by.arn #=> String
|
2985
|
+
# resp.channel_membership.invited_by.name #=> String
|
2986
|
+
# resp.channel_membership.type #=> String, one of "DEFAULT", "HIDDEN"
|
2987
|
+
# resp.channel_membership.member.arn #=> String
|
2988
|
+
# resp.channel_membership.member.name #=> String
|
2989
|
+
# resp.channel_membership.channel_arn #=> String
|
2990
|
+
# resp.channel_membership.created_timestamp #=> Time
|
2991
|
+
# resp.channel_membership.last_updated_timestamp #=> Time
|
2992
|
+
#
|
2993
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembership AWS API Documentation
|
2994
|
+
#
|
2995
|
+
# @overload describe_channel_membership(params = {})
|
2996
|
+
# @param [Hash] params ({})
|
2997
|
+
def describe_channel_membership(params = {}, options = {})
|
2998
|
+
req = build_request(:describe_channel_membership, params)
|
2999
|
+
req.send_request(options)
|
3000
|
+
end
|
3001
|
+
|
3002
|
+
# Returns the details of a channel based on the membership of the
|
3003
|
+
# `AppInstanceUser` specified.
|
3004
|
+
#
|
3005
|
+
# @option params [required, String] :channel_arn
|
3006
|
+
# The ARN of the channel to which the user belongs.
|
3007
|
+
#
|
3008
|
+
# @option params [required, String] :app_instance_user_arn
|
3009
|
+
# The ARN of the user in a channel.
|
3010
|
+
#
|
3011
|
+
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3012
|
+
#
|
3013
|
+
# * {Types::DescribeChannelMembershipForAppInstanceUserResponse#channel_membership #channel_membership} => Types::ChannelMembershipForAppInstanceUserSummary
|
3014
|
+
#
|
3015
|
+
# @example Request syntax with placeholder values
|
3016
|
+
#
|
3017
|
+
# resp = client.describe_channel_membership_for_app_instance_user({
|
3018
|
+
# channel_arn: "ChimeArn", # required
|
3019
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3020
|
+
# })
|
3021
|
+
#
|
3022
|
+
# @example Response structure
|
3023
|
+
#
|
3024
|
+
# resp.channel_membership.channel_summary.name #=> String
|
3025
|
+
# resp.channel_membership.channel_summary.channel_arn #=> String
|
3026
|
+
# resp.channel_membership.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3027
|
+
# resp.channel_membership.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3028
|
+
# resp.channel_membership.channel_summary.metadata #=> String
|
3029
|
+
# resp.channel_membership.channel_summary.last_message_timestamp #=> Time
|
3030
|
+
# resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
3031
|
+
# resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
3032
|
+
#
|
3033
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
|
3034
|
+
#
|
3035
|
+
# @overload describe_channel_membership_for_app_instance_user(params = {})
|
3036
|
+
# @param [Hash] params ({})
|
3037
|
+
def describe_channel_membership_for_app_instance_user(params = {}, options = {})
|
3038
|
+
req = build_request(:describe_channel_membership_for_app_instance_user, params)
|
3039
|
+
req.send_request(options)
|
3040
|
+
end
|
3041
|
+
|
3042
|
+
# Returns the full details of a channel moderated by the specified
|
3043
|
+
# `AppInstanceUser`.
|
3044
|
+
#
|
3045
|
+
# @option params [required, String] :channel_arn
|
3046
|
+
# The ARN of the moderated channel.
|
3047
|
+
#
|
3048
|
+
# @option params [required, String] :app_instance_user_arn
|
3049
|
+
# The ARN of the app instance user in the moderated channel.
|
3050
|
+
#
|
3051
|
+
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3052
|
+
#
|
3053
|
+
# * {Types::DescribeChannelModeratedByAppInstanceUserResponse#channel #channel} => Types::ChannelModeratedByAppInstanceUserSummary
|
3054
|
+
#
|
3055
|
+
# @example Request syntax with placeholder values
|
3056
|
+
#
|
3057
|
+
# resp = client.describe_channel_moderated_by_app_instance_user({
|
3058
|
+
# channel_arn: "ChimeArn", # required
|
3059
|
+
# app_instance_user_arn: "ChimeArn", # required
|
3060
|
+
# })
|
3061
|
+
#
|
3062
|
+
# @example Response structure
|
3063
|
+
#
|
3064
|
+
# resp.channel.channel_summary.name #=> String
|
3065
|
+
# resp.channel.channel_summary.channel_arn #=> String
|
3066
|
+
# resp.channel.channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
3067
|
+
# resp.channel.channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
3068
|
+
# resp.channel.channel_summary.metadata #=> String
|
3069
|
+
# resp.channel.channel_summary.last_message_timestamp #=> Time
|
3070
|
+
#
|
3071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModeratedByAppInstanceUser AWS API Documentation
|
3072
|
+
#
|
3073
|
+
# @overload describe_channel_moderated_by_app_instance_user(params = {})
|
3074
|
+
# @param [Hash] params ({})
|
3075
|
+
def describe_channel_moderated_by_app_instance_user(params = {}, options = {})
|
3076
|
+
req = build_request(:describe_channel_moderated_by_app_instance_user, params)
|
3077
|
+
req.send_request(options)
|
3078
|
+
end
|
3079
|
+
|
3080
|
+
# Returns the full details of a single ChannelModerator.
|
3081
|
+
#
|
3082
|
+
# @option params [required, String] :channel_arn
|
3083
|
+
# The ARN of the channel.
|
3084
|
+
#
|
3085
|
+
# @option params [required, String] :channel_moderator_arn
|
3086
|
+
# The ARN of the channel moderator.
|
3087
|
+
#
|
3088
|
+
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3089
|
+
#
|
3090
|
+
# * {Types::DescribeChannelModeratorResponse#channel_moderator #channel_moderator} => Types::ChannelModerator
|
3091
|
+
#
|
3092
|
+
# @example Request syntax with placeholder values
|
3093
|
+
#
|
3094
|
+
# resp = client.describe_channel_moderator({
|
3095
|
+
# channel_arn: "ChimeArn", # required
|
3096
|
+
# channel_moderator_arn: "ChimeArn", # required
|
3097
|
+
# })
|
3098
|
+
#
|
3099
|
+
# @example Response structure
|
3100
|
+
#
|
3101
|
+
# resp.channel_moderator.moderator.arn #=> String
|
3102
|
+
# resp.channel_moderator.moderator.name #=> String
|
3103
|
+
# resp.channel_moderator.channel_arn #=> String
|
3104
|
+
# resp.channel_moderator.created_timestamp #=> Time
|
3105
|
+
# resp.channel_moderator.created_by.arn #=> String
|
3106
|
+
# resp.channel_moderator.created_by.name #=> String
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DescribeChannelModerator AWS API Documentation
|
3109
|
+
#
|
3110
|
+
# @overload describe_channel_moderator(params = {})
|
3111
|
+
# @param [Hash] params ({})
|
3112
|
+
def describe_channel_moderator(params = {}, options = {})
|
3113
|
+
req = build_request(:describe_channel_moderator, params)
|
3114
|
+
req.send_request(options)
|
3115
|
+
end
|
3116
|
+
|
2222
3117
|
# Disassociates the primary provisioned phone number from the specified
|
2223
3118
|
# Amazon Chime user.
|
2224
3119
|
#
|
@@ -2419,15 +3314,75 @@ module Aws::Chime
|
|
2419
3314
|
req.send_request(options)
|
2420
3315
|
end
|
2421
3316
|
|
2422
|
-
# Gets the
|
2423
|
-
# and attendee ID. For more information about the Amazon Chime SDK, see
|
2424
|
-
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
3317
|
+
# Gets the retention settings for an app instance.
|
2425
3318
|
#
|
3319
|
+
# @option params [required, String] :app_instance_arn
|
3320
|
+
# The ARN of the app instance.
|
2426
3321
|
#
|
3322
|
+
# @return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2427
3323
|
#
|
2428
|
-
#
|
3324
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
3325
|
+
# * {Types::GetAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
2429
3326
|
#
|
2430
|
-
# @
|
3327
|
+
# @example Request syntax with placeholder values
|
3328
|
+
#
|
3329
|
+
# resp = client.get_app_instance_retention_settings({
|
3330
|
+
# app_instance_arn: "ChimeArn", # required
|
3331
|
+
# })
|
3332
|
+
#
|
3333
|
+
# @example Response structure
|
3334
|
+
#
|
3335
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
3336
|
+
# resp.initiate_deletion_timestamp #=> Time
|
3337
|
+
#
|
3338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceRetentionSettings AWS API Documentation
|
3339
|
+
#
|
3340
|
+
# @overload get_app_instance_retention_settings(params = {})
|
3341
|
+
# @param [Hash] params ({})
|
3342
|
+
def get_app_instance_retention_settings(params = {}, options = {})
|
3343
|
+
req = build_request(:get_app_instance_retention_settings, params)
|
3344
|
+
req.send_request(options)
|
3345
|
+
end
|
3346
|
+
|
3347
|
+
# Gets the streaming settings for an app instance.
|
3348
|
+
#
|
3349
|
+
# @option params [required, String] :app_instance_arn
|
3350
|
+
# The ARN of the app instance.
|
3351
|
+
#
|
3352
|
+
# @return [Types::GetAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3353
|
+
#
|
3354
|
+
# * {Types::GetAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
3355
|
+
#
|
3356
|
+
# @example Request syntax with placeholder values
|
3357
|
+
#
|
3358
|
+
# resp = client.get_app_instance_streaming_configurations({
|
3359
|
+
# app_instance_arn: "ChimeArn", # required
|
3360
|
+
# })
|
3361
|
+
#
|
3362
|
+
# @example Response structure
|
3363
|
+
#
|
3364
|
+
# resp.app_instance_streaming_configurations #=> Array
|
3365
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
3366
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
3367
|
+
#
|
3368
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetAppInstanceStreamingConfigurations AWS API Documentation
|
3369
|
+
#
|
3370
|
+
# @overload get_app_instance_streaming_configurations(params = {})
|
3371
|
+
# @param [Hash] params ({})
|
3372
|
+
def get_app_instance_streaming_configurations(params = {}, options = {})
|
3373
|
+
req = build_request(:get_app_instance_streaming_configurations, params)
|
3374
|
+
req.send_request(options)
|
3375
|
+
end
|
3376
|
+
|
3377
|
+
# Gets the Amazon Chime SDK attendee details for a specified meeting ID
|
3378
|
+
# and attendee ID. For more information about the Amazon Chime SDK, see
|
3379
|
+
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
3380
|
+
#
|
3381
|
+
#
|
3382
|
+
#
|
3383
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
|
3384
|
+
#
|
3385
|
+
# @option params [required, String] :meeting_id
|
2431
3386
|
# The Amazon Chime SDK meeting ID.
|
2432
3387
|
#
|
2433
3388
|
# @option params [required, String] :attendee_id
|
@@ -2500,6 +3455,49 @@ module Aws::Chime
|
|
2500
3455
|
req.send_request(options)
|
2501
3456
|
end
|
2502
3457
|
|
3458
|
+
# Gets the full details of a channel message.
|
3459
|
+
#
|
3460
|
+
# @option params [required, String] :channel_arn
|
3461
|
+
# The ARN of the channel.
|
3462
|
+
#
|
3463
|
+
# @option params [required, String] :message_id
|
3464
|
+
# The ID of the message.
|
3465
|
+
#
|
3466
|
+
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3467
|
+
#
|
3468
|
+
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
3469
|
+
#
|
3470
|
+
# @example Request syntax with placeholder values
|
3471
|
+
#
|
3472
|
+
# resp = client.get_channel_message({
|
3473
|
+
# channel_arn: "ChimeArn", # required
|
3474
|
+
# message_id: "MessageId", # required
|
3475
|
+
# })
|
3476
|
+
#
|
3477
|
+
# @example Response structure
|
3478
|
+
#
|
3479
|
+
# resp.channel_message.channel_arn #=> String
|
3480
|
+
# resp.channel_message.message_id #=> String
|
3481
|
+
# resp.channel_message.content #=> String
|
3482
|
+
# resp.channel_message.metadata #=> String
|
3483
|
+
# resp.channel_message.type #=> String, one of "STANDARD", "CONTROL"
|
3484
|
+
# resp.channel_message.created_timestamp #=> Time
|
3485
|
+
# resp.channel_message.last_edited_timestamp #=> Time
|
3486
|
+
# resp.channel_message.last_updated_timestamp #=> Time
|
3487
|
+
# resp.channel_message.sender.arn #=> String
|
3488
|
+
# resp.channel_message.sender.name #=> String
|
3489
|
+
# resp.channel_message.redacted #=> Boolean
|
3490
|
+
# resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
|
3491
|
+
#
|
3492
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetChannelMessage AWS API Documentation
|
3493
|
+
#
|
3494
|
+
# @overload get_channel_message(params = {})
|
3495
|
+
# @param [Hash] params ({})
|
3496
|
+
def get_channel_message(params = {}, options = {})
|
3497
|
+
req = build_request(:get_channel_message, params)
|
3498
|
+
req.send_request(options)
|
3499
|
+
end
|
3500
|
+
|
2503
3501
|
# Gets details for an events configuration that allows a bot to receive
|
2504
3502
|
# outgoing events, such as an HTTPS endpoint or Lambda function ARN.
|
2505
3503
|
#
|
@@ -2601,6 +3599,25 @@ module Aws::Chime
|
|
2601
3599
|
req.send_request(options)
|
2602
3600
|
end
|
2603
3601
|
|
3602
|
+
# The endpoint for the messaging session.
|
3603
|
+
#
|
3604
|
+
# @return [Types::GetMessagingSessionEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3605
|
+
#
|
3606
|
+
# * {Types::GetMessagingSessionEndpointResponse#endpoint #endpoint} => Types::MessagingSessionEndpoint
|
3607
|
+
#
|
3608
|
+
# @example Response structure
|
3609
|
+
#
|
3610
|
+
# resp.endpoint.url #=> String
|
3611
|
+
#
|
3612
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/GetMessagingSessionEndpoint AWS API Documentation
|
3613
|
+
#
|
3614
|
+
# @overload get_messaging_session_endpoint(params = {})
|
3615
|
+
# @param [Hash] params ({})
|
3616
|
+
def get_messaging_session_endpoint(params = {}, options = {})
|
3617
|
+
req = build_request(:get_messaging_session_endpoint, params)
|
3618
|
+
req.send_request(options)
|
3619
|
+
end
|
3620
|
+
|
2604
3621
|
# Retrieves details for the specified phone number ID, such as
|
2605
3622
|
# associations, capabilities, and product type.
|
2606
3623
|
#
|
@@ -3124,7 +4141,7 @@ module Aws::Chime
|
|
3124
4141
|
|
3125
4142
|
# Retrieves the logging configuration details for the specified Amazon
|
3126
4143
|
# Chime Voice Connector. Shows whether SIP message logs are enabled for
|
3127
|
-
# sending to Amazon CloudWatch
|
4144
|
+
# sending to Amazon CloudWatch.
|
3128
4145
|
#
|
3129
4146
|
# @option params [required, String] :voice_connector_id
|
3130
4147
|
# The Amazon Chime Voice Connector ID.
|
@@ -3420,137 +4437,646 @@ module Aws::Chime
|
|
3420
4437
|
req.send_request(options)
|
3421
4438
|
end
|
3422
4439
|
|
4440
|
+
# Returns a list of the administrators in the app instance.
|
4441
|
+
#
|
4442
|
+
# @option params [required, String] :app_instance_arn
|
4443
|
+
# The ARN of the app instance.
|
4444
|
+
#
|
4445
|
+
# @option params [Integer] :max_results
|
4446
|
+
# The maximum number of administrators that you want to return.
|
4447
|
+
#
|
4448
|
+
# @option params [String] :next_token
|
4449
|
+
# The token returned from previous API requests until the number of
|
4450
|
+
# administrators is reached.
|
4451
|
+
#
|
4452
|
+
# @return [Types::ListAppInstanceAdminsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4453
|
+
#
|
4454
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_arn #app_instance_arn} => String
|
4455
|
+
# * {Types::ListAppInstanceAdminsResponse#app_instance_admins #app_instance_admins} => Array<Types::AppInstanceAdminSummary>
|
4456
|
+
# * {Types::ListAppInstanceAdminsResponse#next_token #next_token} => String
|
4457
|
+
#
|
4458
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4459
|
+
#
|
4460
|
+
# @example Request syntax with placeholder values
|
4461
|
+
#
|
4462
|
+
# resp = client.list_app_instance_admins({
|
4463
|
+
# app_instance_arn: "ChimeArn", # required
|
4464
|
+
# max_results: 1,
|
4465
|
+
# next_token: "NextToken",
|
4466
|
+
# })
|
4467
|
+
#
|
4468
|
+
# @example Response structure
|
4469
|
+
#
|
4470
|
+
# resp.app_instance_arn #=> String
|
4471
|
+
# resp.app_instance_admins #=> Array
|
4472
|
+
# resp.app_instance_admins[0].admin.arn #=> String
|
4473
|
+
# resp.app_instance_admins[0].admin.name #=> String
|
4474
|
+
# resp.next_token #=> String
|
4475
|
+
#
|
4476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceAdmins AWS API Documentation
|
4477
|
+
#
|
4478
|
+
# @overload list_app_instance_admins(params = {})
|
4479
|
+
# @param [Hash] params ({})
|
4480
|
+
def list_app_instance_admins(params = {}, options = {})
|
4481
|
+
req = build_request(:list_app_instance_admins, params)
|
4482
|
+
req.send_request(options)
|
4483
|
+
end
|
4484
|
+
|
4485
|
+
# List all `AppInstanceUsers` created under a single app instance.
|
4486
|
+
#
|
4487
|
+
# @option params [required, String] :app_instance_arn
|
4488
|
+
# The ARN of the app instance.
|
4489
|
+
#
|
4490
|
+
# @option params [Integer] :max_results
|
4491
|
+
# The maximum number of requests that you want returned.
|
4492
|
+
#
|
4493
|
+
# @option params [String] :next_token
|
4494
|
+
# The token passed by previous API calls until all requested users are
|
4495
|
+
# returned.
|
4496
|
+
#
|
4497
|
+
# @return [Types::ListAppInstanceUsersResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4498
|
+
#
|
4499
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_arn #app_instance_arn} => String
|
4500
|
+
# * {Types::ListAppInstanceUsersResponse#app_instance_users #app_instance_users} => Array<Types::AppInstanceUserSummary>
|
4501
|
+
# * {Types::ListAppInstanceUsersResponse#next_token #next_token} => String
|
4502
|
+
#
|
4503
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4504
|
+
#
|
4505
|
+
# @example Request syntax with placeholder values
|
4506
|
+
#
|
4507
|
+
# resp = client.list_app_instance_users({
|
4508
|
+
# app_instance_arn: "ChimeArn", # required
|
4509
|
+
# max_results: 1,
|
4510
|
+
# next_token: "NextToken",
|
4511
|
+
# })
|
4512
|
+
#
|
4513
|
+
# @example Response structure
|
4514
|
+
#
|
4515
|
+
# resp.app_instance_arn #=> String
|
4516
|
+
# resp.app_instance_users #=> Array
|
4517
|
+
# resp.app_instance_users[0].app_instance_user_arn #=> String
|
4518
|
+
# resp.app_instance_users[0].name #=> String
|
4519
|
+
# resp.app_instance_users[0].metadata #=> String
|
4520
|
+
# resp.next_token #=> String
|
4521
|
+
#
|
4522
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstanceUsers AWS API Documentation
|
4523
|
+
#
|
4524
|
+
# @overload list_app_instance_users(params = {})
|
4525
|
+
# @param [Hash] params ({})
|
4526
|
+
def list_app_instance_users(params = {}, options = {})
|
4527
|
+
req = build_request(:list_app_instance_users, params)
|
4528
|
+
req.send_request(options)
|
4529
|
+
end
|
4530
|
+
|
4531
|
+
# Lists all Amazon Chime app instances created under a single AWS
|
4532
|
+
# account.
|
4533
|
+
#
|
4534
|
+
# @option params [Integer] :max_results
|
4535
|
+
# The maximum number of app instances that you want to return.
|
4536
|
+
#
|
4537
|
+
# @option params [String] :next_token
|
4538
|
+
# The token passed by previous API requests until you reach the maximum
|
4539
|
+
# number of app instances.
|
4540
|
+
#
|
4541
|
+
# @return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4542
|
+
#
|
4543
|
+
# * {Types::ListAppInstancesResponse#app_instances #app_instances} => Array<Types::AppInstanceSummary>
|
4544
|
+
# * {Types::ListAppInstancesResponse#next_token #next_token} => String
|
4545
|
+
#
|
4546
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4547
|
+
#
|
4548
|
+
# @example Request syntax with placeholder values
|
4549
|
+
#
|
4550
|
+
# resp = client.list_app_instances({
|
4551
|
+
# max_results: 1,
|
4552
|
+
# next_token: "NextToken",
|
4553
|
+
# })
|
4554
|
+
#
|
4555
|
+
# @example Response structure
|
4556
|
+
#
|
4557
|
+
# resp.app_instances #=> Array
|
4558
|
+
# resp.app_instances[0].app_instance_arn #=> String
|
4559
|
+
# resp.app_instances[0].name #=> String
|
4560
|
+
# resp.app_instances[0].metadata #=> String
|
4561
|
+
# resp.next_token #=> String
|
4562
|
+
#
|
4563
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAppInstances AWS API Documentation
|
4564
|
+
#
|
4565
|
+
# @overload list_app_instances(params = {})
|
4566
|
+
# @param [Hash] params ({})
|
4567
|
+
def list_app_instances(params = {}, options = {})
|
4568
|
+
req = build_request(:list_app_instances, params)
|
4569
|
+
req.send_request(options)
|
4570
|
+
end
|
4571
|
+
|
3423
4572
|
# Lists the tags applied to an Amazon Chime SDK attendee resource.
|
3424
4573
|
#
|
3425
4574
|
# @option params [required, String] :meeting_id
|
3426
4575
|
# The Amazon Chime SDK meeting ID.
|
3427
4576
|
#
|
3428
|
-
# @option params [required, String] :attendee_id
|
3429
|
-
# The Amazon Chime SDK attendee ID.
|
4577
|
+
# @option params [required, String] :attendee_id
|
4578
|
+
# The Amazon Chime SDK attendee ID.
|
4579
|
+
#
|
4580
|
+
# @return [Types::ListAttendeeTagsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4581
|
+
#
|
4582
|
+
# * {Types::ListAttendeeTagsResponse#tags #tags} => Array<Types::Tag>
|
4583
|
+
#
|
4584
|
+
# @example Request syntax with placeholder values
|
4585
|
+
#
|
4586
|
+
# resp = client.list_attendee_tags({
|
4587
|
+
# meeting_id: "GuidString", # required
|
4588
|
+
# attendee_id: "GuidString", # required
|
4589
|
+
# })
|
4590
|
+
#
|
4591
|
+
# @example Response structure
|
4592
|
+
#
|
4593
|
+
# resp.tags #=> Array
|
4594
|
+
# resp.tags[0].key #=> String
|
4595
|
+
# resp.tags[0].value #=> String
|
4596
|
+
#
|
4597
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendeeTags AWS API Documentation
|
4598
|
+
#
|
4599
|
+
# @overload list_attendee_tags(params = {})
|
4600
|
+
# @param [Hash] params ({})
|
4601
|
+
def list_attendee_tags(params = {}, options = {})
|
4602
|
+
req = build_request(:list_attendee_tags, params)
|
4603
|
+
req.send_request(options)
|
4604
|
+
end
|
4605
|
+
|
4606
|
+
# Lists the attendees for the specified Amazon Chime SDK meeting. For
|
4607
|
+
# more information about the Amazon Chime SDK, see [Using the Amazon
|
4608
|
+
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
4609
|
+
#
|
4610
|
+
#
|
4611
|
+
#
|
4612
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/dg/meetings-sdk.html
|
4613
|
+
#
|
4614
|
+
# @option params [required, String] :meeting_id
|
4615
|
+
# The Amazon Chime SDK meeting ID.
|
4616
|
+
#
|
4617
|
+
# @option params [String] :next_token
|
4618
|
+
# The token to use to retrieve the next page of results.
|
4619
|
+
#
|
4620
|
+
# @option params [Integer] :max_results
|
4621
|
+
# The maximum number of results to return in a single call.
|
4622
|
+
#
|
4623
|
+
# @return [Types::ListAttendeesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4624
|
+
#
|
4625
|
+
# * {Types::ListAttendeesResponse#attendees #attendees} => Array<Types::Attendee>
|
4626
|
+
# * {Types::ListAttendeesResponse#next_token #next_token} => String
|
4627
|
+
#
|
4628
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4629
|
+
#
|
4630
|
+
# @example Request syntax with placeholder values
|
4631
|
+
#
|
4632
|
+
# resp = client.list_attendees({
|
4633
|
+
# meeting_id: "GuidString", # required
|
4634
|
+
# next_token: "String",
|
4635
|
+
# max_results: 1,
|
4636
|
+
# })
|
4637
|
+
#
|
4638
|
+
# @example Response structure
|
4639
|
+
#
|
4640
|
+
# resp.attendees #=> Array
|
4641
|
+
# resp.attendees[0].external_user_id #=> String
|
4642
|
+
# resp.attendees[0].attendee_id #=> String
|
4643
|
+
# resp.attendees[0].join_token #=> String
|
4644
|
+
# resp.next_token #=> String
|
4645
|
+
#
|
4646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListAttendees AWS API Documentation
|
4647
|
+
#
|
4648
|
+
# @overload list_attendees(params = {})
|
4649
|
+
# @param [Hash] params ({})
|
4650
|
+
def list_attendees(params = {}, options = {})
|
4651
|
+
req = build_request(:list_attendees, params)
|
4652
|
+
req.send_request(options)
|
4653
|
+
end
|
4654
|
+
|
4655
|
+
# Lists the bots associated with the administrator's Amazon Chime
|
4656
|
+
# Enterprise account ID.
|
4657
|
+
#
|
4658
|
+
# @option params [required, String] :account_id
|
4659
|
+
# The Amazon Chime account ID.
|
4660
|
+
#
|
4661
|
+
# @option params [Integer] :max_results
|
4662
|
+
# The maximum number of results to return in a single call. The default
|
4663
|
+
# is 10.
|
4664
|
+
#
|
4665
|
+
# @option params [String] :next_token
|
4666
|
+
# The token to use to retrieve the next page of results.
|
4667
|
+
#
|
4668
|
+
# @return [Types::ListBotsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4669
|
+
#
|
4670
|
+
# * {Types::ListBotsResponse#bots #bots} => Array<Types::Bot>
|
4671
|
+
# * {Types::ListBotsResponse#next_token #next_token} => String
|
4672
|
+
#
|
4673
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4674
|
+
#
|
4675
|
+
# @example Request syntax with placeholder values
|
4676
|
+
#
|
4677
|
+
# resp = client.list_bots({
|
4678
|
+
# account_id: "NonEmptyString", # required
|
4679
|
+
# max_results: 1,
|
4680
|
+
# next_token: "String",
|
4681
|
+
# })
|
4682
|
+
#
|
4683
|
+
# @example Response structure
|
4684
|
+
#
|
4685
|
+
# resp.bots #=> Array
|
4686
|
+
# resp.bots[0].bot_id #=> String
|
4687
|
+
# resp.bots[0].user_id #=> String
|
4688
|
+
# resp.bots[0].display_name #=> String
|
4689
|
+
# resp.bots[0].bot_type #=> String, one of "ChatBot"
|
4690
|
+
# resp.bots[0].disabled #=> Boolean
|
4691
|
+
# resp.bots[0].created_timestamp #=> Time
|
4692
|
+
# resp.bots[0].updated_timestamp #=> Time
|
4693
|
+
# resp.bots[0].bot_email #=> String
|
4694
|
+
# resp.bots[0].security_token #=> String
|
4695
|
+
# resp.next_token #=> String
|
4696
|
+
#
|
4697
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListBots AWS API Documentation
|
4698
|
+
#
|
4699
|
+
# @overload list_bots(params = {})
|
4700
|
+
# @param [Hash] params ({})
|
4701
|
+
def list_bots(params = {}, options = {})
|
4702
|
+
req = build_request(:list_bots, params)
|
4703
|
+
req.send_request(options)
|
4704
|
+
end
|
4705
|
+
|
4706
|
+
# Lists all the users banned from a particular channel.
|
4707
|
+
#
|
4708
|
+
# @option params [required, String] :channel_arn
|
4709
|
+
# The ARN of the channel.
|
4710
|
+
#
|
4711
|
+
# @option params [Integer] :max_results
|
4712
|
+
# The maximum number of bans that you want returned.
|
4713
|
+
#
|
4714
|
+
# @option params [String] :next_token
|
4715
|
+
# The token passed by previous API calls until all requested bans are
|
4716
|
+
# returned.
|
4717
|
+
#
|
4718
|
+
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4719
|
+
#
|
4720
|
+
# * {Types::ListChannelBansResponse#channel_arn #channel_arn} => String
|
4721
|
+
# * {Types::ListChannelBansResponse#next_token #next_token} => String
|
4722
|
+
# * {Types::ListChannelBansResponse#channel_bans #channel_bans} => Array<Types::ChannelBanSummary>
|
4723
|
+
#
|
4724
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4725
|
+
#
|
4726
|
+
# @example Request syntax with placeholder values
|
4727
|
+
#
|
4728
|
+
# resp = client.list_channel_bans({
|
4729
|
+
# channel_arn: "ChimeArn", # required
|
4730
|
+
# max_results: 1,
|
4731
|
+
# next_token: "NextToken",
|
4732
|
+
# })
|
4733
|
+
#
|
4734
|
+
# @example Response structure
|
4735
|
+
#
|
4736
|
+
# resp.channel_arn #=> String
|
4737
|
+
# resp.next_token #=> String
|
4738
|
+
# resp.channel_bans #=> Array
|
4739
|
+
# resp.channel_bans[0].member.arn #=> String
|
4740
|
+
# resp.channel_bans[0].member.name #=> String
|
4741
|
+
#
|
4742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelBans AWS API Documentation
|
4743
|
+
#
|
4744
|
+
# @overload list_channel_bans(params = {})
|
4745
|
+
# @param [Hash] params ({})
|
4746
|
+
def list_channel_bans(params = {}, options = {})
|
4747
|
+
req = build_request(:list_channel_bans, params)
|
4748
|
+
req.send_request(options)
|
4749
|
+
end
|
4750
|
+
|
4751
|
+
# Lists all channel memberships in a channel.
|
4752
|
+
#
|
4753
|
+
# @option params [required, String] :channel_arn
|
4754
|
+
# The maximum number of channel memberships that you want returned.
|
4755
|
+
#
|
4756
|
+
# @option params [String] :type
|
4757
|
+
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
4758
|
+
# are always returned as part of `ListChannelMemberships`. Hidden
|
4759
|
+
# members are only returned if the type filter in
|
4760
|
+
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
4761
|
+
# not returned.
|
4762
|
+
#
|
4763
|
+
# @option params [Integer] :max_results
|
4764
|
+
# The maximum number of channel memberships that you want returned.
|
4765
|
+
#
|
4766
|
+
# @option params [String] :next_token
|
4767
|
+
# The token passed by previous API calls until all requested channel
|
4768
|
+
# memberships are returned..
|
4769
|
+
#
|
4770
|
+
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4771
|
+
#
|
4772
|
+
# * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
|
4773
|
+
# * {Types::ListChannelMembershipsResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipSummary>
|
4774
|
+
# * {Types::ListChannelMembershipsResponse#next_token #next_token} => String
|
4775
|
+
#
|
4776
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4777
|
+
#
|
4778
|
+
# @example Request syntax with placeholder values
|
4779
|
+
#
|
4780
|
+
# resp = client.list_channel_memberships({
|
4781
|
+
# channel_arn: "ChimeArn", # required
|
4782
|
+
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
4783
|
+
# max_results: 1,
|
4784
|
+
# next_token: "NextToken",
|
4785
|
+
# })
|
4786
|
+
#
|
4787
|
+
# @example Response structure
|
4788
|
+
#
|
4789
|
+
# resp.channel_arn #=> String
|
4790
|
+
# resp.channel_memberships #=> Array
|
4791
|
+
# resp.channel_memberships[0].member.arn #=> String
|
4792
|
+
# resp.channel_memberships[0].member.name #=> String
|
4793
|
+
# resp.next_token #=> String
|
4794
|
+
#
|
4795
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMemberships AWS API Documentation
|
4796
|
+
#
|
4797
|
+
# @overload list_channel_memberships(params = {})
|
4798
|
+
# @param [Hash] params ({})
|
4799
|
+
def list_channel_memberships(params = {}, options = {})
|
4800
|
+
req = build_request(:list_channel_memberships, params)
|
4801
|
+
req.send_request(options)
|
4802
|
+
end
|
4803
|
+
|
4804
|
+
# Lists all channels that a particular `AppInstanceUser` is a part of.
|
4805
|
+
# Only an `AppInstanceAdmin` can call the API with a user ARN that is
|
4806
|
+
# not their own.
|
4807
|
+
#
|
4808
|
+
# @option params [String] :app_instance_user_arn
|
4809
|
+
# The ARN of the app instance users
|
4810
|
+
#
|
4811
|
+
# @option params [Integer] :max_results
|
4812
|
+
# The maximum number of users that you want returned.
|
4813
|
+
#
|
4814
|
+
# @option params [String] :next_token
|
4815
|
+
# The token returned from previous API requests until the number of
|
4816
|
+
# channel memberships is reached.
|
4817
|
+
#
|
4818
|
+
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4819
|
+
#
|
4820
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipForAppInstanceUserSummary>
|
4821
|
+
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#next_token #next_token} => String
|
4822
|
+
#
|
4823
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4824
|
+
#
|
4825
|
+
# @example Request syntax with placeholder values
|
4826
|
+
#
|
4827
|
+
# resp = client.list_channel_memberships_for_app_instance_user({
|
4828
|
+
# app_instance_user_arn: "ChimeArn",
|
4829
|
+
# max_results: 1,
|
4830
|
+
# next_token: "NextToken",
|
4831
|
+
# })
|
4832
|
+
#
|
4833
|
+
# @example Response structure
|
4834
|
+
#
|
4835
|
+
# resp.channel_memberships #=> Array
|
4836
|
+
# resp.channel_memberships[0].channel_summary.name #=> String
|
4837
|
+
# resp.channel_memberships[0].channel_summary.channel_arn #=> String
|
4838
|
+
# resp.channel_memberships[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
4839
|
+
# resp.channel_memberships[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
4840
|
+
# resp.channel_memberships[0].channel_summary.metadata #=> String
|
4841
|
+
# resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
|
4842
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
4843
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
4844
|
+
# resp.next_token #=> String
|
4845
|
+
#
|
4846
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMembershipsForAppInstanceUser AWS API Documentation
|
4847
|
+
#
|
4848
|
+
# @overload list_channel_memberships_for_app_instance_user(params = {})
|
4849
|
+
# @param [Hash] params ({})
|
4850
|
+
def list_channel_memberships_for_app_instance_user(params = {}, options = {})
|
4851
|
+
req = build_request(:list_channel_memberships_for_app_instance_user, params)
|
4852
|
+
req.send_request(options)
|
4853
|
+
end
|
4854
|
+
|
4855
|
+
# List all the messages in a channel. Returns a paginated list of
|
4856
|
+
# `ChannelMessages`. Sorted in descending order by default, based on the
|
4857
|
+
# creation timestamp.
|
4858
|
+
#
|
4859
|
+
# <note markdown="1"> Redacted messages appear in the results as empty, since they are only
|
4860
|
+
# redacted, not deleted. Deleted messages do not appear in the results.
|
4861
|
+
# This action always returns the latest version of an edited message.
|
4862
|
+
#
|
4863
|
+
# </note>
|
4864
|
+
#
|
4865
|
+
# @option params [required, String] :channel_arn
|
4866
|
+
# The ARN of the channel.
|
4867
|
+
#
|
4868
|
+
# @option params [String] :sort_order
|
4869
|
+
# The order in which you want messages sorted. Default is Descending,
|
4870
|
+
# based on time created.
|
4871
|
+
#
|
4872
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_before
|
4873
|
+
# The initial or starting time stamp for your requested messages.
|
4874
|
+
#
|
4875
|
+
# @option params [Time,DateTime,Date,Integer,String] :not_after
|
4876
|
+
# The final or ending time stamp for your requested messages.
|
4877
|
+
#
|
4878
|
+
# @option params [Integer] :max_results
|
4879
|
+
# The maximum number of messages that you want returned.
|
4880
|
+
#
|
4881
|
+
# @option params [String] :next_token
|
4882
|
+
# The token passed by previous API calls until all requested messages
|
4883
|
+
# are returned.
|
4884
|
+
#
|
4885
|
+
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4886
|
+
#
|
4887
|
+
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
4888
|
+
# * {Types::ListChannelMessagesResponse#next_token #next_token} => String
|
4889
|
+
# * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array<Types::ChannelMessageSummary>
|
4890
|
+
#
|
4891
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4892
|
+
#
|
4893
|
+
# @example Request syntax with placeholder values
|
4894
|
+
#
|
4895
|
+
# resp = client.list_channel_messages({
|
4896
|
+
# channel_arn: "ChimeArn", # required
|
4897
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
4898
|
+
# not_before: Time.now,
|
4899
|
+
# not_after: Time.now,
|
4900
|
+
# max_results: 1,
|
4901
|
+
# next_token: "NextToken",
|
4902
|
+
# })
|
4903
|
+
#
|
4904
|
+
# @example Response structure
|
4905
|
+
#
|
4906
|
+
# resp.channel_arn #=> String
|
4907
|
+
# resp.next_token #=> String
|
4908
|
+
# resp.channel_messages #=> Array
|
4909
|
+
# resp.channel_messages[0].message_id #=> String
|
4910
|
+
# resp.channel_messages[0].content #=> String
|
4911
|
+
# resp.channel_messages[0].metadata #=> String
|
4912
|
+
# resp.channel_messages[0].type #=> String, one of "STANDARD", "CONTROL"
|
4913
|
+
# resp.channel_messages[0].created_timestamp #=> Time
|
4914
|
+
# resp.channel_messages[0].last_updated_timestamp #=> Time
|
4915
|
+
# resp.channel_messages[0].last_edited_timestamp #=> Time
|
4916
|
+
# resp.channel_messages[0].sender.arn #=> String
|
4917
|
+
# resp.channel_messages[0].sender.name #=> String
|
4918
|
+
# resp.channel_messages[0].redacted #=> Boolean
|
4919
|
+
#
|
4920
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelMessages AWS API Documentation
|
4921
|
+
#
|
4922
|
+
# @overload list_channel_messages(params = {})
|
4923
|
+
# @param [Hash] params ({})
|
4924
|
+
def list_channel_messages(params = {}, options = {})
|
4925
|
+
req = build_request(:list_channel_messages, params)
|
4926
|
+
req.send_request(options)
|
4927
|
+
end
|
4928
|
+
|
4929
|
+
# Lists all the moderators for a channel.
|
4930
|
+
#
|
4931
|
+
# @option params [required, String] :channel_arn
|
4932
|
+
# The ARN of the channel.
|
4933
|
+
#
|
4934
|
+
# @option params [Integer] :max_results
|
4935
|
+
# The maximum number of moderators that you want returned.
|
4936
|
+
#
|
4937
|
+
# @option params [String] :next_token
|
4938
|
+
# The token passed by previous API calls until all requested moderators
|
4939
|
+
# are returned.
|
4940
|
+
#
|
4941
|
+
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3430
4942
|
#
|
3431
|
-
#
|
4943
|
+
# * {Types::ListChannelModeratorsResponse#channel_arn #channel_arn} => String
|
4944
|
+
# * {Types::ListChannelModeratorsResponse#next_token #next_token} => String
|
4945
|
+
# * {Types::ListChannelModeratorsResponse#channel_moderators #channel_moderators} => Array<Types::ChannelModeratorSummary>
|
3432
4946
|
#
|
3433
|
-
#
|
4947
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3434
4948
|
#
|
3435
4949
|
# @example Request syntax with placeholder values
|
3436
4950
|
#
|
3437
|
-
# resp = client.
|
3438
|
-
#
|
3439
|
-
#
|
4951
|
+
# resp = client.list_channel_moderators({
|
4952
|
+
# channel_arn: "ChimeArn", # required
|
4953
|
+
# max_results: 1,
|
4954
|
+
# next_token: "NextToken",
|
3440
4955
|
# })
|
3441
4956
|
#
|
3442
4957
|
# @example Response structure
|
3443
4958
|
#
|
3444
|
-
# resp.
|
3445
|
-
# resp.
|
3446
|
-
# resp.
|
4959
|
+
# resp.channel_arn #=> String
|
4960
|
+
# resp.next_token #=> String
|
4961
|
+
# resp.channel_moderators #=> Array
|
4962
|
+
# resp.channel_moderators[0].moderator.arn #=> String
|
4963
|
+
# resp.channel_moderators[0].moderator.name #=> String
|
3447
4964
|
#
|
3448
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
4965
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelModerators AWS API Documentation
|
3449
4966
|
#
|
3450
|
-
# @overload
|
4967
|
+
# @overload list_channel_moderators(params = {})
|
3451
4968
|
# @param [Hash] params ({})
|
3452
|
-
def
|
3453
|
-
req = build_request(:
|
4969
|
+
def list_channel_moderators(params = {}, options = {})
|
4970
|
+
req = build_request(:list_channel_moderators, params)
|
3454
4971
|
req.send_request(options)
|
3455
4972
|
end
|
3456
4973
|
|
3457
|
-
# Lists
|
3458
|
-
#
|
3459
|
-
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
4974
|
+
# Lists all Channels created under a single Chime App as a paginated
|
4975
|
+
# list. You can specify filters to narrow results.
|
3460
4976
|
#
|
4977
|
+
# **Functionality & restrictions**
|
3461
4978
|
#
|
4979
|
+
# * Use privacy = `PUBLIC` to retrieve all public channels in the
|
4980
|
+
# account
|
3462
4981
|
#
|
3463
|
-
#
|
4982
|
+
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
4983
|
+
# private channels in an account.
|
3464
4984
|
#
|
3465
|
-
# @option params [required, String] :
|
3466
|
-
# The
|
4985
|
+
# @option params [required, String] :app_instance_arn
|
4986
|
+
# The ARN of the app instance.
|
3467
4987
|
#
|
3468
|
-
# @option params [String] :
|
3469
|
-
# The
|
4988
|
+
# @option params [String] :privacy
|
4989
|
+
# The privacy setting. `PUBLIC` retrieves all the public channels.
|
4990
|
+
# `PRIVATE` retrieves private channels. Only an app instance
|
4991
|
+
# administrator can retrieve private channels.
|
3470
4992
|
#
|
3471
4993
|
# @option params [Integer] :max_results
|
3472
|
-
# The maximum number of
|
4994
|
+
# The maximum number of channels that you want to return.
|
3473
4995
|
#
|
3474
|
-
# @
|
4996
|
+
# @option params [String] :next_token
|
4997
|
+
# The token passed by previous API calls until all requested channels
|
4998
|
+
# are returned.
|
3475
4999
|
#
|
3476
|
-
#
|
3477
|
-
#
|
5000
|
+
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5001
|
+
#
|
5002
|
+
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
5003
|
+
# * {Types::ListChannelsResponse#next_token #next_token} => String
|
3478
5004
|
#
|
3479
5005
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3480
5006
|
#
|
3481
5007
|
# @example Request syntax with placeholder values
|
3482
5008
|
#
|
3483
|
-
# resp = client.
|
3484
|
-
#
|
3485
|
-
#
|
5009
|
+
# resp = client.list_channels({
|
5010
|
+
# app_instance_arn: "ChimeArn", # required
|
5011
|
+
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
3486
5012
|
# max_results: 1,
|
5013
|
+
# next_token: "NextToken",
|
3487
5014
|
# })
|
3488
5015
|
#
|
3489
5016
|
# @example Response structure
|
3490
5017
|
#
|
3491
|
-
# resp.
|
3492
|
-
# resp.
|
3493
|
-
# resp.
|
3494
|
-
# resp.
|
5018
|
+
# resp.channels #=> Array
|
5019
|
+
# resp.channels[0].name #=> String
|
5020
|
+
# resp.channels[0].channel_arn #=> String
|
5021
|
+
# resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5022
|
+
# resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5023
|
+
# resp.channels[0].metadata #=> String
|
5024
|
+
# resp.channels[0].last_message_timestamp #=> Time
|
3495
5025
|
# resp.next_token #=> String
|
3496
5026
|
#
|
3497
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5027
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannels AWS API Documentation
|
3498
5028
|
#
|
3499
|
-
# @overload
|
5029
|
+
# @overload list_channels(params = {})
|
3500
5030
|
# @param [Hash] params ({})
|
3501
|
-
def
|
3502
|
-
req = build_request(:
|
5031
|
+
def list_channels(params = {}, options = {})
|
5032
|
+
req = build_request(:list_channels, params)
|
3503
5033
|
req.send_request(options)
|
3504
5034
|
end
|
3505
5035
|
|
3506
|
-
#
|
3507
|
-
# Enterprise account ID.
|
5036
|
+
# A list of the channels moderated by an app instance user.
|
3508
5037
|
#
|
3509
|
-
# @option params [
|
3510
|
-
# The
|
5038
|
+
# @option params [String] :app_instance_user_arn
|
5039
|
+
# The ARN of the user in the moderated channel.
|
3511
5040
|
#
|
3512
5041
|
# @option params [Integer] :max_results
|
3513
|
-
# The maximum number of
|
3514
|
-
# is 10.
|
5042
|
+
# The maximum number of channels in the request.
|
3515
5043
|
#
|
3516
5044
|
# @option params [String] :next_token
|
3517
|
-
# The token
|
5045
|
+
# The token returned from previous API requests until the number of
|
5046
|
+
# channels moderated by the user is reached.
|
3518
5047
|
#
|
3519
|
-
# @return [Types::
|
5048
|
+
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3520
5049
|
#
|
3521
|
-
# * {Types::
|
3522
|
-
# * {Types::
|
5050
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#channels #channels} => Array<Types::ChannelModeratedByAppInstanceUserSummary>
|
5051
|
+
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#next_token #next_token} => String
|
3523
5052
|
#
|
3524
5053
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3525
5054
|
#
|
3526
5055
|
# @example Request syntax with placeholder values
|
3527
5056
|
#
|
3528
|
-
# resp = client.
|
3529
|
-
#
|
5057
|
+
# resp = client.list_channels_moderated_by_app_instance_user({
|
5058
|
+
# app_instance_user_arn: "ChimeArn",
|
3530
5059
|
# max_results: 1,
|
3531
|
-
# next_token: "
|
5060
|
+
# next_token: "NextToken",
|
3532
5061
|
# })
|
3533
5062
|
#
|
3534
5063
|
# @example Response structure
|
3535
5064
|
#
|
3536
|
-
# resp.
|
3537
|
-
# resp.
|
3538
|
-
# resp.
|
3539
|
-
# resp.
|
3540
|
-
# resp.
|
3541
|
-
# resp.
|
3542
|
-
# resp.
|
3543
|
-
# resp.bots[0].updated_timestamp #=> Time
|
3544
|
-
# resp.bots[0].bot_email #=> String
|
3545
|
-
# resp.bots[0].security_token #=> String
|
5065
|
+
# resp.channels #=> Array
|
5066
|
+
# resp.channels[0].channel_summary.name #=> String
|
5067
|
+
# resp.channels[0].channel_summary.channel_arn #=> String
|
5068
|
+
# resp.channels[0].channel_summary.mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
5069
|
+
# resp.channels[0].channel_summary.privacy #=> String, one of "PUBLIC", "PRIVATE"
|
5070
|
+
# resp.channels[0].channel_summary.metadata #=> String
|
5071
|
+
# resp.channels[0].channel_summary.last_message_timestamp #=> Time
|
3546
5072
|
# resp.next_token #=> String
|
3547
5073
|
#
|
3548
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/
|
5074
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/ListChannelsModeratedByAppInstanceUser AWS API Documentation
|
3549
5075
|
#
|
3550
|
-
# @overload
|
5076
|
+
# @overload list_channels_moderated_by_app_instance_user(params = {})
|
3551
5077
|
# @param [Hash] params ({})
|
3552
|
-
def
|
3553
|
-
req = build_request(:
|
5078
|
+
def list_channels_moderated_by_app_instance_user(params = {}, options = {})
|
5079
|
+
req = build_request(:list_channels_moderated_by_app_instance_user, params)
|
3554
5080
|
req.send_request(options)
|
3555
5081
|
end
|
3556
5082
|
|
@@ -3939,6 +5465,8 @@ module Aws::Chime
|
|
3939
5465
|
# * {Types::ListSipMediaApplicationsResponse#sip_media_applications #sip_media_applications} => Array<Types::SipMediaApplication>
|
3940
5466
|
# * {Types::ListSipMediaApplicationsResponse#next_token #next_token} => String
|
3941
5467
|
#
|
5468
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5469
|
+
#
|
3942
5470
|
# @example Request syntax with placeholder values
|
3943
5471
|
#
|
3944
5472
|
# resp = client.list_sip_media_applications({
|
@@ -3984,6 +5512,8 @@ module Aws::Chime
|
|
3984
5512
|
# * {Types::ListSipRulesResponse#sip_rules #sip_rules} => Array<Types::SipRule>
|
3985
5513
|
# * {Types::ListSipRulesResponse#next_token #next_token} => String
|
3986
5514
|
#
|
5515
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5516
|
+
#
|
3987
5517
|
# @example Request syntax with placeholder values
|
3988
5518
|
#
|
3989
5519
|
# resp = client.list_sip_rules({
|
@@ -4257,6 +5787,84 @@ module Aws::Chime
|
|
4257
5787
|
req.send_request(options)
|
4258
5788
|
end
|
4259
5789
|
|
5790
|
+
# Sets the amount of time in days that a given app instance retains
|
5791
|
+
# data.
|
5792
|
+
#
|
5793
|
+
# @option params [required, String] :app_instance_arn
|
5794
|
+
# The ARN of the app instance.
|
5795
|
+
#
|
5796
|
+
# @option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings
|
5797
|
+
# The time in days to retain data. Data type: number.
|
5798
|
+
#
|
5799
|
+
# @return [Types::PutAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5800
|
+
#
|
5801
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#app_instance_retention_settings #app_instance_retention_settings} => Types::AppInstanceRetentionSettings
|
5802
|
+
# * {Types::PutAppInstanceRetentionSettingsResponse#initiate_deletion_timestamp #initiate_deletion_timestamp} => Time
|
5803
|
+
#
|
5804
|
+
# @example Request syntax with placeholder values
|
5805
|
+
#
|
5806
|
+
# resp = client.put_app_instance_retention_settings({
|
5807
|
+
# app_instance_arn: "ChimeArn", # required
|
5808
|
+
# app_instance_retention_settings: { # required
|
5809
|
+
# channel_retention_settings: {
|
5810
|
+
# retention_days: 1,
|
5811
|
+
# },
|
5812
|
+
# },
|
5813
|
+
# })
|
5814
|
+
#
|
5815
|
+
# @example Response structure
|
5816
|
+
#
|
5817
|
+
# resp.app_instance_retention_settings.channel_retention_settings.retention_days #=> Integer
|
5818
|
+
# resp.initiate_deletion_timestamp #=> Time
|
5819
|
+
#
|
5820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceRetentionSettings AWS API Documentation
|
5821
|
+
#
|
5822
|
+
# @overload put_app_instance_retention_settings(params = {})
|
5823
|
+
# @param [Hash] params ({})
|
5824
|
+
def put_app_instance_retention_settings(params = {}, options = {})
|
5825
|
+
req = build_request(:put_app_instance_retention_settings, params)
|
5826
|
+
req.send_request(options)
|
5827
|
+
end
|
5828
|
+
|
5829
|
+
# The data streaming configurations of an app instance.
|
5830
|
+
#
|
5831
|
+
# @option params [required, String] :app_instance_arn
|
5832
|
+
# The ARN of the app instance.
|
5833
|
+
#
|
5834
|
+
# @option params [required, Array<Types::AppInstanceStreamingConfiguration>] :app_instance_streaming_configurations
|
5835
|
+
# The streaming configurations set for an app instance.
|
5836
|
+
#
|
5837
|
+
# @return [Types::PutAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5838
|
+
#
|
5839
|
+
# * {Types::PutAppInstanceStreamingConfigurationsResponse#app_instance_streaming_configurations #app_instance_streaming_configurations} => Array<Types::AppInstanceStreamingConfiguration>
|
5840
|
+
#
|
5841
|
+
# @example Request syntax with placeholder values
|
5842
|
+
#
|
5843
|
+
# resp = client.put_app_instance_streaming_configurations({
|
5844
|
+
# app_instance_arn: "ChimeArn", # required
|
5845
|
+
# app_instance_streaming_configurations: [ # required
|
5846
|
+
# {
|
5847
|
+
# app_instance_data_type: "Channel", # required, accepts Channel, ChannelMessage
|
5848
|
+
# resource_arn: "Arn", # required
|
5849
|
+
# },
|
5850
|
+
# ],
|
5851
|
+
# })
|
5852
|
+
#
|
5853
|
+
# @example Response structure
|
5854
|
+
#
|
5855
|
+
# resp.app_instance_streaming_configurations #=> Array
|
5856
|
+
# resp.app_instance_streaming_configurations[0].app_instance_data_type #=> String, one of "Channel", "ChannelMessage"
|
5857
|
+
# resp.app_instance_streaming_configurations[0].resource_arn #=> String
|
5858
|
+
#
|
5859
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/PutAppInstanceStreamingConfigurations AWS API Documentation
|
5860
|
+
#
|
5861
|
+
# @overload put_app_instance_streaming_configurations(params = {})
|
5862
|
+
# @param [Hash] params ({})
|
5863
|
+
def put_app_instance_streaming_configurations(params = {}, options = {})
|
5864
|
+
req = build_request(:put_app_instance_streaming_configurations, params)
|
5865
|
+
req.send_request(options)
|
5866
|
+
end
|
5867
|
+
|
4260
5868
|
# Creates an events configuration that allows a bot to receive outgoing
|
4261
5869
|
# events sent by Amazon Chime. Choose either an HTTPS endpoint or a
|
4262
5870
|
# Lambda function ARN. For more information, see Bot.
|
@@ -4711,6 +6319,43 @@ module Aws::Chime
|
|
4711
6319
|
req.send_request(options)
|
4712
6320
|
end
|
4713
6321
|
|
6322
|
+
# Redacts message content, but not metadata. The message exists in the
|
6323
|
+
# back end, but the action returns null content, and the state shows as
|
6324
|
+
# redacted.
|
6325
|
+
#
|
6326
|
+
# @option params [required, String] :channel_arn
|
6327
|
+
# The ARN of the channel containing the messages that you want to
|
6328
|
+
# redact.
|
6329
|
+
#
|
6330
|
+
# @option params [required, String] :message_id
|
6331
|
+
# The ID of the message being redacted.
|
6332
|
+
#
|
6333
|
+
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6334
|
+
#
|
6335
|
+
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
6336
|
+
# * {Types::RedactChannelMessageResponse#message_id #message_id} => String
|
6337
|
+
#
|
6338
|
+
# @example Request syntax with placeholder values
|
6339
|
+
#
|
6340
|
+
# resp = client.redact_channel_message({
|
6341
|
+
# channel_arn: "ChimeArn", # required
|
6342
|
+
# message_id: "MessageId", # required
|
6343
|
+
# })
|
6344
|
+
#
|
6345
|
+
# @example Response structure
|
6346
|
+
#
|
6347
|
+
# resp.channel_arn #=> String
|
6348
|
+
# resp.message_id #=> String
|
6349
|
+
#
|
6350
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/RedactChannelMessage AWS API Documentation
|
6351
|
+
#
|
6352
|
+
# @overload redact_channel_message(params = {})
|
6353
|
+
# @param [Hash] params ({})
|
6354
|
+
def redact_channel_message(params = {}, options = {})
|
6355
|
+
req = build_request(:redact_channel_message, params)
|
6356
|
+
req.send_request(options)
|
6357
|
+
end
|
6358
|
+
|
4714
6359
|
# Redacts the specified message from the specified Amazon Chime
|
4715
6360
|
# conversation.
|
4716
6361
|
#
|
@@ -4742,8 +6387,7 @@ module Aws::Chime
|
|
4742
6387
|
req.send_request(options)
|
4743
6388
|
end
|
4744
6389
|
|
4745
|
-
# Redacts the specified message from the specified Amazon Chime
|
4746
|
-
# room.
|
6390
|
+
# Redacts the specified message from the specified Amazon Chime channel.
|
4747
6391
|
#
|
4748
6392
|
# @option params [required, String] :account_id
|
4749
6393
|
# The Amazon Chime account ID.
|
@@ -4961,6 +6605,65 @@ module Aws::Chime
|
|
4961
6605
|
req.send_request(options)
|
4962
6606
|
end
|
4963
6607
|
|
6608
|
+
# Sends a message to a particular channel that the member is a part of.
|
6609
|
+
#
|
6610
|
+
# <note markdown="1"> `STANDARD` messages can contain 4KB of data and the 1KB of metadata.
|
6611
|
+
# `CONTROL` messages can contain 30 bytes of data and no metadata.
|
6612
|
+
#
|
6613
|
+
# </note>
|
6614
|
+
#
|
6615
|
+
# @option params [required, String] :channel_arn
|
6616
|
+
# The ARN of the channel.
|
6617
|
+
#
|
6618
|
+
# @option params [required, String] :content
|
6619
|
+
# The content of the message.
|
6620
|
+
#
|
6621
|
+
# @option params [required, String] :type
|
6622
|
+
# The type of message, `STANDARD` or `CONTROL`.
|
6623
|
+
#
|
6624
|
+
# @option params [required, String] :persistence
|
6625
|
+
# Boolean that controls whether the message is persisted on the back
|
6626
|
+
# end. Required.
|
6627
|
+
#
|
6628
|
+
# @option params [String] :metadata
|
6629
|
+
# The optional metadata for each message.
|
6630
|
+
#
|
6631
|
+
# @option params [required, String] :client_request_token
|
6632
|
+
# The `Idempotency` token for each client request.
|
6633
|
+
#
|
6634
|
+
# **A suitable default value is auto-generated.** You should normally
|
6635
|
+
# not need to pass this option.**
|
6636
|
+
#
|
6637
|
+
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6638
|
+
#
|
6639
|
+
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
6640
|
+
# * {Types::SendChannelMessageResponse#message_id #message_id} => String
|
6641
|
+
#
|
6642
|
+
# @example Request syntax with placeholder values
|
6643
|
+
#
|
6644
|
+
# resp = client.send_channel_message({
|
6645
|
+
# channel_arn: "ChimeArn", # required
|
6646
|
+
# content: "NonEmptyContent", # required
|
6647
|
+
# type: "STANDARD", # required, accepts STANDARD, CONTROL
|
6648
|
+
# persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
|
6649
|
+
# metadata: "Metadata",
|
6650
|
+
# client_request_token: "ClientRequestToken", # required
|
6651
|
+
# })
|
6652
|
+
#
|
6653
|
+
# @example Response structure
|
6654
|
+
#
|
6655
|
+
# resp.channel_arn #=> String
|
6656
|
+
# resp.message_id #=> String
|
6657
|
+
#
|
6658
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/SendChannelMessage AWS API Documentation
|
6659
|
+
#
|
6660
|
+
# @overload send_channel_message(params = {})
|
6661
|
+
# @param [Hash] params ({})
|
6662
|
+
def send_channel_message(params = {}, options = {})
|
6663
|
+
req = build_request(:send_channel_message, params)
|
6664
|
+
req.send_request(options)
|
6665
|
+
end
|
6666
|
+
|
4964
6667
|
# Applies the specified tags to the specified Amazon Chime SDK attendee.
|
4965
6668
|
#
|
4966
6669
|
# @option params [required, String] :meeting_id
|
@@ -5221,6 +6924,79 @@ module Aws::Chime
|
|
5221
6924
|
req.send_request(options)
|
5222
6925
|
end
|
5223
6926
|
|
6927
|
+
# Updates `AppInstance` metadata.
|
6928
|
+
#
|
6929
|
+
# @option params [required, String] :app_instance_arn
|
6930
|
+
# The ARN of the app instance.
|
6931
|
+
#
|
6932
|
+
# @option params [required, String] :name
|
6933
|
+
# The name that you want to change.
|
6934
|
+
#
|
6935
|
+
# @option params [String] :metadata
|
6936
|
+
# The metadata that you want to change.
|
6937
|
+
#
|
6938
|
+
# @return [Types::UpdateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6939
|
+
#
|
6940
|
+
# * {Types::UpdateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
6941
|
+
#
|
6942
|
+
# @example Request syntax with placeholder values
|
6943
|
+
#
|
6944
|
+
# resp = client.update_app_instance({
|
6945
|
+
# app_instance_arn: "ChimeArn", # required
|
6946
|
+
# name: "NonEmptyResourceName", # required
|
6947
|
+
# metadata: "Metadata",
|
6948
|
+
# })
|
6949
|
+
#
|
6950
|
+
# @example Response structure
|
6951
|
+
#
|
6952
|
+
# resp.app_instance_arn #=> String
|
6953
|
+
#
|
6954
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstance AWS API Documentation
|
6955
|
+
#
|
6956
|
+
# @overload update_app_instance(params = {})
|
6957
|
+
# @param [Hash] params ({})
|
6958
|
+
def update_app_instance(params = {}, options = {})
|
6959
|
+
req = build_request(:update_app_instance, params)
|
6960
|
+
req.send_request(options)
|
6961
|
+
end
|
6962
|
+
|
6963
|
+
# Updates the details for an `AppInstanceUser`. You can update names and
|
6964
|
+
# metadata.
|
6965
|
+
#
|
6966
|
+
# @option params [required, String] :app_instance_user_arn
|
6967
|
+
# The ARN of the app instance user.
|
6968
|
+
#
|
6969
|
+
# @option params [required, String] :name
|
6970
|
+
# The name of the app instance user.
|
6971
|
+
#
|
6972
|
+
# @option params [String] :metadata
|
6973
|
+
# The metadata of the app instance user.
|
6974
|
+
#
|
6975
|
+
# @return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6976
|
+
#
|
6977
|
+
# * {Types::UpdateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
6978
|
+
#
|
6979
|
+
# @example Request syntax with placeholder values
|
6980
|
+
#
|
6981
|
+
# resp = client.update_app_instance_user({
|
6982
|
+
# app_instance_user_arn: "ChimeArn", # required
|
6983
|
+
# name: "UserName", # required
|
6984
|
+
# metadata: "Metadata",
|
6985
|
+
# })
|
6986
|
+
#
|
6987
|
+
# @example Response structure
|
6988
|
+
#
|
6989
|
+
# resp.app_instance_user_arn #=> String
|
6990
|
+
#
|
6991
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateAppInstanceUser AWS API Documentation
|
6992
|
+
#
|
6993
|
+
# @overload update_app_instance_user(params = {})
|
6994
|
+
# @param [Hash] params ({})
|
6995
|
+
def update_app_instance_user(params = {}, options = {})
|
6996
|
+
req = build_request(:update_app_instance_user, params)
|
6997
|
+
req.send_request(options)
|
6998
|
+
end
|
6999
|
+
|
5224
7000
|
# Updates the status of the specified bot, such as starting or stopping
|
5225
7001
|
# the bot from running in your Amazon Chime Enterprise account.
|
5226
7002
|
#
|
@@ -5266,6 +7042,119 @@ module Aws::Chime
|
|
5266
7042
|
req.send_request(options)
|
5267
7043
|
end
|
5268
7044
|
|
7045
|
+
# Update a channel's attributes.
|
7046
|
+
#
|
7047
|
+
# **Restriction**\: You can't change a channel's privacy.
|
7048
|
+
#
|
7049
|
+
# @option params [required, String] :channel_arn
|
7050
|
+
# The ARN of the channel.
|
7051
|
+
#
|
7052
|
+
# @option params [required, String] :name
|
7053
|
+
# The name of the channel.
|
7054
|
+
#
|
7055
|
+
# @option params [required, String] :mode
|
7056
|
+
# The mode of the update request.
|
7057
|
+
#
|
7058
|
+
# @option params [String] :metadata
|
7059
|
+
# The metadata of the channel.
|
7060
|
+
#
|
7061
|
+
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7062
|
+
#
|
7063
|
+
# * {Types::UpdateChannelResponse#channel_arn #channel_arn} => String
|
7064
|
+
#
|
7065
|
+
# @example Request syntax with placeholder values
|
7066
|
+
#
|
7067
|
+
# resp = client.update_channel({
|
7068
|
+
# channel_arn: "ChimeArn", # required
|
7069
|
+
# name: "NonEmptyResourceName", # required
|
7070
|
+
# mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
|
7071
|
+
# metadata: "Metadata",
|
7072
|
+
# })
|
7073
|
+
#
|
7074
|
+
# @example Response structure
|
7075
|
+
#
|
7076
|
+
# resp.channel_arn #=> String
|
7077
|
+
#
|
7078
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannel AWS API Documentation
|
7079
|
+
#
|
7080
|
+
# @overload update_channel(params = {})
|
7081
|
+
# @param [Hash] params ({})
|
7082
|
+
def update_channel(params = {}, options = {})
|
7083
|
+
req = build_request(:update_channel, params)
|
7084
|
+
req.send_request(options)
|
7085
|
+
end
|
7086
|
+
|
7087
|
+
# Updates the content of a message.
|
7088
|
+
#
|
7089
|
+
# @option params [required, String] :channel_arn
|
7090
|
+
# The ARN of the channel.
|
7091
|
+
#
|
7092
|
+
# @option params [required, String] :message_id
|
7093
|
+
# The ID string of the message being updated.
|
7094
|
+
#
|
7095
|
+
# @option params [String] :content
|
7096
|
+
# The content of the message being updated.
|
7097
|
+
#
|
7098
|
+
# @option params [String] :metadata
|
7099
|
+
# The metadata of the message being updated.
|
7100
|
+
#
|
7101
|
+
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7102
|
+
#
|
7103
|
+
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
7104
|
+
# * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
|
7105
|
+
#
|
7106
|
+
# @example Request syntax with placeholder values
|
7107
|
+
#
|
7108
|
+
# resp = client.update_channel_message({
|
7109
|
+
# channel_arn: "ChimeArn", # required
|
7110
|
+
# message_id: "MessageId", # required
|
7111
|
+
# content: "Content",
|
7112
|
+
# metadata: "Metadata",
|
7113
|
+
# })
|
7114
|
+
#
|
7115
|
+
# @example Response structure
|
7116
|
+
#
|
7117
|
+
# resp.channel_arn #=> String
|
7118
|
+
# resp.message_id #=> String
|
7119
|
+
#
|
7120
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelMessage AWS API Documentation
|
7121
|
+
#
|
7122
|
+
# @overload update_channel_message(params = {})
|
7123
|
+
# @param [Hash] params ({})
|
7124
|
+
def update_channel_message(params = {}, options = {})
|
7125
|
+
req = build_request(:update_channel_message, params)
|
7126
|
+
req.send_request(options)
|
7127
|
+
end
|
7128
|
+
|
7129
|
+
# Sets the timestamp to the point when a user last read messages in a
|
7130
|
+
# channel.
|
7131
|
+
#
|
7132
|
+
# @option params [required, String] :channel_arn
|
7133
|
+
# The ARN of the channel.
|
7134
|
+
#
|
7135
|
+
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7136
|
+
#
|
7137
|
+
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
7138
|
+
#
|
7139
|
+
# @example Request syntax with placeholder values
|
7140
|
+
#
|
7141
|
+
# resp = client.update_channel_read_marker({
|
7142
|
+
# channel_arn: "ChimeArn", # required
|
7143
|
+
# })
|
7144
|
+
#
|
7145
|
+
# @example Response structure
|
7146
|
+
#
|
7147
|
+
# resp.channel_arn #=> String
|
7148
|
+
#
|
7149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/UpdateChannelReadMarker AWS API Documentation
|
7150
|
+
#
|
7151
|
+
# @overload update_channel_read_marker(params = {})
|
7152
|
+
# @param [Hash] params ({})
|
7153
|
+
def update_channel_read_marker(params = {}, options = {})
|
7154
|
+
req = build_request(:update_channel_read_marker, params)
|
7155
|
+
req.send_request(options)
|
7156
|
+
end
|
7157
|
+
|
5269
7158
|
# Updates global settings for the administrator's AWS account, such as
|
5270
7159
|
# Amazon Chime Business Calling and Amazon Chime Voice Connector
|
5271
7160
|
# settings.
|
@@ -5843,7 +7732,7 @@ module Aws::Chime
|
|
5843
7732
|
params: params,
|
5844
7733
|
config: config)
|
5845
7734
|
context[:gem_name] = 'aws-sdk-chime'
|
5846
|
-
context[:gem_version] = '1.
|
7735
|
+
context[:gem_version] = '1.39.0'
|
5847
7736
|
Seahorse::Client::Request.new(handlers, context)
|
5848
7737
|
end
|
5849
7738
|
|