aws-sdk-chimesdkmessaging 1.15.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +394 -156
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +116 -1
- data/lib/aws-sdk-chimesdkmessaging/endpoint_parameters.rb +0 -3
- data/lib/aws-sdk-chimesdkmessaging/endpoint_provider.rb +27 -24
- data/lib/aws-sdk-chimesdkmessaging/endpoints.rb +56 -0
- data/lib/aws-sdk-chimesdkmessaging/plugins/endpoints.rb +8 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +267 -55
- 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
|
#
|
@@ -547,11 +550,11 @@ module Aws::ChimeSDKMessaging
|
|
547
550
|
|
548
551
|
# Creates a channel to which you can add users and send messages.
|
549
552
|
#
|
550
|
-
# **Restriction
|
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
|
#
|
@@ -1147,12 +1168,40 @@ module Aws::ChimeSDKMessaging
|
|
1147
1168
|
req.send_request(options)
|
1148
1169
|
end
|
1149
1170
|
|
1171
|
+
# Deletes the streaming configurations for an `AppInstance`. For more
|
1172
|
+
# information, see [Streaming messaging data][1] in the *Amazon Chime
|
1173
|
+
# SDK Developer Guide*.
|
1174
|
+
#
|
1175
|
+
#
|
1176
|
+
#
|
1177
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html
|
1178
|
+
#
|
1179
|
+
# @option params [required, String] :app_instance_arn
|
1180
|
+
# The ARN of the streaming configurations being deleted.
|
1181
|
+
#
|
1182
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1183
|
+
#
|
1184
|
+
# @example Request syntax with placeholder values
|
1185
|
+
#
|
1186
|
+
# resp = client.delete_messaging_streaming_configurations({
|
1187
|
+
# app_instance_arn: "ChimeArn", # required
|
1188
|
+
# })
|
1189
|
+
#
|
1190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteMessagingStreamingConfigurations AWS API Documentation
|
1191
|
+
#
|
1192
|
+
# @overload delete_messaging_streaming_configurations(params = {})
|
1193
|
+
# @param [Hash] params ({})
|
1194
|
+
def delete_messaging_streaming_configurations(params = {}, options = {})
|
1195
|
+
req = build_request(:delete_messaging_streaming_configurations, params)
|
1196
|
+
req.send_request(options)
|
1197
|
+
end
|
1198
|
+
|
1150
1199
|
# Returns the full details of a channel in an Amazon Chime
|
1151
1200
|
# `AppInstance`.
|
1152
1201
|
#
|
1153
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1154
|
-
# `
|
1155
|
-
# 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.
|
1156
1205
|
#
|
1157
1206
|
# </note>
|
1158
1207
|
#
|
@@ -1160,7 +1209,8 @@ module Aws::ChimeSDKMessaging
|
|
1160
1209
|
# The ARN of the channel.
|
1161
1210
|
#
|
1162
1211
|
# @option params [required, String] :chime_bearer
|
1163
|
-
# The
|
1212
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1213
|
+
# API call.
|
1164
1214
|
#
|
1165
1215
|
# @return [Types::DescribeChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1166
1216
|
#
|
@@ -1189,6 +1239,8 @@ module Aws::ChimeSDKMessaging
|
|
1189
1239
|
# resp.channel.elastic_channel_configuration.maximum_sub_channels #=> Integer
|
1190
1240
|
# resp.channel.elastic_channel_configuration.target_memberships_per_sub_channel #=> Integer
|
1191
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"
|
1192
1244
|
#
|
1193
1245
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
|
1194
1246
|
#
|
@@ -1201,9 +1253,9 @@ module Aws::ChimeSDKMessaging
|
|
1201
1253
|
|
1202
1254
|
# Returns the full details of a channel ban.
|
1203
1255
|
#
|
1204
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1205
|
-
# `
|
1206
|
-
# 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.
|
1207
1259
|
#
|
1208
1260
|
# </note>
|
1209
1261
|
#
|
@@ -1214,7 +1266,8 @@ module Aws::ChimeSDKMessaging
|
|
1214
1266
|
# The `AppInstanceUserArn` of the member being banned.
|
1215
1267
|
#
|
1216
1268
|
# @option params [required, String] :chime_bearer
|
1217
|
-
# The
|
1269
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1270
|
+
# API call.
|
1218
1271
|
#
|
1219
1272
|
# @return [Types::DescribeChannelBanResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1220
1273
|
#
|
@@ -1286,9 +1339,9 @@ module Aws::ChimeSDKMessaging
|
|
1286
1339
|
|
1287
1340
|
# Returns the full details of a user's channel membership.
|
1288
1341
|
#
|
1289
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1290
|
-
# `
|
1291
|
-
# 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.
|
1292
1345
|
#
|
1293
1346
|
# </note>
|
1294
1347
|
#
|
@@ -1299,7 +1352,8 @@ module Aws::ChimeSDKMessaging
|
|
1299
1352
|
# The `AppInstanceUserArn` of the member.
|
1300
1353
|
#
|
1301
1354
|
# @option params [required, String] :chime_bearer
|
1302
|
-
# The
|
1355
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1356
|
+
# API call.
|
1303
1357
|
#
|
1304
1358
|
# @option params [String] :sub_channel_id
|
1305
1359
|
# The ID of the SubChannel in the request. The response contains an
|
@@ -1344,11 +1398,11 @@ module Aws::ChimeSDKMessaging
|
|
1344
1398
|
end
|
1345
1399
|
|
1346
1400
|
# Returns the details of a channel based on the membership of the
|
1347
|
-
# specified `AppInstanceUser`.
|
1401
|
+
# specified `AppInstanceUser` or `AppInstanceBot`.
|
1348
1402
|
#
|
1349
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1350
|
-
# `
|
1351
|
-
# 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.
|
1352
1406
|
#
|
1353
1407
|
# </note>
|
1354
1408
|
#
|
@@ -1356,10 +1410,11 @@ module Aws::ChimeSDKMessaging
|
|
1356
1410
|
# The ARN of the channel to which the user belongs.
|
1357
1411
|
#
|
1358
1412
|
# @option params [required, String] :app_instance_user_arn
|
1359
|
-
# The ARN of the user in a channel.
|
1413
|
+
# The ARN of the user or bot in a channel.
|
1360
1414
|
#
|
1361
1415
|
# @option params [required, String] :chime_bearer
|
1362
|
-
# The
|
1416
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1417
|
+
# API call.
|
1363
1418
|
#
|
1364
1419
|
# @return [Types::DescribeChannelMembershipForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1365
1420
|
#
|
@@ -1395,11 +1450,11 @@ module Aws::ChimeSDKMessaging
|
|
1395
1450
|
end
|
1396
1451
|
|
1397
1452
|
# Returns the full details of a channel moderated by the specified
|
1398
|
-
# `AppInstanceUser`.
|
1453
|
+
# `AppInstanceUser` or `AppInstanceBot`.
|
1399
1454
|
#
|
1400
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1401
|
-
# `
|
1402
|
-
# 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.
|
1403
1458
|
#
|
1404
1459
|
# </note>
|
1405
1460
|
#
|
@@ -1407,10 +1462,11 @@ module Aws::ChimeSDKMessaging
|
|
1407
1462
|
# The ARN of the moderated channel.
|
1408
1463
|
#
|
1409
1464
|
# @option params [required, String] :app_instance_user_arn
|
1410
|
-
# The ARN of the
|
1465
|
+
# The ARN of the user or bot in the moderated channel.
|
1411
1466
|
#
|
1412
1467
|
# @option params [required, String] :chime_bearer
|
1413
|
-
# The
|
1468
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1469
|
+
# API call.
|
1414
1470
|
#
|
1415
1471
|
# @return [Types::DescribeChannelModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1416
1472
|
#
|
@@ -1457,7 +1513,8 @@ module Aws::ChimeSDKMessaging
|
|
1457
1513
|
# The `AppInstanceUserArn` of the channel moderator.
|
1458
1514
|
#
|
1459
1515
|
# @option params [required, String] :chime_bearer
|
1460
|
-
# The
|
1516
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1517
|
+
# API call.
|
1461
1518
|
#
|
1462
1519
|
# @return [Types::DescribeChannelModeratorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1463
1520
|
#
|
@@ -1494,9 +1551,11 @@ module Aws::ChimeSDKMessaging
|
|
1494
1551
|
# channel flow processor.
|
1495
1552
|
#
|
1496
1553
|
# <note markdown="1"> Only administrators or channel moderators can disassociate a channel
|
1497
|
-
# flow.
|
1498
|
-
#
|
1499
|
-
#
|
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.
|
1500
1559
|
#
|
1501
1560
|
# </note>
|
1502
1561
|
#
|
@@ -1528,13 +1587,19 @@ module Aws::ChimeSDKMessaging
|
|
1528
1587
|
req.send_request(options)
|
1529
1588
|
end
|
1530
1589
|
|
1531
|
-
# Gets the membership preferences of an `AppInstanceUser`
|
1532
|
-
# specified channel.
|
1533
|
-
#
|
1534
|
-
#
|
1535
|
-
# moderator roles can't retrieve preferences for other users
|
1536
|
-
# users can't retrieve membership preferences for
|
1537
|
-
# 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>
|
1538
1603
|
#
|
1539
1604
|
# @option params [required, String] :channel_arn
|
1540
1605
|
# The ARN of the channel.
|
@@ -1543,7 +1608,8 @@ module Aws::ChimeSDKMessaging
|
|
1543
1608
|
# The `AppInstanceUserArn` of the member retrieving the preferences.
|
1544
1609
|
#
|
1545
1610
|
# @option params [required, String] :chime_bearer
|
1546
|
-
# The
|
1611
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1612
|
+
# API call.
|
1547
1613
|
#
|
1548
1614
|
# @return [Types::GetChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1549
1615
|
#
|
@@ -1578,9 +1644,9 @@ module Aws::ChimeSDKMessaging
|
|
1578
1644
|
|
1579
1645
|
# Gets the full details of a channel message.
|
1580
1646
|
#
|
1581
|
-
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
1582
|
-
# `
|
1583
|
-
# 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.
|
1584
1650
|
#
|
1585
1651
|
# </note>
|
1586
1652
|
#
|
@@ -1591,7 +1657,8 @@ module Aws::ChimeSDKMessaging
|
|
1591
1657
|
# The ID of the message.
|
1592
1658
|
#
|
1593
1659
|
# @option params [required, String] :chime_bearer
|
1594
|
-
# The
|
1660
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1661
|
+
# API call.
|
1595
1662
|
#
|
1596
1663
|
# @option params [String] :sub_channel_id
|
1597
1664
|
# The ID of the SubChannel in the request.
|
@@ -1634,6 +1701,7 @@ module Aws::ChimeSDKMessaging
|
|
1634
1701
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
1635
1702
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
1636
1703
|
# resp.channel_message.sub_channel_id #=> String
|
1704
|
+
# resp.channel_message.content_type #=> String
|
1637
1705
|
#
|
1638
1706
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
1639
1707
|
#
|
@@ -1673,9 +1741,9 @@ module Aws::ChimeSDKMessaging
|
|
1673
1741
|
#
|
1674
1742
|
# * Only the message sender can invoke this API.
|
1675
1743
|
#
|
1676
|
-
# * The `x-amz-chime-bearer` request header is mandatory. Use the
|
1677
|
-
# `
|
1678
|
-
# 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.
|
1679
1747
|
#
|
1680
1748
|
# </note>
|
1681
1749
|
#
|
@@ -1742,11 +1810,47 @@ module Aws::ChimeSDKMessaging
|
|
1742
1810
|
req.send_request(options)
|
1743
1811
|
end
|
1744
1812
|
|
1745
|
-
#
|
1813
|
+
# Retrieves the data streaming configuration for an `AppInstance`. For
|
1814
|
+
# more information, see [Streaming messaging data][1] in the *Amazon
|
1815
|
+
# Chime SDK Developer Guide*.
|
1746
1816
|
#
|
1747
|
-
#
|
1748
|
-
#
|
1749
|
-
#
|
1817
|
+
#
|
1818
|
+
#
|
1819
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html
|
1820
|
+
#
|
1821
|
+
# @option params [required, String] :app_instance_arn
|
1822
|
+
# The ARN of the streaming configurations.
|
1823
|
+
#
|
1824
|
+
# @return [Types::GetMessagingStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1825
|
+
#
|
1826
|
+
# * {Types::GetMessagingStreamingConfigurationsResponse#streaming_configurations #streaming_configurations} => Array<Types::StreamingConfiguration>
|
1827
|
+
#
|
1828
|
+
# @example Request syntax with placeholder values
|
1829
|
+
#
|
1830
|
+
# resp = client.get_messaging_streaming_configurations({
|
1831
|
+
# app_instance_arn: "ChimeArn", # required
|
1832
|
+
# })
|
1833
|
+
#
|
1834
|
+
# @example Response structure
|
1835
|
+
#
|
1836
|
+
# resp.streaming_configurations #=> Array
|
1837
|
+
# resp.streaming_configurations[0].data_type #=> String, one of "Channel", "ChannelMessage"
|
1838
|
+
# resp.streaming_configurations[0].resource_arn #=> String
|
1839
|
+
#
|
1840
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingStreamingConfigurations AWS API Documentation
|
1841
|
+
#
|
1842
|
+
# @overload get_messaging_streaming_configurations(params = {})
|
1843
|
+
# @param [Hash] params ({})
|
1844
|
+
def get_messaging_streaming_configurations(params = {}, options = {})
|
1845
|
+
req = build_request(:get_messaging_streaming_configurations, params)
|
1846
|
+
req.send_request(options)
|
1847
|
+
end
|
1848
|
+
|
1849
|
+
# Lists all the users and bots banned from a particular channel.
|
1850
|
+
#
|
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.
|
1750
1854
|
#
|
1751
1855
|
# </note>
|
1752
1856
|
#
|
@@ -1761,7 +1865,8 @@ module Aws::ChimeSDKMessaging
|
|
1761
1865
|
# returned.
|
1762
1866
|
#
|
1763
1867
|
# @option params [required, String] :chime_bearer
|
1764
|
-
# The
|
1868
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1869
|
+
# API call.
|
1765
1870
|
#
|
1766
1871
|
# @return [Types::ListChannelBansResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1767
1872
|
#
|
@@ -1849,9 +1954,9 @@ module Aws::ChimeSDKMessaging
|
|
1849
1954
|
|
1850
1955
|
# Lists all channel memberships in a channel.
|
1851
1956
|
#
|
1852
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1853
|
-
# `
|
1854
|
-
# 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.
|
1855
1960
|
#
|
1856
1961
|
# </note>
|
1857
1962
|
#
|
@@ -1879,7 +1984,8 @@ module Aws::ChimeSDKMessaging
|
|
1879
1984
|
# memberships are returned.
|
1880
1985
|
#
|
1881
1986
|
# @option params [required, String] :chime_bearer
|
1882
|
-
# The
|
1987
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
1988
|
+
# API call.
|
1883
1989
|
#
|
1884
1990
|
# @option params [String] :sub_channel_id
|
1885
1991
|
# The ID of the SubChannel in the request.
|
@@ -1925,18 +2031,18 @@ module Aws::ChimeSDKMessaging
|
|
1925
2031
|
req.send_request(options)
|
1926
2032
|
end
|
1927
2033
|
|
1928
|
-
# Lists all channels that
|
1929
|
-
# Only an `AppInstanceAdmin` can call the API with a user ARN
|
1930
|
-
# 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.
|
1931
2037
|
#
|
1932
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
1933
|
-
# `
|
1934
|
-
# 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.
|
1935
2041
|
#
|
1936
2042
|
# </note>
|
1937
2043
|
#
|
1938
2044
|
# @option params [String] :app_instance_user_arn
|
1939
|
-
# The ARN of the
|
2045
|
+
# The ARN of the user or bot.
|
1940
2046
|
#
|
1941
2047
|
# @option params [Integer] :max_results
|
1942
2048
|
# The maximum number of users that you want returned.
|
@@ -1946,7 +2052,8 @@ module Aws::ChimeSDKMessaging
|
|
1946
2052
|
# channel memberships is reached.
|
1947
2053
|
#
|
1948
2054
|
# @option params [required, String] :chime_bearer
|
1949
|
-
# The
|
2055
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2056
|
+
# API call.
|
1950
2057
|
#
|
1951
2058
|
# @return [Types::ListChannelMembershipsForAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1952
2059
|
#
|
@@ -1995,9 +2102,9 @@ module Aws::ChimeSDKMessaging
|
|
1995
2102
|
# redacted, not deleted. Deleted messages do not appear in the results.
|
1996
2103
|
# This action always returns the latest version of an edited message.
|
1997
2104
|
#
|
1998
|
-
# Also, the x-amz-chime-bearer request header is mandatory. Use the
|
1999
|
-
#
|
2000
|
-
# 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.
|
2001
2108
|
#
|
2002
2109
|
# </note>
|
2003
2110
|
#
|
@@ -2022,7 +2129,8 @@ module Aws::ChimeSDKMessaging
|
|
2022
2129
|
# are returned.
|
2023
2130
|
#
|
2024
2131
|
# @option params [required, String] :chime_bearer
|
2025
|
-
# The
|
2132
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2133
|
+
# API call.
|
2026
2134
|
#
|
2027
2135
|
# @option params [String] :sub_channel_id
|
2028
2136
|
# The ID of the SubChannel in the request.
|
@@ -2074,6 +2182,7 @@ module Aws::ChimeSDKMessaging
|
|
2074
2182
|
# resp.channel_messages[0].message_attributes #=> Hash
|
2075
2183
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
2076
2184
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
2185
|
+
# resp.channel_messages[0].content_type #=> String
|
2077
2186
|
# resp.sub_channel_id #=> String
|
2078
2187
|
#
|
2079
2188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
@@ -2087,9 +2196,9 @@ module Aws::ChimeSDKMessaging
|
|
2087
2196
|
|
2088
2197
|
# Lists all the moderators for a channel.
|
2089
2198
|
#
|
2090
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2091
|
-
# `
|
2092
|
-
# 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.
|
2093
2202
|
#
|
2094
2203
|
# </note>
|
2095
2204
|
#
|
@@ -2104,7 +2213,8 @@ module Aws::ChimeSDKMessaging
|
|
2104
2213
|
# are returned.
|
2105
2214
|
#
|
2106
2215
|
# @option params [required, String] :chime_bearer
|
2107
|
-
# The
|
2216
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2217
|
+
# API call.
|
2108
2218
|
#
|
2109
2219
|
# @return [Types::ListChannelModeratorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2110
2220
|
#
|
@@ -2151,9 +2261,9 @@ module Aws::ChimeSDKMessaging
|
|
2151
2261
|
# * Only an `AppInstanceAdmin` can set privacy = `PRIVATE` to list the
|
2152
2262
|
# private channels in an account.
|
2153
2263
|
#
|
2154
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2155
|
-
# `
|
2156
|
-
# 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.
|
2157
2267
|
#
|
2158
2268
|
# </note>
|
2159
2269
|
#
|
@@ -2173,7 +2283,8 @@ module Aws::ChimeSDKMessaging
|
|
2173
2283
|
# are returned.
|
2174
2284
|
#
|
2175
2285
|
# @option params [required, String] :chime_bearer
|
2176
|
-
# The
|
2286
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2287
|
+
# API call.
|
2177
2288
|
#
|
2178
2289
|
# @return [Types::ListChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2179
2290
|
#
|
@@ -2262,14 +2373,14 @@ module Aws::ChimeSDKMessaging
|
|
2262
2373
|
|
2263
2374
|
# A list of the channels moderated by an `AppInstanceUser`.
|
2264
2375
|
#
|
2265
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2266
|
-
# `
|
2267
|
-
# 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.
|
2268
2379
|
#
|
2269
2380
|
# </note>
|
2270
2381
|
#
|
2271
2382
|
# @option params [String] :app_instance_user_arn
|
2272
|
-
# The ARN of the user in the moderated channel.
|
2383
|
+
# The ARN of the user or bot in the moderated channel.
|
2273
2384
|
#
|
2274
2385
|
# @option params [Integer] :max_results
|
2275
2386
|
# The maximum number of channels in the request.
|
@@ -2279,7 +2390,8 @@ module Aws::ChimeSDKMessaging
|
|
2279
2390
|
# channels moderated by the user is reached.
|
2280
2391
|
#
|
2281
2392
|
# @option params [required, String] :chime_bearer
|
2282
|
-
# The
|
2393
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2394
|
+
# API call.
|
2283
2395
|
#
|
2284
2396
|
# @return [Types::ListChannelsModeratedByAppInstanceUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2285
2397
|
#
|
@@ -2398,21 +2510,85 @@ module Aws::ChimeSDKMessaging
|
|
2398
2510
|
req.send_request(options)
|
2399
2511
|
end
|
2400
2512
|
|
2401
|
-
# Sets the
|
2402
|
-
#
|
2403
|
-
#
|
2404
|
-
#
|
2405
|
-
#
|
2406
|
-
#
|
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>
|
2407
2582
|
#
|
2408
2583
|
# @option params [required, String] :channel_arn
|
2409
2584
|
# The ARN of the channel.
|
2410
2585
|
#
|
2411
2586
|
# @option params [required, String] :member_arn
|
2412
|
-
# The
|
2587
|
+
# The ARN of the member setting the preferences.
|
2413
2588
|
#
|
2414
2589
|
# @option params [required, String] :chime_bearer
|
2415
|
-
# The
|
2590
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2591
|
+
# API call.
|
2416
2592
|
#
|
2417
2593
|
# @option params [required, Types::ChannelMembershipPreferences] :preferences
|
2418
2594
|
# The channel membership preferences of an `AppInstanceUser` .
|
@@ -2454,13 +2630,58 @@ module Aws::ChimeSDKMessaging
|
|
2454
2630
|
req.send_request(options)
|
2455
2631
|
end
|
2456
2632
|
|
2633
|
+
# Sets the data streaming configuration for an `AppInstance`. For more
|
2634
|
+
# information, see [Streaming messaging data][1] in the *Amazon Chime
|
2635
|
+
# SDK Developer Guide*.
|
2636
|
+
#
|
2637
|
+
#
|
2638
|
+
#
|
2639
|
+
# [1]: https://docs.aws.amazon.com/chime-sdk/latest/dg/streaming-export.html
|
2640
|
+
#
|
2641
|
+
# @option params [required, String] :app_instance_arn
|
2642
|
+
# The ARN of the streaming configuration.
|
2643
|
+
#
|
2644
|
+
# @option params [required, Array<Types::StreamingConfiguration>] :streaming_configurations
|
2645
|
+
# The streaming configurations.
|
2646
|
+
#
|
2647
|
+
# @return [Types::PutMessagingStreamingConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2648
|
+
#
|
2649
|
+
# * {Types::PutMessagingStreamingConfigurationsResponse#streaming_configurations #streaming_configurations} => Array<Types::StreamingConfiguration>
|
2650
|
+
#
|
2651
|
+
# @example Request syntax with placeholder values
|
2652
|
+
#
|
2653
|
+
# resp = client.put_messaging_streaming_configurations({
|
2654
|
+
# app_instance_arn: "ChimeArn", # required
|
2655
|
+
# streaming_configurations: [ # required
|
2656
|
+
# {
|
2657
|
+
# data_type: "Channel", # required, accepts Channel, ChannelMessage
|
2658
|
+
# resource_arn: "ChimeArn", # required
|
2659
|
+
# },
|
2660
|
+
# ],
|
2661
|
+
# })
|
2662
|
+
#
|
2663
|
+
# @example Response structure
|
2664
|
+
#
|
2665
|
+
# resp.streaming_configurations #=> Array
|
2666
|
+
# resp.streaming_configurations[0].data_type #=> String, one of "Channel", "ChannelMessage"
|
2667
|
+
# resp.streaming_configurations[0].resource_arn #=> String
|
2668
|
+
#
|
2669
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutMessagingStreamingConfigurations AWS API Documentation
|
2670
|
+
#
|
2671
|
+
# @overload put_messaging_streaming_configurations(params = {})
|
2672
|
+
# @param [Hash] params ({})
|
2673
|
+
def put_messaging_streaming_configurations(params = {}, options = {})
|
2674
|
+
req = build_request(:put_messaging_streaming_configurations, params)
|
2675
|
+
req.send_request(options)
|
2676
|
+
end
|
2677
|
+
|
2457
2678
|
# Redacts message content, but not metadata. The message exists in the
|
2458
2679
|
# back end, but the action returns null content, and the state shows as
|
2459
2680
|
# redacted.
|
2460
2681
|
#
|
2461
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2462
|
-
# `
|
2463
|
-
# 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.
|
2464
2685
|
#
|
2465
2686
|
# </note>
|
2466
2687
|
#
|
@@ -2472,7 +2693,8 @@ module Aws::ChimeSDKMessaging
|
|
2472
2693
|
# The ID of the message being redacted.
|
2473
2694
|
#
|
2474
2695
|
# @option params [required, String] :chime_bearer
|
2475
|
-
# The
|
2696
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2697
|
+
# API call.
|
2476
2698
|
#
|
2477
2699
|
# @option params [String] :sub_channel_id
|
2478
2700
|
# The ID of the SubChannel in the request.
|
@@ -2507,9 +2729,13 @@ module Aws::ChimeSDKMessaging
|
|
2507
2729
|
req.send_request(options)
|
2508
2730
|
end
|
2509
2731
|
|
2510
|
-
# Allows `ChimeBearer` to search channels by channel members.
|
2511
|
-
#
|
2512
|
-
#
|
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.
|
2513
2739
|
#
|
2514
2740
|
# @option params [String] :chime_bearer
|
2515
2741
|
# The `AppInstanceUserArn` of the user making the API call.
|
@@ -2568,9 +2794,9 @@ module Aws::ChimeSDKMessaging
|
|
2568
2794
|
|
2569
2795
|
# Sends a message to a particular channel that the member is a part of.
|
2570
2796
|
#
|
2571
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2572
|
-
# `
|
2573
|
-
# 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.
|
2574
2800
|
#
|
2575
2801
|
# Also, `STANDARD` messages can contain 4KB of data and the 1KB of
|
2576
2802
|
# metadata. `CONTROL` messages can contain 30 bytes of data and no
|
@@ -2601,7 +2827,8 @@ module Aws::ChimeSDKMessaging
|
|
2601
2827
|
# not need to pass this option.**
|
2602
2828
|
#
|
2603
2829
|
# @option params [required, String] :chime_bearer
|
2604
|
-
# The
|
2830
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2831
|
+
# API call.
|
2605
2832
|
#
|
2606
2833
|
# @option params [Types::PushNotificationConfiguration] :push_notification
|
2607
2834
|
# The push notification configuration of the message.
|
@@ -2613,6 +2840,9 @@ module Aws::ChimeSDKMessaging
|
|
2613
2840
|
# @option params [String] :sub_channel_id
|
2614
2841
|
# The ID of the SubChannel in the request.
|
2615
2842
|
#
|
2843
|
+
# @option params [String] :content_type
|
2844
|
+
# The content type of the channel message.
|
2845
|
+
#
|
2616
2846
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2617
2847
|
#
|
2618
2848
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2641,6 +2871,7 @@ module Aws::ChimeSDKMessaging
|
|
2641
2871
|
# },
|
2642
2872
|
# },
|
2643
2873
|
# sub_channel_id: "SubChannelId",
|
2874
|
+
# content_type: "ContentType",
|
2644
2875
|
# })
|
2645
2876
|
#
|
2646
2877
|
# @example Response structure
|
@@ -2721,11 +2952,11 @@ module Aws::ChimeSDKMessaging
|
|
2721
2952
|
|
2722
2953
|
# Update a channel's attributes.
|
2723
2954
|
#
|
2724
|
-
# **Restriction
|
2955
|
+
# **Restriction**: You can't change a channel's privacy.
|
2725
2956
|
#
|
2726
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2727
|
-
# `
|
2728
|
-
# 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.
|
2729
2960
|
#
|
2730
2961
|
# </note>
|
2731
2962
|
#
|
@@ -2742,7 +2973,8 @@ module Aws::ChimeSDKMessaging
|
|
2742
2973
|
# The metadata for the update request.
|
2743
2974
|
#
|
2744
2975
|
# @option params [required, String] :chime_bearer
|
2745
|
-
# The
|
2976
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
2977
|
+
# API call.
|
2746
2978
|
#
|
2747
2979
|
# @return [Types::UpdateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2748
2980
|
#
|
@@ -2821,9 +3053,9 @@ module Aws::ChimeSDKMessaging
|
|
2821
3053
|
|
2822
3054
|
# Updates the content of a message.
|
2823
3055
|
#
|
2824
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2825
|
-
# `
|
2826
|
-
# 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.
|
2827
3059
|
#
|
2828
3060
|
# </note>
|
2829
3061
|
#
|
@@ -2833,14 +3065,15 @@ module Aws::ChimeSDKMessaging
|
|
2833
3065
|
# @option params [required, String] :message_id
|
2834
3066
|
# The ID string of the message being updated.
|
2835
3067
|
#
|
2836
|
-
# @option params [String] :content
|
3068
|
+
# @option params [required, String] :content
|
2837
3069
|
# The content of the message being updated.
|
2838
3070
|
#
|
2839
3071
|
# @option params [String] :metadata
|
2840
3072
|
# The metadata of the message being updated.
|
2841
3073
|
#
|
2842
3074
|
# @option params [required, String] :chime_bearer
|
2843
|
-
# The
|
3075
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3076
|
+
# API call.
|
2844
3077
|
#
|
2845
3078
|
# @option params [String] :sub_channel_id
|
2846
3079
|
# The ID of the SubChannel in the request.
|
@@ -2850,6 +3083,9 @@ module Aws::ChimeSDKMessaging
|
|
2850
3083
|
#
|
2851
3084
|
# </note>
|
2852
3085
|
#
|
3086
|
+
# @option params [String] :content_type
|
3087
|
+
# The content type of the channel message.
|
3088
|
+
#
|
2853
3089
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2854
3090
|
#
|
2855
3091
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
@@ -2862,10 +3098,11 @@ module Aws::ChimeSDKMessaging
|
|
2862
3098
|
# resp = client.update_channel_message({
|
2863
3099
|
# channel_arn: "ChimeArn", # required
|
2864
3100
|
# message_id: "MessageId", # required
|
2865
|
-
# content: "
|
3101
|
+
# content: "NonEmptyContent", # required
|
2866
3102
|
# metadata: "Metadata",
|
2867
3103
|
# chime_bearer: "ChimeArn", # required
|
2868
3104
|
# sub_channel_id: "SubChannelId",
|
3105
|
+
# content_type: "ContentType",
|
2869
3106
|
# })
|
2870
3107
|
#
|
2871
3108
|
# @example Response structure
|
@@ -2887,9 +3124,9 @@ module Aws::ChimeSDKMessaging
|
|
2887
3124
|
|
2888
3125
|
# The details of the time when a user last read messages in a channel.
|
2889
3126
|
#
|
2890
|
-
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
2891
|
-
# `
|
2892
|
-
# 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.
|
2893
3130
|
#
|
2894
3131
|
# </note>
|
2895
3132
|
#
|
@@ -2897,7 +3134,8 @@ module Aws::ChimeSDKMessaging
|
|
2897
3134
|
# The ARN of the channel.
|
2898
3135
|
#
|
2899
3136
|
# @option params [required, String] :chime_bearer
|
2900
|
-
# The
|
3137
|
+
# The ARN of the `AppInstanceUser` or `AppInstanceBot` that makes the
|
3138
|
+
# API call.
|
2901
3139
|
#
|
2902
3140
|
# @option params [String] :sub_channel_id
|
2903
3141
|
# The ID of the SubChannel in the request.
|
@@ -2942,7 +3180,7 @@ module Aws::ChimeSDKMessaging
|
|
2942
3180
|
params: params,
|
2943
3181
|
config: config)
|
2944
3182
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
2945
|
-
context[:gem_version] = '1.
|
3183
|
+
context[:gem_version] = '1.17.0'
|
2946
3184
|
Seahorse::Client::Request.new(handlers, context)
|
2947
3185
|
end
|
2948
3186
|
|