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.
@@ -437,6 +437,61 @@ module Aws::Connect
437
437
  req.send_request(options)
438
438
  end
439
439
 
440
+ # This API is in preview release for Amazon Connect and is subject to
441
+ # change.
442
+ #
443
+ # Associates the specified dataset for a Amazon Connect instance with
444
+ # the target account. You can associate only one dataset in a single
445
+ # call.
446
+ #
447
+ # @option params [required, String] :instance_id
448
+ # The identifier of the Amazon Connect instance. You can [find the
449
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
450
+ #
451
+ #
452
+ #
453
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
454
+ #
455
+ # @option params [required, String] :data_set_id
456
+ # The identifier of the dataset to associate with the target account.
457
+ #
458
+ # @option params [String] :target_account_id
459
+ # The identifier of the target account. Use to associate a dataset to a
460
+ # different account than the one containing the Amazon Connect instance.
461
+ # If not specified, by default this value is the Amazon Web Services
462
+ # account that has the Amazon Connect instance.
463
+ #
464
+ # @return [Types::AssociateAnalyticsDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
465
+ #
466
+ # * {Types::AssociateAnalyticsDataSetResponse#data_set_id #data_set_id} => String
467
+ # * {Types::AssociateAnalyticsDataSetResponse#target_account_id #target_account_id} => String
468
+ # * {Types::AssociateAnalyticsDataSetResponse#resource_share_id #resource_share_id} => String
469
+ # * {Types::AssociateAnalyticsDataSetResponse#resource_share_arn #resource_share_arn} => String
470
+ #
471
+ # @example Request syntax with placeholder values
472
+ #
473
+ # resp = client.associate_analytics_data_set({
474
+ # instance_id: "InstanceId", # required
475
+ # data_set_id: "DataSetId", # required
476
+ # target_account_id: "AWSAccountId",
477
+ # })
478
+ #
479
+ # @example Response structure
480
+ #
481
+ # resp.data_set_id #=> String
482
+ # resp.target_account_id #=> String
483
+ # resp.resource_share_id #=> String
484
+ # resp.resource_share_arn #=> String
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateAnalyticsDataSet AWS API Documentation
487
+ #
488
+ # @overload associate_analytics_data_set(params = {})
489
+ # @param [Hash] params ({})
490
+ def associate_analytics_data_set(params = {}, options = {})
491
+ req = build_request(:associate_analytics_data_set, params)
492
+ req.send_request(options)
493
+ end
494
+
440
495
  # This API is in preview release for Amazon Connect and is subject to
441
496
  # change.
442
497
  #
@@ -559,6 +614,45 @@ module Aws::Connect
559
614
  req.send_request(options)
560
615
  end
561
616
 
617
+ # Associates a connect resource to a flow.
618
+ #
619
+ # @option params [required, String] :instance_id
620
+ # The identifier of the Amazon Connect instance. You can [find the
621
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
622
+ #
623
+ #
624
+ #
625
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
626
+ #
627
+ # @option params [required, String] :resource_id
628
+ # The identifier of the resource.
629
+ #
630
+ # @option params [required, String] :flow_id
631
+ # The identifier of the flow.
632
+ #
633
+ # @option params [required, String] :resource_type
634
+ # A valid resource type.
635
+ #
636
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
637
+ #
638
+ # @example Request syntax with placeholder values
639
+ #
640
+ # resp = client.associate_flow({
641
+ # instance_id: "InstanceId", # required
642
+ # resource_id: "ARN", # required
643
+ # flow_id: "ARN", # required
644
+ # resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
645
+ # })
646
+ #
647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateFlow AWS API Documentation
648
+ #
649
+ # @overload associate_flow(params = {})
650
+ # @param [Hash] params ({})
651
+ def associate_flow(params = {}, options = {})
652
+ req = build_request(:associate_flow, params)
653
+ req.send_request(options)
654
+ end
655
+
562
656
  # This API is in preview release for Amazon Connect and is subject to
563
657
  # change.
564
658
  #
@@ -919,6 +1013,117 @@ module Aws::Connect
919
1013
  req.send_request(options)
920
1014
  end
921
1015
 
1016
+ # This API is in preview release for Amazon Connect and is subject to
1017
+ # change.
1018
+ #
1019
+ # Associates a list of analytics datasets for a given Amazon Connect
1020
+ # instance to a target account. You can associate multiple datasets in a
1021
+ # single call.
1022
+ #
1023
+ # @option params [required, String] :instance_id
1024
+ # The identifier of the Amazon Connect instance. You can [find the
1025
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
1026
+ #
1027
+ #
1028
+ #
1029
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
1030
+ #
1031
+ # @option params [required, Array<String>] :data_set_ids
1032
+ # An array of dataset identifiers to associate.
1033
+ #
1034
+ # @option params [String] :target_account_id
1035
+ # The identifier of the target account. Use to associate a dataset to a
1036
+ # different account than the one containing the Amazon Connect instance.
1037
+ # If not specified, by default this value is the Amazon Web Services
1038
+ # account that has the Amazon Connect instance.
1039
+ #
1040
+ # @return [Types::BatchAssociateAnalyticsDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1041
+ #
1042
+ # * {Types::BatchAssociateAnalyticsDataSetResponse#created #created} => Array&lt;Types::AnalyticsDataAssociationResult&gt;
1043
+ # * {Types::BatchAssociateAnalyticsDataSetResponse#errors #errors} => Array&lt;Types::ErrorResult&gt;
1044
+ #
1045
+ # @example Request syntax with placeholder values
1046
+ #
1047
+ # resp = client.batch_associate_analytics_data_set({
1048
+ # instance_id: "InstanceId", # required
1049
+ # data_set_ids: ["DataSetId"], # required
1050
+ # target_account_id: "AWSAccountId",
1051
+ # })
1052
+ #
1053
+ # @example Response structure
1054
+ #
1055
+ # resp.created #=> Array
1056
+ # resp.created[0].data_set_id #=> String
1057
+ # resp.created[0].target_account_id #=> String
1058
+ # resp.created[0].resource_share_id #=> String
1059
+ # resp.created[0].resource_share_arn #=> String
1060
+ # resp.errors #=> Array
1061
+ # resp.errors[0].error_code #=> String
1062
+ # resp.errors[0].error_message #=> String
1063
+ #
1064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchAssociateAnalyticsDataSet AWS API Documentation
1065
+ #
1066
+ # @overload batch_associate_analytics_data_set(params = {})
1067
+ # @param [Hash] params ({})
1068
+ def batch_associate_analytics_data_set(params = {}, options = {})
1069
+ req = build_request(:batch_associate_analytics_data_set, params)
1070
+ req.send_request(options)
1071
+ end
1072
+
1073
+ # This API is in preview release for Amazon Connect and is subject to
1074
+ # change.
1075
+ #
1076
+ # Removes a list of analytics datasets associated with a given Amazon
1077
+ # Connect instance. You can disassociate multiple datasets in a single
1078
+ # call.
1079
+ #
1080
+ # @option params [required, String] :instance_id
1081
+ # The identifier of the Amazon Connect instance. You can [find the
1082
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
1083
+ #
1084
+ #
1085
+ #
1086
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
1087
+ #
1088
+ # @option params [required, Array<String>] :data_set_ids
1089
+ # An array of associated dataset identifiers to remove.
1090
+ #
1091
+ # @option params [String] :target_account_id
1092
+ # The identifier of the target account. Use to disassociate a dataset
1093
+ # from a different account than the one containing the Amazon Connect
1094
+ # instance. If not specified, by default this value is the Amazon Web
1095
+ # Services account that has the Amazon Connect instance.
1096
+ #
1097
+ # @return [Types::BatchDisassociateAnalyticsDataSetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1098
+ #
1099
+ # * {Types::BatchDisassociateAnalyticsDataSetResponse#deleted #deleted} => Array&lt;String&gt;
1100
+ # * {Types::BatchDisassociateAnalyticsDataSetResponse#errors #errors} => Array&lt;Types::ErrorResult&gt;
1101
+ #
1102
+ # @example Request syntax with placeholder values
1103
+ #
1104
+ # resp = client.batch_disassociate_analytics_data_set({
1105
+ # instance_id: "InstanceId", # required
1106
+ # data_set_ids: ["DataSetId"], # required
1107
+ # target_account_id: "AWSAccountId",
1108
+ # })
1109
+ #
1110
+ # @example Response structure
1111
+ #
1112
+ # resp.deleted #=> Array
1113
+ # resp.deleted[0] #=> String
1114
+ # resp.errors #=> Array
1115
+ # resp.errors[0].error_code #=> String
1116
+ # resp.errors[0].error_message #=> String
1117
+ #
1118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BatchDisassociateAnalyticsDataSet AWS API Documentation
1119
+ #
1120
+ # @overload batch_disassociate_analytics_data_set(params = {})
1121
+ # @param [Hash] params ({})
1122
+ def batch_disassociate_analytics_data_set(params = {}, options = {})
1123
+ req = build_request(:batch_disassociate_analytics_data_set, params)
1124
+ req.send_request(options)
1125
+ end
1126
+
922
1127
  # Retrieve the flow associations for the given resources.
923
1128
  #
924
1129
  # @option params [required, String] :instance_id
@@ -2312,7 +2517,7 @@ module Aws::Connect
2312
2517
  # instance_id: "InstanceId", # required
2313
2518
  # name: "RuleName", # required
2314
2519
  # trigger_event_source: { # required
2315
- # event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
2520
+ # event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
2316
2521
  # integration_association_id: "IntegrationAssociationId",
2317
2522
  # },
2318
2523
  # function: "RuleFunction", # required
@@ -2714,9 +2919,9 @@ module Aws::Connect
2714
2919
  # identity management. `FirstName` and `LastName` are required if you
2715
2920
  # are using Amazon Connect or SAML for identity management.
2716
2921
  #
2717
- # For information about how to create user accounts using the Amazon
2718
- # Connect console, see [Add Users][2] in the *Amazon Connect
2719
- # Administrator Guide*.
2922
+ # For information about how to create users using the Amazon Connect
2923
+ # admin website, see [Add Users][2] in the *Amazon Connect Administrator
2924
+ # Guide*.
2720
2925
  #
2721
2926
  #
2722
2927
  #
@@ -4495,7 +4700,7 @@ module Aws::Connect
4495
4700
  # resp.claimed_phone_number_summary.phone_number_arn #=> String
4496
4701
  # resp.claimed_phone_number_summary.phone_number #=> String
4497
4702
  # resp.claimed_phone_number_summary.phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
4498
- # resp.claimed_phone_number_summary.phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID"
4703
+ # resp.claimed_phone_number_summary.phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
4499
4704
  # resp.claimed_phone_number_summary.phone_number_description #=> String
4500
4705
  # resp.claimed_phone_number_summary.target_arn #=> String
4501
4706
  # resp.claimed_phone_number_summary.instance_id #=> String
@@ -4503,6 +4708,7 @@ module Aws::Connect
4503
4708
  # resp.claimed_phone_number_summary.tags["TagKey"] #=> String
4504
4709
  # resp.claimed_phone_number_summary.phone_number_status.status #=> String, one of "CLAIMED", "IN_PROGRESS", "FAILED"
4505
4710
  # resp.claimed_phone_number_summary.phone_number_status.message #=> String
4711
+ # resp.claimed_phone_number_summary.source_phone_number_arn #=> String
4506
4712
  #
4507
4713
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumber AWS API Documentation
4508
4714
  #
@@ -4743,7 +4949,7 @@ module Aws::Connect
4743
4949
  # resp.rule.name #=> String
4744
4950
  # resp.rule.rule_id #=> String
4745
4951
  # resp.rule.rule_arn #=> String
4746
- # resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
4952
+ # resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
4747
4953
  # resp.rule.trigger_event_source.integration_association_id #=> String
4748
4954
  # resp.rule.function #=> String
4749
4955
  # resp.rule.actions #=> Array
@@ -4867,8 +5073,8 @@ module Aws::Connect
4867
5073
  req.send_request(options)
4868
5074
  end
4869
5075
 
4870
- # Describes the specified user account. You can [find the instance ID in
4871
- # the Amazon Connect console][1] (it’s the final part of the ARN). The
5076
+ # Describes the specified user. You can [find the instance ID in the
5077
+ # Amazon Connect console][1] (it’s the final part of the ARN). The
4872
5078
  # console does not display the user IDs. Instead, list the users and
4873
5079
  # note the IDs provided in the output.
4874
5080
  #
@@ -5166,6 +5372,48 @@ module Aws::Connect
5166
5372
  req.send_request(options)
5167
5373
  end
5168
5374
 
5375
+ # This API is in preview release for Amazon Connect and is subject to
5376
+ # change.
5377
+ #
5378
+ # Removes the dataset ID associated with a given Amazon Connect
5379
+ # instance.
5380
+ #
5381
+ # @option params [required, String] :instance_id
5382
+ # The identifier of the Amazon Connect instance. You can [find the
5383
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5384
+ #
5385
+ #
5386
+ #
5387
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5388
+ #
5389
+ # @option params [required, String] :data_set_id
5390
+ # The identifier of the dataset to remove.
5391
+ #
5392
+ # @option params [String] :target_account_id
5393
+ # The identifier of the target account. Use to associate a dataset to a
5394
+ # different account than the one containing the Amazon Connect instance.
5395
+ # If not specified, by default this value is the Amazon Web Services
5396
+ # account that has the Amazon Connect instance.
5397
+ #
5398
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5399
+ #
5400
+ # @example Request syntax with placeholder values
5401
+ #
5402
+ # resp = client.disassociate_analytics_data_set({
5403
+ # instance_id: "InstanceId", # required
5404
+ # data_set_id: "DataSetId", # required
5405
+ # target_account_id: "AWSAccountId",
5406
+ # })
5407
+ #
5408
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateAnalyticsDataSet AWS API Documentation
5409
+ #
5410
+ # @overload disassociate_analytics_data_set(params = {})
5411
+ # @param [Hash] params ({})
5412
+ def disassociate_analytics_data_set(params = {}, options = {})
5413
+ req = build_request(:disassociate_analytics_data_set, params)
5414
+ req.send_request(options)
5415
+ end
5416
+
5169
5417
  # This API is in preview release for Amazon Connect and is subject to
5170
5418
  # change.
5171
5419
  #
@@ -5244,6 +5492,41 @@ module Aws::Connect
5244
5492
  req.send_request(options)
5245
5493
  end
5246
5494
 
5495
+ # Disassociates a connect resource from a flow.
5496
+ #
5497
+ # @option params [required, String] :instance_id
5498
+ # The identifier of the Amazon Connect instance. You can [find the
5499
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
5500
+ #
5501
+ #
5502
+ #
5503
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
5504
+ #
5505
+ # @option params [required, String] :resource_id
5506
+ # The identifier of the resource.
5507
+ #
5508
+ # @option params [required, String] :resource_type
5509
+ # A valid resource type.
5510
+ #
5511
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
5512
+ #
5513
+ # @example Request syntax with placeholder values
5514
+ #
5515
+ # resp = client.disassociate_flow({
5516
+ # instance_id: "InstanceId", # required
5517
+ # resource_id: "ARN", # required
5518
+ # resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
5519
+ # })
5520
+ #
5521
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlow AWS API Documentation
5522
+ #
5523
+ # @overload disassociate_flow(params = {})
5524
+ # @param [Hash] params ({})
5525
+ def disassociate_flow(params = {}, options = {})
5526
+ req = build_request(:disassociate_flow, params)
5527
+ req.send_request(options)
5528
+ end
5529
+
5247
5530
  # This API is in preview release for Amazon Connect and is subject to
5248
5531
  # change.
5249
5532
  #
@@ -6048,6 +6331,51 @@ module Aws::Connect
6048
6331
  req.send_request(options)
6049
6332
  end
6050
6333
 
6334
+ # Retrieves the flow associated for a given resource.
6335
+ #
6336
+ # @option params [required, String] :instance_id
6337
+ # The identifier of the Amazon Connect instance. You can [find the
6338
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
6339
+ #
6340
+ #
6341
+ #
6342
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
6343
+ #
6344
+ # @option params [required, String] :resource_id
6345
+ # The identifier of the resource.
6346
+ #
6347
+ # @option params [required, String] :resource_type
6348
+ # A valid resource type.
6349
+ #
6350
+ # @return [Types::GetFlowAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6351
+ #
6352
+ # * {Types::GetFlowAssociationResponse#resource_id #resource_id} => String
6353
+ # * {Types::GetFlowAssociationResponse#flow_id #flow_id} => String
6354
+ # * {Types::GetFlowAssociationResponse#resource_type #resource_type} => String
6355
+ #
6356
+ # @example Request syntax with placeholder values
6357
+ #
6358
+ # resp = client.get_flow_association({
6359
+ # instance_id: "InstanceId", # required
6360
+ # resource_id: "ARN", # required
6361
+ # resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
6362
+ # })
6363
+ #
6364
+ # @example Response structure
6365
+ #
6366
+ # resp.resource_id #=> String
6367
+ # resp.flow_id #=> String
6368
+ # resp.resource_type #=> String, one of "SMS_PHONE_NUMBER"
6369
+ #
6370
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociation AWS API Documentation
6371
+ #
6372
+ # @overload get_flow_association(params = {})
6373
+ # @param [Hash] params ({})
6374
+ def get_flow_association(params = {}, options = {})
6375
+ req = build_request(:get_flow_association, params)
6376
+ req.send_request(options)
6377
+ end
6378
+
6051
6379
  # Gets historical metric data from the specified Amazon Connect
6052
6380
  # instance.
6053
6381
  #
@@ -6457,7 +6785,7 @@ module Aws::Connect
6457
6785
  # `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6458
6786
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6459
6787
  # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
6460
- # `FEATURE`
6788
+ # `FEATURE` \| `contact/segmentAttributes/connect:Subtype`
6461
6789
  #
6462
6790
  # * **Filter values**: A maximum of 100 filter values are supported in a
6463
6791
  # single request. VOICE, CHAT, and TASK are valid `filterValue` for
@@ -6470,6 +6798,10 @@ module Aws::Connect
6470
6798
  # the `FEATURE` filter key. It is available only to contacts analyzed
6471
6799
  # by Contact Lens conversational analytics.
6472
6800
  #
6801
+ # `connect:Chat`, `connect:SMS`, `connect:Telephony`, and
6802
+ # `connect:WebRTC` are valid `filterValue` examples (not exhaustive)
6803
+ # for the `contact/segmentAttributes/connect:Subtype filter` key.
6804
+ #
6473
6805
  #
6474
6806
  #
6475
6807
  # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
@@ -6485,7 +6817,8 @@ module Aws::Connect
6485
6817
  # Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
6486
6818
  # `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
6487
6819
  # `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
6488
- # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`
6820
+ # `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`,
6821
+ # `contact/segmentAttributes/connect:Subtype`
6489
6822
  #
6490
6823
  # @option params [required, Array<Types::MetricV2>] :metrics
6491
6824
  # The metrics to retrieve. Specify the name, groupings, and filters for
@@ -6498,7 +6831,7 @@ module Aws::Connect
6498
6831
  # : Unit: Percent
6499
6832
  #
6500
6833
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6501
- # Agent Hierarchy
6834
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6502
6835
  #
6503
6836
  # AGENT\_ADHERENT\_TIME
6504
6837
  #
@@ -6510,6 +6843,20 @@ module Aws::Connect
6510
6843
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6511
6844
  # Agent Hierarchy
6512
6845
  #
6846
+ # AGENT\_ANSWER\_RATE
6847
+ #
6848
+ # : Unit: Percent
6849
+ #
6850
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6851
+ # Agent Hierarchy
6852
+ #
6853
+ # AGENT\_NON\_ADHERENT\_TIME
6854
+ #
6855
+ # : Unit: Seconds
6856
+ #
6857
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6858
+ # Agent Hierarchy
6859
+ #
6513
6860
  # AGENT\_NON\_RESPONSE
6514
6861
  #
6515
6862
  # : Unit: Count
@@ -6558,14 +6905,16 @@ module Aws::Connect
6558
6905
  # : Unit: Seconds
6559
6906
  #
6560
6907
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6561
- # Agent Hierarchy
6908
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6562
6909
  #
6563
6910
  # AVG\_AFTER\_CONTACT\_WORK\_TIME
6564
6911
  #
6565
6912
  # : Unit: Seconds
6566
6913
  #
6914
+ # Valid metric filter key: `INITIATION_METHOD`
6915
+ #
6567
6916
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6568
- # Agent Hierarchy, Feature
6917
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6569
6918
  #
6570
6919
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6571
6920
  #
@@ -6592,7 +6941,7 @@ module Aws::Connect
6592
6941
  # : Unit: Seconds
6593
6942
  #
6594
6943
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6595
- # Agent Hierarchy, Feature
6944
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6596
6945
  #
6597
6946
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6598
6947
  #
@@ -6603,7 +6952,7 @@ module Aws::Connect
6603
6952
  # : Unit: Seconds
6604
6953
  #
6605
6954
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6606
- # Agent Hierarchy
6955
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6607
6956
  #
6608
6957
  # AVG\_GREETING\_TIME\_AGENT
6609
6958
  #
@@ -6613,14 +6962,14 @@ module Aws::Connect
6613
6962
  # Unit: Seconds
6614
6963
  #
6615
6964
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6616
- # Agent Hierarchy
6965
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6617
6966
  #
6618
6967
  # AVG\_HANDLE\_TIME
6619
6968
  #
6620
6969
  # : Unit: Seconds
6621
6970
  #
6622
6971
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6623
- # Agent Hierarchy, Feature
6972
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6624
6973
  #
6625
6974
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6626
6975
  #
@@ -6631,7 +6980,7 @@ module Aws::Connect
6631
6980
  # : Unit: Seconds
6632
6981
  #
6633
6982
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6634
- # Agent Hierarchy, Feature
6983
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6635
6984
  #
6636
6985
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6637
6986
  #
@@ -6642,14 +6991,14 @@ module Aws::Connect
6642
6991
  # : Unit: Seconds
6643
6992
  #
6644
6993
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6645
- # Agent Hierarchy
6994
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6646
6995
  #
6647
6996
  # AVG\_HOLDS
6648
6997
  #
6649
6998
  # : Unit: Count
6650
6999
  #
6651
7000
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6652
- # Agent Hierarchy, Feature
7001
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6653
7002
  #
6654
7003
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6655
7004
  #
@@ -6660,14 +7009,16 @@ module Aws::Connect
6660
7009
  # : Unit: Seconds
6661
7010
  #
6662
7011
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6663
- # Agent Hierarchy
7012
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6664
7013
  #
6665
7014
  # AVG\_INTERACTION\_TIME
6666
7015
  #
6667
7016
  # : Unit: Seconds
6668
7017
  #
7018
+ # Valid metric filter key: `INITIATION_METHOD`
7019
+ #
6669
7020
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6670
- # Feature
7021
+ # Feature, contact/segmentAttributes/connect:Subtype
6671
7022
  #
6672
7023
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6673
7024
  #
@@ -6681,7 +7032,7 @@ module Aws::Connect
6681
7032
  # Unit: Count
6682
7033
  #
6683
7034
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6684
- # Agent Hierarchy
7035
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6685
7036
  #
6686
7037
  # AVG\_INTERRUPTION\_TIME\_AGENT
6687
7038
  #
@@ -6691,7 +7042,7 @@ module Aws::Connect
6691
7042
  # Unit: Seconds
6692
7043
  #
6693
7044
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6694
- # Agent Hierarchy
7045
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6695
7046
  #
6696
7047
  # AVG\_NON\_TALK\_TIME
6697
7048
  #
@@ -6701,14 +7052,14 @@ module Aws::Connect
6701
7052
  # Unit: Seconds
6702
7053
  #
6703
7054
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6704
- # Agent Hierarchy
7055
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6705
7056
  #
6706
7057
  # AVG\_QUEUE\_ANSWER\_TIME
6707
7058
  #
6708
7059
  # : Unit: Seconds
6709
7060
  #
6710
7061
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6711
- # Feature
7062
+ # Feature, contact/segmentAttributes/connect:Subtype
6712
7063
  #
6713
7064
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6714
7065
  #
@@ -6718,7 +7069,8 @@ module Aws::Connect
6718
7069
  #
6719
7070
  # : Unit: Seconds
6720
7071
  #
6721
- # Valid groupings and filters: Queue, Channel, Routing Profile
7072
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7073
+ # contact/segmentAttributes/connect:Subtype
6722
7074
  #
6723
7075
  # AVG\_TALK\_TIME
6724
7076
  #
@@ -6728,7 +7080,7 @@ module Aws::Connect
6728
7080
  # Unit: Seconds
6729
7081
  #
6730
7082
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6731
- # Agent Hierarchy
7083
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6732
7084
  #
6733
7085
  # AVG\_TALK\_TIME\_AGENT
6734
7086
  #
@@ -6738,7 +7090,7 @@ module Aws::Connect
6738
7090
  # Unit: Seconds
6739
7091
  #
6740
7092
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6741
- # Agent Hierarchy
7093
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6742
7094
  #
6743
7095
  # AVG\_TALK\_TIME\_CUSTOMER
6744
7096
  #
@@ -6748,14 +7100,14 @@ module Aws::Connect
6748
7100
  # Unit: Seconds
6749
7101
  #
6750
7102
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6751
- # Agent Hierarchy
7103
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6752
7104
  #
6753
7105
  # CONTACTS\_ABANDONED
6754
7106
  #
6755
7107
  # : Unit: Count
6756
7108
  #
6757
7109
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6758
- # Agent Hierarchy
7110
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6759
7111
  #
6760
7112
  # CONTACTS\_CREATED
6761
7113
  #
@@ -6764,7 +7116,7 @@ module Aws::Connect
6764
7116
  # Valid metric filter key: `INITIATION_METHOD`
6765
7117
  #
6766
7118
  # Valid groupings and filters: Queue, Channel, Routing Profile,
6767
- # Feature
7119
+ # Feature, contact/segmentAttributes/connect:Subtype
6768
7120
  #
6769
7121
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6770
7122
  #
@@ -6777,7 +7129,7 @@ module Aws::Connect
6777
7129
  # Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
6778
7130
  #
6779
7131
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6780
- # Agent Hierarchy, Feature
7132
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
6781
7133
  #
6782
7134
  # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6783
7135
  #
@@ -6788,66 +7140,102 @@ module Aws::Connect
6788
7140
  # : Unit: Count
6789
7141
  #
6790
7142
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6791
- # Agent Hierarchy
7143
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6792
7144
  #
6793
- # CONTACTS\_QUEUED
7145
+ # CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
6794
7146
  #
6795
7147
  # : Unit: Count
6796
7148
  #
6797
7149
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6798
7150
  # Agent Hierarchy
6799
7151
  #
6800
- # CONTACTS\_RESOLVED\_IN\_X
7152
+ # CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
6801
7153
  #
6802
7154
  # : Unit: Count
6803
7155
  #
6804
- # Valid groupings and filters: Queue, Channel, Routing Profile
6805
- #
6806
- # Threshold: For `ThresholdValue` enter any whole number from 1 to
6807
- # 604800 (inclusive), in seconds. For `Comparison`, you must enter
6808
- # `LT` (for "Less than").
7156
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7157
+ # Agent Hierarchy
6809
7158
  #
6810
- # CONTACTS\_TRANSFERRED\_OUT
7159
+ # CONTACTS\_PUT\_ON\_HOLD
6811
7160
  #
6812
7161
  # : Unit: Count
6813
7162
  #
6814
7163
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6815
- # Agent Hierarchy, Feature
6816
- #
6817
- # <note markdown="1"> Feature is a valid filter but not a valid grouping.
6818
- #
6819
- # </note>
7164
+ # Agent Hierarchy
6820
7165
  #
6821
- # CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
7166
+ # CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
6822
7167
  #
6823
7168
  # : Unit: Count
6824
7169
  #
6825
7170
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6826
7171
  # Agent Hierarchy
6827
7172
  #
6828
- # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
7173
+ # CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
6829
7174
  #
6830
- # : Unit: Count
7175
+ # : Unit: Percent
6831
7176
  #
6832
7177
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6833
7178
  # Agent Hierarchy
6834
7179
  #
6835
- # MAX\_QUEUED\_TIME
7180
+ # CONTACTS\_QUEUED
6836
7181
  #
6837
- # : Unit: Seconds
7182
+ # : Unit: Count
6838
7183
  #
6839
7184
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6840
- # Agent Hierarchy
7185
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6841
7186
  #
6842
- # PERCENT\_NON\_TALK\_TIME
7187
+ # CONTACTS\_RESOLVED\_IN\_X
6843
7188
  #
6844
- # : This metric is available only for contacts analyzed by Contact Lens
7189
+ # : Unit: Count
7190
+ #
7191
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7192
+ # contact/segmentAttributes/connect:Subtype
7193
+ #
7194
+ # Threshold: For `ThresholdValue` enter any whole number from 1 to
7195
+ # 604800 (inclusive), in seconds. For `Comparison`, you must enter
7196
+ # `LT` (for "Less than").
7197
+ #
7198
+ # CONTACTS\_TRANSFERRED\_OUT
7199
+ #
7200
+ # : Unit: Count
7201
+ #
7202
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7203
+ # Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
7204
+ #
7205
+ # <note markdown="1"> Feature is a valid filter but not a valid grouping.
7206
+ #
7207
+ # </note>
7208
+ #
7209
+ # CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
7210
+ #
7211
+ # : Unit: Count
7212
+ #
7213
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7214
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7215
+ #
7216
+ # CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
7217
+ #
7218
+ # : Unit: Count
7219
+ #
7220
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7221
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7222
+ #
7223
+ # MAX\_QUEUED\_TIME
7224
+ #
7225
+ # : Unit: Seconds
7226
+ #
7227
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7228
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7229
+ #
7230
+ # PERCENT\_NON\_TALK\_TIME
7231
+ #
7232
+ # : This metric is available only for contacts analyzed by Contact Lens
6845
7233
  # conversational analytics.
6846
7234
  #
6847
7235
  # Unit: Percentage
6848
7236
  #
6849
7237
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6850
- # Agent Hierarchy
7238
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6851
7239
  #
6852
7240
  # PERCENT\_TALK\_TIME
6853
7241
  #
@@ -6857,7 +7245,7 @@ module Aws::Connect
6857
7245
  # Unit: Percentage
6858
7246
  #
6859
7247
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6860
- # Agent Hierarchy
7248
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6861
7249
  #
6862
7250
  # PERCENT\_TALK\_TIME\_AGENT
6863
7251
  #
@@ -6867,7 +7255,7 @@ module Aws::Connect
6867
7255
  # Unit: Percentage
6868
7256
  #
6869
7257
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6870
- # Agent Hierarchy
7258
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6871
7259
  #
6872
7260
  # PERCENT\_TALK\_TIME\_CUSTOMER
6873
7261
  #
@@ -6877,7 +7265,7 @@ module Aws::Connect
6877
7265
  # Unit: Percentage
6878
7266
  #
6879
7267
  # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
6880
- # Agent Hierarchy
7268
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
6881
7269
  #
6882
7270
  # SERVICE\_LEVEL
6883
7271
  #
@@ -6891,11 +7279,49 @@ module Aws::Connect
6891
7279
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
6892
7280
  # `LT` (for "Less than").
6893
7281
  #
7282
+ # SUM\_AFTER\_CONTACT\_WORK\_TIME
7283
+ #
7284
+ # : Unit: Seconds
7285
+ #
7286
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7287
+ # Agent Hierarchy
7288
+ #
7289
+ # SUM\_CONNECTING\_TIME\_AGENT
7290
+ #
7291
+ # : Unit: Seconds
7292
+ #
7293
+ # Valid metric filter key: `INITIATION_METHOD`. This metric only
7294
+ # supports the following filter keys as `INITIATION_METHOD`: `INBOUND`
7295
+ # \| `OUTBOUND` \| `CALLBACK` \| `API`
7296
+ #
7297
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7298
+ # Agent Hierarchy
7299
+ #
7300
+ # <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
7301
+ # metric.
7302
+ #
7303
+ # </note>
7304
+ #
7305
+ # SUM\_CONTACT\_FLOW\_TIME
7306
+ #
7307
+ # : Unit: Seconds
7308
+ #
7309
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7310
+ # Agent Hierarchy
7311
+ #
7312
+ # SUM\_CONTACT\_TIME\_AGENT
7313
+ #
7314
+ # : Unit: Seconds
7315
+ #
7316
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7317
+ # Agent Hierarchy
7318
+ #
6894
7319
  # SUM\_CONTACTS\_ANSWERED\_IN\_X
6895
7320
  #
6896
7321
  # : Unit: Count
6897
7322
  #
6898
- # Valid groupings and filters: Queue, Channel, Routing Profile
7323
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7324
+ # contact/segmentAttributes/connect:Subtype
6899
7325
  #
6900
7326
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
6901
7327
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -6905,7 +7331,8 @@ module Aws::Connect
6905
7331
  #
6906
7332
  # : Unit: Count
6907
7333
  #
6908
- # Valid groupings and filters: Queue, Channel, Routing Profile
7334
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7335
+ # contact/segmentAttributes/connect:Subtype
6909
7336
  #
6910
7337
  # Threshold: For `ThresholdValue`, enter any whole number from 1 to
6911
7338
  # 604800 (inclusive), in seconds. For `Comparison`, you must enter
@@ -6917,13 +7344,68 @@ module Aws::Connect
6917
7344
  #
6918
7345
  # Unit: Count
6919
7346
  #
6920
- # Valid groupings and filters: Queue, Channel, Routing Profile
7347
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7348
+ # Agent Hierarchy, contact/segmentAttributes/connect:Subtype
7349
+ #
7350
+ # SUM\_ERROR\_STATUS\_TIME\_AGENT
7351
+ #
7352
+ # : Unit: Seconds
7353
+ #
7354
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7355
+ # Agent Hierarchy
7356
+ #
7357
+ # SUM\_HANDLE\_TIME
7358
+ #
7359
+ # : Unit: Seconds
7360
+ #
7361
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7362
+ # Agent Hierarchy
7363
+ #
7364
+ # SUM\_HOLD\_TIME
7365
+ #
7366
+ # : Unit: Count
7367
+ #
7368
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7369
+ # Agent Hierarchy
7370
+ #
7371
+ # SUM\_IDLE\_TIME\_AGENT
7372
+ #
7373
+ # : Unit: Seconds
7374
+ #
7375
+ # Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
7376
+ #
7377
+ # SUM\_INTERACTION\_AND\_HOLD\_TIME
7378
+ #
7379
+ # : Unit: Seconds
7380
+ #
7381
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7382
+ # Agent Hierarchy
7383
+ #
7384
+ # SUM\_INTERACTION\_TIME
7385
+ #
7386
+ # : Unit: Seconds
7387
+ #
7388
+ # Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
7389
+ # Agent Hierarchy
7390
+ #
7391
+ # SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
7392
+ #
7393
+ # : Unit: Seconds
7394
+ #
7395
+ # Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
7396
+ #
7397
+ # SUM\_ONLINE\_TIME\_AGENT
7398
+ #
7399
+ # : Unit: Seconds
7400
+ #
7401
+ # Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
6921
7402
  #
6922
7403
  # SUM\_RETRY\_CALLBACK\_ATTEMPTS
6923
7404
  #
6924
7405
  # : Unit: Count
6925
7406
  #
6926
- # Valid groupings and filters: Queue, Channel, Routing Profile
7407
+ # Valid groupings and filters: Queue, Channel, Routing Profile,
7408
+ # contact/segmentAttributes/connect:Subtype
6927
7409
  #
6928
7410
  #
6929
7411
  #
@@ -7178,6 +7660,76 @@ module Aws::Connect
7178
7660
  req.send_request(options)
7179
7661
  end
7180
7662
 
7663
+ # Imports a claimed phone number from an external service, such as
7664
+ # Amazon Pinpoint, into an Amazon Connect instance. You can call this
7665
+ # API only in the same Amazon Web Services Region where the Amazon
7666
+ # Connect instance was created.
7667
+ #
7668
+ # @option params [required, String] :instance_id
7669
+ # The identifier of the Amazon Connect instance. You can [find the
7670
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
7671
+ #
7672
+ #
7673
+ #
7674
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
7675
+ #
7676
+ # @option params [required, String] :source_phone_number_arn
7677
+ # The claimed phone number ARN being imported from the external service,
7678
+ # such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like
7679
+ # the ARN of the phone number to import from Amazon Pinpoint.
7680
+ #
7681
+ # @option params [String] :phone_number_description
7682
+ # The description of the phone number.
7683
+ #
7684
+ # @option params [Hash<String,String>] :tags
7685
+ # The tags used to organize, track, or control access for this resource.
7686
+ # For example, \\\{ "tags": \\\{"key1":"value1",
7687
+ # "key2":"value2"\\} \\}.
7688
+ #
7689
+ # @option params [String] :client_token
7690
+ # A unique, case-sensitive identifier that you provide to ensure the
7691
+ # idempotency of the request. If not provided, the Amazon Web Services
7692
+ # SDK populates this field. For more information about idempotency, see
7693
+ # [Making retries safe with idempotent APIs][1].
7694
+ #
7695
+ # **A suitable default value is auto-generated.** You should normally
7696
+ # not need to pass this option.**
7697
+ #
7698
+ #
7699
+ #
7700
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
7701
+ #
7702
+ # @return [Types::ImportPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7703
+ #
7704
+ # * {Types::ImportPhoneNumberResponse#phone_number_id #phone_number_id} => String
7705
+ # * {Types::ImportPhoneNumberResponse#phone_number_arn #phone_number_arn} => String
7706
+ #
7707
+ # @example Request syntax with placeholder values
7708
+ #
7709
+ # resp = client.import_phone_number({
7710
+ # instance_id: "InstanceId", # required
7711
+ # source_phone_number_arn: "ARN", # required
7712
+ # phone_number_description: "PhoneNumberDescription",
7713
+ # tags: {
7714
+ # "TagKey" => "TagValue",
7715
+ # },
7716
+ # client_token: "ClientToken",
7717
+ # })
7718
+ #
7719
+ # @example Response structure
7720
+ #
7721
+ # resp.phone_number_id #=> String
7722
+ # resp.phone_number_arn #=> String
7723
+ #
7724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumber AWS API Documentation
7725
+ #
7726
+ # @overload import_phone_number(params = {})
7727
+ # @param [Hash] params ({})
7728
+ def import_phone_number(params = {}, options = {})
7729
+ req = build_request(:import_phone_number, params)
7730
+ req.send_request(options)
7731
+ end
7732
+
7181
7733
  # This API is in preview release for Amazon Connect and is subject to
7182
7734
  # change.
7183
7735
  #
@@ -7238,6 +7790,63 @@ module Aws::Connect
7238
7790
  req.send_request(options)
7239
7791
  end
7240
7792
 
7793
+ # This API is in preview release for Amazon Connect and is subject to
7794
+ # change.
7795
+ #
7796
+ # Lists the association status of requested dataset ID for a given
7797
+ # Amazon Connect instance.
7798
+ #
7799
+ # @option params [required, String] :instance_id
7800
+ # The identifier of the Amazon Connect instance. You can [find the
7801
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
7802
+ #
7803
+ #
7804
+ #
7805
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
7806
+ #
7807
+ # @option params [String] :data_set_id
7808
+ # The identifier of the dataset to get the association status.
7809
+ #
7810
+ # @option params [String] :next_token
7811
+ # The token for the next set of results. Use the value returned in the
7812
+ # previous response in the next request to retrieve the next set of
7813
+ # results.
7814
+ #
7815
+ # @option params [Integer] :max_results
7816
+ # The maximum number of results to return per page.
7817
+ #
7818
+ # @return [Types::ListAnalyticsDataAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7819
+ #
7820
+ # * {Types::ListAnalyticsDataAssociationsResponse#results #results} => Array&lt;Types::AnalyticsDataAssociationResult&gt;
7821
+ # * {Types::ListAnalyticsDataAssociationsResponse#next_token #next_token} => String
7822
+ #
7823
+ # @example Request syntax with placeholder values
7824
+ #
7825
+ # resp = client.list_analytics_data_associations({
7826
+ # instance_id: "InstanceId", # required
7827
+ # data_set_id: "DataSetId",
7828
+ # next_token: "NextToken",
7829
+ # max_results: 1,
7830
+ # })
7831
+ #
7832
+ # @example Response structure
7833
+ #
7834
+ # resp.results #=> Array
7835
+ # resp.results[0].data_set_id #=> String
7836
+ # resp.results[0].target_account_id #=> String
7837
+ # resp.results[0].resource_share_id #=> String
7838
+ # resp.results[0].resource_share_arn #=> String
7839
+ # resp.next_token #=> String
7840
+ #
7841
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociations AWS API Documentation
7842
+ #
7843
+ # @overload list_analytics_data_associations(params = {})
7844
+ # @param [Hash] params ({})
7845
+ def list_analytics_data_associations(params = {}, options = {})
7846
+ req = build_request(:list_analytics_data_associations, params)
7847
+ req.send_request(options)
7848
+ end
7849
+
7241
7850
  # This API is in preview release for Amazon Connect and is subject to
7242
7851
  # change.
7243
7852
  #
@@ -7787,6 +8396,60 @@ module Aws::Connect
7787
8396
  req.send_request(options)
7788
8397
  end
7789
8398
 
8399
+ # List the flow association based on the filters.
8400
+ #
8401
+ # @option params [required, String] :instance_id
8402
+ # The identifier of the Amazon Connect instance. You can [find the
8403
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
8404
+ #
8405
+ #
8406
+ #
8407
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
8408
+ #
8409
+ # @option params [String] :resource_type
8410
+ # A valid resource type.
8411
+ #
8412
+ # @option params [String] :next_token
8413
+ # The token for the next set of results. Use the value returned in the
8414
+ # previous response in the next request to retrieve the next set of
8415
+ # results.
8416
+ #
8417
+ # @option params [Integer] :max_results
8418
+ # The maximum number of results to return per page.
8419
+ #
8420
+ # @return [Types::ListFlowAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8421
+ #
8422
+ # * {Types::ListFlowAssociationsResponse#flow_association_summary_list #flow_association_summary_list} => Array&lt;Types::FlowAssociationSummary&gt;
8423
+ # * {Types::ListFlowAssociationsResponse#next_token #next_token} => String
8424
+ #
8425
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
8426
+ #
8427
+ # @example Request syntax with placeholder values
8428
+ #
8429
+ # resp = client.list_flow_associations({
8430
+ # instance_id: "InstanceId", # required
8431
+ # resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
8432
+ # next_token: "NextToken",
8433
+ # max_results: 1,
8434
+ # })
8435
+ #
8436
+ # @example Response structure
8437
+ #
8438
+ # resp.flow_association_summary_list #=> Array
8439
+ # resp.flow_association_summary_list[0].resource_id #=> String
8440
+ # resp.flow_association_summary_list[0].flow_id #=> String
8441
+ # resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
8442
+ # resp.next_token #=> String
8443
+ #
8444
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociations AWS API Documentation
8445
+ #
8446
+ # @overload list_flow_associations(params = {})
8447
+ # @param [Hash] params ({})
8448
+ def list_flow_associations(params = {}, options = {})
8449
+ req = build_request(:list_flow_associations, params)
8450
+ req.send_request(options)
8451
+ end
8452
+
7790
8453
  # Provides information about the hours of operation for the specified
7791
8454
  # Amazon Connect instance.
7792
8455
  #
@@ -8267,7 +8930,7 @@ module Aws::Connect
8267
8930
  #
8268
8931
  # resp = client.list_phone_numbers({
8269
8932
  # instance_id: "InstanceId", # required
8270
- # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID
8933
+ # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
8271
8934
  # phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
8272
8935
  # next_token: "NextToken",
8273
8936
  # max_results: 1,
@@ -8279,7 +8942,7 @@ module Aws::Connect
8279
8942
  # resp.phone_number_summary_list[0].id #=> String
8280
8943
  # resp.phone_number_summary_list[0].arn #=> String
8281
8944
  # resp.phone_number_summary_list[0].phone_number #=> String
8282
- # resp.phone_number_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID"
8945
+ # resp.phone_number_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
8283
8946
  # resp.phone_number_summary_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
8284
8947
  # resp.next_token #=> String
8285
8948
  #
@@ -8367,7 +9030,7 @@ module Aws::Connect
8367
9030
  # max_results: 1,
8368
9031
  # next_token: "LargeNextToken",
8369
9032
  # phone_number_country_codes: ["AF"], # accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
8370
- # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID
9033
+ # phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
8371
9034
  # phone_number_prefix: "PhoneNumberPrefix",
8372
9035
  # })
8373
9036
  #
@@ -8379,9 +9042,11 @@ module Aws::Connect
8379
9042
  # resp.list_phone_numbers_summary_list[0].phone_number_arn #=> String
8380
9043
  # resp.list_phone_numbers_summary_list[0].phone_number #=> String
8381
9044
  # resp.list_phone_numbers_summary_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
8382
- # resp.list_phone_numbers_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID"
9045
+ # resp.list_phone_numbers_summary_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
8383
9046
  # resp.list_phone_numbers_summary_list[0].target_arn #=> String
8384
9047
  # resp.list_phone_numbers_summary_list[0].instance_id #=> String
9048
+ # resp.list_phone_numbers_summary_list[0].phone_number_description #=> String
9049
+ # resp.list_phone_numbers_summary_list[0].source_phone_number_arn #=> String
8385
9050
  #
8386
9051
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2 AWS API Documentation
8387
9052
  #
@@ -8598,8 +9263,8 @@ module Aws::Connect
8598
9263
  # MaxResult size is 100.
8599
9264
  #
8600
9265
  # @option params [Array<String>] :quick_connect_types
8601
- # The type of quick connect. In the Amazon Connect console, when you
8602
- # create a quick connect, you are prompted to assign one of the
9266
+ # The type of quick connect. In the Amazon Connect admin website, when
9267
+ # you create a quick connect, you are prompted to assign one of the
8603
9268
  # following types: Agent (USER), External (PHONE\_NUMBER), or Queue
8604
9269
  # (QUEUE).
8605
9270
  #
@@ -8639,6 +9304,111 @@ module Aws::Connect
8639
9304
  req.send_request(options)
8640
9305
  end
8641
9306
 
9307
+ # Provides a list of analysis segments for a real-time analysis session.
9308
+ #
9309
+ # @option params [required, String] :instance_id
9310
+ # The identifier of the Amazon Connect instance. You can [find the
9311
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
9312
+ #
9313
+ #
9314
+ #
9315
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
9316
+ #
9317
+ # @option params [required, String] :contact_id
9318
+ # The identifier of the contact in this instance of Amazon Connect.
9319
+ #
9320
+ # @option params [Integer] :max_results
9321
+ # The maximum number of results to return per page.
9322
+ #
9323
+ # @option params [String] :next_token
9324
+ # The token for the next set of results. Use the value returned in the
9325
+ # previous response in the next request to retrieve the next set of
9326
+ # results.
9327
+ #
9328
+ # @option params [required, String] :output_type
9329
+ # The Contact Lens output type to be returned.
9330
+ #
9331
+ # @option params [required, Array<String>] :segment_types
9332
+ # Enum with segment types . Each value corresponds to a segment type
9333
+ # returned in the segments list of the API. Each segment type has its
9334
+ # own structure. Different channels may have different sets of supported
9335
+ # segment types.
9336
+ #
9337
+ # @return [Types::ListRealtimeContactAnalysisSegmentsV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9338
+ #
9339
+ # * {Types::ListRealtimeContactAnalysisSegmentsV2Response#channel #channel} => String
9340
+ # * {Types::ListRealtimeContactAnalysisSegmentsV2Response#status #status} => String
9341
+ # * {Types::ListRealtimeContactAnalysisSegmentsV2Response#segments #segments} => Array&lt;Types::RealtimeContactAnalysisSegment&gt;
9342
+ # * {Types::ListRealtimeContactAnalysisSegmentsV2Response#next_token #next_token} => String
9343
+ #
9344
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
9345
+ #
9346
+ # @example Request syntax with placeholder values
9347
+ #
9348
+ # resp = client.list_realtime_contact_analysis_segments_v2({
9349
+ # instance_id: "InstanceId", # required
9350
+ # contact_id: "ContactId", # required
9351
+ # max_results: 1,
9352
+ # next_token: "LargeNextToken",
9353
+ # output_type: "Raw", # required, accepts Raw, Redacted
9354
+ # segment_types: ["Transcript"], # required, accepts Transcript, Categories, Issues, Event, Attachments
9355
+ # })
9356
+ #
9357
+ # @example Response structure
9358
+ #
9359
+ # resp.channel #=> String, one of "VOICE", "CHAT"
9360
+ # resp.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
9361
+ # resp.segments #=> Array
9362
+ # resp.segments[0].transcript.id #=> String
9363
+ # resp.segments[0].transcript.participant_id #=> String
9364
+ # resp.segments[0].transcript.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
9365
+ # resp.segments[0].transcript.display_name #=> String
9366
+ # resp.segments[0].transcript.content #=> String
9367
+ # resp.segments[0].transcript.content_type #=> String
9368
+ # resp.segments[0].transcript.time.absolute_time #=> Time
9369
+ # resp.segments[0].transcript.redaction.character_offsets #=> Array
9370
+ # resp.segments[0].transcript.redaction.character_offsets[0].begin_offset_char #=> Integer
9371
+ # resp.segments[0].transcript.redaction.character_offsets[0].end_offset_char #=> Integer
9372
+ # resp.segments[0].transcript.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
9373
+ # resp.segments[0].categories.matched_details #=> Hash
9374
+ # resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest #=> Array
9375
+ # resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items #=> Array
9376
+ # resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].id #=> String
9377
+ # resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
9378
+ # resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
9379
+ # resp.segments[0].issues.issues_detected #=> Array
9380
+ # resp.segments[0].issues.issues_detected[0].transcript_items #=> Array
9381
+ # resp.segments[0].issues.issues_detected[0].transcript_items[0].content #=> String
9382
+ # resp.segments[0].issues.issues_detected[0].transcript_items[0].id #=> String
9383
+ # resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
9384
+ # resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
9385
+ # resp.segments[0].event.id #=> String
9386
+ # resp.segments[0].event.participant_id #=> String
9387
+ # resp.segments[0].event.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
9388
+ # resp.segments[0].event.display_name #=> String
9389
+ # resp.segments[0].event.event_type #=> String
9390
+ # resp.segments[0].event.time.absolute_time #=> Time
9391
+ # resp.segments[0].attachments.id #=> String
9392
+ # resp.segments[0].attachments.participant_id #=> String
9393
+ # resp.segments[0].attachments.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
9394
+ # resp.segments[0].attachments.display_name #=> String
9395
+ # resp.segments[0].attachments.attachments #=> Array
9396
+ # resp.segments[0].attachments.attachments[0].attachment_name #=> String
9397
+ # resp.segments[0].attachments.attachments[0].content_type #=> String
9398
+ # resp.segments[0].attachments.attachments[0].attachment_id #=> String
9399
+ # resp.segments[0].attachments.attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
9400
+ # resp.segments[0].attachments.time.absolute_time #=> Time
9401
+ # resp.next_token #=> String
9402
+ #
9403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2 AWS API Documentation
9404
+ #
9405
+ # @overload list_realtime_contact_analysis_segments_v2(params = {})
9406
+ # @param [Hash] params ({})
9407
+ def list_realtime_contact_analysis_segments_v2(params = {}, options = {})
9408
+ req = build_request(:list_realtime_contact_analysis_segments_v2, params)
9409
+ req.send_request(options)
9410
+ end
9411
+
8642
9412
  # Lists the queues associated with a routing profile.
8643
9413
  #
8644
9414
  # @option params [required, String] :instance_id
@@ -8800,7 +9570,7 @@ module Aws::Connect
8800
9570
  # resp = client.list_rules({
8801
9571
  # instance_id: "InstanceId", # required
8802
9572
  # publish_status: "DRAFT", # accepts DRAFT, PUBLISHED
8803
- # event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
9573
+ # event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
8804
9574
  # max_results: 1,
8805
9575
  # next_token: "NextToken",
8806
9576
  # })
@@ -8811,7 +9581,7 @@ module Aws::Connect
8811
9581
  # resp.rule_summary_list[0].name #=> String
8812
9582
  # resp.rule_summary_list[0].rule_id #=> String
8813
9583
  # resp.rule_summary_list[0].rule_arn #=> String
8814
- # resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
9584
+ # resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
8815
9585
  # resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
8816
9586
  # resp.rule_summary_list[0].action_summaries #=> Array
8817
9587
  # resp.rule_summary_list[0].action_summaries[0].action_type #=> String, one of "CREATE_TASK", "ASSIGN_CONTACT_CATEGORY", "GENERATE_EVENTBRIDGE_EVENT", "SEND_NOTIFICATION"
@@ -9664,7 +10434,7 @@ module Aws::Connect
9664
10434
  # the Amazon Web Services Region where the number was claimed.
9665
10435
  #
9666
10436
  # To release phone numbers from a traffic distribution group, use the
9667
- # `ReleasePhoneNumber` API, not the Amazon Connect console.
10437
+ # `ReleasePhoneNumber` API, not the Amazon Connect admin website.
9668
10438
  #
9669
10439
  # After releasing a phone number, the phone number enters into a
9670
10440
  # cooldown period of 30 days. It cannot be searched for or claimed again
@@ -9887,7 +10657,7 @@ module Aws::Connect
9887
10657
  # target_arn: "ARN",
9888
10658
  # instance_id: "InstanceId",
9889
10659
  # phone_number_country_code: "AF", # required, accepts AF, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BA, BW, BR, IO, VG, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CK, CR, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, TL, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, PF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GU, GT, GG, GN, GW, GY, HT, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, CI, JM, JP, JE, JO, KZ, KE, KI, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, KP, MP, NO, OM, PK, PW, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, CG, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, KR, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TG, TK, TO, TT, TN, TR, TM, TC, TV, VI, UG, UA, AE, GB, US, UY, UZ, VU, VA, VE, VN, WF, EH, YE, ZM, ZW
9890
- # phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID
10660
+ # phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
9891
10661
  # phone_number_prefix: "PhoneNumberPrefix",
9892
10662
  # max_results: 1,
9893
10663
  # next_token: "LargeNextToken",
@@ -9899,7 +10669,7 @@ module Aws::Connect
9899
10669
  # resp.available_numbers_list #=> Array
9900
10670
  # resp.available_numbers_list[0].phone_number #=> String
9901
10671
  # resp.available_numbers_list[0].phone_number_country_code #=> String, one of "AF", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BA", "BW", "BR", "IO", "VG", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CK", "CR", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "TL", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "PF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "CI", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "KP", "MP", "NO", "OM", "PK", "PW", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "CG", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "KR", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "VI", "UG", "UA", "AE", "GB", "US", "UY", "UZ", "VU", "VA", "VE", "VN", "WF", "EH", "YE", "ZM", "ZW"
9902
- # resp.available_numbers_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID"
10672
+ # resp.available_numbers_list[0].phone_number_type #=> String, one of "TOLL_FREE", "DID", "UIFN", "SHARED", "THIRD_PARTY_TF", "THIRD_PARTY_DID", "SHORT_CODE"
9903
10673
  #
9904
10674
  # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbers AWS API Documentation
9905
10675
  #
@@ -10847,6 +11617,90 @@ module Aws::Connect
10847
11617
  req.send_request(options)
10848
11618
  end
10849
11619
 
11620
+ # Processes chat integration events from Amazon Web Services or external
11621
+ # integrations to Amazon Connect. A chat integration event includes:
11622
+ #
11623
+ # * SourceId, DestinationId, and Subtype: a set of identifiers, uniquely
11624
+ # representing a chat
11625
+ #
11626
+ # * ChatEvent: details of the chat action to perform such as sending a
11627
+ # message, event, or disconnecting from a chat
11628
+ #
11629
+ # When a chat integration event is sent with chat identifiers that do
11630
+ # not map to an active chat contact, a new chat contact is also created
11631
+ # before handling chat action.
11632
+ #
11633
+ # Access to this API is currently restricted to Amazon Pinpoint for
11634
+ # supporting SMS integration.
11635
+ #
11636
+ # @option params [required, String] :source_id
11637
+ # External identifier of chat customer participant, used in part to
11638
+ # uniquely identify a chat. For SMS, this is the E164 phone number of
11639
+ # the chat customer participant.
11640
+ #
11641
+ # @option params [required, String] :destination_id
11642
+ # Chat system identifier, used in part to uniquely identify chat. This
11643
+ # is associated with the Amazon Connect instance and flow to be used to
11644
+ # start chats. For SMS, this is the phone number destination of inbound
11645
+ # SMS messages represented by an Amazon Pinpoint phone number ARN.
11646
+ #
11647
+ # @option params [String] :subtype
11648
+ # Classification of a channel. This is used in part to uniquely identify
11649
+ # chat.
11650
+ #
11651
+ # Valid value: `["connect:sms"]`
11652
+ #
11653
+ # @option params [required, Types::ChatEvent] :event
11654
+ # Chat integration event payload
11655
+ #
11656
+ # @option params [Types::NewSessionDetails] :new_session_details
11657
+ # Contact properties to apply when starting a new chat. If the
11658
+ # integration event is handled with an existing chat, this is ignored.
11659
+ #
11660
+ # @return [Types::SendChatIntegrationEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
11661
+ #
11662
+ # * {Types::SendChatIntegrationEventResponse#initial_contact_id #initial_contact_id} => String
11663
+ # * {Types::SendChatIntegrationEventResponse#new_chat_created #new_chat_created} => Boolean
11664
+ #
11665
+ # @example Request syntax with placeholder values
11666
+ #
11667
+ # resp = client.send_chat_integration_event({
11668
+ # source_id: "SourceId", # required
11669
+ # destination_id: "DestinationId", # required
11670
+ # subtype: "Subtype",
11671
+ # event: { # required
11672
+ # type: "DISCONNECT", # required, accepts DISCONNECT, MESSAGE, EVENT
11673
+ # content_type: "ChatContentType",
11674
+ # content: "ChatContent",
11675
+ # },
11676
+ # new_session_details: {
11677
+ # supported_messaging_content_types: ["SupportedMessagingContentType"],
11678
+ # participant_details: {
11679
+ # display_name: "DisplayName", # required
11680
+ # },
11681
+ # attributes: {
11682
+ # "AttributeName" => "AttributeValue",
11683
+ # },
11684
+ # streaming_configuration: {
11685
+ # streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
11686
+ # },
11687
+ # },
11688
+ # })
11689
+ #
11690
+ # @example Response structure
11691
+ #
11692
+ # resp.initial_contact_id #=> String
11693
+ # resp.new_chat_created #=> Boolean
11694
+ #
11695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEvent AWS API Documentation
11696
+ #
11697
+ # @overload send_chat_integration_event(params = {})
11698
+ # @param [Hash] params ({})
11699
+ def send_chat_integration_event(params = {}, options = {})
11700
+ req = build_request(:send_chat_integration_event, params)
11701
+ req.send_request(options)
11702
+ end
11703
+
10850
11704
  # Initiates a flow to start a new chat for the customer. Response of
10851
11705
  # this API provides a token required to obtain credentials from the
10852
11706
  # [CreateParticipantConnection][1] API in the Amazon Connect Participant
@@ -10890,11 +11744,11 @@ module Aws::Connect
10890
11744
  #
10891
11745
  # @option params [required, String] :contact_flow_id
10892
11746
  # The identifier of the flow for initiating the chat. To see the
10893
- # ContactFlowId in the Amazon Connect console user interface, on the
10894
- # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
10895
- # On the flow page, under the name of the flow, choose **Show additional
10896
- # flow information**. The ContactFlowId is the last part of the ARN,
10897
- # shown here in bold:
11747
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
11748
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
11749
+ # flow page, under the name of the flow, choose **Show additional flow
11750
+ # information**. The ContactFlowId is the last part of the ARN, shown
11751
+ # here in bold:
10898
11752
  #
10899
11753
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
10900
11754
  #
@@ -11274,11 +12128,11 @@ module Aws::Connect
11274
12128
  #
11275
12129
  # @option params [required, String] :contact_flow_id
11276
12130
  # The identifier of the flow for the outbound call. To see the
11277
- # ContactFlowId in the Amazon Connect console user interface, on the
11278
- # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
11279
- # On the flow page, under the name of the flow, choose **Show additional
11280
- # flow information**. The ContactFlowId is the last part of the ARN,
11281
- # shown here in bold:
12131
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
12132
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
12133
+ # flow page, under the name of the flow, choose **Show additional flow
12134
+ # information**. The ContactFlowId is the last part of the ARN, shown
12135
+ # here in bold:
11282
12136
  #
11283
12137
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
11284
12138
  #
@@ -11438,11 +12292,11 @@ module Aws::Connect
11438
12292
  #
11439
12293
  # @option params [String] :contact_flow_id
11440
12294
  # The identifier of the flow for initiating the tasks. To see the
11441
- # ContactFlowId in the Amazon Connect console user interface, on the
11442
- # navigation menu go to **Routing**, **Contact Flows**. Choose the flow.
11443
- # On the flow page, under the name of the flow, choose **Show additional
11444
- # flow information**. The ContactFlowId is the last part of the ARN,
11445
- # shown here in bold:
12295
+ # ContactFlowId in the Amazon Connect admin website, on the navigation
12296
+ # menu go to **Routing**, **Contact Flows**. Choose the flow. On the
12297
+ # flow page, under the name of the flow, choose **Show additional flow
12298
+ # information**. The ContactFlowId is the last part of the ARN, shown
12299
+ # here in bold:
11446
12300
  #
11447
12301
  # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
11448
12302
  #
@@ -11560,6 +12414,137 @@ module Aws::Connect
11560
12414
  req.send_request(options)
11561
12415
  end
11562
12416
 
12417
+ # Places an inbound in-app, web, or video call to a contact, and then
12418
+ # initiates the flow. It performs the actions in the flow that are
12419
+ # specified (in ContactFlowId) and present in the Amazon Connect
12420
+ # instance (specified as InstanceId).
12421
+ #
12422
+ # @option params [Hash<String,String>] :attributes
12423
+ # A custom key-value pair using an attribute map. The attributes are
12424
+ # standard Amazon Connect attributes, and can be accessed in flows just
12425
+ # like any other contact attributes.
12426
+ #
12427
+ # There can be up to 32,768 UTF-8 bytes across all key-value pairs per
12428
+ # contact. Attribute keys can include only alphanumeric, -, and \_
12429
+ # characters.
12430
+ #
12431
+ # @option params [String] :client_token
12432
+ # A unique, case-sensitive identifier that you provide to ensure the
12433
+ # idempotency of the request. If not provided, the Amazon Web Services
12434
+ # SDK populates this field. For more information about idempotency, see
12435
+ # [Making retries safe with idempotent APIs][1].
12436
+ #
12437
+ # The token is valid for 7 days after creation. If a contact is already
12438
+ # started, the contact ID is returned.
12439
+ #
12440
+ # **A suitable default value is auto-generated.** You should normally
12441
+ # not need to pass this option.**
12442
+ #
12443
+ #
12444
+ #
12445
+ # [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
12446
+ #
12447
+ # @option params [required, String] :contact_flow_id
12448
+ # The identifier of the flow for the call. To see the ContactFlowId in
12449
+ # the Amazon Connect admin website, on the navigation menu go to
12450
+ # **Routing**, **Contact Flows**. Choose the flow. On the flow page,
12451
+ # under the name of the flow, choose **Show additional flow
12452
+ # information**. The ContactFlowId is the last part of the ARN, shown
12453
+ # here in bold:
12454
+ #
12455
+ # arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
12456
+ #
12457
+ # @option params [required, String] :instance_id
12458
+ # The identifier of the Amazon Connect instance. You can [find the
12459
+ # instance ID][1] in the Amazon Resource Name (ARN) of the instance.
12460
+ #
12461
+ #
12462
+ #
12463
+ # [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
12464
+ #
12465
+ # @option params [Types::AllowedCapabilities] :allowed_capabilities
12466
+ # Information about the video sharing capabilities of the participants
12467
+ # (customer, agent).
12468
+ #
12469
+ # @option params [required, Types::ParticipantDetails] :participant_details
12470
+ # The customer's details.
12471
+ #
12472
+ # @option params [String] :related_contact_id
12473
+ # The unique identifier for an Amazon Connect contact. This identifier
12474
+ # is related to the contact starting.
12475
+ #
12476
+ # @option params [Hash<String,Types::Reference>] :references
12477
+ # A formatted URL that is shown to an agent in the Contact Control Panel
12478
+ # (CCP). Tasks can have the following reference types at the time of
12479
+ # creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \| `EMAIL`.
12480
+ # `ATTACHMENT` is not a supported reference type during task creation.
12481
+ #
12482
+ # @option params [String] :description
12483
+ # A description of the task that is shown to an agent in the Contact
12484
+ # Control Panel (CCP).
12485
+ #
12486
+ # @return [Types::StartWebRTCContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
12487
+ #
12488
+ # * {Types::StartWebRTCContactResponse#connection_data #connection_data} => Types::ConnectionData
12489
+ # * {Types::StartWebRTCContactResponse#contact_id #contact_id} => String
12490
+ # * {Types::StartWebRTCContactResponse#participant_id #participant_id} => String
12491
+ # * {Types::StartWebRTCContactResponse#participant_token #participant_token} => String
12492
+ #
12493
+ # @example Request syntax with placeholder values
12494
+ #
12495
+ # resp = client.start_web_rtc_contact({
12496
+ # attributes: {
12497
+ # "AttributeName" => "AttributeValue",
12498
+ # },
12499
+ # client_token: "ClientToken",
12500
+ # contact_flow_id: "ContactFlowId", # required
12501
+ # instance_id: "InstanceId", # required
12502
+ # allowed_capabilities: {
12503
+ # customer: {
12504
+ # video: "SEND", # accepts SEND
12505
+ # },
12506
+ # agent: {
12507
+ # video: "SEND", # accepts SEND
12508
+ # },
12509
+ # },
12510
+ # participant_details: { # required
12511
+ # display_name: "DisplayName", # required
12512
+ # },
12513
+ # related_contact_id: "ContactId",
12514
+ # references: {
12515
+ # "ReferenceKey" => {
12516
+ # value: "ReferenceValue", # required
12517
+ # type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
12518
+ # },
12519
+ # },
12520
+ # description: "Description",
12521
+ # })
12522
+ #
12523
+ # @example Response structure
12524
+ #
12525
+ # resp.connection_data.attendee.attendee_id #=> String
12526
+ # resp.connection_data.attendee.join_token #=> String
12527
+ # resp.connection_data.meeting.media_region #=> String
12528
+ # resp.connection_data.meeting.media_placement.audio_host_url #=> String
12529
+ # resp.connection_data.meeting.media_placement.audio_fallback_url #=> String
12530
+ # resp.connection_data.meeting.media_placement.signaling_url #=> String
12531
+ # resp.connection_data.meeting.media_placement.turn_control_url #=> String
12532
+ # resp.connection_data.meeting.media_placement.event_ingestion_url #=> String
12533
+ # resp.connection_data.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
12534
+ # resp.connection_data.meeting.meeting_id #=> String
12535
+ # resp.contact_id #=> String
12536
+ # resp.participant_id #=> String
12537
+ # resp.participant_token #=> String
12538
+ #
12539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContact AWS API Documentation
12540
+ #
12541
+ # @overload start_web_rtc_contact(params = {})
12542
+ # @param [Hash] params ({})
12543
+ def start_web_rtc_contact(params = {}, options = {})
12544
+ req = build_request(:start_web_rtc_contact, params)
12545
+ req.send_request(options)
12546
+ end
12547
+
11563
12548
  # Ends the specified contact. This call does not work for voice contacts
11564
12549
  # that use the following initiation methods:
11565
12550
  #
@@ -14329,7 +15314,7 @@ module Aws::Connect
14329
15314
  params: params,
14330
15315
  config: config)
14331
15316
  context[:gem_name] = 'aws-sdk-connect'
14332
- context[:gem_version] = '1.139.0'
15317
+ context[:gem_version] = '1.141.0'
14333
15318
  Seahorse::Client::Request.new(handlers, context)
14334
15319
  end
14335
15320