aws-sdk-chimesdkmessaging 1.16.0 → 1.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +286 -164
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +45 -5
- 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 +188 -72
- 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
|
#
|
@@ -734,6 +747,9 @@ module Aws::ChimeSDKMessaging
|
|
734
747
|
# @option params [required, String] :client_request_token
|
735
748
|
# The client token for the request. An Idempotency token.
|
736
749
|
#
|
750
|
+
# **A suitable default value is auto-generated.** You should normally
|
751
|
+
# not need to pass this option.**
|
752
|
+
#
|
737
753
|
# @return [Types::CreateChannelFlowResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
738
754
|
#
|
739
755
|
# * {Types::CreateChannelFlowResponse#channel_flow_arn #channel_flow_arn} => String
|
@@ -778,8 +794,9 @@ module Aws::ChimeSDKMessaging
|
|
778
794
|
req.send_request(options)
|
779
795
|
end
|
780
796
|
|
781
|
-
# Adds a
|
782
|
-
# is derived from the request header. A channel
|
797
|
+
# Adds a member to a channel. The `InvitedBy` field in
|
798
|
+
# `ChannelMembership` is derived from the request header. A channel
|
799
|
+
# member can:
|
783
800
|
#
|
784
801
|
# * List messages
|
785
802
|
#
|
@@ -798,9 +815,9 @@ module Aws::ChimeSDKMessaging
|
|
798
815
|
#
|
799
816
|
# * Private Channels: You must be a member to list or send messages.
|
800
817
|
#
|
801
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
802
|
-
# `AppInstanceUserArn`
|
803
|
-
# in the header.
|
818
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
819
|
+
# the `AppInstanceUserArn` or `AppInstanceBot` that makes the API call
|
820
|
+
# as the value in the header.
|
804
821
|
#
|
805
822
|
# </note>
|
806
823
|
#
|
@@ -818,7 +835,8 @@ module Aws::ChimeSDKMessaging
|
|
818
835
|
# not returned. This is only supported by moderators.
|
819
836
|
#
|
820
837
|
# @option params [required, String] :chime_bearer
|
821
|
-
# The
|
838
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
839
|
+
# API call.
|
822
840
|
#
|
823
841
|
# @option params [String] :sub_channel_id
|
824
842
|
# The ID of the SubChannel in the request.
|
@@ -872,9 +890,9 @@ module Aws::ChimeSDKMessaging
|
|
872
890
|
#
|
873
891
|
# * List messages in the channel.
|
874
892
|
#
|
875
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
876
|
-
# `
|
877
|
-
# in the header.
|
893
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
894
|
+
# the `AppInstanceUser` or `AppInstanceBot`of the user that makes the
|
895
|
+
# API call as the value in the header.
|
878
896
|
#
|
879
897
|
# </note>
|
880
898
|
#
|
@@ -885,7 +903,8 @@ module Aws::ChimeSDKMessaging
|
|
885
903
|
# The `AppInstanceUserArn` of the moderator.
|
886
904
|
#
|
887
905
|
# @option params [required, String] :chime_bearer
|
888
|
-
# The
|
906
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
907
|
+
# API call.
|
889
908
|
#
|
890
909
|
# @return [Types::CreateChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
891
910
|
#
|
@@ -918,9 +937,9 @@ module Aws::ChimeSDKMessaging
|
|
918
937
|
# Immediately makes a channel and its memberships inaccessible and marks
|
919
938
|
# them for deletion. This is an irreversible process.
|
920
939
|
#
|
921
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
922
|
-
# `AppInstanceUserArn`
|
923
|
-
# in the header.
|
940
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
941
|
+
# the `AppInstanceUserArn` or `AppInstanceBot` that makes the API call
|
942
|
+
# as the value in the header.
|
924
943
|
#
|
925
944
|
# </note>
|
926
945
|
#
|
@@ -928,10 +947,8 @@ module Aws::ChimeSDKMessaging
|
|
928
947
|
# The ARN of the channel being deleted.
|
929
948
|
#
|
930
949
|
# @option params [required, String] :chime_bearer
|
931
|
-
# The
|
932
|
-
#
|
933
|
-
# @option params [String] :sub_channel_id
|
934
|
-
# The ID of the SubChannel in the request.
|
950
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
951
|
+
# API call.
|
935
952
|
#
|
936
953
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
937
954
|
#
|
@@ -940,7 +957,6 @@ module Aws::ChimeSDKMessaging
|
|
940
957
|
# resp = client.delete_channel({
|
941
958
|
# channel_arn: "ChimeArn", # required
|
942
959
|
# chime_bearer: "ChimeArn", # required
|
943
|
-
# sub_channel_id: "SubChannelId",
|
944
960
|
# })
|
945
961
|
#
|
946
962
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel AWS API Documentation
|
@@ -952,11 +968,11 @@ module Aws::ChimeSDKMessaging
|
|
952
968
|
req.send_request(options)
|
953
969
|
end
|
954
970
|
|
955
|
-
# Removes a
|
971
|
+
# Removes a member from a channel's ban list.
|
956
972
|
#
|
957
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
958
|
-
# `
|
959
|
-
# in the header.
|
973
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
974
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
975
|
+
# the value in the header.
|
960
976
|
#
|
961
977
|
# </note>
|
962
978
|
#
|
@@ -967,7 +983,8 @@ module Aws::ChimeSDKMessaging
|
|
967
983
|
# The ARN of the `AppInstanceUser` that you want to reinstate.
|
968
984
|
#
|
969
985
|
# @option params [required, String] :chime_bearer
|
970
|
-
# The
|
986
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
987
|
+
# API call.
|
971
988
|
#
|
972
989
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
973
990
|
#
|
@@ -1035,7 +1052,8 @@ module Aws::ChimeSDKMessaging
|
|
1035
1052
|
# channel.
|
1036
1053
|
#
|
1037
1054
|
# @option params [required, String] :chime_bearer
|
1038
|
-
# The
|
1055
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1056
|
+
# API call.
|
1039
1057
|
#
|
1040
1058
|
# @option params [String] :sub_channel_id
|
1041
1059
|
# The ID of the SubChannel in the request.
|
@@ -1068,9 +1086,9 @@ module Aws::ChimeSDKMessaging
|
|
1068
1086
|
# Deletion makes messages inaccessible immediately. A background process
|
1069
1087
|
# deletes any revisions created by `UpdateChannelMessage`.
|
1070
1088
|
#
|
1071
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1072
|
-
# `
|
1073
|
-
# in the header.
|
1089
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1090
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1091
|
+
# the value in the header.
|
1074
1092
|
#
|
1075
1093
|
# </note>
|
1076
1094
|
#
|
@@ -1081,7 +1099,8 @@ module Aws::ChimeSDKMessaging
|
|
1081
1099
|
# The ID of the message being deleted.
|
1082
1100
|
#
|
1083
1101
|
# @option params [required, String] :chime_bearer
|
1084
|
-
# The
|
1102
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1103
|
+
# API call.
|
1085
1104
|
#
|
1086
1105
|
# @option params [String] :sub_channel_id
|
1087
1106
|
# The ID of the SubChannel in the request.
|
@@ -1113,9 +1132,9 @@ module Aws::ChimeSDKMessaging
|
|
1113
1132
|
|
1114
1133
|
# Deletes a channel moderator.
|
1115
1134
|
#
|
1116
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1117
|
-
# `
|
1118
|
-
# in the header.
|
1135
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1136
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1137
|
+
# the value in the header.
|
1119
1138
|
#
|
1120
1139
|
# </note>
|
1121
1140
|
#
|
@@ -1126,7 +1145,8 @@ module Aws::ChimeSDKMessaging
|
|
1126
1145
|
# The `AppInstanceUserArn` of the moderator being deleted.
|
1127
1146
|
#
|
1128
1147
|
# @option params [required, String] :chime_bearer
|
1129
|
-
# The
|
1148
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1149
|
+
# API call.
|
1130
1150
|
#
|
1131
1151
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1132
1152
|
#
|
@@ -1178,9 +1198,9 @@ module Aws::ChimeSDKMessaging
|
|
1178
1198
|
# Returns the full details of a channel in an Amazon Chime
|
1179
1199
|
# `AppInstance`.
|
1180
1200
|
#
|
1181
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1182
|
-
# `
|
1183
|
-
# in the header.
|
1201
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1202
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1203
|
+
# the value in the header.
|
1184
1204
|
#
|
1185
1205
|
# </note>
|
1186
1206
|
#
|
@@ -1188,7 +1208,8 @@ module Aws::ChimeSDKMessaging
|
|
1188
1208
|
# The ARN of the channel.
|
1189
1209
|
#
|
1190
1210
|
# @option params [required, String] :chime_bearer
|
1191
|
-
# The
|
1211
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1212
|
+
# API call.
|
1192
1213
|
#
|
1193
1214
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1194
1215
|
#
|
@@ -1217,6 +1238,8 @@ module Aws::ChimeSDKMessaging
|
|
1217
1238
|
# resp.channel.elastic_channel_configuration.maximum_sub_channels #=> Integer
|
1218
1239
|
# resp.channel.elastic_channel_configuration.target_memberships_per_sub_channel #=> Integer
|
1219
1240
|
# resp.channel.elastic_channel_configuration.minimum_membership_percentage #=> Integer
|
1241
|
+
# resp.channel.expiration_settings.expiration_days #=> Integer
|
1242
|
+
# resp.channel.expiration_settings.expiration_criterion #=> String, one of "CREATED_TIMESTAMP", "LAST_MESSAGE_TIMESTAMP"
|
1220
1243
|
#
|
1221
1244
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
|
1222
1245
|
#
|
@@ -1229,9 +1252,9 @@ module Aws::ChimeSDKMessaging
|
|
1229
1252
|
|
1230
1253
|
# Returns the full details of a channel ban.
|
1231
1254
|
#
|
1232
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1233
|
-
# `
|
1234
|
-
# in the header.
|
1255
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1256
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1257
|
+
# the value in the header.
|
1235
1258
|
#
|
1236
1259
|
# </note>
|
1237
1260
|
#
|
@@ -1242,7 +1265,8 @@ module Aws::ChimeSDKMessaging
|
|
1242
1265
|
# The `AppInstanceUserArn` of the member being banned.
|
1243
1266
|
#
|
1244
1267
|
# @option params [required, String] :chime_bearer
|
1245
|
-
# The
|
1268
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1269
|
+
# API call.
|
1246
1270
|
#
|
1247
1271
|
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1248
1272
|
#
|
@@ -1314,9 +1338,9 @@ module Aws::ChimeSDKMessaging
|
|
1314
1338
|
|
1315
1339
|
# Returns the full details of a user's channel membership.
|
1316
1340
|
#
|
1317
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1318
|
-
# `
|
1319
|
-
# in the header.
|
1341
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1342
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1343
|
+
# the value in the header.
|
1320
1344
|
#
|
1321
1345
|
# </note>
|
1322
1346
|
#
|
@@ -1327,7 +1351,8 @@ module Aws::ChimeSDKMessaging
|
|
1327
1351
|
# The `AppInstanceUserArn` of the member.
|
1328
1352
|
#
|
1329
1353
|
# @option params [required, String] :chime_bearer
|
1330
|
-
# The
|
1354
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1355
|
+
# API call.
|
1331
1356
|
#
|
1332
1357
|
# @option params [String] :sub_channel_id
|
1333
1358
|
# The ID of the SubChannel in the request. The response contains an
|
@@ -1372,11 +1397,11 @@ module Aws::ChimeSDKMessaging
|
|
1372
1397
|
end
|
1373
1398
|
|
1374
1399
|
# Returns the details of a channel based on the membership of the
|
1375
|
-
# specified `AppInstanceUser`.
|
1400
|
+
# specified `AppInstanceUser` or `AppInstanceBot`.
|
1376
1401
|
#
|
1377
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1378
|
-
# `
|
1379
|
-
# in the header.
|
1402
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1403
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1404
|
+
# the value in the header.
|
1380
1405
|
#
|
1381
1406
|
# </note>
|
1382
1407
|
#
|
@@ -1384,10 +1409,11 @@ module Aws::ChimeSDKMessaging
|
|
1384
1409
|
# The ARN of the channel to which the user belongs.
|
1385
1410
|
#
|
1386
1411
|
# @option params [required, String] :app_instance_user_arn
|
1387
|
-
# The ARN of the user in a channel.
|
1412
|
+
# The ARN of the user or bot in a channel.
|
1388
1413
|
#
|
1389
1414
|
# @option params [required, String] :chime_bearer
|
1390
|
-
# The
|
1415
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1416
|
+
# API call.
|
1391
1417
|
#
|
1392
1418
|
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1393
1419
|
#
|
@@ -1423,11 +1449,11 @@ module Aws::ChimeSDKMessaging
|
|
1423
1449
|
end
|
1424
1450
|
|
1425
1451
|
# Returns the full details of a channel moderated by the specified
|
1426
|
-
# `AppInstanceUser`.
|
1452
|
+
# `AppInstanceUser` or `AppInstanceBot`.
|
1427
1453
|
#
|
1428
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1429
|
-
# `
|
1430
|
-
# in the header.
|
1454
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1455
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1456
|
+
# the value in the header.
|
1431
1457
|
#
|
1432
1458
|
# </note>
|
1433
1459
|
#
|
@@ -1435,10 +1461,11 @@ module Aws::ChimeSDKMessaging
|
|
1435
1461
|
# The ARN of the moderated channel.
|
1436
1462
|
#
|
1437
1463
|
# @option params [required, String] :app_instance_user_arn
|
1438
|
-
# The ARN of the
|
1464
|
+
# The ARN of the user or bot in the moderated channel.
|
1439
1465
|
#
|
1440
1466
|
# @option params [required, String] :chime_bearer
|
1441
|
-
# The
|
1467
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1468
|
+
# API call.
|
1442
1469
|
#
|
1443
1470
|
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1444
1471
|
#
|
@@ -1485,7 +1512,8 @@ module Aws::ChimeSDKMessaging
|
|
1485
1512
|
# The `AppInstanceUserArn` of the channel moderator.
|
1486
1513
|
#
|
1487
1514
|
# @option params [required, String] :chime_bearer
|
1488
|
-
# The
|
1515
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1516
|
+
# API call.
|
1489
1517
|
#
|
1490
1518
|
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1491
1519
|
#
|
@@ -1522,9 +1550,11 @@ module Aws::ChimeSDKMessaging
|
|
1522
1550
|
# channel flow processor.
|
1523
1551
|
#
|
1524
1552
|
# <note markdown="1"> Only administrators or channel moderators can disassociate a channel
|
1525
|
-
# flow.
|
1526
|
-
#
|
1527
|
-
#
|
1553
|
+
# flow.
|
1554
|
+
#
|
1555
|
+
# The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1556
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1557
|
+
# the value in the header.
|
1528
1558
|
#
|
1529
1559
|
# </note>
|
1530
1560
|
#
|
@@ -1556,13 +1586,19 @@ module Aws::ChimeSDKMessaging
|
|
1556
1586
|
req.send_request(options)
|
1557
1587
|
end
|
1558
1588
|
|
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.
|
1589
|
+
# Gets the membership preferences of an `AppInstanceUser` or
|
1590
|
+
# `AppInstanceBot` for the specified channel. A user or a bot must be a
|
1591
|
+
# member of the channel and own the membership to be able to retrieve
|
1592
|
+
# membership preferences. Users or bots in the `AppInstanceAdmin` and
|
1593
|
+
# channel moderator roles can't retrieve preferences for other users or
|
1594
|
+
# bots. Banned users or bots can't retrieve membership preferences for
|
1595
|
+
# the channel from which they are banned.
|
1596
|
+
#
|
1597
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1598
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1599
|
+
# the value in the header.
|
1600
|
+
#
|
1601
|
+
# </note>
|
1566
1602
|
#
|
1567
1603
|
# @option params [required, String] :channel_arn
|
1568
1604
|
# The ARN of the channel.
|
@@ -1571,7 +1607,8 @@ module Aws::ChimeSDKMessaging
|
|
1571
1607
|
# The `AppInstanceUserArn` of the member retrieving the preferences.
|
1572
1608
|
#
|
1573
1609
|
# @option params [required, String] :chime_bearer
|
1574
|
-
# The
|
1610
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1611
|
+
# API call.
|
1575
1612
|
#
|
1576
1613
|
# @return [Types::GetChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1577
1614
|
#
|
@@ -1606,9 +1643,9 @@ module Aws::ChimeSDKMessaging
|
|
1606
1643
|
|
1607
1644
|
# Gets the full details of a channel message.
|
1608
1645
|
#
|
1609
|
-
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
1610
|
-
# `
|
1611
|
-
# in the header.
|
1646
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1647
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1648
|
+
# the value in the header.
|
1612
1649
|
#
|
1613
1650
|
# </note>
|
1614
1651
|
#
|
@@ -1619,7 +1656,8 @@ module Aws::ChimeSDKMessaging
|
|
1619
1656
|
# The ID of the message.
|
1620
1657
|
#
|
1621
1658
|
# @option params [required, String] :chime_bearer
|
1622
|
-
# The
|
1659
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1660
|
+
# API call.
|
1623
1661
|
#
|
1624
1662
|
# @option params [String] :sub_channel_id
|
1625
1663
|
# The ID of the SubChannel in the request.
|
@@ -1662,6 +1700,7 @@ module Aws::ChimeSDKMessaging
|
|
1662
1700
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
1663
1701
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
1664
1702
|
# resp.channel_message.sub_channel_id #=> String
|
1703
|
+
# resp.channel_message.content_type #=> String
|
1665
1704
|
#
|
1666
1705
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
1667
1706
|
#
|
@@ -1701,9 +1740,9 @@ module Aws::ChimeSDKMessaging
|
|
1701
1740
|
#
|
1702
1741
|
# * Only the message sender can invoke this API.
|
1703
1742
|
#
|
1704
|
-
# * The `x-amz-chime-bearer` request header is mandatory. Use the
|
1705
|
-
# `
|
1706
|
-
# value in the header
|
1743
|
+
# * The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1744
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1745
|
+
# the value in the header.
|
1707
1746
|
#
|
1708
1747
|
# </note>
|
1709
1748
|
#
|
@@ -1806,11 +1845,11 @@ module Aws::ChimeSDKMessaging
|
|
1806
1845
|
req.send_request(options)
|
1807
1846
|
end
|
1808
1847
|
|
1809
|
-
# Lists all the users banned from a particular channel.
|
1848
|
+
# Lists all the users and bots banned from a particular channel.
|
1810
1849
|
#
|
1811
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1812
|
-
# `
|
1813
|
-
# in the header.
|
1850
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1851
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1852
|
+
# the value in the header.
|
1814
1853
|
#
|
1815
1854
|
# </note>
|
1816
1855
|
#
|
@@ -1825,7 +1864,8 @@ module Aws::ChimeSDKMessaging
|
|
1825
1864
|
# returned.
|
1826
1865
|
#
|
1827
1866
|
# @option params [required, String] :chime_bearer
|
1828
|
-
# The
|
1867
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1868
|
+
# API call.
|
1829
1869
|
#
|
1830
1870
|
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1831
1871
|
#
|
@@ -1913,9 +1953,9 @@ module Aws::ChimeSDKMessaging
|
|
1913
1953
|
|
1914
1954
|
# Lists all channel memberships in a channel.
|
1915
1955
|
#
|
1916
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1917
|
-
# `
|
1918
|
-
# in the header.
|
1956
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
1957
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
1958
|
+
# the value in the header.
|
1919
1959
|
#
|
1920
1960
|
# </note>
|
1921
1961
|
#
|
@@ -1943,7 +1983,8 @@ module Aws::ChimeSDKMessaging
|
|
1943
1983
|
# memberships are returned.
|
1944
1984
|
#
|
1945
1985
|
# @option params [required, String] :chime_bearer
|
1946
|
-
# The
|
1986
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1987
|
+
# API call.
|
1947
1988
|
#
|
1948
1989
|
# @option params [String] :sub_channel_id
|
1949
1990
|
# The ID of the SubChannel in the request.
|
@@ -1989,18 +2030,18 @@ module Aws::ChimeSDKMessaging
|
|
1989
2030
|
req.send_request(options)
|
1990
2031
|
end
|
1991
2032
|
|
1992
|
-
# Lists all channels that
|
1993
|
-
# Only an `AppInstanceAdmin` can call the API with a user ARN
|
1994
|
-
# not their own.
|
2033
|
+
# Lists all channels that anr `AppInstanceUser` or `AppInstanceBot` is a
|
2034
|
+
# part of. Only an `AppInstanceAdmin` can call the API with a user ARN
|
2035
|
+
# that is not their own.
|
1995
2036
|
#
|
1996
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1997
|
-
# `
|
1998
|
-
# in the header.
|
2037
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2038
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2039
|
+
# the value in the header.
|
1999
2040
|
#
|
2000
2041
|
# </note>
|
2001
2042
|
#
|
2002
2043
|
# @option params [String] :app_instance_user_arn
|
2003
|
-
# The ARN of the
|
2044
|
+
# The ARN of the user or bot.
|
2004
2045
|
#
|
2005
2046
|
# @option params [Integer] :max_results
|
2006
2047
|
# The maximum number of users that you want returned.
|
@@ -2010,7 +2051,8 @@ module Aws::ChimeSDKMessaging
|
|
2010
2051
|
# channel memberships is reached.
|
2011
2052
|
#
|
2012
2053
|
# @option params [required, String] :chime_bearer
|
2013
|
-
# The
|
2054
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2055
|
+
# API call.
|
2014
2056
|
#
|
2015
2057
|
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2016
2058
|
#
|
@@ -2059,9 +2101,9 @@ module Aws::ChimeSDKMessaging
|
|
2059
2101
|
# redacted, not deleted. Deleted messages do not appear in the results.
|
2060
2102
|
# This action always returns the latest version of an edited message.
|
2061
2103
|
#
|
2062
|
-
# Also, the x-amz-chime-bearer request header is mandatory. Use the
|
2063
|
-
#
|
2064
|
-
# in the header.
|
2104
|
+
# Also, the `x-amz-chime-bearer` request header is mandatory. Use the
|
2105
|
+
# ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the API
|
2106
|
+
# call as the value in the header.
|
2065
2107
|
#
|
2066
2108
|
# </note>
|
2067
2109
|
#
|
@@ -2086,7 +2128,8 @@ module Aws::ChimeSDKMessaging
|
|
2086
2128
|
# are returned.
|
2087
2129
|
#
|
2088
2130
|
# @option params [required, String] :chime_bearer
|
2089
|
-
# The
|
2131
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2132
|
+
# API call.
|
2090
2133
|
#
|
2091
2134
|
# @option params [String] :sub_channel_id
|
2092
2135
|
# The ID of the SubChannel in the request.
|
@@ -2138,6 +2181,7 @@ module Aws::ChimeSDKMessaging
|
|
2138
2181
|
# resp.channel_messages[0].message_attributes #=> Hash
|
2139
2182
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
2140
2183
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
2184
|
+
# resp.channel_messages[0].content_type #=> String
|
2141
2185
|
# resp.sub_channel_id #=> String
|
2142
2186
|
#
|
2143
2187
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
@@ -2151,9 +2195,9 @@ module Aws::ChimeSDKMessaging
|
|
2151
2195
|
|
2152
2196
|
# Lists all the moderators for a channel.
|
2153
2197
|
#
|
2154
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2155
|
-
# `
|
2156
|
-
# in the header.
|
2198
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2199
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2200
|
+
# the value in the header.
|
2157
2201
|
#
|
2158
2202
|
# </note>
|
2159
2203
|
#
|
@@ -2168,7 +2212,8 @@ module Aws::ChimeSDKMessaging
|
|
2168
2212
|
# are returned.
|
2169
2213
|
#
|
2170
2214
|
# @option params [required, String] :chime_bearer
|
2171
|
-
# The
|
2215
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2216
|
+
# API call.
|
2172
2217
|
#
|
2173
2218
|
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2174
2219
|
#
|
@@ -2215,9 +2260,9 @@ module Aws::ChimeSDKMessaging
|
|
2215
2260
|
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
2216
2261
|
# private channels in an account.
|
2217
2262
|
#
|
2218
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2219
|
-
# `
|
2220
|
-
# in the header.
|
2263
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2264
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2265
|
+
# the value in the header.
|
2221
2266
|
#
|
2222
2267
|
# </note>
|
2223
2268
|
#
|
@@ -2237,7 +2282,8 @@ module Aws::ChimeSDKMessaging
|
|
2237
2282
|
# are returned.
|
2238
2283
|
#
|
2239
2284
|
# @option params [required, String] :chime_bearer
|
2240
|
-
# The
|
2285
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2286
|
+
# API call.
|
2241
2287
|
#
|
2242
2288
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2243
2289
|
#
|
@@ -2326,14 +2372,14 @@ module Aws::ChimeSDKMessaging
|
|
2326
2372
|
|
2327
2373
|
# A list of the channels moderated by an `AppInstanceUser`.
|
2328
2374
|
#
|
2329
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2330
|
-
# `
|
2331
|
-
# in the header.
|
2375
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2376
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2377
|
+
# the value in the header.
|
2332
2378
|
#
|
2333
2379
|
# </note>
|
2334
2380
|
#
|
2335
2381
|
# @option params [String] :app_instance_user_arn
|
2336
|
-
# The ARN of the user in the moderated channel.
|
2382
|
+
# The ARN of the user or bot in the moderated channel.
|
2337
2383
|
#
|
2338
2384
|
# @option params [Integer] :max_results
|
2339
2385
|
# The maximum number of channels in the request.
|
@@ -2343,7 +2389,8 @@ module Aws::ChimeSDKMessaging
|
|
2343
2389
|
# channels moderated by the user is reached.
|
2344
2390
|
#
|
2345
2391
|
# @option params [required, String] :chime_bearer
|
2346
|
-
# The
|
2392
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2393
|
+
# API call.
|
2347
2394
|
#
|
2348
2395
|
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2349
2396
|
#
|
@@ -2462,21 +2509,85 @@ module Aws::ChimeSDKMessaging
|
|
2462
2509
|
req.send_request(options)
|
2463
2510
|
end
|
2464
2511
|
|
2465
|
-
# Sets the
|
2466
|
-
#
|
2467
|
-
#
|
2468
|
-
#
|
2469
|
-
#
|
2470
|
-
#
|
2512
|
+
# Sets the number of days before the channel is automatically deleted.
|
2513
|
+
#
|
2514
|
+
# <note markdown="1"> * A background process deletes expired channels within 6 hours of
|
2515
|
+
# expiration. Actual deletion times may vary.
|
2516
|
+
#
|
2517
|
+
# * Expired channels that have not yet been deleted appear as active,
|
2518
|
+
# and you can update their expiration settings. The system honors the
|
2519
|
+
# new settings.
|
2520
|
+
#
|
2521
|
+
# * The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2522
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2523
|
+
# the value in the header.
|
2524
|
+
#
|
2525
|
+
# </note>
|
2526
|
+
#
|
2527
|
+
# @option params [required, String] :channel_arn
|
2528
|
+
# The ARN of the channel.
|
2529
|
+
#
|
2530
|
+
# @option params [String] :chime_bearer
|
2531
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2532
|
+
# API call.
|
2533
|
+
#
|
2534
|
+
# @option params [Types::ExpirationSettings] :expiration_settings
|
2535
|
+
# Settings that control the interval after which a channel is deleted.
|
2536
|
+
#
|
2537
|
+
# @return [Types::PutChannelExpirationSettingsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2538
|
+
#
|
2539
|
+
# * {Types::PutChannelExpirationSettingsResponse#channel_arn #channel_arn} => String
|
2540
|
+
# * {Types::PutChannelExpirationSettingsResponse#expiration_settings #expiration_settings} => Types::ExpirationSettings
|
2541
|
+
#
|
2542
|
+
# @example Request syntax with placeholder values
|
2543
|
+
#
|
2544
|
+
# resp = client.put_channel_expiration_settings({
|
2545
|
+
# channel_arn: "ChimeArn", # required
|
2546
|
+
# chime_bearer: "ChimeArn",
|
2547
|
+
# expiration_settings: {
|
2548
|
+
# expiration_days: 1, # required
|
2549
|
+
# expiration_criterion: "CREATED_TIMESTAMP", # required, accepts CREATED_TIMESTAMP, LAST_MESSAGE_TIMESTAMP
|
2550
|
+
# },
|
2551
|
+
# })
|
2552
|
+
#
|
2553
|
+
# @example Response structure
|
2554
|
+
#
|
2555
|
+
# resp.channel_arn #=> String
|
2556
|
+
# resp.expiration_settings.expiration_days #=> Integer
|
2557
|
+
# resp.expiration_settings.expiration_criterion #=> String, one of "CREATED_TIMESTAMP", "LAST_MESSAGE_TIMESTAMP"
|
2558
|
+
#
|
2559
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelExpirationSettings AWS API Documentation
|
2560
|
+
#
|
2561
|
+
# @overload put_channel_expiration_settings(params = {})
|
2562
|
+
# @param [Hash] params ({})
|
2563
|
+
def put_channel_expiration_settings(params = {}, options = {})
|
2564
|
+
req = build_request(:put_channel_expiration_settings, params)
|
2565
|
+
req.send_request(options)
|
2566
|
+
end
|
2567
|
+
|
2568
|
+
# Sets the membership preferences of an `AppInstanceUser` or
|
2569
|
+
# `AppIntanceBot` for the specified channel. The user or bot must be a
|
2570
|
+
# member of the channel. Only the user or bot who owns the membership
|
2571
|
+
# can set preferences. Users or bots in the `AppInstanceAdmin` and
|
2572
|
+
# channel moderator roles can't set preferences for other users or
|
2573
|
+
# users. Banned users or bots can't set membership preferences for the
|
2574
|
+
# channel from which they are banned.
|
2575
|
+
#
|
2576
|
+
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the ARN of an
|
2577
|
+
# `AppInstanceUser` or `AppInstanceBot` that makes the API call as the
|
2578
|
+
# value in the header.
|
2579
|
+
#
|
2580
|
+
# </note>
|
2471
2581
|
#
|
2472
2582
|
# @option params [required, String] :channel_arn
|
2473
2583
|
# The ARN of the channel.
|
2474
2584
|
#
|
2475
2585
|
# @option params [required, String] :member_arn
|
2476
|
-
# The
|
2586
|
+
# The ARN of the member setting the preferences.
|
2477
2587
|
#
|
2478
2588
|
# @option params [required, String] :chime_bearer
|
2479
|
-
# The
|
2589
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2590
|
+
# API call.
|
2480
2591
|
#
|
2481
2592
|
# @option params [required, Types::ChannelMembershipPreferences] :preferences
|
2482
2593
|
# The channel membership preferences of an `AppInstanceUser` .
|
@@ -2567,9 +2678,9 @@ module Aws::ChimeSDKMessaging
|
|
2567
2678
|
# back end, but the action returns null content, and the state shows as
|
2568
2679
|
# redacted.
|
2569
2680
|
#
|
2570
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2571
|
-
# `
|
2572
|
-
# in the header.
|
2681
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2682
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2683
|
+
# the value in the header.
|
2573
2684
|
#
|
2574
2685
|
# </note>
|
2575
2686
|
#
|
@@ -2581,7 +2692,8 @@ module Aws::ChimeSDKMessaging
|
|
2581
2692
|
# The ID of the message being redacted.
|
2582
2693
|
#
|
2583
2694
|
# @option params [required, String] :chime_bearer
|
2584
|
-
# The
|
2695
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2696
|
+
# API call.
|
2585
2697
|
#
|
2586
2698
|
# @option params [String] :sub_channel_id
|
2587
2699
|
# The ID of the SubChannel in the request.
|
@@ -2616,9 +2728,13 @@ module Aws::ChimeSDKMessaging
|
|
2616
2728
|
req.send_request(options)
|
2617
2729
|
end
|
2618
2730
|
|
2619
|
-
# Allows `ChimeBearer` to search channels by channel members.
|
2620
|
-
#
|
2621
|
-
#
|
2731
|
+
# Allows the `ChimeBearer` to search channels by channel members. Users
|
2732
|
+
# or bots can search across the channels that they belong to. Users in
|
2733
|
+
# the `AppInstanceAdmin` role can search across all channels.
|
2734
|
+
#
|
2735
|
+
# The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2736
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2737
|
+
# the value in the header.
|
2622
2738
|
#
|
2623
2739
|
# @option params [String] :chime_bearer
|
2624
2740
|
# The `AppInstanceUserArn` of the user making the API call.
|
@@ -2677,9 +2793,9 @@ module Aws::ChimeSDKMessaging
|
|
2677
2793
|
|
2678
2794
|
# Sends a message to a particular channel that the member is a part of.
|
2679
2795
|
#
|
2680
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2681
|
-
# `
|
2682
|
-
# in the header.
|
2796
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2797
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2798
|
+
# the value in the header.
|
2683
2799
|
#
|
2684
2800
|
# Also, `STANDARD` messages can contain 4KB of data and the 1KB of
|
2685
2801
|
# metadata. `CONTROL` messages can contain 30 bytes of data and no
|
@@ -2710,7 +2826,8 @@ module Aws::ChimeSDKMessaging
|
|
2710
2826
|
# not need to pass this option.**
|
2711
2827
|
#
|
2712
2828
|
# @option params [required, String] :chime_bearer
|
2713
|
-
# The
|
2829
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2830
|
+
# API call.
|
2714
2831
|
#
|
2715
2832
|
# @option params [Types::PushNotificationConfiguration] :push_notification
|
2716
2833
|
# The push notification configuration of the message.
|
@@ -2722,6 +2839,9 @@ module Aws::ChimeSDKMessaging
|
|
2722
2839
|
# @option params [String] :sub_channel_id
|
2723
2840
|
# The ID of the SubChannel in the request.
|
2724
2841
|
#
|
2842
|
+
# @option params [String] :content_type
|
2843
|
+
# The content type of the channel message.
|
2844
|
+
#
|
2725
2845
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2726
2846
|
#
|
2727
2847
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2750,6 +2870,7 @@ module Aws::ChimeSDKMessaging
|
|
2750
2870
|
# },
|
2751
2871
|
# },
|
2752
2872
|
# sub_channel_id: "SubChannelId",
|
2873
|
+
# content_type: "ContentType",
|
2753
2874
|
# })
|
2754
2875
|
#
|
2755
2876
|
# @example Response structure
|
@@ -2832,9 +2953,9 @@ module Aws::ChimeSDKMessaging
|
|
2832
2953
|
#
|
2833
2954
|
# **Restriction**: You can't change a channel's privacy.
|
2834
2955
|
#
|
2835
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2836
|
-
# `
|
2837
|
-
# in the header.
|
2956
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
2957
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
2958
|
+
# the value in the header.
|
2838
2959
|
#
|
2839
2960
|
# </note>
|
2840
2961
|
#
|
@@ -2851,7 +2972,8 @@ module Aws::ChimeSDKMessaging
|
|
2851
2972
|
# The metadata for the update request.
|
2852
2973
|
#
|
2853
2974
|
# @option params [required, String] :chime_bearer
|
2854
|
-
# The
|
2975
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2976
|
+
# API call.
|
2855
2977
|
#
|
2856
2978
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2857
2979
|
#
|
@@ -2930,9 +3052,9 @@ module Aws::ChimeSDKMessaging
|
|
2930
3052
|
|
2931
3053
|
# Updates the content of a message.
|
2932
3054
|
#
|
2933
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2934
|
-
# `
|
2935
|
-
# in the header.
|
3055
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
3056
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
3057
|
+
# the value in the header.
|
2936
3058
|
#
|
2937
3059
|
# </note>
|
2938
3060
|
#
|
@@ -2942,14 +3064,15 @@ module Aws::ChimeSDKMessaging
|
|
2942
3064
|
# @option params [required, String] :message_id
|
2943
3065
|
# The ID string of the message being updated.
|
2944
3066
|
#
|
2945
|
-
# @option params [String] :content
|
3067
|
+
# @option params [required, String] :content
|
2946
3068
|
# The content of the message being updated.
|
2947
3069
|
#
|
2948
3070
|
# @option params [String] :metadata
|
2949
3071
|
# The metadata of the message being updated.
|
2950
3072
|
#
|
2951
3073
|
# @option params [required, String] :chime_bearer
|
2952
|
-
# The
|
3074
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3075
|
+
# API call.
|
2953
3076
|
#
|
2954
3077
|
# @option params [String] :sub_channel_id
|
2955
3078
|
# The ID of the SubChannel in the request.
|
@@ -2959,6 +3082,9 @@ module Aws::ChimeSDKMessaging
|
|
2959
3082
|
#
|
2960
3083
|
# </note>
|
2961
3084
|
#
|
3085
|
+
# @option params [String] :content_type
|
3086
|
+
# The content type of the channel message.
|
3087
|
+
#
|
2962
3088
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2963
3089
|
#
|
2964
3090
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2971,10 +3097,11 @@ module Aws::ChimeSDKMessaging
|
|
2971
3097
|
# resp = client.update_channel_message({
|
2972
3098
|
# channel_arn: "ChimeArn", # required
|
2973
3099
|
# message_id: "MessageId", # required
|
2974
|
-
# content: "
|
3100
|
+
# content: "NonEmptyContent", # required
|
2975
3101
|
# metadata: "Metadata",
|
2976
3102
|
# chime_bearer: "ChimeArn", # required
|
2977
3103
|
# sub_channel_id: "SubChannelId",
|
3104
|
+
# content_type: "ContentType",
|
2978
3105
|
# })
|
2979
3106
|
#
|
2980
3107
|
# @example Response structure
|
@@ -2996,9 +3123,9 @@ module Aws::ChimeSDKMessaging
|
|
2996
3123
|
|
2997
3124
|
# The details of the time when a user last read messages in a channel.
|
2998
3125
|
#
|
2999
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
3000
|
-
# `
|
3001
|
-
# in the header.
|
3126
|
+
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the ARN of
|
3127
|
+
# the `AppInstanceUser` or `AppInstanceBot` that makes the API call as
|
3128
|
+
# the value in the header.
|
3002
3129
|
#
|
3003
3130
|
# </note>
|
3004
3131
|
#
|
@@ -3006,28 +3133,23 @@ module Aws::ChimeSDKMessaging
|
|
3006
3133
|
# The ARN of the channel.
|
3007
3134
|
#
|
3008
3135
|
# @option params [required, String] :chime_bearer
|
3009
|
-
# The
|
3010
|
-
#
|
3011
|
-
# @option params [String] :sub_channel_id
|
3012
|
-
# The ID of the SubChannel in the request.
|
3136
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3137
|
+
# API call.
|
3013
3138
|
#
|
3014
3139
|
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3015
3140
|
#
|
3016
3141
|
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
3017
|
-
# * {Types::UpdateChannelReadMarkerResponse#sub_channel_id #sub_channel_id} => String
|
3018
3142
|
#
|
3019
3143
|
# @example Request syntax with placeholder values
|
3020
3144
|
#
|
3021
3145
|
# resp = client.update_channel_read_marker({
|
3022
3146
|
# channel_arn: "ChimeArn", # required
|
3023
3147
|
# chime_bearer: "ChimeArn", # required
|
3024
|
-
# sub_channel_id: "SubChannelId",
|
3025
3148
|
# })
|
3026
3149
|
#
|
3027
3150
|
# @example Response structure
|
3028
3151
|
#
|
3029
3152
|
# resp.channel_arn #=> String
|
3030
|
-
# resp.sub_channel_id #=> String
|
3031
3153
|
#
|
3032
3154
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker AWS API Documentation
|
3033
3155
|
#
|
@@ -3051,7 +3173,7 @@ module Aws::ChimeSDKMessaging
|
|
3051
3173
|
params: params,
|
3052
3174
|
config: config)
|
3053
3175
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
3054
|
-
context[:gem_version] = '1.
|
3176
|
+
context[:gem_version] = '1.18.0'
|
3055
3177
|
Seahorse::Client::Request.new(handlers, context)
|
3056
3178
|
end
|
3057
3179
|
|