aws-sdk-chimesdkmessaging 1.11.0 → 1.13.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.
@@ -21,11 +21,16 @@ module Aws::ChimeSDKMessaging
21
21
  # read.
22
22
  # @return [Time]
23
23
  #
24
+ # @!attribute [rw] sub_channel_id
25
+ # The ID of the SubChannel that the `AppInstanceUser` is a member of.
26
+ # @return [String]
27
+ #
24
28
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AppInstanceUserMembershipSummary AWS API Documentation
25
29
  #
26
30
  class AppInstanceUserMembershipSummary < Struct.new(
27
31
  :type,
28
- :read_marker_timestamp)
32
+ :read_marker_timestamp,
33
+ :sub_channel_id)
29
34
  SENSITIVE = []
30
35
  include Aws::Structure
31
36
  end
@@ -97,13 +102,18 @@ module Aws::ChimeSDKMessaging
97
102
  # The ARN of the channel to which you're adding users.
98
103
  # @return [String]
99
104
  #
105
+ # @!attribute [rw] sub_channel_id
106
+ # The ID of the SubChannel.
107
+ # @return [String]
108
+ #
100
109
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchChannelMemberships AWS API Documentation
101
110
  #
102
111
  class BatchChannelMemberships < Struct.new(
103
112
  :invited_by,
104
113
  :type,
105
114
  :members,
106
- :channel_arn)
115
+ :channel_arn,
116
+ :sub_channel_id)
107
117
  SENSITIVE = []
108
118
  include Aws::Structure
109
119
  end
@@ -141,6 +151,7 @@ module Aws::ChimeSDKMessaging
141
151
  # type: "DEFAULT", # accepts DEFAULT, HIDDEN
142
152
  # member_arns: ["ChimeArn"], # required
143
153
  # chime_bearer: "ChimeArn", # required
154
+ # sub_channel_id: "SubChannelId",
144
155
  # }
145
156
  #
146
157
  # @!attribute [rw] channel_arn
@@ -164,13 +175,23 @@ module Aws::ChimeSDKMessaging
164
175
  # The `AppInstanceUserArn` of the user that makes the API call.
165
176
  # @return [String]
166
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
+ #
167
187
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/BatchCreateChannelMembershipRequest AWS API Documentation
168
188
  #
169
189
  class BatchCreateChannelMembershipRequest < Struct.new(
170
190
  :channel_arn,
171
191
  :type,
172
192
  :member_arns,
173
- :chime_bearer)
193
+ :chime_bearer,
194
+ :sub_channel_id)
174
195
  SENSITIVE = []
175
196
  include Aws::Structure
176
197
  end
@@ -236,6 +257,11 @@ module Aws::ChimeSDKMessaging
236
257
  # The ARN of the channel flow.
237
258
  # @return [String]
238
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
+ #
239
265
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Channel AWS API Documentation
240
266
  #
241
267
  class Channel < Struct.new(
@@ -248,7 +274,8 @@ module Aws::ChimeSDKMessaging
248
274
  :created_timestamp,
249
275
  :last_message_timestamp,
250
276
  :last_updated_timestamp,
251
- :channel_flow_arn)
277
+ :channel_flow_arn,
278
+ :elastic_channel_configuration)
252
279
  SENSITIVE = [:name, :metadata]
253
280
  include Aws::Structure
254
281
  end
@@ -385,6 +412,7 @@ module Aws::ChimeSDKMessaging
385
412
  # string_values: ["MessageAttributeStringValue"],
386
413
  # },
387
414
  # },
415
+ # sub_channel_id: "SubChannelId",
388
416
  # },
389
417
  # }
390
418
  #
@@ -487,6 +515,10 @@ module Aws::ChimeSDKMessaging
487
515
  # The time at which a channel membership was last updated.
488
516
  # @return [Time]
489
517
  #
518
+ # @!attribute [rw] sub_channel_id
519
+ # The ID of the SubChannel that a user belongs to.
520
+ # @return [String]
521
+ #
490
522
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembership AWS API Documentation
491
523
  #
492
524
  class ChannelMembership < Struct.new(
@@ -495,7 +527,8 @@ module Aws::ChimeSDKMessaging
495
527
  :member,
496
528
  :channel_arn,
497
529
  :created_timestamp,
498
- :last_updated_timestamp)
530
+ :last_updated_timestamp,
531
+ :sub_channel_id)
499
532
  SENSITIVE = []
500
533
  include Aws::Structure
501
534
  end
@@ -612,6 +645,10 @@ module Aws::ChimeSDKMessaging
612
645
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
613
646
  # @return [Hash<String,Types::MessageAttributeValue>]
614
647
  #
648
+ # @!attribute [rw] sub_channel_id
649
+ # The ID of the SubChannel.
650
+ # @return [String]
651
+ #
615
652
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
616
653
  #
617
654
  class ChannelMessage < Struct.new(
@@ -627,7 +664,8 @@ module Aws::ChimeSDKMessaging
627
664
  :redacted,
628
665
  :persistence,
629
666
  :status,
630
- :message_attributes)
667
+ :message_attributes,
668
+ :sub_channel_id)
631
669
  SENSITIVE = [:content, :metadata]
632
670
  include Aws::Structure
633
671
  end
@@ -651,6 +689,7 @@ module Aws::ChimeSDKMessaging
651
689
  # string_values: ["MessageAttributeStringValue"],
652
690
  # },
653
691
  # },
692
+ # sub_channel_id: "SubChannelId",
654
693
  # }
655
694
  #
656
695
  # @!attribute [rw] message_id
@@ -674,6 +713,10 @@ module Aws::ChimeSDKMessaging
674
713
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
675
714
  # @return [Hash<String,Types::MessageAttributeValue>]
676
715
  #
716
+ # @!attribute [rw] sub_channel_id
717
+ # The ID of the SubChannel.
718
+ # @return [String]
719
+ #
677
720
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageCallback AWS API Documentation
678
721
  #
679
722
  class ChannelMessageCallback < Struct.new(
@@ -681,7 +724,8 @@ module Aws::ChimeSDKMessaging
681
724
  :content,
682
725
  :metadata,
683
726
  :push_notification,
684
- :message_attributes)
727
+ :message_attributes,
728
+ :sub_channel_id)
685
729
  SENSITIVE = [:content, :metadata]
686
730
  include Aws::Structure
687
731
  end
@@ -851,7 +895,7 @@ module Aws::ChimeSDKMessaging
851
895
  # @return [String]
852
896
  #
853
897
  # @!attribute [rw] last_message_timestamp
854
- # The time at which the last message in a channel was sent.
898
+ # The time at which the last persistent message in a channel was sent.
855
899
  # @return [Time]
856
900
  #
857
901
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelSummary AWS API Documentation
@@ -1014,6 +1058,7 @@ module Aws::ChimeSDKMessaging
1014
1058
  # member_arn: "ChimeArn", # required
1015
1059
  # type: "DEFAULT", # required, accepts DEFAULT, HIDDEN
1016
1060
  # chime_bearer: "ChimeArn", # required
1061
+ # sub_channel_id: "SubChannelId",
1017
1062
  # }
1018
1063
  #
1019
1064
  # @!attribute [rw] channel_arn
@@ -1037,13 +1082,23 @@ module Aws::ChimeSDKMessaging
1037
1082
  # The `AppInstanceUserArn` of the user that makes the API call.
1038
1083
  # @return [String]
1039
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
+ #
1040
1094
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipRequest AWS API Documentation
1041
1095
  #
1042
1096
  class CreateChannelMembershipRequest < Struct.new(
1043
1097
  :channel_arn,
1044
1098
  :member_arn,
1045
1099
  :type,
1046
- :chime_bearer)
1100
+ :chime_bearer,
1101
+ :sub_channel_id)
1047
1102
  SENSITIVE = []
1048
1103
  include Aws::Structure
1049
1104
  end
@@ -1056,11 +1111,16 @@ module Aws::ChimeSDKMessaging
1056
1111
  # The ARN and metadata of the member being added.
1057
1112
  # @return [Types::Identity]
1058
1113
  #
1114
+ # @!attribute [rw] sub_channel_id
1115
+ # The ID of the SubChannel in the response.
1116
+ # @return [String]
1117
+ #
1059
1118
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelMembershipResponse AWS API Documentation
1060
1119
  #
1061
1120
  class CreateChannelMembershipResponse < Struct.new(
1062
1121
  :channel_arn,
1063
- :member)
1122
+ :member,
1123
+ :sub_channel_id)
1064
1124
  SENSITIVE = []
1065
1125
  include Aws::Structure
1066
1126
  end
@@ -1133,6 +1193,11 @@ module Aws::ChimeSDKMessaging
1133
1193
  # channel_id: "ChannelId",
1134
1194
  # member_arns: ["ChimeArn"],
1135
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
+ # },
1136
1201
  # }
1137
1202
  #
1138
1203
  # @!attribute [rw] app_instance_arn
@@ -1187,6 +1252,12 @@ module Aws::ChimeSDKMessaging
1187
1252
  # The ARNs of the channel moderators in the request.
1188
1253
  # @return [Array<String>]
1189
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
+ #
1190
1261
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelRequest AWS API Documentation
1191
1262
  #
1192
1263
  class CreateChannelRequest < Struct.new(
@@ -1200,7 +1271,8 @@ module Aws::ChimeSDKMessaging
1200
1271
  :chime_bearer,
1201
1272
  :channel_id,
1202
1273
  :member_arns,
1203
- :moderator_arns)
1274
+ :moderator_arns,
1275
+ :elastic_channel_configuration)
1204
1276
  SENSITIVE = [:name, :metadata, :client_request_token, :channel_id]
1205
1277
  include Aws::Structure
1206
1278
  end
@@ -1274,6 +1346,7 @@ module Aws::ChimeSDKMessaging
1274
1346
  # channel_arn: "ChimeArn", # required
1275
1347
  # member_arn: "ChimeArn", # required
1276
1348
  # chime_bearer: "ChimeArn", # required
1349
+ # sub_channel_id: "SubChannelId",
1277
1350
  # }
1278
1351
  #
1279
1352
  # @!attribute [rw] channel_arn
@@ -1289,12 +1362,21 @@ module Aws::ChimeSDKMessaging
1289
1362
  # The `AppInstanceUserArn` of the user that makes the API call.
1290
1363
  # @return [String]
1291
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
+ #
1292
1373
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMembershipRequest AWS API Documentation
1293
1374
  #
1294
1375
  class DeleteChannelMembershipRequest < Struct.new(
1295
1376
  :channel_arn,
1296
1377
  :member_arn,
1297
- :chime_bearer)
1378
+ :chime_bearer,
1379
+ :sub_channel_id)
1298
1380
  SENSITIVE = []
1299
1381
  include Aws::Structure
1300
1382
  end
@@ -1306,6 +1388,7 @@ module Aws::ChimeSDKMessaging
1306
1388
  # channel_arn: "ChimeArn", # required
1307
1389
  # message_id: "MessageId", # required
1308
1390
  # chime_bearer: "ChimeArn", # required
1391
+ # sub_channel_id: "SubChannelId",
1309
1392
  # }
1310
1393
  #
1311
1394
  # @!attribute [rw] channel_arn
@@ -1320,12 +1403,22 @@ module Aws::ChimeSDKMessaging
1320
1403
  # The `AppInstanceUserArn` of the user that makes the API call.
1321
1404
  # @return [String]
1322
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
+ #
1323
1415
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelMessageRequest AWS API Documentation
1324
1416
  #
1325
1417
  class DeleteChannelMessageRequest < Struct.new(
1326
1418
  :channel_arn,
1327
1419
  :message_id,
1328
- :chime_bearer)
1420
+ :chime_bearer,
1421
+ :sub_channel_id)
1329
1422
  SENSITIVE = []
1330
1423
  include Aws::Structure
1331
1424
  end
@@ -1367,6 +1460,7 @@ module Aws::ChimeSDKMessaging
1367
1460
  # {
1368
1461
  # channel_arn: "ChimeArn", # required
1369
1462
  # chime_bearer: "ChimeArn", # required
1463
+ # sub_channel_id: "SubChannelId",
1370
1464
  # }
1371
1465
  #
1372
1466
  # @!attribute [rw] channel_arn
@@ -1377,11 +1471,16 @@ module Aws::ChimeSDKMessaging
1377
1471
  # The `AppInstanceUserArn` of the user that makes the API call.
1378
1472
  # @return [String]
1379
1473
  #
1474
+ # @!attribute [rw] sub_channel_id
1475
+ # The ID of the SubChannel in the request.
1476
+ # @return [String]
1477
+ #
1380
1478
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelRequest AWS API Documentation
1381
1479
  #
1382
1480
  class DeleteChannelRequest < Struct.new(
1383
1481
  :channel_arn,
1384
- :chime_bearer)
1482
+ :chime_bearer,
1483
+ :sub_channel_id)
1385
1484
  SENSITIVE = []
1386
1485
  include Aws::Structure
1387
1486
  end
@@ -1510,6 +1609,7 @@ module Aws::ChimeSDKMessaging
1510
1609
  # channel_arn: "ChimeArn", # required
1511
1610
  # member_arn: "ChimeArn", # required
1512
1611
  # chime_bearer: "ChimeArn", # required
1612
+ # sub_channel_id: "SubChannelId",
1513
1613
  # }
1514
1614
  #
1515
1615
  # @!attribute [rw] channel_arn
@@ -1524,12 +1624,22 @@ module Aws::ChimeSDKMessaging
1524
1624
  # The `AppInstanceUserArn` of the user that makes the API call.
1525
1625
  # @return [String]
1526
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
+ #
1527
1636
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipRequest AWS API Documentation
1528
1637
  #
1529
1638
  class DescribeChannelMembershipRequest < Struct.new(
1530
1639
  :channel_arn,
1531
1640
  :member_arn,
1532
- :chime_bearer)
1641
+ :chime_bearer,
1642
+ :sub_channel_id)
1533
1643
  SENSITIVE = []
1534
1644
  include Aws::Structure
1535
1645
  end
@@ -1700,6 +1810,43 @@ module Aws::ChimeSDKMessaging
1700
1810
  include Aws::Structure
1701
1811
  end
1702
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
+
1703
1850
  # The client is permanently forbidden from making the request.
1704
1851
  #
1705
1852
  # @!attribute [rw] code
@@ -1777,6 +1924,7 @@ module Aws::ChimeSDKMessaging
1777
1924
  # channel_arn: "ChimeArn", # required
1778
1925
  # message_id: "MessageId", # required
1779
1926
  # chime_bearer: "ChimeArn", # required
1927
+ # sub_channel_id: "SubChannelId",
1780
1928
  # }
1781
1929
  #
1782
1930
  # @!attribute [rw] channel_arn
@@ -1791,12 +1939,22 @@ module Aws::ChimeSDKMessaging
1791
1939
  # The `AppInstanceUserArn` of the user that makes the API call.
1792
1940
  # @return [String]
1793
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
+ #
1794
1951
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageRequest AWS API Documentation
1795
1952
  #
1796
1953
  class GetChannelMessageRequest < Struct.new(
1797
1954
  :channel_arn,
1798
1955
  :message_id,
1799
- :chime_bearer)
1956
+ :chime_bearer,
1957
+ :sub_channel_id)
1800
1958
  SENSITIVE = []
1801
1959
  include Aws::Structure
1802
1960
  end
@@ -1820,6 +1978,7 @@ module Aws::ChimeSDKMessaging
1820
1978
  # channel_arn: "ChimeArn", # required
1821
1979
  # message_id: "MessageId", # required
1822
1980
  # chime_bearer: "ChimeArn", # required
1981
+ # sub_channel_id: "SubChannelId",
1823
1982
  # }
1824
1983
  #
1825
1984
  # @!attribute [rw] channel_arn
@@ -1834,12 +1993,22 @@ module Aws::ChimeSDKMessaging
1834
1993
  # The `AppInstanceUserArn` of the user making the API call.
1835
1994
  # @return [String]
1836
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
+ #
1837
2005
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusRequest AWS API Documentation
1838
2006
  #
1839
2007
  class GetChannelMessageStatusRequest < Struct.new(
1840
2008
  :channel_arn,
1841
2009
  :message_id,
1842
- :chime_bearer)
2010
+ :chime_bearer,
2011
+ :sub_channel_id)
1843
2012
  SENSITIVE = []
1844
2013
  include Aws::Structure
1845
2014
  end
@@ -2096,6 +2265,7 @@ module Aws::ChimeSDKMessaging
2096
2265
  # max_results: 1,
2097
2266
  # next_token: "NextToken",
2098
2267
  # chime_bearer: "ChimeArn", # required
2268
+ # sub_channel_id: "SubChannelId",
2099
2269
  # }
2100
2270
  #
2101
2271
  # @!attribute [rw] channel_arn
@@ -2122,6 +2292,15 @@ module Aws::ChimeSDKMessaging
2122
2292
  # The `AppInstanceUserArn` of the user that makes the API call.
2123
2293
  # @return [String]
2124
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
+ #
2125
2304
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMembershipsRequest AWS API Documentation
2126
2305
  #
2127
2306
  class ListChannelMembershipsRequest < Struct.new(
@@ -2129,7 +2308,8 @@ module Aws::ChimeSDKMessaging
2129
2308
  :type,
2130
2309
  :max_results,
2131
2310
  :next_token,
2132
- :chime_bearer)
2311
+ :chime_bearer,
2312
+ :sub_channel_id)
2133
2313
  SENSITIVE = [:next_token]
2134
2314
  include Aws::Structure
2135
2315
  end
@@ -2168,6 +2348,7 @@ module Aws::ChimeSDKMessaging
2168
2348
  # max_results: 1,
2169
2349
  # next_token: "NextToken",
2170
2350
  # chime_bearer: "ChimeArn", # required
2351
+ # sub_channel_id: "SubChannelId",
2171
2352
  # }
2172
2353
  #
2173
2354
  # @!attribute [rw] channel_arn
@@ -2200,6 +2381,15 @@ module Aws::ChimeSDKMessaging
2200
2381
  # The `AppInstanceUserArn` of the user that makes the API call.
2201
2382
  # @return [String]
2202
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
+ #
2203
2393
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesRequest AWS API Documentation
2204
2394
  #
2205
2395
  class ListChannelMessagesRequest < Struct.new(
@@ -2209,7 +2399,8 @@ module Aws::ChimeSDKMessaging
2209
2399
  :not_after,
2210
2400
  :max_results,
2211
2401
  :next_token,
2212
- :chime_bearer)
2402
+ :chime_bearer,
2403
+ :sub_channel_id)
2213
2404
  SENSITIVE = [:next_token]
2214
2405
  include Aws::Structure
2215
2406
  end
@@ -2227,12 +2418,17 @@ module Aws::ChimeSDKMessaging
2227
2418
  # The information about, and content of, each requested message.
2228
2419
  # @return [Array<Types::ChannelMessageSummary>]
2229
2420
  #
2421
+ # @!attribute [rw] sub_channel_id
2422
+ # The ID of the SubChannel in the response.
2423
+ # @return [String]
2424
+ #
2230
2425
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessagesResponse AWS API Documentation
2231
2426
  #
2232
2427
  class ListChannelMessagesResponse < Struct.new(
2233
2428
  :channel_arn,
2234
2429
  :next_token,
2235
- :channel_messages)
2430
+ :channel_messages,
2431
+ :sub_channel_id)
2236
2432
  SENSITIVE = [:next_token]
2237
2433
  include Aws::Structure
2238
2434
  end
@@ -2468,6 +2664,67 @@ module Aws::ChimeSDKMessaging
2468
2664
  include Aws::Structure
2469
2665
  end
2470
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
+
2471
2728
  # @note When making an API call, you may pass ListTagsForResourceRequest
2472
2729
  # data as a hash:
2473
2730
  #
@@ -2767,6 +3024,7 @@ module Aws::ChimeSDKMessaging
2767
3024
  # channel_arn: "ChimeArn", # required
2768
3025
  # message_id: "MessageId", # required
2769
3026
  # chime_bearer: "ChimeArn", # required
3027
+ # sub_channel_id: "SubChannelId",
2770
3028
  # }
2771
3029
  #
2772
3030
  # @!attribute [rw] channel_arn
@@ -2782,12 +3040,17 @@ module Aws::ChimeSDKMessaging
2782
3040
  # The `AppInstanceUserArn` of the user that makes the API call.
2783
3041
  # @return [String]
2784
3042
  #
3043
+ # @!attribute [rw] sub_channel_id
3044
+ # The ID of the SubChannel in the request.
3045
+ # @return [String]
3046
+ #
2785
3047
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageRequest AWS API Documentation
2786
3048
  #
2787
3049
  class RedactChannelMessageRequest < Struct.new(
2788
3050
  :channel_arn,
2789
3051
  :message_id,
2790
- :chime_bearer)
3052
+ :chime_bearer,
3053
+ :sub_channel_id)
2791
3054
  SENSITIVE = []
2792
3055
  include Aws::Structure
2793
3056
  end
@@ -2801,11 +3064,21 @@ module Aws::ChimeSDKMessaging
2801
3064
  # The ID of the message being redacted.
2802
3065
  # @return [String]
2803
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
+ #
2804
3076
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/RedactChannelMessageResponse AWS API Documentation
2805
3077
  #
2806
3078
  class RedactChannelMessageResponse < Struct.new(
2807
3079
  :channel_arn,
2808
- :message_id)
3080
+ :message_id,
3081
+ :sub_channel_id)
2809
3082
  SENSITIVE = []
2810
3083
  include Aws::Structure
2811
3084
  end
@@ -2957,6 +3230,7 @@ module Aws::ChimeSDKMessaging
2957
3230
  # string_values: ["MessageAttributeStringValue"],
2958
3231
  # },
2959
3232
  # },
3233
+ # sub_channel_id: "SubChannelId",
2960
3234
  # }
2961
3235
  #
2962
3236
  # @!attribute [rw] channel_arn
@@ -3000,6 +3274,10 @@ module Aws::ChimeSDKMessaging
3000
3274
  # with a `FilterRule` defined in the `PushNotificationPreferences`.
3001
3275
  # @return [Hash<String,Types::MessageAttributeValue>]
3002
3276
  #
3277
+ # @!attribute [rw] sub_channel_id
3278
+ # The ID of the SubChannel in the request.
3279
+ # @return [String]
3280
+ #
3003
3281
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
3004
3282
  #
3005
3283
  class SendChannelMessageRequest < Struct.new(
@@ -3011,7 +3289,8 @@ module Aws::ChimeSDKMessaging
3011
3289
  :client_request_token,
3012
3290
  :chime_bearer,
3013
3291
  :push_notification,
3014
- :message_attributes)
3292
+ :message_attributes,
3293
+ :sub_channel_id)
3015
3294
  SENSITIVE = [:content, :metadata, :client_request_token]
3016
3295
  include Aws::Structure
3017
3296
  end
@@ -3028,12 +3307,17 @@ module Aws::ChimeSDKMessaging
3028
3307
  # The status of the channel message.
3029
3308
  # @return [Types::ChannelMessageStatusStructure]
3030
3309
  #
3310
+ # @!attribute [rw] sub_channel_id
3311
+ # The ID of the SubChannel in the response.
3312
+ # @return [String]
3313
+ #
3031
3314
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageResponse AWS API Documentation
3032
3315
  #
3033
3316
  class SendChannelMessageResponse < Struct.new(
3034
3317
  :channel_arn,
3035
3318
  :message_id,
3036
- :status)
3319
+ :status,
3320
+ :sub_channel_id)
3037
3321
  SENSITIVE = []
3038
3322
  include Aws::Structure
3039
3323
  end
@@ -3072,6 +3356,25 @@ module Aws::ChimeSDKMessaging
3072
3356
  include Aws::Structure
3073
3357
  end
3074
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
+
3075
3378
  # A tag object containing a key-value pair.
3076
3379
  #
3077
3380
  # @note When making an API call, you may pass Tag
@@ -3252,6 +3555,7 @@ module Aws::ChimeSDKMessaging
3252
3555
  # content: "Content",
3253
3556
  # metadata: "Metadata",
3254
3557
  # chime_bearer: "ChimeArn", # required
3558
+ # sub_channel_id: "SubChannelId",
3255
3559
  # }
3256
3560
  #
3257
3561
  # @!attribute [rw] channel_arn
@@ -3274,6 +3578,15 @@ module Aws::ChimeSDKMessaging
3274
3578
  # The `AppInstanceUserArn` of the user that makes the API call.
3275
3579
  # @return [String]
3276
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
+ #
3277
3590
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageRequest AWS API Documentation
3278
3591
  #
3279
3592
  class UpdateChannelMessageRequest < Struct.new(
@@ -3281,7 +3594,8 @@ module Aws::ChimeSDKMessaging
3281
3594
  :message_id,
3282
3595
  :content,
3283
3596
  :metadata,
3284
- :chime_bearer)
3597
+ :chime_bearer,
3598
+ :sub_channel_id)
3285
3599
  SENSITIVE = [:content, :metadata]
3286
3600
  include Aws::Structure
3287
3601
  end
@@ -3298,12 +3612,17 @@ module Aws::ChimeSDKMessaging
3298
3612
  # The status of the message update.
3299
3613
  # @return [Types::ChannelMessageStatusStructure]
3300
3614
  #
3615
+ # @!attribute [rw] sub_channel_id
3616
+ # The ID of the SubChannel in the response.
3617
+ # @return [String]
3618
+ #
3301
3619
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageResponse AWS API Documentation
3302
3620
  #
3303
3621
  class UpdateChannelMessageResponse < Struct.new(
3304
3622
  :channel_arn,
3305
3623
  :message_id,
3306
- :status)
3624
+ :status,
3625
+ :sub_channel_id)
3307
3626
  SENSITIVE = []
3308
3627
  include Aws::Structure
3309
3628
  end
@@ -3314,6 +3633,7 @@ module Aws::ChimeSDKMessaging
3314
3633
  # {
3315
3634
  # channel_arn: "ChimeArn", # required
3316
3635
  # chime_bearer: "ChimeArn", # required
3636
+ # sub_channel_id: "SubChannelId",
3317
3637
  # }
3318
3638
  #
3319
3639
  # @!attribute [rw] channel_arn
@@ -3324,11 +3644,16 @@ module Aws::ChimeSDKMessaging
3324
3644
  # The `AppInstanceUserArn` of the user that makes the API call.
3325
3645
  # @return [String]
3326
3646
  #
3647
+ # @!attribute [rw] sub_channel_id
3648
+ # The ID of the SubChannel in the request.
3649
+ # @return [String]
3650
+ #
3327
3651
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerRequest AWS API Documentation
3328
3652
  #
3329
3653
  class UpdateChannelReadMarkerRequest < Struct.new(
3330
3654
  :channel_arn,
3331
- :chime_bearer)
3655
+ :chime_bearer,
3656
+ :sub_channel_id)
3332
3657
  SENSITIVE = []
3333
3658
  include Aws::Structure
3334
3659
  end
@@ -3337,10 +3662,15 @@ module Aws::ChimeSDKMessaging
3337
3662
  # The ARN of the channel.
3338
3663
  # @return [String]
3339
3664
  #
3665
+ # @!attribute [rw] sub_channel_id
3666
+ # The ID of the SubChannel in the response.
3667
+ # @return [String]
3668
+ #
3340
3669
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelReadMarkerResponse AWS API Documentation
3341
3670
  #
3342
3671
  class UpdateChannelReadMarkerResponse < Struct.new(
3343
- :channel_arn)
3672
+ :channel_arn,
3673
+ :sub_channel_id)
3344
3674
  SENSITIVE = []
3345
3675
  include Aws::Structure
3346
3676
  end