aws-sdk-chimesdkmessaging 1.9.0 → 1.12.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.
@@ -17,14 +17,20 @@ module Aws::ChimeSDKMessaging
17
17
  # @return [String]
18
18
  #
19
19
  # @!attribute [rw] read_marker_timestamp
20
- # The time at which a message was last read.
20
+ # The time at which an `AppInstanceUser` last marked a channel as
21
+ # read.
21
22
  # @return [Time]
22
23
  #
24
+ # @!attribute [rw] sub_channel_id
25
+ # The ID of the SubChannel that the `AppInstanceUser` is a member of.
26
+ # @return [String]
27
+ #
23
28
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AppInstanceUserMembershipSummary AWS API Documentation
24
29
  #
25
30
  class AppInstanceUserMembershipSummary < Struct.new(
26
31
  :type,
27
- :read_marker_timestamp)
32
+ :read_marker_timestamp,
33
+ :sub_channel_id)
28
34
  SENSITIVE = []
29
35
  include Aws::Structure
30
36
  end
@@ -96,13 +102,18 @@ module Aws::ChimeSDKMessaging
96
102
  # The ARN of the channel to which you're adding users.
97
103
  # @return [String]
98
104
  #
105
+ # @!attribute [rw] sub_channel_id
106
+ # The ID of the SubChannel.
107
+ # @return [String]
108
+ #
99
109
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchChannelMemberships AWS API Documentation
100
110
  #
101
111
  class BatchChannelMemberships < Struct.new(
102
112
  :invited_by,
103
113
  :type,
104
114
  :members,
105
- :channel_arn)
115
+ :channel_arn,
116
+ :sub_channel_id)
106
117
  SENSITIVE = []
107
118
  include Aws::Structure
108
119
  end
@@ -140,6 +151,7 @@ module Aws::ChimeSDKMessaging
140
151
  # type: "DEFAULT", # accepts DEFAULT, HIDDEN
141
152
  # member_arns: ["ChimeArn"], # required
142
153
  # chime_bearer: "ChimeArn", # required
154
+ # sub_channel_id: "SubChannelId",
143
155
  # }
144
156
  #
145
157
  # @!attribute [rw] channel_arn
@@ -163,13 +175,23 @@ module Aws::ChimeSDKMessaging
163
175
  # The `AppInstanceUserArn` of the user that makes the API call.
164
176
  # @return [String]
165
177
  #
178
+ # @!attribute [rw] sub_channel_id
179
+ # The ID of the SubChannel in the request.
180
+ #
181
+ # <note markdown="1"> Only required when creating membership in a SubChannel for a
182
+ # moderator in an elastic channel.
183
+ #
184
+ # </note>
185
+ # @return [String]
186
+ #
166
187
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembershipRequest AWS API Documentation
167
188
  #
168
189
  class BatchCreateChannelMembershipRequest < Struct.new(
169
190
  :channel_arn,
170
191
  :type,
171
192
  :member_arns,
172
- :chime_bearer)
193
+ :chime_bearer,
194
+ :sub_channel_id)
173
195
  SENSITIVE = []
174
196
  include Aws::Structure
175
197
  end
@@ -235,6 +257,11 @@ module Aws::ChimeSDKMessaging
235
257
  # The ARN of the channel flow.
236
258
  # @return [String]
237
259
  #
260
+ # @!attribute [rw] elastic_channel_configuration
261
+ # The attributes required to configure and create an elastic channel.
262
+ # An elastic channel can support a maximum of 1-million members.
263
+ # @return [Types::ElasticChannelConfiguration]
264
+ #
238
265
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Channel AWS API Documentation
239
266
  #
240
267
  class Channel < Struct.new(
@@ -247,7 +274,8 @@ module Aws::ChimeSDKMessaging
247
274
  :created_timestamp,
248
275
  :last_message_timestamp,
249
276
  :last_updated_timestamp,
250
- :channel_flow_arn)
277
+ :channel_flow_arn,
278
+ :elastic_channel_configuration)
251
279
  SENSITIVE = [:name, :metadata]
252
280
  include Aws::Structure
253
281
  end
@@ -384,6 +412,7 @@ module Aws::ChimeSDKMessaging
384
412
  # string_values: ["MessageAttributeStringValue"],
385
413
  # },
386
414
  # },
415
+ # sub_channel_id: "SubChannelId",
387
416
  # },
388
417
  # }
389
418
  #
@@ -486,6 +515,10 @@ module Aws::ChimeSDKMessaging
486
515
  # The time at which a channel membership was last updated.
487
516
  # @return [Time]
488
517
  #
518
+ # @!attribute [rw] sub_channel_id
519
+ # The ID of the SubChannel that a user belongs to.
520
+ # @return [String]
521
+ #
489
522
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembership AWS API Documentation
490
523
  #
491
524
  class ChannelMembership < Struct.new(
@@ -494,7 +527,8 @@ module Aws::ChimeSDKMessaging
494
527
  :member,
495
528
  :channel_arn,
496
529
  :created_timestamp,
497
- :last_updated_timestamp)
530
+ :last_updated_timestamp,
531
+ :sub_channel_id)
498
532
  SENSITIVE = []
499
533
  include Aws::Structure
500
534
  end
@@ -611,6 +645,10 @@ module Aws::ChimeSDKMessaging
611
645
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
612
646
  # @return [Hash<String,Types::MessageAttributeValue>]
613
647
  #
648
+ # @!attribute [rw] sub_channel_id
649
+ # The ID of the SubChannel.
650
+ # @return [String]
651
+ #
614
652
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
615
653
  #
616
654
  class ChannelMessage < Struct.new(
@@ -626,7 +664,8 @@ module Aws::ChimeSDKMessaging
626
664
  :redacted,
627
665
  :persistence,
628
666
  :status,
629
- :message_attributes)
667
+ :message_attributes,
668
+ :sub_channel_id)
630
669
  SENSITIVE = [:content, :metadata]
631
670
  include Aws::Structure
632
671
  end
@@ -650,6 +689,7 @@ module Aws::ChimeSDKMessaging
650
689
  # string_values: ["MessageAttributeStringValue"],
651
690
  # },
652
691
  # },
692
+ # sub_channel_id: "SubChannelId",
653
693
  # }
654
694
  #
655
695
  # @!attribute [rw] message_id
@@ -673,6 +713,10 @@ module Aws::ChimeSDKMessaging
673
713
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
674
714
  # @return [Hash<String,Types::MessageAttributeValue>]
675
715
  #
716
+ # @!attribute [rw] sub_channel_id
717
+ # The ID of the SubChannel.
718
+ # @return [String]
719
+ #
676
720
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageCallback AWS API Documentation
677
721
  #
678
722
  class ChannelMessageCallback < Struct.new(
@@ -680,7 +724,8 @@ module Aws::ChimeSDKMessaging
680
724
  :content,
681
725
  :metadata,
682
726
  :push_notification,
683
- :message_attributes)
727
+ :message_attributes,
728
+ :sub_channel_id)
684
729
  SENSITIVE = [:content, :metadata]
685
730
  include Aws::Structure
686
731
  end
@@ -1013,6 +1058,7 @@ module Aws::ChimeSDKMessaging
1013
1058
  # member_arn: "ChimeArn", # required
1014
1059
  # type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
1015
1060
  # chime_bearer: "ChimeArn", # required
1061
+ # sub_channel_id: "SubChannelId",
1016
1062
  # }
1017
1063
  #
1018
1064
  # @!attribute [rw] channel_arn
@@ -1036,13 +1082,23 @@ module Aws::ChimeSDKMessaging
1036
1082
  # The `AppInstanceUserArn` of the user that makes the API call.
1037
1083
  # @return [String]
1038
1084
  #
1085
+ # @!attribute [rw] sub_channel_id
1086
+ # The ID of the SubChannel in the request.
1087
+ #
1088
+ # <note markdown="1"> Only required when creating membership in a SubChannel for a
1089
+ # moderator in an elastic channel.
1090
+ #
1091
+ # </note>
1092
+ # @return [String]
1093
+ #
1039
1094
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipRequest AWS API Documentation
1040
1095
  #
1041
1096
  class CreateChannelMembershipRequest < Struct.new(
1042
1097
  :channel_arn,
1043
1098
  :member_arn,
1044
1099
  :type,
1045
- :chime_bearer)
1100
+ :chime_bearer,
1101
+ :sub_channel_id)
1046
1102
  SENSITIVE = []
1047
1103
  include Aws::Structure
1048
1104
  end
@@ -1055,11 +1111,16 @@ module Aws::ChimeSDKMessaging
1055
1111
  # The ARN and metadata of the member being added.
1056
1112
  # @return [Types::Identity]
1057
1113
  #
1114
+ # @!attribute [rw] sub_channel_id
1115
+ # The ID of the SubChannel in the response.
1116
+ # @return [String]
1117
+ #
1058
1118
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipResponse AWS API Documentation
1059
1119
  #
1060
1120
  class CreateChannelMembershipResponse < Struct.new(
1061
1121
  :channel_arn,
1062
- :member)
1122
+ :member,
1123
+ :sub_channel_id)
1063
1124
  SENSITIVE = []
1064
1125
  include Aws::Structure
1065
1126
  end
@@ -1129,6 +1190,14 @@ module Aws::ChimeSDKMessaging
1129
1190
  # },
1130
1191
  # ],
1131
1192
  # chime_bearer: "ChimeArn", # required
1193
+ # channel_id: "ChannelId",
1194
+ # member_arns: ["ChimeArn"],
1195
+ # moderator_arns: ["ChimeArn"],
1196
+ # elastic_channel_configuration: {
1197
+ # maximum_sub_channels: 1, # required
1198
+ # target_memberships_per_sub_channel: 1, # required
1199
+ # minimum_membership_percentage: 1, # required
1200
+ # },
1132
1201
  # }
1133
1202
  #
1134
1203
  # @!attribute [rw] app_instance_arn
@@ -1171,6 +1240,24 @@ module Aws::ChimeSDKMessaging
1171
1240
  # The `AppInstanceUserArn` of the user that makes the API call.
1172
1241
  # @return [String]
1173
1242
  #
1243
+ # @!attribute [rw] channel_id
1244
+ # The ID of the channel in the request.
1245
+ # @return [String]
1246
+ #
1247
+ # @!attribute [rw] member_arns
1248
+ # The ARNs of the channel members in the request.
1249
+ # @return [Array<String>]
1250
+ #
1251
+ # @!attribute [rw] moderator_arns
1252
+ # The ARNs of the channel moderators in the request.
1253
+ # @return [Array<String>]
1254
+ #
1255
+ # @!attribute [rw] elastic_channel_configuration
1256
+ # The attributes required to configure and create an elastic channel.
1257
+ # An elastic channel can support a maximum of 1-million users,
1258
+ # excluding moderators.
1259
+ # @return [Types::ElasticChannelConfiguration]
1260
+ #
1174
1261
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelRequest AWS API Documentation
1175
1262
  #
1176
1263
  class CreateChannelRequest < Struct.new(
@@ -1181,8 +1268,12 @@ module Aws::ChimeSDKMessaging
1181
1268
  :metadata,
1182
1269
  :client_request_token,
1183
1270
  :tags,
1184
- :chime_bearer)
1185
- SENSITIVE = [:name, :metadata, :client_request_token]
1271
+ :chime_bearer,
1272
+ :channel_id,
1273
+ :member_arns,
1274
+ :moderator_arns,
1275
+ :elastic_channel_configuration)
1276
+ SENSITIVE = [:name, :metadata, :client_request_token, :channel_id]
1186
1277
  include Aws::Structure
1187
1278
  end
1188
1279
 
@@ -1255,6 +1346,7 @@ module Aws::ChimeSDKMessaging
1255
1346
  # channel_arn: "ChimeArn", # required
1256
1347
  # member_arn: "ChimeArn", # required
1257
1348
  # chime_bearer: "ChimeArn", # required
1349
+ # sub_channel_id: "SubChannelId",
1258
1350
  # }
1259
1351
  #
1260
1352
  # @!attribute [rw] channel_arn
@@ -1270,12 +1362,21 @@ module Aws::ChimeSDKMessaging
1270
1362
  # The `AppInstanceUserArn` of the user that makes the API call.
1271
1363
  # @return [String]
1272
1364
  #
1365
+ # @!attribute [rw] sub_channel_id
1366
+ # The ID of the SubChannel in the request.
1367
+ #
1368
+ # <note markdown="1"> Only for use by moderators.
1369
+ #
1370
+ # </note>
1371
+ # @return [String]
1372
+ #
1273
1373
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembershipRequest AWS API Documentation
1274
1374
  #
1275
1375
  class DeleteChannelMembershipRequest < Struct.new(
1276
1376
  :channel_arn,
1277
1377
  :member_arn,
1278
- :chime_bearer)
1378
+ :chime_bearer,
1379
+ :sub_channel_id)
1279
1380
  SENSITIVE = []
1280
1381
  include Aws::Structure
1281
1382
  end
@@ -1287,6 +1388,7 @@ module Aws::ChimeSDKMessaging
1287
1388
  # channel_arn: "ChimeArn", # required
1288
1389
  # message_id: "MessageId", # required
1289
1390
  # chime_bearer: "ChimeArn", # required
1391
+ # sub_channel_id: "SubChannelId",
1290
1392
  # }
1291
1393
  #
1292
1394
  # @!attribute [rw] channel_arn
@@ -1301,12 +1403,22 @@ module Aws::ChimeSDKMessaging
1301
1403
  # The `AppInstanceUserArn` of the user that makes the API call.
1302
1404
  # @return [String]
1303
1405
  #
1406
+ # @!attribute [rw] sub_channel_id
1407
+ # The ID of the SubChannel in the request.
1408
+ #
1409
+ # <note markdown="1"> Only required when deleting messages in a SubChannel that the user
1410
+ # belongs to.
1411
+ #
1412
+ # </note>
1413
+ # @return [String]
1414
+ #
1304
1415
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessageRequest AWS API Documentation
1305
1416
  #
1306
1417
  class DeleteChannelMessageRequest < Struct.new(
1307
1418
  :channel_arn,
1308
1419
  :message_id,
1309
- :chime_bearer)
1420
+ :chime_bearer,
1421
+ :sub_channel_id)
1310
1422
  SENSITIVE = []
1311
1423
  include Aws::Structure
1312
1424
  end
@@ -1348,6 +1460,7 @@ module Aws::ChimeSDKMessaging
1348
1460
  # {
1349
1461
  # channel_arn: "ChimeArn", # required
1350
1462
  # chime_bearer: "ChimeArn", # required
1463
+ # sub_channel_id: "SubChannelId",
1351
1464
  # }
1352
1465
  #
1353
1466
  # @!attribute [rw] channel_arn
@@ -1358,11 +1471,16 @@ module Aws::ChimeSDKMessaging
1358
1471
  # The `AppInstanceUserArn` of the user that makes the API call.
1359
1472
  # @return [String]
1360
1473
  #
1474
+ # @!attribute [rw] sub_channel_id
1475
+ # The ID of the SubChannel in the request.
1476
+ # @return [String]
1477
+ #
1361
1478
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelRequest AWS API Documentation
1362
1479
  #
1363
1480
  class DeleteChannelRequest < Struct.new(
1364
1481
  :channel_arn,
1365
- :chime_bearer)
1482
+ :chime_bearer,
1483
+ :sub_channel_id)
1366
1484
  SENSITIVE = []
1367
1485
  include Aws::Structure
1368
1486
  end
@@ -1491,6 +1609,7 @@ module Aws::ChimeSDKMessaging
1491
1609
  # channel_arn: "ChimeArn", # required
1492
1610
  # member_arn: "ChimeArn", # required
1493
1611
  # chime_bearer: "ChimeArn", # required
1612
+ # sub_channel_id: "SubChannelId",
1494
1613
  # }
1495
1614
  #
1496
1615
  # @!attribute [rw] channel_arn
@@ -1505,12 +1624,22 @@ module Aws::ChimeSDKMessaging
1505
1624
  # The `AppInstanceUserArn` of the user that makes the API call.
1506
1625
  # @return [String]
1507
1626
  #
1627
+ # @!attribute [rw] sub_channel_id
1628
+ # The ID of the SubChannel in the request. The response contains an
1629
+ # `ElasticChannelConfiguration` object.
1630
+ #
1631
+ # <note markdown="1"> Only required to get a user’s SubChannel membership details.
1632
+ #
1633
+ # </note>
1634
+ # @return [String]
1635
+ #
1508
1636
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipRequest AWS API Documentation
1509
1637
  #
1510
1638
  class DescribeChannelMembershipRequest < Struct.new(
1511
1639
  :channel_arn,
1512
1640
  :member_arn,
1513
- :chime_bearer)
1641
+ :chime_bearer,
1642
+ :sub_channel_id)
1514
1643
  SENSITIVE = []
1515
1644
  include Aws::Structure
1516
1645
  end
@@ -1681,6 +1810,43 @@ module Aws::ChimeSDKMessaging
1681
1810
  include Aws::Structure
1682
1811
  end
1683
1812
 
1813
+ # The attributes required to configure and create an elastic channel. An
1814
+ # elastic channel can support a maximum of 1-million members.
1815
+ #
1816
+ # @note When making an API call, you may pass ElasticChannelConfiguration
1817
+ # data as a hash:
1818
+ #
1819
+ # {
1820
+ # maximum_sub_channels: 1, # required
1821
+ # target_memberships_per_sub_channel: 1, # required
1822
+ # minimum_membership_percentage: 1, # required
1823
+ # }
1824
+ #
1825
+ # @!attribute [rw] maximum_sub_channels
1826
+ # The maximum number of SubChannels that you want to allow in the
1827
+ # elastic channel.
1828
+ # @return [Integer]
1829
+ #
1830
+ # @!attribute [rw] target_memberships_per_sub_channel
1831
+ # The maximum number of members allowed in a SubChannel.
1832
+ # @return [Integer]
1833
+ #
1834
+ # @!attribute [rw] minimum_membership_percentage
1835
+ # The minimum allowed percentage of TargetMembershipsPerSubChannel
1836
+ # users. Ceil of the calculated value is used in balancing members
1837
+ # among SubChannels of the elastic channel.
1838
+ # @return [Integer]
1839
+ #
1840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ElasticChannelConfiguration AWS API Documentation
1841
+ #
1842
+ class ElasticChannelConfiguration < Struct.new(
1843
+ :maximum_sub_channels,
1844
+ :target_memberships_per_sub_channel,
1845
+ :minimum_membership_percentage)
1846
+ SENSITIVE = []
1847
+ include Aws::Structure
1848
+ end
1849
+
1684
1850
  # The client is permanently forbidden from making the request.
1685
1851
  #
1686
1852
  # @!attribute [rw] code
@@ -1758,6 +1924,7 @@ module Aws::ChimeSDKMessaging
1758
1924
  # channel_arn: "ChimeArn", # required
1759
1925
  # message_id: "MessageId", # required
1760
1926
  # chime_bearer: "ChimeArn", # required
1927
+ # sub_channel_id: "SubChannelId",
1761
1928
  # }
1762
1929
  #
1763
1930
  # @!attribute [rw] channel_arn
@@ -1772,12 +1939,22 @@ module Aws::ChimeSDKMessaging
1772
1939
  # The `AppInstanceUserArn` of the user that makes the API call.
1773
1940
  # @return [String]
1774
1941
  #
1942
+ # @!attribute [rw] sub_channel_id
1943
+ # The ID of the SubChannel in the request.
1944
+ #
1945
+ # <note markdown="1"> Only required when getting messages in a SubChannel that the user
1946
+ # belongs to.
1947
+ #
1948
+ # </note>
1949
+ # @return [String]
1950
+ #
1775
1951
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageRequest AWS API Documentation
1776
1952
  #
1777
1953
  class GetChannelMessageRequest < Struct.new(
1778
1954
  :channel_arn,
1779
1955
  :message_id,
1780
- :chime_bearer)
1956
+ :chime_bearer,
1957
+ :sub_channel_id)
1781
1958
  SENSITIVE = []
1782
1959
  include Aws::Structure
1783
1960
  end
@@ -1801,6 +1978,7 @@ module Aws::ChimeSDKMessaging
1801
1978
  # channel_arn: "ChimeArn", # required
1802
1979
  # message_id: "MessageId", # required
1803
1980
  # chime_bearer: "ChimeArn", # required
1981
+ # sub_channel_id: "SubChannelId",
1804
1982
  # }
1805
1983
  #
1806
1984
  # @!attribute [rw] channel_arn
@@ -1815,12 +1993,22 @@ module Aws::ChimeSDKMessaging
1815
1993
  # The `AppInstanceUserArn` of the user making the API call.
1816
1994
  # @return [String]
1817
1995
  #
1996
+ # @!attribute [rw] sub_channel_id
1997
+ # The ID of the SubChannel in the request.
1998
+ #
1999
+ # <note markdown="1"> Only required when getting message status in a SubChannel that the
2000
+ # user belongs to.
2001
+ #
2002
+ # </note>
2003
+ # @return [String]
2004
+ #
1818
2005
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusRequest AWS API Documentation
1819
2006
  #
1820
2007
  class GetChannelMessageStatusRequest < Struct.new(
1821
2008
  :channel_arn,
1822
2009
  :message_id,
1823
- :chime_bearer)
2010
+ :chime_bearer,
2011
+ :sub_channel_id)
1824
2012
  SENSITIVE = []
1825
2013
  include Aws::Structure
1826
2014
  end
@@ -2051,8 +2239,7 @@ module Aws::ChimeSDKMessaging
2051
2239
  end
2052
2240
 
2053
2241
  # @!attribute [rw] channel_memberships
2054
- # The token passed by previous API calls until all requested users are
2055
- # returned.
2242
+ # The information for the requested channel memberships.
2056
2243
  # @return [Array<Types::ChannelMembershipForAppInstanceUserSummary>]
2057
2244
  #
2058
2245
  # @!attribute [rw] next_token
@@ -2078,6 +2265,7 @@ module Aws::ChimeSDKMessaging
2078
2265
  # max_results: 1,
2079
2266
  # next_token: "NextToken",
2080
2267
  # chime_bearer: "ChimeArn", # required
2268
+ # sub_channel_id: "SubChannelId",
2081
2269
  # }
2082
2270
  #
2083
2271
  # @!attribute [rw] channel_arn
@@ -2104,6 +2292,15 @@ module Aws::ChimeSDKMessaging
2104
2292
  # The `AppInstanceUserArn` of the user that makes the API call.
2105
2293
  # @return [String]
2106
2294
  #
2295
+ # @!attribute [rw] sub_channel_id
2296
+ # The ID of the SubChannel in the request.
2297
+ #
2298
+ # <note markdown="1"> Only required when listing a user's memberships in a particular
2299
+ # sub-channel of an elastic channel.
2300
+ #
2301
+ # </note>
2302
+ # @return [String]
2303
+ #
2107
2304
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsRequest AWS API Documentation
2108
2305
  #
2109
2306
  class ListChannelMembershipsRequest < Struct.new(
@@ -2111,7 +2308,8 @@ module Aws::ChimeSDKMessaging
2111
2308
  :type,
2112
2309
  :max_results,
2113
2310
  :next_token,
2114
- :chime_bearer)
2311
+ :chime_bearer,
2312
+ :sub_channel_id)
2115
2313
  SENSITIVE = [:next_token]
2116
2314
  include Aws::Structure
2117
2315
  end
@@ -2150,6 +2348,7 @@ module Aws::ChimeSDKMessaging
2150
2348
  # max_results: 1,
2151
2349
  # next_token: "NextToken",
2152
2350
  # chime_bearer: "ChimeArn", # required
2351
+ # sub_channel_id: "SubChannelId",
2153
2352
  # }
2154
2353
  #
2155
2354
  # @!attribute [rw] channel_arn
@@ -2182,6 +2381,15 @@ module Aws::ChimeSDKMessaging
2182
2381
  # The `AppInstanceUserArn` of the user that makes the API call.
2183
2382
  # @return [String]
2184
2383
  #
2384
+ # @!attribute [rw] sub_channel_id
2385
+ # The ID of the SubChannel in the request.
2386
+ #
2387
+ # <note markdown="1"> Only required when listing the messages in a SubChannel that the
2388
+ # user belongs to.
2389
+ #
2390
+ # </note>
2391
+ # @return [String]
2392
+ #
2185
2393
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesRequest AWS API Documentation
2186
2394
  #
2187
2395
  class ListChannelMessagesRequest < Struct.new(
@@ -2191,7 +2399,8 @@ module Aws::ChimeSDKMessaging
2191
2399
  :not_after,
2192
2400
  :max_results,
2193
2401
  :next_token,
2194
- :chime_bearer)
2402
+ :chime_bearer,
2403
+ :sub_channel_id)
2195
2404
  SENSITIVE = [:next_token]
2196
2405
  include Aws::Structure
2197
2406
  end
@@ -2209,12 +2418,17 @@ module Aws::ChimeSDKMessaging
2209
2418
  # The information about, and content of, each requested message.
2210
2419
  # @return [Array<Types::ChannelMessageSummary>]
2211
2420
  #
2421
+ # @!attribute [rw] sub_channel_id
2422
+ # The ID of the SubChannel in the response.
2423
+ # @return [String]
2424
+ #
2212
2425
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesResponse AWS API Documentation
2213
2426
  #
2214
2427
  class ListChannelMessagesResponse < Struct.new(
2215
2428
  :channel_arn,
2216
2429
  :next_token,
2217
- :channel_messages)
2430
+ :channel_messages,
2431
+ :sub_channel_id)
2218
2432
  SENSITIVE = [:next_token]
2219
2433
  include Aws::Structure
2220
2434
  end
@@ -2450,6 +2664,67 @@ module Aws::ChimeSDKMessaging
2450
2664
  include Aws::Structure
2451
2665
  end
2452
2666
 
2667
+ # @note When making an API call, you may pass ListSubChannelsRequest
2668
+ # data as a hash:
2669
+ #
2670
+ # {
2671
+ # channel_arn: "ChimeArn", # required
2672
+ # chime_bearer: "ChimeArn", # required
2673
+ # max_results: 1,
2674
+ # next_token: "NextToken",
2675
+ # }
2676
+ #
2677
+ # @!attribute [rw] channel_arn
2678
+ # The ARN of elastic channel.
2679
+ # @return [String]
2680
+ #
2681
+ # @!attribute [rw] chime_bearer
2682
+ # The `AppInstanceUserArn` of the user making the API call.
2683
+ # @return [String]
2684
+ #
2685
+ # @!attribute [rw] max_results
2686
+ # The maximum number of sub-channels that you want to return.
2687
+ # @return [Integer]
2688
+ #
2689
+ # @!attribute [rw] next_token
2690
+ # The token passed by previous API calls until all requested
2691
+ # sub-channels are returned.
2692
+ # @return [String]
2693
+ #
2694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListSubChannelsRequest AWS API Documentation
2695
+ #
2696
+ class ListSubChannelsRequest < Struct.new(
2697
+ :channel_arn,
2698
+ :chime_bearer,
2699
+ :max_results,
2700
+ :next_token)
2701
+ SENSITIVE = [:next_token]
2702
+ include Aws::Structure
2703
+ end
2704
+
2705
+ # @!attribute [rw] channel_arn
2706
+ # The ARN of elastic channel.
2707
+ # @return [String]
2708
+ #
2709
+ # @!attribute [rw] sub_channels
2710
+ # The information about each sub-channel.
2711
+ # @return [Array<Types::SubChannelSummary>]
2712
+ #
2713
+ # @!attribute [rw] next_token
2714
+ # The token passed by previous API calls until all requested
2715
+ # sub-channels are returned.
2716
+ # @return [String]
2717
+ #
2718
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListSubChannelsResponse AWS API Documentation
2719
+ #
2720
+ class ListSubChannelsResponse < Struct.new(
2721
+ :channel_arn,
2722
+ :sub_channels,
2723
+ :next_token)
2724
+ SENSITIVE = [:next_token]
2725
+ include Aws::Structure
2726
+ end
2727
+
2453
2728
  # @note When making an API call, you may pass ListTagsForResourceRequest
2454
2729
  # data as a hash:
2455
2730
  #
@@ -2666,7 +2941,7 @@ module Aws::ChimeSDKMessaging
2666
2941
  #
2667
2942
  # @!attribute [rw] filter_rule
2668
2943
  # The simple JSON object used to send a subset of a push notification
2669
- # to the requsted member.
2944
+ # to the requested member.
2670
2945
  # @return [String]
2671
2946
  #
2672
2947
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PushNotificationPreferences AWS API Documentation
@@ -2749,6 +3024,7 @@ module Aws::ChimeSDKMessaging
2749
3024
  # channel_arn: "ChimeArn", # required
2750
3025
  # message_id: "MessageId", # required
2751
3026
  # chime_bearer: "ChimeArn", # required
3027
+ # sub_channel_id: "SubChannelId",
2752
3028
  # }
2753
3029
  #
2754
3030
  # @!attribute [rw] channel_arn
@@ -2764,12 +3040,17 @@ module Aws::ChimeSDKMessaging
2764
3040
  # The `AppInstanceUserArn` of the user that makes the API call.
2765
3041
  # @return [String]
2766
3042
  #
3043
+ # @!attribute [rw] sub_channel_id
3044
+ # The ID of the SubChannel in the request.
3045
+ # @return [String]
3046
+ #
2767
3047
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageRequest AWS API Documentation
2768
3048
  #
2769
3049
  class RedactChannelMessageRequest < Struct.new(
2770
3050
  :channel_arn,
2771
3051
  :message_id,
2772
- :chime_bearer)
3052
+ :chime_bearer,
3053
+ :sub_channel_id)
2773
3054
  SENSITIVE = []
2774
3055
  include Aws::Structure
2775
3056
  end
@@ -2783,11 +3064,21 @@ module Aws::ChimeSDKMessaging
2783
3064
  # The ID of the message being redacted.
2784
3065
  # @return [String]
2785
3066
  #
3067
+ # @!attribute [rw] sub_channel_id
3068
+ # The ID of the SubChannel in the response.
3069
+ #
3070
+ # <note markdown="1"> Only required when redacting messages in a SubChannel that the user
3071
+ # belongs to.
3072
+ #
3073
+ # </note>
3074
+ # @return [String]
3075
+ #
2786
3076
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageResponse AWS API Documentation
2787
3077
  #
2788
3078
  class RedactChannelMessageResponse < Struct.new(
2789
3079
  :channel_arn,
2790
- :message_id)
3080
+ :message_id,
3081
+ :sub_channel_id)
2791
3082
  SENSITIVE = []
2792
3083
  include Aws::Structure
2793
3084
  end
@@ -2809,6 +3100,115 @@ module Aws::ChimeSDKMessaging
2809
3100
  include Aws::Structure
2810
3101
  end
2811
3102
 
3103
+ # @note When making an API call, you may pass SearchChannelsRequest
3104
+ # data as a hash:
3105
+ #
3106
+ # {
3107
+ # chime_bearer: "ChimeArn",
3108
+ # fields: [ # required
3109
+ # {
3110
+ # key: "MEMBERS", # required, accepts MEMBERS
3111
+ # values: ["SearchFieldValue"], # required
3112
+ # operator: "EQUALS", # required, accepts EQUALS, INCLUDES
3113
+ # },
3114
+ # ],
3115
+ # max_results: 1,
3116
+ # next_token: "NextToken",
3117
+ # }
3118
+ #
3119
+ # @!attribute [rw] chime_bearer
3120
+ # The `AppInstanceUserArn` of the user making the API call.
3121
+ # @return [String]
3122
+ #
3123
+ # @!attribute [rw] fields
3124
+ # A list of the `Field` objects in the channel being searched.
3125
+ # @return [Array<Types::SearchField>]
3126
+ #
3127
+ # @!attribute [rw] max_results
3128
+ # The maximum number of channels that you want returned.
3129
+ # @return [Integer]
3130
+ #
3131
+ # @!attribute [rw] next_token
3132
+ # The token returned from previous API requests until the number of
3133
+ # channels is reached.
3134
+ # @return [String]
3135
+ #
3136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchChannelsRequest AWS API Documentation
3137
+ #
3138
+ class SearchChannelsRequest < Struct.new(
3139
+ :chime_bearer,
3140
+ :fields,
3141
+ :max_results,
3142
+ :next_token)
3143
+ SENSITIVE = [:next_token]
3144
+ include Aws::Structure
3145
+ end
3146
+
3147
+ # @!attribute [rw] channels
3148
+ # A list of the channels in the request.
3149
+ # @return [Array<Types::ChannelSummary>]
3150
+ #
3151
+ # @!attribute [rw] next_token
3152
+ # The token returned from previous API responses until the number of
3153
+ # channels is reached.
3154
+ # @return [String]
3155
+ #
3156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchChannelsResponse AWS API Documentation
3157
+ #
3158
+ class SearchChannelsResponse < Struct.new(
3159
+ :channels,
3160
+ :next_token)
3161
+ SENSITIVE = [:next_token]
3162
+ include Aws::Structure
3163
+ end
3164
+
3165
+ # A `Field` of the channel that you want to search.
3166
+ #
3167
+ # @note When making an API call, you may pass SearchField
3168
+ # data as a hash:
3169
+ #
3170
+ # {
3171
+ # key: "MEMBERS", # required, accepts MEMBERS
3172
+ # values: ["SearchFieldValue"], # required
3173
+ # operator: "EQUALS", # required, accepts EQUALS, INCLUDES
3174
+ # }
3175
+ #
3176
+ # @!attribute [rw] key
3177
+ # An `enum` value that indicates the key to search the channel on.
3178
+ # `MEMBERS` allows you to search channels based on memberships. You
3179
+ # can use it with the `EQUALS` operator to get channels whose
3180
+ # memberships are equal to the specified values, and with the
3181
+ # `INCLUDES` operator to get channels whose memberships include the
3182
+ # specified values.
3183
+ # @return [String]
3184
+ #
3185
+ # @!attribute [rw] values
3186
+ # The values that you want to search for, a list of strings. The
3187
+ # values must be `AppInstanceUserArns` specified as a list of strings.
3188
+ #
3189
+ # <note markdown="1"> This operation isn't supported for `AppInstanceUsers` with large
3190
+ # number of memberships.
3191
+ #
3192
+ # </note>
3193
+ # @return [Array<String>]
3194
+ #
3195
+ # @!attribute [rw] operator
3196
+ # The operator used to compare field values, currently `EQUALS` or
3197
+ # `INCLUDES`. Use the `EQUALS` operator to find channels whose
3198
+ # memberships equal the specified values. Use the `INCLUDES` operator
3199
+ # to find channels whose memberships include the specified values.
3200
+ # @return [String]
3201
+ #
3202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SearchField AWS API Documentation
3203
+ #
3204
+ class SearchField < Struct.new(
3205
+ :key,
3206
+ :values,
3207
+ :operator)
3208
+ SENSITIVE = []
3209
+ include Aws::Structure
3210
+ end
3211
+
2812
3212
  # @note When making an API call, you may pass SendChannelMessageRequest
2813
3213
  # data as a hash:
2814
3214
  #
@@ -2830,6 +3230,7 @@ module Aws::ChimeSDKMessaging
2830
3230
  # string_values: ["MessageAttributeStringValue"],
2831
3231
  # },
2832
3232
  # },
3233
+ # sub_channel_id: "SubChannelId",
2833
3234
  # }
2834
3235
  #
2835
3236
  # @!attribute [rw] channel_arn
@@ -2873,6 +3274,10 @@ module Aws::ChimeSDKMessaging
2873
3274
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
2874
3275
  # @return [Hash<String,Types::MessageAttributeValue>]
2875
3276
  #
3277
+ # @!attribute [rw] sub_channel_id
3278
+ # The ID of the SubChannel in the request.
3279
+ # @return [String]
3280
+ #
2876
3281
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
2877
3282
  #
2878
3283
  class SendChannelMessageRequest < Struct.new(
@@ -2884,7 +3289,8 @@ module Aws::ChimeSDKMessaging
2884
3289
  :client_request_token,
2885
3290
  :chime_bearer,
2886
3291
  :push_notification,
2887
- :message_attributes)
3292
+ :message_attributes,
3293
+ :sub_channel_id)
2888
3294
  SENSITIVE = [:content, :metadata, :client_request_token]
2889
3295
  include Aws::Structure
2890
3296
  end
@@ -2901,12 +3307,17 @@ module Aws::ChimeSDKMessaging
2901
3307
  # The status of the channel message.
2902
3308
  # @return [Types::ChannelMessageStatusStructure]
2903
3309
  #
3310
+ # @!attribute [rw] sub_channel_id
3311
+ # The ID of the SubChannel in the response.
3312
+ # @return [String]
3313
+ #
2904
3314
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageResponse AWS API Documentation
2905
3315
  #
2906
3316
  class SendChannelMessageResponse < Struct.new(
2907
3317
  :channel_arn,
2908
3318
  :message_id,
2909
- :status)
3319
+ :status,
3320
+ :sub_channel_id)
2910
3321
  SENSITIVE = []
2911
3322
  include Aws::Structure
2912
3323
  end
@@ -2945,6 +3356,25 @@ module Aws::ChimeSDKMessaging
2945
3356
  include Aws::Structure
2946
3357
  end
2947
3358
 
3359
+ # Summary of the sub-channels associated with the elastic channel.
3360
+ #
3361
+ # @!attribute [rw] sub_channel_id
3362
+ # The unique ID of a SubChannel.
3363
+ # @return [String]
3364
+ #
3365
+ # @!attribute [rw] membership_count
3366
+ # The number of members in a SubChannel.
3367
+ # @return [Integer]
3368
+ #
3369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SubChannelSummary AWS API Documentation
3370
+ #
3371
+ class SubChannelSummary < Struct.new(
3372
+ :sub_channel_id,
3373
+ :membership_count)
3374
+ SENSITIVE = []
3375
+ include Aws::Structure
3376
+ end
3377
+
2948
3378
  # A tag object containing a key-value pair.
2949
3379
  #
2950
3380
  # @note When making an API call, you may pass Tag
@@ -3125,6 +3555,7 @@ module Aws::ChimeSDKMessaging
3125
3555
  # content: "Content",
3126
3556
  # metadata: "Metadata",
3127
3557
  # chime_bearer: "ChimeArn", # required
3558
+ # sub_channel_id: "SubChannelId",
3128
3559
  # }
3129
3560
  #
3130
3561
  # @!attribute [rw] channel_arn
@@ -3147,6 +3578,15 @@ module Aws::ChimeSDKMessaging
3147
3578
  # The `AppInstanceUserArn` of the user that makes the API call.
3148
3579
  # @return [String]
3149
3580
  #
3581
+ # @!attribute [rw] sub_channel_id
3582
+ # The ID of the SubChannel in the request.
3583
+ #
3584
+ # <note markdown="1"> Only required when updating messages in a SubChannel that the user
3585
+ # belongs to.
3586
+ #
3587
+ # </note>
3588
+ # @return [String]
3589
+ #
3150
3590
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageRequest AWS API Documentation
3151
3591
  #
3152
3592
  class UpdateChannelMessageRequest < Struct.new(
@@ -3154,7 +3594,8 @@ module Aws::ChimeSDKMessaging
3154
3594
  :message_id,
3155
3595
  :content,
3156
3596
  :metadata,
3157
- :chime_bearer)
3597
+ :chime_bearer,
3598
+ :sub_channel_id)
3158
3599
  SENSITIVE = [:content, :metadata]
3159
3600
  include Aws::Structure
3160
3601
  end
@@ -3171,12 +3612,17 @@ module Aws::ChimeSDKMessaging
3171
3612
  # The status of the message update.
3172
3613
  # @return [Types::ChannelMessageStatusStructure]
3173
3614
  #
3615
+ # @!attribute [rw] sub_channel_id
3616
+ # The ID of the SubChannel in the response.
3617
+ # @return [String]
3618
+ #
3174
3619
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageResponse AWS API Documentation
3175
3620
  #
3176
3621
  class UpdateChannelMessageResponse < Struct.new(
3177
3622
  :channel_arn,
3178
3623
  :message_id,
3179
- :status)
3624
+ :status,
3625
+ :sub_channel_id)
3180
3626
  SENSITIVE = []
3181
3627
  include Aws::Structure
3182
3628
  end
@@ -3187,6 +3633,7 @@ module Aws::ChimeSDKMessaging
3187
3633
  # {
3188
3634
  # channel_arn: "ChimeArn", # required
3189
3635
  # chime_bearer: "ChimeArn", # required
3636
+ # sub_channel_id: "SubChannelId",
3190
3637
  # }
3191
3638
  #
3192
3639
  # @!attribute [rw] channel_arn
@@ -3197,11 +3644,16 @@ module Aws::ChimeSDKMessaging
3197
3644
  # The `AppInstanceUserArn` of the user that makes the API call.
3198
3645
  # @return [String]
3199
3646
  #
3647
+ # @!attribute [rw] sub_channel_id
3648
+ # The ID of the SubChannel in the request.
3649
+ # @return [String]
3650
+ #
3200
3651
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerRequest AWS API Documentation
3201
3652
  #
3202
3653
  class UpdateChannelReadMarkerRequest < Struct.new(
3203
3654
  :channel_arn,
3204
- :chime_bearer)
3655
+ :chime_bearer,
3656
+ :sub_channel_id)
3205
3657
  SENSITIVE = []
3206
3658
  include Aws::Structure
3207
3659
  end
@@ -3210,10 +3662,15 @@ module Aws::ChimeSDKMessaging
3210
3662
  # The ARN of the channel.
3211
3663
  # @return [String]
3212
3664
  #
3665
+ # @!attribute [rw] sub_channel_id
3666
+ # The ID of the SubChannel in the response.
3667
+ # @return [String]
3668
+ #
3213
3669
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerResponse AWS API Documentation
3214
3670
  #
3215
3671
  class UpdateChannelReadMarkerResponse < Struct.new(
3216
- :channel_arn)
3672
+ :channel_arn,
3673
+ :sub_channel_id)
3217
3674
  SENSITIVE = []
3218
3675
  include Aws::Structure
3219
3676
  end
@@ -3223,8 +3680,8 @@ module Aws::ChimeSDKMessaging
3223
3680
  #
3224
3681
  # {
3225
3682
  # channel_arn: "ChimeArn", # required
3226
- # name: "NonEmptyResourceName", # required
3227
- # mode: "UNRESTRICTED", # required, accepts UNRESTRICTED, RESTRICTED
3683
+ # name: "NonEmptyResourceName",
3684
+ # mode: "UNRESTRICTED", # accepts UNRESTRICTED, RESTRICTED
3228
3685
  # metadata: "Metadata",
3229
3686
  # chime_bearer: "ChimeArn", # required
3230
3687
  # }