aws-sdk-chimesdkmessaging 1.3.0 → 1.7.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-chimesdkmessaging/client.rb +767 -13
- data/lib/aws-sdk-chimesdkmessaging/client_api.rb +476 -0
- data/lib/aws-sdk-chimesdkmessaging/types.rb +1102 -31
- data/lib/aws-sdk-chimesdkmessaging.rb +2 -2
- metadata +4 -4
@@ -29,6 +29,37 @@ module Aws::ChimeSDKMessaging
|
|
29
29
|
include Aws::Structure
|
30
30
|
end
|
31
31
|
|
32
|
+
# @note When making an API call, you may pass AssociateChannelFlowRequest
|
33
|
+
# data as a hash:
|
34
|
+
#
|
35
|
+
# {
|
36
|
+
# channel_arn: "ChimeArn", # required
|
37
|
+
# channel_flow_arn: "ChimeArn", # required
|
38
|
+
# chime_bearer: "ChimeArn", # required
|
39
|
+
# }
|
40
|
+
#
|
41
|
+
# @!attribute [rw] channel_arn
|
42
|
+
# The ARN of the channel.
|
43
|
+
# @return [String]
|
44
|
+
#
|
45
|
+
# @!attribute [rw] channel_flow_arn
|
46
|
+
# The ARN of the channel flow.
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] chime_bearer
|
50
|
+
# The `AppInstanceUserArn` of the user making the API call.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/AssociateChannelFlowRequest AWS API Documentation
|
54
|
+
#
|
55
|
+
class AssociateChannelFlowRequest < Struct.new(
|
56
|
+
:channel_arn,
|
57
|
+
:channel_flow_arn,
|
58
|
+
:chime_bearer)
|
59
|
+
SENSITIVE = []
|
60
|
+
include Aws::Structure
|
61
|
+
end
|
62
|
+
|
32
63
|
# The input parameters don't match the service's restrictions.
|
33
64
|
#
|
34
65
|
# @!attribute [rw] code
|
@@ -79,7 +110,8 @@ module Aws::ChimeSDKMessaging
|
|
79
110
|
# A list of failed member ARNs, error codes, and error messages.
|
80
111
|
#
|
81
112
|
# @!attribute [rw] member_arn
|
82
|
-
# The
|
113
|
+
# The `AppInstanceUserArn` of the member that the service couldn't
|
114
|
+
# add.
|
83
115
|
# @return [String]
|
84
116
|
#
|
85
117
|
# @!attribute [rw] error_code
|
@@ -123,7 +155,8 @@ module Aws::ChimeSDKMessaging
|
|
123
155
|
# @return [String]
|
124
156
|
#
|
125
157
|
# @!attribute [rw] member_arns
|
126
|
-
# The
|
158
|
+
# The `AppInstanceUserArn`s of the members you want to add to the
|
159
|
+
# channel.
|
127
160
|
# @return [Array<String>]
|
128
161
|
#
|
129
162
|
# @!attribute [rw] chime_bearer
|
@@ -198,6 +231,10 @@ module Aws::ChimeSDKMessaging
|
|
198
231
|
# The time at which a channel was last updated.
|
199
232
|
# @return [Time]
|
200
233
|
#
|
234
|
+
# @!attribute [rw] channel_flow_arn
|
235
|
+
# The ARN of the channel flow.
|
236
|
+
# @return [String]
|
237
|
+
#
|
201
238
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Channel AWS API Documentation
|
202
239
|
#
|
203
240
|
class Channel < Struct.new(
|
@@ -209,7 +246,42 @@ module Aws::ChimeSDKMessaging
|
|
209
246
|
:created_by,
|
210
247
|
:created_timestamp,
|
211
248
|
:last_message_timestamp,
|
212
|
-
:last_updated_timestamp
|
249
|
+
:last_updated_timestamp,
|
250
|
+
:channel_flow_arn)
|
251
|
+
SENSITIVE = [:name, :metadata]
|
252
|
+
include Aws::Structure
|
253
|
+
end
|
254
|
+
|
255
|
+
# Summary of details of a channel associated with channel flow.
|
256
|
+
#
|
257
|
+
# @!attribute [rw] name
|
258
|
+
# The name of the channel flow.
|
259
|
+
# @return [String]
|
260
|
+
#
|
261
|
+
# @!attribute [rw] channel_arn
|
262
|
+
# The ARN of the channel.
|
263
|
+
# @return [String]
|
264
|
+
#
|
265
|
+
# @!attribute [rw] mode
|
266
|
+
# The mode of the channel.
|
267
|
+
# @return [String]
|
268
|
+
#
|
269
|
+
# @!attribute [rw] privacy
|
270
|
+
# The channel's privacy setting.
|
271
|
+
# @return [String]
|
272
|
+
#
|
273
|
+
# @!attribute [rw] metadata
|
274
|
+
# The channel's metadata.
|
275
|
+
# @return [String]
|
276
|
+
#
|
277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelAssociatedWithFlowSummary AWS API Documentation
|
278
|
+
#
|
279
|
+
class ChannelAssociatedWithFlowSummary < Struct.new(
|
280
|
+
:name,
|
281
|
+
:channel_arn,
|
282
|
+
:mode,
|
283
|
+
:privacy,
|
284
|
+
:metadata)
|
213
285
|
SENSITIVE = [:name, :metadata]
|
214
286
|
include Aws::Structure
|
215
287
|
end
|
@@ -257,6 +329,127 @@ module Aws::ChimeSDKMessaging
|
|
257
329
|
include Aws::Structure
|
258
330
|
end
|
259
331
|
|
332
|
+
# The details of a channel flow.
|
333
|
+
#
|
334
|
+
# @!attribute [rw] channel_flow_arn
|
335
|
+
# The ARN of the channel flow.
|
336
|
+
# @return [String]
|
337
|
+
#
|
338
|
+
# @!attribute [rw] processors
|
339
|
+
# Information about the processor Lambda functions.
|
340
|
+
# @return [Array<Types::Processor>]
|
341
|
+
#
|
342
|
+
# @!attribute [rw] name
|
343
|
+
# The name of the channel flow.
|
344
|
+
# @return [String]
|
345
|
+
#
|
346
|
+
# @!attribute [rw] created_timestamp
|
347
|
+
# The time at which the channel flow was created.
|
348
|
+
# @return [Time]
|
349
|
+
#
|
350
|
+
# @!attribute [rw] last_updated_timestamp
|
351
|
+
# The time at which a channel flow was updated.
|
352
|
+
# @return [Time]
|
353
|
+
#
|
354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlow AWS API Documentation
|
355
|
+
#
|
356
|
+
class ChannelFlow < Struct.new(
|
357
|
+
:channel_flow_arn,
|
358
|
+
:processors,
|
359
|
+
:name,
|
360
|
+
:created_timestamp,
|
361
|
+
:last_updated_timestamp)
|
362
|
+
SENSITIVE = [:name]
|
363
|
+
include Aws::Structure
|
364
|
+
end
|
365
|
+
|
366
|
+
# @note When making an API call, you may pass ChannelFlowCallbackRequest
|
367
|
+
# data as a hash:
|
368
|
+
#
|
369
|
+
# {
|
370
|
+
# callback_id: "CallbackIdType", # required
|
371
|
+
# channel_arn: "ChimeArn", # required
|
372
|
+
# delete_resource: false,
|
373
|
+
# channel_message: { # required
|
374
|
+
# message_id: "MessageId", # required
|
375
|
+
# content: "NonEmptyContent",
|
376
|
+
# metadata: "Metadata",
|
377
|
+
# },
|
378
|
+
# }
|
379
|
+
#
|
380
|
+
# @!attribute [rw] callback_id
|
381
|
+
# The identifier passed to the processor by the service when invoked.
|
382
|
+
# Use the identifier to call back the service.
|
383
|
+
#
|
384
|
+
# **A suitable default value is auto-generated.** You should normally
|
385
|
+
# not need to pass this option.
|
386
|
+
# @return [String]
|
387
|
+
#
|
388
|
+
# @!attribute [rw] channel_arn
|
389
|
+
# The ARN of the channel.
|
390
|
+
# @return [String]
|
391
|
+
#
|
392
|
+
# @!attribute [rw] delete_resource
|
393
|
+
# When a processor determines that a message needs to be `DENIED`,
|
394
|
+
# pass this parameter with a value of true.
|
395
|
+
# @return [Boolean]
|
396
|
+
#
|
397
|
+
# @!attribute [rw] channel_message
|
398
|
+
# Stores information about the processed message.
|
399
|
+
# @return [Types::ChannelMessageCallback]
|
400
|
+
#
|
401
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallbackRequest AWS API Documentation
|
402
|
+
#
|
403
|
+
class ChannelFlowCallbackRequest < Struct.new(
|
404
|
+
:callback_id,
|
405
|
+
:channel_arn,
|
406
|
+
:delete_resource,
|
407
|
+
:channel_message)
|
408
|
+
SENSITIVE = []
|
409
|
+
include Aws::Structure
|
410
|
+
end
|
411
|
+
|
412
|
+
# @!attribute [rw] channel_arn
|
413
|
+
# The ARN of the channel.
|
414
|
+
# @return [String]
|
415
|
+
#
|
416
|
+
# @!attribute [rw] callback_id
|
417
|
+
# The call back ID passed in the request.
|
418
|
+
# @return [String]
|
419
|
+
#
|
420
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallbackResponse AWS API Documentation
|
421
|
+
#
|
422
|
+
class ChannelFlowCallbackResponse < Struct.new(
|
423
|
+
:channel_arn,
|
424
|
+
:callback_id)
|
425
|
+
SENSITIVE = []
|
426
|
+
include Aws::Structure
|
427
|
+
end
|
428
|
+
|
429
|
+
# Summary of details of a channel flow.
|
430
|
+
#
|
431
|
+
# @!attribute [rw] channel_flow_arn
|
432
|
+
# The ARN of the channel flow.
|
433
|
+
# @return [String]
|
434
|
+
#
|
435
|
+
# @!attribute [rw] name
|
436
|
+
# The name of the channel flow.
|
437
|
+
# @return [String]
|
438
|
+
#
|
439
|
+
# @!attribute [rw] processors
|
440
|
+
# Information about the processor Lambda functions.
|
441
|
+
# @return [Array<Types::Processor>]
|
442
|
+
#
|
443
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowSummary AWS API Documentation
|
444
|
+
#
|
445
|
+
class ChannelFlowSummary < Struct.new(
|
446
|
+
:channel_flow_arn,
|
447
|
+
:name,
|
448
|
+
:processors)
|
449
|
+
SENSITIVE = [:name]
|
450
|
+
include Aws::Structure
|
451
|
+
end
|
452
|
+
|
260
453
|
# The details of a channel member.
|
261
454
|
#
|
262
455
|
# @!attribute [rw] invited_by
|
@@ -315,6 +508,30 @@ module Aws::ChimeSDKMessaging
|
|
315
508
|
include Aws::Structure
|
316
509
|
end
|
317
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
|
+
|
318
535
|
# Summary of the details of a `ChannelMembership`.
|
319
536
|
#
|
320
537
|
# @!attribute [rw] member
|
@@ -375,6 +592,15 @@ module Aws::ChimeSDKMessaging
|
|
375
592
|
# The persistence setting for a channel message.
|
376
593
|
# @return [String]
|
377
594
|
#
|
595
|
+
# @!attribute [rw] status
|
596
|
+
# The status of the channel message.
|
597
|
+
# @return [Types::ChannelMessageStatusStructure]
|
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
|
+
#
|
378
604
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
|
379
605
|
#
|
380
606
|
class ChannelMessage < Struct.new(
|
@@ -388,11 +614,65 @@ module Aws::ChimeSDKMessaging
|
|
388
614
|
:last_updated_timestamp,
|
389
615
|
:sender,
|
390
616
|
:redacted,
|
391
|
-
:persistence
|
617
|
+
:persistence,
|
618
|
+
:status,
|
619
|
+
:message_attributes)
|
620
|
+
SENSITIVE = [:content, :metadata]
|
621
|
+
include Aws::Structure
|
622
|
+
end
|
623
|
+
|
624
|
+
# Stores information about a callback.
|
625
|
+
#
|
626
|
+
# @note When making an API call, you may pass ChannelMessageCallback
|
627
|
+
# data as a hash:
|
628
|
+
#
|
629
|
+
# {
|
630
|
+
# message_id: "MessageId", # required
|
631
|
+
# content: "NonEmptyContent",
|
632
|
+
# metadata: "Metadata",
|
633
|
+
# }
|
634
|
+
#
|
635
|
+
# @!attribute [rw] message_id
|
636
|
+
# The message ID.
|
637
|
+
# @return [String]
|
638
|
+
#
|
639
|
+
# @!attribute [rw] content
|
640
|
+
# The message content.
|
641
|
+
# @return [String]
|
642
|
+
#
|
643
|
+
# @!attribute [rw] metadata
|
644
|
+
# The message metadata.
|
645
|
+
# @return [String]
|
646
|
+
#
|
647
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageCallback AWS API Documentation
|
648
|
+
#
|
649
|
+
class ChannelMessageCallback < Struct.new(
|
650
|
+
:message_id,
|
651
|
+
:content,
|
652
|
+
:metadata)
|
392
653
|
SENSITIVE = [:content, :metadata]
|
393
654
|
include Aws::Structure
|
394
655
|
end
|
395
656
|
|
657
|
+
# Stores information about a message status.
|
658
|
+
#
|
659
|
+
# @!attribute [rw] value
|
660
|
+
# The message status value.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @!attribute [rw] detail
|
664
|
+
# Contains more details about the messasge status.
|
665
|
+
# @return [String]
|
666
|
+
#
|
667
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageStatusStructure AWS API Documentation
|
668
|
+
#
|
669
|
+
class ChannelMessageStatusStructure < Struct.new(
|
670
|
+
:value,
|
671
|
+
:detail)
|
672
|
+
SENSITIVE = []
|
673
|
+
include Aws::Structure
|
674
|
+
end
|
675
|
+
|
396
676
|
# Summary of the messages in a `Channel`.
|
397
677
|
#
|
398
678
|
# @!attribute [rw] message_id
|
@@ -431,6 +711,16 @@ module Aws::ChimeSDKMessaging
|
|
431
711
|
# Indicates whether a message was redacted.
|
432
712
|
# @return [Boolean]
|
433
713
|
#
|
714
|
+
# @!attribute [rw] status
|
715
|
+
# The message status. The status value is `SENT` for messages sent to
|
716
|
+
# a channel without a channel flow. For channels associated with
|
717
|
+
# channel flow, the value determines the processing stage.
|
718
|
+
# @return [Types::ChannelMessageStatusStructure]
|
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
|
+
#
|
434
724
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageSummary AWS API Documentation
|
435
725
|
#
|
436
726
|
class ChannelMessageSummary < Struct.new(
|
@@ -442,7 +732,9 @@ module Aws::ChimeSDKMessaging
|
|
442
732
|
:last_updated_timestamp,
|
443
733
|
:last_edited_timestamp,
|
444
734
|
:sender,
|
445
|
-
:redacted
|
735
|
+
:redacted,
|
736
|
+
:status,
|
737
|
+
:message_attributes)
|
446
738
|
SENSITIVE = [:content, :metadata]
|
447
739
|
include Aws::Structure
|
448
740
|
end
|
@@ -575,7 +867,7 @@ module Aws::ChimeSDKMessaging
|
|
575
867
|
# @return [String]
|
576
868
|
#
|
577
869
|
# @!attribute [rw] member_arn
|
578
|
-
# The
|
870
|
+
# The `AppInstanceUserArn` of the member being banned.
|
579
871
|
# @return [String]
|
580
872
|
#
|
581
873
|
# @!attribute [rw] chime_bearer
|
@@ -610,6 +902,78 @@ module Aws::ChimeSDKMessaging
|
|
610
902
|
include Aws::Structure
|
611
903
|
end
|
612
904
|
|
905
|
+
# @note When making an API call, you may pass CreateChannelFlowRequest
|
906
|
+
# data as a hash:
|
907
|
+
#
|
908
|
+
# {
|
909
|
+
# app_instance_arn: "ChimeArn", # required
|
910
|
+
# processors: [ # required
|
911
|
+
# {
|
912
|
+
# name: "NonEmptyResourceName", # required
|
913
|
+
# configuration: { # required
|
914
|
+
# lambda: { # required
|
915
|
+
# resource_arn: "LambdaFunctionArn", # required
|
916
|
+
# invocation_type: "ASYNC", # required, accepts ASYNC
|
917
|
+
# },
|
918
|
+
# },
|
919
|
+
# execution_order: 1, # required
|
920
|
+
# fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
|
921
|
+
# },
|
922
|
+
# ],
|
923
|
+
# name: "NonEmptyResourceName", # required
|
924
|
+
# tags: [
|
925
|
+
# {
|
926
|
+
# key: "TagKey", # required
|
927
|
+
# value: "TagValue", # required
|
928
|
+
# },
|
929
|
+
# ],
|
930
|
+
# client_request_token: "ClientRequestToken", # required
|
931
|
+
# }
|
932
|
+
#
|
933
|
+
# @!attribute [rw] app_instance_arn
|
934
|
+
# The ARN of the channel flow request.
|
935
|
+
# @return [String]
|
936
|
+
#
|
937
|
+
# @!attribute [rw] processors
|
938
|
+
# Information about the processor Lambda functions.
|
939
|
+
# @return [Array<Types::Processor>]
|
940
|
+
#
|
941
|
+
# @!attribute [rw] name
|
942
|
+
# The name of the channel flow.
|
943
|
+
# @return [String]
|
944
|
+
#
|
945
|
+
# @!attribute [rw] tags
|
946
|
+
# The tags for the creation request.
|
947
|
+
# @return [Array<Types::Tag>]
|
948
|
+
#
|
949
|
+
# @!attribute [rw] client_request_token
|
950
|
+
# The client token for the request. An Idempotency token.
|
951
|
+
# @return [String]
|
952
|
+
#
|
953
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlowRequest AWS API Documentation
|
954
|
+
#
|
955
|
+
class CreateChannelFlowRequest < Struct.new(
|
956
|
+
:app_instance_arn,
|
957
|
+
:processors,
|
958
|
+
:name,
|
959
|
+
:tags,
|
960
|
+
:client_request_token)
|
961
|
+
SENSITIVE = [:name, :client_request_token]
|
962
|
+
include Aws::Structure
|
963
|
+
end
|
964
|
+
|
965
|
+
# @!attribute [rw] channel_flow_arn
|
966
|
+
# The ARN of the channel flow.
|
967
|
+
# @return [String]
|
968
|
+
#
|
969
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlowResponse AWS API Documentation
|
970
|
+
#
|
971
|
+
class CreateChannelFlowResponse < Struct.new(
|
972
|
+
:channel_flow_arn)
|
973
|
+
SENSITIVE = []
|
974
|
+
include Aws::Structure
|
975
|
+
end
|
976
|
+
|
613
977
|
# @note When making an API call, you may pass CreateChannelMembershipRequest
|
614
978
|
# data as a hash:
|
615
979
|
#
|
@@ -625,7 +989,8 @@ module Aws::ChimeSDKMessaging
|
|
625
989
|
# @return [String]
|
626
990
|
#
|
627
991
|
# @!attribute [rw] member_arn
|
628
|
-
# The
|
992
|
+
# The `AppInstanceUserArn` of the member you want to add to the
|
993
|
+
# channel.
|
629
994
|
# @return [String]
|
630
995
|
#
|
631
996
|
# @!attribute [rw] type
|
@@ -682,7 +1047,7 @@ module Aws::ChimeSDKMessaging
|
|
682
1047
|
# @return [String]
|
683
1048
|
#
|
684
1049
|
# @!attribute [rw] channel_moderator_arn
|
685
|
-
# The
|
1050
|
+
# The `AppInstanceUserArn` of the moderator.
|
686
1051
|
# @return [String]
|
687
1052
|
#
|
688
1053
|
# @!attribute [rw] chime_bearer
|
@@ -833,6 +1198,25 @@ module Aws::ChimeSDKMessaging
|
|
833
1198
|
include Aws::Structure
|
834
1199
|
end
|
835
1200
|
|
1201
|
+
# @note When making an API call, you may pass DeleteChannelFlowRequest
|
1202
|
+
# data as a hash:
|
1203
|
+
#
|
1204
|
+
# {
|
1205
|
+
# channel_flow_arn: "ChimeArn", # required
|
1206
|
+
# }
|
1207
|
+
#
|
1208
|
+
# @!attribute [rw] channel_flow_arn
|
1209
|
+
# The ARN of the channel flow.
|
1210
|
+
# @return [String]
|
1211
|
+
#
|
1212
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelFlowRequest AWS API Documentation
|
1213
|
+
#
|
1214
|
+
class DeleteChannelFlowRequest < Struct.new(
|
1215
|
+
:channel_flow_arn)
|
1216
|
+
SENSITIVE = []
|
1217
|
+
include Aws::Structure
|
1218
|
+
end
|
1219
|
+
|
836
1220
|
# @note When making an API call, you may pass DeleteChannelMembershipRequest
|
837
1221
|
# data as a hash:
|
838
1222
|
#
|
@@ -847,7 +1231,8 @@ module Aws::ChimeSDKMessaging
|
|
847
1231
|
# @return [String]
|
848
1232
|
#
|
849
1233
|
# @!attribute [rw] member_arn
|
850
|
-
# The
|
1234
|
+
# The `AppInstanceUserArn` of the member that you're removing from
|
1235
|
+
# the channel.
|
851
1236
|
# @return [String]
|
852
1237
|
#
|
853
1238
|
# @!attribute [rw] chime_bearer
|
@@ -909,7 +1294,7 @@ module Aws::ChimeSDKMessaging
|
|
909
1294
|
# @return [String]
|
910
1295
|
#
|
911
1296
|
# @!attribute [rw] channel_moderator_arn
|
912
|
-
# The
|
1297
|
+
# The `AppInstanceUserArn` of the moderator being deleted.
|
913
1298
|
# @return [String]
|
914
1299
|
#
|
915
1300
|
# @!attribute [rw] chime_bearer
|
@@ -965,7 +1350,7 @@ module Aws::ChimeSDKMessaging
|
|
965
1350
|
# @return [String]
|
966
1351
|
#
|
967
1352
|
# @!attribute [rw] member_arn
|
968
|
-
# The
|
1353
|
+
# The `AppInstanceUserArn` of the member being banned.
|
969
1354
|
# @return [String]
|
970
1355
|
#
|
971
1356
|
# @!attribute [rw] chime_bearer
|
@@ -994,26 +1379,57 @@ module Aws::ChimeSDKMessaging
|
|
994
1379
|
include Aws::Structure
|
995
1380
|
end
|
996
1381
|
|
997
|
-
# @note When making an API call, you may pass
|
1382
|
+
# @note When making an API call, you may pass DescribeChannelFlowRequest
|
998
1383
|
# data as a hash:
|
999
1384
|
#
|
1000
1385
|
# {
|
1001
|
-
#
|
1002
|
-
# app_instance_user_arn: "ChimeArn", # required
|
1003
|
-
# chime_bearer: "ChimeArn", # required
|
1386
|
+
# channel_flow_arn: "ChimeArn", # required
|
1004
1387
|
# }
|
1005
1388
|
#
|
1006
|
-
# @!attribute [rw]
|
1007
|
-
# The ARN of the channel
|
1389
|
+
# @!attribute [rw] channel_flow_arn
|
1390
|
+
# The ARN of the channel flow.
|
1008
1391
|
# @return [String]
|
1009
1392
|
#
|
1010
|
-
#
|
1011
|
-
# The ARN of the user in a channel.
|
1012
|
-
# @return [String]
|
1393
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlowRequest AWS API Documentation
|
1013
1394
|
#
|
1014
|
-
|
1015
|
-
|
1016
|
-
|
1395
|
+
class DescribeChannelFlowRequest < Struct.new(
|
1396
|
+
:channel_flow_arn)
|
1397
|
+
SENSITIVE = []
|
1398
|
+
include Aws::Structure
|
1399
|
+
end
|
1400
|
+
|
1401
|
+
# @!attribute [rw] channel_flow
|
1402
|
+
# The channel flow details.
|
1403
|
+
# @return [Types::ChannelFlow]
|
1404
|
+
#
|
1405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlowResponse AWS API Documentation
|
1406
|
+
#
|
1407
|
+
class DescribeChannelFlowResponse < Struct.new(
|
1408
|
+
:channel_flow)
|
1409
|
+
SENSITIVE = []
|
1410
|
+
include Aws::Structure
|
1411
|
+
end
|
1412
|
+
|
1413
|
+
# @note When making an API call, you may pass DescribeChannelMembershipForAppInstanceUserRequest
|
1414
|
+
# data as a hash:
|
1415
|
+
#
|
1416
|
+
# {
|
1417
|
+
# channel_arn: "ChimeArn", # required
|
1418
|
+
# app_instance_user_arn: "ChimeArn", # required
|
1419
|
+
# chime_bearer: "ChimeArn", # required
|
1420
|
+
# }
|
1421
|
+
#
|
1422
|
+
# @!attribute [rw] channel_arn
|
1423
|
+
# The ARN of the channel to which the user belongs.
|
1424
|
+
# @return [String]
|
1425
|
+
#
|
1426
|
+
# @!attribute [rw] app_instance_user_arn
|
1427
|
+
# The ARN of the user in a channel.
|
1428
|
+
# @return [String]
|
1429
|
+
#
|
1430
|
+
# @!attribute [rw] chime_bearer
|
1431
|
+
# The `AppInstanceUserArn` of the user that makes the API call.
|
1432
|
+
# @return [String]
|
1017
1433
|
#
|
1018
1434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelMembershipForAppInstanceUserRequest AWS API Documentation
|
1019
1435
|
#
|
@@ -1051,7 +1467,7 @@ module Aws::ChimeSDKMessaging
|
|
1051
1467
|
# @return [String]
|
1052
1468
|
#
|
1053
1469
|
# @!attribute [rw] member_arn
|
1054
|
-
# The
|
1470
|
+
# The `AppInstanceUserArn` of the member.
|
1055
1471
|
# @return [String]
|
1056
1472
|
#
|
1057
1473
|
# @!attribute [rw] chime_bearer
|
@@ -1137,7 +1553,7 @@ module Aws::ChimeSDKMessaging
|
|
1137
1553
|
# @return [String]
|
1138
1554
|
#
|
1139
1555
|
# @!attribute [rw] channel_moderator_arn
|
1140
|
-
# The
|
1556
|
+
# The `AppInstanceUserArn` of the channel moderator.
|
1141
1557
|
# @return [String]
|
1142
1558
|
#
|
1143
1559
|
# @!attribute [rw] chime_bearer
|
@@ -1203,6 +1619,37 @@ module Aws::ChimeSDKMessaging
|
|
1203
1619
|
include Aws::Structure
|
1204
1620
|
end
|
1205
1621
|
|
1622
|
+
# @note When making an API call, you may pass DisassociateChannelFlowRequest
|
1623
|
+
# data as a hash:
|
1624
|
+
#
|
1625
|
+
# {
|
1626
|
+
# channel_arn: "ChimeArn", # required
|
1627
|
+
# channel_flow_arn: "ChimeArn", # required
|
1628
|
+
# chime_bearer: "ChimeArn", # required
|
1629
|
+
# }
|
1630
|
+
#
|
1631
|
+
# @!attribute [rw] channel_arn
|
1632
|
+
# The ARN of the channel.
|
1633
|
+
# @return [String]
|
1634
|
+
#
|
1635
|
+
# @!attribute [rw] channel_flow_arn
|
1636
|
+
# The ARN of the channel flow.
|
1637
|
+
# @return [String]
|
1638
|
+
#
|
1639
|
+
# @!attribute [rw] chime_bearer
|
1640
|
+
# The `AppInstanceUserArn` of the user making the API call.
|
1641
|
+
# @return [String]
|
1642
|
+
#
|
1643
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DisassociateChannelFlowRequest AWS API Documentation
|
1644
|
+
#
|
1645
|
+
class DisassociateChannelFlowRequest < Struct.new(
|
1646
|
+
:channel_arn,
|
1647
|
+
:channel_flow_arn,
|
1648
|
+
:chime_bearer)
|
1649
|
+
SENSITIVE = []
|
1650
|
+
include Aws::Structure
|
1651
|
+
end
|
1652
|
+
|
1206
1653
|
# The client is permanently forbidden from making the request.
|
1207
1654
|
#
|
1208
1655
|
# @!attribute [rw] code
|
@@ -1220,6 +1667,59 @@ module Aws::ChimeSDKMessaging
|
|
1220
1667
|
include Aws::Structure
|
1221
1668
|
end
|
1222
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
|
+
|
1223
1723
|
# @note When making an API call, you may pass GetChannelMessageRequest
|
1224
1724
|
# data as a hash:
|
1225
1725
|
#
|
@@ -1263,6 +1763,49 @@ module Aws::ChimeSDKMessaging
|
|
1263
1763
|
include Aws::Structure
|
1264
1764
|
end
|
1265
1765
|
|
1766
|
+
# @note When making an API call, you may pass GetChannelMessageStatusRequest
|
1767
|
+
# data as a hash:
|
1768
|
+
#
|
1769
|
+
# {
|
1770
|
+
# channel_arn: "ChimeArn", # required
|
1771
|
+
# message_id: "MessageId", # required
|
1772
|
+
# chime_bearer: "ChimeArn", # required
|
1773
|
+
# }
|
1774
|
+
#
|
1775
|
+
# @!attribute [rw] channel_arn
|
1776
|
+
# The ARN of the channel
|
1777
|
+
# @return [String]
|
1778
|
+
#
|
1779
|
+
# @!attribute [rw] message_id
|
1780
|
+
# The ID of the message.
|
1781
|
+
# @return [String]
|
1782
|
+
#
|
1783
|
+
# @!attribute [rw] chime_bearer
|
1784
|
+
# The `AppInstanceUserArn` of the user making the API call.
|
1785
|
+
# @return [String]
|
1786
|
+
#
|
1787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusRequest AWS API Documentation
|
1788
|
+
#
|
1789
|
+
class GetChannelMessageStatusRequest < Struct.new(
|
1790
|
+
:channel_arn,
|
1791
|
+
:message_id,
|
1792
|
+
:chime_bearer)
|
1793
|
+
SENSITIVE = []
|
1794
|
+
include Aws::Structure
|
1795
|
+
end
|
1796
|
+
|
1797
|
+
# @!attribute [rw] status
|
1798
|
+
# The message status and details.
|
1799
|
+
# @return [Types::ChannelMessageStatusStructure]
|
1800
|
+
#
|
1801
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusResponse AWS API Documentation
|
1802
|
+
#
|
1803
|
+
class GetChannelMessageStatusResponse < Struct.new(
|
1804
|
+
:status)
|
1805
|
+
SENSITIVE = []
|
1806
|
+
include Aws::Structure
|
1807
|
+
end
|
1808
|
+
|
1266
1809
|
# @api private
|
1267
1810
|
#
|
1268
1811
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpointRequest AWS API Documentation
|
@@ -1300,6 +1843,33 @@ module Aws::ChimeSDKMessaging
|
|
1300
1843
|
include Aws::Structure
|
1301
1844
|
end
|
1302
1845
|
|
1846
|
+
# Stores metadata about a Lambda processor.
|
1847
|
+
#
|
1848
|
+
# @note When making an API call, you may pass LambdaConfiguration
|
1849
|
+
# data as a hash:
|
1850
|
+
#
|
1851
|
+
# {
|
1852
|
+
# resource_arn: "LambdaFunctionArn", # required
|
1853
|
+
# invocation_type: "ASYNC", # required, accepts ASYNC
|
1854
|
+
# }
|
1855
|
+
#
|
1856
|
+
# @!attribute [rw] resource_arn
|
1857
|
+
# The ARN of the Lambda message processing function.
|
1858
|
+
# @return [String]
|
1859
|
+
#
|
1860
|
+
# @!attribute [rw] invocation_type
|
1861
|
+
# Controls how the Lambda function is invoked.
|
1862
|
+
# @return [String]
|
1863
|
+
#
|
1864
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/LambdaConfiguration AWS API Documentation
|
1865
|
+
#
|
1866
|
+
class LambdaConfiguration < Struct.new(
|
1867
|
+
:resource_arn,
|
1868
|
+
:invocation_type)
|
1869
|
+
SENSITIVE = []
|
1870
|
+
include Aws::Structure
|
1871
|
+
end
|
1872
|
+
|
1303
1873
|
# @note When making an API call, you may pass ListChannelBansRequest
|
1304
1874
|
# data as a hash:
|
1305
1875
|
#
|
@@ -1361,6 +1931,56 @@ module Aws::ChimeSDKMessaging
|
|
1361
1931
|
include Aws::Structure
|
1362
1932
|
end
|
1363
1933
|
|
1934
|
+
# @note When making an API call, you may pass ListChannelFlowsRequest
|
1935
|
+
# data as a hash:
|
1936
|
+
#
|
1937
|
+
# {
|
1938
|
+
# app_instance_arn: "ChimeArn", # required
|
1939
|
+
# max_results: 1,
|
1940
|
+
# next_token: "NextToken",
|
1941
|
+
# }
|
1942
|
+
#
|
1943
|
+
# @!attribute [rw] app_instance_arn
|
1944
|
+
# The ARN of the app instance.
|
1945
|
+
# @return [String]
|
1946
|
+
#
|
1947
|
+
# @!attribute [rw] max_results
|
1948
|
+
# The maximum number of channel flows that you want to return.
|
1949
|
+
# @return [Integer]
|
1950
|
+
#
|
1951
|
+
# @!attribute [rw] next_token
|
1952
|
+
# The token passed by previous API calls until all requested channel
|
1953
|
+
# flows are returned.
|
1954
|
+
# @return [String]
|
1955
|
+
#
|
1956
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlowsRequest AWS API Documentation
|
1957
|
+
#
|
1958
|
+
class ListChannelFlowsRequest < Struct.new(
|
1959
|
+
:app_instance_arn,
|
1960
|
+
:max_results,
|
1961
|
+
:next_token)
|
1962
|
+
SENSITIVE = [:next_token]
|
1963
|
+
include Aws::Structure
|
1964
|
+
end
|
1965
|
+
|
1966
|
+
# @!attribute [rw] channel_flows
|
1967
|
+
# The information about each channel flow.
|
1968
|
+
# @return [Array<Types::ChannelFlowSummary>]
|
1969
|
+
#
|
1970
|
+
# @!attribute [rw] next_token
|
1971
|
+
# The token passed by previous API calls until all requested channels
|
1972
|
+
# are returned.
|
1973
|
+
# @return [String]
|
1974
|
+
#
|
1975
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlowsResponse AWS API Documentation
|
1976
|
+
#
|
1977
|
+
class ListChannelFlowsResponse < Struct.new(
|
1978
|
+
:channel_flows,
|
1979
|
+
:next_token)
|
1980
|
+
SENSITIVE = [:next_token]
|
1981
|
+
include Aws::Structure
|
1982
|
+
end
|
1983
|
+
|
1364
1984
|
# @note When making an API call, you may pass ListChannelMembershipsForAppInstanceUserRequest
|
1365
1985
|
# data as a hash:
|
1366
1986
|
#
|
@@ -1630,6 +2250,56 @@ module Aws::ChimeSDKMessaging
|
|
1630
2250
|
include Aws::Structure
|
1631
2251
|
end
|
1632
2252
|
|
2253
|
+
# @note When making an API call, you may pass ListChannelsAssociatedWithChannelFlowRequest
|
2254
|
+
# data as a hash:
|
2255
|
+
#
|
2256
|
+
# {
|
2257
|
+
# channel_flow_arn: "ChimeArn", # required
|
2258
|
+
# max_results: 1,
|
2259
|
+
# next_token: "NextToken",
|
2260
|
+
# }
|
2261
|
+
#
|
2262
|
+
# @!attribute [rw] channel_flow_arn
|
2263
|
+
# The ARN of the channel flow.
|
2264
|
+
# @return [String]
|
2265
|
+
#
|
2266
|
+
# @!attribute [rw] max_results
|
2267
|
+
# The maximum number of channels that you want to return.
|
2268
|
+
# @return [Integer]
|
2269
|
+
#
|
2270
|
+
# @!attribute [rw] next_token
|
2271
|
+
# The token passed by previous API calls until all requested channels
|
2272
|
+
# are returned.
|
2273
|
+
# @return [String]
|
2274
|
+
#
|
2275
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlowRequest AWS API Documentation
|
2276
|
+
#
|
2277
|
+
class ListChannelsAssociatedWithChannelFlowRequest < Struct.new(
|
2278
|
+
:channel_flow_arn,
|
2279
|
+
:max_results,
|
2280
|
+
:next_token)
|
2281
|
+
SENSITIVE = [:next_token]
|
2282
|
+
include Aws::Structure
|
2283
|
+
end
|
2284
|
+
|
2285
|
+
# @!attribute [rw] channels
|
2286
|
+
# The information about each channel.
|
2287
|
+
# @return [Array<Types::ChannelAssociatedWithFlowSummary>]
|
2288
|
+
#
|
2289
|
+
# @!attribute [rw] next_token
|
2290
|
+
# The token passed by previous API calls until all requested channels
|
2291
|
+
# are returned.
|
2292
|
+
# @return [String]
|
2293
|
+
#
|
2294
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlowResponse AWS API Documentation
|
2295
|
+
#
|
2296
|
+
class ListChannelsAssociatedWithChannelFlowResponse < Struct.new(
|
2297
|
+
:channels,
|
2298
|
+
:next_token)
|
2299
|
+
SENSITIVE = [:next_token]
|
2300
|
+
include Aws::Structure
|
2301
|
+
end
|
2302
|
+
|
1633
2303
|
# @note When making an API call, you may pass ListChannelsModeratedByAppInstanceUserRequest
|
1634
2304
|
# data as a hash:
|
1635
2305
|
#
|
@@ -1750,6 +2420,58 @@ module Aws::ChimeSDKMessaging
|
|
1750
2420
|
include Aws::Structure
|
1751
2421
|
end
|
1752
2422
|
|
2423
|
+
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2424
|
+
# data as a hash:
|
2425
|
+
#
|
2426
|
+
# {
|
2427
|
+
# resource_arn: "ChimeArn", # required
|
2428
|
+
# }
|
2429
|
+
#
|
2430
|
+
# @!attribute [rw] resource_arn
|
2431
|
+
# The ARN of the resource.
|
2432
|
+
# @return [String]
|
2433
|
+
#
|
2434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListTagsForResourceRequest AWS API Documentation
|
2435
|
+
#
|
2436
|
+
class ListTagsForResourceRequest < Struct.new(
|
2437
|
+
:resource_arn)
|
2438
|
+
SENSITIVE = []
|
2439
|
+
include Aws::Structure
|
2440
|
+
end
|
2441
|
+
|
2442
|
+
# @!attribute [rw] tags
|
2443
|
+
# The tag key-value pairs.
|
2444
|
+
# @return [Array<Types::Tag>]
|
2445
|
+
#
|
2446
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListTagsForResourceResponse AWS API Documentation
|
2447
|
+
#
|
2448
|
+
class ListTagsForResourceResponse < Struct.new(
|
2449
|
+
:tags)
|
2450
|
+
SENSITIVE = []
|
2451
|
+
include Aws::Structure
|
2452
|
+
end
|
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
|
+
|
1753
2475
|
# The websocket endpoint used to connect to Amazon Chime SDK messaging.
|
1754
2476
|
#
|
1755
2477
|
# @!attribute [rw] url
|
@@ -1782,6 +2504,214 @@ module Aws::ChimeSDKMessaging
|
|
1782
2504
|
include Aws::Structure
|
1783
2505
|
end
|
1784
2506
|
|
2507
|
+
# The information about a processor in a channel flow.
|
2508
|
+
#
|
2509
|
+
# @note When making an API call, you may pass Processor
|
2510
|
+
# data as a hash:
|
2511
|
+
#
|
2512
|
+
# {
|
2513
|
+
# name: "NonEmptyResourceName", # required
|
2514
|
+
# configuration: { # required
|
2515
|
+
# lambda: { # required
|
2516
|
+
# resource_arn: "LambdaFunctionArn", # required
|
2517
|
+
# invocation_type: "ASYNC", # required, accepts ASYNC
|
2518
|
+
# },
|
2519
|
+
# },
|
2520
|
+
# execution_order: 1, # required
|
2521
|
+
# fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
|
2522
|
+
# }
|
2523
|
+
#
|
2524
|
+
# @!attribute [rw] name
|
2525
|
+
# The name of the channel flow.
|
2526
|
+
# @return [String]
|
2527
|
+
#
|
2528
|
+
# @!attribute [rw] configuration
|
2529
|
+
# The information about the type of processor and its identifier.
|
2530
|
+
# @return [Types::ProcessorConfiguration]
|
2531
|
+
#
|
2532
|
+
# @!attribute [rw] execution_order
|
2533
|
+
# The sequence in which processors run. If you have multiple
|
2534
|
+
# processors in a channel flow, message processing goes through each
|
2535
|
+
# processor in the sequence. The value determines the sequence. At
|
2536
|
+
# this point, we support only 1 processor within a flow.
|
2537
|
+
# @return [Integer]
|
2538
|
+
#
|
2539
|
+
# @!attribute [rw] fallback_action
|
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.
|
2548
|
+
# @return [String]
|
2549
|
+
#
|
2550
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Processor AWS API Documentation
|
2551
|
+
#
|
2552
|
+
class Processor < Struct.new(
|
2553
|
+
:name,
|
2554
|
+
:configuration,
|
2555
|
+
:execution_order,
|
2556
|
+
:fallback_action)
|
2557
|
+
SENSITIVE = [:name]
|
2558
|
+
include Aws::Structure
|
2559
|
+
end
|
2560
|
+
|
2561
|
+
# A processor's metadata.
|
2562
|
+
#
|
2563
|
+
# @note When making an API call, you may pass ProcessorConfiguration
|
2564
|
+
# data as a hash:
|
2565
|
+
#
|
2566
|
+
# {
|
2567
|
+
# lambda: { # required
|
2568
|
+
# resource_arn: "LambdaFunctionArn", # required
|
2569
|
+
# invocation_type: "ASYNC", # required, accepts ASYNC
|
2570
|
+
# },
|
2571
|
+
# }
|
2572
|
+
#
|
2573
|
+
# @!attribute [rw] lambda
|
2574
|
+
# Indicates that the processor is of type Lambda.
|
2575
|
+
# @return [Types::LambdaConfiguration]
|
2576
|
+
#
|
2577
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ProcessorConfiguration AWS API Documentation
|
2578
|
+
#
|
2579
|
+
class ProcessorConfiguration < Struct.new(
|
2580
|
+
:lambda)
|
2581
|
+
SENSITIVE = []
|
2582
|
+
include Aws::Structure
|
2583
|
+
end
|
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
|
+
|
1785
2715
|
# @note When making an API call, you may pass RedactChannelMessageRequest
|
1786
2716
|
# data as a hash:
|
1787
2717
|
#
|
@@ -1860,6 +2790,16 @@ module Aws::ChimeSDKMessaging
|
|
1860
2790
|
# metadata: "Metadata",
|
1861
2791
|
# client_request_token: "ClientRequestToken", # required
|
1862
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
|
+
# },
|
1863
2803
|
# }
|
1864
2804
|
#
|
1865
2805
|
# @!attribute [rw] channel_arn
|
@@ -1894,6 +2834,15 @@ module Aws::ChimeSDKMessaging
|
|
1894
2834
|
# The `AppInstanceUserArn` of the user that makes the API call.
|
1895
2835
|
# @return [String]
|
1896
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
|
+
#
|
1897
2846
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageRequest AWS API Documentation
|
1898
2847
|
#
|
1899
2848
|
class SendChannelMessageRequest < Struct.new(
|
@@ -1903,7 +2852,9 @@ module Aws::ChimeSDKMessaging
|
|
1903
2852
|
:persistence,
|
1904
2853
|
:metadata,
|
1905
2854
|
:client_request_token,
|
1906
|
-
:chime_bearer
|
2855
|
+
:chime_bearer,
|
2856
|
+
:push_notification,
|
2857
|
+
:message_attributes)
|
1907
2858
|
SENSITIVE = [:content, :metadata, :client_request_token]
|
1908
2859
|
include Aws::Structure
|
1909
2860
|
end
|
@@ -1916,11 +2867,16 @@ module Aws::ChimeSDKMessaging
|
|
1916
2867
|
# The ID string assigned to each message.
|
1917
2868
|
# @return [String]
|
1918
2869
|
#
|
2870
|
+
# @!attribute [rw] status
|
2871
|
+
# The status of the channel message.
|
2872
|
+
# @return [Types::ChannelMessageStatusStructure]
|
2873
|
+
#
|
1919
2874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageResponse AWS API Documentation
|
1920
2875
|
#
|
1921
2876
|
class SendChannelMessageResponse < Struct.new(
|
1922
2877
|
:channel_arn,
|
1923
|
-
:message_id
|
2878
|
+
:message_id,
|
2879
|
+
:status)
|
1924
2880
|
SENSITIVE = []
|
1925
2881
|
include Aws::Structure
|
1926
2882
|
end
|
@@ -1959,7 +2915,7 @@ module Aws::ChimeSDKMessaging
|
|
1959
2915
|
include Aws::Structure
|
1960
2916
|
end
|
1961
2917
|
|
1962
|
-
#
|
2918
|
+
# A tag object containing a key-value pair.
|
1963
2919
|
#
|
1964
2920
|
# @note When making an API call, you may pass Tag
|
1965
2921
|
# data as a hash:
|
@@ -1970,11 +2926,11 @@ module Aws::ChimeSDKMessaging
|
|
1970
2926
|
# }
|
1971
2927
|
#
|
1972
2928
|
# @!attribute [rw] key
|
1973
|
-
# The key
|
2929
|
+
# The key in a tag.
|
1974
2930
|
# @return [String]
|
1975
2931
|
#
|
1976
2932
|
# @!attribute [rw] value
|
1977
|
-
# The value
|
2933
|
+
# The value in a tag.
|
1978
2934
|
# @return [String]
|
1979
2935
|
#
|
1980
2936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Tag AWS API Documentation
|
@@ -1986,6 +2942,36 @@ module Aws::ChimeSDKMessaging
|
|
1986
2942
|
include Aws::Structure
|
1987
2943
|
end
|
1988
2944
|
|
2945
|
+
# @note When making an API call, you may pass TagResourceRequest
|
2946
|
+
# data as a hash:
|
2947
|
+
#
|
2948
|
+
# {
|
2949
|
+
# resource_arn: "ChimeArn", # required
|
2950
|
+
# tags: [ # required
|
2951
|
+
# {
|
2952
|
+
# key: "TagKey", # required
|
2953
|
+
# value: "TagValue", # required
|
2954
|
+
# },
|
2955
|
+
# ],
|
2956
|
+
# }
|
2957
|
+
#
|
2958
|
+
# @!attribute [rw] resource_arn
|
2959
|
+
# The resource ARN.
|
2960
|
+
# @return [String]
|
2961
|
+
#
|
2962
|
+
# @!attribute [rw] tags
|
2963
|
+
# The tag key-value pairs.
|
2964
|
+
# @return [Array<Types::Tag>]
|
2965
|
+
#
|
2966
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/TagResourceRequest AWS API Documentation
|
2967
|
+
#
|
2968
|
+
class TagResourceRequest < Struct.new(
|
2969
|
+
:resource_arn,
|
2970
|
+
:tags)
|
2971
|
+
SENSITIVE = []
|
2972
|
+
include Aws::Structure
|
2973
|
+
end
|
2974
|
+
|
1989
2975
|
# The client exceeded its request rate limit.
|
1990
2976
|
#
|
1991
2977
|
# @!attribute [rw] code
|
@@ -2020,6 +3006,86 @@ module Aws::ChimeSDKMessaging
|
|
2020
3006
|
include Aws::Structure
|
2021
3007
|
end
|
2022
3008
|
|
3009
|
+
# @note When making an API call, you may pass UntagResourceRequest
|
3010
|
+
# data as a hash:
|
3011
|
+
#
|
3012
|
+
# {
|
3013
|
+
# resource_arn: "ChimeArn", # required
|
3014
|
+
# tag_keys: ["TagKey"], # required
|
3015
|
+
# }
|
3016
|
+
#
|
3017
|
+
# @!attribute [rw] resource_arn
|
3018
|
+
# The resource ARN.
|
3019
|
+
# @return [String]
|
3020
|
+
#
|
3021
|
+
# @!attribute [rw] tag_keys
|
3022
|
+
# The tag keys.
|
3023
|
+
# @return [Array<String>]
|
3024
|
+
#
|
3025
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UntagResourceRequest AWS API Documentation
|
3026
|
+
#
|
3027
|
+
class UntagResourceRequest < Struct.new(
|
3028
|
+
:resource_arn,
|
3029
|
+
:tag_keys)
|
3030
|
+
SENSITIVE = []
|
3031
|
+
include Aws::Structure
|
3032
|
+
end
|
3033
|
+
|
3034
|
+
# @note When making an API call, you may pass UpdateChannelFlowRequest
|
3035
|
+
# data as a hash:
|
3036
|
+
#
|
3037
|
+
# {
|
3038
|
+
# channel_flow_arn: "ChimeArn", # required
|
3039
|
+
# processors: [ # required
|
3040
|
+
# {
|
3041
|
+
# name: "NonEmptyResourceName", # required
|
3042
|
+
# configuration: { # required
|
3043
|
+
# lambda: { # required
|
3044
|
+
# resource_arn: "LambdaFunctionArn", # required
|
3045
|
+
# invocation_type: "ASYNC", # required, accepts ASYNC
|
3046
|
+
# },
|
3047
|
+
# },
|
3048
|
+
# execution_order: 1, # required
|
3049
|
+
# fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
|
3050
|
+
# },
|
3051
|
+
# ],
|
3052
|
+
# name: "NonEmptyResourceName", # required
|
3053
|
+
# }
|
3054
|
+
#
|
3055
|
+
# @!attribute [rw] channel_flow_arn
|
3056
|
+
# The ARN of the channel flow.
|
3057
|
+
# @return [String]
|
3058
|
+
#
|
3059
|
+
# @!attribute [rw] processors
|
3060
|
+
# Information about the processor Lambda functions
|
3061
|
+
# @return [Array<Types::Processor>]
|
3062
|
+
#
|
3063
|
+
# @!attribute [rw] name
|
3064
|
+
# The name of the channel flow.
|
3065
|
+
# @return [String]
|
3066
|
+
#
|
3067
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlowRequest AWS API Documentation
|
3068
|
+
#
|
3069
|
+
class UpdateChannelFlowRequest < Struct.new(
|
3070
|
+
:channel_flow_arn,
|
3071
|
+
:processors,
|
3072
|
+
:name)
|
3073
|
+
SENSITIVE = [:name]
|
3074
|
+
include Aws::Structure
|
3075
|
+
end
|
3076
|
+
|
3077
|
+
# @!attribute [rw] channel_flow_arn
|
3078
|
+
# The ARN of the channel flow.
|
3079
|
+
# @return [String]
|
3080
|
+
#
|
3081
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlowResponse AWS API Documentation
|
3082
|
+
#
|
3083
|
+
class UpdateChannelFlowResponse < Struct.new(
|
3084
|
+
:channel_flow_arn)
|
3085
|
+
SENSITIVE = []
|
3086
|
+
include Aws::Structure
|
3087
|
+
end
|
3088
|
+
|
2023
3089
|
# @note When making an API call, you may pass UpdateChannelMessageRequest
|
2024
3090
|
# data as a hash:
|
2025
3091
|
#
|
@@ -2071,11 +3137,16 @@ module Aws::ChimeSDKMessaging
|
|
2071
3137
|
# The ID string of the message being updated.
|
2072
3138
|
# @return [String]
|
2073
3139
|
#
|
3140
|
+
# @!attribute [rw] status
|
3141
|
+
# The status of the message update.
|
3142
|
+
# @return [Types::ChannelMessageStatusStructure]
|
3143
|
+
#
|
2074
3144
|
# @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageResponse AWS API Documentation
|
2075
3145
|
#
|
2076
3146
|
class UpdateChannelMessageResponse < Struct.new(
|
2077
3147
|
:channel_arn,
|
2078
|
-
:message_id
|
3148
|
+
:message_id,
|
3149
|
+
:status)
|
2079
3150
|
SENSITIVE = []
|
2080
3151
|
include Aws::Structure
|
2081
3152
|
end
|