aws-sdk-connect 1.140.0 → 1.142.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -300,6 +300,59 @@ module Aws::Connect
300
300
  include Aws::Structure
301
301
  end
302
302
 
303
+ # Information about the capabilities enabled for participants of the
304
+ # contact.
305
+ #
306
+ # @!attribute [rw] customer
307
+ # Information about the customer's video sharing capabilities.
308
+ # @return [Types::ParticipantCapabilities]
309
+ #
310
+ # @!attribute [rw] agent
311
+ # Information about the agent's video sharing capabilities.
312
+ # @return [Types::ParticipantCapabilities]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AllowedCapabilities AWS API Documentation
315
+ #
316
+ class AllowedCapabilities < Struct.new(
317
+ :customer,
318
+ :agent)
319
+ SENSITIVE = []
320
+ include Aws::Structure
321
+ end
322
+
323
+ # This API is in preview release for Amazon Connect and is subject to
324
+ # change.
325
+ #
326
+ # Information about associations that are successfully created:
327
+ # `DataSetId`, `TargetAccountId`, `ResourceShareId`, `ResourceShareArn`.
328
+ #
329
+ # @!attribute [rw] data_set_id
330
+ # The identifier of the dataset.
331
+ # @return [String]
332
+ #
333
+ # @!attribute [rw] target_account_id
334
+ # The identifier of the target account.
335
+ # @return [String]
336
+ #
337
+ # @!attribute [rw] resource_share_id
338
+ # The Resource Access Manager share ID.
339
+ # @return [String]
340
+ #
341
+ # @!attribute [rw] resource_share_arn
342
+ # The Amazon Resource Name (ARN) of the Resource Access Manager share.
343
+ # @return [String]
344
+ #
345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AnalyticsDataAssociationResult AWS API Documentation
346
+ #
347
+ class AnalyticsDataAssociationResult < Struct.new(
348
+ :data_set_id,
349
+ :target_account_id,
350
+ :resource_share_id,
351
+ :resource_share_arn)
352
+ SENSITIVE = []
353
+ include Aws::Structure
354
+ end
355
+
303
356
  # Configuration of the answering machine detection.
304
357
  #
305
358
  # @!attribute [rw] enable_answer_machine_detection
@@ -346,8 +399,9 @@ module Aws::Connect
346
399
 
347
400
  # This action must be set if `TriggerEventSource` is one of the
348
401
  # following values: `OnPostCallAnalysisAvailable` \|
349
- # `OnRealTimeCallAnalysisAvailable` \| `OnPostChatAnalysisAvailable`.
350
- # Contact is categorized using the rule name.
402
+ # `OnRealTimeCallAnalysisAvailable` \| `OnRealTimeChatAnalysisAvailable`
403
+ # \| `OnPostChatAnalysisAvailable`. Contact is categorized using the
404
+ # rule name.
351
405
  #
352
406
  # `RuleName` is used as `ContactCategory`.
353
407
  #
@@ -357,6 +411,63 @@ module Aws::Connect
357
411
  #
358
412
  class AssignContactCategoryActionDefinition < Aws::EmptyStructure; end
359
413
 
414
+ # @!attribute [rw] instance_id
415
+ # The identifier of the Amazon Connect instance. You can [find the
416
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
417
+ #
418
+ #
419
+ #
420
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
421
+ # @return [String]
422
+ #
423
+ # @!attribute [rw] data_set_id
424
+ # The identifier of the dataset to associate with the target account.
425
+ # @return [String]
426
+ #
427
+ # @!attribute [rw] target_account_id
428
+ # The identifier of the target account. Use to associate a dataset to
429
+ # a different account than the one containing the Amazon Connect
430
+ # instance. If not specified, by default this value is the Amazon Web
431
+ # Services account that has the Amazon Connect instance.
432
+ # @return [String]
433
+ #
434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateAnalyticsDataSetRequest AWS API Documentation
435
+ #
436
+ class AssociateAnalyticsDataSetRequest < Struct.new(
437
+ :instance_id,
438
+ :data_set_id,
439
+ :target_account_id)
440
+ SENSITIVE = []
441
+ include Aws::Structure
442
+ end
443
+
444
+ # @!attribute [rw] data_set_id
445
+ # The identifier of the dataset that was associated.
446
+ # @return [String]
447
+ #
448
+ # @!attribute [rw] target_account_id
449
+ # The identifier of the target account.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] resource_share_id
453
+ # The Resource Access Manager share ID that is generated.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] resource_share_arn
457
+ # The Amazon Resource Name (ARN) of the Resource Access Manager share.
458
+ # @return [String]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateAnalyticsDataSetResponse AWS API Documentation
461
+ #
462
+ class AssociateAnalyticsDataSetResponse < Struct.new(
463
+ :data_set_id,
464
+ :target_account_id,
465
+ :resource_share_id,
466
+ :resource_share_arn)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
360
471
  # @!attribute [rw] instance_id
361
472
  # The identifier of the Amazon Connect instance. You can [find the
362
473
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -444,6 +555,42 @@ module Aws::Connect
444
555
  #
445
556
  class AssociateDefaultVocabularyResponse < Aws::EmptyStructure; end
446
557
 
558
+ # @!attribute [rw] instance_id
559
+ # The identifier of the Amazon Connect instance. You can [find the
560
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
561
+ #
562
+ #
563
+ #
564
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] resource_id
568
+ # The identifier of the resource.
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] flow_id
572
+ # The identifier of the flow.
573
+ # @return [String]
574
+ #
575
+ # @!attribute [rw] resource_type
576
+ # A valid resource type.
577
+ # @return [String]
578
+ #
579
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateFlowRequest AWS API Documentation
580
+ #
581
+ class AssociateFlowRequest < Struct.new(
582
+ :instance_id,
583
+ :resource_id,
584
+ :flow_id,
585
+ :resource_type)
586
+ SENSITIVE = []
587
+ include Aws::Structure
588
+ end
589
+
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateFlowResponse AWS API Documentation
591
+ #
592
+ class AssociateFlowResponse < Aws::EmptyStructure; end
593
+
447
594
  # @!attribute [rw] instance_id
448
595
  # The identifier of the Amazon Connect instance. You can [find the
449
596
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -705,6 +852,25 @@ module Aws::Connect
705
852
  include Aws::Structure
706
853
  end
707
854
 
855
+ # The attendee information, including attendee ID and join token.
856
+ #
857
+ # @!attribute [rw] attendee_id
858
+ # The Amazon Chime SDK attendee ID.
859
+ # @return [String]
860
+ #
861
+ # @!attribute [rw] join_token
862
+ # The join token used by the Amazon Chime SDK attendee.
863
+ # @return [String]
864
+ #
865
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Attendee AWS API Documentation
866
+ #
867
+ class Attendee < Struct.new(
868
+ :attendee_id,
869
+ :join_token)
870
+ SENSITIVE = [:join_token]
871
+ include Aws::Structure
872
+ end
873
+
708
874
  # A toggle for an individual feature at the instance level.
709
875
  #
710
876
  # @!attribute [rw] attribute_type
@@ -724,6 +890,22 @@ module Aws::Connect
724
890
  include Aws::Structure
725
891
  end
726
892
 
893
+ # Has audio-specific configurations as the operating parameter for Echo
894
+ # Reduction.
895
+ #
896
+ # @!attribute [rw] echo_reduction
897
+ # Makes echo reduction available to clients who connect to the
898
+ # meeting.
899
+ # @return [String]
900
+ #
901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AudioFeatures AWS API Documentation
902
+ #
903
+ class AudioFeatures < Struct.new(
904
+ :echo_reduction)
905
+ SENSITIVE = []
906
+ include Aws::Structure
907
+ end
908
+
727
909
  # Information about available phone numbers.
728
910
  #
729
911
  # @!attribute [rw] phone_number
@@ -749,6 +931,103 @@ module Aws::Connect
749
931
  include Aws::Structure
750
932
  end
751
933
 
934
+ # @!attribute [rw] instance_id
935
+ # The identifier of the Amazon Connect instance. You can [find the
936
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
937
+ #
938
+ #
939
+ #
940
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
941
+ # @return [String]
942
+ #
943
+ # @!attribute [rw] data_set_ids
944
+ # An array of dataset identifiers to associate.
945
+ # @return [Array<String>]
946
+ #
947
+ # @!attribute [rw] target_account_id
948
+ # The identifier of the target account. Use to associate a dataset to
949
+ # a different account than the one containing the Amazon Connect
950
+ # instance. If not specified, by default this value is the Amazon Web
951
+ # Services account that has the Amazon Connect instance.
952
+ # @return [String]
953
+ #
954
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchAssociateAnalyticsDataSetRequest AWS API Documentation
955
+ #
956
+ class BatchAssociateAnalyticsDataSetRequest < Struct.new(
957
+ :instance_id,
958
+ :data_set_ids,
959
+ :target_account_id)
960
+ SENSITIVE = []
961
+ include Aws::Structure
962
+ end
963
+
964
+ # @!attribute [rw] created
965
+ # Information about associations that are successfully created:
966
+ # `DataSetId`, `TargetAccountId`, `ResourceShareId`,
967
+ # `ResourceShareArn`.
968
+ # @return [Array<Types::AnalyticsDataAssociationResult>]
969
+ #
970
+ # @!attribute [rw] errors
971
+ # A list of errors for datasets that aren't successfully associated
972
+ # with the target account.
973
+ # @return [Array<Types::ErrorResult>]
974
+ #
975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchAssociateAnalyticsDataSetResponse AWS API Documentation
976
+ #
977
+ class BatchAssociateAnalyticsDataSetResponse < Struct.new(
978
+ :created,
979
+ :errors)
980
+ SENSITIVE = []
981
+ include Aws::Structure
982
+ end
983
+
984
+ # @!attribute [rw] instance_id
985
+ # The identifier of the Amazon Connect instance. You can [find the
986
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
987
+ #
988
+ #
989
+ #
990
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
991
+ # @return [String]
992
+ #
993
+ # @!attribute [rw] data_set_ids
994
+ # An array of associated dataset identifiers to remove.
995
+ # @return [Array<String>]
996
+ #
997
+ # @!attribute [rw] target_account_id
998
+ # The identifier of the target account. Use to disassociate a dataset
999
+ # from a different account than the one containing the Amazon Connect
1000
+ # instance. If not specified, by default this value is the Amazon Web
1001
+ # Services account that has the Amazon Connect instance.
1002
+ # @return [String]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchDisassociateAnalyticsDataSetRequest AWS API Documentation
1005
+ #
1006
+ class BatchDisassociateAnalyticsDataSetRequest < Struct.new(
1007
+ :instance_id,
1008
+ :data_set_ids,
1009
+ :target_account_id)
1010
+ SENSITIVE = []
1011
+ include Aws::Structure
1012
+ end
1013
+
1014
+ # @!attribute [rw] deleted
1015
+ # An array of successfully disassociated dataset identifiers.
1016
+ # @return [Array<String>]
1017
+ #
1018
+ # @!attribute [rw] errors
1019
+ # A list of errors for any datasets not successfully removed.
1020
+ # @return [Array<Types::ErrorResult>]
1021
+ #
1022
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchDisassociateAnalyticsDataSetResponse AWS API Documentation
1023
+ #
1024
+ class BatchDisassociateAnalyticsDataSetResponse < Struct.new(
1025
+ :deleted,
1026
+ :errors)
1027
+ SENSITIVE = []
1028
+ include Aws::Structure
1029
+ end
1030
+
752
1031
  # @!attribute [rw] instance_id
753
1032
  # The identifier of the Amazon Connect instance. You can [find the
754
1033
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -856,6 +1135,65 @@ module Aws::Connect
856
1135
  include Aws::Structure
857
1136
  end
858
1137
 
1138
+ # Chat integration event containing payload to perform different chat
1139
+ # actions such as:
1140
+ #
1141
+ # * Sending a chat message
1142
+ #
1143
+ # * Sending a chat event, such as typing
1144
+ #
1145
+ # * Disconnecting from a chat
1146
+ #
1147
+ # @!attribute [rw] type
1148
+ # Type of chat integration event.
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] content_type
1152
+ # Type of content. This is required when `Type` is `MESSAGE` or
1153
+ # `EVENT`.
1154
+ #
1155
+ # * For allowed message content types, see the `ContentType` parameter
1156
+ # in the [SendMessage][1] topic in the *Amazon Connect Participant
1157
+ # Service API Reference*.
1158
+ #
1159
+ # * For allowed event content types, see the `ContentType` parameter
1160
+ # in the [SendEvent][2] topic in the *Amazon Connect Participant
1161
+ # Service API Reference*.
1162
+ #
1163
+ #
1164
+ #
1165
+ # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html
1166
+ # [2]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html
1167
+ # @return [String]
1168
+ #
1169
+ # @!attribute [rw] content
1170
+ # Content of the message or event. This is required when `Type` is
1171
+ # `MESSAGE` and for certain `ContentTypes` when `Type` is `EVENT`.
1172
+ #
1173
+ # * For allowed message content, see the `Content` parameter in the
1174
+ # [SendMessage][1] topic in the *Amazon Connect Participant Service
1175
+ # API Reference*.
1176
+ #
1177
+ # * For allowed event content, see the `Content` parameter in the
1178
+ # [SendEvent][2] topic in the *Amazon Connect Participant Service
1179
+ # API Reference*.
1180
+ #
1181
+ #
1182
+ #
1183
+ # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html
1184
+ # [2]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html
1185
+ # @return [String]
1186
+ #
1187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ChatEvent AWS API Documentation
1188
+ #
1189
+ class ChatEvent < Struct.new(
1190
+ :type,
1191
+ :content_type,
1192
+ :content)
1193
+ SENSITIVE = []
1194
+ include Aws::Structure
1195
+ end
1196
+
859
1197
  # A chat message.
860
1198
  #
861
1199
  # @!attribute [rw] content_type
@@ -1084,6 +1422,13 @@ module Aws::Connect
1084
1422
  # [4]: https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html
1085
1423
  # @return [Types::PhoneNumberStatus]
1086
1424
  #
1425
+ # @!attribute [rw] source_phone_number_arn
1426
+ # The claimed phone number ARN that was previously imported from the
1427
+ # external service, such as Amazon Pinpoint. If it is from Amazon
1428
+ # Pinpoint, it looks like the ARN of the phone number that was
1429
+ # imported from Amazon Pinpoint.
1430
+ # @return [String]
1431
+ #
1087
1432
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ClaimedPhoneNumberSummary AWS API Documentation
1088
1433
  #
1089
1434
  class ClaimedPhoneNumberSummary < Struct.new(
@@ -1096,7 +1441,27 @@ module Aws::Connect
1096
1441
  :target_arn,
1097
1442
  :instance_id,
1098
1443
  :tags,
1099
- :phone_number_status)
1444
+ :phone_number_status,
1445
+ :source_phone_number_arn)
1446
+ SENSITIVE = []
1447
+ include Aws::Structure
1448
+ end
1449
+
1450
+ # Information required to join the call.
1451
+ #
1452
+ # @!attribute [rw] attendee
1453
+ # The attendee information, including attendee ID and join token.
1454
+ # @return [Types::Attendee]
1455
+ #
1456
+ # @!attribute [rw] meeting
1457
+ # A meeting created using the Amazon Chime SDK.
1458
+ # @return [Types::Meeting]
1459
+ #
1460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ConnectionData AWS API Documentation
1461
+ #
1462
+ class ConnectionData < Struct.new(
1463
+ :attendee,
1464
+ :meeting)
1100
1465
  SENSITIVE = []
1101
1466
  include Aws::Structure
1102
1467
  end
@@ -1883,6 +2248,12 @@ module Aws::Connect
1883
2248
  # Your contact center allows outbound calls.
1884
2249
  # @return [Boolean]
1885
2250
  #
2251
+ # @!attribute [rw] tags
2252
+ # The tags used to organize, track, or control access for this
2253
+ # resource. For example, `\{ "tags": \{"key1":"value1",
2254
+ # "key2":"value2"\} \}`.
2255
+ # @return [Hash<String,String>]
2256
+ #
1886
2257
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateInstanceRequest AWS API Documentation
1887
2258
  #
1888
2259
  class CreateInstanceRequest < Struct.new(
@@ -1891,7 +2262,8 @@ module Aws::Connect
1891
2262
  :instance_alias,
1892
2263
  :directory_id,
1893
2264
  :inbound_calls_enabled,
1894
- :outbound_calls_enabled)
2265
+ :outbound_calls_enabled,
2266
+ :tags)
1895
2267
  SENSITIVE = [:instance_alias]
1896
2268
  include Aws::Structure
1897
2269
  end
@@ -4721,6 +5093,36 @@ module Aws::Connect
4721
5093
  include Aws::Structure
4722
5094
  end
4723
5095
 
5096
+ # @!attribute [rw] instance_id
5097
+ # The identifier of the Amazon Connect instance. You can [find the
5098
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5099
+ #
5100
+ #
5101
+ #
5102
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5103
+ # @return [String]
5104
+ #
5105
+ # @!attribute [rw] data_set_id
5106
+ # The identifier of the dataset to remove.
5107
+ # @return [String]
5108
+ #
5109
+ # @!attribute [rw] target_account_id
5110
+ # The identifier of the target account. Use to associate a dataset to
5111
+ # a different account than the one containing the Amazon Connect
5112
+ # instance. If not specified, by default this value is the Amazon Web
5113
+ # Services account that has the Amazon Connect instance.
5114
+ # @return [String]
5115
+ #
5116
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateAnalyticsDataSetRequest AWS API Documentation
5117
+ #
5118
+ class DisassociateAnalyticsDataSetRequest < Struct.new(
5119
+ :instance_id,
5120
+ :data_set_id,
5121
+ :target_account_id)
5122
+ SENSITIVE = []
5123
+ include Aws::Structure
5124
+ end
5125
+
4724
5126
  # @!attribute [rw] instance_id
4725
5127
  # The identifier of the Amazon Connect instance. You can [find the
4726
5128
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -4770,6 +5172,37 @@ module Aws::Connect
4770
5172
  include Aws::Structure
4771
5173
  end
4772
5174
 
5175
+ # @!attribute [rw] instance_id
5176
+ # The identifier of the Amazon Connect instance. You can [find the
5177
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5178
+ #
5179
+ #
5180
+ #
5181
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5182
+ # @return [String]
5183
+ #
5184
+ # @!attribute [rw] resource_id
5185
+ # The identifier of the resource.
5186
+ # @return [String]
5187
+ #
5188
+ # @!attribute [rw] resource_type
5189
+ # A valid resource type.
5190
+ # @return [String]
5191
+ #
5192
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlowRequest AWS API Documentation
5193
+ #
5194
+ class DisassociateFlowRequest < Struct.new(
5195
+ :instance_id,
5196
+ :resource_id,
5197
+ :resource_type)
5198
+ SENSITIVE = []
5199
+ include Aws::Structure
5200
+ end
5201
+
5202
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlowResponse AWS API Documentation
5203
+ #
5204
+ class DisassociateFlowResponse < Aws::EmptyStructure; end
5205
+
4773
5206
  # @!attribute [rw] instance_id
4774
5207
  # The identifier of the Amazon Connect instance. You can [find the
4775
5208
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -5128,9 +5561,31 @@ module Aws::Connect
5128
5561
  include Aws::Structure
5129
5562
  end
5130
5563
 
5131
- # Information about a contact evaluation.
5564
+ # This API is in preview release for Amazon Connect and is subject to
5565
+ # change.
5132
5566
  #
5133
- # @!attribute [rw] evaluation_id
5567
+ # List of errors for dataset association failures.
5568
+ #
5569
+ # @!attribute [rw] error_code
5570
+ # The error code.
5571
+ # @return [String]
5572
+ #
5573
+ # @!attribute [rw] error_message
5574
+ # The corresponding error message for the error code.
5575
+ # @return [String]
5576
+ #
5577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ErrorResult AWS API Documentation
5578
+ #
5579
+ class ErrorResult < Struct.new(
5580
+ :error_code,
5581
+ :error_message)
5582
+ SENSITIVE = []
5583
+ include Aws::Structure
5584
+ end
5585
+
5586
+ # Information about a contact evaluation.
5587
+ #
5588
+ # @!attribute [rw] evaluation_id
5134
5589
  # A unique identifier for the contact evaluation.
5135
5590
  # @return [String]
5136
5591
  #
@@ -6490,6 +6945,55 @@ module Aws::Connect
6490
6945
  include Aws::Structure
6491
6946
  end
6492
6947
 
6948
+ # @!attribute [rw] instance_id
6949
+ # The identifier of the Amazon Connect instance. You can [find the
6950
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
6951
+ #
6952
+ #
6953
+ #
6954
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
6955
+ # @return [String]
6956
+ #
6957
+ # @!attribute [rw] resource_id
6958
+ # The identifier of the resource.
6959
+ # @return [String]
6960
+ #
6961
+ # @!attribute [rw] resource_type
6962
+ # A valid resource type.
6963
+ # @return [String]
6964
+ #
6965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociationRequest AWS API Documentation
6966
+ #
6967
+ class GetFlowAssociationRequest < Struct.new(
6968
+ :instance_id,
6969
+ :resource_id,
6970
+ :resource_type)
6971
+ SENSITIVE = []
6972
+ include Aws::Structure
6973
+ end
6974
+
6975
+ # @!attribute [rw] resource_id
6976
+ # The identifier of the resource.
6977
+ # @return [String]
6978
+ #
6979
+ # @!attribute [rw] flow_id
6980
+ # The identifier of the flow.
6981
+ # @return [String]
6982
+ #
6983
+ # @!attribute [rw] resource_type
6984
+ # A valid resource type.
6985
+ # @return [String]
6986
+ #
6987
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociationResponse AWS API Documentation
6988
+ #
6989
+ class GetFlowAssociationResponse < Struct.new(
6990
+ :resource_id,
6991
+ :flow_id,
6992
+ :resource_type)
6993
+ SENSITIVE = []
6994
+ include Aws::Structure
6995
+ end
6996
+
6493
6997
  # @!attribute [rw] instance_id
6494
6998
  # The identifier of the Amazon Connect instance. You can [find the
6495
6999
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -6851,7 +7355,7 @@ module Aws::Connect
6851
7355
  # `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6852
7356
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6853
7357
  # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
6854
- # `FEATURE`
7358
+ # `FEATURE` \| `contact/segmentAttributes/connect:Subtype`
6855
7359
  #
6856
7360
  # * **Filter values**: A maximum of 100 filter values are supported in
6857
7361
  # a single request. VOICE, CHAT, and TASK are valid `filterValue`
@@ -6864,6 +7368,10 @@ module Aws::Connect
6864
7368
  # the `FEATURE` filter key. It is available only to contacts
6865
7369
  # analyzed by Contact Lens conversational analytics.
6866
7370
  #
7371
+ # `connect:Chat`, `connect:SMS`, `connect:Telephony`, and
7372
+ # `connect:WebRTC` are valid `filterValue` examples (not exhaustive)
7373
+ # for the `contact/segmentAttributes/connect:Subtype filter` key.
7374
+ #
6867
7375
  #
6868
7376
  #
6869
7377
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
@@ -6880,7 +7388,8 @@ module Aws::Connect
6880
7388
  # Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
6881
7389
  # `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6882
7390
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6883
- # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
7391
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`,
7392
+ # `contact/segmentAttributes/connect:Subtype`
6884
7393
  # @return [Array<String>]
6885
7394
  #
6886
7395
  # @!attribute [rw] metrics
@@ -6894,7 +7403,8 @@ module Aws::Connect
6894
7403
  # : Unit: Percent
6895
7404
  #
6896
7405
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6897
- # Agent, Agent Hierarchy
7406
+ # Agent, Agent Hierarchy, Feature,
7407
+ # contact/segmentAttributes/connect:Subtype
6898
7408
  #
6899
7409
  # AGENT\_ADHERENT\_TIME
6900
7410
  #
@@ -6906,6 +7416,20 @@ module Aws::Connect
6906
7416
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6907
7417
  # Agent, Agent Hierarchy
6908
7418
  #
7419
+ # AGENT\_ANSWER\_RATE
7420
+ #
7421
+ # : Unit: Percent
7422
+ #
7423
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7424
+ # Agent, Agent Hierarchy
7425
+ #
7426
+ # AGENT\_NON\_ADHERENT\_TIME
7427
+ #
7428
+ # : Unit: Seconds
7429
+ #
7430
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7431
+ # Agent, Agent Hierarchy
7432
+ #
6909
7433
  # AGENT\_NON\_RESPONSE
6910
7434
  #
6911
7435
  # : Unit: Count
@@ -6955,14 +7479,18 @@ module Aws::Connect
6955
7479
  # : Unit: Seconds
6956
7480
  #
6957
7481
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6958
- # Agent, Agent Hierarchy
7482
+ # Agent, Agent Hierarchy, Feature,
7483
+ # contact/segmentAttributes/connect:Subtype
6959
7484
  #
6960
7485
  # AVG\_AFTER\_CONTACT\_WORK\_TIME
6961
7486
  #
6962
7487
  # : Unit: Seconds
6963
7488
  #
7489
+ # Valid metric filter key: `INITIATION_METHOD`
7490
+ #
6964
7491
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6965
- # Agent, Agent Hierarchy, Feature
7492
+ # Agent, Agent Hierarchy, Feature,
7493
+ # contact/segmentAttributes/connect:Subtype
6966
7494
  #
6967
7495
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6968
7496
  #
@@ -6989,7 +7517,8 @@ module Aws::Connect
6989
7517
  # : Unit: Seconds
6990
7518
  #
6991
7519
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6992
- # Agent, Agent Hierarchy, Feature
7520
+ # Agent, Agent Hierarchy, Feature,
7521
+ # contact/segmentAttributes/connect:Subtype
6993
7522
  #
6994
7523
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6995
7524
  #
@@ -7000,7 +7529,8 @@ module Aws::Connect
7000
7529
  # : Unit: Seconds
7001
7530
  #
7002
7531
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7003
- # Agent, Agent Hierarchy
7532
+ # Agent, Agent Hierarchy, Feature,
7533
+ # contact/segmentAttributes/connect:Subtype
7004
7534
  #
7005
7535
  # AVG\_GREETING\_TIME\_AGENT
7006
7536
  #
@@ -7010,14 +7540,15 @@ module Aws::Connect
7010
7540
  # Unit: Seconds
7011
7541
  #
7012
7542
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7013
- # Agent, Agent Hierarchy
7543
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7014
7544
  #
7015
7545
  # AVG\_HANDLE\_TIME
7016
7546
  #
7017
7547
  # : Unit: Seconds
7018
7548
  #
7019
7549
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7020
- # Agent, Agent Hierarchy, Feature
7550
+ # Agent, Agent Hierarchy, Feature,
7551
+ # contact/segmentAttributes/connect:Subtype
7021
7552
  #
7022
7553
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7023
7554
  #
@@ -7028,7 +7559,8 @@ module Aws::Connect
7028
7559
  # : Unit: Seconds
7029
7560
  #
7030
7561
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7031
- # Agent, Agent Hierarchy, Feature
7562
+ # Agent, Agent Hierarchy, Feature,
7563
+ # contact/segmentAttributes/connect:Subtype
7032
7564
  #
7033
7565
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7034
7566
  #
@@ -7039,14 +7571,15 @@ module Aws::Connect
7039
7571
  # : Unit: Seconds
7040
7572
  #
7041
7573
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7042
- # Agent, Agent Hierarchy
7574
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7043
7575
  #
7044
7576
  # AVG\_HOLDS
7045
7577
  #
7046
7578
  # : Unit: Count
7047
7579
  #
7048
7580
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7049
- # Agent, Agent Hierarchy, Feature
7581
+ # Agent, Agent Hierarchy, Feature,
7582
+ # contact/segmentAttributes/connect:Subtype
7050
7583
  #
7051
7584
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7052
7585
  #
@@ -7057,14 +7590,16 @@ module Aws::Connect
7057
7590
  # : Unit: Seconds
7058
7591
  #
7059
7592
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7060
- # Agent, Agent Hierarchy
7593
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7061
7594
  #
7062
7595
  # AVG\_INTERACTION\_TIME
7063
7596
  #
7064
7597
  # : Unit: Seconds
7065
7598
  #
7599
+ # Valid metric filter key: `INITIATION_METHOD`
7600
+ #
7066
7601
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7067
- # Feature
7602
+ # Feature, contact/segmentAttributes/connect:Subtype
7068
7603
  #
7069
7604
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7070
7605
  #
@@ -7078,7 +7613,7 @@ module Aws::Connect
7078
7613
  # Unit: Count
7079
7614
  #
7080
7615
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7081
- # Agent, Agent Hierarchy
7616
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7082
7617
  #
7083
7618
  # AVG\_INTERRUPTION\_TIME\_AGENT
7084
7619
  #
@@ -7088,7 +7623,7 @@ module Aws::Connect
7088
7623
  # Unit: Seconds
7089
7624
  #
7090
7625
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7091
- # Agent, Agent Hierarchy
7626
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7092
7627
  #
7093
7628
  # AVG\_NON\_TALK\_TIME
7094
7629
  #
@@ -7098,14 +7633,14 @@ module Aws::Connect
7098
7633
  # Unit: Seconds
7099
7634
  #
7100
7635
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7101
- # Agent, Agent Hierarchy
7636
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7102
7637
  #
7103
7638
  # AVG\_QUEUE\_ANSWER\_TIME
7104
7639
  #
7105
7640
  # : Unit: Seconds
7106
7641
  #
7107
7642
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7108
- # Feature
7643
+ # Feature, contact/segmentAttributes/connect:Subtype
7109
7644
  #
7110
7645
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7111
7646
  #
@@ -7115,7 +7650,8 @@ module Aws::Connect
7115
7650
  #
7116
7651
  # : Unit: Seconds
7117
7652
  #
7118
- # Valid groupings and filters: Queue, Channel, Routing Profile
7653
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7654
+ # contact/segmentAttributes/connect:Subtype
7119
7655
  #
7120
7656
  # AVG\_TALK\_TIME
7121
7657
  #
@@ -7125,7 +7661,7 @@ module Aws::Connect
7125
7661
  # Unit: Seconds
7126
7662
  #
7127
7663
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7128
- # Agent, Agent Hierarchy
7664
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7129
7665
  #
7130
7666
  # AVG\_TALK\_TIME\_AGENT
7131
7667
  #
@@ -7135,7 +7671,7 @@ module Aws::Connect
7135
7671
  # Unit: Seconds
7136
7672
  #
7137
7673
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7138
- # Agent, Agent Hierarchy
7674
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7139
7675
  #
7140
7676
  # AVG\_TALK\_TIME\_CUSTOMER
7141
7677
  #
@@ -7145,14 +7681,14 @@ module Aws::Connect
7145
7681
  # Unit: Seconds
7146
7682
  #
7147
7683
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7148
- # Agent, Agent Hierarchy
7684
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7149
7685
  #
7150
7686
  # CONTACTS\_ABANDONED
7151
7687
  #
7152
7688
  # : Unit: Count
7153
7689
  #
7154
7690
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7155
- # Agent, Agent Hierarchy
7691
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7156
7692
  #
7157
7693
  # CONTACTS\_CREATED
7158
7694
  #
@@ -7161,7 +7697,7 @@ module Aws::Connect
7161
7697
  # Valid metric filter key: `INITIATION_METHOD`
7162
7698
  #
7163
7699
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7164
- # Feature
7700
+ # Feature, contact/segmentAttributes/connect:Subtype
7165
7701
  #
7166
7702
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7167
7703
  #
@@ -7174,7 +7710,8 @@ module Aws::Connect
7174
7710
  # Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
7175
7711
  #
7176
7712
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7177
- # Agent, Agent Hierarchy, Feature
7713
+ # Agent, Agent Hierarchy, Feature,
7714
+ # contact/segmentAttributes/connect:Subtype
7178
7715
  #
7179
7716
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7180
7717
  #
@@ -7185,20 +7722,56 @@ module Aws::Connect
7185
7722
  # : Unit: Count
7186
7723
  #
7187
7724
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7725
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7726
+ #
7727
+ # CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
7728
+ #
7729
+ # : Unit: Count
7730
+ #
7731
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7188
7732
  # Agent, Agent Hierarchy
7189
7733
  #
7190
- # CONTACTS\_QUEUED
7734
+ # CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
7191
7735
  #
7192
7736
  # : Unit: Count
7193
7737
  #
7194
7738
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7195
7739
  # Agent, Agent Hierarchy
7196
7740
  #
7741
+ # CONTACTS\_PUT\_ON\_HOLD
7742
+ #
7743
+ # : Unit: Count
7744
+ #
7745
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7746
+ # Agent, Agent Hierarchy
7747
+ #
7748
+ # CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
7749
+ #
7750
+ # : Unit: Count
7751
+ #
7752
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7753
+ # Agent, Agent Hierarchy
7754
+ #
7755
+ # CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
7756
+ #
7757
+ # : Unit: Percent
7758
+ #
7759
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7760
+ # Agent, Agent Hierarchy
7761
+ #
7762
+ # CONTACTS\_QUEUED
7763
+ #
7764
+ # : Unit: Count
7765
+ #
7766
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7767
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7768
+ #
7197
7769
  # CONTACTS\_RESOLVED\_IN\_X
7198
7770
  #
7199
7771
  # : Unit: Count
7200
7772
  #
7201
- # Valid groupings and filters: Queue, Channel, Routing Profile
7773
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7774
+ # contact/segmentAttributes/connect:Subtype
7202
7775
  #
7203
7776
  # Threshold: For `ThresholdValue` enter any whole number from 1 to
7204
7777
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7209,7 +7782,8 @@ module Aws::Connect
7209
7782
  # : Unit: Count
7210
7783
  #
7211
7784
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7212
- # Agent, Agent Hierarchy, Feature
7785
+ # Agent, Agent Hierarchy, Feature,
7786
+ # contact/segmentAttributes/connect:Subtype
7213
7787
  #
7214
7788
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7215
7789
  #
@@ -7220,21 +7794,21 @@ module Aws::Connect
7220
7794
  # : Unit: Count
7221
7795
  #
7222
7796
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7223
- # Agent, Agent Hierarchy
7797
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7224
7798
  #
7225
7799
  # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
7226
7800
  #
7227
7801
  # : Unit: Count
7228
7802
  #
7229
7803
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7230
- # Agent, Agent Hierarchy
7804
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7231
7805
  #
7232
7806
  # MAX\_QUEUED\_TIME
7233
7807
  #
7234
7808
  # : Unit: Seconds
7235
7809
  #
7236
7810
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7237
- # Agent, Agent Hierarchy
7811
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7238
7812
  #
7239
7813
  # PERCENT\_NON\_TALK\_TIME
7240
7814
  #
@@ -7244,7 +7818,7 @@ module Aws::Connect
7244
7818
  # Unit: Percentage
7245
7819
  #
7246
7820
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7247
- # Agent, Agent Hierarchy
7821
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7248
7822
  #
7249
7823
  # PERCENT\_TALK\_TIME
7250
7824
  #
@@ -7254,7 +7828,7 @@ module Aws::Connect
7254
7828
  # Unit: Percentage
7255
7829
  #
7256
7830
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7257
- # Agent, Agent Hierarchy
7831
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7258
7832
  #
7259
7833
  # PERCENT\_TALK\_TIME\_AGENT
7260
7834
  #
@@ -7264,7 +7838,7 @@ module Aws::Connect
7264
7838
  # Unit: Percentage
7265
7839
  #
7266
7840
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7267
- # Agent, Agent Hierarchy
7841
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7268
7842
  #
7269
7843
  # PERCENT\_TALK\_TIME\_CUSTOMER
7270
7844
  #
@@ -7274,7 +7848,7 @@ module Aws::Connect
7274
7848
  # Unit: Percentage
7275
7849
  #
7276
7850
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7277
- # Agent, Agent Hierarchy
7851
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7278
7852
  #
7279
7853
  # SERVICE\_LEVEL
7280
7854
  #
@@ -7288,11 +7862,49 @@ module Aws::Connect
7288
7862
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
7289
7863
  # `LT` (for "Less than").
7290
7864
  #
7865
+ # SUM\_AFTER\_CONTACT\_WORK\_TIME
7866
+ #
7867
+ # : Unit: Seconds
7868
+ #
7869
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7870
+ # Agent, Agent Hierarchy
7871
+ #
7872
+ # SUM\_CONNECTING\_TIME\_AGENT
7873
+ #
7874
+ # : Unit: Seconds
7875
+ #
7876
+ # Valid metric filter key: `INITIATION_METHOD`. This metric only
7877
+ # supports the following filter keys as `INITIATION_METHOD`:
7878
+ # `INBOUND` \| `OUTBOUND` \| `CALLBACK` \| `API`
7879
+ #
7880
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7881
+ # Agent, Agent Hierarchy
7882
+ #
7883
+ # <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
7884
+ # this metric.
7885
+ #
7886
+ # </note>
7887
+ #
7888
+ # SUM\_CONTACT\_FLOW\_TIME
7889
+ #
7890
+ # : Unit: Seconds
7891
+ #
7892
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7893
+ # Agent, Agent Hierarchy
7894
+ #
7895
+ # SUM\_CONTACT\_TIME\_AGENT
7896
+ #
7897
+ # : Unit: Seconds
7898
+ #
7899
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7900
+ # Agent, Agent Hierarchy
7901
+ #
7291
7902
  # SUM\_CONTACTS\_ANSWERED\_IN\_X
7292
7903
  #
7293
7904
  # : Unit: Count
7294
7905
  #
7295
- # Valid groupings and filters: Queue, Channel, Routing Profile
7906
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7907
+ # contact/segmentAttributes/connect:Subtype
7296
7908
  #
7297
7909
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
7298
7910
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7302,7 +7914,8 @@ module Aws::Connect
7302
7914
  #
7303
7915
  # : Unit: Count
7304
7916
  #
7305
- # Valid groupings and filters: Queue, Channel, Routing Profile
7917
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7918
+ # contact/segmentAttributes/connect:Subtype
7306
7919
  #
7307
7920
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
7308
7921
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7314,13 +7927,71 @@ module Aws::Connect
7314
7927
  #
7315
7928
  # Unit: Count
7316
7929
  #
7317
- # Valid groupings and filters: Queue, Channel, Routing Profile
7930
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7931
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7932
+ #
7933
+ # SUM\_ERROR\_STATUS\_TIME\_AGENT
7934
+ #
7935
+ # : Unit: Seconds
7936
+ #
7937
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7938
+ # Agent, Agent Hierarchy
7939
+ #
7940
+ # SUM\_HANDLE\_TIME
7941
+ #
7942
+ # : Unit: Seconds
7943
+ #
7944
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7945
+ # Agent, Agent Hierarchy
7946
+ #
7947
+ # SUM\_HOLD\_TIME
7948
+ #
7949
+ # : Unit: Count
7950
+ #
7951
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7952
+ # Agent, Agent Hierarchy
7953
+ #
7954
+ # SUM\_IDLE\_TIME\_AGENT
7955
+ #
7956
+ # : Unit: Seconds
7957
+ #
7958
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7959
+ # Hierarchy
7960
+ #
7961
+ # SUM\_INTERACTION\_AND\_HOLD\_TIME
7962
+ #
7963
+ # : Unit: Seconds
7964
+ #
7965
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7966
+ # Agent, Agent Hierarchy
7967
+ #
7968
+ # SUM\_INTERACTION\_TIME
7969
+ #
7970
+ # : Unit: Seconds
7971
+ #
7972
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7973
+ # Agent, Agent Hierarchy
7974
+ #
7975
+ # SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
7976
+ #
7977
+ # : Unit: Seconds
7978
+ #
7979
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7980
+ # Hierarchy
7981
+ #
7982
+ # SUM\_ONLINE\_TIME\_AGENT
7983
+ #
7984
+ # : Unit: Seconds
7985
+ #
7986
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7987
+ # Hierarchy
7318
7988
  #
7319
7989
  # SUM\_RETRY\_CALLBACK\_ATTEMPTS
7320
7990
  #
7321
7991
  # : Unit: Count
7322
7992
  #
7323
- # Valid groupings and filters: Queue, Channel, Routing Profile
7993
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7994
+ # contact/segmentAttributes/connect:Subtype
7324
7995
  #
7325
7996
  #
7326
7997
  #
@@ -8168,9 +8839,7 @@ module Aws::Connect
8168
8839
  include Aws::Structure
8169
8840
  end
8170
8841
 
8171
- # The Amazon Connect instance.
8172
- #
8173
- # @!attribute [rw] id
8842
+ # @!attribute [rw] instance_id
8174
8843
  # The identifier of the Amazon Connect instance. You can [find the
8175
8844
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
8176
8845
  #
@@ -8179,36 +8848,107 @@ module Aws::Connect
8179
8848
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
8180
8849
  # @return [String]
8181
8850
  #
8182
- # @!attribute [rw] arn
8183
- # The Amazon Resource Name (ARN) of the instance.
8851
+ # @!attribute [rw] source_phone_number_arn
8852
+ # The claimed phone number ARN being imported from the external
8853
+ # service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it
8854
+ # looks like the ARN of the phone number to import from Amazon
8855
+ # Pinpoint.
8184
8856
  # @return [String]
8185
8857
  #
8186
- # @!attribute [rw] identity_management_type
8187
- # The identity management type.
8858
+ # @!attribute [rw] phone_number_description
8859
+ # The description of the phone number.
8188
8860
  # @return [String]
8189
8861
  #
8190
- # @!attribute [rw] instance_alias
8191
- # The alias of instance.
8192
- # @return [String]
8862
+ # @!attribute [rw] tags
8863
+ # The tags used to organize, track, or control access for this
8864
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
8865
+ # "key2":"value2"\\} \\}.
8866
+ # @return [Hash<String,String>]
8193
8867
  #
8194
- # @!attribute [rw] created_time
8195
- # When the instance was created.
8196
- # @return [Time]
8868
+ # @!attribute [rw] client_token
8869
+ # A unique, case-sensitive identifier that you provide to ensure the
8870
+ # idempotency of the request. If not provided, the Amazon Web Services
8871
+ # SDK populates this field. For more information about idempotency,
8872
+ # see [Making retries safe with idempotent APIs][1].
8197
8873
  #
8198
- # @!attribute [rw] service_role
8199
- # The service role of the instance.
8200
- # @return [String]
8874
+ # **A suitable default value is auto-generated.** You should normally
8875
+ # not need to pass this option.
8201
8876
  #
8202
- # @!attribute [rw] instance_status
8203
- # The state of the instance.
8877
+ #
8878
+ #
8879
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
8204
8880
  # @return [String]
8205
8881
  #
8206
- # @!attribute [rw] status_reason
8207
- # Relevant details why the instance was not successfully created.
8208
- # @return [Types::InstanceStatusReason]
8882
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumberRequest AWS API Documentation
8209
8883
  #
8210
- # @!attribute [rw] inbound_calls_enabled
8211
- # Whether inbound calls are enabled.
8884
+ class ImportPhoneNumberRequest < Struct.new(
8885
+ :instance_id,
8886
+ :source_phone_number_arn,
8887
+ :phone_number_description,
8888
+ :tags,
8889
+ :client_token)
8890
+ SENSITIVE = []
8891
+ include Aws::Structure
8892
+ end
8893
+
8894
+ # @!attribute [rw] phone_number_id
8895
+ # A unique identifier for the phone number.
8896
+ # @return [String]
8897
+ #
8898
+ # @!attribute [rw] phone_number_arn
8899
+ # The Amazon Resource Name (ARN) of the phone number.
8900
+ # @return [String]
8901
+ #
8902
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumberResponse AWS API Documentation
8903
+ #
8904
+ class ImportPhoneNumberResponse < Struct.new(
8905
+ :phone_number_id,
8906
+ :phone_number_arn)
8907
+ SENSITIVE = []
8908
+ include Aws::Structure
8909
+ end
8910
+
8911
+ # The Amazon Connect instance.
8912
+ #
8913
+ # @!attribute [rw] id
8914
+ # The identifier of the Amazon Connect instance. You can [find the
8915
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
8916
+ #
8917
+ #
8918
+ #
8919
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
8920
+ # @return [String]
8921
+ #
8922
+ # @!attribute [rw] arn
8923
+ # The Amazon Resource Name (ARN) of the instance.
8924
+ # @return [String]
8925
+ #
8926
+ # @!attribute [rw] identity_management_type
8927
+ # The identity management type.
8928
+ # @return [String]
8929
+ #
8930
+ # @!attribute [rw] instance_alias
8931
+ # The alias of instance.
8932
+ # @return [String]
8933
+ #
8934
+ # @!attribute [rw] created_time
8935
+ # When the instance was created.
8936
+ # @return [Time]
8937
+ #
8938
+ # @!attribute [rw] service_role
8939
+ # The service role of the instance.
8940
+ # @return [String]
8941
+ #
8942
+ # @!attribute [rw] instance_status
8943
+ # The state of the instance.
8944
+ # @return [String]
8945
+ #
8946
+ # @!attribute [rw] status_reason
8947
+ # Relevant details why the instance was not successfully created.
8948
+ # @return [Types::InstanceStatusReason]
8949
+ #
8950
+ # @!attribute [rw] inbound_calls_enabled
8951
+ # Whether inbound calls are enabled.
8212
8952
  # @return [Boolean]
8213
8953
  #
8214
8954
  # @!attribute [rw] outbound_calls_enabled
@@ -8220,6 +8960,10 @@ module Aws::Connect
8220
8960
  # admin website.
8221
8961
  # @return [String]
8222
8962
  #
8963
+ # @!attribute [rw] tags
8964
+ # The tags of an instance.
8965
+ # @return [Hash<String,String>]
8966
+ #
8223
8967
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Instance AWS API Documentation
8224
8968
  #
8225
8969
  class Instance < Struct.new(
@@ -8233,7 +8977,8 @@ module Aws::Connect
8233
8977
  :status_reason,
8234
8978
  :inbound_calls_enabled,
8235
8979
  :outbound_calls_enabled,
8236
- :instance_access_url)
8980
+ :instance_access_url,
8981
+ :tags)
8237
8982
  SENSITIVE = [:instance_alias]
8238
8983
  include Aws::Structure
8239
8984
  end
@@ -8713,6 +9458,60 @@ module Aws::Connect
8713
9458
  include Aws::Structure
8714
9459
  end
8715
9460
 
9461
+ # @!attribute [rw] instance_id
9462
+ # The identifier of the Amazon Connect instance. You can [find the
9463
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
9464
+ #
9465
+ #
9466
+ #
9467
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9468
+ # @return [String]
9469
+ #
9470
+ # @!attribute [rw] data_set_id
9471
+ # The identifier of the dataset to get the association status.
9472
+ # @return [String]
9473
+ #
9474
+ # @!attribute [rw] next_token
9475
+ # The token for the next set of results. Use the value returned in the
9476
+ # previous response in the next request to retrieve the next set of
9477
+ # results.
9478
+ # @return [String]
9479
+ #
9480
+ # @!attribute [rw] max_results
9481
+ # The maximum number of results to return per page.
9482
+ # @return [Integer]
9483
+ #
9484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociationsRequest AWS API Documentation
9485
+ #
9486
+ class ListAnalyticsDataAssociationsRequest < Struct.new(
9487
+ :instance_id,
9488
+ :data_set_id,
9489
+ :next_token,
9490
+ :max_results)
9491
+ SENSITIVE = []
9492
+ include Aws::Structure
9493
+ end
9494
+
9495
+ # @!attribute [rw] results
9496
+ # An array of successful results: `DataSetId`, `TargetAccountId`,
9497
+ # `ResourceShareId`, `ResourceShareArn`. This is a paginated API, so
9498
+ # `nextToken` is given if there are more results to be returned.
9499
+ # @return [Array<Types::AnalyticsDataAssociationResult>]
9500
+ #
9501
+ # @!attribute [rw] next_token
9502
+ # If there are additional results, this is the token for the next set
9503
+ # of results.
9504
+ # @return [String]
9505
+ #
9506
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociationsResponse AWS API Documentation
9507
+ #
9508
+ class ListAnalyticsDataAssociationsResponse < Struct.new(
9509
+ :results,
9510
+ :next_token)
9511
+ SENSITIVE = []
9512
+ include Aws::Structure
9513
+ end
9514
+
8716
9515
  # @!attribute [rw] instance_id
8717
9516
  # The identifier of the Amazon Connect instance. You can [find the
8718
9517
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -9187,6 +9986,58 @@ module Aws::Connect
9187
9986
  include Aws::Structure
9188
9987
  end
9189
9988
 
9989
+ # @!attribute [rw] instance_id
9990
+ # The identifier of the Amazon Connect instance. You can [find the
9991
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
9992
+ #
9993
+ #
9994
+ #
9995
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9996
+ # @return [String]
9997
+ #
9998
+ # @!attribute [rw] resource_type
9999
+ # A valid resource type.
10000
+ # @return [String]
10001
+ #
10002
+ # @!attribute [rw] next_token
10003
+ # The token for the next set of results. Use the value returned in the
10004
+ # previous response in the next request to retrieve the next set of
10005
+ # results.
10006
+ # @return [String]
10007
+ #
10008
+ # @!attribute [rw] max_results
10009
+ # The maximum number of results to return per page.
10010
+ # @return [Integer]
10011
+ #
10012
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociationsRequest AWS API Documentation
10013
+ #
10014
+ class ListFlowAssociationsRequest < Struct.new(
10015
+ :instance_id,
10016
+ :resource_type,
10017
+ :next_token,
10018
+ :max_results)
10019
+ SENSITIVE = []
10020
+ include Aws::Structure
10021
+ end
10022
+
10023
+ # @!attribute [rw] flow_association_summary_list
10024
+ # Summary of flow associations.
10025
+ # @return [Array<Types::FlowAssociationSummary>]
10026
+ #
10027
+ # @!attribute [rw] next_token
10028
+ # If there are additional results, this is the token for the next set
10029
+ # of results.
10030
+ # @return [String]
10031
+ #
10032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociationsResponse AWS API Documentation
10033
+ #
10034
+ class ListFlowAssociationsResponse < Struct.new(
10035
+ :flow_association_summary_list,
10036
+ :next_token)
10037
+ SENSITIVE = []
10038
+ include Aws::Structure
10039
+ end
10040
+
9190
10041
  # @!attribute [rw] instance_id
9191
10042
  # The identifier of the Amazon Connect instance. You can [find the
9192
10043
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -9633,6 +10484,17 @@ module Aws::Connect
9633
10484
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9634
10485
  # @return [String]
9635
10486
  #
10487
+ # @!attribute [rw] phone_number_description
10488
+ # The description of the phone number.
10489
+ # @return [String]
10490
+ #
10491
+ # @!attribute [rw] source_phone_number_arn
10492
+ # The claimed phone number ARN that was previously imported from the
10493
+ # external service, such as Amazon Pinpoint. If it is from Amazon
10494
+ # Pinpoint, it looks like the ARN of the phone number that was
10495
+ # imported from Amazon Pinpoint.
10496
+ # @return [String]
10497
+ #
9636
10498
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersSummary AWS API Documentation
9637
10499
  #
9638
10500
  class ListPhoneNumbersSummary < Struct.new(
@@ -9642,7 +10504,9 @@ module Aws::Connect
9642
10504
  :phone_number_country_code,
9643
10505
  :phone_number_type,
9644
10506
  :target_arn,
9645
- :instance_id)
10507
+ :instance_id,
10508
+ :phone_number_description,
10509
+ :source_phone_number_arn)
9646
10510
  SENSITIVE = []
9647
10511
  include Aws::Structure
9648
10512
  end
@@ -9906,8 +10770,8 @@ module Aws::Connect
9906
10770
  # @return [Integer]
9907
10771
  #
9908
10772
  # @!attribute [rw] quick_connect_types
9909
- # The type of quick connect. In the Amazon Connect console, when you
9910
- # create a quick connect, you are prompted to assign one of the
10773
+ # The type of quick connect. In the Amazon Connect admin website, when
10774
+ # you create a quick connect, you are prompted to assign one of the
9911
10775
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
9912
10776
  # (QUEUE).
9913
10777
  # @return [Array<String>]
@@ -9941,6 +10805,81 @@ module Aws::Connect
9941
10805
  include Aws::Structure
9942
10806
  end
9943
10807
 
10808
+ # @!attribute [rw] instance_id
10809
+ # The identifier of the Amazon Connect instance. You can [find the
10810
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
10811
+ #
10812
+ #
10813
+ #
10814
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
10815
+ # @return [String]
10816
+ #
10817
+ # @!attribute [rw] contact_id
10818
+ # The identifier of the contact in this instance of Amazon Connect.
10819
+ # @return [String]
10820
+ #
10821
+ # @!attribute [rw] max_results
10822
+ # The maximum number of results to return per page.
10823
+ # @return [Integer]
10824
+ #
10825
+ # @!attribute [rw] next_token
10826
+ # The token for the next set of results. Use the value returned in the
10827
+ # previous response in the next request to retrieve the next set of
10828
+ # results.
10829
+ # @return [String]
10830
+ #
10831
+ # @!attribute [rw] output_type
10832
+ # The Contact Lens output type to be returned.
10833
+ # @return [String]
10834
+ #
10835
+ # @!attribute [rw] segment_types
10836
+ # Enum with segment types . Each value corresponds to a segment type
10837
+ # returned in the segments list of the API. Each segment type has its
10838
+ # own structure. Different channels may have different sets of
10839
+ # supported segment types.
10840
+ # @return [Array<String>]
10841
+ #
10842
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2Request AWS API Documentation
10843
+ #
10844
+ class ListRealtimeContactAnalysisSegmentsV2Request < Struct.new(
10845
+ :instance_id,
10846
+ :contact_id,
10847
+ :max_results,
10848
+ :next_token,
10849
+ :output_type,
10850
+ :segment_types)
10851
+ SENSITIVE = []
10852
+ include Aws::Structure
10853
+ end
10854
+
10855
+ # @!attribute [rw] channel
10856
+ # The channel of the contact. `Voice` will not be returned.
10857
+ # @return [String]
10858
+ #
10859
+ # @!attribute [rw] status
10860
+ # Status of real-time contact analysis.
10861
+ # @return [String]
10862
+ #
10863
+ # @!attribute [rw] segments
10864
+ # An analyzed transcript or category.
10865
+ # @return [Array<Types::RealtimeContactAnalysisSegment>]
10866
+ #
10867
+ # @!attribute [rw] next_token
10868
+ # If there are additional results, this is the token for the next set
10869
+ # of results.
10870
+ # @return [String]
10871
+ #
10872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2Response AWS API Documentation
10873
+ #
10874
+ class ListRealtimeContactAnalysisSegmentsV2Response < Struct.new(
10875
+ :channel,
10876
+ :status,
10877
+ :segments,
10878
+ :next_token)
10879
+ SENSITIVE = []
10880
+ include Aws::Structure
10881
+ end
10882
+
9944
10883
  # @!attribute [rw] instance_id
9945
10884
  # The identifier of the Amazon Connect instance. You can [find the
9946
10885
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -10831,6 +11770,85 @@ module Aws::Connect
10831
11770
  include Aws::Structure
10832
11771
  end
10833
11772
 
11773
+ # A set of endpoints used by clients to connect to the media service
11774
+ # group for an Amazon Chime SDK meeting.
11775
+ #
11776
+ # @!attribute [rw] audio_host_url
11777
+ # The audio host URL.
11778
+ # @return [String]
11779
+ #
11780
+ # @!attribute [rw] audio_fallback_url
11781
+ # The audio fallback URL.
11782
+ # @return [String]
11783
+ #
11784
+ # @!attribute [rw] signaling_url
11785
+ # The signaling URL.
11786
+ # @return [String]
11787
+ #
11788
+ # @!attribute [rw] turn_control_url
11789
+ # The turn control URL.
11790
+ # @return [String]
11791
+ #
11792
+ # @!attribute [rw] event_ingestion_url
11793
+ # The event ingestion URL to which you send client meeting events.
11794
+ # @return [String]
11795
+ #
11796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaPlacement AWS API Documentation
11797
+ #
11798
+ class MediaPlacement < Struct.new(
11799
+ :audio_host_url,
11800
+ :audio_fallback_url,
11801
+ :signaling_url,
11802
+ :turn_control_url,
11803
+ :event_ingestion_url)
11804
+ SENSITIVE = []
11805
+ include Aws::Structure
11806
+ end
11807
+
11808
+ # A meeting created using the Amazon Chime SDK.
11809
+ #
11810
+ # @!attribute [rw] media_region
11811
+ # The Amazon Web Services Region in which you create the meeting.
11812
+ # @return [String]
11813
+ #
11814
+ # @!attribute [rw] media_placement
11815
+ # The media placement for the meeting.
11816
+ # @return [Types::MediaPlacement]
11817
+ #
11818
+ # @!attribute [rw] meeting_features
11819
+ # The configuration settings of the features available to a meeting.
11820
+ # @return [Types::MeetingFeaturesConfiguration]
11821
+ #
11822
+ # @!attribute [rw] meeting_id
11823
+ # The Amazon Chime SDK meeting ID.
11824
+ # @return [String]
11825
+ #
11826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Meeting AWS API Documentation
11827
+ #
11828
+ class Meeting < Struct.new(
11829
+ :media_region,
11830
+ :media_placement,
11831
+ :meeting_features,
11832
+ :meeting_id)
11833
+ SENSITIVE = []
11834
+ include Aws::Structure
11835
+ end
11836
+
11837
+ # The configuration settings of the features available to a meeting.
11838
+ #
11839
+ # @!attribute [rw] audio
11840
+ # The configuration settings for the audio features available to a
11841
+ # meeting.
11842
+ # @return [Types::AudioFeatures]
11843
+ #
11844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MeetingFeaturesConfiguration AWS API Documentation
11845
+ #
11846
+ class MeetingFeaturesConfiguration < Struct.new(
11847
+ :audio)
11848
+ SENSITIVE = []
11849
+ include Aws::Structure
11850
+ end
11851
+
10834
11852
  # Contains the name, thresholds, and metric filters.
10835
11853
  #
10836
11854
  # @!attribute [rw] metric
@@ -11042,6 +12060,52 @@ module Aws::Connect
11042
12060
  include Aws::Structure
11043
12061
  end
11044
12062
 
12063
+ # Payload of chat properties to apply when starting a new contact.
12064
+ #
12065
+ # @!attribute [rw] supported_messaging_content_types
12066
+ # The supported chat message content types. Supported types are
12067
+ # `text/plain`, `text/markdown`, `application/json`,
12068
+ # `application/vnd.amazonaws.connect.message.interactive`, and
12069
+ # `application/vnd.amazonaws.connect.message.interactive.response`.
12070
+ #
12071
+ # Content types must always contain ` text/plain`. You can then put
12072
+ # any other supported type in the list. For example, all the following
12073
+ # lists are valid because they contain `text/plain`: `[text/plain,
12074
+ # text/markdown, application/json]`, ` [text/markdown, text/plain]`,
12075
+ # `[text/plain, application/json,
12076
+ # application/vnd.amazonaws.connect.message.interactive.response]`.
12077
+ # @return [Array<String>]
12078
+ #
12079
+ # @!attribute [rw] participant_details
12080
+ # The customer's details.
12081
+ # @return [Types::ParticipantDetails]
12082
+ #
12083
+ # @!attribute [rw] attributes
12084
+ # A custom key-value pair using an attribute map. The attributes are
12085
+ # standard Amazon Connect attributes. They can be accessed in flows
12086
+ # just like any other contact attributes.
12087
+ #
12088
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
12089
+ # contact. Attribute keys can include only alphanumeric, dash, and
12090
+ # underscore characters.
12091
+ # @return [Hash<String,String>]
12092
+ #
12093
+ # @!attribute [rw] streaming_configuration
12094
+ # The streaming configuration, such as the Amazon SNS streaming
12095
+ # endpoint.
12096
+ # @return [Types::ChatStreamingConfiguration]
12097
+ #
12098
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NewSessionDetails AWS API Documentation
12099
+ #
12100
+ class NewSessionDetails < Struct.new(
12101
+ :supported_messaging_content_types,
12102
+ :participant_details,
12103
+ :attributes,
12104
+ :streaming_configuration)
12105
+ SENSITIVE = []
12106
+ include Aws::Structure
12107
+ end
12108
+
11045
12109
  # The type of notification recipient.
11046
12110
  #
11047
12111
  # @!attribute [rw] user_tags
@@ -11149,6 +12213,38 @@ module Aws::Connect
11149
12213
  include Aws::Structure
11150
12214
  end
11151
12215
 
12216
+ # Thrown for analyzed content when requested OutputType was not enabled
12217
+ # for a given contact. For example, if an OutputType.Raw was requested
12218
+ # for a contact that had `RedactedOnly` Redaction policy set in
12219
+ # Contact flow.
12220
+ #
12221
+ # @!attribute [rw] message
12222
+ # @return [String]
12223
+ #
12224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutputTypeNotFoundException AWS API Documentation
12225
+ #
12226
+ class OutputTypeNotFoundException < Struct.new(
12227
+ :message)
12228
+ SENSITIVE = []
12229
+ include Aws::Structure
12230
+ end
12231
+
12232
+ # The configuration for the allowed capabilities for participants
12233
+ # present over the call.
12234
+ #
12235
+ # @!attribute [rw] video
12236
+ # The configuration having the video sharing capabilities for
12237
+ # participants over the call.
12238
+ # @return [String]
12239
+ #
12240
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantCapabilities AWS API Documentation
12241
+ #
12242
+ class ParticipantCapabilities < Struct.new(
12243
+ :video)
12244
+ SENSITIVE = []
12245
+ include Aws::Structure
12246
+ end
12247
+
11152
12248
  # The customer's details.
11153
12249
  #
11154
12250
  # @!attribute [rw] display_name
@@ -11926,8 +13022,8 @@ module Aws::Connect
11926
13022
  # Contains configuration settings for a quick connect.
11927
13023
  #
11928
13024
  # @!attribute [rw] quick_connect_type
11929
- # The type of quick connect. In the Amazon Connect console, when you
11930
- # create a quick connect, you are prompted to assign one of the
13025
+ # The type of quick connect. In the Amazon Connect admin website, when
13026
+ # you create a quick connect, you are prompted to assign one of the
11931
13027
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
11932
13028
  # (QUEUE).
11933
13029
  # @return [String]
@@ -12027,8 +13123,8 @@ module Aws::Connect
12027
13123
  # @return [String]
12028
13124
  #
12029
13125
  # @!attribute [rw] quick_connect_type
12030
- # The type of quick connect. In the Amazon Connect console, when you
12031
- # create a quick connect, you are prompted to assign one of the
13126
+ # The type of quick connect. In the Amazon Connect admin website, when
13127
+ # you create a quick connect, you are prompted to assign one of the
12032
13128
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
12033
13129
  # (QUEUE).
12034
13130
  # @return [String]
@@ -12069,6 +13165,418 @@ module Aws::Connect
12069
13165
  include Aws::Structure
12070
13166
  end
12071
13167
 
13168
+ # Object that describes attached file.
13169
+ #
13170
+ # @!attribute [rw] attachment_name
13171
+ # A case-sensitive name of the attachment being uploaded. Can be
13172
+ # redacted.
13173
+ # @return [String]
13174
+ #
13175
+ # @!attribute [rw] content_type
13176
+ # Describes the MIME file type of the attachment. For a list of
13177
+ # supported file types, see [Feature specifications][1] in the *Amazon
13178
+ # Connect Administrator Guide*.
13179
+ #
13180
+ #
13181
+ #
13182
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
13183
+ # @return [String]
13184
+ #
13185
+ # @!attribute [rw] attachment_id
13186
+ # A unique identifier for the attachment.
13187
+ # @return [String]
13188
+ #
13189
+ # @!attribute [rw] status
13190
+ # Status of the attachment.
13191
+ # @return [String]
13192
+ #
13193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisAttachment AWS API Documentation
13194
+ #
13195
+ class RealTimeContactAnalysisAttachment < Struct.new(
13196
+ :attachment_name,
13197
+ :content_type,
13198
+ :attachment_id,
13199
+ :status)
13200
+ SENSITIVE = []
13201
+ include Aws::Structure
13202
+ end
13203
+
13204
+ # Provides information about the category rule that was matched.
13205
+ #
13206
+ # @!attribute [rw] points_of_interest
13207
+ # List of PointOfInterest - objects describing a single match of a
13208
+ # rule.
13209
+ # @return [Array<Types::RealTimeContactAnalysisPointOfInterest>]
13210
+ #
13211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisCategoryDetails AWS API Documentation
13212
+ #
13213
+ class RealTimeContactAnalysisCategoryDetails < Struct.new(
13214
+ :points_of_interest)
13215
+ SENSITIVE = []
13216
+ include Aws::Structure
13217
+ end
13218
+
13219
+ # Begin and end offsets for a part of text.
13220
+ #
13221
+ # @!attribute [rw] begin_offset_char
13222
+ # The beginning of the character interval.
13223
+ # @return [Integer]
13224
+ #
13225
+ # @!attribute [rw] end_offset_char
13226
+ # The end of the character interval.
13227
+ # @return [Integer]
13228
+ #
13229
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisCharacterInterval AWS API Documentation
13230
+ #
13231
+ class RealTimeContactAnalysisCharacterInterval < Struct.new(
13232
+ :begin_offset_char,
13233
+ :end_offset_char)
13234
+ SENSITIVE = []
13235
+ include Aws::Structure
13236
+ end
13237
+
13238
+ # Potential issues that are detected based on an artificial intelligence
13239
+ # analysis of each turn in the conversation.
13240
+ #
13241
+ # @!attribute [rw] transcript_items
13242
+ # List of the transcript items (segments) that are associated with a
13243
+ # given issue.
13244
+ # @return [Array<Types::RealTimeContactAnalysisTranscriptItemWithContent>]
13245
+ #
13246
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisIssueDetected AWS API Documentation
13247
+ #
13248
+ class RealTimeContactAnalysisIssueDetected < Struct.new(
13249
+ :transcript_items)
13250
+ SENSITIVE = []
13251
+ include Aws::Structure
13252
+ end
13253
+
13254
+ # The section of the contact transcript segment that category rule was
13255
+ # detected.
13256
+ #
13257
+ # @!attribute [rw] transcript_items
13258
+ # List of the transcript items (segments) that are associated with a
13259
+ # given point of interest.
13260
+ # @return [Array<Types::RealTimeContactAnalysisTranscriptItemWithCharacterOffsets>]
13261
+ #
13262
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisPointOfInterest AWS API Documentation
13263
+ #
13264
+ class RealTimeContactAnalysisPointOfInterest < Struct.new(
13265
+ :transcript_items)
13266
+ SENSITIVE = []
13267
+ include Aws::Structure
13268
+ end
13269
+
13270
+ # Segment containing list of attachments.
13271
+ #
13272
+ # @!attribute [rw] id
13273
+ # The identifier of the segment.
13274
+ # @return [String]
13275
+ #
13276
+ # @!attribute [rw] participant_id
13277
+ # The identifier of the participant.
13278
+ # @return [String]
13279
+ #
13280
+ # @!attribute [rw] participant_role
13281
+ # The role of the participant. For example, is it a customer, agent,
13282
+ # or system.
13283
+ # @return [String]
13284
+ #
13285
+ # @!attribute [rw] display_name
13286
+ # The display name of the participant. Can be redacted.
13287
+ # @return [String]
13288
+ #
13289
+ # @!attribute [rw] attachments
13290
+ # List of objects describing an individual attachment.
13291
+ # @return [Array<Types::RealTimeContactAnalysisAttachment>]
13292
+ #
13293
+ # @!attribute [rw] time
13294
+ # Field describing the time of the event. It can have different
13295
+ # representations of time.
13296
+ # @return [Types::RealTimeContactAnalysisTimeData]
13297
+ #
13298
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentAttachments AWS API Documentation
13299
+ #
13300
+ class RealTimeContactAnalysisSegmentAttachments < Struct.new(
13301
+ :id,
13302
+ :participant_id,
13303
+ :participant_role,
13304
+ :display_name,
13305
+ :attachments,
13306
+ :time)
13307
+ SENSITIVE = []
13308
+ include Aws::Structure
13309
+ end
13310
+
13311
+ # The matched category rules.
13312
+ #
13313
+ # @!attribute [rw] matched_details
13314
+ # Map between the name of the matched rule and
13315
+ # RealTimeContactAnalysisCategoryDetails.
13316
+ # @return [Hash<String,Types::RealTimeContactAnalysisCategoryDetails>]
13317
+ #
13318
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentCategories AWS API Documentation
13319
+ #
13320
+ class RealTimeContactAnalysisSegmentCategories < Struct.new(
13321
+ :matched_details)
13322
+ SENSITIVE = []
13323
+ include Aws::Structure
13324
+ end
13325
+
13326
+ # Segment type describing a contact event.
13327
+ #
13328
+ # @!attribute [rw] id
13329
+ # The identifier of the contact event.
13330
+ # @return [String]
13331
+ #
13332
+ # @!attribute [rw] participant_id
13333
+ # The identifier of the participant.
13334
+ # @return [String]
13335
+ #
13336
+ # @!attribute [rw] participant_role
13337
+ # The role of the participant. For example, is it a customer, agent,
13338
+ # or system.
13339
+ # @return [String]
13340
+ #
13341
+ # @!attribute [rw] display_name
13342
+ # The display name of the participant. Can be redacted.
13343
+ # @return [String]
13344
+ #
13345
+ # @!attribute [rw] event_type
13346
+ # Type of the event. For example,
13347
+ # `application/vnd.amazonaws.connect.event.participant.left`.
13348
+ # @return [String]
13349
+ #
13350
+ # @!attribute [rw] time
13351
+ # Field describing the time of the event. It can have different
13352
+ # representations of time.
13353
+ # @return [Types::RealTimeContactAnalysisTimeData]
13354
+ #
13355
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentEvent AWS API Documentation
13356
+ #
13357
+ class RealTimeContactAnalysisSegmentEvent < Struct.new(
13358
+ :id,
13359
+ :participant_id,
13360
+ :participant_role,
13361
+ :display_name,
13362
+ :event_type,
13363
+ :time)
13364
+ SENSITIVE = []
13365
+ include Aws::Structure
13366
+ end
13367
+
13368
+ # Segment type containing a list of detected issues.
13369
+ #
13370
+ # @!attribute [rw] issues_detected
13371
+ # List of the issues detected.
13372
+ # @return [Array<Types::RealTimeContactAnalysisIssueDetected>]
13373
+ #
13374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentIssues AWS API Documentation
13375
+ #
13376
+ class RealTimeContactAnalysisSegmentIssues < Struct.new(
13377
+ :issues_detected)
13378
+ SENSITIVE = []
13379
+ include Aws::Structure
13380
+ end
13381
+
13382
+ # The analyzed transcript segment.
13383
+ #
13384
+ # @!attribute [rw] id
13385
+ # The identifier of the transcript.
13386
+ # @return [String]
13387
+ #
13388
+ # @!attribute [rw] participant_id
13389
+ # The identifier of the participant.
13390
+ # @return [String]
13391
+ #
13392
+ # @!attribute [rw] participant_role
13393
+ # The role of the participant. For example, is it a customer, agent,
13394
+ # or system.
13395
+ # @return [String]
13396
+ #
13397
+ # @!attribute [rw] display_name
13398
+ # The display name of the participant.
13399
+ # @return [String]
13400
+ #
13401
+ # @!attribute [rw] content
13402
+ # The content of the transcript. Can be redacted.
13403
+ # @return [String]
13404
+ #
13405
+ # @!attribute [rw] content_type
13406
+ # The type of content of the item. For example, `text/plain`.
13407
+ # @return [String]
13408
+ #
13409
+ # @!attribute [rw] time
13410
+ # Field describing the time of the event. It can have different
13411
+ # representations of time.
13412
+ # @return [Types::RealTimeContactAnalysisTimeData]
13413
+ #
13414
+ # @!attribute [rw] redaction
13415
+ # Object describing redaction that was applied to the transcript. If
13416
+ # transcript has the field it means part of the transcript was
13417
+ # redacted.
13418
+ # @return [Types::RealTimeContactAnalysisTranscriptItemRedaction]
13419
+ #
13420
+ # @!attribute [rw] sentiment
13421
+ # The sentiment detected for this piece of transcript.
13422
+ # @return [String]
13423
+ #
13424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentTranscript AWS API Documentation
13425
+ #
13426
+ class RealTimeContactAnalysisSegmentTranscript < Struct.new(
13427
+ :id,
13428
+ :participant_id,
13429
+ :participant_role,
13430
+ :display_name,
13431
+ :content,
13432
+ :content_type,
13433
+ :time,
13434
+ :redaction,
13435
+ :sentiment)
13436
+ SENSITIVE = []
13437
+ include Aws::Structure
13438
+ end
13439
+
13440
+ # Object describing time with which the segment is associated. It can
13441
+ # have different representations of time. Currently supported:
13442
+ # absoluteTime
13443
+ #
13444
+ # @note RealTimeContactAnalysisTimeData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RealTimeContactAnalysisTimeData corresponding to the set member.
13445
+ #
13446
+ # @!attribute [rw] absolute_time
13447
+ # Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
13448
+ # example, 2019-11-08T02:41:28.172Z.
13449
+ # @return [Time]
13450
+ #
13451
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTimeData AWS API Documentation
13452
+ #
13453
+ class RealTimeContactAnalysisTimeData < Struct.new(
13454
+ :absolute_time,
13455
+ :unknown)
13456
+ SENSITIVE = []
13457
+ include Aws::Structure
13458
+ include Aws::Structure::Union
13459
+
13460
+ class AbsoluteTime < RealTimeContactAnalysisTimeData; end
13461
+ class Unknown < RealTimeContactAnalysisTimeData; end
13462
+ end
13463
+
13464
+ # Object describing redaction applied to the segment.
13465
+ #
13466
+ # @!attribute [rw] character_offsets
13467
+ # List of character intervals each describing a part of the text that
13468
+ # was redacted. For `OutputType.Raw`, part of the original text that
13469
+ # contains data that can be redacted. For ` OutputType.Redacted`, part
13470
+ # of the string with redaction tag.
13471
+ # @return [Array<Types::RealTimeContactAnalysisCharacterInterval>]
13472
+ #
13473
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemRedaction AWS API Documentation
13474
+ #
13475
+ class RealTimeContactAnalysisTranscriptItemRedaction < Struct.new(
13476
+ :character_offsets)
13477
+ SENSITIVE = []
13478
+ include Aws::Structure
13479
+ end
13480
+
13481
+ # Transcript representation containing Id and list of character
13482
+ # intervals that are associated with analysis data. For example, this
13483
+ # object within a `RealTimeContactAnalysisPointOfInterest` in
13484
+ # `Category.MatchedDetails` would have character interval describing
13485
+ # part of the text that matched category.
13486
+ #
13487
+ # @!attribute [rw] id
13488
+ # Transcript identifier. Matches the identifier from one of the
13489
+ # TranscriptSegments.
13490
+ # @return [String]
13491
+ #
13492
+ # @!attribute [rw] character_offsets
13493
+ # List of character intervals within transcript content/text.
13494
+ # @return [Types::RealTimeContactAnalysisCharacterInterval]
13495
+ #
13496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemWithCharacterOffsets AWS API Documentation
13497
+ #
13498
+ class RealTimeContactAnalysisTranscriptItemWithCharacterOffsets < Struct.new(
13499
+ :id,
13500
+ :character_offsets)
13501
+ SENSITIVE = []
13502
+ include Aws::Structure
13503
+ end
13504
+
13505
+ # Transcript representation containing Id, Content and list of character
13506
+ # intervals that are associated with analysis data. For example, this
13507
+ # object within an issue detected would describe both content that
13508
+ # contains identified issue and intervals where that content is taken
13509
+ # from.
13510
+ #
13511
+ # @!attribute [rw] content
13512
+ # Part of the transcript content that contains identified issue. Can
13513
+ # be redacted
13514
+ # @return [String]
13515
+ #
13516
+ # @!attribute [rw] id
13517
+ # Transcript identifier. Matches the identifier from one of the
13518
+ # TranscriptSegments.
13519
+ # @return [String]
13520
+ #
13521
+ # @!attribute [rw] character_offsets
13522
+ # Begin and end offsets for a part of text.
13523
+ # @return [Types::RealTimeContactAnalysisCharacterInterval]
13524
+ #
13525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemWithContent AWS API Documentation
13526
+ #
13527
+ class RealTimeContactAnalysisTranscriptItemWithContent < Struct.new(
13528
+ :content,
13529
+ :id,
13530
+ :character_offsets)
13531
+ SENSITIVE = []
13532
+ include Aws::Structure
13533
+ end
13534
+
13535
+ # An analyzed segment for a real-time analysis session.
13536
+ #
13537
+ # @note RealtimeContactAnalysisSegment is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RealtimeContactAnalysisSegment corresponding to the set member.
13538
+ #
13539
+ # @!attribute [rw] transcript
13540
+ # The analyzed transcript segment.
13541
+ # @return [Types::RealTimeContactAnalysisSegmentTranscript]
13542
+ #
13543
+ # @!attribute [rw] categories
13544
+ # The matched category rules.
13545
+ # @return [Types::RealTimeContactAnalysisSegmentCategories]
13546
+ #
13547
+ # @!attribute [rw] issues
13548
+ # Segment type containing a list of detected issues.
13549
+ # @return [Types::RealTimeContactAnalysisSegmentIssues]
13550
+ #
13551
+ # @!attribute [rw] event
13552
+ # Segment type describing a contact event.
13553
+ # @return [Types::RealTimeContactAnalysisSegmentEvent]
13554
+ #
13555
+ # @!attribute [rw] attachments
13556
+ # The analyzed attachments.
13557
+ # @return [Types::RealTimeContactAnalysisSegmentAttachments]
13558
+ #
13559
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealtimeContactAnalysisSegment AWS API Documentation
13560
+ #
13561
+ class RealtimeContactAnalysisSegment < Struct.new(
13562
+ :transcript,
13563
+ :categories,
13564
+ :issues,
13565
+ :event,
13566
+ :attachments,
13567
+ :unknown)
13568
+ SENSITIVE = []
13569
+ include Aws::Structure
13570
+ include Aws::Structure::Union
13571
+
13572
+ class Transcript < RealtimeContactAnalysisSegment; end
13573
+ class Categories < RealtimeContactAnalysisSegment; end
13574
+ class Issues < RealtimeContactAnalysisSegment; end
13575
+ class Event < RealtimeContactAnalysisSegment; end
13576
+ class Attachments < RealtimeContactAnalysisSegment; end
13577
+ class Unknown < RealtimeContactAnalysisSegment; end
13578
+ end
13579
+
12072
13580
  # Well-formed data on a contact, used by agents to complete a contact
12073
13581
  # request. You can have up to 4,096 UTF-8 bytes across all references
12074
13582
  # for a contact.
@@ -12763,7 +14271,8 @@ module Aws::Connect
12763
14271
  #
12764
14272
  # Supported only for `TriggerEventSource` values:
12765
14273
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12766
- # \| `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
14274
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14275
+ # `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
12767
14276
  # `OnMetricDataUpdate`
12768
14277
  # @return [Types::EventBridgeActionDefinition]
12769
14278
  #
@@ -12772,7 +14281,8 @@ module Aws::Connect
12772
14281
  #
12773
14282
  # Supported only for `TriggerEventSource` values:
12774
14283
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12775
- # \| `OnPostChatAnalysisAvailable` \| `OnZendeskTicketCreate` \|
14284
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14285
+ # `OnPostChatAnalysisAvailable` \| `OnZendeskTicketCreate` \|
12776
14286
  # `OnZendeskTicketStatusUpdate` \| `OnSalesforceCaseCreate`
12777
14287
  # @return [Types::AssignContactCategoryActionDefinition]
12778
14288
  #
@@ -12781,7 +14291,8 @@ module Aws::Connect
12781
14291
  #
12782
14292
  # Supported only for `TriggerEventSource` values:
12783
14293
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12784
- # \| `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
14294
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14295
+ # `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
12785
14296
  # `OnMetricDataUpdate`
12786
14297
  # @return [Types::SendNotificationActionDefinition]
12787
14298
  #
@@ -13798,6 +15309,68 @@ module Aws::Connect
13798
15309
  include Aws::Structure
13799
15310
  end
13800
15311
 
15312
+ # @!attribute [rw] source_id
15313
+ # External identifier of chat customer participant, used in part to
15314
+ # uniquely identify a chat. For SMS, this is the E164 phone number of
15315
+ # the chat customer participant.
15316
+ # @return [String]
15317
+ #
15318
+ # @!attribute [rw] destination_id
15319
+ # Chat system identifier, used in part to uniquely identify chat. This
15320
+ # is associated with the Amazon Connect instance and flow to be used
15321
+ # to start chats. For SMS, this is the phone number destination of
15322
+ # inbound SMS messages represented by an Amazon Pinpoint phone number
15323
+ # ARN.
15324
+ # @return [String]
15325
+ #
15326
+ # @!attribute [rw] subtype
15327
+ # Classification of a channel. This is used in part to uniquely
15328
+ # identify chat.
15329
+ #
15330
+ # Valid value: `["connect:sms"]`
15331
+ # @return [String]
15332
+ #
15333
+ # @!attribute [rw] event
15334
+ # Chat integration event payload
15335
+ # @return [Types::ChatEvent]
15336
+ #
15337
+ # @!attribute [rw] new_session_details
15338
+ # Contact properties to apply when starting a new chat. If the
15339
+ # integration event is handled with an existing chat, this is ignored.
15340
+ # @return [Types::NewSessionDetails]
15341
+ #
15342
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEventRequest AWS API Documentation
15343
+ #
15344
+ class SendChatIntegrationEventRequest < Struct.new(
15345
+ :source_id,
15346
+ :destination_id,
15347
+ :subtype,
15348
+ :event,
15349
+ :new_session_details)
15350
+ SENSITIVE = []
15351
+ include Aws::Structure
15352
+ end
15353
+
15354
+ # @!attribute [rw] initial_contact_id
15355
+ # Identifier of chat contact used to handle integration event. This
15356
+ # may be null if the integration event is not valid without an already
15357
+ # existing chat contact.
15358
+ # @return [String]
15359
+ #
15360
+ # @!attribute [rw] new_chat_created
15361
+ # Whether handling the integration event resulted in creating a new
15362
+ # chat or acting on existing chat.
15363
+ # @return [Boolean]
15364
+ #
15365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEventResponse AWS API Documentation
15366
+ #
15367
+ class SendChatIntegrationEventResponse < Struct.new(
15368
+ :initial_contact_id,
15369
+ :new_chat_created)
15370
+ SENSITIVE = []
15371
+ include Aws::Structure
15372
+ end
15373
+
13801
15374
  # Information about the send notification action.
13802
15375
  #
13803
15376
  # @!attribute [rw] delivery_method
@@ -13933,11 +15506,11 @@ module Aws::Connect
13933
15506
  #
13934
15507
  # @!attribute [rw] contact_flow_id
13935
15508
  # The identifier of the flow for initiating the chat. To see the
13936
- # ContactFlowId in the Amazon Connect console user interface, on the
13937
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
13938
- # flow. On the flow page, under the name of the flow, choose **Show
13939
- # additional flow information**. The ContactFlowId is the last part of
13940
- # the ARN, shown here in bold:
15509
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15510
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15511
+ # flow page, under the name of the flow, choose **Show additional flow
15512
+ # information**. The ContactFlowId is the last part of the ARN, shown
15513
+ # here in bold:
13941
15514
  #
13942
15515
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
13943
15516
  # @return [String]
@@ -14254,11 +15827,11 @@ module Aws::Connect
14254
15827
  #
14255
15828
  # @!attribute [rw] contact_flow_id
14256
15829
  # The identifier of the flow for the outbound call. To see the
14257
- # ContactFlowId in the Amazon Connect console user interface, on the
14258
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
14259
- # flow. On the flow page, under the name of the flow, choose **Show
14260
- # additional flow information**. The ContactFlowId is the last part of
14261
- # the ARN, shown here in bold:
15830
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15831
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15832
+ # flow page, under the name of the flow, choose **Show additional flow
15833
+ # information**. The ContactFlowId is the last part of the ARN, shown
15834
+ # here in bold:
14262
15835
  #
14263
15836
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
14264
15837
  # @return [String]
@@ -14374,11 +15947,11 @@ module Aws::Connect
14374
15947
  #
14375
15948
  # @!attribute [rw] contact_flow_id
14376
15949
  # The identifier of the flow for initiating the tasks. To see the
14377
- # ContactFlowId in the Amazon Connect console user interface, on the
14378
- # navigation menu go to **Routing**, **Contact Flows**. Choose the
14379
- # flow. On the flow page, under the name of the flow, choose **Show
14380
- # additional flow information**. The ContactFlowId is the last part of
14381
- # the ARN, shown here in bold:
15950
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15951
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15952
+ # flow page, under the name of the flow, choose **Show additional flow
15953
+ # information**. The ContactFlowId is the last part of the ARN, shown
15954
+ # here in bold:
14382
15955
  #
14383
15956
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
14384
15957
  # @return [String]
@@ -14497,6 +16070,131 @@ module Aws::Connect
14497
16070
  include Aws::Structure
14498
16071
  end
14499
16072
 
16073
+ # @!attribute [rw] attributes
16074
+ # A custom key-value pair using an attribute map. The attributes are
16075
+ # standard Amazon Connect attributes, and can be accessed in flows
16076
+ # just like any other contact attributes.
16077
+ #
16078
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
16079
+ # contact. Attribute keys can include only alphanumeric, -, and \_
16080
+ # characters.
16081
+ # @return [Hash<String,String>]
16082
+ #
16083
+ # @!attribute [rw] client_token
16084
+ # A unique, case-sensitive identifier that you provide to ensure the
16085
+ # idempotency of the request. If not provided, the Amazon Web Services
16086
+ # SDK populates this field. For more information about idempotency,
16087
+ # see [Making retries safe with idempotent APIs][1].
16088
+ #
16089
+ # The token is valid for 7 days after creation. If a contact is
16090
+ # already started, the contact ID is returned.
16091
+ #
16092
+ # **A suitable default value is auto-generated.** You should normally
16093
+ # not need to pass this option.
16094
+ #
16095
+ #
16096
+ #
16097
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
16098
+ # @return [String]
16099
+ #
16100
+ # @!attribute [rw] contact_flow_id
16101
+ # The identifier of the flow for the call. To see the ContactFlowId in
16102
+ # the Amazon Connect admin website, on the navigation menu go to
16103
+ # **Routing**, **Contact Flows**. Choose the flow. On the flow page,
16104
+ # under the name of the flow, choose **Show additional flow
16105
+ # information**. The ContactFlowId is the last part of the ARN, shown
16106
+ # here in bold:
16107
+ #
16108
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
16109
+ # @return [String]
16110
+ #
16111
+ # @!attribute [rw] instance_id
16112
+ # The identifier of the Amazon Connect instance. You can [find the
16113
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
16114
+ #
16115
+ #
16116
+ #
16117
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
16118
+ # @return [String]
16119
+ #
16120
+ # @!attribute [rw] allowed_capabilities
16121
+ # Information about the video sharing capabilities of the participants
16122
+ # (customer, agent).
16123
+ # @return [Types::AllowedCapabilities]
16124
+ #
16125
+ # @!attribute [rw] participant_details
16126
+ # The customer's details.
16127
+ # @return [Types::ParticipantDetails]
16128
+ #
16129
+ # @!attribute [rw] related_contact_id
16130
+ # The unique identifier for an Amazon Connect contact. This identifier
16131
+ # is related to the contact starting.
16132
+ # @return [String]
16133
+ #
16134
+ # @!attribute [rw] references
16135
+ # A formatted URL that is shown to an agent in the Contact Control
16136
+ # Panel (CCP). Tasks can have the following reference types at the
16137
+ # time of creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \|
16138
+ # `EMAIL`. `ATTACHMENT` is not a supported reference type during task
16139
+ # creation.
16140
+ # @return [Hash<String,Types::Reference>]
16141
+ #
16142
+ # @!attribute [rw] description
16143
+ # A description of the task that is shown to an agent in the Contact
16144
+ # Control Panel (CCP).
16145
+ # @return [String]
16146
+ #
16147
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContactRequest AWS API Documentation
16148
+ #
16149
+ class StartWebRTCContactRequest < Struct.new(
16150
+ :attributes,
16151
+ :client_token,
16152
+ :contact_flow_id,
16153
+ :instance_id,
16154
+ :allowed_capabilities,
16155
+ :participant_details,
16156
+ :related_contact_id,
16157
+ :references,
16158
+ :description)
16159
+ SENSITIVE = []
16160
+ include Aws::Structure
16161
+ end
16162
+
16163
+ # @!attribute [rw] connection_data
16164
+ # Information required for the client application (mobile application
16165
+ # or website) to connect to the call.
16166
+ # @return [Types::ConnectionData]
16167
+ #
16168
+ # @!attribute [rw] contact_id
16169
+ # The identifier of the contact in this instance of Amazon Connect.
16170
+ # @return [String]
16171
+ #
16172
+ # @!attribute [rw] participant_id
16173
+ # The identifier for a contact participant. The `ParticipantId` for a
16174
+ # contact participant is the same throughout the contact lifecycle.
16175
+ # @return [String]
16176
+ #
16177
+ # @!attribute [rw] participant_token
16178
+ # The token used by the contact participant to call the
16179
+ # [CreateParticipantConnection][1] API. The participant token is valid
16180
+ # for the lifetime of a contact participant.
16181
+ #
16182
+ #
16183
+ #
16184
+ # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
16185
+ # @return [String]
16186
+ #
16187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContactResponse AWS API Documentation
16188
+ #
16189
+ class StartWebRTCContactResponse < Struct.new(
16190
+ :connection_data,
16191
+ :contact_id,
16192
+ :participant_id,
16193
+ :participant_token)
16194
+ SENSITIVE = []
16195
+ include Aws::Structure
16196
+ end
16197
+
14500
16198
  # @!attribute [rw] instance_id
14501
16199
  # The identifier of the Amazon Connect instance. You can [find the
14502
16200
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.