aws-sdk-chimesdkmessaging 1.9.0 → 1.12.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +266 -5
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +142 -2
- data/lib/aws-sdk-chimesdkmessaging/types.rb +491 -34
- data/lib/aws-sdk-chimesdkmessaging.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 58c62f418eb4f61fff54d85961f10fb5c4d71ac96f788dedcc9c8e6b445e914e
|
4
|
+
data.tar.gz: c3ddd7616528875b93f2d53104554be9ff3ca52286d1f743cedc0865a572a507
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 121be8ef6824a0b3249db6fea44ee9ba76501154a0a4d3262d9a25aa3f08df26a3753a1d27a0c280d1bcd1a0b0f9a6551d4004d756b9cea8e01e36d1a2f07107
|
7
|
+
data.tar.gz: c1eb26dc9b7dd1a4aee35e398726a486b6d0c3c6e5c66f76ad1e7fe7ccf44714095e0ed3294b4cf9ac9d9935c078dab25054ffc56498e006bb8a285b162c26b0
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.12.0 (2022-08-12)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - The Amazon Chime SDK now supports channels with up to one million participants with elastic channels.
|
8
|
+
|
9
|
+
1.11.0 (2022-06-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for searching channels by members via the SearchChannels API, removes required restrictions for Name and Mode in UpdateChannel API and enhances CreateChannel API by exposing member and moderator list as well as channel id as optional parameters.
|
13
|
+
|
14
|
+
1.10.0 (2022-02-24)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
4
19
|
1.9.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.12.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::ChimeSDKMessaging
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -407,6 +409,14 @@ module Aws::ChimeSDKMessaging
|
|
407
409
|
# @option params [required, String] :chime_bearer
|
408
410
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
409
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
|
+
#
|
410
420
|
# @return [Types::BatchCreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
411
421
|
#
|
412
422
|
# * {Types::BatchCreateChannelMembershipResponse#batch_channel_memberships #batch_channel_memberships} => Types::BatchChannelMemberships
|
@@ -419,6 +429,7 @@ module Aws::ChimeSDKMessaging
|
|
419
429
|
# type: "DEFAULT", # accepts DEFAULT, HIDDEN
|
420
430
|
# member_arns: ["ChimeArn"], # required
|
421
431
|
# chime_bearer: "ChimeArn", # required
|
432
|
+
# sub_channel_id: "SubChannelId",
|
422
433
|
# })
|
423
434
|
#
|
424
435
|
# @example Response structure
|
@@ -430,6 +441,7 @@ module Aws::ChimeSDKMessaging
|
|
430
441
|
# resp.batch_channel_memberships.members[0].arn #=> String
|
431
442
|
# resp.batch_channel_memberships.members[0].name #=> String
|
432
443
|
# resp.batch_channel_memberships.channel_arn #=> String
|
444
|
+
# resp.batch_channel_memberships.sub_channel_id #=> String
|
433
445
|
# resp.errors #=> Array
|
434
446
|
# resp.errors[0].member_arn #=> String
|
435
447
|
# resp.errors[0].error_code #=> String, one of "BadRequest", "Conflict", "Forbidden", "NotFound", "PreconditionFailed", "ResourceLimitExceeded", "ServiceFailure", "AccessDenied", "ServiceUnavailable", "Throttled", "Throttling", "Unauthorized", "Unprocessable", "VoiceConnectorGroupAssociationsExist", "PhoneNumberAssociationsExist"
|
@@ -498,6 +510,7 @@ module Aws::ChimeSDKMessaging
|
|
498
510
|
# string_values: ["MessageAttributeStringValue"],
|
499
511
|
# },
|
500
512
|
# },
|
513
|
+
# sub_channel_id: "SubChannelId",
|
501
514
|
# },
|
502
515
|
# })
|
503
516
|
#
|
@@ -557,6 +570,20 @@ module Aws::ChimeSDKMessaging
|
|
557
570
|
# @option params [required, String] :chime_bearer
|
558
571
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
559
572
|
#
|
573
|
+
# @option params [String] :channel_id
|
574
|
+
# The ID of the channel in the request.
|
575
|
+
#
|
576
|
+
# @option params [Array<String>] :member_arns
|
577
|
+
# The ARNs of the channel members in the request.
|
578
|
+
#
|
579
|
+
# @option params [Array<String>] :moderator_arns
|
580
|
+
# The ARNs of the channel moderators in the request.
|
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
|
+
#
|
560
587
|
# @return [Types::CreateChannelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
561
588
|
#
|
562
589
|
# * {Types::CreateChannelResponse#channel_arn #channel_arn} => String
|
@@ -577,6 +604,14 @@ module Aws::ChimeSDKMessaging
|
|
577
604
|
# },
|
578
605
|
# ],
|
579
606
|
# chime_bearer: "ChimeArn", # required
|
607
|
+
# channel_id: "ChannelId",
|
608
|
+
# member_arns: ["ChimeArn"],
|
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
|
+
# },
|
580
615
|
# })
|
581
616
|
#
|
582
617
|
# @example Response structure
|
@@ -768,10 +803,19 @@ module Aws::ChimeSDKMessaging
|
|
768
803
|
# @option params [required, String] :chime_bearer
|
769
804
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
770
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
|
+
#
|
771
814
|
# @return [Types::CreateChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
772
815
|
#
|
773
816
|
# * {Types::CreateChannelMembershipResponse#channel_arn #channel_arn} => String
|
774
817
|
# * {Types::CreateChannelMembershipResponse#member #member} => Types::Identity
|
818
|
+
# * {Types::CreateChannelMembershipResponse#sub_channel_id #sub_channel_id} => String
|
775
819
|
#
|
776
820
|
# @example Request syntax with placeholder values
|
777
821
|
#
|
@@ -780,6 +824,7 @@ module Aws::ChimeSDKMessaging
|
|
780
824
|
# member_arn: "ChimeArn", # required
|
781
825
|
# type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
|
782
826
|
# chime_bearer: "ChimeArn", # required
|
827
|
+
# sub_channel_id: "SubChannelId",
|
783
828
|
# })
|
784
829
|
#
|
785
830
|
# @example Response structure
|
@@ -787,6 +832,7 @@ module Aws::ChimeSDKMessaging
|
|
787
832
|
# resp.channel_arn #=> String
|
788
833
|
# resp.member.arn #=> String
|
789
834
|
# resp.member.name #=> String
|
835
|
+
# resp.sub_channel_id #=> String
|
790
836
|
#
|
791
837
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembership AWS API Documentation
|
792
838
|
#
|
@@ -867,6 +913,9 @@ module Aws::ChimeSDKMessaging
|
|
867
913
|
# @option params [required, String] :chime_bearer
|
868
914
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
869
915
|
#
|
916
|
+
# @option params [String] :sub_channel_id
|
917
|
+
# The ID of the SubChannel in the request.
|
918
|
+
#
|
870
919
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
871
920
|
#
|
872
921
|
# @example Request syntax with placeholder values
|
@@ -874,6 +923,7 @@ module Aws::ChimeSDKMessaging
|
|
874
923
|
# resp = client.delete_channel({
|
875
924
|
# channel_arn: "ChimeArn", # required
|
876
925
|
# chime_bearer: "ChimeArn", # required
|
926
|
+
# sub_channel_id: "SubChannelId",
|
877
927
|
# })
|
878
928
|
#
|
879
929
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannel AWS API Documentation
|
@@ -970,6 +1020,13 @@ module Aws::ChimeSDKMessaging
|
|
970
1020
|
# @option params [required, String] :chime_bearer
|
971
1021
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
972
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
|
+
#
|
973
1030
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
974
1031
|
#
|
975
1032
|
# @example Request syntax with placeholder values
|
@@ -978,6 +1035,7 @@ module Aws::ChimeSDKMessaging
|
|
978
1035
|
# channel_arn: "ChimeArn", # required
|
979
1036
|
# member_arn: "ChimeArn", # required
|
980
1037
|
# chime_bearer: "ChimeArn", # required
|
1038
|
+
# sub_channel_id: "SubChannelId",
|
981
1039
|
# })
|
982
1040
|
#
|
983
1041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembership AWS API Documentation
|
@@ -1008,6 +1066,14 @@ module Aws::ChimeSDKMessaging
|
|
1008
1066
|
# @option params [required, String] :chime_bearer
|
1009
1067
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1010
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
|
+
#
|
1011
1077
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1012
1078
|
#
|
1013
1079
|
# @example Request syntax with placeholder values
|
@@ -1016,6 +1082,7 @@ module Aws::ChimeSDKMessaging
|
|
1016
1082
|
# channel_arn: "ChimeArn", # required
|
1017
1083
|
# message_id: "MessageId", # required
|
1018
1084
|
# chime_bearer: "ChimeArn", # required
|
1085
|
+
# sub_channel_id: "SubChannelId",
|
1019
1086
|
# })
|
1020
1087
|
#
|
1021
1088
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessage AWS API Documentation
|
@@ -1102,6 +1169,9 @@ module Aws::ChimeSDKMessaging
|
|
1102
1169
|
# resp.channel.last_message_timestamp #=> Time
|
1103
1170
|
# resp.channel.last_updated_timestamp #=> Time
|
1104
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
|
1105
1175
|
#
|
1106
1176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannel AWS API Documentation
|
1107
1177
|
#
|
@@ -1214,6 +1284,14 @@ module Aws::ChimeSDKMessaging
|
|
1214
1284
|
# @option params [required, String] :chime_bearer
|
1215
1285
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1216
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
|
+
#
|
1217
1295
|
# @return [Types::DescribeChannelMembershipResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1218
1296
|
#
|
1219
1297
|
# * {Types::DescribeChannelMembershipResponse#channel_membership #channel_membership} => Types::ChannelMembership
|
@@ -1224,6 +1302,7 @@ module Aws::ChimeSDKMessaging
|
|
1224
1302
|
# channel_arn: "ChimeArn", # required
|
1225
1303
|
# member_arn: "ChimeArn", # required
|
1226
1304
|
# chime_bearer: "ChimeArn", # required
|
1305
|
+
# sub_channel_id: "SubChannelId",
|
1227
1306
|
# })
|
1228
1307
|
#
|
1229
1308
|
# @example Response structure
|
@@ -1236,6 +1315,7 @@ module Aws::ChimeSDKMessaging
|
|
1236
1315
|
# resp.channel_membership.channel_arn #=> String
|
1237
1316
|
# resp.channel_membership.created_timestamp #=> Time
|
1238
1317
|
# resp.channel_membership.last_updated_timestamp #=> Time
|
1318
|
+
# resp.channel_membership.sub_channel_id #=> String
|
1239
1319
|
#
|
1240
1320
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembership AWS API Documentation
|
1241
1321
|
#
|
@@ -1286,6 +1366,7 @@ module Aws::ChimeSDKMessaging
|
|
1286
1366
|
# resp.channel_membership.channel_summary.last_message_timestamp #=> Time
|
1287
1367
|
# resp.channel_membership.app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
1288
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
|
1289
1370
|
#
|
1290
1371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUser AWS API Documentation
|
1291
1372
|
#
|
@@ -1495,6 +1576,14 @@ module Aws::ChimeSDKMessaging
|
|
1495
1576
|
# @option params [required, String] :chime_bearer
|
1496
1577
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1497
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
|
+
#
|
1498
1587
|
# @return [Types::GetChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1499
1588
|
#
|
1500
1589
|
# * {Types::GetChannelMessageResponse#channel_message #channel_message} => Types::ChannelMessage
|
@@ -1505,6 +1594,7 @@ module Aws::ChimeSDKMessaging
|
|
1505
1594
|
# channel_arn: "ChimeArn", # required
|
1506
1595
|
# message_id: "MessageId", # required
|
1507
1596
|
# chime_bearer: "ChimeArn", # required
|
1597
|
+
# sub_channel_id: "SubChannelId",
|
1508
1598
|
# })
|
1509
1599
|
#
|
1510
1600
|
# @example Response structure
|
@@ -1526,6 +1616,7 @@ module Aws::ChimeSDKMessaging
|
|
1526
1616
|
# resp.channel_message.message_attributes #=> Hash
|
1527
1617
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
1528
1618
|
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
1619
|
+
# resp.channel_message.sub_channel_id #=> String
|
1529
1620
|
#
|
1530
1621
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
1531
1622
|
#
|
@@ -1580,6 +1671,14 @@ module Aws::ChimeSDKMessaging
|
|
1580
1671
|
# @option params [required, String] :chime_bearer
|
1581
1672
|
# The `AppInstanceUserArn` of the user making the API call.
|
1582
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
|
+
#
|
1583
1682
|
# @return [Types::GetChannelMessageStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1584
1683
|
#
|
1585
1684
|
# * {Types::GetChannelMessageStatusResponse#status #status} => Types::ChannelMessageStatusStructure
|
@@ -1590,6 +1689,7 @@ module Aws::ChimeSDKMessaging
|
|
1590
1689
|
# channel_arn: "ChimeArn", # required
|
1591
1690
|
# message_id: "MessageId", # required
|
1592
1691
|
# chime_bearer: "ChimeArn", # required
|
1692
|
+
# sub_channel_id: "SubChannelId",
|
1593
1693
|
# })
|
1594
1694
|
#
|
1595
1695
|
# @example Response structure
|
@@ -1764,6 +1864,14 @@ module Aws::ChimeSDKMessaging
|
|
1764
1864
|
# @option params [required, String] :chime_bearer
|
1765
1865
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1766
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
|
+
#
|
1767
1875
|
# @return [Types::ListChannelMembershipsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1768
1876
|
#
|
1769
1877
|
# * {Types::ListChannelMembershipsResponse#channel_arn #channel_arn} => String
|
@@ -1780,6 +1888,7 @@ module Aws::ChimeSDKMessaging
|
|
1780
1888
|
# max_results: 1,
|
1781
1889
|
# next_token: "NextToken",
|
1782
1890
|
# chime_bearer: "ChimeArn", # required
|
1891
|
+
# sub_channel_id: "SubChannelId",
|
1783
1892
|
# })
|
1784
1893
|
#
|
1785
1894
|
# @example Response structure
|
@@ -1849,6 +1958,7 @@ module Aws::ChimeSDKMessaging
|
|
1849
1958
|
# resp.channel_memberships[0].channel_summary.last_message_timestamp #=> Time
|
1850
1959
|
# resp.channel_memberships[0].app_instance_user_membership_summary.type #=> String, one of "DEFAULT", "HIDDEN"
|
1851
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
|
1852
1962
|
# resp.next_token #=> String
|
1853
1963
|
#
|
1854
1964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsForAppInstanceUser AWS API Documentation
|
@@ -1897,11 +2007,20 @@ module Aws::ChimeSDKMessaging
|
|
1897
2007
|
# @option params [required, String] :chime_bearer
|
1898
2008
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1899
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
|
+
#
|
1900
2018
|
# @return [Types::ListChannelMessagesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1901
2019
|
#
|
1902
2020
|
# * {Types::ListChannelMessagesResponse#channel_arn #channel_arn} => String
|
1903
2021
|
# * {Types::ListChannelMessagesResponse#next_token #next_token} => String
|
1904
2022
|
# * {Types::ListChannelMessagesResponse#channel_messages #channel_messages} => Array<Types::ChannelMessageSummary>
|
2023
|
+
# * {Types::ListChannelMessagesResponse#sub_channel_id #sub_channel_id} => String
|
1905
2024
|
#
|
1906
2025
|
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1907
2026
|
#
|
@@ -1915,6 +2034,7 @@ module Aws::ChimeSDKMessaging
|
|
1915
2034
|
# max_results: 1,
|
1916
2035
|
# next_token: "NextToken",
|
1917
2036
|
# chime_bearer: "ChimeArn", # required
|
2037
|
+
# sub_channel_id: "SubChannelId",
|
1918
2038
|
# })
|
1919
2039
|
#
|
1920
2040
|
# @example Response structure
|
@@ -1937,6 +2057,7 @@ module Aws::ChimeSDKMessaging
|
|
1937
2057
|
# resp.channel_messages[0].message_attributes #=> Hash
|
1938
2058
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
1939
2059
|
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
2060
|
+
# resp.sub_channel_id #=> String
|
1940
2061
|
#
|
1941
2062
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
1942
2063
|
#
|
@@ -2179,6 +2300,57 @@ module Aws::ChimeSDKMessaging
|
|
2179
2300
|
req.send_request(options)
|
2180
2301
|
end
|
2181
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
|
+
|
2182
2354
|
# Lists the tags applied to an Amazon Chime SDK messaging resource.
|
2183
2355
|
#
|
2184
2356
|
# @option params [required, String] :resource_arn
|
@@ -2285,10 +2457,14 @@ module Aws::ChimeSDKMessaging
|
|
2285
2457
|
# @option params [required, String] :chime_bearer
|
2286
2458
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2287
2459
|
#
|
2460
|
+
# @option params [String] :sub_channel_id
|
2461
|
+
# The ID of the SubChannel in the request.
|
2462
|
+
#
|
2288
2463
|
# @return [Types::RedactChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2289
2464
|
#
|
2290
2465
|
# * {Types::RedactChannelMessageResponse#channel_arn #channel_arn} => String
|
2291
2466
|
# * {Types::RedactChannelMessageResponse#message_id #message_id} => String
|
2467
|
+
# * {Types::RedactChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2292
2468
|
#
|
2293
2469
|
# @example Request syntax with placeholder values
|
2294
2470
|
#
|
@@ -2296,12 +2472,14 @@ module Aws::ChimeSDKMessaging
|
|
2296
2472
|
# channel_arn: "ChimeArn", # required
|
2297
2473
|
# message_id: "MessageId", # required
|
2298
2474
|
# chime_bearer: "ChimeArn", # required
|
2475
|
+
# sub_channel_id: "SubChannelId",
|
2299
2476
|
# })
|
2300
2477
|
#
|
2301
2478
|
# @example Response structure
|
2302
2479
|
#
|
2303
2480
|
# resp.channel_arn #=> String
|
2304
2481
|
# resp.message_id #=> String
|
2482
|
+
# resp.sub_channel_id #=> String
|
2305
2483
|
#
|
2306
2484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessage AWS API Documentation
|
2307
2485
|
#
|
@@ -2312,6 +2490,66 @@ module Aws::ChimeSDKMessaging
|
|
2312
2490
|
req.send_request(options)
|
2313
2491
|
end
|
2314
2492
|
|
2493
|
+
# Allows an `AppInstanceUser` to search the channels that they belong
|
2494
|
+
# to. The `AppInstanceUser` can search by membership or external ID. An
|
2495
|
+
# `AppInstanceAdmin` can search across all channels within the
|
2496
|
+
# `AppInstance`.
|
2497
|
+
#
|
2498
|
+
# @option params [String] :chime_bearer
|
2499
|
+
# The `AppInstanceUserArn` of the user making the API call.
|
2500
|
+
#
|
2501
|
+
# @option params [required, Array<Types::SearchField>] :fields
|
2502
|
+
# A list of the `Field` objects in the channel being searched.
|
2503
|
+
#
|
2504
|
+
# @option params [Integer] :max_results
|
2505
|
+
# The maximum number of channels that you want returned.
|
2506
|
+
#
|
2507
|
+
# @option params [String] :next_token
|
2508
|
+
# The token returned from previous API requests until the number of
|
2509
|
+
# channels is reached.
|
2510
|
+
#
|
2511
|
+
# @return [Types::SearchChannelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2512
|
+
#
|
2513
|
+
# * {Types::SearchChannelsResponse#channels #channels} => Array<Types::ChannelSummary>
|
2514
|
+
# * {Types::SearchChannelsResponse#next_token #next_token} => String
|
2515
|
+
#
|
2516
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2517
|
+
#
|
2518
|
+
# @example Request syntax with placeholder values
|
2519
|
+
#
|
2520
|
+
# resp = client.search_channels({
|
2521
|
+
# chime_bearer: "ChimeArn",
|
2522
|
+
# fields: [ # required
|
2523
|
+
# {
|
2524
|
+
# key: "MEMBERS", # required, accepts MEMBERS
|
2525
|
+
# values: ["SearchFieldValue"], # required
|
2526
|
+
# operator: "EQUALS", # required, accepts EQUALS, INCLUDES
|
2527
|
+
# },
|
2528
|
+
# ],
|
2529
|
+
# max_results: 1,
|
2530
|
+
# next_token: "NextToken",
|
2531
|
+
# })
|
2532
|
+
#
|
2533
|
+
# @example Response structure
|
2534
|
+
#
|
2535
|
+
# resp.channels #=> Array
|
2536
|
+
# resp.channels[0].name #=> String
|
2537
|
+
# resp.channels[0].channel_arn #=> String
|
2538
|
+
# resp.channels[0].mode #=> String, one of "UNRESTRICTED", "RESTRICTED"
|
2539
|
+
# resp.channels[0].privacy #=> String, one of "PUBLIC", "PRIVATE"
|
2540
|
+
# resp.channels[0].metadata #=> String
|
2541
|
+
# resp.channels[0].last_message_timestamp #=> Time
|
2542
|
+
# resp.next_token #=> String
|
2543
|
+
#
|
2544
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchChannels AWS API Documentation
|
2545
|
+
#
|
2546
|
+
# @overload search_channels(params = {})
|
2547
|
+
# @param [Hash] params ({})
|
2548
|
+
def search_channels(params = {}, options = {})
|
2549
|
+
req = build_request(:search_channels, params)
|
2550
|
+
req.send_request(options)
|
2551
|
+
end
|
2552
|
+
|
2315
2553
|
# Sends a message to a particular channel that the member is a part of.
|
2316
2554
|
#
|
2317
2555
|
# <note markdown="1"> The `x-amz-chime-bearer` request header is mandatory. Use the
|
@@ -2356,11 +2594,15 @@ module Aws::ChimeSDKMessaging
|
|
2356
2594
|
# The attributes for the message, used for message filtering along with
|
2357
2595
|
# a `FilterRule` defined in the `PushNotificationPreferences`.
|
2358
2596
|
#
|
2597
|
+
# @option params [String] :sub_channel_id
|
2598
|
+
# The ID of the SubChannel in the request.
|
2599
|
+
#
|
2359
2600
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2360
2601
|
#
|
2361
2602
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
2362
2603
|
# * {Types::SendChannelMessageResponse#message_id #message_id} => String
|
2363
2604
|
# * {Types::SendChannelMessageResponse#status #status} => Types::ChannelMessageStatusStructure
|
2605
|
+
# * {Types::SendChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2364
2606
|
#
|
2365
2607
|
# @example Request syntax with placeholder values
|
2366
2608
|
#
|
@@ -2382,6 +2624,7 @@ module Aws::ChimeSDKMessaging
|
|
2382
2624
|
# string_values: ["MessageAttributeStringValue"],
|
2383
2625
|
# },
|
2384
2626
|
# },
|
2627
|
+
# sub_channel_id: "SubChannelId",
|
2385
2628
|
# })
|
2386
2629
|
#
|
2387
2630
|
# @example Response structure
|
@@ -2390,6 +2633,7 @@ module Aws::ChimeSDKMessaging
|
|
2390
2633
|
# resp.message_id #=> String
|
2391
2634
|
# resp.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
2392
2635
|
# resp.status.detail #=> String
|
2636
|
+
# resp.sub_channel_id #=> String
|
2393
2637
|
#
|
2394
2638
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessage AWS API Documentation
|
2395
2639
|
#
|
@@ -2472,10 +2716,10 @@ module Aws::ChimeSDKMessaging
|
|
2472
2716
|
# @option params [required, String] :channel_arn
|
2473
2717
|
# The ARN of the channel.
|
2474
2718
|
#
|
2475
|
-
# @option params [
|
2719
|
+
# @option params [String] :name
|
2476
2720
|
# The name of the channel.
|
2477
2721
|
#
|
2478
|
-
# @option params [
|
2722
|
+
# @option params [String] :mode
|
2479
2723
|
# The mode of the update request.
|
2480
2724
|
#
|
2481
2725
|
# @option params [String] :metadata
|
@@ -2492,8 +2736,8 @@ module Aws::ChimeSDKMessaging
|
|
2492
2736
|
#
|
2493
2737
|
# resp = client.update_channel({
|
2494
2738
|
# channel_arn: "ChimeArn", # required
|
2495
|
-
# name: "NonEmptyResourceName",
|
2496
|
-
# mode: "UNRESTRICTED", #
|
2739
|
+
# name: "NonEmptyResourceName",
|
2740
|
+
# mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
|
2497
2741
|
# metadata: "Metadata",
|
2498
2742
|
# chime_bearer: "ChimeArn", # required
|
2499
2743
|
# })
|
@@ -2582,11 +2826,20 @@ module Aws::ChimeSDKMessaging
|
|
2582
2826
|
# @option params [required, String] :chime_bearer
|
2583
2827
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2584
2828
|
#
|
2829
|
+
# @option params [String] :sub_channel_id
|
2830
|
+
# The ID of the SubChannel in the request.
|
2831
|
+
#
|
2832
|
+
# <note markdown="1"> Only required when updating messages in a SubChannel that the user
|
2833
|
+
# belongs to.
|
2834
|
+
#
|
2835
|
+
# </note>
|
2836
|
+
#
|
2585
2837
|
# @return [Types::UpdateChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2586
2838
|
#
|
2587
2839
|
# * {Types::UpdateChannelMessageResponse#channel_arn #channel_arn} => String
|
2588
2840
|
# * {Types::UpdateChannelMessageResponse#message_id #message_id} => String
|
2589
2841
|
# * {Types::UpdateChannelMessageResponse#status #status} => Types::ChannelMessageStatusStructure
|
2842
|
+
# * {Types::UpdateChannelMessageResponse#sub_channel_id #sub_channel_id} => String
|
2590
2843
|
#
|
2591
2844
|
# @example Request syntax with placeholder values
|
2592
2845
|
#
|
@@ -2596,6 +2849,7 @@ module Aws::ChimeSDKMessaging
|
|
2596
2849
|
# content: "Content",
|
2597
2850
|
# metadata: "Metadata",
|
2598
2851
|
# chime_bearer: "ChimeArn", # required
|
2852
|
+
# sub_channel_id: "SubChannelId",
|
2599
2853
|
# })
|
2600
2854
|
#
|
2601
2855
|
# @example Response structure
|
@@ -2604,6 +2858,7 @@ module Aws::ChimeSDKMessaging
|
|
2604
2858
|
# resp.message_id #=> String
|
2605
2859
|
# resp.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
2606
2860
|
# resp.status.detail #=> String
|
2861
|
+
# resp.sub_channel_id #=> String
|
2607
2862
|
#
|
2608
2863
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessage AWS API Documentation
|
2609
2864
|
#
|
@@ -2628,20 +2883,26 @@ module Aws::ChimeSDKMessaging
|
|
2628
2883
|
# @option params [required, String] :chime_bearer
|
2629
2884
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
2630
2885
|
#
|
2886
|
+
# @option params [String] :sub_channel_id
|
2887
|
+
# The ID of the SubChannel in the request.
|
2888
|
+
#
|
2631
2889
|
# @return [Types::UpdateChannelReadMarkerResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2632
2890
|
#
|
2633
2891
|
# * {Types::UpdateChannelReadMarkerResponse#channel_arn #channel_arn} => String
|
2892
|
+
# * {Types::UpdateChannelReadMarkerResponse#sub_channel_id #sub_channel_id} => String
|
2634
2893
|
#
|
2635
2894
|
# @example Request syntax with placeholder values
|
2636
2895
|
#
|
2637
2896
|
# resp = client.update_channel_read_marker({
|
2638
2897
|
# channel_arn: "ChimeArn", # required
|
2639
2898
|
# chime_bearer: "ChimeArn", # required
|
2899
|
+
# sub_channel_id: "SubChannelId",
|
2640
2900
|
# })
|
2641
2901
|
#
|
2642
2902
|
# @example Response structure
|
2643
2903
|
#
|
2644
2904
|
# resp.channel_arn #=> String
|
2905
|
+
# resp.sub_channel_id #=> String
|
2645
2906
|
#
|
2646
2907
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarker AWS API Documentation
|
2647
2908
|
#
|
@@ -2665,7 +2926,7 @@ module Aws::ChimeSDKMessaging
|
|
2665
2926
|
params: params,
|
2666
2927
|
config: config)
|
2667
2928
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
2668
|
-
context[:gem_version] = '1.
|
2929
|
+
context[:gem_version] = '1.12.0'
|
2669
2930
|
Seahorse::Client::Request.new(handlers, context)
|
2670
2931
|
end
|
2671
2932
|
|