aws-sdk-connect 1.140.0 → 1.142.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +1081 -87
- data/lib/aws-sdk-connect/client_api.rb +586 -0
- data/lib/aws-sdk-connect/endpoints.rb +182 -0
- data/lib/aws-sdk-connect/errors.rb +16 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +29 -2
- data/lib/aws-sdk-connect/types.rb +1792 -94
- data/lib/aws-sdk-connect.rb +1 -1
- metadata +2 -2
@@ -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<Types::AnalyticsDataAssociationResult>
|
1043
|
+
# * {Types::BatchAssociateAnalyticsDataSetResponse#errors #errors} => Array<Types::ErrorResult>
|
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<String>
|
1100
|
+
# * {Types::BatchDisassociateAnalyticsDataSetResponse#errors #errors} => Array<Types::ErrorResult>
|
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
|
@@ -1622,6 +1827,10 @@ module Aws::Connect
|
|
1622
1827
|
# @option params [required, Boolean] :outbound_calls_enabled
|
1623
1828
|
# Your contact center allows outbound calls.
|
1624
1829
|
#
|
1830
|
+
# @option params [Hash<String,String>] :tags
|
1831
|
+
# The tags used to organize, track, or control access for this resource.
|
1832
|
+
# For example, `\{ "tags": \{"key1":"value1", "key2":"value2"\} \}`.
|
1833
|
+
#
|
1625
1834
|
# @return [Types::CreateInstanceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1626
1835
|
#
|
1627
1836
|
# * {Types::CreateInstanceResponse#id #id} => String
|
@@ -1636,6 +1845,9 @@ module Aws::Connect
|
|
1636
1845
|
# directory_id: "DirectoryId",
|
1637
1846
|
# inbound_calls_enabled: false, # required
|
1638
1847
|
# outbound_calls_enabled: false, # required
|
1848
|
+
# tags: {
|
1849
|
+
# "TagKey" => "TagValue",
|
1850
|
+
# },
|
1639
1851
|
# })
|
1640
1852
|
#
|
1641
1853
|
# @example Response structure
|
@@ -2312,7 +2524,7 @@ module Aws::Connect
|
|
2312
2524
|
# instance_id: "InstanceId", # required
|
2313
2525
|
# name: "RuleName", # required
|
2314
2526
|
# trigger_event_source: { # required
|
2315
|
-
# event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
|
2527
|
+
# event_source_name: "OnPostCallAnalysisAvailable", # required, accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
|
2316
2528
|
# integration_association_id: "IntegrationAssociationId",
|
2317
2529
|
# },
|
2318
2530
|
# function: "RuleFunction", # required
|
@@ -2714,9 +2926,9 @@ module Aws::Connect
|
|
2714
2926
|
# identity management. `FirstName` and `LastName` are required if you
|
2715
2927
|
# are using Amazon Connect or SAML for identity management.
|
2716
2928
|
#
|
2717
|
-
# For information about how to create
|
2718
|
-
#
|
2719
|
-
#
|
2929
|
+
# For information about how to create users using the Amazon Connect
|
2930
|
+
# admin website, see [Add Users][2] in the *Amazon Connect Administrator
|
2931
|
+
# Guide*.
|
2720
2932
|
#
|
2721
2933
|
#
|
2722
2934
|
#
|
@@ -4355,6 +4567,8 @@ module Aws::Connect
|
|
4355
4567
|
# resp.instance.inbound_calls_enabled #=> Boolean
|
4356
4568
|
# resp.instance.outbound_calls_enabled #=> Boolean
|
4357
4569
|
# resp.instance.instance_access_url #=> String
|
4570
|
+
# resp.instance.tags #=> Hash
|
4571
|
+
# resp.instance.tags["TagKey"] #=> String
|
4358
4572
|
#
|
4359
4573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeInstance AWS API Documentation
|
4360
4574
|
#
|
@@ -4495,7 +4709,7 @@ module Aws::Connect
|
|
4495
4709
|
# resp.claimed_phone_number_summary.phone_number_arn #=> String
|
4496
4710
|
# resp.claimed_phone_number_summary.phone_number #=> String
|
4497
4711
|
# 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"
|
4712
|
+
# 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
4713
|
# resp.claimed_phone_number_summary.phone_number_description #=> String
|
4500
4714
|
# resp.claimed_phone_number_summary.target_arn #=> String
|
4501
4715
|
# resp.claimed_phone_number_summary.instance_id #=> String
|
@@ -4503,6 +4717,7 @@ module Aws::Connect
|
|
4503
4717
|
# resp.claimed_phone_number_summary.tags["TagKey"] #=> String
|
4504
4718
|
# resp.claimed_phone_number_summary.phone_number_status.status #=> String, one of "CLAIMED", "IN_PROGRESS", "FAILED"
|
4505
4719
|
# resp.claimed_phone_number_summary.phone_number_status.message #=> String
|
4720
|
+
# resp.claimed_phone_number_summary.source_phone_number_arn #=> String
|
4506
4721
|
#
|
4507
4722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribePhoneNumber AWS API Documentation
|
4508
4723
|
#
|
@@ -4743,7 +4958,7 @@ module Aws::Connect
|
|
4743
4958
|
# resp.rule.name #=> String
|
4744
4959
|
# resp.rule.rule_id #=> String
|
4745
4960
|
# 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"
|
4961
|
+
# resp.rule.trigger_event_source.event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
|
4747
4962
|
# resp.rule.trigger_event_source.integration_association_id #=> String
|
4748
4963
|
# resp.rule.function #=> String
|
4749
4964
|
# resp.rule.actions #=> Array
|
@@ -4867,8 +5082,8 @@ module Aws::Connect
|
|
4867
5082
|
req.send_request(options)
|
4868
5083
|
end
|
4869
5084
|
|
4870
|
-
# Describes the specified user
|
4871
|
-
#
|
5085
|
+
# Describes the specified user. You can [find the instance ID in the
|
5086
|
+
# Amazon Connect console][1] (it’s the final part of the ARN). The
|
4872
5087
|
# console does not display the user IDs. Instead, list the users and
|
4873
5088
|
# note the IDs provided in the output.
|
4874
5089
|
#
|
@@ -5166,6 +5381,48 @@ module Aws::Connect
|
|
5166
5381
|
req.send_request(options)
|
5167
5382
|
end
|
5168
5383
|
|
5384
|
+
# This API is in preview release for Amazon Connect and is subject to
|
5385
|
+
# change.
|
5386
|
+
#
|
5387
|
+
# Removes the dataset ID associated with a given Amazon Connect
|
5388
|
+
# instance.
|
5389
|
+
#
|
5390
|
+
# @option params [required, String] :instance_id
|
5391
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5392
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5393
|
+
#
|
5394
|
+
#
|
5395
|
+
#
|
5396
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5397
|
+
#
|
5398
|
+
# @option params [required, String] :data_set_id
|
5399
|
+
# The identifier of the dataset to remove.
|
5400
|
+
#
|
5401
|
+
# @option params [String] :target_account_id
|
5402
|
+
# The identifier of the target account. Use to associate a dataset to a
|
5403
|
+
# different account than the one containing the Amazon Connect instance.
|
5404
|
+
# If not specified, by default this value is the Amazon Web Services
|
5405
|
+
# account that has the Amazon Connect instance.
|
5406
|
+
#
|
5407
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5408
|
+
#
|
5409
|
+
# @example Request syntax with placeholder values
|
5410
|
+
#
|
5411
|
+
# resp = client.disassociate_analytics_data_set({
|
5412
|
+
# instance_id: "InstanceId", # required
|
5413
|
+
# data_set_id: "DataSetId", # required
|
5414
|
+
# target_account_id: "AWSAccountId",
|
5415
|
+
# })
|
5416
|
+
#
|
5417
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateAnalyticsDataSet AWS API Documentation
|
5418
|
+
#
|
5419
|
+
# @overload disassociate_analytics_data_set(params = {})
|
5420
|
+
# @param [Hash] params ({})
|
5421
|
+
def disassociate_analytics_data_set(params = {}, options = {})
|
5422
|
+
req = build_request(:disassociate_analytics_data_set, params)
|
5423
|
+
req.send_request(options)
|
5424
|
+
end
|
5425
|
+
|
5169
5426
|
# This API is in preview release for Amazon Connect and is subject to
|
5170
5427
|
# change.
|
5171
5428
|
#
|
@@ -5244,6 +5501,41 @@ module Aws::Connect
|
|
5244
5501
|
req.send_request(options)
|
5245
5502
|
end
|
5246
5503
|
|
5504
|
+
# Disassociates a connect resource from a flow.
|
5505
|
+
#
|
5506
|
+
# @option params [required, String] :instance_id
|
5507
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
5508
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
5509
|
+
#
|
5510
|
+
#
|
5511
|
+
#
|
5512
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
5513
|
+
#
|
5514
|
+
# @option params [required, String] :resource_id
|
5515
|
+
# The identifier of the resource.
|
5516
|
+
#
|
5517
|
+
# @option params [required, String] :resource_type
|
5518
|
+
# A valid resource type.
|
5519
|
+
#
|
5520
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5521
|
+
#
|
5522
|
+
# @example Request syntax with placeholder values
|
5523
|
+
#
|
5524
|
+
# resp = client.disassociate_flow({
|
5525
|
+
# instance_id: "InstanceId", # required
|
5526
|
+
# resource_id: "ARN", # required
|
5527
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
5528
|
+
# })
|
5529
|
+
#
|
5530
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateFlow AWS API Documentation
|
5531
|
+
#
|
5532
|
+
# @overload disassociate_flow(params = {})
|
5533
|
+
# @param [Hash] params ({})
|
5534
|
+
def disassociate_flow(params = {}, options = {})
|
5535
|
+
req = build_request(:disassociate_flow, params)
|
5536
|
+
req.send_request(options)
|
5537
|
+
end
|
5538
|
+
|
5247
5539
|
# This API is in preview release for Amazon Connect and is subject to
|
5248
5540
|
# change.
|
5249
5541
|
#
|
@@ -6048,6 +6340,51 @@ module Aws::Connect
|
|
6048
6340
|
req.send_request(options)
|
6049
6341
|
end
|
6050
6342
|
|
6343
|
+
# Retrieves the flow associated for a given resource.
|
6344
|
+
#
|
6345
|
+
# @option params [required, String] :instance_id
|
6346
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
6347
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
6348
|
+
#
|
6349
|
+
#
|
6350
|
+
#
|
6351
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6352
|
+
#
|
6353
|
+
# @option params [required, String] :resource_id
|
6354
|
+
# The identifier of the resource.
|
6355
|
+
#
|
6356
|
+
# @option params [required, String] :resource_type
|
6357
|
+
# A valid resource type.
|
6358
|
+
#
|
6359
|
+
# @return [Types::GetFlowAssociationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6360
|
+
#
|
6361
|
+
# * {Types::GetFlowAssociationResponse#resource_id #resource_id} => String
|
6362
|
+
# * {Types::GetFlowAssociationResponse#flow_id #flow_id} => String
|
6363
|
+
# * {Types::GetFlowAssociationResponse#resource_type #resource_type} => String
|
6364
|
+
#
|
6365
|
+
# @example Request syntax with placeholder values
|
6366
|
+
#
|
6367
|
+
# resp = client.get_flow_association({
|
6368
|
+
# instance_id: "InstanceId", # required
|
6369
|
+
# resource_id: "ARN", # required
|
6370
|
+
# resource_type: "SMS_PHONE_NUMBER", # required, accepts SMS_PHONE_NUMBER
|
6371
|
+
# })
|
6372
|
+
#
|
6373
|
+
# @example Response structure
|
6374
|
+
#
|
6375
|
+
# resp.resource_id #=> String
|
6376
|
+
# resp.flow_id #=> String
|
6377
|
+
# resp.resource_type #=> String, one of "SMS_PHONE_NUMBER"
|
6378
|
+
#
|
6379
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetFlowAssociation AWS API Documentation
|
6380
|
+
#
|
6381
|
+
# @overload get_flow_association(params = {})
|
6382
|
+
# @param [Hash] params ({})
|
6383
|
+
def get_flow_association(params = {}, options = {})
|
6384
|
+
req = build_request(:get_flow_association, params)
|
6385
|
+
req.send_request(options)
|
6386
|
+
end
|
6387
|
+
|
6051
6388
|
# Gets historical metric data from the specified Amazon Connect
|
6052
6389
|
# instance.
|
6053
6390
|
#
|
@@ -6457,7 +6794,7 @@ module Aws::Connect
|
|
6457
6794
|
# `AGENT` \| `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
|
6458
6795
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
6459
6796
|
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
|
6460
|
-
# `FEATURE`
|
6797
|
+
# `FEATURE` \| `contact/segmentAttributes/connect:Subtype`
|
6461
6798
|
#
|
6462
6799
|
# * **Filter values**: A maximum of 100 filter values are supported in a
|
6463
6800
|
# single request. VOICE, CHAT, and TASK are valid `filterValue` for
|
@@ -6470,6 +6807,10 @@ module Aws::Connect
|
|
6470
6807
|
# the `FEATURE` filter key. It is available only to contacts analyzed
|
6471
6808
|
# by Contact Lens conversational analytics.
|
6472
6809
|
#
|
6810
|
+
# `connect:Chat`, `connect:SMS`, `connect:Telephony`, and
|
6811
|
+
# `connect:WebRTC` are valid `filterValue` examples (not exhaustive)
|
6812
|
+
# for the `contact/segmentAttributes/connect:Subtype filter` key.
|
6813
|
+
#
|
6473
6814
|
#
|
6474
6815
|
#
|
6475
6816
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
|
@@ -6485,7 +6826,8 @@ module Aws::Connect
|
|
6485
6826
|
# Valid grouping keys: `QUEUE` \| `ROUTING_PROFILE` \| `AGENT` \|
|
6486
6827
|
# `CHANNEL` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
|
6487
6828
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
6488
|
-
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE
|
6829
|
+
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE`,
|
6830
|
+
# `contact/segmentAttributes/connect:Subtype`
|
6489
6831
|
#
|
6490
6832
|
# @option params [required, Array<Types::MetricV2>] :metrics
|
6491
6833
|
# The metrics to retrieve. Specify the name, groupings, and filters for
|
@@ -6498,7 +6840,7 @@ module Aws::Connect
|
|
6498
6840
|
# : Unit: Percent
|
6499
6841
|
#
|
6500
6842
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6501
|
-
# Agent Hierarchy
|
6843
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6502
6844
|
#
|
6503
6845
|
# AGENT\_ADHERENT\_TIME
|
6504
6846
|
#
|
@@ -6510,6 +6852,20 @@ module Aws::Connect
|
|
6510
6852
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6511
6853
|
# Agent Hierarchy
|
6512
6854
|
#
|
6855
|
+
# AGENT\_ANSWER\_RATE
|
6856
|
+
#
|
6857
|
+
# : Unit: Percent
|
6858
|
+
#
|
6859
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6860
|
+
# Agent Hierarchy
|
6861
|
+
#
|
6862
|
+
# AGENT\_NON\_ADHERENT\_TIME
|
6863
|
+
#
|
6864
|
+
# : Unit: Seconds
|
6865
|
+
#
|
6866
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6867
|
+
# Agent Hierarchy
|
6868
|
+
#
|
6513
6869
|
# AGENT\_NON\_RESPONSE
|
6514
6870
|
#
|
6515
6871
|
# : Unit: Count
|
@@ -6558,14 +6914,16 @@ module Aws::Connect
|
|
6558
6914
|
# : Unit: Seconds
|
6559
6915
|
#
|
6560
6916
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6561
|
-
# Agent Hierarchy
|
6917
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6562
6918
|
#
|
6563
6919
|
# AVG\_AFTER\_CONTACT\_WORK\_TIME
|
6564
6920
|
#
|
6565
6921
|
# : Unit: Seconds
|
6566
6922
|
#
|
6923
|
+
# Valid metric filter key: `INITIATION_METHOD`
|
6924
|
+
#
|
6567
6925
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6568
|
-
# Agent Hierarchy, Feature
|
6926
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6569
6927
|
#
|
6570
6928
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6571
6929
|
#
|
@@ -6592,7 +6950,7 @@ module Aws::Connect
|
|
6592
6950
|
# : Unit: Seconds
|
6593
6951
|
#
|
6594
6952
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6595
|
-
# Agent Hierarchy, Feature
|
6953
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6596
6954
|
#
|
6597
6955
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6598
6956
|
#
|
@@ -6603,7 +6961,7 @@ module Aws::Connect
|
|
6603
6961
|
# : Unit: Seconds
|
6604
6962
|
#
|
6605
6963
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6606
|
-
# Agent Hierarchy
|
6964
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6607
6965
|
#
|
6608
6966
|
# AVG\_GREETING\_TIME\_AGENT
|
6609
6967
|
#
|
@@ -6613,14 +6971,14 @@ module Aws::Connect
|
|
6613
6971
|
# Unit: Seconds
|
6614
6972
|
#
|
6615
6973
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6616
|
-
# Agent Hierarchy
|
6974
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6617
6975
|
#
|
6618
6976
|
# AVG\_HANDLE\_TIME
|
6619
6977
|
#
|
6620
6978
|
# : Unit: Seconds
|
6621
6979
|
#
|
6622
6980
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6623
|
-
# Agent Hierarchy, Feature
|
6981
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6624
6982
|
#
|
6625
6983
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6626
6984
|
#
|
@@ -6631,7 +6989,7 @@ module Aws::Connect
|
|
6631
6989
|
# : Unit: Seconds
|
6632
6990
|
#
|
6633
6991
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6634
|
-
# Agent Hierarchy, Feature
|
6992
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6635
6993
|
#
|
6636
6994
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6637
6995
|
#
|
@@ -6642,14 +7000,14 @@ module Aws::Connect
|
|
6642
7000
|
# : Unit: Seconds
|
6643
7001
|
#
|
6644
7002
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6645
|
-
# Agent Hierarchy
|
7003
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6646
7004
|
#
|
6647
7005
|
# AVG\_HOLDS
|
6648
7006
|
#
|
6649
7007
|
# : Unit: Count
|
6650
7008
|
#
|
6651
7009
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6652
|
-
# Agent Hierarchy, Feature
|
7010
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6653
7011
|
#
|
6654
7012
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6655
7013
|
#
|
@@ -6660,14 +7018,16 @@ module Aws::Connect
|
|
6660
7018
|
# : Unit: Seconds
|
6661
7019
|
#
|
6662
7020
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6663
|
-
# Agent Hierarchy
|
7021
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6664
7022
|
#
|
6665
7023
|
# AVG\_INTERACTION\_TIME
|
6666
7024
|
#
|
6667
7025
|
# : Unit: Seconds
|
6668
7026
|
#
|
7027
|
+
# Valid metric filter key: `INITIATION_METHOD`
|
7028
|
+
#
|
6669
7029
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6670
|
-
# Feature
|
7030
|
+
# Feature, contact/segmentAttributes/connect:Subtype
|
6671
7031
|
#
|
6672
7032
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6673
7033
|
#
|
@@ -6681,7 +7041,7 @@ module Aws::Connect
|
|
6681
7041
|
# Unit: Count
|
6682
7042
|
#
|
6683
7043
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6684
|
-
# Agent Hierarchy
|
7044
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6685
7045
|
#
|
6686
7046
|
# AVG\_INTERRUPTION\_TIME\_AGENT
|
6687
7047
|
#
|
@@ -6691,7 +7051,7 @@ module Aws::Connect
|
|
6691
7051
|
# Unit: Seconds
|
6692
7052
|
#
|
6693
7053
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6694
|
-
# Agent Hierarchy
|
7054
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6695
7055
|
#
|
6696
7056
|
# AVG\_NON\_TALK\_TIME
|
6697
7057
|
#
|
@@ -6701,14 +7061,14 @@ module Aws::Connect
|
|
6701
7061
|
# Unit: Seconds
|
6702
7062
|
#
|
6703
7063
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6704
|
-
# Agent Hierarchy
|
7064
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6705
7065
|
#
|
6706
7066
|
# AVG\_QUEUE\_ANSWER\_TIME
|
6707
7067
|
#
|
6708
7068
|
# : Unit: Seconds
|
6709
7069
|
#
|
6710
7070
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6711
|
-
# Feature
|
7071
|
+
# Feature, contact/segmentAttributes/connect:Subtype
|
6712
7072
|
#
|
6713
7073
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6714
7074
|
#
|
@@ -6718,7 +7078,8 @@ module Aws::Connect
|
|
6718
7078
|
#
|
6719
7079
|
# : Unit: Seconds
|
6720
7080
|
#
|
6721
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile
|
7081
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7082
|
+
# contact/segmentAttributes/connect:Subtype
|
6722
7083
|
#
|
6723
7084
|
# AVG\_TALK\_TIME
|
6724
7085
|
#
|
@@ -6728,7 +7089,7 @@ module Aws::Connect
|
|
6728
7089
|
# Unit: Seconds
|
6729
7090
|
#
|
6730
7091
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6731
|
-
# Agent Hierarchy
|
7092
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6732
7093
|
#
|
6733
7094
|
# AVG\_TALK\_TIME\_AGENT
|
6734
7095
|
#
|
@@ -6738,7 +7099,7 @@ module Aws::Connect
|
|
6738
7099
|
# Unit: Seconds
|
6739
7100
|
#
|
6740
7101
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6741
|
-
# Agent Hierarchy
|
7102
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6742
7103
|
#
|
6743
7104
|
# AVG\_TALK\_TIME\_CUSTOMER
|
6744
7105
|
#
|
@@ -6748,14 +7109,14 @@ module Aws::Connect
|
|
6748
7109
|
# Unit: Seconds
|
6749
7110
|
#
|
6750
7111
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6751
|
-
# Agent Hierarchy
|
7112
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6752
7113
|
#
|
6753
7114
|
# CONTACTS\_ABANDONED
|
6754
7115
|
#
|
6755
7116
|
# : Unit: Count
|
6756
7117
|
#
|
6757
7118
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6758
|
-
# Agent Hierarchy
|
7119
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6759
7120
|
#
|
6760
7121
|
# CONTACTS\_CREATED
|
6761
7122
|
#
|
@@ -6764,7 +7125,7 @@ module Aws::Connect
|
|
6764
7125
|
# Valid metric filter key: `INITIATION_METHOD`
|
6765
7126
|
#
|
6766
7127
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
6767
|
-
# Feature
|
7128
|
+
# Feature, contact/segmentAttributes/connect:Subtype
|
6768
7129
|
#
|
6769
7130
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6770
7131
|
#
|
@@ -6777,7 +7138,7 @@ module Aws::Connect
|
|
6777
7138
|
# Valid metric filter key: `INITIATION_METHOD`, `DISCONNECT_REASON`
|
6778
7139
|
#
|
6779
7140
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6780
|
-
# Agent Hierarchy, Feature
|
7141
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
6781
7142
|
#
|
6782
7143
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6783
7144
|
#
|
@@ -6788,56 +7149,92 @@ module Aws::Connect
|
|
6788
7149
|
# : Unit: Count
|
6789
7150
|
#
|
6790
7151
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6791
|
-
# Agent Hierarchy
|
7152
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6792
7153
|
#
|
6793
|
-
# CONTACTS\
|
7154
|
+
# CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
|
6794
7155
|
#
|
6795
7156
|
# : Unit: Count
|
6796
7157
|
#
|
6797
7158
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6798
7159
|
# Agent Hierarchy
|
6799
7160
|
#
|
6800
|
-
# CONTACTS\
|
7161
|
+
# CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
|
6801
7162
|
#
|
6802
7163
|
# : Unit: Count
|
6803
7164
|
#
|
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").
|
7165
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7166
|
+
# Agent Hierarchy
|
6809
7167
|
#
|
6810
|
-
# CONTACTS\
|
7168
|
+
# CONTACTS\_PUT\_ON\_HOLD
|
6811
7169
|
#
|
6812
7170
|
# : Unit: Count
|
6813
7171
|
#
|
6814
7172
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6815
|
-
# Agent Hierarchy
|
6816
|
-
#
|
6817
|
-
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
6818
|
-
#
|
6819
|
-
# </note>
|
7173
|
+
# Agent Hierarchy
|
6820
7174
|
#
|
6821
|
-
# CONTACTS\_TRANSFERRED\_OUT\
|
7175
|
+
# CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
|
6822
7176
|
#
|
6823
7177
|
# : Unit: Count
|
6824
7178
|
#
|
6825
7179
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6826
7180
|
# Agent Hierarchy
|
6827
7181
|
#
|
6828
|
-
# CONTACTS\_TRANSFERRED\_OUT\
|
7182
|
+
# CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
|
6829
7183
|
#
|
6830
|
-
# : Unit:
|
7184
|
+
# : Unit: Percent
|
6831
7185
|
#
|
6832
7186
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6833
7187
|
# Agent Hierarchy
|
6834
7188
|
#
|
6835
|
-
#
|
7189
|
+
# CONTACTS\_QUEUED
|
7190
|
+
#
|
7191
|
+
# : Unit: Count
|
7192
|
+
#
|
7193
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7194
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
7195
|
+
#
|
7196
|
+
# CONTACTS\_RESOLVED\_IN\_X
|
7197
|
+
#
|
7198
|
+
# : Unit: Count
|
7199
|
+
#
|
7200
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7201
|
+
# contact/segmentAttributes/connect:Subtype
|
7202
|
+
#
|
7203
|
+
# Threshold: For `ThresholdValue` enter any whole number from 1 to
|
7204
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
7205
|
+
# `LT` (for "Less than").
|
7206
|
+
#
|
7207
|
+
# CONTACTS\_TRANSFERRED\_OUT
|
7208
|
+
#
|
7209
|
+
# : Unit: Count
|
7210
|
+
#
|
7211
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7212
|
+
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
|
7213
|
+
#
|
7214
|
+
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7215
|
+
#
|
7216
|
+
# </note>
|
7217
|
+
#
|
7218
|
+
# CONTACTS\_TRANSFERRED\_OUT\_BY\_AGENT
|
7219
|
+
#
|
7220
|
+
# : Unit: Count
|
7221
|
+
#
|
7222
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7223
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
7224
|
+
#
|
7225
|
+
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
7226
|
+
#
|
7227
|
+
# : Unit: Count
|
7228
|
+
#
|
7229
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7230
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
7231
|
+
#
|
7232
|
+
# MAX\_QUEUED\_TIME
|
6836
7233
|
#
|
6837
7234
|
# : Unit: Seconds
|
6838
7235
|
#
|
6839
7236
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6840
|
-
# Agent Hierarchy
|
7237
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6841
7238
|
#
|
6842
7239
|
# PERCENT\_NON\_TALK\_TIME
|
6843
7240
|
#
|
@@ -6847,7 +7244,7 @@ module Aws::Connect
|
|
6847
7244
|
# Unit: Percentage
|
6848
7245
|
#
|
6849
7246
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6850
|
-
# Agent Hierarchy
|
7247
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6851
7248
|
#
|
6852
7249
|
# PERCENT\_TALK\_TIME
|
6853
7250
|
#
|
@@ -6857,7 +7254,7 @@ module Aws::Connect
|
|
6857
7254
|
# Unit: Percentage
|
6858
7255
|
#
|
6859
7256
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6860
|
-
# Agent Hierarchy
|
7257
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6861
7258
|
#
|
6862
7259
|
# PERCENT\_TALK\_TIME\_AGENT
|
6863
7260
|
#
|
@@ -6867,7 +7264,7 @@ module Aws::Connect
|
|
6867
7264
|
# Unit: Percentage
|
6868
7265
|
#
|
6869
7266
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6870
|
-
# Agent Hierarchy
|
7267
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6871
7268
|
#
|
6872
7269
|
# PERCENT\_TALK\_TIME\_CUSTOMER
|
6873
7270
|
#
|
@@ -6877,7 +7274,7 @@ module Aws::Connect
|
|
6877
7274
|
# Unit: Percentage
|
6878
7275
|
#
|
6879
7276
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
6880
|
-
# Agent Hierarchy
|
7277
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
6881
7278
|
#
|
6882
7279
|
# SERVICE\_LEVEL
|
6883
7280
|
#
|
@@ -6891,11 +7288,49 @@ module Aws::Connect
|
|
6891
7288
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
6892
7289
|
# `LT` (for "Less than").
|
6893
7290
|
#
|
7291
|
+
# SUM\_AFTER\_CONTACT\_WORK\_TIME
|
7292
|
+
#
|
7293
|
+
# : Unit: Seconds
|
7294
|
+
#
|
7295
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7296
|
+
# Agent Hierarchy
|
7297
|
+
#
|
7298
|
+
# SUM\_CONNECTING\_TIME\_AGENT
|
7299
|
+
#
|
7300
|
+
# : Unit: Seconds
|
7301
|
+
#
|
7302
|
+
# Valid metric filter key: `INITIATION_METHOD`. This metric only
|
7303
|
+
# supports the following filter keys as `INITIATION_METHOD`: `INBOUND`
|
7304
|
+
# \| `OUTBOUND` \| `CALLBACK` \| `API`
|
7305
|
+
#
|
7306
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7307
|
+
# Agent Hierarchy
|
7308
|
+
#
|
7309
|
+
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
|
7310
|
+
# metric.
|
7311
|
+
#
|
7312
|
+
# </note>
|
7313
|
+
#
|
7314
|
+
# SUM\_CONTACT\_FLOW\_TIME
|
7315
|
+
#
|
7316
|
+
# : Unit: Seconds
|
7317
|
+
#
|
7318
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7319
|
+
# Agent Hierarchy
|
7320
|
+
#
|
7321
|
+
# SUM\_CONTACT\_TIME\_AGENT
|
7322
|
+
#
|
7323
|
+
# : Unit: Seconds
|
7324
|
+
#
|
7325
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7326
|
+
# Agent Hierarchy
|
7327
|
+
#
|
6894
7328
|
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
6895
7329
|
#
|
6896
7330
|
# : Unit: Count
|
6897
7331
|
#
|
6898
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile
|
7332
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7333
|
+
# contact/segmentAttributes/connect:Subtype
|
6899
7334
|
#
|
6900
7335
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
6901
7336
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
@@ -6905,7 +7340,8 @@ module Aws::Connect
|
|
6905
7340
|
#
|
6906
7341
|
# : Unit: Count
|
6907
7342
|
#
|
6908
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile
|
7343
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7344
|
+
# contact/segmentAttributes/connect:Subtype
|
6909
7345
|
#
|
6910
7346
|
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
6911
7347
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
@@ -6917,13 +7353,68 @@ module Aws::Connect
|
|
6917
7353
|
#
|
6918
7354
|
# Unit: Count
|
6919
7355
|
#
|
6920
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile
|
7356
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7357
|
+
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype
|
7358
|
+
#
|
7359
|
+
# SUM\_ERROR\_STATUS\_TIME\_AGENT
|
7360
|
+
#
|
7361
|
+
# : Unit: Seconds
|
7362
|
+
#
|
7363
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7364
|
+
# Agent Hierarchy
|
7365
|
+
#
|
7366
|
+
# SUM\_HANDLE\_TIME
|
7367
|
+
#
|
7368
|
+
# : Unit: Seconds
|
7369
|
+
#
|
7370
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7371
|
+
# Agent Hierarchy
|
7372
|
+
#
|
7373
|
+
# SUM\_HOLD\_TIME
|
7374
|
+
#
|
7375
|
+
# : Unit: Count
|
7376
|
+
#
|
7377
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7378
|
+
# Agent Hierarchy
|
7379
|
+
#
|
7380
|
+
# SUM\_IDLE\_TIME\_AGENT
|
7381
|
+
#
|
7382
|
+
# : Unit: Seconds
|
7383
|
+
#
|
7384
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
7385
|
+
#
|
7386
|
+
# SUM\_INTERACTION\_AND\_HOLD\_TIME
|
7387
|
+
#
|
7388
|
+
# : Unit: Seconds
|
7389
|
+
#
|
7390
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7391
|
+
# Agent Hierarchy
|
7392
|
+
#
|
7393
|
+
# SUM\_INTERACTION\_TIME
|
7394
|
+
#
|
7395
|
+
# : Unit: Seconds
|
7396
|
+
#
|
7397
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
7398
|
+
# Agent Hierarchy
|
7399
|
+
#
|
7400
|
+
# SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
|
7401
|
+
#
|
7402
|
+
# : Unit: Seconds
|
7403
|
+
#
|
7404
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
7405
|
+
#
|
7406
|
+
# SUM\_ONLINE\_TIME\_AGENT
|
7407
|
+
#
|
7408
|
+
# : Unit: Seconds
|
7409
|
+
#
|
7410
|
+
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
6921
7411
|
#
|
6922
7412
|
# SUM\_RETRY\_CALLBACK\_ATTEMPTS
|
6923
7413
|
#
|
6924
7414
|
# : Unit: Count
|
6925
7415
|
#
|
6926
|
-
# Valid groupings and filters: Queue, Channel, Routing Profile
|
7416
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7417
|
+
# contact/segmentAttributes/connect:Subtype
|
6927
7418
|
#
|
6928
7419
|
#
|
6929
7420
|
#
|
@@ -7178,6 +7669,76 @@ module Aws::Connect
|
|
7178
7669
|
req.send_request(options)
|
7179
7670
|
end
|
7180
7671
|
|
7672
|
+
# Imports a claimed phone number from an external service, such as
|
7673
|
+
# Amazon Pinpoint, into an Amazon Connect instance. You can call this
|
7674
|
+
# API only in the same Amazon Web Services Region where the Amazon
|
7675
|
+
# Connect instance was created.
|
7676
|
+
#
|
7677
|
+
# @option params [required, String] :instance_id
|
7678
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
7679
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
7680
|
+
#
|
7681
|
+
#
|
7682
|
+
#
|
7683
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
7684
|
+
#
|
7685
|
+
# @option params [required, String] :source_phone_number_arn
|
7686
|
+
# The claimed phone number ARN being imported from the external service,
|
7687
|
+
# such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like
|
7688
|
+
# the ARN of the phone number to import from Amazon Pinpoint.
|
7689
|
+
#
|
7690
|
+
# @option params [String] :phone_number_description
|
7691
|
+
# The description of the phone number.
|
7692
|
+
#
|
7693
|
+
# @option params [Hash<String,String>] :tags
|
7694
|
+
# The tags used to organize, track, or control access for this resource.
|
7695
|
+
# For example, \\\{ "tags": \\\{"key1":"value1",
|
7696
|
+
# "key2":"value2"\\} \\}.
|
7697
|
+
#
|
7698
|
+
# @option params [String] :client_token
|
7699
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
7700
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
7701
|
+
# SDK populates this field. For more information about idempotency, see
|
7702
|
+
# [Making retries safe with idempotent APIs][1].
|
7703
|
+
#
|
7704
|
+
# **A suitable default value is auto-generated.** You should normally
|
7705
|
+
# not need to pass this option.**
|
7706
|
+
#
|
7707
|
+
#
|
7708
|
+
#
|
7709
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
7710
|
+
#
|
7711
|
+
# @return [Types::ImportPhoneNumberResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7712
|
+
#
|
7713
|
+
# * {Types::ImportPhoneNumberResponse#phone_number_id #phone_number_id} => String
|
7714
|
+
# * {Types::ImportPhoneNumberResponse#phone_number_arn #phone_number_arn} => String
|
7715
|
+
#
|
7716
|
+
# @example Request syntax with placeholder values
|
7717
|
+
#
|
7718
|
+
# resp = client.import_phone_number({
|
7719
|
+
# instance_id: "InstanceId", # required
|
7720
|
+
# source_phone_number_arn: "ARN", # required
|
7721
|
+
# phone_number_description: "PhoneNumberDescription",
|
7722
|
+
# tags: {
|
7723
|
+
# "TagKey" => "TagValue",
|
7724
|
+
# },
|
7725
|
+
# client_token: "ClientToken",
|
7726
|
+
# })
|
7727
|
+
#
|
7728
|
+
# @example Response structure
|
7729
|
+
#
|
7730
|
+
# resp.phone_number_id #=> String
|
7731
|
+
# resp.phone_number_arn #=> String
|
7732
|
+
#
|
7733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ImportPhoneNumber AWS API Documentation
|
7734
|
+
#
|
7735
|
+
# @overload import_phone_number(params = {})
|
7736
|
+
# @param [Hash] params ({})
|
7737
|
+
def import_phone_number(params = {}, options = {})
|
7738
|
+
req = build_request(:import_phone_number, params)
|
7739
|
+
req.send_request(options)
|
7740
|
+
end
|
7741
|
+
|
7181
7742
|
# This API is in preview release for Amazon Connect and is subject to
|
7182
7743
|
# change.
|
7183
7744
|
#
|
@@ -7238,6 +7799,63 @@ module Aws::Connect
|
|
7238
7799
|
req.send_request(options)
|
7239
7800
|
end
|
7240
7801
|
|
7802
|
+
# This API is in preview release for Amazon Connect and is subject to
|
7803
|
+
# change.
|
7804
|
+
#
|
7805
|
+
# Lists the association status of requested dataset ID for a given
|
7806
|
+
# Amazon Connect instance.
|
7807
|
+
#
|
7808
|
+
# @option params [required, String] :instance_id
|
7809
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
7810
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
7811
|
+
#
|
7812
|
+
#
|
7813
|
+
#
|
7814
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
7815
|
+
#
|
7816
|
+
# @option params [String] :data_set_id
|
7817
|
+
# The identifier of the dataset to get the association status.
|
7818
|
+
#
|
7819
|
+
# @option params [String] :next_token
|
7820
|
+
# The token for the next set of results. Use the value returned in the
|
7821
|
+
# previous response in the next request to retrieve the next set of
|
7822
|
+
# results.
|
7823
|
+
#
|
7824
|
+
# @option params [Integer] :max_results
|
7825
|
+
# The maximum number of results to return per page.
|
7826
|
+
#
|
7827
|
+
# @return [Types::ListAnalyticsDataAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7828
|
+
#
|
7829
|
+
# * {Types::ListAnalyticsDataAssociationsResponse#results #results} => Array<Types::AnalyticsDataAssociationResult>
|
7830
|
+
# * {Types::ListAnalyticsDataAssociationsResponse#next_token #next_token} => String
|
7831
|
+
#
|
7832
|
+
# @example Request syntax with placeholder values
|
7833
|
+
#
|
7834
|
+
# resp = client.list_analytics_data_associations({
|
7835
|
+
# instance_id: "InstanceId", # required
|
7836
|
+
# data_set_id: "DataSetId",
|
7837
|
+
# next_token: "NextToken",
|
7838
|
+
# max_results: 1,
|
7839
|
+
# })
|
7840
|
+
#
|
7841
|
+
# @example Response structure
|
7842
|
+
#
|
7843
|
+
# resp.results #=> Array
|
7844
|
+
# resp.results[0].data_set_id #=> String
|
7845
|
+
# resp.results[0].target_account_id #=> String
|
7846
|
+
# resp.results[0].resource_share_id #=> String
|
7847
|
+
# resp.results[0].resource_share_arn #=> String
|
7848
|
+
# resp.next_token #=> String
|
7849
|
+
#
|
7850
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListAnalyticsDataAssociations AWS API Documentation
|
7851
|
+
#
|
7852
|
+
# @overload list_analytics_data_associations(params = {})
|
7853
|
+
# @param [Hash] params ({})
|
7854
|
+
def list_analytics_data_associations(params = {}, options = {})
|
7855
|
+
req = build_request(:list_analytics_data_associations, params)
|
7856
|
+
req.send_request(options)
|
7857
|
+
end
|
7858
|
+
|
7241
7859
|
# This API is in preview release for Amazon Connect and is subject to
|
7242
7860
|
# change.
|
7243
7861
|
#
|
@@ -7787,6 +8405,60 @@ module Aws::Connect
|
|
7787
8405
|
req.send_request(options)
|
7788
8406
|
end
|
7789
8407
|
|
8408
|
+
# List the flow association based on the filters.
|
8409
|
+
#
|
8410
|
+
# @option params [required, String] :instance_id
|
8411
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
8412
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
8413
|
+
#
|
8414
|
+
#
|
8415
|
+
#
|
8416
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
8417
|
+
#
|
8418
|
+
# @option params [String] :resource_type
|
8419
|
+
# A valid resource type.
|
8420
|
+
#
|
8421
|
+
# @option params [String] :next_token
|
8422
|
+
# The token for the next set of results. Use the value returned in the
|
8423
|
+
# previous response in the next request to retrieve the next set of
|
8424
|
+
# results.
|
8425
|
+
#
|
8426
|
+
# @option params [Integer] :max_results
|
8427
|
+
# The maximum number of results to return per page.
|
8428
|
+
#
|
8429
|
+
# @return [Types::ListFlowAssociationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8430
|
+
#
|
8431
|
+
# * {Types::ListFlowAssociationsResponse#flow_association_summary_list #flow_association_summary_list} => Array<Types::FlowAssociationSummary>
|
8432
|
+
# * {Types::ListFlowAssociationsResponse#next_token #next_token} => String
|
8433
|
+
#
|
8434
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
8435
|
+
#
|
8436
|
+
# @example Request syntax with placeholder values
|
8437
|
+
#
|
8438
|
+
# resp = client.list_flow_associations({
|
8439
|
+
# instance_id: "InstanceId", # required
|
8440
|
+
# resource_type: "VOICE_PHONE_NUMBER", # accepts VOICE_PHONE_NUMBER
|
8441
|
+
# next_token: "NextToken",
|
8442
|
+
# max_results: 1,
|
8443
|
+
# })
|
8444
|
+
#
|
8445
|
+
# @example Response structure
|
8446
|
+
#
|
8447
|
+
# resp.flow_association_summary_list #=> Array
|
8448
|
+
# resp.flow_association_summary_list[0].resource_id #=> String
|
8449
|
+
# resp.flow_association_summary_list[0].flow_id #=> String
|
8450
|
+
# resp.flow_association_summary_list[0].resource_type #=> String, one of "VOICE_PHONE_NUMBER"
|
8451
|
+
# resp.next_token #=> String
|
8452
|
+
#
|
8453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListFlowAssociations AWS API Documentation
|
8454
|
+
#
|
8455
|
+
# @overload list_flow_associations(params = {})
|
8456
|
+
# @param [Hash] params ({})
|
8457
|
+
def list_flow_associations(params = {}, options = {})
|
8458
|
+
req = build_request(:list_flow_associations, params)
|
8459
|
+
req.send_request(options)
|
8460
|
+
end
|
8461
|
+
|
7790
8462
|
# Provides information about the hours of operation for the specified
|
7791
8463
|
# Amazon Connect instance.
|
7792
8464
|
#
|
@@ -8267,7 +8939,7 @@ module Aws::Connect
|
|
8267
8939
|
#
|
8268
8940
|
# resp = client.list_phone_numbers({
|
8269
8941
|
# instance_id: "InstanceId", # required
|
8270
|
-
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID
|
8942
|
+
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
|
8271
8943
|
# 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
8944
|
# next_token: "NextToken",
|
8273
8945
|
# max_results: 1,
|
@@ -8279,7 +8951,7 @@ module Aws::Connect
|
|
8279
8951
|
# resp.phone_number_summary_list[0].id #=> String
|
8280
8952
|
# resp.phone_number_summary_list[0].arn #=> String
|
8281
8953
|
# 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"
|
8954
|
+
# 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
8955
|
# 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
8956
|
# resp.next_token #=> String
|
8285
8957
|
#
|
@@ -8367,7 +9039,7 @@ module Aws::Connect
|
|
8367
9039
|
# max_results: 1,
|
8368
9040
|
# next_token: "LargeNextToken",
|
8369
9041
|
# 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
|
9042
|
+
# phone_number_types: ["TOLL_FREE"], # accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
|
8371
9043
|
# phone_number_prefix: "PhoneNumberPrefix",
|
8372
9044
|
# })
|
8373
9045
|
#
|
@@ -8379,9 +9051,11 @@ module Aws::Connect
|
|
8379
9051
|
# resp.list_phone_numbers_summary_list[0].phone_number_arn #=> String
|
8380
9052
|
# resp.list_phone_numbers_summary_list[0].phone_number #=> String
|
8381
9053
|
# 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"
|
9054
|
+
# 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
9055
|
# resp.list_phone_numbers_summary_list[0].target_arn #=> String
|
8384
9056
|
# resp.list_phone_numbers_summary_list[0].instance_id #=> String
|
9057
|
+
# resp.list_phone_numbers_summary_list[0].phone_number_description #=> String
|
9058
|
+
# resp.list_phone_numbers_summary_list[0].source_phone_number_arn #=> String
|
8385
9059
|
#
|
8386
9060
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListPhoneNumbersV2 AWS API Documentation
|
8387
9061
|
#
|
@@ -8598,8 +9272,8 @@ module Aws::Connect
|
|
8598
9272
|
# MaxResult size is 100.
|
8599
9273
|
#
|
8600
9274
|
# @option params [Array<String>] :quick_connect_types
|
8601
|
-
# The type of quick connect. In the Amazon Connect
|
8602
|
-
# create a quick connect, you are prompted to assign one of the
|
9275
|
+
# The type of quick connect. In the Amazon Connect admin website, when
|
9276
|
+
# you create a quick connect, you are prompted to assign one of the
|
8603
9277
|
# following types: Agent (USER), External (PHONE\_NUMBER), or Queue
|
8604
9278
|
# (QUEUE).
|
8605
9279
|
#
|
@@ -8639,6 +9313,111 @@ module Aws::Connect
|
|
8639
9313
|
req.send_request(options)
|
8640
9314
|
end
|
8641
9315
|
|
9316
|
+
# Provides a list of analysis segments for a real-time analysis session.
|
9317
|
+
#
|
9318
|
+
# @option params [required, String] :instance_id
|
9319
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
9320
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
9321
|
+
#
|
9322
|
+
#
|
9323
|
+
#
|
9324
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
9325
|
+
#
|
9326
|
+
# @option params [required, String] :contact_id
|
9327
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9328
|
+
#
|
9329
|
+
# @option params [Integer] :max_results
|
9330
|
+
# The maximum number of results to return per page.
|
9331
|
+
#
|
9332
|
+
# @option params [String] :next_token
|
9333
|
+
# The token for the next set of results. Use the value returned in the
|
9334
|
+
# previous response in the next request to retrieve the next set of
|
9335
|
+
# results.
|
9336
|
+
#
|
9337
|
+
# @option params [required, String] :output_type
|
9338
|
+
# The Contact Lens output type to be returned.
|
9339
|
+
#
|
9340
|
+
# @option params [required, Array<String>] :segment_types
|
9341
|
+
# Enum with segment types . Each value corresponds to a segment type
|
9342
|
+
# returned in the segments list of the API. Each segment type has its
|
9343
|
+
# own structure. Different channels may have different sets of supported
|
9344
|
+
# segment types.
|
9345
|
+
#
|
9346
|
+
# @return [Types::ListRealtimeContactAnalysisSegmentsV2Response] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9347
|
+
#
|
9348
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsV2Response#channel #channel} => String
|
9349
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsV2Response#status #status} => String
|
9350
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsV2Response#segments #segments} => Array<Types::RealtimeContactAnalysisSegment>
|
9351
|
+
# * {Types::ListRealtimeContactAnalysisSegmentsV2Response#next_token #next_token} => String
|
9352
|
+
#
|
9353
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
9354
|
+
#
|
9355
|
+
# @example Request syntax with placeholder values
|
9356
|
+
#
|
9357
|
+
# resp = client.list_realtime_contact_analysis_segments_v2({
|
9358
|
+
# instance_id: "InstanceId", # required
|
9359
|
+
# contact_id: "ContactId", # required
|
9360
|
+
# max_results: 1,
|
9361
|
+
# next_token: "LargeNextToken",
|
9362
|
+
# output_type: "Raw", # required, accepts Raw, Redacted
|
9363
|
+
# segment_types: ["Transcript"], # required, accepts Transcript, Categories, Issues, Event, Attachments
|
9364
|
+
# })
|
9365
|
+
#
|
9366
|
+
# @example Response structure
|
9367
|
+
#
|
9368
|
+
# resp.channel #=> String, one of "VOICE", "CHAT"
|
9369
|
+
# resp.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
|
9370
|
+
# resp.segments #=> Array
|
9371
|
+
# resp.segments[0].transcript.id #=> String
|
9372
|
+
# resp.segments[0].transcript.participant_id #=> String
|
9373
|
+
# resp.segments[0].transcript.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
|
9374
|
+
# resp.segments[0].transcript.display_name #=> String
|
9375
|
+
# resp.segments[0].transcript.content #=> String
|
9376
|
+
# resp.segments[0].transcript.content_type #=> String
|
9377
|
+
# resp.segments[0].transcript.time.absolute_time #=> Time
|
9378
|
+
# resp.segments[0].transcript.redaction.character_offsets #=> Array
|
9379
|
+
# resp.segments[0].transcript.redaction.character_offsets[0].begin_offset_char #=> Integer
|
9380
|
+
# resp.segments[0].transcript.redaction.character_offsets[0].end_offset_char #=> Integer
|
9381
|
+
# resp.segments[0].transcript.sentiment #=> String, one of "POSITIVE", "NEGATIVE", "NEUTRAL"
|
9382
|
+
# resp.segments[0].categories.matched_details #=> Hash
|
9383
|
+
# resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest #=> Array
|
9384
|
+
# resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items #=> Array
|
9385
|
+
# resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].id #=> String
|
9386
|
+
# resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
|
9387
|
+
# resp.segments[0].categories.matched_details["RealTimeContactAnalysisCategoryName"].points_of_interest[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
|
9388
|
+
# resp.segments[0].issues.issues_detected #=> Array
|
9389
|
+
# resp.segments[0].issues.issues_detected[0].transcript_items #=> Array
|
9390
|
+
# resp.segments[0].issues.issues_detected[0].transcript_items[0].content #=> String
|
9391
|
+
# resp.segments[0].issues.issues_detected[0].transcript_items[0].id #=> String
|
9392
|
+
# resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.begin_offset_char #=> Integer
|
9393
|
+
# resp.segments[0].issues.issues_detected[0].transcript_items[0].character_offsets.end_offset_char #=> Integer
|
9394
|
+
# resp.segments[0].event.id #=> String
|
9395
|
+
# resp.segments[0].event.participant_id #=> String
|
9396
|
+
# resp.segments[0].event.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
|
9397
|
+
# resp.segments[0].event.display_name #=> String
|
9398
|
+
# resp.segments[0].event.event_type #=> String
|
9399
|
+
# resp.segments[0].event.time.absolute_time #=> Time
|
9400
|
+
# resp.segments[0].attachments.id #=> String
|
9401
|
+
# resp.segments[0].attachments.participant_id #=> String
|
9402
|
+
# resp.segments[0].attachments.participant_role #=> String, one of "AGENT", "CUSTOMER", "SYSTEM", "CUSTOM_BOT"
|
9403
|
+
# resp.segments[0].attachments.display_name #=> String
|
9404
|
+
# resp.segments[0].attachments.attachments #=> Array
|
9405
|
+
# resp.segments[0].attachments.attachments[0].attachment_name #=> String
|
9406
|
+
# resp.segments[0].attachments.attachments[0].content_type #=> String
|
9407
|
+
# resp.segments[0].attachments.attachments[0].attachment_id #=> String
|
9408
|
+
# resp.segments[0].attachments.attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
|
9409
|
+
# resp.segments[0].attachments.time.absolute_time #=> Time
|
9410
|
+
# resp.next_token #=> String
|
9411
|
+
#
|
9412
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2 AWS API Documentation
|
9413
|
+
#
|
9414
|
+
# @overload list_realtime_contact_analysis_segments_v2(params = {})
|
9415
|
+
# @param [Hash] params ({})
|
9416
|
+
def list_realtime_contact_analysis_segments_v2(params = {}, options = {})
|
9417
|
+
req = build_request(:list_realtime_contact_analysis_segments_v2, params)
|
9418
|
+
req.send_request(options)
|
9419
|
+
end
|
9420
|
+
|
8642
9421
|
# Lists the queues associated with a routing profile.
|
8643
9422
|
#
|
8644
9423
|
# @option params [required, String] :instance_id
|
@@ -8800,7 +9579,7 @@ module Aws::Connect
|
|
8800
9579
|
# resp = client.list_rules({
|
8801
9580
|
# instance_id: "InstanceId", # required
|
8802
9581
|
# publish_status: "DRAFT", # accepts DRAFT, PUBLISHED
|
8803
|
-
# event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
|
9582
|
+
# event_source_name: "OnPostCallAnalysisAvailable", # accepts OnPostCallAnalysisAvailable, OnRealTimeCallAnalysisAvailable, OnRealTimeChatAnalysisAvailable, OnPostChatAnalysisAvailable, OnZendeskTicketCreate, OnZendeskTicketStatusUpdate, OnSalesforceCaseCreate, OnContactEvaluationSubmit, OnMetricDataUpdate
|
8804
9583
|
# max_results: 1,
|
8805
9584
|
# next_token: "NextToken",
|
8806
9585
|
# })
|
@@ -8811,7 +9590,7 @@ module Aws::Connect
|
|
8811
9590
|
# resp.rule_summary_list[0].name #=> String
|
8812
9591
|
# resp.rule_summary_list[0].rule_id #=> String
|
8813
9592
|
# 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"
|
9593
|
+
# resp.rule_summary_list[0].event_source_name #=> String, one of "OnPostCallAnalysisAvailable", "OnRealTimeCallAnalysisAvailable", "OnRealTimeChatAnalysisAvailable", "OnPostChatAnalysisAvailable", "OnZendeskTicketCreate", "OnZendeskTicketStatusUpdate", "OnSalesforceCaseCreate", "OnContactEvaluationSubmit", "OnMetricDataUpdate"
|
8815
9594
|
# resp.rule_summary_list[0].publish_status #=> String, one of "DRAFT", "PUBLISHED"
|
8816
9595
|
# resp.rule_summary_list[0].action_summaries #=> Array
|
8817
9596
|
# 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 +10443,7 @@ module Aws::Connect
|
|
9664
10443
|
# the Amazon Web Services Region where the number was claimed.
|
9665
10444
|
#
|
9666
10445
|
# To release phone numbers from a traffic distribution group, use the
|
9667
|
-
# `ReleasePhoneNumber` API, not the Amazon Connect
|
10446
|
+
# `ReleasePhoneNumber` API, not the Amazon Connect admin website.
|
9668
10447
|
#
|
9669
10448
|
# After releasing a phone number, the phone number enters into a
|
9670
10449
|
# cooldown period of 30 days. It cannot be searched for or claimed again
|
@@ -9887,7 +10666,7 @@ module Aws::Connect
|
|
9887
10666
|
# target_arn: "ARN",
|
9888
10667
|
# instance_id: "InstanceId",
|
9889
10668
|
# 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
|
10669
|
+
# phone_number_type: "TOLL_FREE", # required, accepts TOLL_FREE, DID, UIFN, SHARED, THIRD_PARTY_TF, THIRD_PARTY_DID, SHORT_CODE
|
9891
10670
|
# phone_number_prefix: "PhoneNumberPrefix",
|
9892
10671
|
# max_results: 1,
|
9893
10672
|
# next_token: "LargeNextToken",
|
@@ -9899,7 +10678,7 @@ module Aws::Connect
|
|
9899
10678
|
# resp.available_numbers_list #=> Array
|
9900
10679
|
# resp.available_numbers_list[0].phone_number #=> String
|
9901
10680
|
# 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"
|
10681
|
+
# 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
10682
|
#
|
9904
10683
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAvailablePhoneNumbers AWS API Documentation
|
9905
10684
|
#
|
@@ -10847,6 +11626,90 @@ module Aws::Connect
|
|
10847
11626
|
req.send_request(options)
|
10848
11627
|
end
|
10849
11628
|
|
11629
|
+
# Processes chat integration events from Amazon Web Services or external
|
11630
|
+
# integrations to Amazon Connect. A chat integration event includes:
|
11631
|
+
#
|
11632
|
+
# * SourceId, DestinationId, and Subtype: a set of identifiers, uniquely
|
11633
|
+
# representing a chat
|
11634
|
+
#
|
11635
|
+
# * ChatEvent: details of the chat action to perform such as sending a
|
11636
|
+
# message, event, or disconnecting from a chat
|
11637
|
+
#
|
11638
|
+
# When a chat integration event is sent with chat identifiers that do
|
11639
|
+
# not map to an active chat contact, a new chat contact is also created
|
11640
|
+
# before handling chat action.
|
11641
|
+
#
|
11642
|
+
# Access to this API is currently restricted to Amazon Pinpoint for
|
11643
|
+
# supporting SMS integration.
|
11644
|
+
#
|
11645
|
+
# @option params [required, String] :source_id
|
11646
|
+
# External identifier of chat customer participant, used in part to
|
11647
|
+
# uniquely identify a chat. For SMS, this is the E164 phone number of
|
11648
|
+
# the chat customer participant.
|
11649
|
+
#
|
11650
|
+
# @option params [required, String] :destination_id
|
11651
|
+
# Chat system identifier, used in part to uniquely identify chat. This
|
11652
|
+
# is associated with the Amazon Connect instance and flow to be used to
|
11653
|
+
# start chats. For SMS, this is the phone number destination of inbound
|
11654
|
+
# SMS messages represented by an Amazon Pinpoint phone number ARN.
|
11655
|
+
#
|
11656
|
+
# @option params [String] :subtype
|
11657
|
+
# Classification of a channel. This is used in part to uniquely identify
|
11658
|
+
# chat.
|
11659
|
+
#
|
11660
|
+
# Valid value: `["connect:sms"]`
|
11661
|
+
#
|
11662
|
+
# @option params [required, Types::ChatEvent] :event
|
11663
|
+
# Chat integration event payload
|
11664
|
+
#
|
11665
|
+
# @option params [Types::NewSessionDetails] :new_session_details
|
11666
|
+
# Contact properties to apply when starting a new chat. If the
|
11667
|
+
# integration event is handled with an existing chat, this is ignored.
|
11668
|
+
#
|
11669
|
+
# @return [Types::SendChatIntegrationEventResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11670
|
+
#
|
11671
|
+
# * {Types::SendChatIntegrationEventResponse#initial_contact_id #initial_contact_id} => String
|
11672
|
+
# * {Types::SendChatIntegrationEventResponse#new_chat_created #new_chat_created} => Boolean
|
11673
|
+
#
|
11674
|
+
# @example Request syntax with placeholder values
|
11675
|
+
#
|
11676
|
+
# resp = client.send_chat_integration_event({
|
11677
|
+
# source_id: "SourceId", # required
|
11678
|
+
# destination_id: "DestinationId", # required
|
11679
|
+
# subtype: "Subtype",
|
11680
|
+
# event: { # required
|
11681
|
+
# type: "DISCONNECT", # required, accepts DISCONNECT, MESSAGE, EVENT
|
11682
|
+
# content_type: "ChatContentType",
|
11683
|
+
# content: "ChatContent",
|
11684
|
+
# },
|
11685
|
+
# new_session_details: {
|
11686
|
+
# supported_messaging_content_types: ["SupportedMessagingContentType"],
|
11687
|
+
# participant_details: {
|
11688
|
+
# display_name: "DisplayName", # required
|
11689
|
+
# },
|
11690
|
+
# attributes: {
|
11691
|
+
# "AttributeName" => "AttributeValue",
|
11692
|
+
# },
|
11693
|
+
# streaming_configuration: {
|
11694
|
+
# streaming_endpoint_arn: "ChatStreamingEndpointARN", # required
|
11695
|
+
# },
|
11696
|
+
# },
|
11697
|
+
# })
|
11698
|
+
#
|
11699
|
+
# @example Response structure
|
11700
|
+
#
|
11701
|
+
# resp.initial_contact_id #=> String
|
11702
|
+
# resp.new_chat_created #=> Boolean
|
11703
|
+
#
|
11704
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SendChatIntegrationEvent AWS API Documentation
|
11705
|
+
#
|
11706
|
+
# @overload send_chat_integration_event(params = {})
|
11707
|
+
# @param [Hash] params ({})
|
11708
|
+
def send_chat_integration_event(params = {}, options = {})
|
11709
|
+
req = build_request(:send_chat_integration_event, params)
|
11710
|
+
req.send_request(options)
|
11711
|
+
end
|
11712
|
+
|
10850
11713
|
# Initiates a flow to start a new chat for the customer. Response of
|
10851
11714
|
# this API provides a token required to obtain credentials from the
|
10852
11715
|
# [CreateParticipantConnection][1] API in the Amazon Connect Participant
|
@@ -10890,11 +11753,11 @@ module Aws::Connect
|
|
10890
11753
|
#
|
10891
11754
|
# @option params [required, String] :contact_flow_id
|
10892
11755
|
# The identifier of the flow for initiating the chat. To see the
|
10893
|
-
# ContactFlowId in the Amazon Connect
|
10894
|
-
#
|
10895
|
-
#
|
10896
|
-
#
|
10897
|
-
#
|
11756
|
+
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
11757
|
+
# menu go to **Routing**, **Contact Flows**. Choose the flow. On the
|
11758
|
+
# flow page, under the name of the flow, choose **Show additional flow
|
11759
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
11760
|
+
# here in bold:
|
10898
11761
|
#
|
10899
11762
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
10900
11763
|
#
|
@@ -11274,11 +12137,11 @@ module Aws::Connect
|
|
11274
12137
|
#
|
11275
12138
|
# @option params [required, String] :contact_flow_id
|
11276
12139
|
# The identifier of the flow for the outbound call. To see the
|
11277
|
-
# ContactFlowId in the Amazon Connect
|
11278
|
-
#
|
11279
|
-
#
|
11280
|
-
#
|
11281
|
-
#
|
12140
|
+
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
12141
|
+
# menu go to **Routing**, **Contact Flows**. Choose the flow. On the
|
12142
|
+
# flow page, under the name of the flow, choose **Show additional flow
|
12143
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
12144
|
+
# here in bold:
|
11282
12145
|
#
|
11283
12146
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
11284
12147
|
#
|
@@ -11438,11 +12301,11 @@ module Aws::Connect
|
|
11438
12301
|
#
|
11439
12302
|
# @option params [String] :contact_flow_id
|
11440
12303
|
# The identifier of the flow for initiating the tasks. To see the
|
11441
|
-
# ContactFlowId in the Amazon Connect
|
11442
|
-
#
|
11443
|
-
#
|
11444
|
-
#
|
11445
|
-
#
|
12304
|
+
# ContactFlowId in the Amazon Connect admin website, on the navigation
|
12305
|
+
# menu go to **Routing**, **Contact Flows**. Choose the flow. On the
|
12306
|
+
# flow page, under the name of the flow, choose **Show additional flow
|
12307
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
12308
|
+
# here in bold:
|
11446
12309
|
#
|
11447
12310
|
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
11448
12311
|
#
|
@@ -11560,6 +12423,137 @@ module Aws::Connect
|
|
11560
12423
|
req.send_request(options)
|
11561
12424
|
end
|
11562
12425
|
|
12426
|
+
# Places an inbound in-app, web, or video call to a contact, and then
|
12427
|
+
# initiates the flow. It performs the actions in the flow that are
|
12428
|
+
# specified (in ContactFlowId) and present in the Amazon Connect
|
12429
|
+
# instance (specified as InstanceId).
|
12430
|
+
#
|
12431
|
+
# @option params [Hash<String,String>] :attributes
|
12432
|
+
# A custom key-value pair using an attribute map. The attributes are
|
12433
|
+
# standard Amazon Connect attributes, and can be accessed in flows just
|
12434
|
+
# like any other contact attributes.
|
12435
|
+
#
|
12436
|
+
# There can be up to 32,768 UTF-8 bytes across all key-value pairs per
|
12437
|
+
# contact. Attribute keys can include only alphanumeric, -, and \_
|
12438
|
+
# characters.
|
12439
|
+
#
|
12440
|
+
# @option params [String] :client_token
|
12441
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
12442
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
12443
|
+
# SDK populates this field. For more information about idempotency, see
|
12444
|
+
# [Making retries safe with idempotent APIs][1].
|
12445
|
+
#
|
12446
|
+
# The token is valid for 7 days after creation. If a contact is already
|
12447
|
+
# started, the contact ID is returned.
|
12448
|
+
#
|
12449
|
+
# **A suitable default value is auto-generated.** You should normally
|
12450
|
+
# not need to pass this option.**
|
12451
|
+
#
|
12452
|
+
#
|
12453
|
+
#
|
12454
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
12455
|
+
#
|
12456
|
+
# @option params [required, String] :contact_flow_id
|
12457
|
+
# The identifier of the flow for the call. To see the ContactFlowId in
|
12458
|
+
# the Amazon Connect admin website, on the navigation menu go to
|
12459
|
+
# **Routing**, **Contact Flows**. Choose the flow. On the flow page,
|
12460
|
+
# under the name of the flow, choose **Show additional flow
|
12461
|
+
# information**. The ContactFlowId is the last part of the ARN, shown
|
12462
|
+
# here in bold:
|
12463
|
+
#
|
12464
|
+
# arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/**846ec553-a005-41c0-8341-xxxxxxxxxxxx**
|
12465
|
+
#
|
12466
|
+
# @option params [required, String] :instance_id
|
12467
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
12468
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12469
|
+
#
|
12470
|
+
#
|
12471
|
+
#
|
12472
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
12473
|
+
#
|
12474
|
+
# @option params [Types::AllowedCapabilities] :allowed_capabilities
|
12475
|
+
# Information about the video sharing capabilities of the participants
|
12476
|
+
# (customer, agent).
|
12477
|
+
#
|
12478
|
+
# @option params [required, Types::ParticipantDetails] :participant_details
|
12479
|
+
# The customer's details.
|
12480
|
+
#
|
12481
|
+
# @option params [String] :related_contact_id
|
12482
|
+
# The unique identifier for an Amazon Connect contact. This identifier
|
12483
|
+
# is related to the contact starting.
|
12484
|
+
#
|
12485
|
+
# @option params [Hash<String,Types::Reference>] :references
|
12486
|
+
# A formatted URL that is shown to an agent in the Contact Control Panel
|
12487
|
+
# (CCP). Tasks can have the following reference types at the time of
|
12488
|
+
# creation: `URL` \| `NUMBER` \| `STRING` \| `DATE` \| `EMAIL`.
|
12489
|
+
# `ATTACHMENT` is not a supported reference type during task creation.
|
12490
|
+
#
|
12491
|
+
# @option params [String] :description
|
12492
|
+
# A description of the task that is shown to an agent in the Contact
|
12493
|
+
# Control Panel (CCP).
|
12494
|
+
#
|
12495
|
+
# @return [Types::StartWebRTCContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12496
|
+
#
|
12497
|
+
# * {Types::StartWebRTCContactResponse#connection_data #connection_data} => Types::ConnectionData
|
12498
|
+
# * {Types::StartWebRTCContactResponse#contact_id #contact_id} => String
|
12499
|
+
# * {Types::StartWebRTCContactResponse#participant_id #participant_id} => String
|
12500
|
+
# * {Types::StartWebRTCContactResponse#participant_token #participant_token} => String
|
12501
|
+
#
|
12502
|
+
# @example Request syntax with placeholder values
|
12503
|
+
#
|
12504
|
+
# resp = client.start_web_rtc_contact({
|
12505
|
+
# attributes: {
|
12506
|
+
# "AttributeName" => "AttributeValue",
|
12507
|
+
# },
|
12508
|
+
# client_token: "ClientToken",
|
12509
|
+
# contact_flow_id: "ContactFlowId", # required
|
12510
|
+
# instance_id: "InstanceId", # required
|
12511
|
+
# allowed_capabilities: {
|
12512
|
+
# customer: {
|
12513
|
+
# video: "SEND", # accepts SEND
|
12514
|
+
# },
|
12515
|
+
# agent: {
|
12516
|
+
# video: "SEND", # accepts SEND
|
12517
|
+
# },
|
12518
|
+
# },
|
12519
|
+
# participant_details: { # required
|
12520
|
+
# display_name: "DisplayName", # required
|
12521
|
+
# },
|
12522
|
+
# related_contact_id: "ContactId",
|
12523
|
+
# references: {
|
12524
|
+
# "ReferenceKey" => {
|
12525
|
+
# value: "ReferenceValue", # required
|
12526
|
+
# type: "URL", # required, accepts URL, ATTACHMENT, NUMBER, STRING, DATE, EMAIL
|
12527
|
+
# },
|
12528
|
+
# },
|
12529
|
+
# description: "Description",
|
12530
|
+
# })
|
12531
|
+
#
|
12532
|
+
# @example Response structure
|
12533
|
+
#
|
12534
|
+
# resp.connection_data.attendee.attendee_id #=> String
|
12535
|
+
# resp.connection_data.attendee.join_token #=> String
|
12536
|
+
# resp.connection_data.meeting.media_region #=> String
|
12537
|
+
# resp.connection_data.meeting.media_placement.audio_host_url #=> String
|
12538
|
+
# resp.connection_data.meeting.media_placement.audio_fallback_url #=> String
|
12539
|
+
# resp.connection_data.meeting.media_placement.signaling_url #=> String
|
12540
|
+
# resp.connection_data.meeting.media_placement.turn_control_url #=> String
|
12541
|
+
# resp.connection_data.meeting.media_placement.event_ingestion_url #=> String
|
12542
|
+
# resp.connection_data.meeting.meeting_features.audio.echo_reduction #=> String, one of "AVAILABLE", "UNAVAILABLE"
|
12543
|
+
# resp.connection_data.meeting.meeting_id #=> String
|
12544
|
+
# resp.contact_id #=> String
|
12545
|
+
# resp.participant_id #=> String
|
12546
|
+
# resp.participant_token #=> String
|
12547
|
+
#
|
12548
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartWebRTCContact AWS API Documentation
|
12549
|
+
#
|
12550
|
+
# @overload start_web_rtc_contact(params = {})
|
12551
|
+
# @param [Hash] params ({})
|
12552
|
+
def start_web_rtc_contact(params = {}, options = {})
|
12553
|
+
req = build_request(:start_web_rtc_contact, params)
|
12554
|
+
req.send_request(options)
|
12555
|
+
end
|
12556
|
+
|
11563
12557
|
# Ends the specified contact. This call does not work for voice contacts
|
11564
12558
|
# that use the following initiation methods:
|
11565
12559
|
#
|
@@ -14329,7 +15323,7 @@ module Aws::Connect
|
|
14329
15323
|
params: params,
|
14330
15324
|
config: config)
|
14331
15325
|
context[:gem_name] = 'aws-sdk-connect'
|
14332
|
-
context[:gem_version] = '1.
|
15326
|
+
context[:gem_version] = '1.142.0'
|
14333
15327
|
Seahorse::Client::Request.new(handlers, context)
|
14334
15328
|
end
|
14335
15329
|
|