aws-sdk-chimesdkmessaging 1.4.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4b10147b6d45b0a8999da8925c7280dc8f432084117ae088320188dae84576c6
4
- data.tar.gz: 0aed0d675cb6c5d0700d527e3840bd0c5595564f7adeec1c67ac6ca12b007172
3
+ metadata.gz: 2b3e41600d1bcd4ab8474aba3969ff9cf2ffacf83f2cb2f0c95a8269465e73e5
4
+ data.tar.gz: b26a0f251d8789936d08518226ca9d58d9f72e998f53aac1f5018d3f50a26100
5
5
  SHA512:
6
- metadata.gz: e4de8952311ebfed00e2dd333d05e83d618c580d09ccdc0f6b06a8ba041e5e28ede47dc1b4a071d72abed17fe51de0c5c99bb30ccb2ffca27ee5380caf116093
7
- data.tar.gz: 3db5439377e0dfa52ed70c5dba7df5bc1ec83aadf9e7c7dcefe3db6138c35fac35b11099de8dc1e797d740b67d521af9226605301027a1f78f22826156291a53
6
+ metadata.gz: 01b279a1c4f8d95eaf44b6ae8efbb08db286705c41a25d1f9155b5dd297b3f8aa3c3cfbb1798f361171823cb0abb4dbb69dce61139770fd481ae2fe016e94490
7
+ data.tar.gz: e8bc2b9b1baf2d0b5fe971d2000e1897f8c5460cbc723392fe6449310da7b5e1af8fe1d84efa4d1b4bb82197b91ec06788c50e85bd6d55a70a725155b7d15bf2
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.8.0 (2021-12-21)
5
+ ------------------
6
+
7
+ * Feature - The Amazon Chime SDK now supports updating message attributes via channel flows
8
+
9
+ 1.7.0 (2021-11-30)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.6.0 (2021-11-04)
15
+ ------------------
16
+
17
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
18
+
19
+ 1.5.0 (2021-10-26)
20
+ ------------------
21
+
22
+ * Feature - The Amazon Chime SDK now supports push notifications through Amazon Pinpoint
23
+
4
24
  1.4.0 (2021-10-19)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.4.0
1
+ 1.8.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/defaults_mode.rb'
30
31
  require 'aws-sdk-core/plugins/signature_v4.rb'
31
32
  require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
33
 
@@ -73,6 +74,7 @@ module Aws::ChimeSDKMessaging
73
74
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
75
  add_plugin(Aws::Plugins::TransferEncoding)
75
76
  add_plugin(Aws::Plugins::HttpChecksum)
77
+ add_plugin(Aws::Plugins::DefaultsMode)
76
78
  add_plugin(Aws::Plugins::SignatureV4)
77
79
  add_plugin(Aws::Plugins::Protocols::RestJson)
78
80
 
@@ -119,7 +121,9 @@ module Aws::ChimeSDKMessaging
119
121
  # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
122
  # are very aggressive. Construct and pass an instance of
121
123
  # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
- # enable retries and extended timeouts.
124
+ # enable retries and extended timeouts. Instance profile credential
125
+ # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
126
+ # to true.
123
127
  #
124
128
  # @option options [required, String] :region
125
129
  # The AWS region to connect to. The configured `:region` is
@@ -173,6 +177,10 @@ module Aws::ChimeSDKMessaging
173
177
  # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
178
  # a clock skew correction and retry requests with skewed client clocks.
175
179
  #
180
+ # @option options [String] :defaults_mode ("legacy")
181
+ # See {Aws::DefaultsModeConfiguration} for a list of the
182
+ # accepted modes and the configuration defaults that are included.
183
+ #
176
184
  # @option options [Boolean] :disable_host_prefix_injection (false)
177
185
  # Set to true to disable SDK automatically adding host prefix
178
186
  # to default service endpoint when available.
@@ -275,6 +283,15 @@ module Aws::ChimeSDKMessaging
275
283
  # ** Please note ** When response stubbing is enabled, no HTTP
276
284
  # requests are made, and retries are disabled.
277
285
  #
286
+ # @option options [Boolean] :use_dualstack_endpoint
287
+ # When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
288
+ # will be used if available.
289
+ #
290
+ # @option options [Boolean] :use_fips_endpoint
291
+ # When set to `true`, fips compatible endpoints will be used if available.
292
+ # When a `fips` region is used, the region is normalized and this config
293
+ # is set to `true`.
294
+ #
278
295
  # @option options [Boolean] :validate_params (true)
279
296
  # When `true`, request parameters are validated before
280
297
  # sending the request.
@@ -286,7 +303,7 @@ module Aws::ChimeSDKMessaging
286
303
  # seconds to wait when opening a HTTP session before raising a
287
304
  # `Timeout::Error`.
288
305
  #
289
- # @option options [Integer] :http_read_timeout (60) The default
306
+ # @option options [Float] :http_read_timeout (60) The default
290
307
  # number of seconds to wait for response data. This value can
291
308
  # safely be set per-request on the session.
292
309
  #
@@ -302,6 +319,9 @@ module Aws::ChimeSDKMessaging
302
319
  # disables this behaviour. This value can safely be set per
303
320
  # request on the session.
304
321
  #
322
+ # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
323
+ # in seconds.
324
+ #
305
325
  # @option options [Boolean] :http_wire_trace (false) When `true`,
306
326
  # HTTP debug output will be sent to the `:logger`.
307
327
  #
@@ -379,7 +399,8 @@ module Aws::ChimeSDKMessaging
379
399
  # not returned. This is only supported by moderators.
380
400
  #
381
401
  # @option params [required, Array<String>] :member_arns
382
- # The ARNs of the members you want to add to the channel.
402
+ # The `AppInstanceUserArn`s of the members you want to add to the
403
+ # channel.
383
404
  #
384
405
  # @option params [required, String] :chime_bearer
385
406
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -465,6 +486,16 @@ module Aws::ChimeSDKMessaging
465
486
  # message_id: "MessageId", # required
466
487
  # content: "NonEmptyContent",
467
488
  # metadata: "Metadata",
489
+ # push_notification: {
490
+ # title: "PushNotificationTitle",
491
+ # body: "PushNotificationBody",
492
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
493
+ # },
494
+ # message_attributes: {
495
+ # "MessageAttributeName" => {
496
+ # string_values: ["MessageAttributeStringValue"],
497
+ # },
498
+ # },
468
499
  # },
469
500
  # })
470
501
  #
@@ -577,7 +608,7 @@ module Aws::ChimeSDKMessaging
577
608
  # The ARN of the ban request.
578
609
  #
579
610
  # @option params [required, String] :member_arn
580
- # The ARN of the member being banned.
611
+ # The `AppInstanceUserArn` of the member being banned.
581
612
  #
582
613
  # @option params [required, String] :chime_bearer
583
614
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -693,8 +724,8 @@ module Aws::ChimeSDKMessaging
693
724
  req.send_request(options)
694
725
  end
695
726
 
696
- # Adds a user to a channel. The `InvitedBy` response field is derived
697
- # from the request header. A channel member can:
727
+ # Adds a user to a channel. The `InvitedBy` field in `ChannelMembership`
728
+ # is derived from the request header. A channel member can:
698
729
  #
699
730
  # * List messages
700
731
  #
@@ -723,7 +754,7 @@ module Aws::ChimeSDKMessaging
723
754
  # The ARN of the channel to which you're adding users.
724
755
  #
725
756
  # @option params [required, String] :member_arn
726
- # The ARN of the member you want to add to the channel.
757
+ # The `AppInstanceUserArn` of the member you want to add to the channel.
727
758
  #
728
759
  # @option params [required, String] :type
729
760
  # The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
@@ -786,7 +817,7 @@ module Aws::ChimeSDKMessaging
786
817
  # The ARN of the channel.
787
818
  #
788
819
  # @option params [required, String] :channel_moderator_arn
789
- # The ARN of the moderator.
820
+ # The `AppInstanceUserArn` of the moderator.
790
821
  #
791
822
  # @option params [required, String] :chime_bearer
792
823
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -931,7 +962,8 @@ module Aws::ChimeSDKMessaging
931
962
  # The ARN of the channel from which you want to remove the user.
932
963
  #
933
964
  # @option params [required, String] :member_arn
934
- # The ARN of the member that you're removing from the channel.
965
+ # The `AppInstanceUserArn` of the member that you're removing from the
966
+ # channel.
935
967
  #
936
968
  # @option params [required, String] :chime_bearer
937
969
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -1005,7 +1037,7 @@ module Aws::ChimeSDKMessaging
1005
1037
  # The ARN of the channel.
1006
1038
  #
1007
1039
  # @option params [required, String] :channel_moderator_arn
1008
- # The ARN of the moderator being deleted.
1040
+ # The `AppInstanceUserArn` of the moderator being deleted.
1009
1041
  #
1010
1042
  # @option params [required, String] :chime_bearer
1011
1043
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -1090,7 +1122,7 @@ module Aws::ChimeSDKMessaging
1090
1122
  # The ARN of the channel from which the user is banned.
1091
1123
  #
1092
1124
  # @option params [required, String] :member_arn
1093
- # The ARN of the member being banned.
1125
+ # The `AppInstanceUserArn` of the member being banned.
1094
1126
  #
1095
1127
  # @option params [required, String] :chime_bearer
1096
1128
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -1175,7 +1207,7 @@ module Aws::ChimeSDKMessaging
1175
1207
  # The ARN of the channel.
1176
1208
  #
1177
1209
  # @option params [required, String] :member_arn
1178
- # The ARN of the member.
1210
+ # The `AppInstanceUserArn` of the member.
1179
1211
  #
1180
1212
  # @option params [required, String] :chime_bearer
1181
1213
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -1322,7 +1354,7 @@ module Aws::ChimeSDKMessaging
1322
1354
  # The ARN of the channel.
1323
1355
  #
1324
1356
  # @option params [required, String] :channel_moderator_arn
1325
- # The ARN of the channel moderator.
1357
+ # The `AppInstanceUserArn` of the channel moderator.
1326
1358
  #
1327
1359
  # @option params [required, String] :chime_bearer
1328
1360
  # The `AppInstanceUserArn` of the user that makes the API call.
@@ -1396,6 +1428,54 @@ module Aws::ChimeSDKMessaging
1396
1428
  req.send_request(options)
1397
1429
  end
1398
1430
 
1431
+ # Gets the membership preferences of an `AppInstanceUser` for the
1432
+ # specified channel. The `AppInstanceUser` must be a member of the
1433
+ # channel. Only the `AppInstanceUser` who owns the membership can
1434
+ # retrieve preferences. Users in the `AppInstanceAdmin` and channel
1435
+ # moderator roles can't retrieve preferences for other users. Banned
1436
+ # users can't retrieve membership preferences for the channel from
1437
+ # which they are banned.
1438
+ #
1439
+ # @option params [required, String] :channel_arn
1440
+ # The ARN of the channel.
1441
+ #
1442
+ # @option params [required, String] :member_arn
1443
+ # The `AppInstanceUserArn` of the member retrieving the preferences.
1444
+ #
1445
+ # @option params [required, String] :chime_bearer
1446
+ # The `AppInstanceUserARN` of the user making the API call.
1447
+ #
1448
+ # @return [Types::GetChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1449
+ #
1450
+ # * {Types::GetChannelMembershipPreferencesResponse#channel_arn #channel_arn} => String
1451
+ # * {Types::GetChannelMembershipPreferencesResponse#member #member} => Types::Identity
1452
+ # * {Types::GetChannelMembershipPreferencesResponse#preferences #preferences} => Types::ChannelMembershipPreferences
1453
+ #
1454
+ # @example Request syntax with placeholder values
1455
+ #
1456
+ # resp = client.get_channel_membership_preferences({
1457
+ # channel_arn: "ChimeArn", # required
1458
+ # member_arn: "ChimeArn", # required
1459
+ # chime_bearer: "ChimeArn", # required
1460
+ # })
1461
+ #
1462
+ # @example Response structure
1463
+ #
1464
+ # resp.channel_arn #=> String
1465
+ # resp.member.arn #=> String
1466
+ # resp.member.name #=> String
1467
+ # resp.preferences.push_notifications.allow_notifications #=> String, one of "ALL", "NONE", "FILTERED"
1468
+ # resp.preferences.push_notifications.filter_rule #=> String
1469
+ #
1470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences AWS API Documentation
1471
+ #
1472
+ # @overload get_channel_membership_preferences(params = {})
1473
+ # @param [Hash] params ({})
1474
+ def get_channel_membership_preferences(params = {}, options = {})
1475
+ req = build_request(:get_channel_membership_preferences, params)
1476
+ req.send_request(options)
1477
+ end
1478
+
1399
1479
  # Gets the full details of a channel message.
1400
1480
  #
1401
1481
  # <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
@@ -1441,6 +1521,9 @@ module Aws::ChimeSDKMessaging
1441
1521
  # resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
1442
1522
  # resp.channel_message.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
1443
1523
  # resp.channel_message.status.detail #=> String
1524
+ # resp.channel_message.message_attributes #=> Hash
1525
+ # resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
1526
+ # resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
1444
1527
  #
1445
1528
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
1446
1529
  #
@@ -1653,15 +1736,21 @@ module Aws::ChimeSDKMessaging
1653
1736
  #
1654
1737
  # </note>
1655
1738
  #
1739
+ # If you want to list the channels to which a specific app instance user
1740
+ # belongs, see the [ListChannelMembershipsForAppInstanceUser][1] API.
1741
+ #
1742
+ #
1743
+ #
1744
+ # [1]: https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html
1745
+ #
1656
1746
  # @option params [required, String] :channel_arn
1657
1747
  # The maximum number of channel memberships that you want returned.
1658
1748
  #
1659
1749
  # @option params [String] :type
1660
1750
  # The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
1661
- # are always returned as part of `ListChannelMemberships`. Hidden
1662
- # members are only returned if the type filter in
1663
- # `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members are
1664
- # not returned.
1751
+ # are returned as part of `ListChannelMemberships` if no type is
1752
+ # specified. Hidden members are only returned if the type filter in
1753
+ # `ListChannelMemberships` equals `HIDDEN`.
1665
1754
  #
1666
1755
  # @option params [Integer] :max_results
1667
1756
  # The maximum number of channel memberships that you want returned.
@@ -1843,6 +1932,9 @@ module Aws::ChimeSDKMessaging
1843
1932
  # resp.channel_messages[0].redacted #=> Boolean
1844
1933
  # resp.channel_messages[0].status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
1845
1934
  # resp.channel_messages[0].status.detail #=> String
1935
+ # resp.channel_messages[0].message_attributes #=> Hash
1936
+ # resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
1937
+ # resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
1846
1938
  #
1847
1939
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
1848
1940
  #
@@ -2115,6 +2207,62 @@ module Aws::ChimeSDKMessaging
2115
2207
  req.send_request(options)
2116
2208
  end
2117
2209
 
2210
+ # Sets the membership preferences of an `AppInstanceUser` for the
2211
+ # specified channel. The `AppInstanceUser` must be a member of the
2212
+ # channel. Only the `AppInstanceUser` who owns the membership can set
2213
+ # preferences. Users in the `AppInstanceAdmin` and channel moderator
2214
+ # roles can't set preferences for other users. Banned users can't set
2215
+ # membership preferences for the channel from which they are banned.
2216
+ #
2217
+ # @option params [required, String] :channel_arn
2218
+ # The ARN of the channel.
2219
+ #
2220
+ # @option params [required, String] :member_arn
2221
+ # The `AppInstanceUserArn` of the member setting the preferences.
2222
+ #
2223
+ # @option params [required, String] :chime_bearer
2224
+ # The `AppInstanceUserARN` of the user making the API call.
2225
+ #
2226
+ # @option params [required, Types::ChannelMembershipPreferences] :preferences
2227
+ # The channel membership preferences of an `AppInstanceUser` .
2228
+ #
2229
+ # @return [Types::PutChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2230
+ #
2231
+ # * {Types::PutChannelMembershipPreferencesResponse#channel_arn #channel_arn} => String
2232
+ # * {Types::PutChannelMembershipPreferencesResponse#member #member} => Types::Identity
2233
+ # * {Types::PutChannelMembershipPreferencesResponse#preferences #preferences} => Types::ChannelMembershipPreferences
2234
+ #
2235
+ # @example Request syntax with placeholder values
2236
+ #
2237
+ # resp = client.put_channel_membership_preferences({
2238
+ # channel_arn: "ChimeArn", # required
2239
+ # member_arn: "ChimeArn", # required
2240
+ # chime_bearer: "ChimeArn", # required
2241
+ # preferences: { # required
2242
+ # push_notifications: {
2243
+ # allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
2244
+ # filter_rule: "FilterRule",
2245
+ # },
2246
+ # },
2247
+ # })
2248
+ #
2249
+ # @example Response structure
2250
+ #
2251
+ # resp.channel_arn #=> String
2252
+ # resp.member.arn #=> String
2253
+ # resp.member.name #=> String
2254
+ # resp.preferences.push_notifications.allow_notifications #=> String, one of "ALL", "NONE", "FILTERED"
2255
+ # resp.preferences.push_notifications.filter_rule #=> String
2256
+ #
2257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences AWS API Documentation
2258
+ #
2259
+ # @overload put_channel_membership_preferences(params = {})
2260
+ # @param [Hash] params ({})
2261
+ def put_channel_membership_preferences(params = {}, options = {})
2262
+ req = build_request(:put_channel_membership_preferences, params)
2263
+ req.send_request(options)
2264
+ end
2265
+
2118
2266
  # Redacts message content, but not metadata. The message exists in the
2119
2267
  # back end, but the action returns null content, and the state shows as
2120
2268
  # redacted.
@@ -2199,6 +2347,13 @@ module Aws::ChimeSDKMessaging
2199
2347
  # @option params [required, String] :chime_bearer
2200
2348
  # The `AppInstanceUserArn` of the user that makes the API call.
2201
2349
  #
2350
+ # @option params [Types::PushNotificationConfiguration] :push_notification
2351
+ # The push notification configuration of the message.
2352
+ #
2353
+ # @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
2354
+ # The attributes for the message, used for message filtering along with
2355
+ # a `FilterRule` defined in the `PushNotificationPreferences`.
2356
+ #
2202
2357
  # @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2203
2358
  #
2204
2359
  # * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
@@ -2215,6 +2370,16 @@ module Aws::ChimeSDKMessaging
2215
2370
  # metadata: "Metadata",
2216
2371
  # client_request_token: "ClientRequestToken", # required
2217
2372
  # chime_bearer: "ChimeArn", # required
2373
+ # push_notification: {
2374
+ # title: "PushNotificationTitle",
2375
+ # body: "PushNotificationBody",
2376
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
2377
+ # },
2378
+ # message_attributes: {
2379
+ # "MessageAttributeName" => {
2380
+ # string_values: ["MessageAttributeStringValue"],
2381
+ # },
2382
+ # },
2218
2383
  # })
2219
2384
  #
2220
2385
  # @example Response structure
@@ -2498,7 +2663,7 @@ module Aws::ChimeSDKMessaging
2498
2663
  params: params,
2499
2664
  config: config)
2500
2665
  context[:gem_name] = 'aws-sdk-chimesdkmessaging'
2501
- context[:gem_version] = '1.4.0'
2666
+ context[:gem_version] = '1.8.0'
2502
2667
  Seahorse::Client::Request.new(handlers, context)
2503
2668
  end
2504
2669
 
@@ -13,6 +13,7 @@ module Aws::ChimeSDKMessaging
13
13
 
14
14
  include Seahorse::Model
15
15
 
16
+ AllowNotifications = Shapes::StringShape.new(name: 'AllowNotifications')
16
17
  AppInstanceUserMembershipSummary = Shapes::StructureShape.new(name: 'AppInstanceUserMembershipSummary')
17
18
  AssociateChannelFlowRequest = Shapes::StructureShape.new(name: 'AssociateChannelFlowRequest')
18
19
  BadRequestException = Shapes::StructureShape.new(name: 'BadRequestException')
@@ -37,6 +38,7 @@ module Aws::ChimeSDKMessaging
37
38
  ChannelMembership = Shapes::StructureShape.new(name: 'ChannelMembership')
38
39
  ChannelMembershipForAppInstanceUserSummary = Shapes::StructureShape.new(name: 'ChannelMembershipForAppInstanceUserSummary')
39
40
  ChannelMembershipForAppInstanceUserSummaryList = Shapes::ListShape.new(name: 'ChannelMembershipForAppInstanceUserSummaryList')
41
+ ChannelMembershipPreferences = Shapes::StructureShape.new(name: 'ChannelMembershipPreferences')
40
42
  ChannelMembershipSummary = Shapes::StructureShape.new(name: 'ChannelMembershipSummary')
41
43
  ChannelMembershipSummaryList = Shapes::ListShape.new(name: 'ChannelMembershipSummaryList')
42
44
  ChannelMembershipType = Shapes::StringShape.new(name: 'ChannelMembershipType')
@@ -94,7 +96,10 @@ module Aws::ChimeSDKMessaging
94
96
  DisassociateChannelFlowRequest = Shapes::StructureShape.new(name: 'DisassociateChannelFlowRequest')
95
97
  ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
96
98
  FallbackAction = Shapes::StringShape.new(name: 'FallbackAction')
99
+ FilterRule = Shapes::StringShape.new(name: 'FilterRule')
97
100
  ForbiddenException = Shapes::StructureShape.new(name: 'ForbiddenException')
101
+ GetChannelMembershipPreferencesRequest = Shapes::StructureShape.new(name: 'GetChannelMembershipPreferencesRequest')
102
+ GetChannelMembershipPreferencesResponse = Shapes::StructureShape.new(name: 'GetChannelMembershipPreferencesResponse')
98
103
  GetChannelMessageRequest = Shapes::StructureShape.new(name: 'GetChannelMessageRequest')
99
104
  GetChannelMessageResponse = Shapes::StructureShape.new(name: 'GetChannelMessageResponse')
100
105
  GetChannelMessageStatusRequest = Shapes::StructureShape.new(name: 'GetChannelMessageStatusRequest')
@@ -128,6 +133,11 @@ module Aws::ChimeSDKMessaging
128
133
  MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
129
134
  MemberArns = Shapes::ListShape.new(name: 'MemberArns')
130
135
  Members = Shapes::ListShape.new(name: 'Members')
136
+ MessageAttributeMap = Shapes::MapShape.new(name: 'MessageAttributeMap')
137
+ MessageAttributeName = Shapes::StringShape.new(name: 'MessageAttributeName')
138
+ MessageAttributeStringValue = Shapes::StringShape.new(name: 'MessageAttributeStringValue')
139
+ MessageAttributeStringValues = Shapes::ListShape.new(name: 'MessageAttributeStringValues')
140
+ MessageAttributeValue = Shapes::StructureShape.new(name: 'MessageAttributeValue')
131
141
  MessageId = Shapes::StringShape.new(name: 'MessageId')
132
142
  MessagingSessionEndpoint = Shapes::StructureShape.new(name: 'MessagingSessionEndpoint')
133
143
  Metadata = Shapes::StringShape.new(name: 'Metadata')
@@ -139,6 +149,13 @@ module Aws::ChimeSDKMessaging
139
149
  Processor = Shapes::StructureShape.new(name: 'Processor')
140
150
  ProcessorConfiguration = Shapes::StructureShape.new(name: 'ProcessorConfiguration')
141
151
  ProcessorList = Shapes::ListShape.new(name: 'ProcessorList')
152
+ PushNotificationBody = Shapes::StringShape.new(name: 'PushNotificationBody')
153
+ PushNotificationConfiguration = Shapes::StructureShape.new(name: 'PushNotificationConfiguration')
154
+ PushNotificationPreferences = Shapes::StructureShape.new(name: 'PushNotificationPreferences')
155
+ PushNotificationTitle = Shapes::StringShape.new(name: 'PushNotificationTitle')
156
+ PushNotificationType = Shapes::StringShape.new(name: 'PushNotificationType')
157
+ PutChannelMembershipPreferencesRequest = Shapes::StructureShape.new(name: 'PutChannelMembershipPreferencesRequest')
158
+ PutChannelMembershipPreferencesResponse = Shapes::StructureShape.new(name: 'PutChannelMembershipPreferencesResponse')
142
159
  RedactChannelMessageRequest = Shapes::StructureShape.new(name: 'RedactChannelMessageRequest')
143
160
  RedactChannelMessageResponse = Shapes::StructureShape.new(name: 'RedactChannelMessageResponse')
144
161
  ResourceLimitExceededException = Shapes::StructureShape.new(name: 'ResourceLimitExceededException')
@@ -276,6 +293,9 @@ module Aws::ChimeSDKMessaging
276
293
 
277
294
  ChannelMembershipForAppInstanceUserSummaryList.member = Shapes::ShapeRef.new(shape: ChannelMembershipForAppInstanceUserSummary)
278
295
 
296
+ ChannelMembershipPreferences.add_member(:push_notifications, Shapes::ShapeRef.new(shape: PushNotificationPreferences, location_name: "PushNotifications"))
297
+ ChannelMembershipPreferences.struct_class = Types::ChannelMembershipPreferences
298
+
279
299
  ChannelMembershipSummary.add_member(:member, Shapes::ShapeRef.new(shape: Identity, location_name: "Member"))
280
300
  ChannelMembershipSummary.struct_class = Types::ChannelMembershipSummary
281
301
 
@@ -293,11 +313,14 @@ module Aws::ChimeSDKMessaging
293
313
  ChannelMessage.add_member(:redacted, Shapes::ShapeRef.new(shape: NonNullableBoolean, location_name: "Redacted"))
294
314
  ChannelMessage.add_member(:persistence, Shapes::ShapeRef.new(shape: ChannelMessagePersistenceType, location_name: "Persistence"))
295
315
  ChannelMessage.add_member(:status, Shapes::ShapeRef.new(shape: ChannelMessageStatusStructure, location_name: "Status"))
316
+ ChannelMessage.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
296
317
  ChannelMessage.struct_class = Types::ChannelMessage
297
318
 
298
319
  ChannelMessageCallback.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location_name: "MessageId"))
299
320
  ChannelMessageCallback.add_member(:content, Shapes::ShapeRef.new(shape: NonEmptyContent, location_name: "Content"))
300
321
  ChannelMessageCallback.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "Metadata"))
322
+ ChannelMessageCallback.add_member(:push_notification, Shapes::ShapeRef.new(shape: PushNotificationConfiguration, location_name: "PushNotification"))
323
+ ChannelMessageCallback.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
301
324
  ChannelMessageCallback.struct_class = Types::ChannelMessageCallback
302
325
 
303
326
  ChannelMessageStatusStructure.add_member(:value, Shapes::ShapeRef.new(shape: ChannelMessageStatus, location_name: "Value"))
@@ -314,6 +337,7 @@ module Aws::ChimeSDKMessaging
314
337
  ChannelMessageSummary.add_member(:sender, Shapes::ShapeRef.new(shape: Identity, location_name: "Sender"))
315
338
  ChannelMessageSummary.add_member(:redacted, Shapes::ShapeRef.new(shape: NonNullableBoolean, location_name: "Redacted"))
316
339
  ChannelMessageSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelMessageStatusStructure, location_name: "Status"))
340
+ ChannelMessageSummary.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
317
341
  ChannelMessageSummary.struct_class = Types::ChannelMessageSummary
318
342
 
319
343
  ChannelMessageSummaryList.member = Shapes::ShapeRef.new(shape: ChannelMessageSummary)
@@ -488,6 +512,16 @@ module Aws::ChimeSDKMessaging
488
512
  ForbiddenException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
489
513
  ForbiddenException.struct_class = Types::ForbiddenException
490
514
 
515
+ GetChannelMembershipPreferencesRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
516
+ GetChannelMembershipPreferencesRequest.add_member(:member_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "memberArn"))
517
+ GetChannelMembershipPreferencesRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
518
+ GetChannelMembershipPreferencesRequest.struct_class = Types::GetChannelMembershipPreferencesRequest
519
+
520
+ GetChannelMembershipPreferencesResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
521
+ GetChannelMembershipPreferencesResponse.add_member(:member, Shapes::ShapeRef.new(shape: Identity, location_name: "Member"))
522
+ GetChannelMembershipPreferencesResponse.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, location_name: "Preferences"))
523
+ GetChannelMembershipPreferencesResponse.struct_class = Types::GetChannelMembershipPreferencesResponse
524
+
491
525
  GetChannelMessageRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
492
526
  GetChannelMessageRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location: "uri", location_name: "messageId"))
493
527
  GetChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
@@ -624,6 +658,14 @@ module Aws::ChimeSDKMessaging
624
658
 
625
659
  Members.member = Shapes::ShapeRef.new(shape: Identity)
626
660
 
661
+ MessageAttributeMap.key = Shapes::ShapeRef.new(shape: MessageAttributeName)
662
+ MessageAttributeMap.value = Shapes::ShapeRef.new(shape: MessageAttributeValue)
663
+
664
+ MessageAttributeStringValues.member = Shapes::ShapeRef.new(shape: MessageAttributeStringValue)
665
+
666
+ MessageAttributeValue.add_member(:string_values, Shapes::ShapeRef.new(shape: MessageAttributeStringValues, location_name: "StringValues"))
667
+ MessageAttributeValue.struct_class = Types::MessageAttributeValue
668
+
627
669
  MessagingSessionEndpoint.add_member(:url, Shapes::ShapeRef.new(shape: UrlType, location_name: "Url"))
628
670
  MessagingSessionEndpoint.struct_class = Types::MessagingSessionEndpoint
629
671
 
@@ -642,6 +684,26 @@ module Aws::ChimeSDKMessaging
642
684
 
643
685
  ProcessorList.member = Shapes::ShapeRef.new(shape: Processor)
644
686
 
687
+ PushNotificationConfiguration.add_member(:title, Shapes::ShapeRef.new(shape: PushNotificationTitle, location_name: "Title"))
688
+ PushNotificationConfiguration.add_member(:body, Shapes::ShapeRef.new(shape: PushNotificationBody, location_name: "Body"))
689
+ PushNotificationConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: PushNotificationType, location_name: "Type"))
690
+ PushNotificationConfiguration.struct_class = Types::PushNotificationConfiguration
691
+
692
+ PushNotificationPreferences.add_member(:allow_notifications, Shapes::ShapeRef.new(shape: AllowNotifications, required: true, location_name: "AllowNotifications"))
693
+ PushNotificationPreferences.add_member(:filter_rule, Shapes::ShapeRef.new(shape: FilterRule, location_name: "FilterRule"))
694
+ PushNotificationPreferences.struct_class = Types::PushNotificationPreferences
695
+
696
+ PutChannelMembershipPreferencesRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
697
+ PutChannelMembershipPreferencesRequest.add_member(:member_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "memberArn"))
698
+ PutChannelMembershipPreferencesRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
699
+ PutChannelMembershipPreferencesRequest.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, required: true, location_name: "Preferences"))
700
+ PutChannelMembershipPreferencesRequest.struct_class = Types::PutChannelMembershipPreferencesRequest
701
+
702
+ PutChannelMembershipPreferencesResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
703
+ PutChannelMembershipPreferencesResponse.add_member(:member, Shapes::ShapeRef.new(shape: Identity, location_name: "Member"))
704
+ PutChannelMembershipPreferencesResponse.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, location_name: "Preferences"))
705
+ PutChannelMembershipPreferencesResponse.struct_class = Types::PutChannelMembershipPreferencesResponse
706
+
645
707
  RedactChannelMessageRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
646
708
  RedactChannelMessageRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location: "uri", location_name: "messageId"))
647
709
  RedactChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
@@ -662,6 +724,8 @@ module Aws::ChimeSDKMessaging
662
724
  SendChannelMessageRequest.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "Metadata"))
663
725
  SendChannelMessageRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
664
726
  SendChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
727
+ SendChannelMessageRequest.add_member(:push_notification, Shapes::ShapeRef.new(shape: PushNotificationConfiguration, location_name: "PushNotification"))
728
+ SendChannelMessageRequest.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
665
729
  SendChannelMessageRequest.struct_class = Types::SendChannelMessageRequest
666
730
 
667
731
  SendChannelMessageResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
@@ -1083,6 +1147,20 @@ module Aws::ChimeSDKMessaging
1083
1147
  o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
1084
1148
  end)
1085
1149
 
1150
+ api.add_operation(:get_channel_membership_preferences, Seahorse::Model::Operation.new.tap do |o|
1151
+ o.name = "GetChannelMembershipPreferences"
1152
+ o.http_method = "GET"
1153
+ o.http_request_uri = "/channels/{channelArn}/memberships/{memberArn}/preferences"
1154
+ o.input = Shapes::ShapeRef.new(shape: GetChannelMembershipPreferencesRequest)
1155
+ o.output = Shapes::ShapeRef.new(shape: GetChannelMembershipPreferencesResponse)
1156
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
1157
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedClientException)
1158
+ o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
1159
+ o.errors << Shapes::ShapeRef.new(shape: ThrottledClientException)
1160
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1161
+ o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
1162
+ end)
1163
+
1086
1164
  api.add_operation(:get_channel_message, Seahorse::Model::Operation.new.tap do |o|
1087
1165
  o.name = "GetChannelMessage"
1088
1166
  o.http_method = "GET"
@@ -1319,6 +1397,21 @@ module Aws::ChimeSDKMessaging
1319
1397
  o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
1320
1398
  end)
1321
1399
 
1400
+ api.add_operation(:put_channel_membership_preferences, Seahorse::Model::Operation.new.tap do |o|
1401
+ o.name = "PutChannelMembershipPreferences"
1402
+ o.http_method = "PUT"
1403
+ o.http_request_uri = "/channels/{channelArn}/memberships/{memberArn}/preferences"
1404
+ o.input = Shapes::ShapeRef.new(shape: PutChannelMembershipPreferencesRequest)
1405
+ o.output = Shapes::ShapeRef.new(shape: PutChannelMembershipPreferencesResponse)
1406
+ o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
1407
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
1408
+ o.errors << Shapes::ShapeRef.new(shape: UnauthorizedClientException)
1409
+ o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
1410
+ o.errors << Shapes::ShapeRef.new(shape: ThrottledClientException)
1411
+ o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
1412
+ o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
1413
+ end)
1414
+
1322
1415
  api.add_operation(:redact_channel_message, Seahorse::Model::Operation.new.tap do |o|
1323
1416
  o.name = "RedactChannelMessage"
1324
1417
  o.http_method = "POST"
@@ -110,7 +110,8 @@ module Aws::ChimeSDKMessaging
110
110
  # A list of failed member ARNs, error codes, and error messages.
111
111
  #
112
112
  # @!attribute [rw] member_arn
113
- # The ARN of the member that the service couldn't add.
113
+ # The `AppInstanceUserArn` of the member that the service couldn't
114
+ # add.
114
115
  # @return [String]
115
116
  #
116
117
  # @!attribute [rw] error_code
@@ -154,7 +155,8 @@ module Aws::ChimeSDKMessaging
154
155
  # @return [String]
155
156
  #
156
157
  # @!attribute [rw] member_arns
157
- # The ARNs of the members you want to add to the channel.
158
+ # The `AppInstanceUserArn`s of the members you want to add to the
159
+ # channel.
158
160
  # @return [Array<String>]
159
161
  #
160
162
  # @!attribute [rw] chime_bearer
@@ -372,6 +374,16 @@ module Aws::ChimeSDKMessaging
372
374
  # message_id: "MessageId", # required
373
375
  # content: "NonEmptyContent",
374
376
  # metadata: "Metadata",
377
+ # push_notification: {
378
+ # title: "PushNotificationTitle",
379
+ # body: "PushNotificationBody",
380
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
381
+ # },
382
+ # message_attributes: {
383
+ # "MessageAttributeName" => {
384
+ # string_values: ["MessageAttributeStringValue"],
385
+ # },
386
+ # },
375
387
  # },
376
388
  # }
377
389
  #
@@ -506,6 +518,30 @@ module Aws::ChimeSDKMessaging
506
518
  include Aws::Structure
507
519
  end
508
520
 
521
+ # The channel membership preferences for an `AppInstanceUser`.
522
+ #
523
+ # @note When making an API call, you may pass ChannelMembershipPreferences
524
+ # data as a hash:
525
+ #
526
+ # {
527
+ # push_notifications: {
528
+ # allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
529
+ # filter_rule: "FilterRule",
530
+ # },
531
+ # }
532
+ #
533
+ # @!attribute [rw] push_notifications
534
+ # The push notification configuration of a message.
535
+ # @return [Types::PushNotificationPreferences]
536
+ #
537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembershipPreferences AWS API Documentation
538
+ #
539
+ class ChannelMembershipPreferences < Struct.new(
540
+ :push_notifications)
541
+ SENSITIVE = []
542
+ include Aws::Structure
543
+ end
544
+
509
545
  # Summary of the details of a `ChannelMembership`.
510
546
  #
511
547
  # @!attribute [rw] member
@@ -570,6 +606,11 @@ module Aws::ChimeSDKMessaging
570
606
  # The status of the channel message.
571
607
  # @return [Types::ChannelMessageStatusStructure]
572
608
  #
609
+ # @!attribute [rw] message_attributes
610
+ # The attributes for the message, used for message filtering along
611
+ # with a `FilterRule` defined in the `PushNotificationPreferences`.
612
+ # @return [Hash<String,Types::MessageAttributeValue>]
613
+ #
573
614
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
574
615
  #
575
616
  class ChannelMessage < Struct.new(
@@ -584,7 +625,8 @@ module Aws::ChimeSDKMessaging
584
625
  :sender,
585
626
  :redacted,
586
627
  :persistence,
587
- :status)
628
+ :status,
629
+ :message_attributes)
588
630
  SENSITIVE = [:content, :metadata]
589
631
  include Aws::Structure
590
632
  end
@@ -598,6 +640,16 @@ module Aws::ChimeSDKMessaging
598
640
  # message_id: "MessageId", # required
599
641
  # content: "NonEmptyContent",
600
642
  # metadata: "Metadata",
643
+ # push_notification: {
644
+ # title: "PushNotificationTitle",
645
+ # body: "PushNotificationBody",
646
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
647
+ # },
648
+ # message_attributes: {
649
+ # "MessageAttributeName" => {
650
+ # string_values: ["MessageAttributeStringValue"],
651
+ # },
652
+ # },
601
653
  # }
602
654
  #
603
655
  # @!attribute [rw] message_id
@@ -612,12 +664,23 @@ module Aws::ChimeSDKMessaging
612
664
  # The message metadata.
613
665
  # @return [String]
614
666
  #
667
+ # @!attribute [rw] push_notification
668
+ # The push notification configuration of the message.
669
+ # @return [Types::PushNotificationConfiguration]
670
+ #
671
+ # @!attribute [rw] message_attributes
672
+ # The attributes for the message, used for message filtering along
673
+ # with a `FilterRule` defined in the `PushNotificationPreferences`.
674
+ # @return [Hash<String,Types::MessageAttributeValue>]
675
+ #
615
676
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageCallback AWS API Documentation
616
677
  #
617
678
  class ChannelMessageCallback < Struct.new(
618
679
  :message_id,
619
680
  :content,
620
- :metadata)
681
+ :metadata,
682
+ :push_notification,
683
+ :message_attributes)
621
684
  SENSITIVE = [:content, :metadata]
622
685
  include Aws::Structure
623
686
  end
@@ -685,6 +748,10 @@ module Aws::ChimeSDKMessaging
685
748
  # channel flow, the value determines the processing stage.
686
749
  # @return [Types::ChannelMessageStatusStructure]
687
750
  #
751
+ # @!attribute [rw] message_attributes
752
+ # The message attribues listed in a the summary of a channel message.
753
+ # @return [Hash<String,Types::MessageAttributeValue>]
754
+ #
688
755
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageSummary AWS API Documentation
689
756
  #
690
757
  class ChannelMessageSummary < Struct.new(
@@ -697,7 +764,8 @@ module Aws::ChimeSDKMessaging
697
764
  :last_edited_timestamp,
698
765
  :sender,
699
766
  :redacted,
700
- :status)
767
+ :status,
768
+ :message_attributes)
701
769
  SENSITIVE = [:content, :metadata]
702
770
  include Aws::Structure
703
771
  end
@@ -830,7 +898,7 @@ module Aws::ChimeSDKMessaging
830
898
  # @return [String]
831
899
  #
832
900
  # @!attribute [rw] member_arn
833
- # The ARN of the member being banned.
901
+ # The `AppInstanceUserArn` of the member being banned.
834
902
  # @return [String]
835
903
  #
836
904
  # @!attribute [rw] chime_bearer
@@ -952,7 +1020,8 @@ module Aws::ChimeSDKMessaging
952
1020
  # @return [String]
953
1021
  #
954
1022
  # @!attribute [rw] member_arn
955
- # The ARN of the member you want to add to the channel.
1023
+ # The `AppInstanceUserArn` of the member you want to add to the
1024
+ # channel.
956
1025
  # @return [String]
957
1026
  #
958
1027
  # @!attribute [rw] type
@@ -1009,7 +1078,7 @@ module Aws::ChimeSDKMessaging
1009
1078
  # @return [String]
1010
1079
  #
1011
1080
  # @!attribute [rw] channel_moderator_arn
1012
- # The ARN of the moderator.
1081
+ # The `AppInstanceUserArn` of the moderator.
1013
1082
  # @return [String]
1014
1083
  #
1015
1084
  # @!attribute [rw] chime_bearer
@@ -1193,7 +1262,8 @@ module Aws::ChimeSDKMessaging
1193
1262
  # @return [String]
1194
1263
  #
1195
1264
  # @!attribute [rw] member_arn
1196
- # The ARN of the member that you're removing from the channel.
1265
+ # The `AppInstanceUserArn` of the member that you're removing from
1266
+ # the channel.
1197
1267
  # @return [String]
1198
1268
  #
1199
1269
  # @!attribute [rw] chime_bearer
@@ -1255,7 +1325,7 @@ module Aws::ChimeSDKMessaging
1255
1325
  # @return [String]
1256
1326
  #
1257
1327
  # @!attribute [rw] channel_moderator_arn
1258
- # The ARN of the moderator being deleted.
1328
+ # The `AppInstanceUserArn` of the moderator being deleted.
1259
1329
  # @return [String]
1260
1330
  #
1261
1331
  # @!attribute [rw] chime_bearer
@@ -1311,7 +1381,7 @@ module Aws::ChimeSDKMessaging
1311
1381
  # @return [String]
1312
1382
  #
1313
1383
  # @!attribute [rw] member_arn
1314
- # The ARN of the member being banned.
1384
+ # The `AppInstanceUserArn` of the member being banned.
1315
1385
  # @return [String]
1316
1386
  #
1317
1387
  # @!attribute [rw] chime_bearer
@@ -1428,7 +1498,7 @@ module Aws::ChimeSDKMessaging
1428
1498
  # @return [String]
1429
1499
  #
1430
1500
  # @!attribute [rw] member_arn
1431
- # The ARN of the member.
1501
+ # The `AppInstanceUserArn` of the member.
1432
1502
  # @return [String]
1433
1503
  #
1434
1504
  # @!attribute [rw] chime_bearer
@@ -1514,7 +1584,7 @@ module Aws::ChimeSDKMessaging
1514
1584
  # @return [String]
1515
1585
  #
1516
1586
  # @!attribute [rw] channel_moderator_arn
1517
- # The ARN of the channel moderator.
1587
+ # The `AppInstanceUserArn` of the channel moderator.
1518
1588
  # @return [String]
1519
1589
  #
1520
1590
  # @!attribute [rw] chime_bearer
@@ -1628,6 +1698,59 @@ module Aws::ChimeSDKMessaging
1628
1698
  include Aws::Structure
1629
1699
  end
1630
1700
 
1701
+ # @note When making an API call, you may pass GetChannelMembershipPreferencesRequest
1702
+ # data as a hash:
1703
+ #
1704
+ # {
1705
+ # channel_arn: "ChimeArn", # required
1706
+ # member_arn: "ChimeArn", # required
1707
+ # chime_bearer: "ChimeArn", # required
1708
+ # }
1709
+ #
1710
+ # @!attribute [rw] channel_arn
1711
+ # The ARN of the channel.
1712
+ # @return [String]
1713
+ #
1714
+ # @!attribute [rw] member_arn
1715
+ # The `AppInstanceUserArn` of the member retrieving the preferences.
1716
+ # @return [String]
1717
+ #
1718
+ # @!attribute [rw] chime_bearer
1719
+ # The `AppInstanceUserARN` of the user making the API call.
1720
+ # @return [String]
1721
+ #
1722
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferencesRequest AWS API Documentation
1723
+ #
1724
+ class GetChannelMembershipPreferencesRequest < Struct.new(
1725
+ :channel_arn,
1726
+ :member_arn,
1727
+ :chime_bearer)
1728
+ SENSITIVE = []
1729
+ include Aws::Structure
1730
+ end
1731
+
1732
+ # @!attribute [rw] channel_arn
1733
+ # The ARN of the channel.
1734
+ # @return [String]
1735
+ #
1736
+ # @!attribute [rw] member
1737
+ # The details of a user.
1738
+ # @return [Types::Identity]
1739
+ #
1740
+ # @!attribute [rw] preferences
1741
+ # The channel membership preferences for an `AppInstanceUser` .
1742
+ # @return [Types::ChannelMembershipPreferences]
1743
+ #
1744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferencesResponse AWS API Documentation
1745
+ #
1746
+ class GetChannelMembershipPreferencesResponse < Struct.new(
1747
+ :channel_arn,
1748
+ :member,
1749
+ :preferences)
1750
+ SENSITIVE = []
1751
+ include Aws::Structure
1752
+ end
1753
+
1631
1754
  # @note When making an API call, you may pass GetChannelMessageRequest
1632
1755
  # data as a hash:
1633
1756
  #
@@ -1963,10 +2086,9 @@ module Aws::ChimeSDKMessaging
1963
2086
  #
1964
2087
  # @!attribute [rw] type
1965
2088
  # The membership type of a user, `DEFAULT` or `HIDDEN`. Default
1966
- # members are always returned as part of `ListChannelMemberships`.
1967
- # Hidden members are only returned if the type filter in
1968
- # `ListChannelMemberships` equals `HIDDEN`. Otherwise hidden members
1969
- # are not returned.
2089
+ # members are returned as part of `ListChannelMemberships` if no type
2090
+ # is specified. Hidden members are only returned if the type filter in
2091
+ # `ListChannelMemberships` equals `HIDDEN`.
1970
2092
  # @return [String]
1971
2093
  #
1972
2094
  # @!attribute [rw] max_results
@@ -2359,6 +2481,27 @@ module Aws::ChimeSDKMessaging
2359
2481
  include Aws::Structure
2360
2482
  end
2361
2483
 
2484
+ # A list of message attribute values.
2485
+ #
2486
+ # @note When making an API call, you may pass MessageAttributeValue
2487
+ # data as a hash:
2488
+ #
2489
+ # {
2490
+ # string_values: ["MessageAttributeStringValue"],
2491
+ # }
2492
+ #
2493
+ # @!attribute [rw] string_values
2494
+ # The strings in a message attribute value.
2495
+ # @return [Array<String>]
2496
+ #
2497
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/MessageAttributeValue AWS API Documentation
2498
+ #
2499
+ class MessageAttributeValue < Struct.new(
2500
+ :string_values)
2501
+ SENSITIVE = []
2502
+ include Aws::Structure
2503
+ end
2504
+
2362
2505
  # The websocket endpoint used to connect to Amazon Chime SDK messaging.
2363
2506
  #
2364
2507
  # @!attribute [rw] url
@@ -2424,11 +2567,14 @@ module Aws::ChimeSDKMessaging
2424
2567
  # @return [Integer]
2425
2568
  #
2426
2569
  # @!attribute [rw] fallback_action
2427
- # Determines whether to continue or stop processing if communication
2428
- # with processor fails. If the last processor in a channel flow
2429
- # sequence has a fallback action of CONTINUE, and communication with
2430
- # the processor fails, the message is considered processed and sent to
2431
- # the recipients in the channel.
2570
+ # Determines whether to continue with message processing or stop it in
2571
+ # cases where communication with a processor fails. If a processor has
2572
+ # a fallback action of `ABORT` and communication with it fails, the
2573
+ # processor sets the message status to `FAILED` and does not send the
2574
+ # message to any recipients. Note that if the last processor in the
2575
+ # channel flow sequence has a fallback action of `CONTINUE` and
2576
+ # communication with the processor fails, then the message is
2577
+ # considered processed and sent to recipients of the channel.
2432
2578
  # @return [String]
2433
2579
  #
2434
2580
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Processor AWS API Documentation
@@ -2466,6 +2612,136 @@ module Aws::ChimeSDKMessaging
2466
2612
  include Aws::Structure
2467
2613
  end
2468
2614
 
2615
+ # The push notification configuration of the message.
2616
+ #
2617
+ # @note When making an API call, you may pass PushNotificationConfiguration
2618
+ # data as a hash:
2619
+ #
2620
+ # {
2621
+ # title: "PushNotificationTitle",
2622
+ # body: "PushNotificationBody",
2623
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
2624
+ # }
2625
+ #
2626
+ # @!attribute [rw] title
2627
+ # The title of the push notification.
2628
+ # @return [String]
2629
+ #
2630
+ # @!attribute [rw] body
2631
+ # The body of the push notification.
2632
+ # @return [String]
2633
+ #
2634
+ # @!attribute [rw] type
2635
+ # Enum value that indicates the type of the push notification for a
2636
+ # message. `DEFAULT`\: Normal mobile push notification. `VOIP`\: VOIP
2637
+ # mobile push notification.
2638
+ # @return [String]
2639
+ #
2640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PushNotificationConfiguration AWS API Documentation
2641
+ #
2642
+ class PushNotificationConfiguration < Struct.new(
2643
+ :title,
2644
+ :body,
2645
+ :type)
2646
+ SENSITIVE = [:title, :body]
2647
+ include Aws::Structure
2648
+ end
2649
+
2650
+ # The channel membership preferences for push notification.
2651
+ #
2652
+ # @note When making an API call, you may pass PushNotificationPreferences
2653
+ # data as a hash:
2654
+ #
2655
+ # {
2656
+ # allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
2657
+ # filter_rule: "FilterRule",
2658
+ # }
2659
+ #
2660
+ # @!attribute [rw] allow_notifications
2661
+ # Enum value that indicates which push notifications to send to the
2662
+ # requested member of a channel. `ALL` sends all push notifications,
2663
+ # `NONE` sends no push notifications, `FILTERED` sends only filtered
2664
+ # push notifications.
2665
+ # @return [String]
2666
+ #
2667
+ # @!attribute [rw] filter_rule
2668
+ # The simple JSON object used to send a subset of a push notification
2669
+ # to the requsted member.
2670
+ # @return [String]
2671
+ #
2672
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PushNotificationPreferences AWS API Documentation
2673
+ #
2674
+ class PushNotificationPreferences < Struct.new(
2675
+ :allow_notifications,
2676
+ :filter_rule)
2677
+ SENSITIVE = [:filter_rule]
2678
+ include Aws::Structure
2679
+ end
2680
+
2681
+ # @note When making an API call, you may pass PutChannelMembershipPreferencesRequest
2682
+ # data as a hash:
2683
+ #
2684
+ # {
2685
+ # channel_arn: "ChimeArn", # required
2686
+ # member_arn: "ChimeArn", # required
2687
+ # chime_bearer: "ChimeArn", # required
2688
+ # preferences: { # required
2689
+ # push_notifications: {
2690
+ # allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
2691
+ # filter_rule: "FilterRule",
2692
+ # },
2693
+ # },
2694
+ # }
2695
+ #
2696
+ # @!attribute [rw] channel_arn
2697
+ # The ARN of the channel.
2698
+ # @return [String]
2699
+ #
2700
+ # @!attribute [rw] member_arn
2701
+ # The `AppInstanceUserArn` of the member setting the preferences.
2702
+ # @return [String]
2703
+ #
2704
+ # @!attribute [rw] chime_bearer
2705
+ # The `AppInstanceUserARN` of the user making the API call.
2706
+ # @return [String]
2707
+ #
2708
+ # @!attribute [rw] preferences
2709
+ # The channel membership preferences of an `AppInstanceUser` .
2710
+ # @return [Types::ChannelMembershipPreferences]
2711
+ #
2712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferencesRequest AWS API Documentation
2713
+ #
2714
+ class PutChannelMembershipPreferencesRequest < Struct.new(
2715
+ :channel_arn,
2716
+ :member_arn,
2717
+ :chime_bearer,
2718
+ :preferences)
2719
+ SENSITIVE = []
2720
+ include Aws::Structure
2721
+ end
2722
+
2723
+ # @!attribute [rw] channel_arn
2724
+ # The ARN of the channel.
2725
+ # @return [String]
2726
+ #
2727
+ # @!attribute [rw] member
2728
+ # The details of a user.
2729
+ # @return [Types::Identity]
2730
+ #
2731
+ # @!attribute [rw] preferences
2732
+ # The ARN and metadata of the member being added.
2733
+ # @return [Types::ChannelMembershipPreferences]
2734
+ #
2735
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferencesResponse AWS API Documentation
2736
+ #
2737
+ class PutChannelMembershipPreferencesResponse < Struct.new(
2738
+ :channel_arn,
2739
+ :member,
2740
+ :preferences)
2741
+ SENSITIVE = []
2742
+ include Aws::Structure
2743
+ end
2744
+
2469
2745
  # @note When making an API call, you may pass RedactChannelMessageRequest
2470
2746
  # data as a hash:
2471
2747
  #
@@ -2544,6 +2820,16 @@ module Aws::ChimeSDKMessaging
2544
2820
  # metadata: "Metadata",
2545
2821
  # client_request_token: "ClientRequestToken", # required
2546
2822
  # chime_bearer: "ChimeArn", # required
2823
+ # push_notification: {
2824
+ # title: "PushNotificationTitle",
2825
+ # body: "PushNotificationBody",
2826
+ # type: "DEFAULT", # accepts DEFAULT, VOIP
2827
+ # },
2828
+ # message_attributes: {
2829
+ # "MessageAttributeName" => {
2830
+ # string_values: ["MessageAttributeStringValue"],
2831
+ # },
2832
+ # },
2547
2833
  # }
2548
2834
  #
2549
2835
  # @!attribute [rw] channel_arn
@@ -2578,6 +2864,15 @@ module Aws::ChimeSDKMessaging
2578
2864
  # The `AppInstanceUserArn` of the user that makes the API call.
2579
2865
  # @return [String]
2580
2866
  #
2867
+ # @!attribute [rw] push_notification
2868
+ # The push notification configuration of the message.
2869
+ # @return [Types::PushNotificationConfiguration]
2870
+ #
2871
+ # @!attribute [rw] message_attributes
2872
+ # The attributes for the message, used for message filtering along
2873
+ # with a `FilterRule` defined in the `PushNotificationPreferences`.
2874
+ # @return [Hash<String,Types::MessageAttributeValue>]
2875
+ #
2581
2876
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
2582
2877
  #
2583
2878
  class SendChannelMessageRequest < Struct.new(
@@ -2587,7 +2882,9 @@ module Aws::ChimeSDKMessaging
2587
2882
  :persistence,
2588
2883
  :metadata,
2589
2884
  :client_request_token,
2590
- :chime_bearer)
2885
+ :chime_bearer,
2886
+ :push_notification,
2887
+ :message_attributes)
2591
2888
  SENSITIVE = [:content, :metadata, :client_request_token]
2592
2889
  include Aws::Structure
2593
2890
  end
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-chimesdkmessaging/customizations'
48
48
  # @!group service
49
49
  module Aws::ChimeSDKMessaging
50
50
 
51
- GEM_VERSION = '1.4.0'
51
+ GEM_VERSION = '1.8.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-chimesdkmessaging
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.0
4
+ version: 1.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-10-19 00:00:00.000000000 Z
11
+ date: 2021-12-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.121.2
22
+ version: 3.125.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.121.2
32
+ version: 3.125.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement