aws-sdk-chimesdkmessaging 1.11.0 → 1.13.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 +191 -5
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +82 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +358 -28
- data/lib/aws-sdk-chimesdkmessaging.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 410d87f5f9a253f4282b911cd7e9368322da3380bae9e5ab2207e5cb4e9470e3
|
4
|
+
data.tar.gz: fe7f8f44fe2c3a2eaa195d4eeaa8de7c9afd42f2855bc4242ea5e4ad6ce2e20b
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 075cfbdcf859c4d26352c92a03929ae909fd938c8514af21abf88166de8384c0da84eafe3e9b0ef25beb0b87034adb7894cb1e52f8bd989a04f75eebf926a81a
|
7
|
+
data.tar.gz: 49a602e00008a376c0bd29193a6648399cb09835a40b338ebb10884f71b8aff810b55fa221b70ed531374b2e459042ffb32c31ee1517f75722e370e52253fbc4
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.13.0 (2022-10-19)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for Chime Messaging SDK
|
8
|
+
|
9
|
+
1.12.0 (2022-08-12)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - The Amazon Chime SDK now supports channels with up to one million participants with elastic channels.
|
13
|
+
|
4
14
|
1.11.0 (2022-06-06)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.13.0
|
@@ -409,6 +409,14 @@ module Aws::ChimeSDKMessaging
|
|
409
409
|
# @option params [required, String] :chime_bearer
|
410
410
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
411
411
|
#
|
412
|
+
# @option params [String] :sub_channel_id
|
413
|
+
# The ID of the SubChannel in the request.
|
414
|
+
#
|
415
|
+
# <note markdown="1"> Only required when creating membership in a SubChannel for a moderator
|
416
|
+
# in an elastic channel.
|
417
|
+
#
|
418
|
+
# </note>
|
419
|
+
#
|
412
420
|
# @return [Types::BatchCreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
413
421
|
#
|
414
422
|
# * {Types::BatchCreateChannelMembershipResponse#batch_channel_memberships #batch_channel_memberships} => Types::BatchChannelMemberships
|
@@ -421,6 +429,7 @@ module Aws::ChimeSDKMessaging
|
|
421
429
|
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
422
430
|
# member_arns: ["ChimeArn"], # required
|
423
431
|
# chime_bearer: "ChimeArn", # required
|
432
|
+
# sub_channel_id: "SubChannelId",
|
424
433
|
# })
|
425
434
|
#
|
426
435
|
# @example Response structure
|
@@ -432,6 +441,7 @@ module Aws::ChimeSDKMessaging
|
|
432
441
|
# resp.batch_channel_memberships.members[0].arn #=> String
|
433
442
|
# resp.batch_channel_memberships.members[0].name #=> String
|
434
443
|
# resp.batch_channel_memberships.channel_arn #=> String
|
444
|
+
# resp.batch_channel_memberships.sub_channel_id #=> String
|
435
445
|
# resp.errors #=> Array
|
436
446
|
# resp.errors[0].member_arn #=> String
|
437
447
|
# resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
@@ -500,6 +510,7 @@ module Aws::ChimeSDKMessaging
|
|
500
510
|
# string_values: ["MessageAttributeStringValue"],
|
501
511
|
# },
|
502
512
|
# },
|
513
|
+
# sub_channel_id: "SubChannelId",
|
503
514
|
# },
|
504
515
|
# })
|
505
516
|
#
|
@@ -568,6 +579,11 @@ module Aws::ChimeSDKMessaging
|
|
568
579
|
# @option params [Array<String>] :moderator_arns
|
569
580
|
# The ARNs of the channel moderators in the request.
|
570
581
|
#
|
582
|
+
# @option params [Types::ElasticChannelConfiguration] :elastic_channel_configuration
|
583
|
+
# The attributes required to configure and create an elastic channel. An
|
584
|
+
# elastic channel can support a maximum of 1-million users, excluding
|
585
|
+
# moderators.
|
586
|
+
#
|
571
587
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
572
588
|
#
|
573
589
|
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
@@ -591,6 +607,11 @@ module Aws::ChimeSDKMessaging
|
|
591
607
|
# channel_id: "ChannelId",
|
592
608
|
# member_arns: ["ChimeArn"],
|
593
609
|
# moderator_arns: ["ChimeArn"],
|
610
|
+
# elastic_channel_configuration: {
|
611
|
+
# maximum_sub_channels: 1, # required
|
612
|
+
# target_memberships_per_sub_channel: 1, # required
|
613
|
+
# minimum_membership_percentage: 1, # required
|
614
|
+
# },
|
594
615
|
# })
|
595
616
|
#
|
596
617
|
# @example Response structure
|
@@ -782,10 +803,19 @@ module Aws::ChimeSDKMessaging
|
|
782
803
|
# @option params [required, String] :chime_bearer
|
783
804
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
784
805
|
#
|
806
|
+
# @option params [String] :sub_channel_id
|
807
|
+
# The ID of the SubChannel in the request.
|
808
|
+
#
|
809
|
+
# <note markdown="1"> Only required when creating membership in a SubChannel for a moderator
|
810
|
+
# in an elastic channel.
|
811
|
+
#
|
812
|
+
# </note>
|
813
|
+
#
|
785
814
|
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
786
815
|
#
|
787
816
|
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
788
817
|
# * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
|
818
|
+
# * {Types::CreateChannelMembershipResponse#sub_channel_id #sub_channel_id} => String
|
789
819
|
#
|
790
820
|
# @example Request syntax with placeholder values
|
791
821
|
#
|
@@ -794,6 +824,7 @@ module Aws::ChimeSDKMessaging
|
|
794
824
|
# member_arn: "ChimeArn", # required
|
795
825
|
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
796
826
|
# chime_bearer: "ChimeArn", # required
|
827
|
+
# sub_channel_id: "SubChannelId",
|
797
828
|
# })
|
798
829
|
#
|
799
830
|
# @example Response structure
|
@@ -801,6 +832,7 @@ module Aws::ChimeSDKMessaging
|
|
801
832
|
# resp.channel_arn #=> String
|
802
833
|
# resp.member.arn #=> String
|
803
834
|
# resp.member.name #=> String
|
835
|
+
# resp.sub_channel_id #=> String
|
804
836
|
#
|
805
837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembership AWS API Documentation
|
806
838
|
#
|
@@ -881,6 +913,9 @@ module Aws::ChimeSDKMessaging
|
|
881
913
|
# @option params [required, String] :chime_bearer
|
882
914
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
883
915
|
#
|
916
|
+
# @option params [String] :sub_channel_id
|
917
|
+
# The ID of the SubChannel in the request.
|
918
|
+
#
|
884
919
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
885
920
|
#
|
886
921
|
# @example Request syntax with placeholder values
|
@@ -888,6 +923,7 @@ module Aws::ChimeSDKMessaging
|
|
888
923
|
# resp = client.delete_channel({
|
889
924
|
# channel_arn: "ChimeArn", # required
|
890
925
|
# chime_bearer: "ChimeArn", # required
|
926
|
+
# sub_channel_id: "SubChannelId",
|
891
927
|
# })
|
892
928
|
#
|
893
929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel AWS API Documentation
|
@@ -984,6 +1020,13 @@ module Aws::ChimeSDKMessaging
|
|
984
1020
|
# @option params [required, String] :chime_bearer
|
985
1021
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
986
1022
|
#
|
1023
|
+
# @option params [String] :sub_channel_id
|
1024
|
+
# The ID of the SubChannel in the request.
|
1025
|
+
#
|
1026
|
+
# <note markdown="1"> Only for use by moderators.
|
1027
|
+
#
|
1028
|
+
# </note>
|
1029
|
+
#
|
987
1030
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
988
1031
|
#
|
989
1032
|
# @example Request syntax with placeholder values
|
@@ -992,6 +1035,7 @@ module Aws::ChimeSDKMessaging
|
|
992
1035
|
# channel_arn: "ChimeArn", # required
|
993
1036
|
# member_arn: "ChimeArn", # required
|
994
1037
|
# chime_bearer: "ChimeArn", # required
|
1038
|
+
# sub_channel_id: "SubChannelId",
|
995
1039
|
# })
|
996
1040
|
#
|
997
1041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembership AWS API Documentation
|
@@ -1022,6 +1066,14 @@ module Aws::ChimeSDKMessaging
|
|
1022
1066
|
# @option params [required, String] :chime_bearer
|
1023
1067
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1024
1068
|
#
|
1069
|
+
# @option params [String] :sub_channel_id
|
1070
|
+
# The ID of the SubChannel in the request.
|
1071
|
+
#
|
1072
|
+
# <note markdown="1"> Only required when deleting messages in a SubChannel that the user
|
1073
|
+
# belongs to.
|
1074
|
+
#
|
1075
|
+
# </note>
|
1076
|
+
#
|
1025
1077
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1026
1078
|
#
|
1027
1079
|
# @example Request syntax with placeholder values
|
@@ -1030,6 +1082,7 @@ module Aws::ChimeSDKMessaging
|
|
1030
1082
|
# channel_arn: "ChimeArn", # required
|
1031
1083
|
# message_id: "MessageId", # required
|
1032
1084
|
# chime_bearer: "ChimeArn", # required
|
1085
|
+
# sub_channel_id: "SubChannelId",
|
1033
1086
|
# })
|
1034
1087
|
#
|
1035
1088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessage AWS API Documentation
|
@@ -1116,6 +1169,9 @@ module Aws::ChimeSDKMessaging
|
|
1116
1169
|
# resp.channel.last_message_timestamp #=> Time
|
1117
1170
|
# resp.channel.last_updated_timestamp #=> Time
|
1118
1171
|
# resp.channel.channel_flow_arn #=> String
|
1172
|
+
# resp.channel.elastic_channel_configuration.maximum_sub_channels #=> Integer
|
1173
|
+
# resp.channel.elastic_channel_configuration.target_memberships_per_sub_channel #=> Integer
|
1174
|
+
# resp.channel.elastic_channel_configuration.minimum_membership_percentage #=> Integer
|
1119
1175
|
#
|
1120
1176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
|
1121
1177
|
#
|
@@ -1228,6 +1284,14 @@ module Aws::ChimeSDKMessaging
|
|
1228
1284
|
# @option params [required, String] :chime_bearer
|
1229
1285
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1230
1286
|
#
|
1287
|
+
# @option params [String] :sub_channel_id
|
1288
|
+
# The ID of the SubChannel in the request. The response contains an
|
1289
|
+
# `ElasticChannelConfiguration` object.
|
1290
|
+
#
|
1291
|
+
# <note markdown="1"> Only required to get a user’s SubChannel membership details.
|
1292
|
+
#
|
1293
|
+
# </note>
|
1294
|
+
#
|
1231
1295
|
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1232
1296
|
#
|
1233
1297
|
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
@@ -1238,6 +1302,7 @@ module Aws::ChimeSDKMessaging
|
|
1238
1302
|
# channel_arn: "ChimeArn", # required
|
1239
1303
|
# member_arn: "ChimeArn", # required
|
1240
1304
|
# chime_bearer: "ChimeArn", # required
|
1305
|
+
# sub_channel_id: "SubChannelId",
|
1241
1306
|
# })
|
1242
1307
|
#
|
1243
1308
|
# @example Response structure
|
@@ -1250,6 +1315,7 @@ module Aws::ChimeSDKMessaging
|
|
1250
1315
|
# resp.channel_membership.channel_arn #=> String
|
1251
1316
|
# resp.channel_membership.created_timestamp #=> Time
|
1252
1317
|
# resp.channel_membership.last_updated_timestamp #=> Time
|
1318
|
+
# resp.channel_membership.sub_channel_id #=> String
|
1253
1319
|
#
|
1254
1320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembership AWS API Documentation
|
1255
1321
|
#
|
@@ -1300,6 +1366,7 @@ module Aws::ChimeSDKMessaging
|
|
1300
1366
|
# resp.channel_membership.channel_summary.last_message_timestamp #=> Time
|
1301
1367
|
# resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
1302
1368
|
# resp.channel_membership.app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
1369
|
+
# resp.channel_membership.app_instance_user_membership_summary.sub_channel_id #=> String
|
1303
1370
|
#
|
1304
1371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
|
1305
1372
|
#
|
@@ -1509,6 +1576,14 @@ module Aws::ChimeSDKMessaging
|
|
1509
1576
|
# @option params [required, String] :chime_bearer
|
1510
1577
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1511
1578
|
#
|
1579
|
+
# @option params [String] :sub_channel_id
|
1580
|
+
# The ID of the SubChannel in the request.
|
1581
|
+
#
|
1582
|
+
# <note markdown="1"> Only required when getting messages in a SubChannel that the user
|
1583
|
+
# belongs to.
|
1584
|
+
#
|
1585
|
+
# </note>
|
1586
|
+
#
|
1512
1587
|
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1513
1588
|
#
|
1514
1589
|
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
@@ -1519,6 +1594,7 @@ module Aws::ChimeSDKMessaging
|
|
1519
1594
|
# channel_arn: "ChimeArn", # required
|
1520
1595
|
# message_id: "MessageId", # required
|
1521
1596
|
# chime_bearer: "ChimeArn", # required
|
1597
|
+
# sub_channel_id: "SubChannelId",
|
1522
1598
|
# })
|
1523
1599
|
#
|
1524
1600
|
# @example Response structure
|
@@ -1540,6 +1616,7 @@ module Aws::ChimeSDKMessaging
|
|
1540
1616
|
# resp.channel_message.message_attributes #=> Hash
|
1541
1617
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
1542
1618
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
1619
|
+
# resp.channel_message.sub_channel_id #=> String
|
1543
1620
|
#
|
1544
1621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
1545
1622
|
#
|
@@ -1594,6 +1671,14 @@ module Aws::ChimeSDKMessaging
|
|
1594
1671
|
# @option params [required, String] :chime_bearer
|
1595
1672
|
# The `AppInstanceUserArn` of the user making the API call.
|
1596
1673
|
#
|
1674
|
+
# @option params [String] :sub_channel_id
|
1675
|
+
# The ID of the SubChannel in the request.
|
1676
|
+
#
|
1677
|
+
# <note markdown="1"> Only required when getting message status in a SubChannel that the
|
1678
|
+
# user belongs to.
|
1679
|
+
#
|
1680
|
+
# </note>
|
1681
|
+
#
|
1597
1682
|
# @return [Types::GetChannelMessageStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1598
1683
|
#
|
1599
1684
|
# * {Types::GetChannelMessageStatusResponse#status #status} => Types::ChannelMessageStatusStructure
|
@@ -1604,6 +1689,7 @@ module Aws::ChimeSDKMessaging
|
|
1604
1689
|
# channel_arn: "ChimeArn", # required
|
1605
1690
|
# message_id: "MessageId", # required
|
1606
1691
|
# chime_bearer: "ChimeArn", # required
|
1692
|
+
# sub_channel_id: "SubChannelId",
|
1607
1693
|
# })
|
1608
1694
|
#
|
1609
1695
|
# @example Response structure
|
@@ -1778,6 +1864,14 @@ module Aws::ChimeSDKMessaging
|
|
1778
1864
|
# @option params [required, String] :chime_bearer
|
1779
1865
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1780
1866
|
#
|
1867
|
+
# @option params [String] :sub_channel_id
|
1868
|
+
# The ID of the SubChannel in the request.
|
1869
|
+
#
|
1870
|
+
# <note markdown="1"> Only required when listing a user's memberships in a particular
|
1871
|
+
# sub-channel of an elastic channel.
|
1872
|
+
#
|
1873
|
+
# </note>
|
1874
|
+
#
|
1781
1875
|
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1782
1876
|
#
|
1783
1877
|
# * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
|
@@ -1794,6 +1888,7 @@ module Aws::ChimeSDKMessaging
|
|
1794
1888
|
# max_results: 1,
|
1795
1889
|
# next_token: "NextToken",
|
1796
1890
|
# chime_bearer: "ChimeArn", # required
|
1891
|
+
# sub_channel_id: "SubChannelId",
|
1797
1892
|
# })
|
1798
1893
|
#
|
1799
1894
|
# @example Response structure
|
@@ -1863,6 +1958,7 @@ module Aws::ChimeSDKMessaging
|
|
1863
1958
|
# resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
|
1864
1959
|
# resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
1865
1960
|
# resp.channel_memberships[0].app_instance_user_membership_summary.read_marker_timestamp #=> Time
|
1961
|
+
# resp.channel_memberships[0].app_instance_user_membership_summary.sub_channel_id #=> String
|
1866
1962
|
# resp.next_token #=> String
|
1867
1963
|
#
|
1868
1964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser AWS API Documentation
|
@@ -1911,11 +2007,20 @@ module Aws::ChimeSDKMessaging
|
|
1911
2007
|
# @option params [required, String] :chime_bearer
|
1912
2008
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1913
2009
|
#
|
2010
|
+
# @option params [String] :sub_channel_id
|
2011
|
+
# The ID of the SubChannel in the request.
|
2012
|
+
#
|
2013
|
+
# <note markdown="1"> Only required when listing the messages in a SubChannel that the user
|
2014
|
+
# belongs to.
|
2015
|
+
#
|
2016
|
+
# </note>
|
2017
|
+
#
|
1914
2018
|
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1915
2019
|
#
|
1916
2020
|
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
1917
2021
|
# * {Types::ListChannelMessagesResponse#next_token #next_token} => String
|
1918
2022
|
# * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array<Types::ChannelMessageSummary>
|
2023
|
+
# * {Types::ListChannelMessagesResponse#sub_channel_id #sub_channel_id} => String
|
1919
2024
|
#
|
1920
2025
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1921
2026
|
#
|
@@ -1929,6 +2034,7 @@ module Aws::ChimeSDKMessaging
|
|
1929
2034
|
# max_results: 1,
|
1930
2035
|
# next_token: "NextToken",
|
1931
2036
|
# chime_bearer: "ChimeArn", # required
|
2037
|
+
# sub_channel_id: "SubChannelId",
|
1932
2038
|
# })
|
1933
2039
|
#
|
1934
2040
|
# @example Response structure
|
@@ -1951,6 +2057,7 @@ module Aws::ChimeSDKMessaging
|
|
1951
2057
|
# resp.channel_messages[0].message_attributes #=> Hash
|
1952
2058
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
1953
2059
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
2060
|
+
# resp.sub_channel_id #=> String
|
1954
2061
|
#
|
1955
2062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
1956
2063
|
#
|
@@ -2193,6 +2300,57 @@ module Aws::ChimeSDKMessaging
|
|
2193
2300
|
req.send_request(options)
|
2194
2301
|
end
|
2195
2302
|
|
2303
|
+
# Lists all the SubChannels in an elastic channel when given a channel
|
2304
|
+
# ID. Available only to the app instance admins and channel moderators
|
2305
|
+
# of elastic channels.
|
2306
|
+
#
|
2307
|
+
# @option params [required, String] :channel_arn
|
2308
|
+
# The ARN of elastic channel.
|
2309
|
+
#
|
2310
|
+
# @option params [required, String] :chime_bearer
|
2311
|
+
# The `AppInstanceUserArn` of the user making the API call.
|
2312
|
+
#
|
2313
|
+
# @option params [Integer] :max_results
|
2314
|
+
# The maximum number of sub-channels that you want to return.
|
2315
|
+
#
|
2316
|
+
# @option params [String] :next_token
|
2317
|
+
# The token passed by previous API calls until all requested
|
2318
|
+
# sub-channels are returned.
|
2319
|
+
#
|
2320
|
+
# @return [Types::ListSubChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2321
|
+
#
|
2322
|
+
# * {Types::ListSubChannelsResponse#channel_arn #channel_arn} => String
|
2323
|
+
# * {Types::ListSubChannelsResponse#sub_channels #sub_channels} => Array<Types::SubChannelSummary>
|
2324
|
+
# * {Types::ListSubChannelsResponse#next_token #next_token} => String
|
2325
|
+
#
|
2326
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2327
|
+
#
|
2328
|
+
# @example Request syntax with placeholder values
|
2329
|
+
#
|
2330
|
+
# resp = client.list_sub_channels({
|
2331
|
+
# channel_arn: "ChimeArn", # required
|
2332
|
+
# chime_bearer: "ChimeArn", # required
|
2333
|
+
# max_results: 1,
|
2334
|
+
# next_token: "NextToken",
|
2335
|
+
# })
|
2336
|
+
#
|
2337
|
+
# @example Response structure
|
2338
|
+
#
|
2339
|
+
# resp.channel_arn #=> String
|
2340
|
+
# resp.sub_channels #=> Array
|
2341
|
+
# resp.sub_channels[0].sub_channel_id #=> String
|
2342
|
+
# resp.sub_channels[0].membership_count #=> Integer
|
2343
|
+
# resp.next_token #=> String
|
2344
|
+
#
|
2345
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListSubChannels AWS API Documentation
|
2346
|
+
#
|
2347
|
+
# @overload list_sub_channels(params = {})
|
2348
|
+
# @param [Hash] params ({})
|
2349
|
+
def list_sub_channels(params = {}, options = {})
|
2350
|
+
req = build_request(:list_sub_channels, params)
|
2351
|
+
req.send_request(options)
|
2352
|
+
end
|
2353
|
+
|
2196
2354
|
# Lists the tags applied to an Amazon Chime SDK messaging resource.
|
2197
2355
|
#
|
2198
2356
|
# @option params [required, String] :resource_arn
|
@@ -2299,10 +2457,14 @@ module Aws::ChimeSDKMessaging
|
|
2299
2457
|
# @option params [required, String] :chime_bearer
|
2300
2458
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2301
2459
|
#
|
2460
|
+
# @option params [String] :sub_channel_id
|
2461
|
+
# The ID of the SubChannel in the request.
|
2462
|
+
#
|
2302
2463
|
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2303
2464
|
#
|
2304
2465
|
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
2305
2466
|
# * {Types::RedactChannelMessageResponse#message_id #message_id} => String
|
2467
|
+
# * {Types::RedactChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2306
2468
|
#
|
2307
2469
|
# @example Request syntax with placeholder values
|
2308
2470
|
#
|
@@ -2310,12 +2472,14 @@ module Aws::ChimeSDKMessaging
|
|
2310
2472
|
# channel_arn: "ChimeArn", # required
|
2311
2473
|
# message_id: "MessageId", # required
|
2312
2474
|
# chime_bearer: "ChimeArn", # required
|
2475
|
+
# sub_channel_id: "SubChannelId",
|
2313
2476
|
# })
|
2314
2477
|
#
|
2315
2478
|
# @example Response structure
|
2316
2479
|
#
|
2317
2480
|
# resp.channel_arn #=> String
|
2318
2481
|
# resp.message_id #=> String
|
2482
|
+
# resp.sub_channel_id #=> String
|
2319
2483
|
#
|
2320
2484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessage AWS API Documentation
|
2321
2485
|
#
|
@@ -2326,10 +2490,9 @@ module Aws::ChimeSDKMessaging
|
|
2326
2490
|
req.send_request(options)
|
2327
2491
|
end
|
2328
2492
|
|
2329
|
-
# Allows
|
2330
|
-
#
|
2331
|
-
#
|
2332
|
-
# `AppInstance`.
|
2493
|
+
# Allows `ChimeBearer` to search channels by channel members.
|
2494
|
+
# AppInstanceUsers can search across the channels that they belong to.
|
2495
|
+
# AppInstanceAdmins can search across all channels.
|
2333
2496
|
#
|
2334
2497
|
# @option params [String] :chime_bearer
|
2335
2498
|
# The `AppInstanceUserArn` of the user making the API call.
|
@@ -2430,11 +2593,15 @@ module Aws::ChimeSDKMessaging
|
|
2430
2593
|
# The attributes for the message, used for message filtering along with
|
2431
2594
|
# a `FilterRule` defined in the `PushNotificationPreferences`.
|
2432
2595
|
#
|
2596
|
+
# @option params [String] :sub_channel_id
|
2597
|
+
# The ID of the SubChannel in the request.
|
2598
|
+
#
|
2433
2599
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2434
2600
|
#
|
2435
2601
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
2436
2602
|
# * {Types::SendChannelMessageResponse#message_id #message_id} => String
|
2437
2603
|
# * {Types::SendChannelMessageResponse#status #status} => Types::ChannelMessageStatusStructure
|
2604
|
+
# * {Types::SendChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2438
2605
|
#
|
2439
2606
|
# @example Request syntax with placeholder values
|
2440
2607
|
#
|
@@ -2456,6 +2623,7 @@ module Aws::ChimeSDKMessaging
|
|
2456
2623
|
# string_values: ["MessageAttributeStringValue"],
|
2457
2624
|
# },
|
2458
2625
|
# },
|
2626
|
+
# sub_channel_id: "SubChannelId",
|
2459
2627
|
# })
|
2460
2628
|
#
|
2461
2629
|
# @example Response structure
|
@@ -2464,6 +2632,7 @@ module Aws::ChimeSDKMessaging
|
|
2464
2632
|
# resp.message_id #=> String
|
2465
2633
|
# resp.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
2466
2634
|
# resp.status.detail #=> String
|
2635
|
+
# resp.sub_channel_id #=> String
|
2467
2636
|
#
|
2468
2637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessage AWS API Documentation
|
2469
2638
|
#
|
@@ -2656,11 +2825,20 @@ module Aws::ChimeSDKMessaging
|
|
2656
2825
|
# @option params [required, String] :chime_bearer
|
2657
2826
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2658
2827
|
#
|
2828
|
+
# @option params [String] :sub_channel_id
|
2829
|
+
# The ID of the SubChannel in the request.
|
2830
|
+
#
|
2831
|
+
# <note markdown="1"> Only required when updating messages in a SubChannel that the user
|
2832
|
+
# belongs to.
|
2833
|
+
#
|
2834
|
+
# </note>
|
2835
|
+
#
|
2659
2836
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2660
2837
|
#
|
2661
2838
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
2662
2839
|
# * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
|
2663
2840
|
# * {Types::UpdateChannelMessageResponse#status #status} => Types::ChannelMessageStatusStructure
|
2841
|
+
# * {Types::UpdateChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2664
2842
|
#
|
2665
2843
|
# @example Request syntax with placeholder values
|
2666
2844
|
#
|
@@ -2670,6 +2848,7 @@ module Aws::ChimeSDKMessaging
|
|
2670
2848
|
# content: "Content",
|
2671
2849
|
# metadata: "Metadata",
|
2672
2850
|
# chime_bearer: "ChimeArn", # required
|
2851
|
+
# sub_channel_id: "SubChannelId",
|
2673
2852
|
# })
|
2674
2853
|
#
|
2675
2854
|
# @example Response structure
|
@@ -2678,6 +2857,7 @@ module Aws::ChimeSDKMessaging
|
|
2678
2857
|
# resp.message_id #=> String
|
2679
2858
|
# resp.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
2680
2859
|
# resp.status.detail #=> String
|
2860
|
+
# resp.sub_channel_id #=> String
|
2681
2861
|
#
|
2682
2862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessage AWS API Documentation
|
2683
2863
|
#
|
@@ -2702,20 +2882,26 @@ module Aws::ChimeSDKMessaging
|
|
2702
2882
|
# @option params [required, String] :chime_bearer
|
2703
2883
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2704
2884
|
#
|
2885
|
+
# @option params [String] :sub_channel_id
|
2886
|
+
# The ID of the SubChannel in the request.
|
2887
|
+
#
|
2705
2888
|
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2706
2889
|
#
|
2707
2890
|
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
2891
|
+
# * {Types::UpdateChannelReadMarkerResponse#sub_channel_id #sub_channel_id} => String
|
2708
2892
|
#
|
2709
2893
|
# @example Request syntax with placeholder values
|
2710
2894
|
#
|
2711
2895
|
# resp = client.update_channel_read_marker({
|
2712
2896
|
# channel_arn: "ChimeArn", # required
|
2713
2897
|
# chime_bearer: "ChimeArn", # required
|
2898
|
+
# sub_channel_id: "SubChannelId",
|
2714
2899
|
# })
|
2715
2900
|
#
|
2716
2901
|
# @example Response structure
|
2717
2902
|
#
|
2718
2903
|
# resp.channel_arn #=> String
|
2904
|
+
# resp.sub_channel_id #=> String
|
2719
2905
|
#
|
2720
2906
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker AWS API Documentation
|
2721
2907
|
#
|
@@ -2739,7 +2925,7 @@ module Aws::ChimeSDKMessaging
|
|
2739
2925
|
params: params,
|
2740
2926
|
config: config)
|
2741
2927
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
2742
|
-
context[:gem_version] = '1.
|
2928
|
+
context[:gem_version] = '1.13.0'
|
2743
2929
|
Seahorse::Client::Request.new(handlers, context)
|
2744
2930
|
end
|
2745
2931
|
|