aws-sdk-chimesdkmessaging 1.16.0 → 1.17.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/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +283 -154
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +42 -1
- data/lib/aws-sdk-chimesdkmessaging/endpoints.rb +14 -0
- data/lib/aws-sdk-chimesdkmessaging/plugins/endpoints.rb +2 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +182 -54
- data/lib/aws-sdk-chimesdkmessaging.rb +1 -1
- metadata +2 -2
@@ -374,8 +374,8 @@ module Aws::ChimeSDKMessaging
|
|
374
374
|
#
|
375
375
|
# <note markdown="1"> Only administrators or channel moderators can associate a channel
|
376
376
|
# flow. The `x-amz-chime-bearer` request header is mandatory. Use the
|
377
|
-
#
|
378
|
-
# in the header.
|
377
|
+
# ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API
|
378
|
+
# call as the value in the header.
|
379
379
|
#
|
380
380
|
# </note>
|
381
381
|
#
|
@@ -407,10 +407,10 @@ module Aws::ChimeSDKMessaging
|
|
407
407
|
req.send_request(options)
|
408
408
|
end
|
409
409
|
|
410
|
-
# Adds a specified number of users to a channel.
|
410
|
+
# Adds a specified number of users and bots to a channel.
|
411
411
|
#
|
412
412
|
# @option params [required, String] :channel_arn
|
413
|
-
# The ARN of the channel to which you're adding users.
|
413
|
+
# The ARN of the channel to which you're adding users or bots.
|
414
414
|
#
|
415
415
|
# @option params [String] :type
|
416
416
|
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
@@ -420,11 +420,13 @@ module Aws::ChimeSDKMessaging
|
|
420
420
|
# not returned. This is only supported by moderators.
|
421
421
|
#
|
422
422
|
# @option params [required, Array<String>] :member_arns
|
423
|
-
# The
|
424
|
-
# channel
|
423
|
+
# The ARNs of the members you want to add to the channel. Only
|
424
|
+
# `AppInstanceUsers` and `AppInstanceBots` can be added as a channel
|
425
|
+
# member.
|
425
426
|
#
|
426
427
|
# @option params [required, String] :chime_bearer
|
427
|
-
# The
|
428
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
429
|
+
# API call.
|
428
430
|
#
|
429
431
|
# @option params [String] :sub_channel_id
|
430
432
|
# The ID of the SubChannel in the request.
|
@@ -528,6 +530,7 @@ module Aws::ChimeSDKMessaging
|
|
528
530
|
# },
|
529
531
|
# },
|
530
532
|
# sub_channel_id: "SubChannelId",
|
533
|
+
# content_type: "ContentType",
|
531
534
|
# },
|
532
535
|
# })
|
533
536
|
#
|
@@ -549,9 +552,9 @@ module Aws::ChimeSDKMessaging
|
|
549
552
|
#
|
550
553
|
# **Restriction**: You can't change a channel's privacy.
|
551
554
|
#
|
552
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
553
|
-
# `
|
554
|
-
# in the header.
|
555
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
556
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
557
|
+
# the value in the header.
|
555
558
|
#
|
556
559
|
# </note>
|
557
560
|
#
|
@@ -585,7 +588,8 @@ module Aws::ChimeSDKMessaging
|
|
585
588
|
# The tags for the creation request.
|
586
589
|
#
|
587
590
|
# @option params [required, String] :chime_bearer
|
588
|
-
# The
|
591
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
592
|
+
# API call.
|
589
593
|
#
|
590
594
|
# @option params [String] :channel_id
|
591
595
|
# The ID of the channel in the request.
|
@@ -601,6 +605,10 @@ module Aws::ChimeSDKMessaging
|
|
601
605
|
# elastic channel can support a maximum of 1-million users, excluding
|
602
606
|
# moderators.
|
603
607
|
#
|
608
|
+
# @option params [Types::ExpirationSettings] :expiration_settings
|
609
|
+
# Settings that control the interval after which the channel is
|
610
|
+
# automatically deleted.
|
611
|
+
#
|
604
612
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
605
613
|
#
|
606
614
|
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
@@ -629,6 +637,10 @@ module Aws::ChimeSDKMessaging
|
|
629
637
|
# target_memberships_per_sub_channel: 1, # required
|
630
638
|
# minimum_membership_percentage: 1, # required
|
631
639
|
# },
|
640
|
+
# expiration_settings: {
|
641
|
+
# expiration_days: 1, # required
|
642
|
+
# expiration_criterion: "CREATED_TIMESTAMP", # required, accepts CREATED_TIMESTAMP, LAST_MESSAGE_TIMESTAMP
|
643
|
+
# },
|
632
644
|
# })
|
633
645
|
#
|
634
646
|
# @example Response structure
|
@@ -652,9 +664,9 @@ module Aws::ChimeSDKMessaging
|
|
652
664
|
# If you ban a user who is already part of a channel, that user is
|
653
665
|
# automatically kicked from the channel.
|
654
666
|
#
|
655
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
656
|
-
# `
|
657
|
-
# in the header.
|
667
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
668
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
669
|
+
# the value in the header.
|
658
670
|
#
|
659
671
|
# </note>
|
660
672
|
#
|
@@ -665,7 +677,8 @@ module Aws::ChimeSDKMessaging
|
|
665
677
|
# The `AppInstanceUserArn` of the member being banned.
|
666
678
|
#
|
667
679
|
# @option params [required, String] :chime_bearer
|
668
|
-
# The
|
680
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
681
|
+
# API call.
|
669
682
|
#
|
670
683
|
# @return [Types::CreateChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
671
684
|
#
|
@@ -778,8 +791,9 @@ module Aws::ChimeSDKMessaging
|
|
778
791
|
req.send_request(options)
|
779
792
|
end
|
780
793
|
|
781
|
-
# Adds a
|
782
|
-
# is derived from the request header. A channel
|
794
|
+
# Adds a member to a channel. The `InvitedBy` field in
|
795
|
+
# `ChannelMembership` is derived from the request header. A channel
|
796
|
+
# member can:
|
783
797
|
#
|
784
798
|
# * List messages
|
785
799
|
#
|
@@ -798,9 +812,9 @@ module Aws::ChimeSDKMessaging
|
|
798
812
|
#
|
799
813
|
# * Private Channels: You must be a member to list or send messages.
|
800
814
|
#
|
801
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
802
|
-
# `AppInstanceUserArn`
|
803
|
-
# in the header.
|
815
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
816
|
+
# the `AppInstanceUserArn` or `AppInstanceBot` that makes the API call
|
817
|
+
# as the value in the header.
|
804
818
|
#
|
805
819
|
# </note>
|
806
820
|
#
|
@@ -818,7 +832,8 @@ module Aws::ChimeSDKMessaging
|
|
818
832
|
# not returned. This is only supported by moderators.
|
819
833
|
#
|
820
834
|
# @option params [required, String] :chime_bearer
|
821
|
-
# The
|
835
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
836
|
+
# API call.
|
822
837
|
#
|
823
838
|
# @option params [String] :sub_channel_id
|
824
839
|
# The ID of the SubChannel in the request.
|
@@ -872,9 +887,9 @@ module Aws::ChimeSDKMessaging
|
|
872
887
|
#
|
873
888
|
# * List messages in the channel.
|
874
889
|
#
|
875
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
876
|
-
# `
|
877
|
-
# in the header.
|
890
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
891
|
+
# the `AppInstanceUser` or `AppInstanceBot`of the user that makes the
|
892
|
+
# API call as the value in the header.
|
878
893
|
#
|
879
894
|
# </note>
|
880
895
|
#
|
@@ -885,7 +900,8 @@ module Aws::ChimeSDKMessaging
|
|
885
900
|
# The `AppInstanceUserArn` of the moderator.
|
886
901
|
#
|
887
902
|
# @option params [required, String] :chime_bearer
|
888
|
-
# The
|
903
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
904
|
+
# API call.
|
889
905
|
#
|
890
906
|
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
891
907
|
#
|
@@ -918,9 +934,9 @@ module Aws::ChimeSDKMessaging
|
|
918
934
|
# Immediately makes a channel and its memberships inaccessible and marks
|
919
935
|
# them for deletion. This is an irreversible process.
|
920
936
|
#
|
921
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
922
|
-
# `AppInstanceUserArn`
|
923
|
-
# in the header.
|
937
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
938
|
+
# the `AppInstanceUserArn` or `AppInstanceBot` that makes the API call
|
939
|
+
# as the value in the header.
|
924
940
|
#
|
925
941
|
# </note>
|
926
942
|
#
|
@@ -928,7 +944,8 @@ module Aws::ChimeSDKMessaging
|
|
928
944
|
# The ARN of the channel being deleted.
|
929
945
|
#
|
930
946
|
# @option params [required, String] :chime_bearer
|
931
|
-
# The
|
947
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
948
|
+
# API call.
|
932
949
|
#
|
933
950
|
# @option params [String] :sub_channel_id
|
934
951
|
# The ID of the SubChannel in the request.
|
@@ -952,11 +969,11 @@ module Aws::ChimeSDKMessaging
|
|
952
969
|
req.send_request(options)
|
953
970
|
end
|
954
971
|
|
955
|
-
# Removes a
|
972
|
+
# Removes a member from a channel's ban list.
|
956
973
|
#
|
957
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
958
|
-
# `
|
959
|
-
# in the header.
|
974
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
975
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
976
|
+
# the value in the header.
|
960
977
|
#
|
961
978
|
# </note>
|
962
979
|
#
|
@@ -967,7 +984,8 @@ module Aws::ChimeSDKMessaging
|
|
967
984
|
# The ARN of the `AppInstanceUser` that you want to reinstate.
|
968
985
|
#
|
969
986
|
# @option params [required, String] :chime_bearer
|
970
|
-
# The
|
987
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
988
|
+
# API call.
|
971
989
|
#
|
972
990
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
973
991
|
#
|
@@ -1035,7 +1053,8 @@ module Aws::ChimeSDKMessaging
|
|
1035
1053
|
# channel.
|
1036
1054
|
#
|
1037
1055
|
# @option params [required, String] :chime_bearer
|
1038
|
-
# The
|
1056
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1057
|
+
# API call.
|
1039
1058
|
#
|
1040
1059
|
# @option params [String] :sub_channel_id
|
1041
1060
|
# The ID of the SubChannel in the request.
|
@@ -1068,9 +1087,9 @@ module Aws::ChimeSDKMessaging
|
|
1068
1087
|
# Deletion makes messages inaccessible immediately. A background process
|
1069
1088
|
# deletes any revisions created by `UpdateChannelMessage`.
|
1070
1089
|
#
|
1071
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1072
|
-
# `
|
1073
|
-
# in the header.
|
1090
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1091
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1092
|
+
# the value in the header.
|
1074
1093
|
#
|
1075
1094
|
# </note>
|
1076
1095
|
#
|
@@ -1081,7 +1100,8 @@ module Aws::ChimeSDKMessaging
|
|
1081
1100
|
# The ID of the message being deleted.
|
1082
1101
|
#
|
1083
1102
|
# @option params [required, String] :chime_bearer
|
1084
|
-
# The
|
1103
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1104
|
+
# API call.
|
1085
1105
|
#
|
1086
1106
|
# @option params [String] :sub_channel_id
|
1087
1107
|
# The ID of the SubChannel in the request.
|
@@ -1113,9 +1133,9 @@ module Aws::ChimeSDKMessaging
|
|
1113
1133
|
|
1114
1134
|
# Deletes a channel moderator.
|
1115
1135
|
#
|
1116
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1117
|
-
# `
|
1118
|
-
# in the header.
|
1136
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1137
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1138
|
+
# the value in the header.
|
1119
1139
|
#
|
1120
1140
|
# </note>
|
1121
1141
|
#
|
@@ -1126,7 +1146,8 @@ module Aws::ChimeSDKMessaging
|
|
1126
1146
|
# The `AppInstanceUserArn` of the moderator being deleted.
|
1127
1147
|
#
|
1128
1148
|
# @option params [required, String] :chime_bearer
|
1129
|
-
# The
|
1149
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1150
|
+
# API call.
|
1130
1151
|
#
|
1131
1152
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1132
1153
|
#
|
@@ -1178,9 +1199,9 @@ module Aws::ChimeSDKMessaging
|
|
1178
1199
|
# Returns the full details of a channel in an Amazon Chime
|
1179
1200
|
# `AppInstance`.
|
1180
1201
|
#
|
1181
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1182
|
-
# `
|
1183
|
-
# in the header.
|
1202
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1203
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1204
|
+
# the value in the header.
|
1184
1205
|
#
|
1185
1206
|
# </note>
|
1186
1207
|
#
|
@@ -1188,7 +1209,8 @@ module Aws::ChimeSDKMessaging
|
|
1188
1209
|
# The ARN of the channel.
|
1189
1210
|
#
|
1190
1211
|
# @option params [required, String] :chime_bearer
|
1191
|
-
# The
|
1212
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1213
|
+
# API call.
|
1192
1214
|
#
|
1193
1215
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1194
1216
|
#
|
@@ -1217,6 +1239,8 @@ module Aws::ChimeSDKMessaging
|
|
1217
1239
|
# resp.channel.elastic_channel_configuration.maximum_sub_channels #=> Integer
|
1218
1240
|
# resp.channel.elastic_channel_configuration.target_memberships_per_sub_channel #=> Integer
|
1219
1241
|
# resp.channel.elastic_channel_configuration.minimum_membership_percentage #=> Integer
|
1242
|
+
# resp.channel.expiration_settings.expiration_days #=> Integer
|
1243
|
+
# resp.channel.expiration_settings.expiration_criterion #=> String, one of "CREATED_TIMESTAMP", "LAST_MESSAGE_TIMESTAMP"
|
1220
1244
|
#
|
1221
1245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
|
1222
1246
|
#
|
@@ -1229,9 +1253,9 @@ module Aws::ChimeSDKMessaging
|
|
1229
1253
|
|
1230
1254
|
# Returns the full details of a channel ban.
|
1231
1255
|
#
|
1232
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1233
|
-
# `
|
1234
|
-
# in the header.
|
1256
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1257
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1258
|
+
# the value in the header.
|
1235
1259
|
#
|
1236
1260
|
# </note>
|
1237
1261
|
#
|
@@ -1242,7 +1266,8 @@ module Aws::ChimeSDKMessaging
|
|
1242
1266
|
# The `AppInstanceUserArn` of the member being banned.
|
1243
1267
|
#
|
1244
1268
|
# @option params [required, String] :chime_bearer
|
1245
|
-
# The
|
1269
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1270
|
+
# API call.
|
1246
1271
|
#
|
1247
1272
|
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1248
1273
|
#
|
@@ -1314,9 +1339,9 @@ module Aws::ChimeSDKMessaging
|
|
1314
1339
|
|
1315
1340
|
# Returns the full details of a user's channel membership.
|
1316
1341
|
#
|
1317
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1318
|
-
# `
|
1319
|
-
# in the header.
|
1342
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1343
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1344
|
+
# the value in the header.
|
1320
1345
|
#
|
1321
1346
|
# </note>
|
1322
1347
|
#
|
@@ -1327,7 +1352,8 @@ module Aws::ChimeSDKMessaging
|
|
1327
1352
|
# The `AppInstanceUserArn` of the member.
|
1328
1353
|
#
|
1329
1354
|
# @option params [required, String] :chime_bearer
|
1330
|
-
# The
|
1355
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1356
|
+
# API call.
|
1331
1357
|
#
|
1332
1358
|
# @option params [String] :sub_channel_id
|
1333
1359
|
# The ID of the SubChannel in the request. The response contains an
|
@@ -1372,11 +1398,11 @@ module Aws::ChimeSDKMessaging
|
|
1372
1398
|
end
|
1373
1399
|
|
1374
1400
|
# Returns the details of a channel based on the membership of the
|
1375
|
-
# specified `AppInstanceUser`.
|
1401
|
+
# specified `AppInstanceUser` or `AppInstanceBot`.
|
1376
1402
|
#
|
1377
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1378
|
-
# `
|
1379
|
-
# in the header.
|
1403
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1404
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1405
|
+
# the value in the header.
|
1380
1406
|
#
|
1381
1407
|
# </note>
|
1382
1408
|
#
|
@@ -1384,10 +1410,11 @@ module Aws::ChimeSDKMessaging
|
|
1384
1410
|
# The ARN of the channel to which the user belongs.
|
1385
1411
|
#
|
1386
1412
|
# @option params [required, String] :app_instance_user_arn
|
1387
|
-
# The ARN of the user in a channel.
|
1413
|
+
# The ARN of the user or bot in a channel.
|
1388
1414
|
#
|
1389
1415
|
# @option params [required, String] :chime_bearer
|
1390
|
-
# The
|
1416
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1417
|
+
# API call.
|
1391
1418
|
#
|
1392
1419
|
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
1420
|
#
|
@@ -1423,11 +1450,11 @@ module Aws::ChimeSDKMessaging
|
|
1423
1450
|
end
|
1424
1451
|
|
1425
1452
|
# Returns the full details of a channel moderated by the specified
|
1426
|
-
# `AppInstanceUser`.
|
1453
|
+
# `AppInstanceUser` or `AppInstanceBot`.
|
1427
1454
|
#
|
1428
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1429
|
-
# `
|
1430
|
-
# in the header.
|
1455
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1456
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1457
|
+
# the value in the header.
|
1431
1458
|
#
|
1432
1459
|
# </note>
|
1433
1460
|
#
|
@@ -1435,10 +1462,11 @@ module Aws::ChimeSDKMessaging
|
|
1435
1462
|
# The ARN of the moderated channel.
|
1436
1463
|
#
|
1437
1464
|
# @option params [required, String] :app_instance_user_arn
|
1438
|
-
# The ARN of the
|
1465
|
+
# The ARN of the user or bot in the moderated channel.
|
1439
1466
|
#
|
1440
1467
|
# @option params [required, String] :chime_bearer
|
1441
|
-
# The
|
1468
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1469
|
+
# API call.
|
1442
1470
|
#
|
1443
1471
|
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1444
1472
|
#
|
@@ -1485,7 +1513,8 @@ module Aws::ChimeSDKMessaging
|
|
1485
1513
|
# The `AppInstanceUserArn` of the channel moderator.
|
1486
1514
|
#
|
1487
1515
|
# @option params [required, String] :chime_bearer
|
1488
|
-
# The
|
1516
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1517
|
+
# API call.
|
1489
1518
|
#
|
1490
1519
|
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
1520
|
#
|
@@ -1522,9 +1551,11 @@ module Aws::ChimeSDKMessaging
|
|
1522
1551
|
# channel flow processor.
|
1523
1552
|
#
|
1524
1553
|
# <note markdown="1"> Only administrators or channel moderators can disassociate a channel
|
1525
|
-
# flow.
|
1526
|
-
#
|
1527
|
-
#
|
1554
|
+
# flow.
|
1555
|
+
#
|
1556
|
+
# The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1557
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1558
|
+
# the value in the header.
|
1528
1559
|
#
|
1529
1560
|
# </note>
|
1530
1561
|
#
|
@@ -1556,13 +1587,19 @@ module Aws::ChimeSDKMessaging
|
|
1556
1587
|
req.send_request(options)
|
1557
1588
|
end
|
1558
1589
|
|
1559
|
-
# Gets the membership preferences of an `AppInstanceUser`
|
1560
|
-
# specified channel.
|
1561
|
-
#
|
1562
|
-
#
|
1563
|
-
# moderator roles can't retrieve preferences for other users
|
1564
|
-
# users can't retrieve membership preferences for
|
1565
|
-
# which they are banned.
|
1590
|
+
# Gets the membership preferences of an `AppInstanceUser` or
|
1591
|
+
# `AppInstanceBot` for the specified channel. A user or a bot must be a
|
1592
|
+
# member of the channel and own the membership to be able to retrieve
|
1593
|
+
# membership preferences. Users or bots in the `AppInstanceAdmin` and
|
1594
|
+
# channel moderator roles can't retrieve preferences for other users or
|
1595
|
+
# bots. Banned users or bots can't retrieve membership preferences for
|
1596
|
+
# the channel from which they are banned.
|
1597
|
+
#
|
1598
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1599
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1600
|
+
# the value in the header.
|
1601
|
+
#
|
1602
|
+
# </note>
|
1566
1603
|
#
|
1567
1604
|
# @option params [required, String] :channel_arn
|
1568
1605
|
# The ARN of the channel.
|
@@ -1571,7 +1608,8 @@ module Aws::ChimeSDKMessaging
|
|
1571
1608
|
# The `AppInstanceUserArn` of the member retrieving the preferences.
|
1572
1609
|
#
|
1573
1610
|
# @option params [required, String] :chime_bearer
|
1574
|
-
# The
|
1611
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1612
|
+
# API call.
|
1575
1613
|
#
|
1576
1614
|
# @return [Types::GetChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1577
1615
|
#
|
@@ -1606,9 +1644,9 @@ module Aws::ChimeSDKMessaging
|
|
1606
1644
|
|
1607
1645
|
# Gets the full details of a channel message.
|
1608
1646
|
#
|
1609
|
-
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
1610
|
-
# `
|
1611
|
-
# in the header.
|
1647
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1648
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1649
|
+
# the value in the header.
|
1612
1650
|
#
|
1613
1651
|
# </note>
|
1614
1652
|
#
|
@@ -1619,7 +1657,8 @@ module Aws::ChimeSDKMessaging
|
|
1619
1657
|
# The ID of the message.
|
1620
1658
|
#
|
1621
1659
|
# @option params [required, String] :chime_bearer
|
1622
|
-
# The
|
1660
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1661
|
+
# API call.
|
1623
1662
|
#
|
1624
1663
|
# @option params [String] :sub_channel_id
|
1625
1664
|
# The ID of the SubChannel in the request.
|
@@ -1662,6 +1701,7 @@ module Aws::ChimeSDKMessaging
|
|
1662
1701
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
1663
1702
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
1664
1703
|
# resp.channel_message.sub_channel_id #=> String
|
1704
|
+
# resp.channel_message.content_type #=> String
|
1665
1705
|
#
|
1666
1706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
1667
1707
|
#
|
@@ -1701,9 +1741,9 @@ module Aws::ChimeSDKMessaging
|
|
1701
1741
|
#
|
1702
1742
|
# * Only the message sender can invoke this API.
|
1703
1743
|
#
|
1704
|
-
# * The `x-amz-chime-bearer` request header is mandatory. Use the
|
1705
|
-
# `
|
1706
|
-
# value in the header
|
1744
|
+
# * The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1745
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1746
|
+
# the value in the header.
|
1707
1747
|
#
|
1708
1748
|
# </note>
|
1709
1749
|
#
|
@@ -1806,11 +1846,11 @@ module Aws::ChimeSDKMessaging
|
|
1806
1846
|
req.send_request(options)
|
1807
1847
|
end
|
1808
1848
|
|
1809
|
-
# Lists all the users banned from a particular channel.
|
1849
|
+
# Lists all the users and bots banned from a particular channel.
|
1810
1850
|
#
|
1811
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1812
|
-
# `
|
1813
|
-
# in the header.
|
1851
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1852
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1853
|
+
# the value in the header.
|
1814
1854
|
#
|
1815
1855
|
# </note>
|
1816
1856
|
#
|
@@ -1825,7 +1865,8 @@ module Aws::ChimeSDKMessaging
|
|
1825
1865
|
# returned.
|
1826
1866
|
#
|
1827
1867
|
# @option params [required, String] :chime_bearer
|
1828
|
-
# The
|
1868
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1869
|
+
# API call.
|
1829
1870
|
#
|
1830
1871
|
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1831
1872
|
#
|
@@ -1913,9 +1954,9 @@ module Aws::ChimeSDKMessaging
|
|
1913
1954
|
|
1914
1955
|
# Lists all channel memberships in a channel.
|
1915
1956
|
#
|
1916
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1917
|
-
# `
|
1918
|
-
# in the header.
|
1957
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1958
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1959
|
+
# the value in the header.
|
1919
1960
|
#
|
1920
1961
|
# </note>
|
1921
1962
|
#
|
@@ -1943,7 +1984,8 @@ module Aws::ChimeSDKMessaging
|
|
1943
1984
|
# memberships are returned.
|
1944
1985
|
#
|
1945
1986
|
# @option params [required, String] :chime_bearer
|
1946
|
-
# The
|
1987
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1988
|
+
# API call.
|
1947
1989
|
#
|
1948
1990
|
# @option params [String] :sub_channel_id
|
1949
1991
|
# The ID of the SubChannel in the request.
|
@@ -1989,18 +2031,18 @@ module Aws::ChimeSDKMessaging
|
|
1989
2031
|
req.send_request(options)
|
1990
2032
|
end
|
1991
2033
|
|
1992
|
-
# Lists all channels that
|
1993
|
-
# Only an `AppInstanceAdmin` can call the API with a user ARN
|
1994
|
-
# not their own.
|
2034
|
+
# Lists all channels that anr `AppInstanceUser` or `AppInstanceBot` is a
|
2035
|
+
# part of. Only an `AppInstanceAdmin` can call the API with a user ARN
|
2036
|
+
# that is not their own.
|
1995
2037
|
#
|
1996
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1997
|
-
# `
|
1998
|
-
# in the header.
|
2038
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2039
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2040
|
+
# the value in the header.
|
1999
2041
|
#
|
2000
2042
|
# </note>
|
2001
2043
|
#
|
2002
2044
|
# @option params [String] :app_instance_user_arn
|
2003
|
-
# The ARN of the
|
2045
|
+
# The ARN of the user or bot.
|
2004
2046
|
#
|
2005
2047
|
# @option params [Integer] :max_results
|
2006
2048
|
# The maximum number of users that you want returned.
|
@@ -2010,7 +2052,8 @@ module Aws::ChimeSDKMessaging
|
|
2010
2052
|
# channel memberships is reached.
|
2011
2053
|
#
|
2012
2054
|
# @option params [required, String] :chime_bearer
|
2013
|
-
# The
|
2055
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2056
|
+
# API call.
|
2014
2057
|
#
|
2015
2058
|
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2016
2059
|
#
|
@@ -2059,9 +2102,9 @@ module Aws::ChimeSDKMessaging
|
|
2059
2102
|
# redacted, not deleted. Deleted messages do not appear in the results.
|
2060
2103
|
# This action always returns the latest version of an edited message.
|
2061
2104
|
#
|
2062
|
-
# Also, the x-amz-chime-bearer request header is mandatory. Use the
|
2063
|
-
#
|
2064
|
-
# in the header.
|
2105
|
+
# Also, the `x-amz-chime-bearer` request header is mandatory. Use the
|
2106
|
+
# ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API
|
2107
|
+
# call as the value in the header.
|
2065
2108
|
#
|
2066
2109
|
# </note>
|
2067
2110
|
#
|
@@ -2086,7 +2129,8 @@ module Aws::ChimeSDKMessaging
|
|
2086
2129
|
# are returned.
|
2087
2130
|
#
|
2088
2131
|
# @option params [required, String] :chime_bearer
|
2089
|
-
# The
|
2132
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2133
|
+
# API call.
|
2090
2134
|
#
|
2091
2135
|
# @option params [String] :sub_channel_id
|
2092
2136
|
# The ID of the SubChannel in the request.
|
@@ -2138,6 +2182,7 @@ module Aws::ChimeSDKMessaging
|
|
2138
2182
|
# resp.channel_messages[0].message_attributes #=> Hash
|
2139
2183
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
2140
2184
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
2185
|
+
# resp.channel_messages[0].content_type #=> String
|
2141
2186
|
# resp.sub_channel_id #=> String
|
2142
2187
|
#
|
2143
2188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
@@ -2151,9 +2196,9 @@ module Aws::ChimeSDKMessaging
|
|
2151
2196
|
|
2152
2197
|
# Lists all the moderators for a channel.
|
2153
2198
|
#
|
2154
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2155
|
-
# `
|
2156
|
-
# in the header.
|
2199
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2200
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2201
|
+
# the value in the header.
|
2157
2202
|
#
|
2158
2203
|
# </note>
|
2159
2204
|
#
|
@@ -2168,7 +2213,8 @@ module Aws::ChimeSDKMessaging
|
|
2168
2213
|
# are returned.
|
2169
2214
|
#
|
2170
2215
|
# @option params [required, String] :chime_bearer
|
2171
|
-
# The
|
2216
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2217
|
+
# API call.
|
2172
2218
|
#
|
2173
2219
|
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2174
2220
|
#
|
@@ -2215,9 +2261,9 @@ module Aws::ChimeSDKMessaging
|
|
2215
2261
|
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
2216
2262
|
# private channels in an account.
|
2217
2263
|
#
|
2218
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2219
|
-
# `
|
2220
|
-
# in the header.
|
2264
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2265
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2266
|
+
# the value in the header.
|
2221
2267
|
#
|
2222
2268
|
# </note>
|
2223
2269
|
#
|
@@ -2237,7 +2283,8 @@ module Aws::ChimeSDKMessaging
|
|
2237
2283
|
# are returned.
|
2238
2284
|
#
|
2239
2285
|
# @option params [required, String] :chime_bearer
|
2240
|
-
# The
|
2286
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2287
|
+
# API call.
|
2241
2288
|
#
|
2242
2289
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2243
2290
|
#
|
@@ -2326,14 +2373,14 @@ module Aws::ChimeSDKMessaging
|
|
2326
2373
|
|
2327
2374
|
# A list of the channels moderated by an `AppInstanceUser`.
|
2328
2375
|
#
|
2329
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2330
|
-
# `
|
2331
|
-
# in the header.
|
2376
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2377
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2378
|
+
# the value in the header.
|
2332
2379
|
#
|
2333
2380
|
# </note>
|
2334
2381
|
#
|
2335
2382
|
# @option params [String] :app_instance_user_arn
|
2336
|
-
# The ARN of the user in the moderated channel.
|
2383
|
+
# The ARN of the user or bot in the moderated channel.
|
2337
2384
|
#
|
2338
2385
|
# @option params [Integer] :max_results
|
2339
2386
|
# The maximum number of channels in the request.
|
@@ -2343,7 +2390,8 @@ module Aws::ChimeSDKMessaging
|
|
2343
2390
|
# channels moderated by the user is reached.
|
2344
2391
|
#
|
2345
2392
|
# @option params [required, String] :chime_bearer
|
2346
|
-
# The
|
2393
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2394
|
+
# API call.
|
2347
2395
|
#
|
2348
2396
|
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2349
2397
|
#
|
@@ -2462,21 +2510,85 @@ module Aws::ChimeSDKMessaging
|
|
2462
2510
|
req.send_request(options)
|
2463
2511
|
end
|
2464
2512
|
|
2465
|
-
# Sets the
|
2466
|
-
#
|
2467
|
-
#
|
2468
|
-
#
|
2469
|
-
#
|
2470
|
-
#
|
2513
|
+
# Sets the number of days before the channel is automatically deleted.
|
2514
|
+
#
|
2515
|
+
# <note markdown="1"> * A background process deletes expired channels within 6 hours of
|
2516
|
+
# expiration. Actual deletion times may vary.
|
2517
|
+
#
|
2518
|
+
# * Expired channels that have not yet been deleted appear as active,
|
2519
|
+
# and you can update their expiration settings. The system honors the
|
2520
|
+
# new settings.
|
2521
|
+
#
|
2522
|
+
# * The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2523
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2524
|
+
# the value in the header.
|
2525
|
+
#
|
2526
|
+
# </note>
|
2527
|
+
#
|
2528
|
+
# @option params [required, String] :channel_arn
|
2529
|
+
# The ARN of the channel.
|
2530
|
+
#
|
2531
|
+
# @option params [String] :chime_bearer
|
2532
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2533
|
+
# API call.
|
2534
|
+
#
|
2535
|
+
# @option params [Types::ExpirationSettings] :expiration_settings
|
2536
|
+
# Settings that control the interval after which a channel is deleted.
|
2537
|
+
#
|
2538
|
+
# @return [Types::PutChannelExpirationSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2539
|
+
#
|
2540
|
+
# * {Types::PutChannelExpirationSettingsResponse#channel_arn #channel_arn} => String
|
2541
|
+
# * {Types::PutChannelExpirationSettingsResponse#expiration_settings #expiration_settings} => Types::ExpirationSettings
|
2542
|
+
#
|
2543
|
+
# @example Request syntax with placeholder values
|
2544
|
+
#
|
2545
|
+
# resp = client.put_channel_expiration_settings({
|
2546
|
+
# channel_arn: "ChimeArn", # required
|
2547
|
+
# chime_bearer: "ChimeArn",
|
2548
|
+
# expiration_settings: {
|
2549
|
+
# expiration_days: 1, # required
|
2550
|
+
# expiration_criterion: "CREATED_TIMESTAMP", # required, accepts CREATED_TIMESTAMP, LAST_MESSAGE_TIMESTAMP
|
2551
|
+
# },
|
2552
|
+
# })
|
2553
|
+
#
|
2554
|
+
# @example Response structure
|
2555
|
+
#
|
2556
|
+
# resp.channel_arn #=> String
|
2557
|
+
# resp.expiration_settings.expiration_days #=> Integer
|
2558
|
+
# resp.expiration_settings.expiration_criterion #=> String, one of "CREATED_TIMESTAMP", "LAST_MESSAGE_TIMESTAMP"
|
2559
|
+
#
|
2560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings AWS API Documentation
|
2561
|
+
#
|
2562
|
+
# @overload put_channel_expiration_settings(params = {})
|
2563
|
+
# @param [Hash] params ({})
|
2564
|
+
def put_channel_expiration_settings(params = {}, options = {})
|
2565
|
+
req = build_request(:put_channel_expiration_settings, params)
|
2566
|
+
req.send_request(options)
|
2567
|
+
end
|
2568
|
+
|
2569
|
+
# Sets the membership preferences of an `AppInstanceUser` or
|
2570
|
+
# `AppIntanceBot` for the specified channel. The user or bot must be a
|
2571
|
+
# member of the channel. Only the user or bot who owns the membership
|
2572
|
+
# can set preferences. Users or bots in the `AppInstanceAdmin` and
|
2573
|
+
# channel moderator roles can't set preferences for other users or
|
2574
|
+
# users. Banned users or bots can't set membership preferences for the
|
2575
|
+
# channel from which they are banned.
|
2576
|
+
#
|
2577
|
+
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the ARN of an
|
2578
|
+
# `AppInstanceUser` or `AppInstanceBot` that makes the API call as the
|
2579
|
+
# value in the header.
|
2580
|
+
#
|
2581
|
+
# </note>
|
2471
2582
|
#
|
2472
2583
|
# @option params [required, String] :channel_arn
|
2473
2584
|
# The ARN of the channel.
|
2474
2585
|
#
|
2475
2586
|
# @option params [required, String] :member_arn
|
2476
|
-
# The
|
2587
|
+
# The ARN of the member setting the preferences.
|
2477
2588
|
#
|
2478
2589
|
# @option params [required, String] :chime_bearer
|
2479
|
-
# The
|
2590
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2591
|
+
# API call.
|
2480
2592
|
#
|
2481
2593
|
# @option params [required, Types::ChannelMembershipPreferences] :preferences
|
2482
2594
|
# The channel membership preferences of an `AppInstanceUser` .
|
@@ -2567,9 +2679,9 @@ module Aws::ChimeSDKMessaging
|
|
2567
2679
|
# back end, but the action returns null content, and the state shows as
|
2568
2680
|
# redacted.
|
2569
2681
|
#
|
2570
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2571
|
-
# `
|
2572
|
-
# in the header.
|
2682
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2683
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2684
|
+
# the value in the header.
|
2573
2685
|
#
|
2574
2686
|
# </note>
|
2575
2687
|
#
|
@@ -2581,7 +2693,8 @@ module Aws::ChimeSDKMessaging
|
|
2581
2693
|
# The ID of the message being redacted.
|
2582
2694
|
#
|
2583
2695
|
# @option params [required, String] :chime_bearer
|
2584
|
-
# The
|
2696
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2697
|
+
# API call.
|
2585
2698
|
#
|
2586
2699
|
# @option params [String] :sub_channel_id
|
2587
2700
|
# The ID of the SubChannel in the request.
|
@@ -2616,9 +2729,13 @@ module Aws::ChimeSDKMessaging
|
|
2616
2729
|
req.send_request(options)
|
2617
2730
|
end
|
2618
2731
|
|
2619
|
-
# Allows `ChimeBearer` to search channels by channel members.
|
2620
|
-
#
|
2621
|
-
#
|
2732
|
+
# Allows the `ChimeBearer` to search channels by channel members. Users
|
2733
|
+
# or bots can search across the channels that they belong to. Users in
|
2734
|
+
# the `AppInstanceAdmin` role can search across all channels.
|
2735
|
+
#
|
2736
|
+
# The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2737
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2738
|
+
# the value in the header.
|
2622
2739
|
#
|
2623
2740
|
# @option params [String] :chime_bearer
|
2624
2741
|
# The `AppInstanceUserArn` of the user making the API call.
|
@@ -2677,9 +2794,9 @@ module Aws::ChimeSDKMessaging
|
|
2677
2794
|
|
2678
2795
|
# Sends a message to a particular channel that the member is a part of.
|
2679
2796
|
#
|
2680
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2681
|
-
# `
|
2682
|
-
# in the header.
|
2797
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2798
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2799
|
+
# the value in the header.
|
2683
2800
|
#
|
2684
2801
|
# Also, `STANDARD` messages can contain 4KB of data and the 1KB of
|
2685
2802
|
# metadata. `CONTROL` messages can contain 30 bytes of data and no
|
@@ -2710,7 +2827,8 @@ module Aws::ChimeSDKMessaging
|
|
2710
2827
|
# not need to pass this option.**
|
2711
2828
|
#
|
2712
2829
|
# @option params [required, String] :chime_bearer
|
2713
|
-
# The
|
2830
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2831
|
+
# API call.
|
2714
2832
|
#
|
2715
2833
|
# @option params [Types::PushNotificationConfiguration] :push_notification
|
2716
2834
|
# The push notification configuration of the message.
|
@@ -2722,6 +2840,9 @@ module Aws::ChimeSDKMessaging
|
|
2722
2840
|
# @option params [String] :sub_channel_id
|
2723
2841
|
# The ID of the SubChannel in the request.
|
2724
2842
|
#
|
2843
|
+
# @option params [String] :content_type
|
2844
|
+
# The content type of the channel message.
|
2845
|
+
#
|
2725
2846
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2726
2847
|
#
|
2727
2848
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2750,6 +2871,7 @@ module Aws::ChimeSDKMessaging
|
|
2750
2871
|
# },
|
2751
2872
|
# },
|
2752
2873
|
# sub_channel_id: "SubChannelId",
|
2874
|
+
# content_type: "ContentType",
|
2753
2875
|
# })
|
2754
2876
|
#
|
2755
2877
|
# @example Response structure
|
@@ -2832,9 +2954,9 @@ module Aws::ChimeSDKMessaging
|
|
2832
2954
|
#
|
2833
2955
|
# **Restriction**: You can't change a channel's privacy.
|
2834
2956
|
#
|
2835
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2836
|
-
# `
|
2837
|
-
# in the header.
|
2957
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2958
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2959
|
+
# the value in the header.
|
2838
2960
|
#
|
2839
2961
|
# </note>
|
2840
2962
|
#
|
@@ -2851,7 +2973,8 @@ module Aws::ChimeSDKMessaging
|
|
2851
2973
|
# The metadata for the update request.
|
2852
2974
|
#
|
2853
2975
|
# @option params [required, String] :chime_bearer
|
2854
|
-
# The
|
2976
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2977
|
+
# API call.
|
2855
2978
|
#
|
2856
2979
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2857
2980
|
#
|
@@ -2930,9 +3053,9 @@ module Aws::ChimeSDKMessaging
|
|
2930
3053
|
|
2931
3054
|
# Updates the content of a message.
|
2932
3055
|
#
|
2933
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2934
|
-
# `
|
2935
|
-
# in the header.
|
3056
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
3057
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
3058
|
+
# the value in the header.
|
2936
3059
|
#
|
2937
3060
|
# </note>
|
2938
3061
|
#
|
@@ -2942,14 +3065,15 @@ module Aws::ChimeSDKMessaging
|
|
2942
3065
|
# @option params [required, String] :message_id
|
2943
3066
|
# The ID string of the message being updated.
|
2944
3067
|
#
|
2945
|
-
# @option params [String] :content
|
3068
|
+
# @option params [required, String] :content
|
2946
3069
|
# The content of the message being updated.
|
2947
3070
|
#
|
2948
3071
|
# @option params [String] :metadata
|
2949
3072
|
# The metadata of the message being updated.
|
2950
3073
|
#
|
2951
3074
|
# @option params [required, String] :chime_bearer
|
2952
|
-
# The
|
3075
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3076
|
+
# API call.
|
2953
3077
|
#
|
2954
3078
|
# @option params [String] :sub_channel_id
|
2955
3079
|
# The ID of the SubChannel in the request.
|
@@ -2959,6 +3083,9 @@ module Aws::ChimeSDKMessaging
|
|
2959
3083
|
#
|
2960
3084
|
# </note>
|
2961
3085
|
#
|
3086
|
+
# @option params [String] :content_type
|
3087
|
+
# The content type of the channel message.
|
3088
|
+
#
|
2962
3089
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2963
3090
|
#
|
2964
3091
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2971,10 +3098,11 @@ module Aws::ChimeSDKMessaging
|
|
2971
3098
|
# resp = client.update_channel_message({
|
2972
3099
|
# channel_arn: "ChimeArn", # required
|
2973
3100
|
# message_id: "MessageId", # required
|
2974
|
-
# content: "
|
3101
|
+
# content: "NonEmptyContent", # required
|
2975
3102
|
# metadata: "Metadata",
|
2976
3103
|
# chime_bearer: "ChimeArn", # required
|
2977
3104
|
# sub_channel_id: "SubChannelId",
|
3105
|
+
# content_type: "ContentType",
|
2978
3106
|
# })
|
2979
3107
|
#
|
2980
3108
|
# @example Response structure
|
@@ -2996,9 +3124,9 @@ module Aws::ChimeSDKMessaging
|
|
2996
3124
|
|
2997
3125
|
# The details of the time when a user last read messages in a channel.
|
2998
3126
|
#
|
2999
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3000
|
-
# `
|
3001
|
-
# in the header.
|
3127
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
3128
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
3129
|
+
# the value in the header.
|
3002
3130
|
#
|
3003
3131
|
# </note>
|
3004
3132
|
#
|
@@ -3006,7 +3134,8 @@ module Aws::ChimeSDKMessaging
|
|
3006
3134
|
# The ARN of the channel.
|
3007
3135
|
#
|
3008
3136
|
# @option params [required, String] :chime_bearer
|
3009
|
-
# The
|
3137
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3138
|
+
# API call.
|
3010
3139
|
#
|
3011
3140
|
# @option params [String] :sub_channel_id
|
3012
3141
|
# The ID of the SubChannel in the request.
|
@@ -3051,7 +3180,7 @@ module Aws::ChimeSDKMessaging
|
|
3051
3180
|
params: params,
|
3052
3181
|
config: config)
|
3053
3182
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
3054
|
-
context[:gem_version] = '1.
|
3183
|
+
context[:gem_version] = '1.17.0'
|
3055
3184
|
Seahorse::Client::Request.new(handlers, context)
|
3056
3185
|
end
|
3057
3186
|
|