aws-sdk-connect 1.139.0 → 1.141.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
@@ -4721,6 +5086,36 @@ module Aws::Connect
4721
5086
  include Aws::Structure
4722
5087
  end
4723
5088
 
5089
+ # @!attribute [rw] instance_id
5090
+ # The identifier of the Amazon Connect instance. You can [find the
5091
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5092
+ #
5093
+ #
5094
+ #
5095
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5096
+ # @return [String]
5097
+ #
5098
+ # @!attribute [rw] data_set_id
5099
+ # The identifier of the dataset to remove.
5100
+ # @return [String]
5101
+ #
5102
+ # @!attribute [rw] target_account_id
5103
+ # The identifier of the target account. Use to associate a dataset to
5104
+ # a different account than the one containing the Amazon Connect
5105
+ # instance. If not specified, by default this value is the Amazon Web
5106
+ # Services account that has the Amazon Connect instance.
5107
+ # @return [String]
5108
+ #
5109
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateAnalyticsDataSetRequest AWS API Documentation
5110
+ #
5111
+ class DisassociateAnalyticsDataSetRequest < Struct.new(
5112
+ :instance_id,
5113
+ :data_set_id,
5114
+ :target_account_id)
5115
+ SENSITIVE = []
5116
+ include Aws::Structure
5117
+ end
5118
+
4724
5119
  # @!attribute [rw] instance_id
4725
5120
  # The identifier of the Amazon Connect instance. You can [find the
4726
5121
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -4770,6 +5165,37 @@ module Aws::Connect
4770
5165
  include Aws::Structure
4771
5166
  end
4772
5167
 
5168
+ # @!attribute [rw] instance_id
5169
+ # The identifier of the Amazon Connect instance. You can [find the
5170
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5171
+ #
5172
+ #
5173
+ #
5174
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5175
+ # @return [String]
5176
+ #
5177
+ # @!attribute [rw] resource_id
5178
+ # The identifier of the resource.
5179
+ # @return [String]
5180
+ #
5181
+ # @!attribute [rw] resource_type
5182
+ # A valid resource type.
5183
+ # @return [String]
5184
+ #
5185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlowRequest AWS API Documentation
5186
+ #
5187
+ class DisassociateFlowRequest < Struct.new(
5188
+ :instance_id,
5189
+ :resource_id,
5190
+ :resource_type)
5191
+ SENSITIVE = []
5192
+ include Aws::Structure
5193
+ end
5194
+
5195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlowResponse AWS API Documentation
5196
+ #
5197
+ class DisassociateFlowResponse < Aws::EmptyStructure; end
5198
+
4773
5199
  # @!attribute [rw] instance_id
4774
5200
  # The identifier of the Amazon Connect instance. You can [find the
4775
5201
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -5128,18 +5554,40 @@ module Aws::Connect
5128
5554
  include Aws::Structure
5129
5555
  end
5130
5556
 
5131
- # Information about a contact evaluation.
5557
+ # This API is in preview release for Amazon Connect and is subject to
5558
+ # change.
5132
5559
  #
5133
- # @!attribute [rw] evaluation_id
5134
- # A unique identifier for the contact evaluation.
5560
+ # List of errors for dataset association failures.
5561
+ #
5562
+ # @!attribute [rw] error_code
5563
+ # The error code.
5135
5564
  # @return [String]
5136
5565
  #
5137
- # @!attribute [rw] evaluation_arn
5138
- # The Amazon Resource Name (ARN) for the contact evaluation resource.
5566
+ # @!attribute [rw] error_message
5567
+ # The corresponding error message for the error code.
5139
5568
  # @return [String]
5140
5569
  #
5141
- # @!attribute [rw] metadata
5142
- # Metadata about the contact evaluation.
5570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ErrorResult AWS API Documentation
5571
+ #
5572
+ class ErrorResult < Struct.new(
5573
+ :error_code,
5574
+ :error_message)
5575
+ SENSITIVE = []
5576
+ include Aws::Structure
5577
+ end
5578
+
5579
+ # Information about a contact evaluation.
5580
+ #
5581
+ # @!attribute [rw] evaluation_id
5582
+ # A unique identifier for the contact evaluation.
5583
+ # @return [String]
5584
+ #
5585
+ # @!attribute [rw] evaluation_arn
5586
+ # The Amazon Resource Name (ARN) for the contact evaluation resource.
5587
+ # @return [String]
5588
+ #
5589
+ # @!attribute [rw] metadata
5590
+ # Metadata about the contact evaluation.
5143
5591
  # @return [Types::EvaluationMetadata]
5144
5592
  #
5145
5593
  # @!attribute [rw] answers
@@ -6490,6 +6938,55 @@ module Aws::Connect
6490
6938
  include Aws::Structure
6491
6939
  end
6492
6940
 
6941
+ # @!attribute [rw] instance_id
6942
+ # The identifier of the Amazon Connect instance. You can [find the
6943
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
6944
+ #
6945
+ #
6946
+ #
6947
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
6948
+ # @return [String]
6949
+ #
6950
+ # @!attribute [rw] resource_id
6951
+ # The identifier of the resource.
6952
+ # @return [String]
6953
+ #
6954
+ # @!attribute [rw] resource_type
6955
+ # A valid resource type.
6956
+ # @return [String]
6957
+ #
6958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociationRequest AWS API Documentation
6959
+ #
6960
+ class GetFlowAssociationRequest < Struct.new(
6961
+ :instance_id,
6962
+ :resource_id,
6963
+ :resource_type)
6964
+ SENSITIVE = []
6965
+ include Aws::Structure
6966
+ end
6967
+
6968
+ # @!attribute [rw] resource_id
6969
+ # The identifier of the resource.
6970
+ # @return [String]
6971
+ #
6972
+ # @!attribute [rw] flow_id
6973
+ # The identifier of the flow.
6974
+ # @return [String]
6975
+ #
6976
+ # @!attribute [rw] resource_type
6977
+ # A valid resource type.
6978
+ # @return [String]
6979
+ #
6980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociationResponse AWS API Documentation
6981
+ #
6982
+ class GetFlowAssociationResponse < Struct.new(
6983
+ :resource_id,
6984
+ :flow_id,
6985
+ :resource_type)
6986
+ SENSITIVE = []
6987
+ include Aws::Structure
6988
+ end
6989
+
6493
6990
  # @!attribute [rw] instance_id
6494
6991
  # The identifier of the Amazon Connect instance. You can [find the
6495
6992
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -6851,7 +7348,7 @@ module Aws::Connect
6851
7348
  # `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6852
7349
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6853
7350
  # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
6854
- # `FEATURE`
7351
+ # `FEATURE` \| `contact/segmentAttributes/connect:Subtype`
6855
7352
  #
6856
7353
  # * **Filter values**: A maximum of 100 filter values are supported in
6857
7354
  # a single request. VOICE, CHAT, and TASK are valid `filterValue`
@@ -6864,6 +7361,10 @@ module Aws::Connect
6864
7361
  # the `FEATURE` filter key. It is available only to contacts
6865
7362
  # analyzed by Contact Lens conversational analytics.
6866
7363
  #
7364
+ # `connect:Chat`, `connect:SMS`, `connect:Telephony`, and
7365
+ # `connect:WebRTC` are valid `filterValue` examples (not exhaustive)
7366
+ # for the `contact/segmentAttributes/connect:Subtype filter` key.
7367
+ #
6867
7368
  #
6868
7369
  #
6869
7370
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
@@ -6880,7 +7381,8 @@ module Aws::Connect
6880
7381
  # Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
6881
7382
  # `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6882
7383
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6883
- # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
7384
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`,
7385
+ # `contact/segmentAttributes/connect:Subtype`
6884
7386
  # @return [Array<String>]
6885
7387
  #
6886
7388
  # @!attribute [rw] metrics
@@ -6894,7 +7396,8 @@ module Aws::Connect
6894
7396
  # : Unit: Percent
6895
7397
  #
6896
7398
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6897
- # Agent, Agent Hierarchy
7399
+ # Agent, Agent Hierarchy, Feature,
7400
+ # contact/segmentAttributes/connect:Subtype
6898
7401
  #
6899
7402
  # AGENT\_ADHERENT\_TIME
6900
7403
  #
@@ -6906,6 +7409,20 @@ module Aws::Connect
6906
7409
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6907
7410
  # Agent, Agent Hierarchy
6908
7411
  #
7412
+ # AGENT\_ANSWER\_RATE
7413
+ #
7414
+ # : Unit: Percent
7415
+ #
7416
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7417
+ # Agent, Agent Hierarchy
7418
+ #
7419
+ # AGENT\_NON\_ADHERENT\_TIME
7420
+ #
7421
+ # : Unit: Seconds
7422
+ #
7423
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7424
+ # Agent, Agent Hierarchy
7425
+ #
6909
7426
  # AGENT\_NON\_RESPONSE
6910
7427
  #
6911
7428
  # : Unit: Count
@@ -6955,14 +7472,18 @@ module Aws::Connect
6955
7472
  # : Unit: Seconds
6956
7473
  #
6957
7474
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6958
- # Agent, Agent Hierarchy
7475
+ # Agent, Agent Hierarchy, Feature,
7476
+ # contact/segmentAttributes/connect:Subtype
6959
7477
  #
6960
7478
  # AVG\_AFTER\_CONTACT\_WORK\_TIME
6961
7479
  #
6962
7480
  # : Unit: Seconds
6963
7481
  #
7482
+ # Valid metric filter key: `INITIATION_METHOD`
7483
+ #
6964
7484
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6965
- # Agent, Agent Hierarchy, Feature
7485
+ # Agent, Agent Hierarchy, Feature,
7486
+ # contact/segmentAttributes/connect:Subtype
6966
7487
  #
6967
7488
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6968
7489
  #
@@ -6989,7 +7510,8 @@ module Aws::Connect
6989
7510
  # : Unit: Seconds
6990
7511
  #
6991
7512
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6992
- # Agent, Agent Hierarchy, Feature
7513
+ # Agent, Agent Hierarchy, Feature,
7514
+ # contact/segmentAttributes/connect:Subtype
6993
7515
  #
6994
7516
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6995
7517
  #
@@ -7000,7 +7522,8 @@ module Aws::Connect
7000
7522
  # : Unit: Seconds
7001
7523
  #
7002
7524
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7003
- # Agent, Agent Hierarchy
7525
+ # Agent, Agent Hierarchy, Feature,
7526
+ # contact/segmentAttributes/connect:Subtype
7004
7527
  #
7005
7528
  # AVG\_GREETING\_TIME\_AGENT
7006
7529
  #
@@ -7010,14 +7533,15 @@ module Aws::Connect
7010
7533
  # Unit: Seconds
7011
7534
  #
7012
7535
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7013
- # Agent, Agent Hierarchy
7536
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7014
7537
  #
7015
7538
  # AVG\_HANDLE\_TIME
7016
7539
  #
7017
7540
  # : Unit: Seconds
7018
7541
  #
7019
7542
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7020
- # Agent, Agent Hierarchy, Feature
7543
+ # Agent, Agent Hierarchy, Feature,
7544
+ # contact/segmentAttributes/connect:Subtype
7021
7545
  #
7022
7546
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7023
7547
  #
@@ -7028,7 +7552,8 @@ module Aws::Connect
7028
7552
  # : Unit: Seconds
7029
7553
  #
7030
7554
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7031
- # Agent, Agent Hierarchy, Feature
7555
+ # Agent, Agent Hierarchy, Feature,
7556
+ # contact/segmentAttributes/connect:Subtype
7032
7557
  #
7033
7558
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7034
7559
  #
@@ -7039,14 +7564,15 @@ module Aws::Connect
7039
7564
  # : Unit: Seconds
7040
7565
  #
7041
7566
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7042
- # Agent, Agent Hierarchy
7567
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7043
7568
  #
7044
7569
  # AVG\_HOLDS
7045
7570
  #
7046
7571
  # : Unit: Count
7047
7572
  #
7048
7573
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7049
- # Agent, Agent Hierarchy, Feature
7574
+ # Agent, Agent Hierarchy, Feature,
7575
+ # contact/segmentAttributes/connect:Subtype
7050
7576
  #
7051
7577
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7052
7578
  #
@@ -7057,14 +7583,16 @@ module Aws::Connect
7057
7583
  # : Unit: Seconds
7058
7584
  #
7059
7585
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7060
- # Agent, Agent Hierarchy
7586
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7061
7587
  #
7062
7588
  # AVG\_INTERACTION\_TIME
7063
7589
  #
7064
7590
  # : Unit: Seconds
7065
7591
  #
7592
+ # Valid metric filter key: `INITIATION_METHOD`
7593
+ #
7066
7594
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7067
- # Feature
7595
+ # Feature, contact/segmentAttributes/connect:Subtype
7068
7596
  #
7069
7597
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7070
7598
  #
@@ -7078,7 +7606,7 @@ module Aws::Connect
7078
7606
  # Unit: Count
7079
7607
  #
7080
7608
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7081
- # Agent, Agent Hierarchy
7609
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7082
7610
  #
7083
7611
  # AVG\_INTERRUPTION\_TIME\_AGENT
7084
7612
  #
@@ -7088,7 +7616,7 @@ module Aws::Connect
7088
7616
  # Unit: Seconds
7089
7617
  #
7090
7618
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7091
- # Agent, Agent Hierarchy
7619
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7092
7620
  #
7093
7621
  # AVG\_NON\_TALK\_TIME
7094
7622
  #
@@ -7098,14 +7626,14 @@ module Aws::Connect
7098
7626
  # Unit: Seconds
7099
7627
  #
7100
7628
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7101
- # Agent, Agent Hierarchy
7629
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7102
7630
  #
7103
7631
  # AVG\_QUEUE\_ANSWER\_TIME
7104
7632
  #
7105
7633
  # : Unit: Seconds
7106
7634
  #
7107
7635
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7108
- # Feature
7636
+ # Feature, contact/segmentAttributes/connect:Subtype
7109
7637
  #
7110
7638
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7111
7639
  #
@@ -7115,7 +7643,8 @@ module Aws::Connect
7115
7643
  #
7116
7644
  # : Unit: Seconds
7117
7645
  #
7118
- # Valid groupings and filters: Queue, Channel, Routing Profile
7646
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7647
+ # contact/segmentAttributes/connect:Subtype
7119
7648
  #
7120
7649
  # AVG\_TALK\_TIME
7121
7650
  #
@@ -7125,7 +7654,7 @@ module Aws::Connect
7125
7654
  # Unit: Seconds
7126
7655
  #
7127
7656
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7128
- # Agent, Agent Hierarchy
7657
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7129
7658
  #
7130
7659
  # AVG\_TALK\_TIME\_AGENT
7131
7660
  #
@@ -7135,7 +7664,7 @@ module Aws::Connect
7135
7664
  # Unit: Seconds
7136
7665
  #
7137
7666
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7138
- # Agent, Agent Hierarchy
7667
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7139
7668
  #
7140
7669
  # AVG\_TALK\_TIME\_CUSTOMER
7141
7670
  #
@@ -7145,14 +7674,14 @@ module Aws::Connect
7145
7674
  # Unit: Seconds
7146
7675
  #
7147
7676
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7148
- # Agent, Agent Hierarchy
7677
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7149
7678
  #
7150
7679
  # CONTACTS\_ABANDONED
7151
7680
  #
7152
7681
  # : Unit: Count
7153
7682
  #
7154
7683
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7155
- # Agent, Agent Hierarchy
7684
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7156
7685
  #
7157
7686
  # CONTACTS\_CREATED
7158
7687
  #
@@ -7161,7 +7690,7 @@ module Aws::Connect
7161
7690
  # Valid metric filter key: `INITIATION_METHOD`
7162
7691
  #
7163
7692
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7164
- # Feature
7693
+ # Feature, contact/segmentAttributes/connect:Subtype
7165
7694
  #
7166
7695
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7167
7696
  #
@@ -7174,7 +7703,8 @@ module Aws::Connect
7174
7703
  # Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
7175
7704
  #
7176
7705
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7177
- # Agent, Agent Hierarchy, Feature
7706
+ # Agent, Agent Hierarchy, Feature,
7707
+ # contact/segmentAttributes/connect:Subtype
7178
7708
  #
7179
7709
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7180
7710
  #
@@ -7185,20 +7715,56 @@ module Aws::Connect
7185
7715
  # : Unit: Count
7186
7716
  #
7187
7717
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7718
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7719
+ #
7720
+ # CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
7721
+ #
7722
+ # : Unit: Count
7723
+ #
7724
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7188
7725
  # Agent, Agent Hierarchy
7189
7726
  #
7190
- # CONTACTS\_QUEUED
7727
+ # CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
7728
+ #
7729
+ # : Unit: Count
7730
+ #
7731
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7732
+ # Agent, Agent Hierarchy
7733
+ #
7734
+ # CONTACTS\_PUT\_ON\_HOLD
7735
+ #
7736
+ # : Unit: Count
7737
+ #
7738
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7739
+ # Agent, Agent Hierarchy
7740
+ #
7741
+ # CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
7191
7742
  #
7192
7743
  # : Unit: Count
7193
7744
  #
7194
7745
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7195
7746
  # Agent, Agent Hierarchy
7196
7747
  #
7748
+ # CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
7749
+ #
7750
+ # : Unit: Percent
7751
+ #
7752
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7753
+ # Agent, Agent Hierarchy
7754
+ #
7755
+ # CONTACTS\_QUEUED
7756
+ #
7757
+ # : Unit: Count
7758
+ #
7759
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7760
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7761
+ #
7197
7762
  # CONTACTS\_RESOLVED\_IN\_X
7198
7763
  #
7199
7764
  # : Unit: Count
7200
7765
  #
7201
- # Valid groupings and filters: Queue, Channel, Routing Profile
7766
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7767
+ # contact/segmentAttributes/connect:Subtype
7202
7768
  #
7203
7769
  # Threshold: For `ThresholdValue` enter any whole number from 1 to
7204
7770
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7209,7 +7775,8 @@ module Aws::Connect
7209
7775
  # : Unit: Count
7210
7776
  #
7211
7777
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7212
- # Agent, Agent Hierarchy, Feature
7778
+ # Agent, Agent Hierarchy, Feature,
7779
+ # contact/segmentAttributes/connect:Subtype
7213
7780
  #
7214
7781
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7215
7782
  #
@@ -7220,21 +7787,21 @@ module Aws::Connect
7220
7787
  # : Unit: Count
7221
7788
  #
7222
7789
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7223
- # Agent, Agent Hierarchy
7790
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7224
7791
  #
7225
7792
  # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
7226
7793
  #
7227
7794
  # : Unit: Count
7228
7795
  #
7229
7796
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7230
- # Agent, Agent Hierarchy
7797
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7231
7798
  #
7232
7799
  # MAX\_QUEUED\_TIME
7233
7800
  #
7234
7801
  # : Unit: Seconds
7235
7802
  #
7236
7803
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7237
- # Agent, Agent Hierarchy
7804
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7238
7805
  #
7239
7806
  # PERCENT\_NON\_TALK\_TIME
7240
7807
  #
@@ -7244,7 +7811,7 @@ module Aws::Connect
7244
7811
  # Unit: Percentage
7245
7812
  #
7246
7813
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7247
- # Agent, Agent Hierarchy
7814
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7248
7815
  #
7249
7816
  # PERCENT\_TALK\_TIME
7250
7817
  #
@@ -7254,7 +7821,7 @@ module Aws::Connect
7254
7821
  # Unit: Percentage
7255
7822
  #
7256
7823
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7257
- # Agent, Agent Hierarchy
7824
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7258
7825
  #
7259
7826
  # PERCENT\_TALK\_TIME\_AGENT
7260
7827
  #
@@ -7264,7 +7831,7 @@ module Aws::Connect
7264
7831
  # Unit: Percentage
7265
7832
  #
7266
7833
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7267
- # Agent, Agent Hierarchy
7834
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7268
7835
  #
7269
7836
  # PERCENT\_TALK\_TIME\_CUSTOMER
7270
7837
  #
@@ -7274,7 +7841,7 @@ module Aws::Connect
7274
7841
  # Unit: Percentage
7275
7842
  #
7276
7843
  # Valid groupings and filters: Queue, Channel, Routing Profile,
7277
- # Agent, Agent Hierarchy
7844
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7278
7845
  #
7279
7846
  # SERVICE\_LEVEL
7280
7847
  #
@@ -7288,11 +7855,49 @@ module Aws::Connect
7288
7855
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
7289
7856
  # `LT` (for "Less than").
7290
7857
  #
7858
+ # SUM\_AFTER\_CONTACT\_WORK\_TIME
7859
+ #
7860
+ # : Unit: Seconds
7861
+ #
7862
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7863
+ # Agent, Agent Hierarchy
7864
+ #
7865
+ # SUM\_CONNECTING\_TIME\_AGENT
7866
+ #
7867
+ # : Unit: Seconds
7868
+ #
7869
+ # Valid metric filter key: `INITIATION_METHOD`. This metric only
7870
+ # supports the following filter keys as `INITIATION_METHOD`:
7871
+ # `INBOUND` \| `OUTBOUND` \| `CALLBACK` \| `API`
7872
+ #
7873
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7874
+ # Agent, Agent Hierarchy
7875
+ #
7876
+ # <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for
7877
+ # this metric.
7878
+ #
7879
+ # </note>
7880
+ #
7881
+ # SUM\_CONTACT\_FLOW\_TIME
7882
+ #
7883
+ # : Unit: Seconds
7884
+ #
7885
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7886
+ # Agent, Agent Hierarchy
7887
+ #
7888
+ # SUM\_CONTACT\_TIME\_AGENT
7889
+ #
7890
+ # : Unit: Seconds
7891
+ #
7892
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7893
+ # Agent, Agent Hierarchy
7894
+ #
7291
7895
  # SUM\_CONTACTS\_ANSWERED\_IN\_X
7292
7896
  #
7293
7897
  # : Unit: Count
7294
7898
  #
7295
- # Valid groupings and filters: Queue, Channel, Routing Profile
7899
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7900
+ # contact/segmentAttributes/connect:Subtype
7296
7901
  #
7297
7902
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
7298
7903
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7302,7 +7907,8 @@ module Aws::Connect
7302
7907
  #
7303
7908
  # : Unit: Count
7304
7909
  #
7305
- # Valid groupings and filters: Queue, Channel, Routing Profile
7910
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7911
+ # contact/segmentAttributes/connect:Subtype
7306
7912
  #
7307
7913
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
7308
7914
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -7314,13 +7920,71 @@ module Aws::Connect
7314
7920
  #
7315
7921
  # Unit: Count
7316
7922
  #
7317
- # Valid groupings and filters: Queue, Channel, Routing Profile
7923
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7924
+ # Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7925
+ #
7926
+ # SUM\_ERROR\_STATUS\_TIME\_AGENT
7927
+ #
7928
+ # : Unit: Seconds
7929
+ #
7930
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7931
+ # Agent, Agent Hierarchy
7932
+ #
7933
+ # SUM\_HANDLE\_TIME
7934
+ #
7935
+ # : Unit: Seconds
7936
+ #
7937
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7938
+ # Agent, Agent Hierarchy
7939
+ #
7940
+ # SUM\_HOLD\_TIME
7941
+ #
7942
+ # : Unit: Count
7943
+ #
7944
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7945
+ # Agent, Agent Hierarchy
7946
+ #
7947
+ # SUM\_IDLE\_TIME\_AGENT
7948
+ #
7949
+ # : Unit: Seconds
7950
+ #
7951
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7952
+ # Hierarchy
7953
+ #
7954
+ # SUM\_INTERACTION\_AND\_HOLD\_TIME
7955
+ #
7956
+ # : Unit: Seconds
7957
+ #
7958
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7959
+ # Agent, Agent Hierarchy
7960
+ #
7961
+ # SUM\_INTERACTION\_TIME
7962
+ #
7963
+ # : Unit: Seconds
7964
+ #
7965
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7966
+ # Agent, Agent Hierarchy
7967
+ #
7968
+ # SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
7969
+ #
7970
+ # : Unit: Seconds
7971
+ #
7972
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7973
+ # Hierarchy
7974
+ #
7975
+ # SUM\_ONLINE\_TIME\_AGENT
7976
+ #
7977
+ # : Unit: Seconds
7978
+ #
7979
+ # Valid groupings and filters: Routing Profile, Agent, Agent
7980
+ # Hierarchy
7318
7981
  #
7319
7982
  # SUM\_RETRY\_CALLBACK\_ATTEMPTS
7320
7983
  #
7321
7984
  # : Unit: Count
7322
7985
  #
7323
- # Valid groupings and filters: Queue, Channel, Routing Profile
7986
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7987
+ # contact/segmentAttributes/connect:Subtype
7324
7988
  #
7325
7989
  #
7326
7990
  #
@@ -8168,9 +8832,7 @@ module Aws::Connect
8168
8832
  include Aws::Structure
8169
8833
  end
8170
8834
 
8171
- # The Amazon Connect instance.
8172
- #
8173
- # @!attribute [rw] id
8835
+ # @!attribute [rw] instance_id
8174
8836
  # The identifier of the Amazon Connect instance. You can [find the
8175
8837
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
8176
8838
  #
@@ -8179,33 +8841,104 @@ module Aws::Connect
8179
8841
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
8180
8842
  # @return [String]
8181
8843
  #
8182
- # @!attribute [rw] arn
8183
- # The Amazon Resource Name (ARN) of the instance.
8844
+ # @!attribute [rw] source_phone_number_arn
8845
+ # The claimed phone number ARN being imported from the external
8846
+ # service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it
8847
+ # looks like the ARN of the phone number to import from Amazon
8848
+ # Pinpoint.
8184
8849
  # @return [String]
8185
8850
  #
8186
- # @!attribute [rw] identity_management_type
8187
- # The identity management type.
8851
+ # @!attribute [rw] phone_number_description
8852
+ # The description of the phone number.
8188
8853
  # @return [String]
8189
8854
  #
8190
- # @!attribute [rw] instance_alias
8191
- # The alias of instance.
8192
- # @return [String]
8855
+ # @!attribute [rw] tags
8856
+ # The tags used to organize, track, or control access for this
8857
+ # resource. For example, \\\{ "tags": \\\{"key1":"value1",
8858
+ # "key2":"value2"\\} \\}.
8859
+ # @return [Hash<String,String>]
8193
8860
  #
8194
- # @!attribute [rw] created_time
8195
- # When the instance was created.
8196
- # @return [Time]
8861
+ # @!attribute [rw] client_token
8862
+ # A unique, case-sensitive identifier that you provide to ensure the
8863
+ # idempotency of the request. If not provided, the Amazon Web Services
8864
+ # SDK populates this field. For more information about idempotency,
8865
+ # see [Making retries safe with idempotent APIs][1].
8197
8866
  #
8198
- # @!attribute [rw] service_role
8199
- # The service role of the instance.
8200
- # @return [String]
8867
+ # **A suitable default value is auto-generated.** You should normally
8868
+ # not need to pass this option.
8201
8869
  #
8202
- # @!attribute [rw] instance_status
8203
- # The state of the instance.
8204
- # @return [String]
8205
8870
  #
8206
- # @!attribute [rw] status_reason
8207
- # Relevant details why the instance was not successfully created.
8208
- # @return [Types::InstanceStatusReason]
8871
+ #
8872
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
8873
+ # @return [String]
8874
+ #
8875
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumberRequest AWS API Documentation
8876
+ #
8877
+ class ImportPhoneNumberRequest < Struct.new(
8878
+ :instance_id,
8879
+ :source_phone_number_arn,
8880
+ :phone_number_description,
8881
+ :tags,
8882
+ :client_token)
8883
+ SENSITIVE = []
8884
+ include Aws::Structure
8885
+ end
8886
+
8887
+ # @!attribute [rw] phone_number_id
8888
+ # A unique identifier for the phone number.
8889
+ # @return [String]
8890
+ #
8891
+ # @!attribute [rw] phone_number_arn
8892
+ # The Amazon Resource Name (ARN) of the phone number.
8893
+ # @return [String]
8894
+ #
8895
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumberResponse AWS API Documentation
8896
+ #
8897
+ class ImportPhoneNumberResponse < Struct.new(
8898
+ :phone_number_id,
8899
+ :phone_number_arn)
8900
+ SENSITIVE = []
8901
+ include Aws::Structure
8902
+ end
8903
+
8904
+ # The Amazon Connect instance.
8905
+ #
8906
+ # @!attribute [rw] id
8907
+ # The identifier of the Amazon Connect instance. You can [find the
8908
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
8909
+ #
8910
+ #
8911
+ #
8912
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
8913
+ # @return [String]
8914
+ #
8915
+ # @!attribute [rw] arn
8916
+ # The Amazon Resource Name (ARN) of the instance.
8917
+ # @return [String]
8918
+ #
8919
+ # @!attribute [rw] identity_management_type
8920
+ # The identity management type.
8921
+ # @return [String]
8922
+ #
8923
+ # @!attribute [rw] instance_alias
8924
+ # The alias of instance.
8925
+ # @return [String]
8926
+ #
8927
+ # @!attribute [rw] created_time
8928
+ # When the instance was created.
8929
+ # @return [Time]
8930
+ #
8931
+ # @!attribute [rw] service_role
8932
+ # The service role of the instance.
8933
+ # @return [String]
8934
+ #
8935
+ # @!attribute [rw] instance_status
8936
+ # The state of the instance.
8937
+ # @return [String]
8938
+ #
8939
+ # @!attribute [rw] status_reason
8940
+ # Relevant details why the instance was not successfully created.
8941
+ # @return [Types::InstanceStatusReason]
8209
8942
  #
8210
8943
  # @!attribute [rw] inbound_calls_enabled
8211
8944
  # Whether inbound calls are enabled.
@@ -8713,6 +9446,60 @@ module Aws::Connect
8713
9446
  include Aws::Structure
8714
9447
  end
8715
9448
 
9449
+ # @!attribute [rw] instance_id
9450
+ # The identifier of the Amazon Connect instance. You can [find the
9451
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
9452
+ #
9453
+ #
9454
+ #
9455
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9456
+ # @return [String]
9457
+ #
9458
+ # @!attribute [rw] data_set_id
9459
+ # The identifier of the dataset to get the association status.
9460
+ # @return [String]
9461
+ #
9462
+ # @!attribute [rw] next_token
9463
+ # The token for the next set of results. Use the value returned in the
9464
+ # previous response in the next request to retrieve the next set of
9465
+ # results.
9466
+ # @return [String]
9467
+ #
9468
+ # @!attribute [rw] max_results
9469
+ # The maximum number of results to return per page.
9470
+ # @return [Integer]
9471
+ #
9472
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociationsRequest AWS API Documentation
9473
+ #
9474
+ class ListAnalyticsDataAssociationsRequest < Struct.new(
9475
+ :instance_id,
9476
+ :data_set_id,
9477
+ :next_token,
9478
+ :max_results)
9479
+ SENSITIVE = []
9480
+ include Aws::Structure
9481
+ end
9482
+
9483
+ # @!attribute [rw] results
9484
+ # An array of successful results: `DataSetId`, `TargetAccountId`,
9485
+ # `ResourceShareId`, `ResourceShareArn`. This is a paginated API, so
9486
+ # `nextToken` is given if there are more results to be returned.
9487
+ # @return [Array<Types::AnalyticsDataAssociationResult>]
9488
+ #
9489
+ # @!attribute [rw] next_token
9490
+ # If there are additional results, this is the token for the next set
9491
+ # of results.
9492
+ # @return [String]
9493
+ #
9494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociationsResponse AWS API Documentation
9495
+ #
9496
+ class ListAnalyticsDataAssociationsResponse < Struct.new(
9497
+ :results,
9498
+ :next_token)
9499
+ SENSITIVE = []
9500
+ include Aws::Structure
9501
+ end
9502
+
8716
9503
  # @!attribute [rw] instance_id
8717
9504
  # The identifier of the Amazon Connect instance. You can [find the
8718
9505
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -9187,6 +9974,58 @@ module Aws::Connect
9187
9974
  include Aws::Structure
9188
9975
  end
9189
9976
 
9977
+ # @!attribute [rw] instance_id
9978
+ # The identifier of the Amazon Connect instance. You can [find the
9979
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
9980
+ #
9981
+ #
9982
+ #
9983
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9984
+ # @return [String]
9985
+ #
9986
+ # @!attribute [rw] resource_type
9987
+ # A valid resource type.
9988
+ # @return [String]
9989
+ #
9990
+ # @!attribute [rw] next_token
9991
+ # The token for the next set of results. Use the value returned in the
9992
+ # previous response in the next request to retrieve the next set of
9993
+ # results.
9994
+ # @return [String]
9995
+ #
9996
+ # @!attribute [rw] max_results
9997
+ # The maximum number of results to return per page.
9998
+ # @return [Integer]
9999
+ #
10000
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociationsRequest AWS API Documentation
10001
+ #
10002
+ class ListFlowAssociationsRequest < Struct.new(
10003
+ :instance_id,
10004
+ :resource_type,
10005
+ :next_token,
10006
+ :max_results)
10007
+ SENSITIVE = []
10008
+ include Aws::Structure
10009
+ end
10010
+
10011
+ # @!attribute [rw] flow_association_summary_list
10012
+ # Summary of flow associations.
10013
+ # @return [Array<Types::FlowAssociationSummary>]
10014
+ #
10015
+ # @!attribute [rw] next_token
10016
+ # If there are additional results, this is the token for the next set
10017
+ # of results.
10018
+ # @return [String]
10019
+ #
10020
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociationsResponse AWS API Documentation
10021
+ #
10022
+ class ListFlowAssociationsResponse < Struct.new(
10023
+ :flow_association_summary_list,
10024
+ :next_token)
10025
+ SENSITIVE = []
10026
+ include Aws::Structure
10027
+ end
10028
+
9190
10029
  # @!attribute [rw] instance_id
9191
10030
  # The identifier of the Amazon Connect instance. You can [find the
9192
10031
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -9633,6 +10472,17 @@ module Aws::Connect
9633
10472
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9634
10473
  # @return [String]
9635
10474
  #
10475
+ # @!attribute [rw] phone_number_description
10476
+ # The description of the phone number.
10477
+ # @return [String]
10478
+ #
10479
+ # @!attribute [rw] source_phone_number_arn
10480
+ # The claimed phone number ARN that was previously imported from the
10481
+ # external service, such as Amazon Pinpoint. If it is from Amazon
10482
+ # Pinpoint, it looks like the ARN of the phone number that was
10483
+ # imported from Amazon Pinpoint.
10484
+ # @return [String]
10485
+ #
9636
10486
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersSummary AWS API Documentation
9637
10487
  #
9638
10488
  class ListPhoneNumbersSummary < Struct.new(
@@ -9642,7 +10492,9 @@ module Aws::Connect
9642
10492
  :phone_number_country_code,
9643
10493
  :phone_number_type,
9644
10494
  :target_arn,
9645
- :instance_id)
10495
+ :instance_id,
10496
+ :phone_number_description,
10497
+ :source_phone_number_arn)
9646
10498
  SENSITIVE = []
9647
10499
  include Aws::Structure
9648
10500
  end
@@ -9906,8 +10758,8 @@ module Aws::Connect
9906
10758
  # @return [Integer]
9907
10759
  #
9908
10760
  # @!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
10761
+ # The type of quick connect. In the Amazon Connect admin website, when
10762
+ # you create a quick connect, you are prompted to assign one of the
9911
10763
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
9912
10764
  # (QUEUE).
9913
10765
  # @return [Array<String>]
@@ -9941,6 +10793,81 @@ module Aws::Connect
9941
10793
  include Aws::Structure
9942
10794
  end
9943
10795
 
10796
+ # @!attribute [rw] instance_id
10797
+ # The identifier of the Amazon Connect instance. You can [find the
10798
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
10799
+ #
10800
+ #
10801
+ #
10802
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
10803
+ # @return [String]
10804
+ #
10805
+ # @!attribute [rw] contact_id
10806
+ # The identifier of the contact in this instance of Amazon Connect.
10807
+ # @return [String]
10808
+ #
10809
+ # @!attribute [rw] max_results
10810
+ # The maximum number of results to return per page.
10811
+ # @return [Integer]
10812
+ #
10813
+ # @!attribute [rw] next_token
10814
+ # The token for the next set of results. Use the value returned in the
10815
+ # previous response in the next request to retrieve the next set of
10816
+ # results.
10817
+ # @return [String]
10818
+ #
10819
+ # @!attribute [rw] output_type
10820
+ # The Contact Lens output type to be returned.
10821
+ # @return [String]
10822
+ #
10823
+ # @!attribute [rw] segment_types
10824
+ # Enum with segment types . Each value corresponds to a segment type
10825
+ # returned in the segments list of the API. Each segment type has its
10826
+ # own structure. Different channels may have different sets of
10827
+ # supported segment types.
10828
+ # @return [Array<String>]
10829
+ #
10830
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2Request AWS API Documentation
10831
+ #
10832
+ class ListRealtimeContactAnalysisSegmentsV2Request < Struct.new(
10833
+ :instance_id,
10834
+ :contact_id,
10835
+ :max_results,
10836
+ :next_token,
10837
+ :output_type,
10838
+ :segment_types)
10839
+ SENSITIVE = []
10840
+ include Aws::Structure
10841
+ end
10842
+
10843
+ # @!attribute [rw] channel
10844
+ # The channel of the contact. `Voice` will not be returned.
10845
+ # @return [String]
10846
+ #
10847
+ # @!attribute [rw] status
10848
+ # Status of real-time contact analysis.
10849
+ # @return [String]
10850
+ #
10851
+ # @!attribute [rw] segments
10852
+ # An analyzed transcript or category.
10853
+ # @return [Array<Types::RealtimeContactAnalysisSegment>]
10854
+ #
10855
+ # @!attribute [rw] next_token
10856
+ # If there are additional results, this is the token for the next set
10857
+ # of results.
10858
+ # @return [String]
10859
+ #
10860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2Response AWS API Documentation
10861
+ #
10862
+ class ListRealtimeContactAnalysisSegmentsV2Response < Struct.new(
10863
+ :channel,
10864
+ :status,
10865
+ :segments,
10866
+ :next_token)
10867
+ SENSITIVE = []
10868
+ include Aws::Structure
10869
+ end
10870
+
9944
10871
  # @!attribute [rw] instance_id
9945
10872
  # The identifier of the Amazon Connect instance. You can [find the
9946
10873
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
@@ -10831,6 +11758,85 @@ module Aws::Connect
10831
11758
  include Aws::Structure
10832
11759
  end
10833
11760
 
11761
+ # A set of endpoints used by clients to connect to the media service
11762
+ # group for an Amazon Chime SDK meeting.
11763
+ #
11764
+ # @!attribute [rw] audio_host_url
11765
+ # The audio host URL.
11766
+ # @return [String]
11767
+ #
11768
+ # @!attribute [rw] audio_fallback_url
11769
+ # The audio fallback URL.
11770
+ # @return [String]
11771
+ #
11772
+ # @!attribute [rw] signaling_url
11773
+ # The signaling URL.
11774
+ # @return [String]
11775
+ #
11776
+ # @!attribute [rw] turn_control_url
11777
+ # The turn control URL.
11778
+ # @return [String]
11779
+ #
11780
+ # @!attribute [rw] event_ingestion_url
11781
+ # The event ingestion URL to which you send client meeting events.
11782
+ # @return [String]
11783
+ #
11784
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MediaPlacement AWS API Documentation
11785
+ #
11786
+ class MediaPlacement < Struct.new(
11787
+ :audio_host_url,
11788
+ :audio_fallback_url,
11789
+ :signaling_url,
11790
+ :turn_control_url,
11791
+ :event_ingestion_url)
11792
+ SENSITIVE = []
11793
+ include Aws::Structure
11794
+ end
11795
+
11796
+ # A meeting created using the Amazon Chime SDK.
11797
+ #
11798
+ # @!attribute [rw] media_region
11799
+ # The Amazon Web Services Region in which you create the meeting.
11800
+ # @return [String]
11801
+ #
11802
+ # @!attribute [rw] media_placement
11803
+ # The media placement for the meeting.
11804
+ # @return [Types::MediaPlacement]
11805
+ #
11806
+ # @!attribute [rw] meeting_features
11807
+ # The configuration settings of the features available to a meeting.
11808
+ # @return [Types::MeetingFeaturesConfiguration]
11809
+ #
11810
+ # @!attribute [rw] meeting_id
11811
+ # The Amazon Chime SDK meeting ID.
11812
+ # @return [String]
11813
+ #
11814
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Meeting AWS API Documentation
11815
+ #
11816
+ class Meeting < Struct.new(
11817
+ :media_region,
11818
+ :media_placement,
11819
+ :meeting_features,
11820
+ :meeting_id)
11821
+ SENSITIVE = []
11822
+ include Aws::Structure
11823
+ end
11824
+
11825
+ # The configuration settings of the features available to a meeting.
11826
+ #
11827
+ # @!attribute [rw] audio
11828
+ # The configuration settings for the audio features available to a
11829
+ # meeting.
11830
+ # @return [Types::AudioFeatures]
11831
+ #
11832
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/MeetingFeaturesConfiguration AWS API Documentation
11833
+ #
11834
+ class MeetingFeaturesConfiguration < Struct.new(
11835
+ :audio)
11836
+ SENSITIVE = []
11837
+ include Aws::Structure
11838
+ end
11839
+
10834
11840
  # Contains the name, thresholds, and metric filters.
10835
11841
  #
10836
11842
  # @!attribute [rw] metric
@@ -11042,10 +12048,56 @@ module Aws::Connect
11042
12048
  include Aws::Structure
11043
12049
  end
11044
12050
 
11045
- # The type of notification recipient.
12051
+ # Payload of chat properties to apply when starting a new contact.
11046
12052
  #
11047
- # @!attribute [rw] user_tags
11048
- # The tags used to organize, track, or control access for this
12053
+ # @!attribute [rw] supported_messaging_content_types
12054
+ # The supported chat message content types. Supported types are
12055
+ # `text/plain`, `text/markdown`, `application/json`,
12056
+ # `application/vnd.amazonaws.connect.message.interactive`, and
12057
+ # `application/vnd.amazonaws.connect.message.interactive.response`.
12058
+ #
12059
+ # Content types must always contain ` text/plain`. You can then put
12060
+ # any other supported type in the list. For example, all the following
12061
+ # lists are valid because they contain `text/plain`: `[text/plain,
12062
+ # text/markdown, application/json]`, ` [text/markdown, text/plain]`,
12063
+ # `[text/plain, application/json,
12064
+ # application/vnd.amazonaws.connect.message.interactive.response]`.
12065
+ # @return [Array<String>]
12066
+ #
12067
+ # @!attribute [rw] participant_details
12068
+ # The customer's details.
12069
+ # @return [Types::ParticipantDetails]
12070
+ #
12071
+ # @!attribute [rw] attributes
12072
+ # A custom key-value pair using an attribute map. The attributes are
12073
+ # standard Amazon Connect attributes. They can be accessed in flows
12074
+ # just like any other contact attributes.
12075
+ #
12076
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
12077
+ # contact. Attribute keys can include only alphanumeric, dash, and
12078
+ # underscore characters.
12079
+ # @return [Hash<String,String>]
12080
+ #
12081
+ # @!attribute [rw] streaming_configuration
12082
+ # The streaming configuration, such as the Amazon SNS streaming
12083
+ # endpoint.
12084
+ # @return [Types::ChatStreamingConfiguration]
12085
+ #
12086
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NewSessionDetails AWS API Documentation
12087
+ #
12088
+ class NewSessionDetails < Struct.new(
12089
+ :supported_messaging_content_types,
12090
+ :participant_details,
12091
+ :attributes,
12092
+ :streaming_configuration)
12093
+ SENSITIVE = []
12094
+ include Aws::Structure
12095
+ end
12096
+
12097
+ # The type of notification recipient.
12098
+ #
12099
+ # @!attribute [rw] user_tags
12100
+ # The tags used to organize, track, or control access for this
11049
12101
  # resource. For example, \\\{ "tags": \\\{"key1":"value1",
11050
12102
  # "key2":"value2"\\} \\}. Amazon Connect users with the specified
11051
12103
  # tags will be notified.
@@ -11149,6 +12201,38 @@ module Aws::Connect
11149
12201
  include Aws::Structure
11150
12202
  end
11151
12203
 
12204
+ # Thrown for analyzed content when requested OutputType was not enabled
12205
+ # for a given contact. For example, if an OutputType.Raw was requested
12206
+ # for a contact that had `RedactedOnly` Redaction policy set in
12207
+ # Contact flow.
12208
+ #
12209
+ # @!attribute [rw] message
12210
+ # @return [String]
12211
+ #
12212
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutputTypeNotFoundException AWS API Documentation
12213
+ #
12214
+ class OutputTypeNotFoundException < Struct.new(
12215
+ :message)
12216
+ SENSITIVE = []
12217
+ include Aws::Structure
12218
+ end
12219
+
12220
+ # The configuration for the allowed capabilities for participants
12221
+ # present over the call.
12222
+ #
12223
+ # @!attribute [rw] video
12224
+ # The configuration having the video sharing capabilities for
12225
+ # participants over the call.
12226
+ # @return [String]
12227
+ #
12228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantCapabilities AWS API Documentation
12229
+ #
12230
+ class ParticipantCapabilities < Struct.new(
12231
+ :video)
12232
+ SENSITIVE = []
12233
+ include Aws::Structure
12234
+ end
12235
+
11152
12236
  # The customer's details.
11153
12237
  #
11154
12238
  # @!attribute [rw] display_name
@@ -11926,8 +13010,8 @@ module Aws::Connect
11926
13010
  # Contains configuration settings for a quick connect.
11927
13011
  #
11928
13012
  # @!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
13013
+ # The type of quick connect. In the Amazon Connect admin website, when
13014
+ # you create a quick connect, you are prompted to assign one of the
11931
13015
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
11932
13016
  # (QUEUE).
11933
13017
  # @return [String]
@@ -12027,8 +13111,8 @@ module Aws::Connect
12027
13111
  # @return [String]
12028
13112
  #
12029
13113
  # @!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
13114
+ # The type of quick connect. In the Amazon Connect admin website, when
13115
+ # you create a quick connect, you are prompted to assign one of the
12032
13116
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
12033
13117
  # (QUEUE).
12034
13118
  # @return [String]
@@ -12069,6 +13153,418 @@ module Aws::Connect
12069
13153
  include Aws::Structure
12070
13154
  end
12071
13155
 
13156
+ # Object that describes attached file.
13157
+ #
13158
+ # @!attribute [rw] attachment_name
13159
+ # A case-sensitive name of the attachment being uploaded. Can be
13160
+ # redacted.
13161
+ # @return [String]
13162
+ #
13163
+ # @!attribute [rw] content_type
13164
+ # Describes the MIME file type of the attachment. For a list of
13165
+ # supported file types, see [Feature specifications][1] in the *Amazon
13166
+ # Connect Administrator Guide*.
13167
+ #
13168
+ #
13169
+ #
13170
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html
13171
+ # @return [String]
13172
+ #
13173
+ # @!attribute [rw] attachment_id
13174
+ # A unique identifier for the attachment.
13175
+ # @return [String]
13176
+ #
13177
+ # @!attribute [rw] status
13178
+ # Status of the attachment.
13179
+ # @return [String]
13180
+ #
13181
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisAttachment AWS API Documentation
13182
+ #
13183
+ class RealTimeContactAnalysisAttachment < Struct.new(
13184
+ :attachment_name,
13185
+ :content_type,
13186
+ :attachment_id,
13187
+ :status)
13188
+ SENSITIVE = []
13189
+ include Aws::Structure
13190
+ end
13191
+
13192
+ # Provides information about the category rule that was matched.
13193
+ #
13194
+ # @!attribute [rw] points_of_interest
13195
+ # List of PointOfInterest - objects describing a single match of a
13196
+ # rule.
13197
+ # @return [Array<Types::RealTimeContactAnalysisPointOfInterest>]
13198
+ #
13199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisCategoryDetails AWS API Documentation
13200
+ #
13201
+ class RealTimeContactAnalysisCategoryDetails < Struct.new(
13202
+ :points_of_interest)
13203
+ SENSITIVE = []
13204
+ include Aws::Structure
13205
+ end
13206
+
13207
+ # Begin and end offsets for a part of text.
13208
+ #
13209
+ # @!attribute [rw] begin_offset_char
13210
+ # The beginning of the character interval.
13211
+ # @return [Integer]
13212
+ #
13213
+ # @!attribute [rw] end_offset_char
13214
+ # The end of the character interval.
13215
+ # @return [Integer]
13216
+ #
13217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisCharacterInterval AWS API Documentation
13218
+ #
13219
+ class RealTimeContactAnalysisCharacterInterval < Struct.new(
13220
+ :begin_offset_char,
13221
+ :end_offset_char)
13222
+ SENSITIVE = []
13223
+ include Aws::Structure
13224
+ end
13225
+
13226
+ # Potential issues that are detected based on an artificial intelligence
13227
+ # analysis of each turn in the conversation.
13228
+ #
13229
+ # @!attribute [rw] transcript_items
13230
+ # List of the transcript items (segments) that are associated with a
13231
+ # given issue.
13232
+ # @return [Array<Types::RealTimeContactAnalysisTranscriptItemWithContent>]
13233
+ #
13234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisIssueDetected AWS API Documentation
13235
+ #
13236
+ class RealTimeContactAnalysisIssueDetected < Struct.new(
13237
+ :transcript_items)
13238
+ SENSITIVE = []
13239
+ include Aws::Structure
13240
+ end
13241
+
13242
+ # The section of the contact transcript segment that category rule was
13243
+ # detected.
13244
+ #
13245
+ # @!attribute [rw] transcript_items
13246
+ # List of the transcript items (segments) that are associated with a
13247
+ # given point of interest.
13248
+ # @return [Array<Types::RealTimeContactAnalysisTranscriptItemWithCharacterOffsets>]
13249
+ #
13250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisPointOfInterest AWS API Documentation
13251
+ #
13252
+ class RealTimeContactAnalysisPointOfInterest < Struct.new(
13253
+ :transcript_items)
13254
+ SENSITIVE = []
13255
+ include Aws::Structure
13256
+ end
13257
+
13258
+ # Segment containing list of attachments.
13259
+ #
13260
+ # @!attribute [rw] id
13261
+ # The identifier of the segment.
13262
+ # @return [String]
13263
+ #
13264
+ # @!attribute [rw] participant_id
13265
+ # The identifier of the participant.
13266
+ # @return [String]
13267
+ #
13268
+ # @!attribute [rw] participant_role
13269
+ # The role of the participant. For example, is it a customer, agent,
13270
+ # or system.
13271
+ # @return [String]
13272
+ #
13273
+ # @!attribute [rw] display_name
13274
+ # The display name of the participant. Can be redacted.
13275
+ # @return [String]
13276
+ #
13277
+ # @!attribute [rw] attachments
13278
+ # List of objects describing an individual attachment.
13279
+ # @return [Array<Types::RealTimeContactAnalysisAttachment>]
13280
+ #
13281
+ # @!attribute [rw] time
13282
+ # Field describing the time of the event. It can have different
13283
+ # representations of time.
13284
+ # @return [Types::RealTimeContactAnalysisTimeData]
13285
+ #
13286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentAttachments AWS API Documentation
13287
+ #
13288
+ class RealTimeContactAnalysisSegmentAttachments < Struct.new(
13289
+ :id,
13290
+ :participant_id,
13291
+ :participant_role,
13292
+ :display_name,
13293
+ :attachments,
13294
+ :time)
13295
+ SENSITIVE = []
13296
+ include Aws::Structure
13297
+ end
13298
+
13299
+ # The matched category rules.
13300
+ #
13301
+ # @!attribute [rw] matched_details
13302
+ # Map between the name of the matched rule and
13303
+ # RealTimeContactAnalysisCategoryDetails.
13304
+ # @return [Hash<String,Types::RealTimeContactAnalysisCategoryDetails>]
13305
+ #
13306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentCategories AWS API Documentation
13307
+ #
13308
+ class RealTimeContactAnalysisSegmentCategories < Struct.new(
13309
+ :matched_details)
13310
+ SENSITIVE = []
13311
+ include Aws::Structure
13312
+ end
13313
+
13314
+ # Segment type describing a contact event.
13315
+ #
13316
+ # @!attribute [rw] id
13317
+ # The identifier of the contact event.
13318
+ # @return [String]
13319
+ #
13320
+ # @!attribute [rw] participant_id
13321
+ # The identifier of the participant.
13322
+ # @return [String]
13323
+ #
13324
+ # @!attribute [rw] participant_role
13325
+ # The role of the participant. For example, is it a customer, agent,
13326
+ # or system.
13327
+ # @return [String]
13328
+ #
13329
+ # @!attribute [rw] display_name
13330
+ # The display name of the participant. Can be redacted.
13331
+ # @return [String]
13332
+ #
13333
+ # @!attribute [rw] event_type
13334
+ # Type of the event. For example,
13335
+ # `application/vnd.amazonaws.connect.event.participant.left`.
13336
+ # @return [String]
13337
+ #
13338
+ # @!attribute [rw] time
13339
+ # Field describing the time of the event. It can have different
13340
+ # representations of time.
13341
+ # @return [Types::RealTimeContactAnalysisTimeData]
13342
+ #
13343
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentEvent AWS API Documentation
13344
+ #
13345
+ class RealTimeContactAnalysisSegmentEvent < Struct.new(
13346
+ :id,
13347
+ :participant_id,
13348
+ :participant_role,
13349
+ :display_name,
13350
+ :event_type,
13351
+ :time)
13352
+ SENSITIVE = []
13353
+ include Aws::Structure
13354
+ end
13355
+
13356
+ # Segment type containing a list of detected issues.
13357
+ #
13358
+ # @!attribute [rw] issues_detected
13359
+ # List of the issues detected.
13360
+ # @return [Array<Types::RealTimeContactAnalysisIssueDetected>]
13361
+ #
13362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentIssues AWS API Documentation
13363
+ #
13364
+ class RealTimeContactAnalysisSegmentIssues < Struct.new(
13365
+ :issues_detected)
13366
+ SENSITIVE = []
13367
+ include Aws::Structure
13368
+ end
13369
+
13370
+ # The analyzed transcript segment.
13371
+ #
13372
+ # @!attribute [rw] id
13373
+ # The identifier of the transcript.
13374
+ # @return [String]
13375
+ #
13376
+ # @!attribute [rw] participant_id
13377
+ # The identifier of the participant.
13378
+ # @return [String]
13379
+ #
13380
+ # @!attribute [rw] participant_role
13381
+ # The role of the participant. For example, is it a customer, agent,
13382
+ # or system.
13383
+ # @return [String]
13384
+ #
13385
+ # @!attribute [rw] display_name
13386
+ # The display name of the participant.
13387
+ # @return [String]
13388
+ #
13389
+ # @!attribute [rw] content
13390
+ # The content of the transcript. Can be redacted.
13391
+ # @return [String]
13392
+ #
13393
+ # @!attribute [rw] content_type
13394
+ # The type of content of the item. For example, `text/plain`.
13395
+ # @return [String]
13396
+ #
13397
+ # @!attribute [rw] time
13398
+ # Field describing the time of the event. It can have different
13399
+ # representations of time.
13400
+ # @return [Types::RealTimeContactAnalysisTimeData]
13401
+ #
13402
+ # @!attribute [rw] redaction
13403
+ # Object describing redaction that was applied to the transcript. If
13404
+ # transcript has the field it means part of the transcript was
13405
+ # redacted.
13406
+ # @return [Types::RealTimeContactAnalysisTranscriptItemRedaction]
13407
+ #
13408
+ # @!attribute [rw] sentiment
13409
+ # The sentiment detected for this piece of transcript.
13410
+ # @return [String]
13411
+ #
13412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisSegmentTranscript AWS API Documentation
13413
+ #
13414
+ class RealTimeContactAnalysisSegmentTranscript < Struct.new(
13415
+ :id,
13416
+ :participant_id,
13417
+ :participant_role,
13418
+ :display_name,
13419
+ :content,
13420
+ :content_type,
13421
+ :time,
13422
+ :redaction,
13423
+ :sentiment)
13424
+ SENSITIVE = []
13425
+ include Aws::Structure
13426
+ end
13427
+
13428
+ # Object describing time with which the segment is associated. It can
13429
+ # have different representations of time. Currently supported:
13430
+ # absoluteTime
13431
+ #
13432
+ # @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.
13433
+ #
13434
+ # @!attribute [rw] absolute_time
13435
+ # Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For
13436
+ # example, 2019-11-08T02:41:28.172Z.
13437
+ # @return [Time]
13438
+ #
13439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTimeData AWS API Documentation
13440
+ #
13441
+ class RealTimeContactAnalysisTimeData < Struct.new(
13442
+ :absolute_time,
13443
+ :unknown)
13444
+ SENSITIVE = []
13445
+ include Aws::Structure
13446
+ include Aws::Structure::Union
13447
+
13448
+ class AbsoluteTime < RealTimeContactAnalysisTimeData; end
13449
+ class Unknown < RealTimeContactAnalysisTimeData; end
13450
+ end
13451
+
13452
+ # Object describing redaction applied to the segment.
13453
+ #
13454
+ # @!attribute [rw] character_offsets
13455
+ # List of character intervals each describing a part of the text that
13456
+ # was redacted. For `OutputType.Raw`, part of the original text that
13457
+ # contains data that can be redacted. For ` OutputType.Redacted`, part
13458
+ # of the string with redaction tag.
13459
+ # @return [Array<Types::RealTimeContactAnalysisCharacterInterval>]
13460
+ #
13461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemRedaction AWS API Documentation
13462
+ #
13463
+ class RealTimeContactAnalysisTranscriptItemRedaction < Struct.new(
13464
+ :character_offsets)
13465
+ SENSITIVE = []
13466
+ include Aws::Structure
13467
+ end
13468
+
13469
+ # Transcript representation containing Id and list of character
13470
+ # intervals that are associated with analysis data. For example, this
13471
+ # object within a `RealTimeContactAnalysisPointOfInterest` in
13472
+ # `Category.MatchedDetails` would have character interval describing
13473
+ # part of the text that matched category.
13474
+ #
13475
+ # @!attribute [rw] id
13476
+ # Transcript identifier. Matches the identifier from one of the
13477
+ # TranscriptSegments.
13478
+ # @return [String]
13479
+ #
13480
+ # @!attribute [rw] character_offsets
13481
+ # List of character intervals within transcript content/text.
13482
+ # @return [Types::RealTimeContactAnalysisCharacterInterval]
13483
+ #
13484
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemWithCharacterOffsets AWS API Documentation
13485
+ #
13486
+ class RealTimeContactAnalysisTranscriptItemWithCharacterOffsets < Struct.new(
13487
+ :id,
13488
+ :character_offsets)
13489
+ SENSITIVE = []
13490
+ include Aws::Structure
13491
+ end
13492
+
13493
+ # Transcript representation containing Id, Content and list of character
13494
+ # intervals that are associated with analysis data. For example, this
13495
+ # object within an issue detected would describe both content that
13496
+ # contains identified issue and intervals where that content is taken
13497
+ # from.
13498
+ #
13499
+ # @!attribute [rw] content
13500
+ # Part of the transcript content that contains identified issue. Can
13501
+ # be redacted
13502
+ # @return [String]
13503
+ #
13504
+ # @!attribute [rw] id
13505
+ # Transcript identifier. Matches the identifier from one of the
13506
+ # TranscriptSegments.
13507
+ # @return [String]
13508
+ #
13509
+ # @!attribute [rw] character_offsets
13510
+ # Begin and end offsets for a part of text.
13511
+ # @return [Types::RealTimeContactAnalysisCharacterInterval]
13512
+ #
13513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealTimeContactAnalysisTranscriptItemWithContent AWS API Documentation
13514
+ #
13515
+ class RealTimeContactAnalysisTranscriptItemWithContent < Struct.new(
13516
+ :content,
13517
+ :id,
13518
+ :character_offsets)
13519
+ SENSITIVE = []
13520
+ include Aws::Structure
13521
+ end
13522
+
13523
+ # An analyzed segment for a real-time analysis session.
13524
+ #
13525
+ # @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.
13526
+ #
13527
+ # @!attribute [rw] transcript
13528
+ # The analyzed transcript segment.
13529
+ # @return [Types::RealTimeContactAnalysisSegmentTranscript]
13530
+ #
13531
+ # @!attribute [rw] categories
13532
+ # The matched category rules.
13533
+ # @return [Types::RealTimeContactAnalysisSegmentCategories]
13534
+ #
13535
+ # @!attribute [rw] issues
13536
+ # Segment type containing a list of detected issues.
13537
+ # @return [Types::RealTimeContactAnalysisSegmentIssues]
13538
+ #
13539
+ # @!attribute [rw] event
13540
+ # Segment type describing a contact event.
13541
+ # @return [Types::RealTimeContactAnalysisSegmentEvent]
13542
+ #
13543
+ # @!attribute [rw] attachments
13544
+ # The analyzed attachments.
13545
+ # @return [Types::RealTimeContactAnalysisSegmentAttachments]
13546
+ #
13547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/RealtimeContactAnalysisSegment AWS API Documentation
13548
+ #
13549
+ class RealtimeContactAnalysisSegment < Struct.new(
13550
+ :transcript,
13551
+ :categories,
13552
+ :issues,
13553
+ :event,
13554
+ :attachments,
13555
+ :unknown)
13556
+ SENSITIVE = []
13557
+ include Aws::Structure
13558
+ include Aws::Structure::Union
13559
+
13560
+ class Transcript < RealtimeContactAnalysisSegment; end
13561
+ class Categories < RealtimeContactAnalysisSegment; end
13562
+ class Issues < RealtimeContactAnalysisSegment; end
13563
+ class Event < RealtimeContactAnalysisSegment; end
13564
+ class Attachments < RealtimeContactAnalysisSegment; end
13565
+ class Unknown < RealtimeContactAnalysisSegment; end
13566
+ end
13567
+
12072
13568
  # Well-formed data on a contact, used by agents to complete a contact
12073
13569
  # request. You can have up to 4,096 UTF-8 bytes across all references
12074
13570
  # for a contact.
@@ -12763,7 +14259,8 @@ module Aws::Connect
12763
14259
  #
12764
14260
  # Supported only for `TriggerEventSource` values:
12765
14261
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12766
- # \| `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
14262
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14263
+ # `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
12767
14264
  # `OnMetricDataUpdate`
12768
14265
  # @return [Types::EventBridgeActionDefinition]
12769
14266
  #
@@ -12772,7 +14269,8 @@ module Aws::Connect
12772
14269
  #
12773
14270
  # Supported only for `TriggerEventSource` values:
12774
14271
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12775
- # \| `OnPostChatAnalysisAvailable` \| `OnZendeskTicketCreate` \|
14272
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14273
+ # `OnPostChatAnalysisAvailable` \| `OnZendeskTicketCreate` \|
12776
14274
  # `OnZendeskTicketStatusUpdate` \| `OnSalesforceCaseCreate`
12777
14275
  # @return [Types::AssignContactCategoryActionDefinition]
12778
14276
  #
@@ -12781,7 +14279,8 @@ module Aws::Connect
12781
14279
  #
12782
14280
  # Supported only for `TriggerEventSource` values:
12783
14281
  # `OnPostCallAnalysisAvailable` \| `OnRealTimeCallAnalysisAvailable`
12784
- # \| `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
14282
+ # \| `OnRealTimeChatAnalysisAvailable` \|
14283
+ # `OnPostChatAnalysisAvailable` \| `OnContactEvaluationSubmit` \|
12785
14284
  # `OnMetricDataUpdate`
12786
14285
  # @return [Types::SendNotificationActionDefinition]
12787
14286
  #
@@ -13798,6 +15297,68 @@ module Aws::Connect
13798
15297
  include Aws::Structure
13799
15298
  end
13800
15299
 
15300
+ # @!attribute [rw] source_id
15301
+ # External identifier of chat customer participant, used in part to
15302
+ # uniquely identify a chat. For SMS, this is the E164 phone number of
15303
+ # the chat customer participant.
15304
+ # @return [String]
15305
+ #
15306
+ # @!attribute [rw] destination_id
15307
+ # Chat system identifier, used in part to uniquely identify chat. This
15308
+ # is associated with the Amazon Connect instance and flow to be used
15309
+ # to start chats. For SMS, this is the phone number destination of
15310
+ # inbound SMS messages represented by an Amazon Pinpoint phone number
15311
+ # ARN.
15312
+ # @return [String]
15313
+ #
15314
+ # @!attribute [rw] subtype
15315
+ # Classification of a channel. This is used in part to uniquely
15316
+ # identify chat.
15317
+ #
15318
+ # Valid value: `["connect:sms"]`
15319
+ # @return [String]
15320
+ #
15321
+ # @!attribute [rw] event
15322
+ # Chat integration event payload
15323
+ # @return [Types::ChatEvent]
15324
+ #
15325
+ # @!attribute [rw] new_session_details
15326
+ # Contact properties to apply when starting a new chat. If the
15327
+ # integration event is handled with an existing chat, this is ignored.
15328
+ # @return [Types::NewSessionDetails]
15329
+ #
15330
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEventRequest AWS API Documentation
15331
+ #
15332
+ class SendChatIntegrationEventRequest < Struct.new(
15333
+ :source_id,
15334
+ :destination_id,
15335
+ :subtype,
15336
+ :event,
15337
+ :new_session_details)
15338
+ SENSITIVE = []
15339
+ include Aws::Structure
15340
+ end
15341
+
15342
+ # @!attribute [rw] initial_contact_id
15343
+ # Identifier of chat contact used to handle integration event. This
15344
+ # may be null if the integration event is not valid without an already
15345
+ # existing chat contact.
15346
+ # @return [String]
15347
+ #
15348
+ # @!attribute [rw] new_chat_created
15349
+ # Whether handling the integration event resulted in creating a new
15350
+ # chat or acting on existing chat.
15351
+ # @return [Boolean]
15352
+ #
15353
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEventResponse AWS API Documentation
15354
+ #
15355
+ class SendChatIntegrationEventResponse < Struct.new(
15356
+ :initial_contact_id,
15357
+ :new_chat_created)
15358
+ SENSITIVE = []
15359
+ include Aws::Structure
15360
+ end
15361
+
13801
15362
  # Information about the send notification action.
13802
15363
  #
13803
15364
  # @!attribute [rw] delivery_method
@@ -13933,11 +15494,11 @@ module Aws::Connect
13933
15494
  #
13934
15495
  # @!attribute [rw] contact_flow_id
13935
15496
  # 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:
15497
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15498
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15499
+ # flow page, under the name of the flow, choose **Show additional flow
15500
+ # information**. The ContactFlowId is the last part of the ARN, shown
15501
+ # here in bold:
13941
15502
  #
13942
15503
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
13943
15504
  # @return [String]
@@ -14254,11 +15815,11 @@ module Aws::Connect
14254
15815
  #
14255
15816
  # @!attribute [rw] contact_flow_id
14256
15817
  # 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:
15818
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15819
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15820
+ # flow page, under the name of the flow, choose **Show additional flow
15821
+ # information**. The ContactFlowId is the last part of the ARN, shown
15822
+ # here in bold:
14262
15823
  #
14263
15824
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
14264
15825
  # @return [String]
@@ -14374,11 +15935,11 @@ module Aws::Connect
14374
15935
  #
14375
15936
  # @!attribute [rw] contact_flow_id
14376
15937
  # 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:
15938
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
15939
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
15940
+ # flow page, under the name of the flow, choose **Show additional flow
15941
+ # information**. The ContactFlowId is the last part of the ARN, shown
15942
+ # here in bold:
14382
15943
  #
14383
15944
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
14384
15945
  # @return [String]
@@ -14497,6 +16058,131 @@ module Aws::Connect
14497
16058
  include Aws::Structure
14498
16059
  end
14499
16060
 
16061
+ # @!attribute [rw] attributes
16062
+ # A custom key-value pair using an attribute map. The attributes are
16063
+ # standard Amazon Connect attributes, and can be accessed in flows
16064
+ # just like any other contact attributes.
16065
+ #
16066
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
16067
+ # contact. Attribute keys can include only alphanumeric, -, and \_
16068
+ # characters.
16069
+ # @return [Hash<String,String>]
16070
+ #
16071
+ # @!attribute [rw] client_token
16072
+ # A unique, case-sensitive identifier that you provide to ensure the
16073
+ # idempotency of the request. If not provided, the Amazon Web Services
16074
+ # SDK populates this field. For more information about idempotency,
16075
+ # see [Making retries safe with idempotent APIs][1].
16076
+ #
16077
+ # The token is valid for 7 days after creation. If a contact is
16078
+ # already started, the contact ID is returned.
16079
+ #
16080
+ # **A suitable default value is auto-generated.** You should normally
16081
+ # not need to pass this option.
16082
+ #
16083
+ #
16084
+ #
16085
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
16086
+ # @return [String]
16087
+ #
16088
+ # @!attribute [rw] contact_flow_id
16089
+ # The identifier of the flow for the call. To see the ContactFlowId in
16090
+ # the Amazon Connect admin website, on the navigation menu go to
16091
+ # **Routing**, **Contact Flows**. Choose the flow. On the flow page,
16092
+ # under the name of the flow, choose **Show additional flow
16093
+ # information**. The ContactFlowId is the last part of the ARN, shown
16094
+ # here in bold:
16095
+ #
16096
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
16097
+ # @return [String]
16098
+ #
16099
+ # @!attribute [rw] instance_id
16100
+ # The identifier of the Amazon Connect instance. You can [find the
16101
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
16102
+ #
16103
+ #
16104
+ #
16105
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
16106
+ # @return [String]
16107
+ #
16108
+ # @!attribute [rw] allowed_capabilities
16109
+ # Information about the video sharing capabilities of the participants
16110
+ # (customer, agent).
16111
+ # @return [Types::AllowedCapabilities]
16112
+ #
16113
+ # @!attribute [rw] participant_details
16114
+ # The customer's details.
16115
+ # @return [Types::ParticipantDetails]
16116
+ #
16117
+ # @!attribute [rw] related_contact_id
16118
+ # The unique identifier for an Amazon Connect contact. This identifier
16119
+ # is related to the contact starting.
16120
+ # @return [String]
16121
+ #
16122
+ # @!attribute [rw] references
16123
+ # A formatted URL that is shown to an agent in the Contact Control
16124
+ # Panel (CCP). Tasks can have the following reference types at the
16125
+ # time of creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \|
16126
+ # `EMAIL`. `ATTACHMENT` is not a supported reference type during task
16127
+ # creation.
16128
+ # @return [Hash<String,Types::Reference>]
16129
+ #
16130
+ # @!attribute [rw] description
16131
+ # A description of the task that is shown to an agent in the Contact
16132
+ # Control Panel (CCP).
16133
+ # @return [String]
16134
+ #
16135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContactRequest AWS API Documentation
16136
+ #
16137
+ class StartWebRTCContactRequest < Struct.new(
16138
+ :attributes,
16139
+ :client_token,
16140
+ :contact_flow_id,
16141
+ :instance_id,
16142
+ :allowed_capabilities,
16143
+ :participant_details,
16144
+ :related_contact_id,
16145
+ :references,
16146
+ :description)
16147
+ SENSITIVE = []
16148
+ include Aws::Structure
16149
+ end
16150
+
16151
+ # @!attribute [rw] connection_data
16152
+ # Information required for the client application (mobile application
16153
+ # or website) to connect to the call.
16154
+ # @return [Types::ConnectionData]
16155
+ #
16156
+ # @!attribute [rw] contact_id
16157
+ # The identifier of the contact in this instance of Amazon Connect.
16158
+ # @return [String]
16159
+ #
16160
+ # @!attribute [rw] participant_id
16161
+ # The identifier for a contact participant. The `ParticipantId` for a
16162
+ # contact participant is the same throughout the contact lifecycle.
16163
+ # @return [String]
16164
+ #
16165
+ # @!attribute [rw] participant_token
16166
+ # The token used by the contact participant to call the
16167
+ # [CreateParticipantConnection][1] API. The participant token is valid
16168
+ # for the lifetime of a contact participant.
16169
+ #
16170
+ #
16171
+ #
16172
+ # [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
16173
+ # @return [String]
16174
+ #
16175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContactResponse AWS API Documentation
16176
+ #
16177
+ class StartWebRTCContactResponse < Struct.new(
16178
+ :connection_data,
16179
+ :contact_id,
16180
+ :participant_id,
16181
+ :participant_token)
16182
+ SENSITIVE = []
16183
+ include Aws::Structure
16184
+ end
16185
+
14500
16186
  # @!attribute [rw] instance_id
14501
16187
  # The identifier of the Amazon Connect instance. You can [find the
14502
16188
  # instance ID][1] in the Amazon Resource Name (ARN) of the instance.