aws-sdk-chimesdkmessaging 1.0.0 → 1.4.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.
@@ -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
@@ -198,6 +229,10 @@ module Aws::ChimeSDKMessaging
198
229
  # The time at which a channel was last updated.
199
230
  # @return [Time]
200
231
  #
232
+ # @!attribute [rw] channel_flow_arn
233
+ # The ARN of the channel flow.
234
+ # @return [String]
235
+ #
201
236
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Channel AWS API Documentation
202
237
  #
203
238
  class Channel < Struct.new(
@@ -209,7 +244,42 @@ module Aws::ChimeSDKMessaging
209
244
  :created_by,
210
245
  :created_timestamp,
211
246
  :last_message_timestamp,
212
- :last_updated_timestamp)
247
+ :last_updated_timestamp,
248
+ :channel_flow_arn)
249
+ SENSITIVE = [:name, :metadata]
250
+ include Aws::Structure
251
+ end
252
+
253
+ # Summary of details of a channel associated with channel flow.
254
+ #
255
+ # @!attribute [rw] name
256
+ # The name of the channel flow.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] channel_arn
260
+ # The ARN of the channel.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] mode
264
+ # The mode of the channel.
265
+ # @return [String]
266
+ #
267
+ # @!attribute [rw] privacy
268
+ # The channel's privacy setting.
269
+ # @return [String]
270
+ #
271
+ # @!attribute [rw] metadata
272
+ # The channel's metadata.
273
+ # @return [String]
274
+ #
275
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelAssociatedWithFlowSummary AWS API Documentation
276
+ #
277
+ class ChannelAssociatedWithFlowSummary < Struct.new(
278
+ :name,
279
+ :channel_arn,
280
+ :mode,
281
+ :privacy,
282
+ :metadata)
213
283
  SENSITIVE = [:name, :metadata]
214
284
  include Aws::Structure
215
285
  end
@@ -257,6 +327,127 @@ module Aws::ChimeSDKMessaging
257
327
  include Aws::Structure
258
328
  end
259
329
 
330
+ # The details of a channel flow.
331
+ #
332
+ # @!attribute [rw] channel_flow_arn
333
+ # The ARN of the channel flow.
334
+ # @return [String]
335
+ #
336
+ # @!attribute [rw] processors
337
+ # Information about the processor Lambda functions.
338
+ # @return [Array<Types::Processor>]
339
+ #
340
+ # @!attribute [rw] name
341
+ # The name of the channel flow.
342
+ # @return [String]
343
+ #
344
+ # @!attribute [rw] created_timestamp
345
+ # The time at which the channel flow was created.
346
+ # @return [Time]
347
+ #
348
+ # @!attribute [rw] last_updated_timestamp
349
+ # The time at which a channel flow was updated.
350
+ # @return [Time]
351
+ #
352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlow AWS API Documentation
353
+ #
354
+ class ChannelFlow < Struct.new(
355
+ :channel_flow_arn,
356
+ :processors,
357
+ :name,
358
+ :created_timestamp,
359
+ :last_updated_timestamp)
360
+ SENSITIVE = [:name]
361
+ include Aws::Structure
362
+ end
363
+
364
+ # @note When making an API call, you may pass ChannelFlowCallbackRequest
365
+ # data as a hash:
366
+ #
367
+ # {
368
+ # callback_id: "CallbackIdType", # required
369
+ # channel_arn: "ChimeArn", # required
370
+ # delete_resource: false,
371
+ # channel_message: { # required
372
+ # message_id: "MessageId", # required
373
+ # content: "NonEmptyContent",
374
+ # metadata: "Metadata",
375
+ # },
376
+ # }
377
+ #
378
+ # @!attribute [rw] callback_id
379
+ # The identifier passed to the processor by the service when invoked.
380
+ # Use the identifier to call back the service.
381
+ #
382
+ # **A suitable default value is auto-generated.** You should normally
383
+ # not need to pass this option.
384
+ # @return [String]
385
+ #
386
+ # @!attribute [rw] channel_arn
387
+ # The ARN of the channel.
388
+ # @return [String]
389
+ #
390
+ # @!attribute [rw] delete_resource
391
+ # When a processor determines that a message needs to be `DENIED`,
392
+ # pass this parameter with a value of true.
393
+ # @return [Boolean]
394
+ #
395
+ # @!attribute [rw] channel_message
396
+ # Stores information about the processed message.
397
+ # @return [Types::ChannelMessageCallback]
398
+ #
399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallbackRequest AWS API Documentation
400
+ #
401
+ class ChannelFlowCallbackRequest < Struct.new(
402
+ :callback_id,
403
+ :channel_arn,
404
+ :delete_resource,
405
+ :channel_message)
406
+ SENSITIVE = []
407
+ include Aws::Structure
408
+ end
409
+
410
+ # @!attribute [rw] channel_arn
411
+ # The ARN of the channel.
412
+ # @return [String]
413
+ #
414
+ # @!attribute [rw] callback_id
415
+ # The call back ID passed in the request.
416
+ # @return [String]
417
+ #
418
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowCallbackResponse AWS API Documentation
419
+ #
420
+ class ChannelFlowCallbackResponse < Struct.new(
421
+ :channel_arn,
422
+ :callback_id)
423
+ SENSITIVE = []
424
+ include Aws::Structure
425
+ end
426
+
427
+ # Summary of details of a channel flow.
428
+ #
429
+ # @!attribute [rw] channel_flow_arn
430
+ # The ARN of the channel flow.
431
+ # @return [String]
432
+ #
433
+ # @!attribute [rw] name
434
+ # The name of the channel flow.
435
+ # @return [String]
436
+ #
437
+ # @!attribute [rw] processors
438
+ # Information about the processor Lambda functions.
439
+ # @return [Array<Types::Processor>]
440
+ #
441
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelFlowSummary AWS API Documentation
442
+ #
443
+ class ChannelFlowSummary < Struct.new(
444
+ :channel_flow_arn,
445
+ :name,
446
+ :processors)
447
+ SENSITIVE = [:name]
448
+ include Aws::Structure
449
+ end
450
+
260
451
  # The details of a channel member.
261
452
  #
262
453
  # @!attribute [rw] invited_by
@@ -375,6 +566,10 @@ module Aws::ChimeSDKMessaging
375
566
  # The persistence setting for a channel message.
376
567
  # @return [String]
377
568
  #
569
+ # @!attribute [rw] status
570
+ # The status of the channel message.
571
+ # @return [Types::ChannelMessageStatusStructure]
572
+ #
378
573
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessage AWS API Documentation
379
574
  #
380
575
  class ChannelMessage < Struct.new(
@@ -388,11 +583,64 @@ module Aws::ChimeSDKMessaging
388
583
  :last_updated_timestamp,
389
584
  :sender,
390
585
  :redacted,
391
- :persistence)
586
+ :persistence,
587
+ :status)
588
+ SENSITIVE = [:content, :metadata]
589
+ include Aws::Structure
590
+ end
591
+
592
+ # Stores information about a callback.
593
+ #
594
+ # @note When making an API call, you may pass ChannelMessageCallback
595
+ # data as a hash:
596
+ #
597
+ # {
598
+ # message_id: "MessageId", # required
599
+ # content: "NonEmptyContent",
600
+ # metadata: "Metadata",
601
+ # }
602
+ #
603
+ # @!attribute [rw] message_id
604
+ # The message ID.
605
+ # @return [String]
606
+ #
607
+ # @!attribute [rw] content
608
+ # The message content.
609
+ # @return [String]
610
+ #
611
+ # @!attribute [rw] metadata
612
+ # The message metadata.
613
+ # @return [String]
614
+ #
615
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageCallback AWS API Documentation
616
+ #
617
+ class ChannelMessageCallback < Struct.new(
618
+ :message_id,
619
+ :content,
620
+ :metadata)
392
621
  SENSITIVE = [:content, :metadata]
393
622
  include Aws::Structure
394
623
  end
395
624
 
625
+ # Stores information about a message status.
626
+ #
627
+ # @!attribute [rw] value
628
+ # The message status value.
629
+ # @return [String]
630
+ #
631
+ # @!attribute [rw] detail
632
+ # Contains more details about the messasge status.
633
+ # @return [String]
634
+ #
635
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageStatusStructure AWS API Documentation
636
+ #
637
+ class ChannelMessageStatusStructure < Struct.new(
638
+ :value,
639
+ :detail)
640
+ SENSITIVE = []
641
+ include Aws::Structure
642
+ end
643
+
396
644
  # Summary of the messages in a `Channel`.
397
645
  #
398
646
  # @!attribute [rw] message_id
@@ -431,6 +679,12 @@ module Aws::ChimeSDKMessaging
431
679
  # Indicates whether a message was redacted.
432
680
  # @return [Boolean]
433
681
  #
682
+ # @!attribute [rw] status
683
+ # The message status. The status value is `SENT` for messages sent to
684
+ # a channel without a channel flow. For channels associated with
685
+ # channel flow, the value determines the processing stage.
686
+ # @return [Types::ChannelMessageStatusStructure]
687
+ #
434
688
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ChannelMessageSummary AWS API Documentation
435
689
  #
436
690
  class ChannelMessageSummary < Struct.new(
@@ -442,7 +696,8 @@ module Aws::ChimeSDKMessaging
442
696
  :last_updated_timestamp,
443
697
  :last_edited_timestamp,
444
698
  :sender,
445
- :redacted)
699
+ :redacted,
700
+ :status)
446
701
  SENSITIVE = [:content, :metadata]
447
702
  include Aws::Structure
448
703
  end
@@ -610,6 +865,78 @@ module Aws::ChimeSDKMessaging
610
865
  include Aws::Structure
611
866
  end
612
867
 
868
+ # @note When making an API call, you may pass CreateChannelFlowRequest
869
+ # data as a hash:
870
+ #
871
+ # {
872
+ # app_instance_arn: "ChimeArn", # required
873
+ # processors: [ # required
874
+ # {
875
+ # name: "NonEmptyResourceName", # required
876
+ # configuration: { # required
877
+ # lambda: { # required
878
+ # resource_arn: "LambdaFunctionArn", # required
879
+ # invocation_type: "ASYNC", # required, accepts ASYNC
880
+ # },
881
+ # },
882
+ # execution_order: 1, # required
883
+ # fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
884
+ # },
885
+ # ],
886
+ # name: "NonEmptyResourceName", # required
887
+ # tags: [
888
+ # {
889
+ # key: "TagKey", # required
890
+ # value: "TagValue", # required
891
+ # },
892
+ # ],
893
+ # client_request_token: "ClientRequestToken", # required
894
+ # }
895
+ #
896
+ # @!attribute [rw] app_instance_arn
897
+ # The ARN of the channel flow request.
898
+ # @return [String]
899
+ #
900
+ # @!attribute [rw] processors
901
+ # Information about the processor Lambda functions.
902
+ # @return [Array<Types::Processor>]
903
+ #
904
+ # @!attribute [rw] name
905
+ # The name of the channel flow.
906
+ # @return [String]
907
+ #
908
+ # @!attribute [rw] tags
909
+ # The tags for the creation request.
910
+ # @return [Array<Types::Tag>]
911
+ #
912
+ # @!attribute [rw] client_request_token
913
+ # The client token for the request. An Idempotency token.
914
+ # @return [String]
915
+ #
916
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlowRequest AWS API Documentation
917
+ #
918
+ class CreateChannelFlowRequest < Struct.new(
919
+ :app_instance_arn,
920
+ :processors,
921
+ :name,
922
+ :tags,
923
+ :client_request_token)
924
+ SENSITIVE = [:name, :client_request_token]
925
+ include Aws::Structure
926
+ end
927
+
928
+ # @!attribute [rw] channel_flow_arn
929
+ # The ARN of the channel flow.
930
+ # @return [String]
931
+ #
932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/CreateChannelFlowResponse AWS API Documentation
933
+ #
934
+ class CreateChannelFlowResponse < Struct.new(
935
+ :channel_flow_arn)
936
+ SENSITIVE = []
937
+ include Aws::Structure
938
+ end
939
+
613
940
  # @note When making an API call, you may pass CreateChannelMembershipRequest
614
941
  # data as a hash:
615
942
  #
@@ -833,6 +1160,25 @@ module Aws::ChimeSDKMessaging
833
1160
  include Aws::Structure
834
1161
  end
835
1162
 
1163
+ # @note When making an API call, you may pass DeleteChannelFlowRequest
1164
+ # data as a hash:
1165
+ #
1166
+ # {
1167
+ # channel_flow_arn: "ChimeArn", # required
1168
+ # }
1169
+ #
1170
+ # @!attribute [rw] channel_flow_arn
1171
+ # The ARN of the channel flow.
1172
+ # @return [String]
1173
+ #
1174
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DeleteChannelFlowRequest AWS API Documentation
1175
+ #
1176
+ class DeleteChannelFlowRequest < Struct.new(
1177
+ :channel_flow_arn)
1178
+ SENSITIVE = []
1179
+ include Aws::Structure
1180
+ end
1181
+
836
1182
  # @note When making an API call, you may pass DeleteChannelMembershipRequest
837
1183
  # data as a hash:
838
1184
  #
@@ -994,6 +1340,37 @@ module Aws::ChimeSDKMessaging
994
1340
  include Aws::Structure
995
1341
  end
996
1342
 
1343
+ # @note When making an API call, you may pass DescribeChannelFlowRequest
1344
+ # data as a hash:
1345
+ #
1346
+ # {
1347
+ # channel_flow_arn: "ChimeArn", # required
1348
+ # }
1349
+ #
1350
+ # @!attribute [rw] channel_flow_arn
1351
+ # The ARN of the channel flow.
1352
+ # @return [String]
1353
+ #
1354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlowRequest AWS API Documentation
1355
+ #
1356
+ class DescribeChannelFlowRequest < Struct.new(
1357
+ :channel_flow_arn)
1358
+ SENSITIVE = []
1359
+ include Aws::Structure
1360
+ end
1361
+
1362
+ # @!attribute [rw] channel_flow
1363
+ # The channel flow details.
1364
+ # @return [Types::ChannelFlow]
1365
+ #
1366
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DescribeChannelFlowResponse AWS API Documentation
1367
+ #
1368
+ class DescribeChannelFlowResponse < Struct.new(
1369
+ :channel_flow)
1370
+ SENSITIVE = []
1371
+ include Aws::Structure
1372
+ end
1373
+
997
1374
  # @note When making an API call, you may pass DescribeChannelMembershipForAppInstanceUserRequest
998
1375
  # data as a hash:
999
1376
  #
@@ -1203,15 +1580,46 @@ module Aws::ChimeSDKMessaging
1203
1580
  include Aws::Structure
1204
1581
  end
1205
1582
 
1206
- # The client is permanently forbidden from making the request.
1583
+ # @note When making an API call, you may pass DisassociateChannelFlowRequest
1584
+ # data as a hash:
1207
1585
  #
1208
- # @!attribute [rw] code
1586
+ # {
1587
+ # channel_arn: "ChimeArn", # required
1588
+ # channel_flow_arn: "ChimeArn", # required
1589
+ # chime_bearer: "ChimeArn", # required
1590
+ # }
1591
+ #
1592
+ # @!attribute [rw] channel_arn
1593
+ # The ARN of the channel.
1209
1594
  # @return [String]
1210
1595
  #
1211
- # @!attribute [rw] message
1596
+ # @!attribute [rw] channel_flow_arn
1597
+ # The ARN of the channel flow.
1212
1598
  # @return [String]
1213
1599
  #
1214
- # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ForbiddenException AWS API Documentation
1600
+ # @!attribute [rw] chime_bearer
1601
+ # The `AppInstanceUserArn` of the user making the API call.
1602
+ # @return [String]
1603
+ #
1604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/DisassociateChannelFlowRequest AWS API Documentation
1605
+ #
1606
+ class DisassociateChannelFlowRequest < Struct.new(
1607
+ :channel_arn,
1608
+ :channel_flow_arn,
1609
+ :chime_bearer)
1610
+ SENSITIVE = []
1611
+ include Aws::Structure
1612
+ end
1613
+
1614
+ # The client is permanently forbidden from making the request.
1615
+ #
1616
+ # @!attribute [rw] code
1617
+ # @return [String]
1618
+ #
1619
+ # @!attribute [rw] message
1620
+ # @return [String]
1621
+ #
1622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ForbiddenException AWS API Documentation
1215
1623
  #
1216
1624
  class ForbiddenException < Struct.new(
1217
1625
  :code,
@@ -1263,6 +1671,49 @@ module Aws::ChimeSDKMessaging
1263
1671
  include Aws::Structure
1264
1672
  end
1265
1673
 
1674
+ # @note When making an API call, you may pass GetChannelMessageStatusRequest
1675
+ # data as a hash:
1676
+ #
1677
+ # {
1678
+ # channel_arn: "ChimeArn", # required
1679
+ # message_id: "MessageId", # required
1680
+ # chime_bearer: "ChimeArn", # required
1681
+ # }
1682
+ #
1683
+ # @!attribute [rw] channel_arn
1684
+ # The ARN of the channel
1685
+ # @return [String]
1686
+ #
1687
+ # @!attribute [rw] message_id
1688
+ # The ID of the message.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] chime_bearer
1692
+ # The `AppInstanceUserArn` of the user making the API call.
1693
+ # @return [String]
1694
+ #
1695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusRequest AWS API Documentation
1696
+ #
1697
+ class GetChannelMessageStatusRequest < Struct.new(
1698
+ :channel_arn,
1699
+ :message_id,
1700
+ :chime_bearer)
1701
+ SENSITIVE = []
1702
+ include Aws::Structure
1703
+ end
1704
+
1705
+ # @!attribute [rw] status
1706
+ # The message status and details.
1707
+ # @return [Types::ChannelMessageStatusStructure]
1708
+ #
1709
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetChannelMessageStatusResponse AWS API Documentation
1710
+ #
1711
+ class GetChannelMessageStatusResponse < Struct.new(
1712
+ :status)
1713
+ SENSITIVE = []
1714
+ include Aws::Structure
1715
+ end
1716
+
1266
1717
  # @api private
1267
1718
  #
1268
1719
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/GetMessagingSessionEndpointRequest AWS API Documentation
@@ -1300,6 +1751,33 @@ module Aws::ChimeSDKMessaging
1300
1751
  include Aws::Structure
1301
1752
  end
1302
1753
 
1754
+ # Stores metadata about a Lambda processor.
1755
+ #
1756
+ # @note When making an API call, you may pass LambdaConfiguration
1757
+ # data as a hash:
1758
+ #
1759
+ # {
1760
+ # resource_arn: "LambdaFunctionArn", # required
1761
+ # invocation_type: "ASYNC", # required, accepts ASYNC
1762
+ # }
1763
+ #
1764
+ # @!attribute [rw] resource_arn
1765
+ # The ARN of the Lambda message processing function.
1766
+ # @return [String]
1767
+ #
1768
+ # @!attribute [rw] invocation_type
1769
+ # Controls how the Lambda function is invoked.
1770
+ # @return [String]
1771
+ #
1772
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/LambdaConfiguration AWS API Documentation
1773
+ #
1774
+ class LambdaConfiguration < Struct.new(
1775
+ :resource_arn,
1776
+ :invocation_type)
1777
+ SENSITIVE = []
1778
+ include Aws::Structure
1779
+ end
1780
+
1303
1781
  # @note When making an API call, you may pass ListChannelBansRequest
1304
1782
  # data as a hash:
1305
1783
  #
@@ -1361,6 +1839,56 @@ module Aws::ChimeSDKMessaging
1361
1839
  include Aws::Structure
1362
1840
  end
1363
1841
 
1842
+ # @note When making an API call, you may pass ListChannelFlowsRequest
1843
+ # data as a hash:
1844
+ #
1845
+ # {
1846
+ # app_instance_arn: "ChimeArn", # required
1847
+ # max_results: 1,
1848
+ # next_token: "NextToken",
1849
+ # }
1850
+ #
1851
+ # @!attribute [rw] app_instance_arn
1852
+ # The ARN of the app instance.
1853
+ # @return [String]
1854
+ #
1855
+ # @!attribute [rw] max_results
1856
+ # The maximum number of channel flows that you want to return.
1857
+ # @return [Integer]
1858
+ #
1859
+ # @!attribute [rw] next_token
1860
+ # The token passed by previous API calls until all requested channel
1861
+ # flows are returned.
1862
+ # @return [String]
1863
+ #
1864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlowsRequest AWS API Documentation
1865
+ #
1866
+ class ListChannelFlowsRequest < Struct.new(
1867
+ :app_instance_arn,
1868
+ :max_results,
1869
+ :next_token)
1870
+ SENSITIVE = [:next_token]
1871
+ include Aws::Structure
1872
+ end
1873
+
1874
+ # @!attribute [rw] channel_flows
1875
+ # The information about each channel flow.
1876
+ # @return [Array<Types::ChannelFlowSummary>]
1877
+ #
1878
+ # @!attribute [rw] next_token
1879
+ # The token passed by previous API calls until all requested channels
1880
+ # are returned.
1881
+ # @return [String]
1882
+ #
1883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelFlowsResponse AWS API Documentation
1884
+ #
1885
+ class ListChannelFlowsResponse < Struct.new(
1886
+ :channel_flows,
1887
+ :next_token)
1888
+ SENSITIVE = [:next_token]
1889
+ include Aws::Structure
1890
+ end
1891
+
1364
1892
  # @note When making an API call, you may pass ListChannelMembershipsForAppInstanceUserRequest
1365
1893
  # data as a hash:
1366
1894
  #
@@ -1630,6 +2158,56 @@ module Aws::ChimeSDKMessaging
1630
2158
  include Aws::Structure
1631
2159
  end
1632
2160
 
2161
+ # @note When making an API call, you may pass ListChannelsAssociatedWithChannelFlowRequest
2162
+ # data as a hash:
2163
+ #
2164
+ # {
2165
+ # channel_flow_arn: "ChimeArn", # required
2166
+ # max_results: 1,
2167
+ # next_token: "NextToken",
2168
+ # }
2169
+ #
2170
+ # @!attribute [rw] channel_flow_arn
2171
+ # The ARN of the channel flow.
2172
+ # @return [String]
2173
+ #
2174
+ # @!attribute [rw] max_results
2175
+ # The maximum number of channels that you want to return.
2176
+ # @return [Integer]
2177
+ #
2178
+ # @!attribute [rw] next_token
2179
+ # The token passed by previous API calls until all requested channels
2180
+ # are returned.
2181
+ # @return [String]
2182
+ #
2183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlowRequest AWS API Documentation
2184
+ #
2185
+ class ListChannelsAssociatedWithChannelFlowRequest < Struct.new(
2186
+ :channel_flow_arn,
2187
+ :max_results,
2188
+ :next_token)
2189
+ SENSITIVE = [:next_token]
2190
+ include Aws::Structure
2191
+ end
2192
+
2193
+ # @!attribute [rw] channels
2194
+ # The information about each channel.
2195
+ # @return [Array<Types::ChannelAssociatedWithFlowSummary>]
2196
+ #
2197
+ # @!attribute [rw] next_token
2198
+ # The token passed by previous API calls until all requested channels
2199
+ # are returned.
2200
+ # @return [String]
2201
+ #
2202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListChannelsAssociatedWithChannelFlowResponse AWS API Documentation
2203
+ #
2204
+ class ListChannelsAssociatedWithChannelFlowResponse < Struct.new(
2205
+ :channels,
2206
+ :next_token)
2207
+ SENSITIVE = [:next_token]
2208
+ include Aws::Structure
2209
+ end
2210
+
1633
2211
  # @note When making an API call, you may pass ListChannelsModeratedByAppInstanceUserRequest
1634
2212
  # data as a hash:
1635
2213
  #
@@ -1750,6 +2328,37 @@ module Aws::ChimeSDKMessaging
1750
2328
  include Aws::Structure
1751
2329
  end
1752
2330
 
2331
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2332
+ # data as a hash:
2333
+ #
2334
+ # {
2335
+ # resource_arn: "ChimeArn", # required
2336
+ # }
2337
+ #
2338
+ # @!attribute [rw] resource_arn
2339
+ # The ARN of the resource.
2340
+ # @return [String]
2341
+ #
2342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListTagsForResourceRequest AWS API Documentation
2343
+ #
2344
+ class ListTagsForResourceRequest < Struct.new(
2345
+ :resource_arn)
2346
+ SENSITIVE = []
2347
+ include Aws::Structure
2348
+ end
2349
+
2350
+ # @!attribute [rw] tags
2351
+ # The tag key-value pairs.
2352
+ # @return [Array<Types::Tag>]
2353
+ #
2354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ListTagsForResourceResponse AWS API Documentation
2355
+ #
2356
+ class ListTagsForResourceResponse < Struct.new(
2357
+ :tags)
2358
+ SENSITIVE = []
2359
+ include Aws::Structure
2360
+ end
2361
+
1753
2362
  # The websocket endpoint used to connect to Amazon Chime SDK messaging.
1754
2363
  #
1755
2364
  # @!attribute [rw] url
@@ -1782,6 +2391,81 @@ module Aws::ChimeSDKMessaging
1782
2391
  include Aws::Structure
1783
2392
  end
1784
2393
 
2394
+ # The information about a processor in a channel flow.
2395
+ #
2396
+ # @note When making an API call, you may pass Processor
2397
+ # data as a hash:
2398
+ #
2399
+ # {
2400
+ # name: "NonEmptyResourceName", # required
2401
+ # configuration: { # required
2402
+ # lambda: { # required
2403
+ # resource_arn: "LambdaFunctionArn", # required
2404
+ # invocation_type: "ASYNC", # required, accepts ASYNC
2405
+ # },
2406
+ # },
2407
+ # execution_order: 1, # required
2408
+ # fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
2409
+ # }
2410
+ #
2411
+ # @!attribute [rw] name
2412
+ # The name of the channel flow.
2413
+ # @return [String]
2414
+ #
2415
+ # @!attribute [rw] configuration
2416
+ # The information about the type of processor and its identifier.
2417
+ # @return [Types::ProcessorConfiguration]
2418
+ #
2419
+ # @!attribute [rw] execution_order
2420
+ # The sequence in which processors run. If you have multiple
2421
+ # processors in a channel flow, message processing goes through each
2422
+ # processor in the sequence. The value determines the sequence. At
2423
+ # this point, we support only 1 processor within a flow.
2424
+ # @return [Integer]
2425
+ #
2426
+ # @!attribute [rw] fallback_action
2427
+ # Determines whether to continue or stop processing if communication
2428
+ # with processor fails. If the last processor in a channel flow
2429
+ # sequence has a fallback action of CONTINUE, and communication with
2430
+ # the processor fails, the message is considered processed and sent to
2431
+ # the recipients in the channel.
2432
+ # @return [String]
2433
+ #
2434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Processor AWS API Documentation
2435
+ #
2436
+ class Processor < Struct.new(
2437
+ :name,
2438
+ :configuration,
2439
+ :execution_order,
2440
+ :fallback_action)
2441
+ SENSITIVE = [:name]
2442
+ include Aws::Structure
2443
+ end
2444
+
2445
+ # A processor's metadata.
2446
+ #
2447
+ # @note When making an API call, you may pass ProcessorConfiguration
2448
+ # data as a hash:
2449
+ #
2450
+ # {
2451
+ # lambda: { # required
2452
+ # resource_arn: "LambdaFunctionArn", # required
2453
+ # invocation_type: "ASYNC", # required, accepts ASYNC
2454
+ # },
2455
+ # }
2456
+ #
2457
+ # @!attribute [rw] lambda
2458
+ # Indicates that the processor is of type Lambda.
2459
+ # @return [Types::LambdaConfiguration]
2460
+ #
2461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/ProcessorConfiguration AWS API Documentation
2462
+ #
2463
+ class ProcessorConfiguration < Struct.new(
2464
+ :lambda)
2465
+ SENSITIVE = []
2466
+ include Aws::Structure
2467
+ end
2468
+
1785
2469
  # @note When making an API call, you may pass RedactChannelMessageRequest
1786
2470
  # data as a hash:
1787
2471
  #
@@ -1916,11 +2600,16 @@ module Aws::ChimeSDKMessaging
1916
2600
  # The ID string assigned to each message.
1917
2601
  # @return [String]
1918
2602
  #
2603
+ # @!attribute [rw] status
2604
+ # The status of the channel message.
2605
+ # @return [Types::ChannelMessageStatusStructure]
2606
+ #
1919
2607
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/SendChannelMessageResponse AWS API Documentation
1920
2608
  #
1921
2609
  class SendChannelMessageResponse < Struct.new(
1922
2610
  :channel_arn,
1923
- :message_id)
2611
+ :message_id,
2612
+ :status)
1924
2613
  SENSITIVE = []
1925
2614
  include Aws::Structure
1926
2615
  end
@@ -1959,7 +2648,7 @@ module Aws::ChimeSDKMessaging
1959
2648
  include Aws::Structure
1960
2649
  end
1961
2650
 
1962
- # Describes a tag applied to a resource.
2651
+ # A tag object containing a key-value pair.
1963
2652
  #
1964
2653
  # @note When making an API call, you may pass Tag
1965
2654
  # data as a hash:
@@ -1970,11 +2659,11 @@ module Aws::ChimeSDKMessaging
1970
2659
  # }
1971
2660
  #
1972
2661
  # @!attribute [rw] key
1973
- # The key of the tag.
2662
+ # The key in a tag.
1974
2663
  # @return [String]
1975
2664
  #
1976
2665
  # @!attribute [rw] value
1977
- # The value of the tag.
2666
+ # The value in a tag.
1978
2667
  # @return [String]
1979
2668
  #
1980
2669
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/Tag AWS API Documentation
@@ -1986,6 +2675,36 @@ module Aws::ChimeSDKMessaging
1986
2675
  include Aws::Structure
1987
2676
  end
1988
2677
 
2678
+ # @note When making an API call, you may pass TagResourceRequest
2679
+ # data as a hash:
2680
+ #
2681
+ # {
2682
+ # resource_arn: "ChimeArn", # required
2683
+ # tags: [ # required
2684
+ # {
2685
+ # key: "TagKey", # required
2686
+ # value: "TagValue", # required
2687
+ # },
2688
+ # ],
2689
+ # }
2690
+ #
2691
+ # @!attribute [rw] resource_arn
2692
+ # The resource ARN.
2693
+ # @return [String]
2694
+ #
2695
+ # @!attribute [rw] tags
2696
+ # The tag key-value pairs.
2697
+ # @return [Array<Types::Tag>]
2698
+ #
2699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/TagResourceRequest AWS API Documentation
2700
+ #
2701
+ class TagResourceRequest < Struct.new(
2702
+ :resource_arn,
2703
+ :tags)
2704
+ SENSITIVE = []
2705
+ include Aws::Structure
2706
+ end
2707
+
1989
2708
  # The client exceeded its request rate limit.
1990
2709
  #
1991
2710
  # @!attribute [rw] code
@@ -2020,6 +2739,86 @@ module Aws::ChimeSDKMessaging
2020
2739
  include Aws::Structure
2021
2740
  end
2022
2741
 
2742
+ # @note When making an API call, you may pass UntagResourceRequest
2743
+ # data as a hash:
2744
+ #
2745
+ # {
2746
+ # resource_arn: "ChimeArn", # required
2747
+ # tag_keys: ["TagKey"], # required
2748
+ # }
2749
+ #
2750
+ # @!attribute [rw] resource_arn
2751
+ # The resource ARN.
2752
+ # @return [String]
2753
+ #
2754
+ # @!attribute [rw] tag_keys
2755
+ # The tag keys.
2756
+ # @return [Array<String>]
2757
+ #
2758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UntagResourceRequest AWS API Documentation
2759
+ #
2760
+ class UntagResourceRequest < Struct.new(
2761
+ :resource_arn,
2762
+ :tag_keys)
2763
+ SENSITIVE = []
2764
+ include Aws::Structure
2765
+ end
2766
+
2767
+ # @note When making an API call, you may pass UpdateChannelFlowRequest
2768
+ # data as a hash:
2769
+ #
2770
+ # {
2771
+ # channel_flow_arn: "ChimeArn", # required
2772
+ # processors: [ # required
2773
+ # {
2774
+ # name: "NonEmptyResourceName", # required
2775
+ # configuration: { # required
2776
+ # lambda: { # required
2777
+ # resource_arn: "LambdaFunctionArn", # required
2778
+ # invocation_type: "ASYNC", # required, accepts ASYNC
2779
+ # },
2780
+ # },
2781
+ # execution_order: 1, # required
2782
+ # fallback_action: "CONTINUE", # required, accepts CONTINUE, ABORT
2783
+ # },
2784
+ # ],
2785
+ # name: "NonEmptyResourceName", # required
2786
+ # }
2787
+ #
2788
+ # @!attribute [rw] channel_flow_arn
2789
+ # The ARN of the channel flow.
2790
+ # @return [String]
2791
+ #
2792
+ # @!attribute [rw] processors
2793
+ # Information about the processor Lambda functions
2794
+ # @return [Array<Types::Processor>]
2795
+ #
2796
+ # @!attribute [rw] name
2797
+ # The name of the channel flow.
2798
+ # @return [String]
2799
+ #
2800
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlowRequest AWS API Documentation
2801
+ #
2802
+ class UpdateChannelFlowRequest < Struct.new(
2803
+ :channel_flow_arn,
2804
+ :processors,
2805
+ :name)
2806
+ SENSITIVE = [:name]
2807
+ include Aws::Structure
2808
+ end
2809
+
2810
+ # @!attribute [rw] channel_flow_arn
2811
+ # The ARN of the channel flow.
2812
+ # @return [String]
2813
+ #
2814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelFlowResponse AWS API Documentation
2815
+ #
2816
+ class UpdateChannelFlowResponse < Struct.new(
2817
+ :channel_flow_arn)
2818
+ SENSITIVE = []
2819
+ include Aws::Structure
2820
+ end
2821
+
2023
2822
  # @note When making an API call, you may pass UpdateChannelMessageRequest
2024
2823
  # data as a hash:
2025
2824
  #
@@ -2071,11 +2870,16 @@ module Aws::ChimeSDKMessaging
2071
2870
  # The ID string of the message being updated.
2072
2871
  # @return [String]
2073
2872
  #
2873
+ # @!attribute [rw] status
2874
+ # The status of the message update.
2875
+ # @return [Types::ChannelMessageStatusStructure]
2876
+ #
2074
2877
  # @see http://docs.aws.amazon.com/goto/WebAPI/chime-sdk-messaging-2021-05-15/UpdateChannelMessageResponse AWS API Documentation
2075
2878
  #
2076
2879
  class UpdateChannelMessageResponse < Struct.new(
2077
2880
  :channel_arn,
2078
- :message_id)
2881
+ :message_id,
2882
+ :status)
2079
2883
  SENSITIVE = []
2080
2884
  include Aws::Structure
2081
2885
  end