aws-sdk-chime 1.39.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-chime.rb +1 -1
- data/lib/aws-sdk-chime/client.rb +441 -155
- data/lib/aws-sdk-chime/client_api.rb +34 -5
- data/lib/aws-sdk-chime/types.rb +441 -274
- 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: c963ae7fbfc6691c04788eec29967c2fa8a201157f17eb2761f97bb418bd5b71
|
4
|
+
data.tar.gz: 78daf053a5f9c68054b49bf3465a8285f31faf5e86277312ed32b9290d0d421a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40b707bbff49ae8354b76dd03b8a43b42767e9456a0279ce29fb80dfa23af8ef3641a83af9d4ce687aa3bdb5bdfc993e27c4ed1a6fdfffff27e8490aed28f1e2
|
7
|
+
data.tar.gz: bd6b58c21f94422ee0b2ab619511236d452ba6b5c9d2ddac165b041e5015290f4851e1c6b55031370ea673dd88270421f2819a454c86999f6ddb6bb52f98f69e
|
data/lib/aws-sdk-chime.rb
CHANGED
data/lib/aws-sdk-chime/client.rb
CHANGED
@@ -531,9 +531,9 @@ module Aws::Chime
|
|
531
531
|
end
|
532
532
|
|
533
533
|
# Adds up to 50 members to a chat room in an Amazon Chime Enterprise
|
534
|
-
# account. Members can be
|
535
|
-
#
|
536
|
-
#
|
534
|
+
# account. Members can be users or bots. The member role designates
|
535
|
+
# whether the member is a chat room administrator or a general chat room
|
536
|
+
# member.
|
537
537
|
#
|
538
538
|
# @option params [required, String] :account_id
|
539
539
|
# The Amazon Chime account ID.
|
@@ -619,7 +619,7 @@ module Aws::Chime
|
|
619
619
|
# Administration Guide*.
|
620
620
|
#
|
621
621
|
# Users suspended from a `Team` account are disassociated from the
|
622
|
-
# account,
|
622
|
+
# account,but they can continue to use Amazon Chime as free users. To
|
623
623
|
# remove the suspension from suspended `Team` account users, invite them
|
624
624
|
# to the `Team` account again. You can use the InviteUsers action to do
|
625
625
|
# so.
|
@@ -716,7 +716,7 @@ module Aws::Chime
|
|
716
716
|
end
|
717
717
|
|
718
718
|
# Updates phone number product types or calling names. You can update
|
719
|
-
# one attribute at a time for each `UpdatePhoneNumberRequestItem
|
719
|
+
# one attribute at a time for each `UpdatePhoneNumberRequestItem` . For
|
720
720
|
# example, you can update either the product type or the calling name.
|
721
721
|
#
|
722
722
|
# For product types, choose from Amazon Chime Business Calling and
|
@@ -855,23 +855,26 @@ module Aws::Chime
|
|
855
855
|
req.send_request(options)
|
856
856
|
end
|
857
857
|
|
858
|
-
# Creates an Amazon Chime
|
859
|
-
#
|
860
|
-
# `CreateAppInstance` supports
|
861
|
-
#
|
858
|
+
# Creates an Amazon Chime SDK messaging `AppInstance` under an AWS
|
859
|
+
# account. Only SDK messaging customers use this API.
|
860
|
+
# `CreateAppInstance` supports idempotency behavior as described in the
|
861
|
+
# AWS API Standard.
|
862
862
|
#
|
863
863
|
# @option params [required, String] :name
|
864
|
-
# The name of the
|
864
|
+
# The name of the `AppInstance`.
|
865
865
|
#
|
866
866
|
# @option params [String] :metadata
|
867
|
-
# The metadata of the
|
867
|
+
# The metadata of the `AppInstance`. Limited to a 1KB string in UTF-8.
|
868
868
|
#
|
869
869
|
# @option params [required, String] :client_request_token
|
870
|
-
# The `ClientRequestToken` of the
|
870
|
+
# The `ClientRequestToken` of the `AppInstance`.
|
871
871
|
#
|
872
872
|
# **A suitable default value is auto-generated.** You should normally
|
873
873
|
# not need to pass this option.**
|
874
874
|
#
|
875
|
+
# @option params [Array<Types::Tag>] :tags
|
876
|
+
# Tags assigned to the `AppInstanceUser`.
|
877
|
+
#
|
875
878
|
# @return [Types::CreateAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
876
879
|
#
|
877
880
|
# * {Types::CreateAppInstanceResponse#app_instance_arn #app_instance_arn} => String
|
@@ -882,6 +885,12 @@ module Aws::Chime
|
|
882
885
|
# name: "NonEmptyResourceName", # required
|
883
886
|
# metadata: "Metadata",
|
884
887
|
# client_request_token: "ClientRequestToken", # required
|
888
|
+
# tags: [
|
889
|
+
# {
|
890
|
+
# key: "TagKey", # required
|
891
|
+
# value: "TagValue", # required
|
892
|
+
# },
|
893
|
+
# ],
|
885
894
|
# })
|
886
895
|
#
|
887
896
|
# @example Response structure
|
@@ -900,7 +909,7 @@ module Aws::Chime
|
|
900
909
|
# Promotes an `AppInstanceUser` to an `AppInstanceAdmin`. The promoted
|
901
910
|
# user can perform the following actions.
|
902
911
|
#
|
903
|
-
# * `ChannelModerator` actions across all channels in the
|
912
|
+
# * `ChannelModerator` actions across all channels in the `AppInstance`.
|
904
913
|
#
|
905
914
|
# * `DeleteChannelMessage` actions.
|
906
915
|
#
|
@@ -908,10 +917,10 @@ module Aws::Chime
|
|
908
917
|
# role.
|
909
918
|
#
|
910
919
|
# @option params [required, String] :app_instance_admin_arn
|
911
|
-
# The ARN of the administrator of the current
|
920
|
+
# The ARN of the administrator of the current `AppInstance`.
|
912
921
|
#
|
913
922
|
# @option params [required, String] :app_instance_arn
|
914
|
-
# The ARN of the
|
923
|
+
# The ARN of the `AppInstance`.
|
915
924
|
#
|
916
925
|
# @return [Types::CreateAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
917
926
|
#
|
@@ -944,10 +953,10 @@ module Aws::Chime
|
|
944
953
|
# consists of a unique `appInstanceUserId` and `Name` for that user.
|
945
954
|
#
|
946
955
|
# @option params [required, String] :app_instance_arn
|
947
|
-
# The ARN of the
|
956
|
+
# The ARN of the `AppInstance` request.
|
948
957
|
#
|
949
958
|
# @option params [required, String] :app_instance_user_id
|
950
|
-
# The user ID of the
|
959
|
+
# The user ID of the `AppInstance`.
|
951
960
|
#
|
952
961
|
# @option params [required, String] :name
|
953
962
|
# The user's name.
|
@@ -956,11 +965,14 @@ module Aws::Chime
|
|
956
965
|
# The request's metadata. Limited to a 1KB string in UTF-8.
|
957
966
|
#
|
958
967
|
# @option params [required, String] :client_request_token
|
959
|
-
# The token assigned to the user requesting an
|
968
|
+
# The token assigned to the user requesting an `AppInstance`.
|
960
969
|
#
|
961
970
|
# **A suitable default value is auto-generated.** You should normally
|
962
971
|
# not need to pass this option.**
|
963
972
|
#
|
973
|
+
# @option params [Array<Types::Tag>] :tags
|
974
|
+
# Tags assigned to the `AppInstanceUser`.
|
975
|
+
#
|
964
976
|
# @return [Types::CreateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
965
977
|
#
|
966
978
|
# * {Types::CreateAppInstanceUserResponse#app_instance_user_arn #app_instance_user_arn} => String
|
@@ -973,6 +985,12 @@ module Aws::Chime
|
|
973
985
|
# name: "UserName", # required
|
974
986
|
# metadata: "Metadata",
|
975
987
|
# client_request_token: "ClientRequestToken", # required
|
988
|
+
# tags: [
|
989
|
+
# {
|
990
|
+
# key: "TagKey", # required
|
991
|
+
# value: "TagValue", # required
|
992
|
+
# },
|
993
|
+
# ],
|
976
994
|
# })
|
977
995
|
#
|
978
996
|
# @example Response structure
|
@@ -1001,9 +1019,7 @@ module Aws::Chime
|
|
1001
1019
|
#
|
1002
1020
|
# @option params [required, String] :external_user_id
|
1003
1021
|
# The Amazon Chime SDK external user ID. An idempotency token. Links the
|
1004
|
-
# attendee to an identity managed by a builder application.
|
1005
|
-
# create an attendee with the same external user id, the service returns
|
1006
|
-
# the existing record.
|
1022
|
+
# attendee to an identity managed by a builder application.
|
1007
1023
|
#
|
1008
1024
|
# @option params [Array<Types::Tag>] :tags
|
1009
1025
|
# The tag key-value pairs.
|
@@ -1088,6 +1104,12 @@ module Aws::Chime
|
|
1088
1104
|
#
|
1089
1105
|
# **Restriction**\: You can't change a channel's privacy.
|
1090
1106
|
#
|
1107
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1108
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1109
|
+
# in the header.
|
1110
|
+
#
|
1111
|
+
# </note>
|
1112
|
+
#
|
1091
1113
|
# @option params [required, String] :app_instance_arn
|
1092
1114
|
# The ARN of the channel request.
|
1093
1115
|
#
|
@@ -1103,7 +1125,7 @@ module Aws::Chime
|
|
1103
1125
|
# @option params [String] :privacy
|
1104
1126
|
# The channel's privacy level: `PUBLIC` or `PRIVATE`. Private channels
|
1105
1127
|
# aren't discoverable by users outside the channel. Public channels are
|
1106
|
-
# discoverable by anyone in the
|
1128
|
+
# discoverable by anyone in the `AppInstance`.
|
1107
1129
|
#
|
1108
1130
|
# @option params [String] :metadata
|
1109
1131
|
# The metadata of the creation request. Limited to 1KB and UTF-8.
|
@@ -1115,6 +1137,10 @@ module Aws::Chime
|
|
1115
1137
|
# not need to pass this option.**
|
1116
1138
|
#
|
1117
1139
|
# @option params [Array<Types::Tag>] :tags
|
1140
|
+
# The tags for the creation request.
|
1141
|
+
#
|
1142
|
+
# @option params [String] :chime_bearer
|
1143
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1118
1144
|
#
|
1119
1145
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1120
1146
|
#
|
@@ -1135,6 +1161,7 @@ module Aws::Chime
|
|
1135
1161
|
# value: "TagValue", # required
|
1136
1162
|
# },
|
1137
1163
|
# ],
|
1164
|
+
# chime_bearer: "ChimeArn",
|
1138
1165
|
# })
|
1139
1166
|
#
|
1140
1167
|
# @example Response structure
|
@@ -1158,12 +1185,21 @@ module Aws::Chime
|
|
1158
1185
|
# If you ban a user who is already part of a channel, that user is
|
1159
1186
|
# automatically kicked from the channel.
|
1160
1187
|
#
|
1188
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1189
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1190
|
+
# in the header.
|
1191
|
+
#
|
1192
|
+
# </note>
|
1193
|
+
#
|
1161
1194
|
# @option params [required, String] :channel_arn
|
1162
1195
|
# The ARN of the ban request.
|
1163
1196
|
#
|
1164
1197
|
# @option params [required, String] :member_arn
|
1165
1198
|
# The ARN of the member being banned.
|
1166
1199
|
#
|
1200
|
+
# @option params [String] :chime_bearer
|
1201
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1202
|
+
#
|
1167
1203
|
# @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1168
1204
|
#
|
1169
1205
|
# * {Types::CreateChannelBanResponse#channel_arn #channel_arn} => String
|
@@ -1174,6 +1210,7 @@ module Aws::Chime
|
|
1174
1210
|
# resp = client.create_channel_ban({
|
1175
1211
|
# channel_arn: "ChimeArn", # required
|
1176
1212
|
# member_arn: "ChimeArn", # required
|
1213
|
+
# chime_bearer: "ChimeArn",
|
1177
1214
|
# })
|
1178
1215
|
#
|
1179
1216
|
# @example Response structure
|
@@ -1211,6 +1248,12 @@ module Aws::Chime
|
|
1211
1248
|
#
|
1212
1249
|
# * Private Channels: You must be a member to list or send messages.
|
1213
1250
|
#
|
1251
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1252
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1253
|
+
# in the header.
|
1254
|
+
#
|
1255
|
+
# </note>
|
1256
|
+
#
|
1214
1257
|
# @option params [required, String] :channel_arn
|
1215
1258
|
# The ARN of the channel to which you're adding users.
|
1216
1259
|
#
|
@@ -1224,6 +1267,9 @@ module Aws::Chime
|
|
1224
1267
|
# `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
|
1225
1268
|
# not returned. This is only supported by moderators.
|
1226
1269
|
#
|
1270
|
+
# @option params [String] :chime_bearer
|
1271
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1272
|
+
#
|
1227
1273
|
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1228
1274
|
#
|
1229
1275
|
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
@@ -1235,6 +1281,7 @@ module Aws::Chime
|
|
1235
1281
|
# channel_arn: "ChimeArn", # required
|
1236
1282
|
# member_arn: "ChimeArn", # required
|
1237
1283
|
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
1284
|
+
# chime_bearer: "ChimeArn",
|
1238
1285
|
# })
|
1239
1286
|
#
|
1240
1287
|
# @example Response structure
|
@@ -1264,12 +1311,21 @@ module Aws::Chime
|
|
1264
1311
|
#
|
1265
1312
|
# * List messages in the channel.
|
1266
1313
|
#
|
1314
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1315
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
1316
|
+
# in the header.
|
1317
|
+
#
|
1318
|
+
# </note>
|
1319
|
+
#
|
1267
1320
|
# @option params [required, String] :channel_arn
|
1268
1321
|
# The ARN of the channel.
|
1269
1322
|
#
|
1270
1323
|
# @option params [required, String] :channel_moderator_arn
|
1271
1324
|
# The ARN of the moderator.
|
1272
1325
|
#
|
1326
|
+
# @option params [String] :chime_bearer
|
1327
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1328
|
+
#
|
1273
1329
|
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1274
1330
|
#
|
1275
1331
|
# * {Types::CreateChannelModeratorResponse#channel_arn #channel_arn} => String
|
@@ -1280,6 +1336,7 @@ module Aws::Chime
|
|
1280
1336
|
# resp = client.create_channel_moderator({
|
1281
1337
|
# channel_arn: "ChimeArn", # required
|
1282
1338
|
# channel_moderator_arn: "ChimeArn", # required
|
1339
|
+
# chime_bearer: "ChimeArn",
|
1283
1340
|
# })
|
1284
1341
|
#
|
1285
1342
|
# @example Response structure
|
@@ -1300,8 +1357,9 @@ module Aws::Chime
|
|
1300
1357
|
# Creates a new Amazon Chime SDK meeting in the specified media Region
|
1301
1358
|
# with no initial attendees. For more information about specifying media
|
1302
1359
|
# Regions, see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime
|
1303
|
-
# Developer Guide
|
1304
|
-
# [Using the Amazon Chime SDK][2] in the *Amazon Chime Developer
|
1360
|
+
# Developer Guide* . For more information about the Amazon Chime SDK,
|
1361
|
+
# see [Using the Amazon Chime SDK][2] in the *Amazon Chime Developer
|
1362
|
+
# Guide* .
|
1305
1363
|
#
|
1306
1364
|
#
|
1307
1365
|
#
|
@@ -1324,11 +1382,11 @@ module Aws::Chime
|
|
1324
1382
|
# @option params [String] :media_region
|
1325
1383
|
# The Region in which to create the meeting. Default: `us-east-1`.
|
1326
1384
|
#
|
1327
|
-
# Available values: `af-south-1
|
1328
|
-
# `ap-south-1
|
1329
|
-
# `eu-central-1
|
1330
|
-
# `eu-west-3
|
1331
|
-
# `us-west-2
|
1385
|
+
# Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2` ,
|
1386
|
+
# `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` , `ca-central-1` ,
|
1387
|
+
# `eu-central-1` , `eu-north-1` , `eu-south-1` , `eu-west-1` ,
|
1388
|
+
# `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1` , `us-east-2` ,
|
1389
|
+
# `us-west-1` , `us-west-2` .
|
1332
1390
|
#
|
1333
1391
|
# @option params [Array<Types::Tag>] :tags
|
1334
1392
|
# The tag key-value pairs.
|
@@ -1384,23 +1442,16 @@ module Aws::Chime
|
|
1384
1442
|
|
1385
1443
|
# Uses the join token and call metadata in a meeting request (From
|
1386
1444
|
# number, To number, and so forth) to initiate an outbound call to a
|
1387
|
-
# public switched telephone network (PSTN) and
|
1445
|
+
# public switched telephone network (PSTN) and join them into a Chime
|
1388
1446
|
# meeting. Also ensures that the From number belongs to the customer.
|
1389
1447
|
#
|
1390
1448
|
# To play welcome audio or implement an interactive voice response
|
1391
|
-
# (IVR), use the `CreateSipMediaApplicationCall`
|
1449
|
+
# (IVR), use the `CreateSipMediaApplicationCall` action with the
|
1392
1450
|
# corresponding SIP media application ID.
|
1393
1451
|
#
|
1394
1452
|
# @option params [required, String] :meeting_id
|
1395
1453
|
# The Amazon Chime SDK meeting ID.
|
1396
1454
|
#
|
1397
|
-
# Type: String
|
1398
|
-
#
|
1399
|
-
# Pattern:
|
1400
|
-
# \[a-fA-F0-9\]\\\{8\\}(?:-\[a-fA-F0-9\]\\\{4\\})\\\{3\\}-\[a-fA-F0-9\]\\\{12\\}
|
1401
|
-
#
|
1402
|
-
# Required: No
|
1403
|
-
#
|
1404
1455
|
# @option params [required, String] :from_phone_number
|
1405
1456
|
# Phone number used as the caller ID when the remote party receives a
|
1406
1457
|
# call.
|
@@ -1409,12 +1460,12 @@ module Aws::Chime
|
|
1409
1460
|
# Phone number called when inviting someone to a meeting.
|
1410
1461
|
#
|
1411
1462
|
# @option params [required, String] :join_token
|
1412
|
-
# Token used by the Amazon Chime SDK attendee. Call the
|
1413
|
-
#
|
1463
|
+
# Token used by the Amazon Chime SDK attendee. Call the
|
1464
|
+
# [CreateAttendee][1] action to get a join token.
|
1414
1465
|
#
|
1415
1466
|
#
|
1416
1467
|
#
|
1417
|
-
# [1]: https://docs.aws.amazon.com/
|
1468
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/APIReference/API_Attendee.htmlCreateAttendee
|
1418
1469
|
#
|
1419
1470
|
# @return [Types::CreateMeetingDialOutResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1420
1471
|
#
|
@@ -1445,8 +1496,8 @@ module Aws::Chime
|
|
1445
1496
|
# Creates a new Amazon Chime SDK meeting in the specified media Region,
|
1446
1497
|
# with attendees. For more information about specifying media Regions,
|
1447
1498
|
# see [Amazon Chime SDK Media Regions][1] in the *Amazon Chime Developer
|
1448
|
-
# Guide
|
1449
|
-
# the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide
|
1499
|
+
# Guide* . For more information about the Amazon Chime SDK, see [Using
|
1500
|
+
# the Amazon Chime SDK][2] in the *Amazon Chime Developer Guide* .
|
1450
1501
|
#
|
1451
1502
|
#
|
1452
1503
|
#
|
@@ -1467,21 +1518,21 @@ module Aws::Chime
|
|
1467
1518
|
# Reserved.
|
1468
1519
|
#
|
1469
1520
|
# @option params [String] :media_region
|
1470
|
-
# The Region in which to create the meeting. Default: `us-east-1
|
1521
|
+
# The Region in which to create the meeting. Default: `us-east-1` .
|
1471
1522
|
#
|
1472
|
-
# Available values: `af-south-1
|
1473
|
-
# `ap-south-1
|
1474
|
-
# `eu-central-1
|
1475
|
-
# `eu-west-3
|
1476
|
-
# `us-west-2
|
1523
|
+
# Available values: `af-south-1` , `ap-northeast-1` , `ap-northeast-2` ,
|
1524
|
+
# `ap-south-1` , `ap-southeast-1` , `ap-southeast-2` , `ca-central-1` ,
|
1525
|
+
# `eu-central-1` , `eu-north-1` , `eu-south-1` , `eu-west-1` ,
|
1526
|
+
# `eu-west-2` , `eu-west-3` , `sa-east-1` , `us-east-1` , `us-east-2` ,
|
1527
|
+
# `us-west-1` , `us-west-2` .
|
1477
1528
|
#
|
1478
1529
|
# @option params [Array<Types::Tag>] :tags
|
1479
1530
|
# The tag key-value pairs.
|
1480
1531
|
#
|
1481
1532
|
# @option params [Types::MeetingNotificationConfiguration] :notifications_configuration
|
1482
|
-
# The
|
1483
|
-
#
|
1484
|
-
#
|
1533
|
+
# The resource target configurations for receiving Amazon Chime SDK
|
1534
|
+
# meeting and attendee event notifications. The Amazon Chime SDK
|
1535
|
+
# supports resource targets located in the US East (N. Virginia) AWS
|
1485
1536
|
# Region (`us-east-1`).
|
1486
1537
|
#
|
1487
1538
|
# @option params [Array<Types::CreateAttendeeRequestItem>] :attendees
|
@@ -1771,9 +1822,9 @@ module Aws::Chime
|
|
1771
1822
|
# Creates a SIP media application.
|
1772
1823
|
#
|
1773
1824
|
# @option params [required, String] :aws_region
|
1774
|
-
# AWS Region assigned to the SIP media application.
|
1825
|
+
# The AWS Region assigned to the SIP media application.
|
1775
1826
|
#
|
1776
|
-
# @option params [String] :name
|
1827
|
+
# @option params [required, String] :name
|
1777
1828
|
# The SIP media application name.
|
1778
1829
|
#
|
1779
1830
|
# @option params [required, Array<Types::SipMediaApplicationEndpoint>] :endpoints
|
@@ -1788,7 +1839,7 @@ module Aws::Chime
|
|
1788
1839
|
#
|
1789
1840
|
# resp = client.create_sip_media_application({
|
1790
1841
|
# aws_region: "String", # required
|
1791
|
-
# name: "SipMediaApplicationName",
|
1842
|
+
# name: "SipMediaApplicationName", # required
|
1792
1843
|
# endpoints: [ # required
|
1793
1844
|
# {
|
1794
1845
|
# lambda_arn: "FunctionArn",
|
@@ -1819,11 +1870,11 @@ module Aws::Chime
|
|
1819
1870
|
# specified in the request, and it invokes the endpoint of the specified
|
1820
1871
|
# `sipMediaApplicationId`.
|
1821
1872
|
#
|
1822
|
-
# @option params [String] :from_phone_number
|
1873
|
+
# @option params [required, String] :from_phone_number
|
1823
1874
|
# The phone number that a user calls from.
|
1824
1875
|
#
|
1825
|
-
# @option params [String] :to_phone_number
|
1826
|
-
# The phone number that the user dials in order to connect to a meeting
|
1876
|
+
# @option params [required, String] :to_phone_number
|
1877
|
+
# The phone number that the user dials in order to connect to a meeting.
|
1827
1878
|
#
|
1828
1879
|
# @option params [required, String] :sip_media_application_id
|
1829
1880
|
# The ID of the SIP media application.
|
@@ -1835,8 +1886,8 @@ module Aws::Chime
|
|
1835
1886
|
# @example Request syntax with placeholder values
|
1836
1887
|
#
|
1837
1888
|
# resp = client.create_sip_media_application_call({
|
1838
|
-
# from_phone_number: "E164PhoneNumber",
|
1839
|
-
# to_phone_number: "E164PhoneNumber",
|
1889
|
+
# from_phone_number: "E164PhoneNumber", # required
|
1890
|
+
# to_phone_number: "E164PhoneNumber", # required
|
1840
1891
|
# sip_media_application_id: "NonEmptyString", # required
|
1841
1892
|
# })
|
1842
1893
|
#
|
@@ -1860,21 +1911,17 @@ module Aws::Chime
|
|
1860
1911
|
# The name of the SIP rule.
|
1861
1912
|
#
|
1862
1913
|
# @option params [required, String] :trigger_type
|
1863
|
-
# The type of trigger
|
1864
|
-
#
|
1865
|
-
# `ToPhoneNumber`.
|
1914
|
+
# The type of trigger assigned to the SIP rule in `TriggerValue`,
|
1915
|
+
# currently `RequestUriHostname` or `ToPhoneNumber`.
|
1866
1916
|
#
|
1867
1917
|
# @option params [required, String] :trigger_value
|
1868
|
-
# If `TriggerType` is `RequestUriHostname
|
1918
|
+
# If `TriggerType` is `RequestUriHostname`, the value can be the
|
1869
1919
|
# outbound host name of an Amazon Chime Voice Connector. If
|
1870
|
-
# `TriggerType` is `ToPhoneNumber
|
1871
|
-
#
|
1872
|
-
# the
|
1873
|
-
# `RequestUriHostname`,
|
1874
|
-
#
|
1875
|
-
# then the value can be a customer-owned phone number in E164 format.
|
1876
|
-
# `SipRule` is triggered if the SIP application requests a host name, or
|
1877
|
-
# a `ToPhoneNumber` value matches the incoming SIP request.
|
1920
|
+
# `TriggerType` is `ToPhoneNumber`, the value can be a customer-owned
|
1921
|
+
# phone number in the E164 format. The `SipMediaApplication` specified
|
1922
|
+
# in the `SipRule` is triggered if the request URI in an incoming SIP
|
1923
|
+
# request matches the `RequestUriHostname`, or if the `To` header in the
|
1924
|
+
# incoming SIP request matches the `ToPhoneNumber` value.
|
1878
1925
|
#
|
1879
1926
|
# @option params [Boolean] :disabled
|
1880
1927
|
# Enables or disables a rule. You must disable rules before you can
|
@@ -1994,7 +2041,7 @@ module Aws::Chime
|
|
1994
2041
|
#
|
1995
2042
|
# @option params [String] :aws_region
|
1996
2043
|
# The AWS Region in which the Amazon Chime Voice Connector is created.
|
1997
|
-
# Default value: `us-east-1
|
2044
|
+
# Default value: `us-east-1` .
|
1998
2045
|
#
|
1999
2046
|
# @option params [required, Boolean] :require_encryption
|
2000
2047
|
# When enabled, requires encryption for the Amazon Chime Voice
|
@@ -2082,15 +2129,15 @@ module Aws::Chime
|
|
2082
2129
|
end
|
2083
2130
|
|
2084
2131
|
# Deletes the specified Amazon Chime account. You must suspend all users
|
2085
|
-
# before deleting
|
2086
|
-
# action to
|
2132
|
+
# before deleting `Team` account. You can use the BatchSuspendUser
|
2133
|
+
# action to dodo.
|
2087
2134
|
#
|
2088
2135
|
# For `EnterpriseLWA` and `EnterpriseAD` accounts, you must release the
|
2089
2136
|
# claimed domains for your Amazon Chime account before deletion. As soon
|
2090
2137
|
# as you release the domain, all users under that account are suspended.
|
2091
2138
|
#
|
2092
2139
|
# Deleted accounts appear in your `Disabled` accounts list for 90 days.
|
2093
|
-
# To restore
|
2140
|
+
# To restore deleted account from your `Disabled` accounts list, you
|
2094
2141
|
# must contact AWS Support.
|
2095
2142
|
#
|
2096
2143
|
# After 90 days, deleted accounts are permanently removed from your
|
@@ -2119,7 +2166,7 @@ module Aws::Chime
|
|
2119
2166
|
# Deletes an `AppInstance` and all associated data asynchronously.
|
2120
2167
|
#
|
2121
2168
|
# @option params [required, String] :app_instance_arn
|
2122
|
-
# The ARN of the
|
2169
|
+
# The ARN of the `AppInstance`.
|
2123
2170
|
#
|
2124
2171
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2125
2172
|
#
|
@@ -2142,10 +2189,10 @@ module Aws::Chime
|
|
2142
2189
|
# does not delete the user.
|
2143
2190
|
#
|
2144
2191
|
# @option params [required, String] :app_instance_admin_arn
|
2145
|
-
# The ARN of the
|
2192
|
+
# The ARN of the `AppInstance`'s administrator.
|
2146
2193
|
#
|
2147
2194
|
# @option params [required, String] :app_instance_arn
|
2148
|
-
# The ARN of the
|
2195
|
+
# The ARN of the `AppInstance`.
|
2149
2196
|
#
|
2150
2197
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2151
2198
|
#
|
@@ -2165,7 +2212,7 @@ module Aws::Chime
|
|
2165
2212
|
req.send_request(options)
|
2166
2213
|
end
|
2167
2214
|
|
2168
|
-
# Deletes the streaming configurations of an
|
2215
|
+
# Deletes the streaming configurations of an `AppInstance`.
|
2169
2216
|
#
|
2170
2217
|
# @option params [required, String] :app_instance_arn
|
2171
2218
|
# The ARN of the streaming configurations being deleted.
|
@@ -2210,10 +2257,10 @@ module Aws::Chime
|
|
2210
2257
|
end
|
2211
2258
|
|
2212
2259
|
# Deletes an attendee from the specified Amazon Chime SDK meeting and
|
2213
|
-
# deletes their `JoinToken
|
2260
|
+
# deletes their `JoinToken` . Attendees are automatically deleted when a
|
2214
2261
|
# Amazon Chime SDK meeting is deleted. For more information about the
|
2215
2262
|
# Amazon Chime SDK, see [Using the Amazon Chime SDK][1] in the *Amazon
|
2216
|
-
# Chime Developer Guide
|
2263
|
+
# Chime Developer Guide* .
|
2217
2264
|
#
|
2218
2265
|
#
|
2219
2266
|
#
|
@@ -2246,15 +2293,25 @@ module Aws::Chime
|
|
2246
2293
|
# Immediately makes a channel and its memberships inaccessible and marks
|
2247
2294
|
# them for deletion. This is an irreversible process.
|
2248
2295
|
#
|
2296
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2297
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2298
|
+
# in the header.
|
2299
|
+
#
|
2300
|
+
# </note>
|
2301
|
+
#
|
2249
2302
|
# @option params [required, String] :channel_arn
|
2250
2303
|
# The ARN of the channel being deleted.
|
2251
2304
|
#
|
2305
|
+
# @option params [String] :chime_bearer
|
2306
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2307
|
+
#
|
2252
2308
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2253
2309
|
#
|
2254
2310
|
# @example Request syntax with placeholder values
|
2255
2311
|
#
|
2256
2312
|
# resp = client.delete_channel({
|
2257
2313
|
# channel_arn: "ChimeArn", # required
|
2314
|
+
# chime_bearer: "ChimeArn",
|
2258
2315
|
# })
|
2259
2316
|
#
|
2260
2317
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannel AWS API Documentation
|
@@ -2268,11 +2325,20 @@ module Aws::Chime
|
|
2268
2325
|
|
2269
2326
|
# Removes a user from a channel's ban list.
|
2270
2327
|
#
|
2328
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2329
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2330
|
+
# in the header.
|
2331
|
+
#
|
2332
|
+
# </note>
|
2333
|
+
#
|
2271
2334
|
# @option params [required, String] :channel_arn
|
2272
|
-
# The ARN of the channel from which the
|
2335
|
+
# The ARN of the channel from which the `AppInstanceUser` was banned.
|
2273
2336
|
#
|
2274
2337
|
# @option params [required, String] :member_arn
|
2275
|
-
# The ARN of the
|
2338
|
+
# The ARN of the `AppInstanceUser` that you want to reinstate.
|
2339
|
+
#
|
2340
|
+
# @option params [String] :chime_bearer
|
2341
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2276
2342
|
#
|
2277
2343
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2278
2344
|
#
|
@@ -2281,6 +2347,7 @@ module Aws::Chime
|
|
2281
2347
|
# resp = client.delete_channel_ban({
|
2282
2348
|
# channel_arn: "ChimeArn", # required
|
2283
2349
|
# member_arn: "ChimeArn", # required
|
2350
|
+
# chime_bearer: "ChimeArn",
|
2284
2351
|
# })
|
2285
2352
|
#
|
2286
2353
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelBan AWS API Documentation
|
@@ -2294,12 +2361,21 @@ module Aws::Chime
|
|
2294
2361
|
|
2295
2362
|
# Removes a member from a channel.
|
2296
2363
|
#
|
2364
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2365
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2366
|
+
# in the header.
|
2367
|
+
#
|
2368
|
+
# </note>
|
2369
|
+
#
|
2297
2370
|
# @option params [required, String] :channel_arn
|
2298
2371
|
# The ARN of the channel from which you want to remove the user.
|
2299
2372
|
#
|
2300
2373
|
# @option params [required, String] :member_arn
|
2301
2374
|
# The ARN of the member that you're removing from the channel.
|
2302
2375
|
#
|
2376
|
+
# @option params [String] :chime_bearer
|
2377
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2378
|
+
#
|
2303
2379
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2304
2380
|
#
|
2305
2381
|
# @example Request syntax with placeholder values
|
@@ -2307,6 +2383,7 @@ module Aws::Chime
|
|
2307
2383
|
# resp = client.delete_channel_membership({
|
2308
2384
|
# channel_arn: "ChimeArn", # required
|
2309
2385
|
# member_arn: "ChimeArn", # required
|
2386
|
+
# chime_bearer: "ChimeArn",
|
2310
2387
|
# })
|
2311
2388
|
#
|
2312
2389
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMembership AWS API Documentation
|
@@ -2322,12 +2399,21 @@ module Aws::Chime
|
|
2322
2399
|
# Deletion makes messages inaccessible immediately. A background process
|
2323
2400
|
# deletes any revisions created by `UpdateChannelMessage`.
|
2324
2401
|
#
|
2402
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2403
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2404
|
+
# in the header.
|
2405
|
+
#
|
2406
|
+
# </note>
|
2407
|
+
#
|
2325
2408
|
# @option params [required, String] :channel_arn
|
2326
2409
|
# The ARN of the channel.
|
2327
2410
|
#
|
2328
2411
|
# @option params [required, String] :message_id
|
2329
2412
|
# The ID of the message being deleted.
|
2330
2413
|
#
|
2414
|
+
# @option params [String] :chime_bearer
|
2415
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2416
|
+
#
|
2331
2417
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2332
2418
|
#
|
2333
2419
|
# @example Request syntax with placeholder values
|
@@ -2335,6 +2421,7 @@ module Aws::Chime
|
|
2335
2421
|
# resp = client.delete_channel_message({
|
2336
2422
|
# channel_arn: "ChimeArn", # required
|
2337
2423
|
# message_id: "MessageId", # required
|
2424
|
+
# chime_bearer: "ChimeArn",
|
2338
2425
|
# })
|
2339
2426
|
#
|
2340
2427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelMessage AWS API Documentation
|
@@ -2348,12 +2435,21 @@ module Aws::Chime
|
|
2348
2435
|
|
2349
2436
|
# Deletes a channel moderator.
|
2350
2437
|
#
|
2438
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2439
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2440
|
+
# in the header.
|
2441
|
+
#
|
2442
|
+
# </note>
|
2443
|
+
#
|
2351
2444
|
# @option params [required, String] :channel_arn
|
2352
2445
|
# The ARN of the channel.
|
2353
2446
|
#
|
2354
2447
|
# @option params [required, String] :channel_moderator_arn
|
2355
2448
|
# The ARN of the moderator being deleted.
|
2356
2449
|
#
|
2450
|
+
# @option params [String] :chime_bearer
|
2451
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
2452
|
+
#
|
2357
2453
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2358
2454
|
#
|
2359
2455
|
# @example Request syntax with placeholder values
|
@@ -2361,6 +2457,7 @@ module Aws::Chime
|
|
2361
2457
|
# resp = client.delete_channel_moderator({
|
2362
2458
|
# channel_arn: "ChimeArn", # required
|
2363
2459
|
# channel_moderator_arn: "ChimeArn", # required
|
2460
|
+
# chime_bearer: "ChimeArn",
|
2364
2461
|
# })
|
2365
2462
|
#
|
2366
2463
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-2018-05-01/DeleteChannelModerator AWS API Documentation
|
@@ -2400,9 +2497,10 @@ module Aws::Chime
|
|
2400
2497
|
end
|
2401
2498
|
|
2402
2499
|
# Deletes the specified Amazon Chime SDK meeting. When a meeting is
|
2403
|
-
# deleted, its attendees are also deleted
|
2404
|
-
#
|
2405
|
-
#
|
2500
|
+
# deleted, its attendees are also deleted, clients connected to the
|
2501
|
+
# meeting are disconnected, and clients can no longer join the meeting.
|
2502
|
+
# For more information about the Amazon Chime SDK, see [Using the Amazon
|
2503
|
+
# Chime SDK][1] in the *Amazon Chime Developer Guide*.
|
2406
2504
|
#
|
2407
2505
|
#
|
2408
2506
|
#
|
@@ -2428,7 +2526,7 @@ module Aws::Chime
|
|
2428
2526
|
req.send_request(options)
|
2429
2527
|
end
|
2430
2528
|
|
2431
|
-
# Moves the specified phone number into the **
|
2529
|
+
# Moves the specified phone number into the **Deletionqueue**. A phone
|
2432
2530
|
# number must be disassociated from any users or Amazon Chime Voice
|
2433
2531
|
# Connectors before it can be deleted.
|
2434
2532
|
#
|
@@ -2790,7 +2888,7 @@ module Aws::Chime
|
|
2790
2888
|
# Returns the full details of an `AppInstance`.
|
2791
2889
|
#
|
2792
2890
|
# @option params [required, String] :app_instance_arn
|
2793
|
-
# The ARN of the
|
2891
|
+
# The ARN of the `AppInstance`.
|
2794
2892
|
#
|
2795
2893
|
# @return [Types::DescribeAppInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2796
2894
|
#
|
@@ -2822,10 +2920,10 @@ module Aws::Chime
|
|
2822
2920
|
# Returns the full details of an `AppInstanceAdmin`.
|
2823
2921
|
#
|
2824
2922
|
# @option params [required, String] :app_instance_admin_arn
|
2825
|
-
# The ARN of the
|
2923
|
+
# The ARN of the `AppInstanceAdmin`.
|
2826
2924
|
#
|
2827
2925
|
# @option params [required, String] :app_instance_arn
|
2828
|
-
# The ARN of the
|
2926
|
+
# The ARN of the `AppInstance`.
|
2829
2927
|
#
|
2830
2928
|
# @return [Types::DescribeAppInstanceAdminResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2831
2929
|
#
|
@@ -2854,10 +2952,10 @@ module Aws::Chime
|
|
2854
2952
|
req.send_request(options)
|
2855
2953
|
end
|
2856
2954
|
|
2857
|
-
# Returns the full details of an `AppInstanceUser
|
2955
|
+
# Returns the full details of an `AppInstanceUser` .
|
2858
2956
|
#
|
2859
2957
|
# @option params [required, String] :app_instance_user_arn
|
2860
|
-
# The ARN of the
|
2958
|
+
# The ARN of the `AppInstanceUser`.
|
2861
2959
|
#
|
2862
2960
|
# @return [Types::DescribeAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2863
2961
|
#
|
@@ -2886,11 +2984,21 @@ module Aws::Chime
|
|
2886
2984
|
req.send_request(options)
|
2887
2985
|
end
|
2888
2986
|
|
2889
|
-
# Returns the full details of a channel in an Amazon Chime
|
2987
|
+
# Returns the full details of a channel in an Amazon Chime
|
2988
|
+
# `AppInstance`.
|
2989
|
+
#
|
2990
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2991
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
2992
|
+
# in the header.
|
2993
|
+
#
|
2994
|
+
# </note>
|
2890
2995
|
#
|
2891
2996
|
# @option params [required, String] :channel_arn
|
2892
2997
|
# The ARN of the channel.
|
2893
2998
|
#
|
2999
|
+
# @option params [String] :chime_bearer
|
3000
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3001
|
+
#
|
2894
3002
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2895
3003
|
#
|
2896
3004
|
# * {Types::DescribeChannelResponse#channel #channel} => Types::Channel
|
@@ -2899,6 +3007,7 @@ module Aws::Chime
|
|
2899
3007
|
#
|
2900
3008
|
# resp = client.describe_channel({
|
2901
3009
|
# channel_arn: "ChimeArn", # required
|
3010
|
+
# chime_bearer: "ChimeArn",
|
2902
3011
|
# })
|
2903
3012
|
#
|
2904
3013
|
# @example Response structure
|
@@ -2925,12 +3034,21 @@ module Aws::Chime
|
|
2925
3034
|
|
2926
3035
|
# Returns the full details of a channel ban.
|
2927
3036
|
#
|
3037
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3038
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3039
|
+
# in the header.
|
3040
|
+
#
|
3041
|
+
# </note>
|
3042
|
+
#
|
2928
3043
|
# @option params [required, String] :channel_arn
|
2929
3044
|
# The ARN of the channel from which the user is banned.
|
2930
3045
|
#
|
2931
3046
|
# @option params [required, String] :member_arn
|
2932
3047
|
# The ARN of the member being banned.
|
2933
3048
|
#
|
3049
|
+
# @option params [String] :chime_bearer
|
3050
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3051
|
+
#
|
2934
3052
|
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2935
3053
|
#
|
2936
3054
|
# * {Types::DescribeChannelBanResponse#channel_ban #channel_ban} => Types::ChannelBan
|
@@ -2940,6 +3058,7 @@ module Aws::Chime
|
|
2940
3058
|
# resp = client.describe_channel_ban({
|
2941
3059
|
# channel_arn: "ChimeArn", # required
|
2942
3060
|
# member_arn: "ChimeArn", # required
|
3061
|
+
# chime_bearer: "ChimeArn",
|
2943
3062
|
# })
|
2944
3063
|
#
|
2945
3064
|
# @example Response structure
|
@@ -2962,12 +3081,21 @@ module Aws::Chime
|
|
2962
3081
|
|
2963
3082
|
# Returns the full details of a user's channel membership.
|
2964
3083
|
#
|
3084
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3085
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3086
|
+
# in the header.
|
3087
|
+
#
|
3088
|
+
# </note>
|
3089
|
+
#
|
2965
3090
|
# @option params [required, String] :channel_arn
|
2966
3091
|
# The ARN of the channel.
|
2967
3092
|
#
|
2968
3093
|
# @option params [required, String] :member_arn
|
2969
3094
|
# The ARN of the member.
|
2970
3095
|
#
|
3096
|
+
# @option params [String] :chime_bearer
|
3097
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3098
|
+
#
|
2971
3099
|
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2972
3100
|
#
|
2973
3101
|
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
@@ -2977,6 +3105,7 @@ module Aws::Chime
|
|
2977
3105
|
# resp = client.describe_channel_membership({
|
2978
3106
|
# channel_arn: "ChimeArn", # required
|
2979
3107
|
# member_arn: "ChimeArn", # required
|
3108
|
+
# chime_bearer: "ChimeArn",
|
2980
3109
|
# })
|
2981
3110
|
#
|
2982
3111
|
# @example Response structure
|
@@ -3000,7 +3129,13 @@ module Aws::Chime
|
|
3000
3129
|
end
|
3001
3130
|
|
3002
3131
|
# Returns the details of a channel based on the membership of the
|
3003
|
-
# `AppInstanceUser
|
3132
|
+
# specified `AppInstanceUser`.
|
3133
|
+
#
|
3134
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3135
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3136
|
+
# in the header.
|
3137
|
+
#
|
3138
|
+
# </note>
|
3004
3139
|
#
|
3005
3140
|
# @option params [required, String] :channel_arn
|
3006
3141
|
# The ARN of the channel to which the user belongs.
|
@@ -3008,6 +3143,9 @@ module Aws::Chime
|
|
3008
3143
|
# @option params [required, String] :app_instance_user_arn
|
3009
3144
|
# The ARN of the user in a channel.
|
3010
3145
|
#
|
3146
|
+
# @option params [String] :chime_bearer
|
3147
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3148
|
+
#
|
3011
3149
|
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3012
3150
|
#
|
3013
3151
|
# * {Types::DescribeChannelMembershipForAppInstanceUserResponse#channel_membership #channel_membership} => Types::ChannelMembershipForAppInstanceUserSummary
|
@@ -3017,6 +3155,7 @@ module Aws::Chime
|
|
3017
3155
|
# resp = client.describe_channel_membership_for_app_instance_user({
|
3018
3156
|
# channel_arn: "ChimeArn", # required
|
3019
3157
|
# app_instance_user_arn: "ChimeArn", # required
|
3158
|
+
# chime_bearer: "ChimeArn",
|
3020
3159
|
# })
|
3021
3160
|
#
|
3022
3161
|
# @example Response structure
|
@@ -3042,11 +3181,20 @@ module Aws::Chime
|
|
3042
3181
|
# Returns the full details of a channel moderated by the specified
|
3043
3182
|
# `AppInstanceUser`.
|
3044
3183
|
#
|
3184
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3185
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3186
|
+
# in the header.
|
3187
|
+
#
|
3188
|
+
# </note>
|
3189
|
+
#
|
3045
3190
|
# @option params [required, String] :channel_arn
|
3046
3191
|
# The ARN of the moderated channel.
|
3047
3192
|
#
|
3048
3193
|
# @option params [required, String] :app_instance_user_arn
|
3049
|
-
# The ARN of the
|
3194
|
+
# The ARN of the `AppInstanceUser` in the moderated channel.
|
3195
|
+
#
|
3196
|
+
# @option params [String] :chime_bearer
|
3197
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3050
3198
|
#
|
3051
3199
|
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3052
3200
|
#
|
@@ -3057,6 +3205,7 @@ module Aws::Chime
|
|
3057
3205
|
# resp = client.describe_channel_moderated_by_app_instance_user({
|
3058
3206
|
# channel_arn: "ChimeArn", # required
|
3059
3207
|
# app_instance_user_arn: "ChimeArn", # required
|
3208
|
+
# chime_bearer: "ChimeArn",
|
3060
3209
|
# })
|
3061
3210
|
#
|
3062
3211
|
# @example Response structure
|
@@ -3079,12 +3228,21 @@ module Aws::Chime
|
|
3079
3228
|
|
3080
3229
|
# Returns the full details of a single ChannelModerator.
|
3081
3230
|
#
|
3231
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3232
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3233
|
+
# in the header.
|
3234
|
+
#
|
3235
|
+
# </note>
|
3236
|
+
#
|
3082
3237
|
# @option params [required, String] :channel_arn
|
3083
3238
|
# The ARN of the channel.
|
3084
3239
|
#
|
3085
3240
|
# @option params [required, String] :channel_moderator_arn
|
3086
3241
|
# The ARN of the channel moderator.
|
3087
3242
|
#
|
3243
|
+
# @option params [String] :chime_bearer
|
3244
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3245
|
+
#
|
3088
3246
|
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3089
3247
|
#
|
3090
3248
|
# * {Types::DescribeChannelModeratorResponse#channel_moderator #channel_moderator} => Types::ChannelModerator
|
@@ -3094,6 +3252,7 @@ module Aws::Chime
|
|
3094
3252
|
# resp = client.describe_channel_moderator({
|
3095
3253
|
# channel_arn: "ChimeArn", # required
|
3096
3254
|
# channel_moderator_arn: "ChimeArn", # required
|
3255
|
+
# chime_bearer: "ChimeArn",
|
3097
3256
|
# })
|
3098
3257
|
#
|
3099
3258
|
# @example Response structure
|
@@ -3279,7 +3438,7 @@ module Aws::Chime
|
|
3279
3438
|
end
|
3280
3439
|
|
3281
3440
|
# Retrieves account settings for the specified Amazon Chime account ID,
|
3282
|
-
# such as remote control and
|
3441
|
+
# such as remote control and dialout settings. For more information
|
3283
3442
|
# about these settings, see [Use the Policies Page][1] in the *Amazon
|
3284
3443
|
# Chime Administration Guide*.
|
3285
3444
|
#
|
@@ -3314,10 +3473,10 @@ module Aws::Chime
|
|
3314
3473
|
req.send_request(options)
|
3315
3474
|
end
|
3316
3475
|
|
3317
|
-
# Gets the retention settings for an
|
3476
|
+
# Gets the retention settings for an `AppInstance`.
|
3318
3477
|
#
|
3319
3478
|
# @option params [required, String] :app_instance_arn
|
3320
|
-
# The ARN of the
|
3479
|
+
# The ARN of the `AppInstance`.
|
3321
3480
|
#
|
3322
3481
|
# @return [Types::GetAppInstanceRetentionSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3323
3482
|
#
|
@@ -3344,10 +3503,10 @@ module Aws::Chime
|
|
3344
3503
|
req.send_request(options)
|
3345
3504
|
end
|
3346
3505
|
|
3347
|
-
# Gets the streaming settings for an
|
3506
|
+
# Gets the streaming settings for an `AppInstance`.
|
3348
3507
|
#
|
3349
3508
|
# @option params [required, String] :app_instance_arn
|
3350
|
-
# The ARN of the
|
3509
|
+
# The ARN of the `AppInstance`.
|
3351
3510
|
#
|
3352
3511
|
# @return [Types::GetAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3353
3512
|
#
|
@@ -3376,7 +3535,8 @@ module Aws::Chime
|
|
3376
3535
|
|
3377
3536
|
# Gets the Amazon Chime SDK attendee details for a specified meeting ID
|
3378
3537
|
# 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
|
3538
|
+
# [Using the Amazon Chime SDK][1] in the *Amazon Chime Developer Guide*
|
3539
|
+
# .
|
3380
3540
|
#
|
3381
3541
|
#
|
3382
3542
|
#
|
@@ -3457,12 +3617,21 @@ module Aws::Chime
|
|
3457
3617
|
|
3458
3618
|
# Gets the full details of a channel message.
|
3459
3619
|
#
|
3620
|
+
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
3621
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
3622
|
+
# in the header.
|
3623
|
+
#
|
3624
|
+
# </note>
|
3625
|
+
#
|
3460
3626
|
# @option params [required, String] :channel_arn
|
3461
3627
|
# The ARN of the channel.
|
3462
3628
|
#
|
3463
3629
|
# @option params [required, String] :message_id
|
3464
3630
|
# The ID of the message.
|
3465
3631
|
#
|
3632
|
+
# @option params [String] :chime_bearer
|
3633
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
3634
|
+
#
|
3466
3635
|
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3467
3636
|
#
|
3468
3637
|
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
@@ -3472,6 +3641,7 @@ module Aws::Chime
|
|
3472
3641
|
# resp = client.get_channel_message({
|
3473
3642
|
# channel_arn: "ChimeArn", # required
|
3474
3643
|
# message_id: "MessageId", # required
|
3644
|
+
# chime_bearer: "ChimeArn",
|
3475
3645
|
# })
|
3476
3646
|
#
|
3477
3647
|
# @example Response structure
|
@@ -3558,7 +3728,7 @@ module Aws::Chime
|
|
3558
3728
|
|
3559
3729
|
# Gets the Amazon Chime SDK meeting details for the specified meeting
|
3560
3730
|
# ID. For more information about the Amazon Chime SDK, see [Using the
|
3561
|
-
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide
|
3731
|
+
# Amazon Chime SDK][1] in the *Amazon Chime Developer Guide* .
|
3562
3732
|
#
|
3563
3733
|
#
|
3564
3734
|
#
|
@@ -3599,7 +3769,7 @@ module Aws::Chime
|
|
3599
3769
|
req.send_request(options)
|
3600
3770
|
end
|
3601
3771
|
|
3602
|
-
# The endpoint for the messaging session.
|
3772
|
+
# The details of the endpoint for the messaging session.
|
3603
3773
|
#
|
3604
3774
|
# @return [Types::GetMessagingSessionEndpointResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3605
3775
|
#
|
@@ -3666,9 +3836,9 @@ module Aws::Chime
|
|
3666
3836
|
req.send_request(options)
|
3667
3837
|
end
|
3668
3838
|
|
3669
|
-
# Retrieves details for the specified phone number order, such as
|
3670
|
-
# creation timestamp, phone numbers in E.164 format, product type,
|
3671
|
-
# order status.
|
3839
|
+
# Retrieves details for the specified phone number order, such as the
|
3840
|
+
# order creation timestamp, phone numbers in E.164 format, product type,
|
3841
|
+
# and order status.
|
3672
3842
|
#
|
3673
3843
|
# @option params [required, String] :phone_number_order_id
|
3674
3844
|
# The ID for the phone number order.
|
@@ -3776,8 +3946,8 @@ module Aws::Chime
|
|
3776
3946
|
|
3777
3947
|
# Gets the retention settings for the specified Amazon Chime Enterprise
|
3778
3948
|
# account. For more information about retention settings, see [Managing
|
3779
|
-
# Chat Retention Policies][1] in the *Amazon Chime Administration
|
3780
|
-
#
|
3949
|
+
# Chat Retention Policies][1] in the *Amazon Chime Administration Guide*
|
3950
|
+
# .
|
3781
3951
|
#
|
3782
3952
|
#
|
3783
3953
|
#
|
@@ -3889,7 +4059,7 @@ module Aws::Chime
|
|
3889
4059
|
# application.
|
3890
4060
|
#
|
3891
4061
|
# @option params [required, String] :sip_media_application_id
|
3892
|
-
# The
|
4062
|
+
# The SIP media application ID.
|
3893
4063
|
#
|
3894
4064
|
# @return [Types::GetSipMediaApplicationLoggingConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3895
4065
|
#
|
@@ -3954,7 +4124,7 @@ module Aws::Chime
|
|
3954
4124
|
end
|
3955
4125
|
|
3956
4126
|
# Retrieves details for the specified user ID, such as primary email
|
3957
|
-
# address, license type,
|
4127
|
+
# address, license type,and personal meeting PIN.
|
3958
4128
|
#
|
3959
4129
|
# To retrieve user details with an email address instead of a user ID,
|
3960
4130
|
# use the ListUsers action, and then filter by email address.
|
@@ -4038,7 +4208,7 @@ module Aws::Chime
|
|
4038
4208
|
end
|
4039
4209
|
|
4040
4210
|
# Retrieves details for the specified Amazon Chime Voice Connector, such
|
4041
|
-
# as timestamps,
|
4211
|
+
# as timestamps,name, outbound host, and encryption requirements.
|
4042
4212
|
#
|
4043
4213
|
# @option params [required, String] :voice_connector_id
|
4044
4214
|
# The Amazon Chime Voice Connector ID.
|
@@ -4105,7 +4275,7 @@ module Aws::Chime
|
|
4105
4275
|
end
|
4106
4276
|
|
4107
4277
|
# Retrieves details for the specified Amazon Chime Voice Connector
|
4108
|
-
# group, such as timestamps,
|
4278
|
+
# group, such as timestamps,name, and associated `VoiceConnectorItems` .
|
4109
4279
|
#
|
4110
4280
|
# @option params [required, String] :voice_connector_group_id
|
4111
4281
|
# The Amazon Chime Voice Connector group ID.
|
@@ -4141,7 +4311,7 @@ module Aws::Chime
|
|
4141
4311
|
|
4142
4312
|
# Retrieves the logging configuration details for the specified Amazon
|
4143
4313
|
# Chime Voice Connector. Shows whether SIP message logs are enabled for
|
4144
|
-
# sending to Amazon CloudWatch.
|
4314
|
+
# sending to Amazon CloudWatch Logs.
|
4145
4315
|
#
|
4146
4316
|
# @option params [required, String] :voice_connector_id
|
4147
4317
|
# The Amazon Chime Voice Connector ID.
|
@@ -4381,7 +4551,7 @@ module Aws::Chime
|
|
4381
4551
|
|
4382
4552
|
# Lists the Amazon Chime accounts under the administrator's AWS
|
4383
4553
|
# account. You can filter accounts by account name prefix. To find out
|
4384
|
-
# which Amazon Chime account a user belongs to,
|
4554
|
+
# which Amazon Chime account a user belongs to, toucan filter by the
|
4385
4555
|
# user's email address, which returns one account result.
|
4386
4556
|
#
|
4387
4557
|
# @option params [String] :name
|
@@ -4437,10 +4607,10 @@ module Aws::Chime
|
|
4437
4607
|
req.send_request(options)
|
4438
4608
|
end
|
4439
4609
|
|
4440
|
-
# Returns a list of the administrators in the
|
4610
|
+
# Returns a list of the administrators in the `AppInstance`.
|
4441
4611
|
#
|
4442
4612
|
# @option params [required, String] :app_instance_arn
|
4443
|
-
# The ARN of the
|
4613
|
+
# The ARN of the `AppInstance`.
|
4444
4614
|
#
|
4445
4615
|
# @option params [Integer] :max_results
|
4446
4616
|
# The maximum number of administrators that you want to return.
|
@@ -4482,10 +4652,10 @@ module Aws::Chime
|
|
4482
4652
|
req.send_request(options)
|
4483
4653
|
end
|
4484
4654
|
|
4485
|
-
# List all `AppInstanceUsers` created under a single
|
4655
|
+
# List all `AppInstanceUsers` created under a single `AppInstance`.
|
4486
4656
|
#
|
4487
4657
|
# @option params [required, String] :app_instance_arn
|
4488
|
-
# The ARN of the
|
4658
|
+
# The ARN of the `AppInstance`.
|
4489
4659
|
#
|
4490
4660
|
# @option params [Integer] :max_results
|
4491
4661
|
# The maximum number of requests that you want returned.
|
@@ -4528,15 +4698,15 @@ module Aws::Chime
|
|
4528
4698
|
req.send_request(options)
|
4529
4699
|
end
|
4530
4700
|
|
4531
|
-
# Lists all Amazon Chime
|
4701
|
+
# Lists all Amazon Chime `AppInstance`s created under a single AWS
|
4532
4702
|
# account.
|
4533
4703
|
#
|
4534
4704
|
# @option params [Integer] :max_results
|
4535
|
-
# The maximum number of
|
4705
|
+
# The maximum number of `AppInstance`s that you want to return.
|
4536
4706
|
#
|
4537
4707
|
# @option params [String] :next_token
|
4538
4708
|
# The token passed by previous API requests until you reach the maximum
|
4539
|
-
# number of
|
4709
|
+
# number of `AppInstance`s.
|
4540
4710
|
#
|
4541
4711
|
# @return [Types::ListAppInstancesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4542
4712
|
#
|
@@ -4605,7 +4775,7 @@ module Aws::Chime
|
|
4605
4775
|
|
4606
4776
|
# Lists the attendees for the specified Amazon Chime SDK meeting. For
|
4607
4777
|
# more information about the Amazon Chime SDK, see [Using the Amazon
|
4608
|
-
# Chime SDK][1] in the *Amazon Chime Developer Guide
|
4778
|
+
# Chime SDK][1] in the *Amazon Chime Developer Guide* .
|
4609
4779
|
#
|
4610
4780
|
#
|
4611
4781
|
#
|
@@ -4705,6 +4875,12 @@ module Aws::Chime
|
|
4705
4875
|
|
4706
4876
|
# Lists all the users banned from a particular channel.
|
4707
4877
|
#
|
4878
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4879
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
4880
|
+
# in the header.
|
4881
|
+
#
|
4882
|
+
# </note>
|
4883
|
+
#
|
4708
4884
|
# @option params [required, String] :channel_arn
|
4709
4885
|
# The ARN of the channel.
|
4710
4886
|
#
|
@@ -4715,6 +4891,9 @@ module Aws::Chime
|
|
4715
4891
|
# The token passed by previous API calls until all requested bans are
|
4716
4892
|
# returned.
|
4717
4893
|
#
|
4894
|
+
# @option params [String] :chime_bearer
|
4895
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
4896
|
+
#
|
4718
4897
|
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4719
4898
|
#
|
4720
4899
|
# * {Types::ListChannelBansResponse#channel_arn #channel_arn} => String
|
@@ -4729,6 +4908,7 @@ module Aws::Chime
|
|
4729
4908
|
# channel_arn: "ChimeArn", # required
|
4730
4909
|
# max_results: 1,
|
4731
4910
|
# next_token: "NextToken",
|
4911
|
+
# chime_bearer: "ChimeArn",
|
4732
4912
|
# })
|
4733
4913
|
#
|
4734
4914
|
# @example Response structure
|
@@ -4750,6 +4930,12 @@ module Aws::Chime
|
|
4750
4930
|
|
4751
4931
|
# Lists all channel memberships in a channel.
|
4752
4932
|
#
|
4933
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4934
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
4935
|
+
# in the header.
|
4936
|
+
#
|
4937
|
+
# </note>
|
4938
|
+
#
|
4753
4939
|
# @option params [required, String] :channel_arn
|
4754
4940
|
# The maximum number of channel memberships that you want returned.
|
4755
4941
|
#
|
@@ -4765,7 +4951,10 @@ module Aws::Chime
|
|
4765
4951
|
#
|
4766
4952
|
# @option params [String] :next_token
|
4767
4953
|
# The token passed by previous API calls until all requested channel
|
4768
|
-
# memberships are returned
|
4954
|
+
# memberships are returned.
|
4955
|
+
#
|
4956
|
+
# @option params [String] :chime_bearer
|
4957
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
4769
4958
|
#
|
4770
4959
|
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4771
4960
|
#
|
@@ -4782,6 +4971,7 @@ module Aws::Chime
|
|
4782
4971
|
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
4783
4972
|
# max_results: 1,
|
4784
4973
|
# next_token: "NextToken",
|
4974
|
+
# chime_bearer: "ChimeArn",
|
4785
4975
|
# })
|
4786
4976
|
#
|
4787
4977
|
# @example Response structure
|
@@ -4805,8 +4995,14 @@ module Aws::Chime
|
|
4805
4995
|
# Only an `AppInstanceAdmin` can call the API with a user ARN that is
|
4806
4996
|
# not their own.
|
4807
4997
|
#
|
4998
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
4999
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5000
|
+
# in the header.
|
5001
|
+
#
|
5002
|
+
# </note>
|
5003
|
+
#
|
4808
5004
|
# @option params [String] :app_instance_user_arn
|
4809
|
-
# The ARN of the
|
5005
|
+
# The ARN of the `AppInstanceUser`s
|
4810
5006
|
#
|
4811
5007
|
# @option params [Integer] :max_results
|
4812
5008
|
# The maximum number of users that you want returned.
|
@@ -4815,6 +5011,9 @@ module Aws::Chime
|
|
4815
5011
|
# The token returned from previous API requests until the number of
|
4816
5012
|
# channel memberships is reached.
|
4817
5013
|
#
|
5014
|
+
# @option params [String] :chime_bearer
|
5015
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5016
|
+
#
|
4818
5017
|
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4819
5018
|
#
|
4820
5019
|
# * {Types::ListChannelMembershipsForAppInstanceUserResponse#channel_memberships #channel_memberships} => Array<Types::ChannelMembershipForAppInstanceUserSummary>
|
@@ -4828,6 +5027,7 @@ module Aws::Chime
|
|
4828
5027
|
# app_instance_user_arn: "ChimeArn",
|
4829
5028
|
# max_results: 1,
|
4830
5029
|
# next_token: "NextToken",
|
5030
|
+
# chime_bearer: "ChimeArn",
|
4831
5031
|
# })
|
4832
5032
|
#
|
4833
5033
|
# @example Response structure
|
@@ -4853,13 +5053,17 @@ module Aws::Chime
|
|
4853
5053
|
end
|
4854
5054
|
|
4855
5055
|
# List all the messages in a channel. Returns a paginated list of
|
4856
|
-
# `ChannelMessages`.
|
4857
|
-
#
|
5056
|
+
# `ChannelMessages`. By default, sorted by creation timestamp in
|
5057
|
+
# descending order .
|
4858
5058
|
#
|
4859
5059
|
# <note markdown="1"> Redacted messages appear in the results as empty, since they are only
|
4860
5060
|
# redacted, not deleted. Deleted messages do not appear in the results.
|
4861
5061
|
# This action always returns the latest version of an edited message.
|
4862
5062
|
#
|
5063
|
+
# Also, the x-amz-chime-bearer request header is mandatory. Use the
|
5064
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5065
|
+
# in the header.
|
5066
|
+
#
|
4863
5067
|
# </note>
|
4864
5068
|
#
|
4865
5069
|
# @option params [required, String] :channel_arn
|
@@ -4882,6 +5086,9 @@ module Aws::Chime
|
|
4882
5086
|
# The token passed by previous API calls until all requested messages
|
4883
5087
|
# are returned.
|
4884
5088
|
#
|
5089
|
+
# @option params [String] :chime_bearer
|
5090
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5091
|
+
#
|
4885
5092
|
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4886
5093
|
#
|
4887
5094
|
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
@@ -4899,6 +5106,7 @@ module Aws::Chime
|
|
4899
5106
|
# not_after: Time.now,
|
4900
5107
|
# max_results: 1,
|
4901
5108
|
# next_token: "NextToken",
|
5109
|
+
# chime_bearer: "ChimeArn",
|
4902
5110
|
# })
|
4903
5111
|
#
|
4904
5112
|
# @example Response structure
|
@@ -4928,6 +5136,12 @@ module Aws::Chime
|
|
4928
5136
|
|
4929
5137
|
# Lists all the moderators for a channel.
|
4930
5138
|
#
|
5139
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5140
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5141
|
+
# in the header.
|
5142
|
+
#
|
5143
|
+
# </note>
|
5144
|
+
#
|
4931
5145
|
# @option params [required, String] :channel_arn
|
4932
5146
|
# The ARN of the channel.
|
4933
5147
|
#
|
@@ -4938,6 +5152,9 @@ module Aws::Chime
|
|
4938
5152
|
# The token passed by previous API calls until all requested moderators
|
4939
5153
|
# are returned.
|
4940
5154
|
#
|
5155
|
+
# @option params [String] :chime_bearer
|
5156
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5157
|
+
#
|
4941
5158
|
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4942
5159
|
#
|
4943
5160
|
# * {Types::ListChannelModeratorsResponse#channel_arn #channel_arn} => String
|
@@ -4952,6 +5169,7 @@ module Aws::Chime
|
|
4952
5169
|
# channel_arn: "ChimeArn", # required
|
4953
5170
|
# max_results: 1,
|
4954
5171
|
# next_token: "NextToken",
|
5172
|
+
# chime_bearer: "ChimeArn",
|
4955
5173
|
# })
|
4956
5174
|
#
|
4957
5175
|
# @example Response structure
|
@@ -4982,13 +5200,19 @@ module Aws::Chime
|
|
4982
5200
|
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
4983
5201
|
# private channels in an account.
|
4984
5202
|
#
|
5203
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5204
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5205
|
+
# in the header.
|
5206
|
+
#
|
5207
|
+
# </note>
|
5208
|
+
#
|
4985
5209
|
# @option params [required, String] :app_instance_arn
|
4986
|
-
# The ARN of the
|
5210
|
+
# The ARN of the `AppInstance`.
|
4987
5211
|
#
|
4988
5212
|
# @option params [String] :privacy
|
4989
5213
|
# The privacy setting. `PUBLIC` retrieves all the public channels.
|
4990
|
-
# `PRIVATE` retrieves private channels. Only an
|
4991
|
-
#
|
5214
|
+
# `PRIVATE` retrieves private channels. Only an `AppInstanceAdmin` can
|
5215
|
+
# retrieve private channels.
|
4992
5216
|
#
|
4993
5217
|
# @option params [Integer] :max_results
|
4994
5218
|
# The maximum number of channels that you want to return.
|
@@ -4997,6 +5221,9 @@ module Aws::Chime
|
|
4997
5221
|
# The token passed by previous API calls until all requested channels
|
4998
5222
|
# are returned.
|
4999
5223
|
#
|
5224
|
+
# @option params [String] :chime_bearer
|
5225
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5226
|
+
#
|
5000
5227
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5001
5228
|
#
|
5002
5229
|
# * {Types::ListChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
@@ -5011,6 +5238,7 @@ module Aws::Chime
|
|
5011
5238
|
# privacy: "PUBLIC", # accepts PUBLIC, PRIVATE
|
5012
5239
|
# max_results: 1,
|
5013
5240
|
# next_token: "NextToken",
|
5241
|
+
# chime_bearer: "ChimeArn",
|
5014
5242
|
# })
|
5015
5243
|
#
|
5016
5244
|
# @example Response structure
|
@@ -5033,7 +5261,13 @@ module Aws::Chime
|
|
5033
5261
|
req.send_request(options)
|
5034
5262
|
end
|
5035
5263
|
|
5036
|
-
# A list of the channels moderated by an
|
5264
|
+
# A list of the channels moderated by an `AppInstanceUser`.
|
5265
|
+
#
|
5266
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
5267
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
5268
|
+
# in the header.
|
5269
|
+
#
|
5270
|
+
# </note>
|
5037
5271
|
#
|
5038
5272
|
# @option params [String] :app_instance_user_arn
|
5039
5273
|
# The ARN of the user in the moderated channel.
|
@@ -5045,6 +5279,9 @@ module Aws::Chime
|
|
5045
5279
|
# The token returned from previous API requests until the number of
|
5046
5280
|
# channels moderated by the user is reached.
|
5047
5281
|
#
|
5282
|
+
# @option params [String] :chime_bearer
|
5283
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
5284
|
+
#
|
5048
5285
|
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5049
5286
|
#
|
5050
5287
|
# * {Types::ListChannelsModeratedByAppInstanceUserResponse#channels #channels} => Array<Types::ChannelModeratedByAppInstanceUserSummary>
|
@@ -5058,6 +5295,7 @@ module Aws::Chime
|
|
5058
5295
|
# app_instance_user_arn: "ChimeArn",
|
5059
5296
|
# max_results: 1,
|
5060
5297
|
# next_token: "NextToken",
|
5298
|
+
# chime_bearer: "ChimeArn",
|
5061
5299
|
# })
|
5062
5300
|
#
|
5063
5301
|
# @example Response structure
|
@@ -5112,7 +5350,7 @@ module Aws::Chime
|
|
5112
5350
|
|
5113
5351
|
# Lists up to 100 active Amazon Chime SDK meetings. For more information
|
5114
5352
|
# about the Amazon Chime SDK, see [Using the Amazon Chime SDK][1] in the
|
5115
|
-
# *Amazon Chime Developer Guide
|
5353
|
+
# *Amazon Chime Developer Guide* .
|
5116
5354
|
#
|
5117
5355
|
#
|
5118
5356
|
#
|
@@ -5787,11 +6025,11 @@ module Aws::Chime
|
|
5787
6025
|
req.send_request(options)
|
5788
6026
|
end
|
5789
6027
|
|
5790
|
-
# Sets the amount of time in days that a given
|
6028
|
+
# Sets the amount of time in days that a given `AppInstance` retains
|
5791
6029
|
# data.
|
5792
6030
|
#
|
5793
6031
|
# @option params [required, String] :app_instance_arn
|
5794
|
-
# The ARN of the
|
6032
|
+
# The ARN of the `AppInstance`.
|
5795
6033
|
#
|
5796
6034
|
# @option params [required, Types::AppInstanceRetentionSettings] :app_instance_retention_settings
|
5797
6035
|
# The time in days to retain data. Data type: number.
|
@@ -5826,13 +6064,13 @@ module Aws::Chime
|
|
5826
6064
|
req.send_request(options)
|
5827
6065
|
end
|
5828
6066
|
|
5829
|
-
# The data streaming configurations of an
|
6067
|
+
# The data streaming configurations of an `AppInstance`.
|
5830
6068
|
#
|
5831
6069
|
# @option params [required, String] :app_instance_arn
|
5832
|
-
# The ARN of the
|
6070
|
+
# The ARN of the `AppInstance`.
|
5833
6071
|
#
|
5834
6072
|
# @option params [required, Array<Types::AppInstanceStreamingConfiguration>] :app_instance_streaming_configurations
|
5835
|
-
# The streaming configurations set for an
|
6073
|
+
# The streaming configurations set for an `AppInstance`.
|
5836
6074
|
#
|
5837
6075
|
# @return [Types::PutAppInstanceStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5838
6076
|
#
|
@@ -5913,13 +6151,13 @@ module Aws::Chime
|
|
5913
6151
|
# account. We recommend using AWS CloudTrail to monitor usage of this
|
5914
6152
|
# API for your account. For more information, see [Logging Amazon Chime
|
5915
6153
|
# API Calls with AWS CloudTrail][1] in the *Amazon Chime Administration
|
5916
|
-
# Guide
|
6154
|
+
# Guide* .
|
5917
6155
|
#
|
5918
6156
|
# To turn off existing retention settings, remove the number of days
|
5919
6157
|
# from the corresponding **RetentionDays** field in the
|
5920
6158
|
# **RetentionSettings** object. For more information about retention
|
5921
6159
|
# settings, see [Managing Chat Retention Policies][2] in the *Amazon
|
5922
|
-
# Chime Administration Guide
|
6160
|
+
# Chime Administration Guide* .
|
5923
6161
|
#
|
5924
6162
|
#
|
5925
6163
|
#
|
@@ -5970,7 +6208,7 @@ module Aws::Chime
|
|
5970
6208
|
# application.
|
5971
6209
|
#
|
5972
6210
|
# @option params [required, String] :sip_media_application_id
|
5973
|
-
# The
|
6211
|
+
# The SIP media application ID.
|
5974
6212
|
#
|
5975
6213
|
# @option params [Types::SipMediaApplicationLoggingConfiguration] :sip_media_application_logging_configuration
|
5976
6214
|
# The actual logging configuration.
|
@@ -6192,7 +6430,7 @@ module Aws::Chime
|
|
6192
6430
|
|
6193
6431
|
# Adds a streaming configuration for the specified Amazon Chime Voice
|
6194
6432
|
# Connector. The streaming configuration specifies whether media
|
6195
|
-
# streaming is enabled for sending to
|
6433
|
+
# streaming is enabled for sending to Indonesians. It also sets the
|
6196
6434
|
# retention period, in hours, for the Amazon Kinesis data.
|
6197
6435
|
#
|
6198
6436
|
# @option params [required, String] :voice_connector_id
|
@@ -6323,6 +6561,12 @@ module Aws::Chime
|
|
6323
6561
|
# back end, but the action returns null content, and the state shows as
|
6324
6562
|
# redacted.
|
6325
6563
|
#
|
6564
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
6565
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
6566
|
+
# in the header.
|
6567
|
+
#
|
6568
|
+
# </note>
|
6569
|
+
#
|
6326
6570
|
# @option params [required, String] :channel_arn
|
6327
6571
|
# The ARN of the channel containing the messages that you want to
|
6328
6572
|
# redact.
|
@@ -6330,6 +6574,9 @@ module Aws::Chime
|
|
6330
6574
|
# @option params [required, String] :message_id
|
6331
6575
|
# The ID of the message being redacted.
|
6332
6576
|
#
|
6577
|
+
# @option params [String] :chime_bearer
|
6578
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
6579
|
+
#
|
6333
6580
|
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6334
6581
|
#
|
6335
6582
|
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -6340,6 +6587,7 @@ module Aws::Chime
|
|
6340
6587
|
# resp = client.redact_channel_message({
|
6341
6588
|
# channel_arn: "ChimeArn", # required
|
6342
6589
|
# message_id: "MessageId", # required
|
6590
|
+
# chime_bearer: "ChimeArn",
|
6343
6591
|
# })
|
6344
6592
|
#
|
6345
6593
|
# @example Response structure
|
@@ -6607,8 +6855,13 @@ module Aws::Chime
|
|
6607
6855
|
|
6608
6856
|
# Sends a message to a particular channel that the member is a part of.
|
6609
6857
|
#
|
6610
|
-
# <note markdown="1"> `
|
6611
|
-
# `
|
6858
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
6859
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
6860
|
+
# in the header.
|
6861
|
+
#
|
6862
|
+
# Also, `STANDARD` messages can contain 4KB of data and the 1KB of
|
6863
|
+
# metadata. `CONTROL` messages can contain 30 bytes of data and no
|
6864
|
+
# metadata.
|
6612
6865
|
#
|
6613
6866
|
# </note>
|
6614
6867
|
#
|
@@ -6634,6 +6887,9 @@ module Aws::Chime
|
|
6634
6887
|
# **A suitable default value is auto-generated.** You should normally
|
6635
6888
|
# not need to pass this option.**
|
6636
6889
|
#
|
6890
|
+
# @option params [String] :chime_bearer
|
6891
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
6892
|
+
#
|
6637
6893
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6638
6894
|
#
|
6639
6895
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -6648,6 +6904,7 @@ module Aws::Chime
|
|
6648
6904
|
# persistence: "PERSISTENT", # required, accepts PERSISTENT, NON_PERSISTENT
|
6649
6905
|
# metadata: "Metadata",
|
6650
6906
|
# client_request_token: "ClientRequestToken", # required
|
6907
|
+
# chime_bearer: "ChimeArn",
|
6651
6908
|
# })
|
6652
6909
|
#
|
6653
6910
|
# @example Response structure
|
@@ -6927,7 +7184,7 @@ module Aws::Chime
|
|
6927
7184
|
# Updates `AppInstance` metadata.
|
6928
7185
|
#
|
6929
7186
|
# @option params [required, String] :app_instance_arn
|
6930
|
-
# The ARN of the
|
7187
|
+
# The ARN of the `AppInstance`.
|
6931
7188
|
#
|
6932
7189
|
# @option params [required, String] :name
|
6933
7190
|
# The name that you want to change.
|
@@ -6960,17 +7217,17 @@ module Aws::Chime
|
|
6960
7217
|
req.send_request(options)
|
6961
7218
|
end
|
6962
7219
|
|
6963
|
-
# Updates the details
|
7220
|
+
# Updates the details of an `AppInstanceUser`. You can update names and
|
6964
7221
|
# metadata.
|
6965
7222
|
#
|
6966
7223
|
# @option params [required, String] :app_instance_user_arn
|
6967
|
-
# The ARN of the
|
7224
|
+
# The ARN of the `AppInstanceUser`.
|
6968
7225
|
#
|
6969
7226
|
# @option params [required, String] :name
|
6970
|
-
# The name of the
|
7227
|
+
# The name of the `AppInstanceUser`.
|
6971
7228
|
#
|
6972
7229
|
# @option params [String] :metadata
|
6973
|
-
# The metadata of the
|
7230
|
+
# The metadata of the `AppInstanceUser`.
|
6974
7231
|
#
|
6975
7232
|
# @return [Types::UpdateAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6976
7233
|
#
|
@@ -7046,6 +7303,12 @@ module Aws::Chime
|
|
7046
7303
|
#
|
7047
7304
|
# **Restriction**\: You can't change a channel's privacy.
|
7048
7305
|
#
|
7306
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7307
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7308
|
+
# in the header.
|
7309
|
+
#
|
7310
|
+
# </note>
|
7311
|
+
#
|
7049
7312
|
# @option params [required, String] :channel_arn
|
7050
7313
|
# The ARN of the channel.
|
7051
7314
|
#
|
@@ -7056,7 +7319,10 @@ module Aws::Chime
|
|
7056
7319
|
# The mode of the update request.
|
7057
7320
|
#
|
7058
7321
|
# @option params [String] :metadata
|
7059
|
-
# The metadata
|
7322
|
+
# The metadata for the update request.
|
7323
|
+
#
|
7324
|
+
# @option params [String] :chime_bearer
|
7325
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7060
7326
|
#
|
7061
7327
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7062
7328
|
#
|
@@ -7069,6 +7335,7 @@ module Aws::Chime
|
|
7069
7335
|
# name: "NonEmptyResourceName", # required
|
7070
7336
|
# mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
|
7071
7337
|
# metadata: "Metadata",
|
7338
|
+
# chime_bearer: "ChimeArn",
|
7072
7339
|
# })
|
7073
7340
|
#
|
7074
7341
|
# @example Response structure
|
@@ -7086,6 +7353,12 @@ module Aws::Chime
|
|
7086
7353
|
|
7087
7354
|
# Updates the content of a message.
|
7088
7355
|
#
|
7356
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7357
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7358
|
+
# in the header.
|
7359
|
+
#
|
7360
|
+
# </note>
|
7361
|
+
#
|
7089
7362
|
# @option params [required, String] :channel_arn
|
7090
7363
|
# The ARN of the channel.
|
7091
7364
|
#
|
@@ -7098,6 +7371,9 @@ module Aws::Chime
|
|
7098
7371
|
# @option params [String] :metadata
|
7099
7372
|
# The metadata of the message being updated.
|
7100
7373
|
#
|
7374
|
+
# @option params [String] :chime_bearer
|
7375
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7376
|
+
#
|
7101
7377
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7102
7378
|
#
|
7103
7379
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -7110,6 +7386,7 @@ module Aws::Chime
|
|
7110
7386
|
# message_id: "MessageId", # required
|
7111
7387
|
# content: "Content",
|
7112
7388
|
# metadata: "Metadata",
|
7389
|
+
# chime_bearer: "ChimeArn",
|
7113
7390
|
# })
|
7114
7391
|
#
|
7115
7392
|
# @example Response structure
|
@@ -7126,12 +7403,20 @@ module Aws::Chime
|
|
7126
7403
|
req.send_request(options)
|
7127
7404
|
end
|
7128
7405
|
|
7129
|
-
#
|
7130
|
-
#
|
7406
|
+
# The details of the time when a user last read messages in a channel.
|
7407
|
+
#
|
7408
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
7409
|
+
# `AppInstanceUserArn` of the user that makes the API call as the value
|
7410
|
+
# in the header.
|
7411
|
+
#
|
7412
|
+
# </note>
|
7131
7413
|
#
|
7132
7414
|
# @option params [required, String] :channel_arn
|
7133
7415
|
# The ARN of the channel.
|
7134
7416
|
#
|
7417
|
+
# @option params [String] :chime_bearer
|
7418
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
7419
|
+
#
|
7135
7420
|
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7136
7421
|
#
|
7137
7422
|
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
@@ -7140,6 +7425,7 @@ module Aws::Chime
|
|
7140
7425
|
#
|
7141
7426
|
# resp = client.update_channel_read_marker({
|
7142
7427
|
# channel_arn: "ChimeArn", # required
|
7428
|
+
# chime_bearer: "ChimeArn",
|
7143
7429
|
# })
|
7144
7430
|
#
|
7145
7431
|
# @example Response structure
|
@@ -7427,7 +7713,7 @@ module Aws::Chime
|
|
7427
7713
|
req.send_request(options)
|
7428
7714
|
end
|
7429
7715
|
|
7430
|
-
# Updates the details
|
7716
|
+
# Updates the details of the specified SIP media application.
|
7431
7717
|
#
|
7432
7718
|
# @option params [required, String] :sip_media_application_id
|
7433
7719
|
# The SIP media application ID.
|
@@ -7473,7 +7759,7 @@ module Aws::Chime
|
|
7473
7759
|
req.send_request(options)
|
7474
7760
|
end
|
7475
7761
|
|
7476
|
-
# Updates the details
|
7762
|
+
# Updates the details of the specified SIP rule.
|
7477
7763
|
#
|
7478
7764
|
# @option params [required, String] :sip_rule_id
|
7479
7765
|
# The SIP rule ID.
|
@@ -7671,7 +7957,7 @@ module Aws::Chime
|
|
7671
7957
|
req.send_request(options)
|
7672
7958
|
end
|
7673
7959
|
|
7674
|
-
# Updates details
|
7960
|
+
# Updates details of the specified Amazon Chime Voice Connector group,
|
7675
7961
|
# such as the name and Amazon Chime Voice Connector priority ranking.
|
7676
7962
|
#
|
7677
7963
|
# @option params [required, String] :voice_connector_group_id
|
@@ -7732,7 +8018,7 @@ module Aws::Chime
|
|
7732
8018
|
params: params,
|
7733
8019
|
config: config)
|
7734
8020
|
context[:gem_name] = 'aws-sdk-chime'
|
7735
|
-
context[:gem_version] = '1.
|
8021
|
+
context[:gem_version] = '1.40.0'
|
7736
8022
|
Seahorse::Client::Request.new(handlers, context)
|
7737
8023
|
end
|
7738
8024
|
|