aws-sdk-chimesdkmessaging 1.4.0 → 1.5.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +148 -12
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +91 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +285 -18
- data/lib/aws-sdk-chimesdkmessaging.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d10cd08b96b2c55203dd760259872eb359dcbac8c66296ba0cd2d5d1c852463f
|
|
4
|
+
data.tar.gz: d0d6b479881cba3a1028c709dc6998f160d5a87bf5559df7fd90fafc64ffea2d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 851833d86cb6dc29fcc508116441d1c1e542d12795830d7bed0d533280143b93533f7403ecdd5cc7f7b05d5953a6f8392df5af3e09c781a58e9b83145b546274
|
|
7
|
+
data.tar.gz: 0dcfde90743af2148e905c0be7d4afe9dc231fe6bb0962ad144f60fc35c0d65d2f21458f58f9c4ede771e8ed8770fcc79629ce326c7f1b9578554668cae234fc
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.5.0
|
|
@@ -379,7 +379,8 @@ module Aws::ChimeSDKMessaging
|
|
|
379
379
|
# not returned. This is only supported by moderators.
|
|
380
380
|
#
|
|
381
381
|
# @option params [required, Array<String>] :member_arns
|
|
382
|
-
# The
|
|
382
|
+
# The `AppInstanceUserArn`s of the members you want to add to the
|
|
383
|
+
# channel.
|
|
383
384
|
#
|
|
384
385
|
# @option params [required, String] :chime_bearer
|
|
385
386
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -577,7 +578,7 @@ module Aws::ChimeSDKMessaging
|
|
|
577
578
|
# The ARN of the ban request.
|
|
578
579
|
#
|
|
579
580
|
# @option params [required, String] :member_arn
|
|
580
|
-
# The
|
|
581
|
+
# The `AppInstanceUserArn` of the member being banned.
|
|
581
582
|
#
|
|
582
583
|
# @option params [required, String] :chime_bearer
|
|
583
584
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -693,8 +694,8 @@ module Aws::ChimeSDKMessaging
|
|
|
693
694
|
req.send_request(options)
|
|
694
695
|
end
|
|
695
696
|
|
|
696
|
-
# Adds a user to a channel. The `InvitedBy`
|
|
697
|
-
# from the request header. A channel member can:
|
|
697
|
+
# Adds a user to a channel. The `InvitedBy` field in `ChannelMembership`
|
|
698
|
+
# is derived from the request header. A channel member can:
|
|
698
699
|
#
|
|
699
700
|
# * List messages
|
|
700
701
|
#
|
|
@@ -723,7 +724,7 @@ module Aws::ChimeSDKMessaging
|
|
|
723
724
|
# The ARN of the channel to which you're adding users.
|
|
724
725
|
#
|
|
725
726
|
# @option params [required, String] :member_arn
|
|
726
|
-
# The
|
|
727
|
+
# The `AppInstanceUserArn` of the member you want to add to the channel.
|
|
727
728
|
#
|
|
728
729
|
# @option params [required, String] :type
|
|
729
730
|
# The membership type of a user, `DEFAULT` or `HIDDEN`. Default members
|
|
@@ -786,7 +787,7 @@ module Aws::ChimeSDKMessaging
|
|
|
786
787
|
# The ARN of the channel.
|
|
787
788
|
#
|
|
788
789
|
# @option params [required, String] :channel_moderator_arn
|
|
789
|
-
# The
|
|
790
|
+
# The `AppInstanceUserArn` of the moderator.
|
|
790
791
|
#
|
|
791
792
|
# @option params [required, String] :chime_bearer
|
|
792
793
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -931,7 +932,8 @@ module Aws::ChimeSDKMessaging
|
|
|
931
932
|
# The ARN of the channel from which you want to remove the user.
|
|
932
933
|
#
|
|
933
934
|
# @option params [required, String] :member_arn
|
|
934
|
-
# The
|
|
935
|
+
# The `AppInstanceUserArn` of the member that you're removing from the
|
|
936
|
+
# channel.
|
|
935
937
|
#
|
|
936
938
|
# @option params [required, String] :chime_bearer
|
|
937
939
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -1005,7 +1007,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1005
1007
|
# The ARN of the channel.
|
|
1006
1008
|
#
|
|
1007
1009
|
# @option params [required, String] :channel_moderator_arn
|
|
1008
|
-
# The
|
|
1010
|
+
# The `AppInstanceUserArn` of the moderator being deleted.
|
|
1009
1011
|
#
|
|
1010
1012
|
# @option params [required, String] :chime_bearer
|
|
1011
1013
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -1090,7 +1092,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1090
1092
|
# The ARN of the channel from which the user is banned.
|
|
1091
1093
|
#
|
|
1092
1094
|
# @option params [required, String] :member_arn
|
|
1093
|
-
# The
|
|
1095
|
+
# The `AppInstanceUserArn` of the member being banned.
|
|
1094
1096
|
#
|
|
1095
1097
|
# @option params [required, String] :chime_bearer
|
|
1096
1098
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -1175,7 +1177,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1175
1177
|
# The ARN of the channel.
|
|
1176
1178
|
#
|
|
1177
1179
|
# @option params [required, String] :member_arn
|
|
1178
|
-
# The
|
|
1180
|
+
# The `AppInstanceUserArn` of the member.
|
|
1179
1181
|
#
|
|
1180
1182
|
# @option params [required, String] :chime_bearer
|
|
1181
1183
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -1322,7 +1324,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1322
1324
|
# The ARN of the channel.
|
|
1323
1325
|
#
|
|
1324
1326
|
# @option params [required, String] :channel_moderator_arn
|
|
1325
|
-
# The
|
|
1327
|
+
# The `AppInstanceUserArn` of the channel moderator.
|
|
1326
1328
|
#
|
|
1327
1329
|
# @option params [required, String] :chime_bearer
|
|
1328
1330
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
@@ -1396,6 +1398,54 @@ module Aws::ChimeSDKMessaging
|
|
|
1396
1398
|
req.send_request(options)
|
|
1397
1399
|
end
|
|
1398
1400
|
|
|
1401
|
+
# Gets the membership preferences of an `AppInstanceUser` for the
|
|
1402
|
+
# specified channel. The `AppInstanceUser` must be a member of the
|
|
1403
|
+
# channel. Only the `AppInstanceUser` who owns the membership can
|
|
1404
|
+
# retrieve preferences. Users in the `AppInstanceAdmin` and channel
|
|
1405
|
+
# moderator roles can't retrieve preferences for other users. Banned
|
|
1406
|
+
# users can't retrieve membership preferences for the channel from
|
|
1407
|
+
# which they are banned.
|
|
1408
|
+
#
|
|
1409
|
+
# @option params [required, String] :channel_arn
|
|
1410
|
+
# The ARN of the channel.
|
|
1411
|
+
#
|
|
1412
|
+
# @option params [required, String] :member_arn
|
|
1413
|
+
# The `AppInstanceUserArn` of the member retrieving the preferences.
|
|
1414
|
+
#
|
|
1415
|
+
# @option params [required, String] :chime_bearer
|
|
1416
|
+
# The `AppInstanceUserARN` of the user making the API call.
|
|
1417
|
+
#
|
|
1418
|
+
# @return [Types::GetChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
1419
|
+
#
|
|
1420
|
+
# * {Types::GetChannelMembershipPreferencesResponse#channel_arn #channel_arn} => String
|
|
1421
|
+
# * {Types::GetChannelMembershipPreferencesResponse#member #member} => Types::Identity
|
|
1422
|
+
# * {Types::GetChannelMembershipPreferencesResponse#preferences #preferences} => Types::ChannelMembershipPreferences
|
|
1423
|
+
#
|
|
1424
|
+
# @example Request syntax with placeholder values
|
|
1425
|
+
#
|
|
1426
|
+
# resp = client.get_channel_membership_preferences({
|
|
1427
|
+
# channel_arn: "ChimeArn", # required
|
|
1428
|
+
# member_arn: "ChimeArn", # required
|
|
1429
|
+
# chime_bearer: "ChimeArn", # required
|
|
1430
|
+
# })
|
|
1431
|
+
#
|
|
1432
|
+
# @example Response structure
|
|
1433
|
+
#
|
|
1434
|
+
# resp.channel_arn #=> String
|
|
1435
|
+
# resp.member.arn #=> String
|
|
1436
|
+
# resp.member.name #=> String
|
|
1437
|
+
# resp.preferences.push_notifications.allow_notifications #=> String, one of "ALL", "NONE", "FILTERED"
|
|
1438
|
+
# resp.preferences.push_notifications.filter_rule #=> String
|
|
1439
|
+
#
|
|
1440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferences AWS API Documentation
|
|
1441
|
+
#
|
|
1442
|
+
# @overload get_channel_membership_preferences(params = {})
|
|
1443
|
+
# @param [Hash] params ({})
|
|
1444
|
+
def get_channel_membership_preferences(params = {}, options = {})
|
|
1445
|
+
req = build_request(:get_channel_membership_preferences, params)
|
|
1446
|
+
req.send_request(options)
|
|
1447
|
+
end
|
|
1448
|
+
|
|
1399
1449
|
# Gets the full details of a channel message.
|
|
1400
1450
|
#
|
|
1401
1451
|
# <note markdown="1"> The x-amz-chime-bearer request header is mandatory. Use the
|
|
@@ -1441,6 +1491,9 @@ module Aws::ChimeSDKMessaging
|
|
|
1441
1491
|
# resp.channel_message.persistence #=> String, one of "PERSISTENT", "NON_PERSISTENT"
|
|
1442
1492
|
# resp.channel_message.status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
|
1443
1493
|
# resp.channel_message.status.detail #=> String
|
|
1494
|
+
# resp.channel_message.message_attributes #=> Hash
|
|
1495
|
+
# resp.channel_message.message_attributes["MessageAttributeName"].string_values #=> Array
|
|
1496
|
+
# resp.channel_message.message_attributes["MessageAttributeName"].string_values[0] #=> String
|
|
1444
1497
|
#
|
|
1445
1498
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessage AWS API Documentation
|
|
1446
1499
|
#
|
|
@@ -1653,6 +1706,13 @@ module Aws::ChimeSDKMessaging
|
|
|
1653
1706
|
#
|
|
1654
1707
|
# </note>
|
|
1655
1708
|
#
|
|
1709
|
+
# If you want to list the channels to which a specific app instance user
|
|
1710
|
+
# belongs, see the [ListChannelMembershipsForAppInstanceUser][1] API.
|
|
1711
|
+
#
|
|
1712
|
+
#
|
|
1713
|
+
#
|
|
1714
|
+
# [1]: https://docs.aws.amazon.com/chime/latest/APIReference/API_messaging-chime_ListChannelMembershipsForAppInstanceUser.html
|
|
1715
|
+
#
|
|
1656
1716
|
# @option params [required, String] :channel_arn
|
|
1657
1717
|
# The maximum number of channel memberships that you want returned.
|
|
1658
1718
|
#
|
|
@@ -1843,6 +1903,9 @@ module Aws::ChimeSDKMessaging
|
|
|
1843
1903
|
# resp.channel_messages[0].redacted #=> Boolean
|
|
1844
1904
|
# resp.channel_messages[0].status.value #=> String, one of "SENT", "PENDING", "FAILED", "DENIED"
|
|
1845
1905
|
# resp.channel_messages[0].status.detail #=> String
|
|
1906
|
+
# resp.channel_messages[0].message_attributes #=> Hash
|
|
1907
|
+
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values #=> Array
|
|
1908
|
+
# resp.channel_messages[0].message_attributes["MessageAttributeName"].string_values[0] #=> String
|
|
1846
1909
|
#
|
|
1847
1910
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelMessages AWS API Documentation
|
|
1848
1911
|
#
|
|
@@ -2115,6 +2178,62 @@ module Aws::ChimeSDKMessaging
|
|
|
2115
2178
|
req.send_request(options)
|
|
2116
2179
|
end
|
|
2117
2180
|
|
|
2181
|
+
# Sets the membership preferences of an `AppInstanceUser` for the
|
|
2182
|
+
# specified channel. The `AppInstanceUser` must be a member of the
|
|
2183
|
+
# channel. Only the `AppInstanceUser` who owns the membership can set
|
|
2184
|
+
# preferences. Users in the `AppInstanceAdmin` and channel moderator
|
|
2185
|
+
# roles can't set preferences for other users. Banned users can't set
|
|
2186
|
+
# membership preferences for the channel from which they are banned.
|
|
2187
|
+
#
|
|
2188
|
+
# @option params [required, String] :channel_arn
|
|
2189
|
+
# The ARN of the channel.
|
|
2190
|
+
#
|
|
2191
|
+
# @option params [required, String] :member_arn
|
|
2192
|
+
# The `AppInstanceUserArn` of the member setting the preferences.
|
|
2193
|
+
#
|
|
2194
|
+
# @option params [required, String] :chime_bearer
|
|
2195
|
+
# The `AppInstanceUserARN` of the user making the API call.
|
|
2196
|
+
#
|
|
2197
|
+
# @option params [required, Types::ChannelMembershipPreferences] :preferences
|
|
2198
|
+
# The channel membership preferences of an `AppInstanceUser` .
|
|
2199
|
+
#
|
|
2200
|
+
# @return [Types::PutChannelMembershipPreferencesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2201
|
+
#
|
|
2202
|
+
# * {Types::PutChannelMembershipPreferencesResponse#channel_arn #channel_arn} => String
|
|
2203
|
+
# * {Types::PutChannelMembershipPreferencesResponse#member #member} => Types::Identity
|
|
2204
|
+
# * {Types::PutChannelMembershipPreferencesResponse#preferences #preferences} => Types::ChannelMembershipPreferences
|
|
2205
|
+
#
|
|
2206
|
+
# @example Request syntax with placeholder values
|
|
2207
|
+
#
|
|
2208
|
+
# resp = client.put_channel_membership_preferences({
|
|
2209
|
+
# channel_arn: "ChimeArn", # required
|
|
2210
|
+
# member_arn: "ChimeArn", # required
|
|
2211
|
+
# chime_bearer: "ChimeArn", # required
|
|
2212
|
+
# preferences: { # required
|
|
2213
|
+
# push_notifications: {
|
|
2214
|
+
# allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
|
|
2215
|
+
# filter_rule: "FilterRule",
|
|
2216
|
+
# },
|
|
2217
|
+
# },
|
|
2218
|
+
# })
|
|
2219
|
+
#
|
|
2220
|
+
# @example Response structure
|
|
2221
|
+
#
|
|
2222
|
+
# resp.channel_arn #=> String
|
|
2223
|
+
# resp.member.arn #=> String
|
|
2224
|
+
# resp.member.name #=> String
|
|
2225
|
+
# resp.preferences.push_notifications.allow_notifications #=> String, one of "ALL", "NONE", "FILTERED"
|
|
2226
|
+
# resp.preferences.push_notifications.filter_rule #=> String
|
|
2227
|
+
#
|
|
2228
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferences AWS API Documentation
|
|
2229
|
+
#
|
|
2230
|
+
# @overload put_channel_membership_preferences(params = {})
|
|
2231
|
+
# @param [Hash] params ({})
|
|
2232
|
+
def put_channel_membership_preferences(params = {}, options = {})
|
|
2233
|
+
req = build_request(:put_channel_membership_preferences, params)
|
|
2234
|
+
req.send_request(options)
|
|
2235
|
+
end
|
|
2236
|
+
|
|
2118
2237
|
# Redacts message content, but not metadata. The message exists in the
|
|
2119
2238
|
# back end, but the action returns null content, and the state shows as
|
|
2120
2239
|
# redacted.
|
|
@@ -2199,6 +2318,13 @@ module Aws::ChimeSDKMessaging
|
|
|
2199
2318
|
# @option params [required, String] :chime_bearer
|
|
2200
2319
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
2201
2320
|
#
|
|
2321
|
+
# @option params [Types::PushNotificationConfiguration] :push_notification
|
|
2322
|
+
# The push notification configuration of the message.
|
|
2323
|
+
#
|
|
2324
|
+
# @option params [Hash<String,Types::MessageAttributeValue>] :message_attributes
|
|
2325
|
+
# The attributes for the message, used for message filtering along with
|
|
2326
|
+
# a `FilterRule` defined in the `PushNotificationPreferences`.
|
|
2327
|
+
#
|
|
2202
2328
|
# @return [Types::SendChannelMessageResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2203
2329
|
#
|
|
2204
2330
|
# * {Types::SendChannelMessageResponse#channel_arn #channel_arn} => String
|
|
@@ -2215,6 +2341,16 @@ module Aws::ChimeSDKMessaging
|
|
|
2215
2341
|
# metadata: "Metadata",
|
|
2216
2342
|
# client_request_token: "ClientRequestToken", # required
|
|
2217
2343
|
# chime_bearer: "ChimeArn", # required
|
|
2344
|
+
# push_notification: {
|
|
2345
|
+
# title: "PushNotificationTitle", # required
|
|
2346
|
+
# body: "PushNotificationBody", # required
|
|
2347
|
+
# type: "DEFAULT", # required, accepts DEFAULT, VOIP
|
|
2348
|
+
# },
|
|
2349
|
+
# message_attributes: {
|
|
2350
|
+
# "MessageAttributeName" => {
|
|
2351
|
+
# string_values: ["MessageAttributeStringValue"],
|
|
2352
|
+
# },
|
|
2353
|
+
# },
|
|
2218
2354
|
# })
|
|
2219
2355
|
#
|
|
2220
2356
|
# @example Response structure
|
|
@@ -2498,7 +2634,7 @@ module Aws::ChimeSDKMessaging
|
|
|
2498
2634
|
params: params,
|
|
2499
2635
|
config: config)
|
|
2500
2636
|
context[:gem_name] = 'aws-sdk-chimesdkmessaging'
|
|
2501
|
-
context[:gem_version] = '1.
|
|
2637
|
+
context[:gem_version] = '1.5.0'
|
|
2502
2638
|
Seahorse::Client::Request.new(handlers, context)
|
|
2503
2639
|
end
|
|
2504
2640
|
|
|
@@ -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,6 +313,7 @@ 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"))
|
|
@@ -314,6 +335,7 @@ module Aws::ChimeSDKMessaging
|
|
|
314
335
|
ChannelMessageSummary.add_member(:sender, Shapes::ShapeRef.new(shape: Identity, location_name: "Sender"))
|
|
315
336
|
ChannelMessageSummary.add_member(:redacted, Shapes::ShapeRef.new(shape: NonNullableBoolean, location_name: "Redacted"))
|
|
316
337
|
ChannelMessageSummary.add_member(:status, Shapes::ShapeRef.new(shape: ChannelMessageStatusStructure, location_name: "Status"))
|
|
338
|
+
ChannelMessageSummary.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
|
|
317
339
|
ChannelMessageSummary.struct_class = Types::ChannelMessageSummary
|
|
318
340
|
|
|
319
341
|
ChannelMessageSummaryList.member = Shapes::ShapeRef.new(shape: ChannelMessageSummary)
|
|
@@ -488,6 +510,16 @@ module Aws::ChimeSDKMessaging
|
|
|
488
510
|
ForbiddenException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
|
|
489
511
|
ForbiddenException.struct_class = Types::ForbiddenException
|
|
490
512
|
|
|
513
|
+
GetChannelMembershipPreferencesRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
|
|
514
|
+
GetChannelMembershipPreferencesRequest.add_member(:member_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "memberArn"))
|
|
515
|
+
GetChannelMembershipPreferencesRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
|
|
516
|
+
GetChannelMembershipPreferencesRequest.struct_class = Types::GetChannelMembershipPreferencesRequest
|
|
517
|
+
|
|
518
|
+
GetChannelMembershipPreferencesResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
|
|
519
|
+
GetChannelMembershipPreferencesResponse.add_member(:member, Shapes::ShapeRef.new(shape: Identity, location_name: "Member"))
|
|
520
|
+
GetChannelMembershipPreferencesResponse.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, location_name: "Preferences"))
|
|
521
|
+
GetChannelMembershipPreferencesResponse.struct_class = Types::GetChannelMembershipPreferencesResponse
|
|
522
|
+
|
|
491
523
|
GetChannelMessageRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
|
|
492
524
|
GetChannelMessageRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location: "uri", location_name: "messageId"))
|
|
493
525
|
GetChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
|
|
@@ -624,6 +656,14 @@ module Aws::ChimeSDKMessaging
|
|
|
624
656
|
|
|
625
657
|
Members.member = Shapes::ShapeRef.new(shape: Identity)
|
|
626
658
|
|
|
659
|
+
MessageAttributeMap.key = Shapes::ShapeRef.new(shape: MessageAttributeName)
|
|
660
|
+
MessageAttributeMap.value = Shapes::ShapeRef.new(shape: MessageAttributeValue)
|
|
661
|
+
|
|
662
|
+
MessageAttributeStringValues.member = Shapes::ShapeRef.new(shape: MessageAttributeStringValue)
|
|
663
|
+
|
|
664
|
+
MessageAttributeValue.add_member(:string_values, Shapes::ShapeRef.new(shape: MessageAttributeStringValues, location_name: "StringValues"))
|
|
665
|
+
MessageAttributeValue.struct_class = Types::MessageAttributeValue
|
|
666
|
+
|
|
627
667
|
MessagingSessionEndpoint.add_member(:url, Shapes::ShapeRef.new(shape: UrlType, location_name: "Url"))
|
|
628
668
|
MessagingSessionEndpoint.struct_class = Types::MessagingSessionEndpoint
|
|
629
669
|
|
|
@@ -642,6 +682,26 @@ module Aws::ChimeSDKMessaging
|
|
|
642
682
|
|
|
643
683
|
ProcessorList.member = Shapes::ShapeRef.new(shape: Processor)
|
|
644
684
|
|
|
685
|
+
PushNotificationConfiguration.add_member(:title, Shapes::ShapeRef.new(shape: PushNotificationTitle, required: true, location_name: "Title"))
|
|
686
|
+
PushNotificationConfiguration.add_member(:body, Shapes::ShapeRef.new(shape: PushNotificationBody, required: true, location_name: "Body"))
|
|
687
|
+
PushNotificationConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: PushNotificationType, required: true, location_name: "Type"))
|
|
688
|
+
PushNotificationConfiguration.struct_class = Types::PushNotificationConfiguration
|
|
689
|
+
|
|
690
|
+
PushNotificationPreferences.add_member(:allow_notifications, Shapes::ShapeRef.new(shape: AllowNotifications, required: true, location_name: "AllowNotifications"))
|
|
691
|
+
PushNotificationPreferences.add_member(:filter_rule, Shapes::ShapeRef.new(shape: FilterRule, location_name: "FilterRule"))
|
|
692
|
+
PushNotificationPreferences.struct_class = Types::PushNotificationPreferences
|
|
693
|
+
|
|
694
|
+
PutChannelMembershipPreferencesRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
|
|
695
|
+
PutChannelMembershipPreferencesRequest.add_member(:member_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "memberArn"))
|
|
696
|
+
PutChannelMembershipPreferencesRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
|
|
697
|
+
PutChannelMembershipPreferencesRequest.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, required: true, location_name: "Preferences"))
|
|
698
|
+
PutChannelMembershipPreferencesRequest.struct_class = Types::PutChannelMembershipPreferencesRequest
|
|
699
|
+
|
|
700
|
+
PutChannelMembershipPreferencesResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
|
|
701
|
+
PutChannelMembershipPreferencesResponse.add_member(:member, Shapes::ShapeRef.new(shape: Identity, location_name: "Member"))
|
|
702
|
+
PutChannelMembershipPreferencesResponse.add_member(:preferences, Shapes::ShapeRef.new(shape: ChannelMembershipPreferences, location_name: "Preferences"))
|
|
703
|
+
PutChannelMembershipPreferencesResponse.struct_class = Types::PutChannelMembershipPreferencesResponse
|
|
704
|
+
|
|
645
705
|
RedactChannelMessageRequest.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "uri", location_name: "channelArn"))
|
|
646
706
|
RedactChannelMessageRequest.add_member(:message_id, Shapes::ShapeRef.new(shape: MessageId, required: true, location: "uri", location_name: "messageId"))
|
|
647
707
|
RedactChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
|
|
@@ -662,6 +722,8 @@ module Aws::ChimeSDKMessaging
|
|
|
662
722
|
SendChannelMessageRequest.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "Metadata"))
|
|
663
723
|
SendChannelMessageRequest.add_member(:client_request_token, Shapes::ShapeRef.new(shape: ClientRequestToken, required: true, location_name: "ClientRequestToken", metadata: {"idempotencyToken"=>true}))
|
|
664
724
|
SendChannelMessageRequest.add_member(:chime_bearer, Shapes::ShapeRef.new(shape: ChimeArn, required: true, location: "header", location_name: "x-amz-chime-bearer"))
|
|
725
|
+
SendChannelMessageRequest.add_member(:push_notification, Shapes::ShapeRef.new(shape: PushNotificationConfiguration, location_name: "PushNotification"))
|
|
726
|
+
SendChannelMessageRequest.add_member(:message_attributes, Shapes::ShapeRef.new(shape: MessageAttributeMap, location_name: "MessageAttributes"))
|
|
665
727
|
SendChannelMessageRequest.struct_class = Types::SendChannelMessageRequest
|
|
666
728
|
|
|
667
729
|
SendChannelMessageResponse.add_member(:channel_arn, Shapes::ShapeRef.new(shape: ChimeArn, location_name: "ChannelArn"))
|
|
@@ -1083,6 +1145,20 @@ module Aws::ChimeSDKMessaging
|
|
|
1083
1145
|
o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
|
|
1084
1146
|
end)
|
|
1085
1147
|
|
|
1148
|
+
api.add_operation(:get_channel_membership_preferences, Seahorse::Model::Operation.new.tap do |o|
|
|
1149
|
+
o.name = "GetChannelMembershipPreferences"
|
|
1150
|
+
o.http_method = "GET"
|
|
1151
|
+
o.http_request_uri = "/channels/{channelArn}/memberships/{memberArn}/preferences"
|
|
1152
|
+
o.input = Shapes::ShapeRef.new(shape: GetChannelMembershipPreferencesRequest)
|
|
1153
|
+
o.output = Shapes::ShapeRef.new(shape: GetChannelMembershipPreferencesResponse)
|
|
1154
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
|
1155
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedClientException)
|
|
1156
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
1157
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottledClientException)
|
|
1158
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
|
1159
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
|
|
1160
|
+
end)
|
|
1161
|
+
|
|
1086
1162
|
api.add_operation(:get_channel_message, Seahorse::Model::Operation.new.tap do |o|
|
|
1087
1163
|
o.name = "GetChannelMessage"
|
|
1088
1164
|
o.http_method = "GET"
|
|
@@ -1319,6 +1395,21 @@ module Aws::ChimeSDKMessaging
|
|
|
1319
1395
|
o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
|
|
1320
1396
|
end)
|
|
1321
1397
|
|
|
1398
|
+
api.add_operation(:put_channel_membership_preferences, Seahorse::Model::Operation.new.tap do |o|
|
|
1399
|
+
o.name = "PutChannelMembershipPreferences"
|
|
1400
|
+
o.http_method = "PUT"
|
|
1401
|
+
o.http_request_uri = "/channels/{channelArn}/memberships/{memberArn}/preferences"
|
|
1402
|
+
o.input = Shapes::ShapeRef.new(shape: PutChannelMembershipPreferencesRequest)
|
|
1403
|
+
o.output = Shapes::ShapeRef.new(shape: PutChannelMembershipPreferencesResponse)
|
|
1404
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
|
1405
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
|
1406
|
+
o.errors << Shapes::ShapeRef.new(shape: UnauthorizedClientException)
|
|
1407
|
+
o.errors << Shapes::ShapeRef.new(shape: ForbiddenException)
|
|
1408
|
+
o.errors << Shapes::ShapeRef.new(shape: ThrottledClientException)
|
|
1409
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceUnavailableException)
|
|
1410
|
+
o.errors << Shapes::ShapeRef.new(shape: ServiceFailureException)
|
|
1411
|
+
end)
|
|
1412
|
+
|
|
1322
1413
|
api.add_operation(:redact_channel_message, Seahorse::Model::Operation.new.tap do |o|
|
|
1323
1414
|
o.name = "RedactChannelMessage"
|
|
1324
1415
|
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
|
|
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
|
|
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
|
|
@@ -506,6 +508,30 @@ module Aws::ChimeSDKMessaging
|
|
|
506
508
|
include Aws::Structure
|
|
507
509
|
end
|
|
508
510
|
|
|
511
|
+
# The channel membership preferences for an `AppInstanceUser`.
|
|
512
|
+
#
|
|
513
|
+
# @note When making an API call, you may pass ChannelMembershipPreferences
|
|
514
|
+
# data as a hash:
|
|
515
|
+
#
|
|
516
|
+
# {
|
|
517
|
+
# push_notifications: {
|
|
518
|
+
# allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
|
|
519
|
+
# filter_rule: "FilterRule",
|
|
520
|
+
# },
|
|
521
|
+
# }
|
|
522
|
+
#
|
|
523
|
+
# @!attribute [rw] push_notifications
|
|
524
|
+
# The push notification configuration of a message.
|
|
525
|
+
# @return [Types::PushNotificationPreferences]
|
|
526
|
+
#
|
|
527
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMembershipPreferences AWS API Documentation
|
|
528
|
+
#
|
|
529
|
+
class ChannelMembershipPreferences < Struct.new(
|
|
530
|
+
:push_notifications)
|
|
531
|
+
SENSITIVE = []
|
|
532
|
+
include Aws::Structure
|
|
533
|
+
end
|
|
534
|
+
|
|
509
535
|
# Summary of the details of a `ChannelMembership`.
|
|
510
536
|
#
|
|
511
537
|
# @!attribute [rw] member
|
|
@@ -570,6 +596,11 @@ module Aws::ChimeSDKMessaging
|
|
|
570
596
|
# The status of the channel message.
|
|
571
597
|
# @return [Types::ChannelMessageStatusStructure]
|
|
572
598
|
#
|
|
599
|
+
# @!attribute [rw] message_attributes
|
|
600
|
+
# The attributes for the message, used for message filtering along
|
|
601
|
+
# with a `FilterRule` defined in the `PushNotificationPreferences`.
|
|
602
|
+
# @return [Hash<String,Types::MessageAttributeValue>]
|
|
603
|
+
#
|
|
573
604
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
|
|
574
605
|
#
|
|
575
606
|
class ChannelMessage < Struct.new(
|
|
@@ -584,7 +615,8 @@ module Aws::ChimeSDKMessaging
|
|
|
584
615
|
:sender,
|
|
585
616
|
:redacted,
|
|
586
617
|
:persistence,
|
|
587
|
-
:status
|
|
618
|
+
:status,
|
|
619
|
+
:message_attributes)
|
|
588
620
|
SENSITIVE = [:content, :metadata]
|
|
589
621
|
include Aws::Structure
|
|
590
622
|
end
|
|
@@ -685,6 +717,10 @@ module Aws::ChimeSDKMessaging
|
|
|
685
717
|
# channel flow, the value determines the processing stage.
|
|
686
718
|
# @return [Types::ChannelMessageStatusStructure]
|
|
687
719
|
#
|
|
720
|
+
# @!attribute [rw] message_attributes
|
|
721
|
+
# The message attribues listed in a the summary of a channel message.
|
|
722
|
+
# @return [Hash<String,Types::MessageAttributeValue>]
|
|
723
|
+
#
|
|
688
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageSummary AWS API Documentation
|
|
689
725
|
#
|
|
690
726
|
class ChannelMessageSummary < Struct.new(
|
|
@@ -697,7 +733,8 @@ module Aws::ChimeSDKMessaging
|
|
|
697
733
|
:last_edited_timestamp,
|
|
698
734
|
:sender,
|
|
699
735
|
:redacted,
|
|
700
|
-
:status
|
|
736
|
+
:status,
|
|
737
|
+
:message_attributes)
|
|
701
738
|
SENSITIVE = [:content, :metadata]
|
|
702
739
|
include Aws::Structure
|
|
703
740
|
end
|
|
@@ -830,7 +867,7 @@ module Aws::ChimeSDKMessaging
|
|
|
830
867
|
# @return [String]
|
|
831
868
|
#
|
|
832
869
|
# @!attribute [rw] member_arn
|
|
833
|
-
# The
|
|
870
|
+
# The `AppInstanceUserArn` of the member being banned.
|
|
834
871
|
# @return [String]
|
|
835
872
|
#
|
|
836
873
|
# @!attribute [rw] chime_bearer
|
|
@@ -952,7 +989,8 @@ module Aws::ChimeSDKMessaging
|
|
|
952
989
|
# @return [String]
|
|
953
990
|
#
|
|
954
991
|
# @!attribute [rw] member_arn
|
|
955
|
-
# The
|
|
992
|
+
# The `AppInstanceUserArn` of the member you want to add to the
|
|
993
|
+
# channel.
|
|
956
994
|
# @return [String]
|
|
957
995
|
#
|
|
958
996
|
# @!attribute [rw] type
|
|
@@ -1009,7 +1047,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1009
1047
|
# @return [String]
|
|
1010
1048
|
#
|
|
1011
1049
|
# @!attribute [rw] channel_moderator_arn
|
|
1012
|
-
# The
|
|
1050
|
+
# The `AppInstanceUserArn` of the moderator.
|
|
1013
1051
|
# @return [String]
|
|
1014
1052
|
#
|
|
1015
1053
|
# @!attribute [rw] chime_bearer
|
|
@@ -1193,7 +1231,8 @@ module Aws::ChimeSDKMessaging
|
|
|
1193
1231
|
# @return [String]
|
|
1194
1232
|
#
|
|
1195
1233
|
# @!attribute [rw] member_arn
|
|
1196
|
-
# The
|
|
1234
|
+
# The `AppInstanceUserArn` of the member that you're removing from
|
|
1235
|
+
# the channel.
|
|
1197
1236
|
# @return [String]
|
|
1198
1237
|
#
|
|
1199
1238
|
# @!attribute [rw] chime_bearer
|
|
@@ -1255,7 +1294,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1255
1294
|
# @return [String]
|
|
1256
1295
|
#
|
|
1257
1296
|
# @!attribute [rw] channel_moderator_arn
|
|
1258
|
-
# The
|
|
1297
|
+
# The `AppInstanceUserArn` of the moderator being deleted.
|
|
1259
1298
|
# @return [String]
|
|
1260
1299
|
#
|
|
1261
1300
|
# @!attribute [rw] chime_bearer
|
|
@@ -1311,7 +1350,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1311
1350
|
# @return [String]
|
|
1312
1351
|
#
|
|
1313
1352
|
# @!attribute [rw] member_arn
|
|
1314
|
-
# The
|
|
1353
|
+
# The `AppInstanceUserArn` of the member being banned.
|
|
1315
1354
|
# @return [String]
|
|
1316
1355
|
#
|
|
1317
1356
|
# @!attribute [rw] chime_bearer
|
|
@@ -1428,7 +1467,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1428
1467
|
# @return [String]
|
|
1429
1468
|
#
|
|
1430
1469
|
# @!attribute [rw] member_arn
|
|
1431
|
-
# The
|
|
1470
|
+
# The `AppInstanceUserArn` of the member.
|
|
1432
1471
|
# @return [String]
|
|
1433
1472
|
#
|
|
1434
1473
|
# @!attribute [rw] chime_bearer
|
|
@@ -1514,7 +1553,7 @@ module Aws::ChimeSDKMessaging
|
|
|
1514
1553
|
# @return [String]
|
|
1515
1554
|
#
|
|
1516
1555
|
# @!attribute [rw] channel_moderator_arn
|
|
1517
|
-
# The
|
|
1556
|
+
# The `AppInstanceUserArn` of the channel moderator.
|
|
1518
1557
|
# @return [String]
|
|
1519
1558
|
#
|
|
1520
1559
|
# @!attribute [rw] chime_bearer
|
|
@@ -1628,6 +1667,59 @@ module Aws::ChimeSDKMessaging
|
|
|
1628
1667
|
include Aws::Structure
|
|
1629
1668
|
end
|
|
1630
1669
|
|
|
1670
|
+
# @note When making an API call, you may pass GetChannelMembershipPreferencesRequest
|
|
1671
|
+
# data as a hash:
|
|
1672
|
+
#
|
|
1673
|
+
# {
|
|
1674
|
+
# channel_arn: "ChimeArn", # required
|
|
1675
|
+
# member_arn: "ChimeArn", # required
|
|
1676
|
+
# chime_bearer: "ChimeArn", # required
|
|
1677
|
+
# }
|
|
1678
|
+
#
|
|
1679
|
+
# @!attribute [rw] channel_arn
|
|
1680
|
+
# The ARN of the channel.
|
|
1681
|
+
# @return [String]
|
|
1682
|
+
#
|
|
1683
|
+
# @!attribute [rw] member_arn
|
|
1684
|
+
# The `AppInstanceUserArn` of the member retrieving the preferences.
|
|
1685
|
+
# @return [String]
|
|
1686
|
+
#
|
|
1687
|
+
# @!attribute [rw] chime_bearer
|
|
1688
|
+
# The `AppInstanceUserARN` of the user making the API call.
|
|
1689
|
+
# @return [String]
|
|
1690
|
+
#
|
|
1691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferencesRequest AWS API Documentation
|
|
1692
|
+
#
|
|
1693
|
+
class GetChannelMembershipPreferencesRequest < Struct.new(
|
|
1694
|
+
:channel_arn,
|
|
1695
|
+
:member_arn,
|
|
1696
|
+
:chime_bearer)
|
|
1697
|
+
SENSITIVE = []
|
|
1698
|
+
include Aws::Structure
|
|
1699
|
+
end
|
|
1700
|
+
|
|
1701
|
+
# @!attribute [rw] channel_arn
|
|
1702
|
+
# The ARN of the channel.
|
|
1703
|
+
# @return [String]
|
|
1704
|
+
#
|
|
1705
|
+
# @!attribute [rw] member
|
|
1706
|
+
# The details of a user.
|
|
1707
|
+
# @return [Types::Identity]
|
|
1708
|
+
#
|
|
1709
|
+
# @!attribute [rw] preferences
|
|
1710
|
+
# The channel membership preferences for an `AppInstanceUser` .
|
|
1711
|
+
# @return [Types::ChannelMembershipPreferences]
|
|
1712
|
+
#
|
|
1713
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMembershipPreferencesResponse AWS API Documentation
|
|
1714
|
+
#
|
|
1715
|
+
class GetChannelMembershipPreferencesResponse < Struct.new(
|
|
1716
|
+
:channel_arn,
|
|
1717
|
+
:member,
|
|
1718
|
+
:preferences)
|
|
1719
|
+
SENSITIVE = []
|
|
1720
|
+
include Aws::Structure
|
|
1721
|
+
end
|
|
1722
|
+
|
|
1631
1723
|
# @note When making an API call, you may pass GetChannelMessageRequest
|
|
1632
1724
|
# data as a hash:
|
|
1633
1725
|
#
|
|
@@ -2359,6 +2451,27 @@ module Aws::ChimeSDKMessaging
|
|
|
2359
2451
|
include Aws::Structure
|
|
2360
2452
|
end
|
|
2361
2453
|
|
|
2454
|
+
# A list of message attribute values.
|
|
2455
|
+
#
|
|
2456
|
+
# @note When making an API call, you may pass MessageAttributeValue
|
|
2457
|
+
# data as a hash:
|
|
2458
|
+
#
|
|
2459
|
+
# {
|
|
2460
|
+
# string_values: ["MessageAttributeStringValue"],
|
|
2461
|
+
# }
|
|
2462
|
+
#
|
|
2463
|
+
# @!attribute [rw] string_values
|
|
2464
|
+
# The strings in a message attribute value.
|
|
2465
|
+
# @return [Array<String>]
|
|
2466
|
+
#
|
|
2467
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/MessageAttributeValue AWS API Documentation
|
|
2468
|
+
#
|
|
2469
|
+
class MessageAttributeValue < Struct.new(
|
|
2470
|
+
:string_values)
|
|
2471
|
+
SENSITIVE = []
|
|
2472
|
+
include Aws::Structure
|
|
2473
|
+
end
|
|
2474
|
+
|
|
2362
2475
|
# The websocket endpoint used to connect to Amazon Chime SDK messaging.
|
|
2363
2476
|
#
|
|
2364
2477
|
# @!attribute [rw] url
|
|
@@ -2424,11 +2537,14 @@ module Aws::ChimeSDKMessaging
|
|
|
2424
2537
|
# @return [Integer]
|
|
2425
2538
|
#
|
|
2426
2539
|
# @!attribute [rw] fallback_action
|
|
2427
|
-
# Determines whether to continue or stop
|
|
2428
|
-
# with processor fails. If
|
|
2429
|
-
#
|
|
2430
|
-
#
|
|
2431
|
-
#
|
|
2540
|
+
# Determines whether to continue with message processing or stop it in
|
|
2541
|
+
# cases where communication with a processor fails. If a processor has
|
|
2542
|
+
# a fallback action of `ABORT` and communication with it fails, the
|
|
2543
|
+
# processor sets the message status to `FAILED` and does not send the
|
|
2544
|
+
# message to any recipients. Note that if the last processor in the
|
|
2545
|
+
# channel flow sequence has a fallback action of `CONTINUE` and
|
|
2546
|
+
# communication with the processor fails, then the message is
|
|
2547
|
+
# considered processed and sent to recipients of the channel.
|
|
2432
2548
|
# @return [String]
|
|
2433
2549
|
#
|
|
2434
2550
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Processor AWS API Documentation
|
|
@@ -2466,6 +2582,136 @@ module Aws::ChimeSDKMessaging
|
|
|
2466
2582
|
include Aws::Structure
|
|
2467
2583
|
end
|
|
2468
2584
|
|
|
2585
|
+
# The push notification configuration of the message.
|
|
2586
|
+
#
|
|
2587
|
+
# @note When making an API call, you may pass PushNotificationConfiguration
|
|
2588
|
+
# data as a hash:
|
|
2589
|
+
#
|
|
2590
|
+
# {
|
|
2591
|
+
# title: "PushNotificationTitle", # required
|
|
2592
|
+
# body: "PushNotificationBody", # required
|
|
2593
|
+
# type: "DEFAULT", # required, accepts DEFAULT, VOIP
|
|
2594
|
+
# }
|
|
2595
|
+
#
|
|
2596
|
+
# @!attribute [rw] title
|
|
2597
|
+
# The title of the push notification.
|
|
2598
|
+
# @return [String]
|
|
2599
|
+
#
|
|
2600
|
+
# @!attribute [rw] body
|
|
2601
|
+
# The body of the push notification.
|
|
2602
|
+
# @return [String]
|
|
2603
|
+
#
|
|
2604
|
+
# @!attribute [rw] type
|
|
2605
|
+
# Enum value that indicates the type of the push notification for a
|
|
2606
|
+
# message. `DEFAULT`\: Normal mobile push notification. `VOIP`\: VOIP
|
|
2607
|
+
# mobile push notification.
|
|
2608
|
+
# @return [String]
|
|
2609
|
+
#
|
|
2610
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PushNotificationConfiguration AWS API Documentation
|
|
2611
|
+
#
|
|
2612
|
+
class PushNotificationConfiguration < Struct.new(
|
|
2613
|
+
:title,
|
|
2614
|
+
:body,
|
|
2615
|
+
:type)
|
|
2616
|
+
SENSITIVE = [:title, :body]
|
|
2617
|
+
include Aws::Structure
|
|
2618
|
+
end
|
|
2619
|
+
|
|
2620
|
+
# The channel membership preferences for push notification.
|
|
2621
|
+
#
|
|
2622
|
+
# @note When making an API call, you may pass PushNotificationPreferences
|
|
2623
|
+
# data as a hash:
|
|
2624
|
+
#
|
|
2625
|
+
# {
|
|
2626
|
+
# allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
|
|
2627
|
+
# filter_rule: "FilterRule",
|
|
2628
|
+
# }
|
|
2629
|
+
#
|
|
2630
|
+
# @!attribute [rw] allow_notifications
|
|
2631
|
+
# Enum value that indicates which push notifications to send to the
|
|
2632
|
+
# requested member of a channel. `ALL` sends all push notifications,
|
|
2633
|
+
# `NONE` sends no push notifications, `FILTERED` sends only filtered
|
|
2634
|
+
# push notifications.
|
|
2635
|
+
# @return [String]
|
|
2636
|
+
#
|
|
2637
|
+
# @!attribute [rw] filter_rule
|
|
2638
|
+
# The simple JSON object used to send a subset of a push notification
|
|
2639
|
+
# to the requsted member.
|
|
2640
|
+
# @return [String]
|
|
2641
|
+
#
|
|
2642
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PushNotificationPreferences AWS API Documentation
|
|
2643
|
+
#
|
|
2644
|
+
class PushNotificationPreferences < Struct.new(
|
|
2645
|
+
:allow_notifications,
|
|
2646
|
+
:filter_rule)
|
|
2647
|
+
SENSITIVE = [:filter_rule]
|
|
2648
|
+
include Aws::Structure
|
|
2649
|
+
end
|
|
2650
|
+
|
|
2651
|
+
# @note When making an API call, you may pass PutChannelMembershipPreferencesRequest
|
|
2652
|
+
# data as a hash:
|
|
2653
|
+
#
|
|
2654
|
+
# {
|
|
2655
|
+
# channel_arn: "ChimeArn", # required
|
|
2656
|
+
# member_arn: "ChimeArn", # required
|
|
2657
|
+
# chime_bearer: "ChimeArn", # required
|
|
2658
|
+
# preferences: { # required
|
|
2659
|
+
# push_notifications: {
|
|
2660
|
+
# allow_notifications: "ALL", # required, accepts ALL, NONE, FILTERED
|
|
2661
|
+
# filter_rule: "FilterRule",
|
|
2662
|
+
# },
|
|
2663
|
+
# },
|
|
2664
|
+
# }
|
|
2665
|
+
#
|
|
2666
|
+
# @!attribute [rw] channel_arn
|
|
2667
|
+
# The ARN of the channel.
|
|
2668
|
+
# @return [String]
|
|
2669
|
+
#
|
|
2670
|
+
# @!attribute [rw] member_arn
|
|
2671
|
+
# The `AppInstanceUserArn` of the member setting the preferences.
|
|
2672
|
+
# @return [String]
|
|
2673
|
+
#
|
|
2674
|
+
# @!attribute [rw] chime_bearer
|
|
2675
|
+
# The `AppInstanceUserARN` of the user making the API call.
|
|
2676
|
+
# @return [String]
|
|
2677
|
+
#
|
|
2678
|
+
# @!attribute [rw] preferences
|
|
2679
|
+
# The channel membership preferences of an `AppInstanceUser` .
|
|
2680
|
+
# @return [Types::ChannelMembershipPreferences]
|
|
2681
|
+
#
|
|
2682
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferencesRequest AWS API Documentation
|
|
2683
|
+
#
|
|
2684
|
+
class PutChannelMembershipPreferencesRequest < Struct.new(
|
|
2685
|
+
:channel_arn,
|
|
2686
|
+
:member_arn,
|
|
2687
|
+
:chime_bearer,
|
|
2688
|
+
:preferences)
|
|
2689
|
+
SENSITIVE = []
|
|
2690
|
+
include Aws::Structure
|
|
2691
|
+
end
|
|
2692
|
+
|
|
2693
|
+
# @!attribute [rw] channel_arn
|
|
2694
|
+
# The ARN of the channel.
|
|
2695
|
+
# @return [String]
|
|
2696
|
+
#
|
|
2697
|
+
# @!attribute [rw] member
|
|
2698
|
+
# The details of a user.
|
|
2699
|
+
# @return [Types::Identity]
|
|
2700
|
+
#
|
|
2701
|
+
# @!attribute [rw] preferences
|
|
2702
|
+
# The ARN and metadata of the member being added.
|
|
2703
|
+
# @return [Types::ChannelMembershipPreferences]
|
|
2704
|
+
#
|
|
2705
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/PutChannelMembershipPreferencesResponse AWS API Documentation
|
|
2706
|
+
#
|
|
2707
|
+
class PutChannelMembershipPreferencesResponse < Struct.new(
|
|
2708
|
+
:channel_arn,
|
|
2709
|
+
:member,
|
|
2710
|
+
:preferences)
|
|
2711
|
+
SENSITIVE = []
|
|
2712
|
+
include Aws::Structure
|
|
2713
|
+
end
|
|
2714
|
+
|
|
2469
2715
|
# @note When making an API call, you may pass RedactChannelMessageRequest
|
|
2470
2716
|
# data as a hash:
|
|
2471
2717
|
#
|
|
@@ -2544,6 +2790,16 @@ module Aws::ChimeSDKMessaging
|
|
|
2544
2790
|
# metadata: "Metadata",
|
|
2545
2791
|
# client_request_token: "ClientRequestToken", # required
|
|
2546
2792
|
# chime_bearer: "ChimeArn", # required
|
|
2793
|
+
# push_notification: {
|
|
2794
|
+
# title: "PushNotificationTitle", # required
|
|
2795
|
+
# body: "PushNotificationBody", # required
|
|
2796
|
+
# type: "DEFAULT", # required, accepts DEFAULT, VOIP
|
|
2797
|
+
# },
|
|
2798
|
+
# message_attributes: {
|
|
2799
|
+
# "MessageAttributeName" => {
|
|
2800
|
+
# string_values: ["MessageAttributeStringValue"],
|
|
2801
|
+
# },
|
|
2802
|
+
# },
|
|
2547
2803
|
# }
|
|
2548
2804
|
#
|
|
2549
2805
|
# @!attribute [rw] channel_arn
|
|
@@ -2578,6 +2834,15 @@ module Aws::ChimeSDKMessaging
|
|
|
2578
2834
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
|
2579
2835
|
# @return [String]
|
|
2580
2836
|
#
|
|
2837
|
+
# @!attribute [rw] push_notification
|
|
2838
|
+
# The push notification configuration of the message.
|
|
2839
|
+
# @return [Types::PushNotificationConfiguration]
|
|
2840
|
+
#
|
|
2841
|
+
# @!attribute [rw] message_attributes
|
|
2842
|
+
# The attributes for the message, used for message filtering along
|
|
2843
|
+
# with a `FilterRule` defined in the `PushNotificationPreferences`.
|
|
2844
|
+
# @return [Hash<String,Types::MessageAttributeValue>]
|
|
2845
|
+
#
|
|
2581
2846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
|
|
2582
2847
|
#
|
|
2583
2848
|
class SendChannelMessageRequest < Struct.new(
|
|
@@ -2587,7 +2852,9 @@ module Aws::ChimeSDKMessaging
|
|
|
2587
2852
|
:persistence,
|
|
2588
2853
|
:metadata,
|
|
2589
2854
|
:client_request_token,
|
|
2590
|
-
:chime_bearer
|
|
2855
|
+
:chime_bearer,
|
|
2856
|
+
:push_notification,
|
|
2857
|
+
:message_attributes)
|
|
2591
2858
|
SENSITIVE = [:content, :metadata, :client_request_token]
|
|
2592
2859
|
include Aws::Structure
|
|
2593
2860
|
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
|
+
version: 1.5.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-
|
|
11
|
+
date: 2021-10-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: aws-sdk-core
|