aws-sdk-connect 1.259.0 → 1.261.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +529 -11
- data/lib/aws-sdk-connect/client_api.rb +261 -0
- data/lib/aws-sdk-connect/types.rb +770 -23
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +105 -11
- data/sig/params.rbs +80 -6
- data/sig/types.rbs +192 -4
- metadata +1 -1
|
@@ -2049,7 +2049,7 @@ module Aws::Connect
|
|
|
2049
2049
|
# resp.files[0].file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
|
2050
2050
|
# resp.files[0].created_by.connect_user_arn #=> String
|
|
2051
2051
|
# resp.files[0].created_by.aws_identity_arn #=> String
|
|
2052
|
-
# resp.files[0].file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT"
|
|
2052
|
+
# resp.files[0].file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT", "VOICE_RECORDING"
|
|
2053
2053
|
# resp.files[0].associated_resource_arn #=> String
|
|
2054
2054
|
# resp.files[0].tags #=> Hash
|
|
2055
2055
|
# resp.files[0].tags["TagKey"] #=> String
|
|
@@ -2512,6 +2512,99 @@ module Aws::Connect
|
|
|
2512
2512
|
req.send_request(options)
|
|
2513
2513
|
end
|
|
2514
2514
|
|
|
2515
|
+
# Creates an attached file for a completed voice contact by copying a
|
|
2516
|
+
# recording from a source S3 URI into Connect Customer managed storage.
|
|
2517
|
+
# Use this API to attach voice recordings to contacts for downstream
|
|
2518
|
+
# processing such as conversational analytics.
|
|
2519
|
+
#
|
|
2520
|
+
# The `AssociatedResourceArn` must be the ARN of a completed voice
|
|
2521
|
+
# contact, `FileUseCaseType` must be set to `VOICE_RECORDING`, and
|
|
2522
|
+
# `FileSourceUri` must be a valid S3 URI.
|
|
2523
|
+
#
|
|
2524
|
+
# <note markdown="1"> For example, you can call `CreateContact`, then `CreateAttachedFile`,
|
|
2525
|
+
# then `StartContactConversationalAnalyticsJob` to create a contact,
|
|
2526
|
+
# attach a recording, and run post-call analytics.
|
|
2527
|
+
#
|
|
2528
|
+
# </note>
|
|
2529
|
+
#
|
|
2530
|
+
# @option params [String] :client_token
|
|
2531
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
2532
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
2533
|
+
# SDK populates this field. For more information about idempotency, see
|
|
2534
|
+
# [Making retries safe with idempotent APIs][1].
|
|
2535
|
+
#
|
|
2536
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
2537
|
+
# not need to pass this option.**
|
|
2538
|
+
#
|
|
2539
|
+
#
|
|
2540
|
+
#
|
|
2541
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
2542
|
+
#
|
|
2543
|
+
# @option params [required, String] :instance_id
|
|
2544
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
2545
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
2546
|
+
#
|
|
2547
|
+
#
|
|
2548
|
+
#
|
|
2549
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
2550
|
+
#
|
|
2551
|
+
# @option params [required, String] :file_use_case_type
|
|
2552
|
+
# The use case for the file.
|
|
2553
|
+
#
|
|
2554
|
+
# Only `VOICE_RECORDING` is supported.
|
|
2555
|
+
#
|
|
2556
|
+
# @option params [required, String] :file_source_uri
|
|
2557
|
+
# The S3 URI of the file to be attached. Only S3 source URIs are
|
|
2558
|
+
# supported.
|
|
2559
|
+
#
|
|
2560
|
+
# @option params [required, String] :associated_resource_arn
|
|
2561
|
+
# The ARN of the completed voice contact to attach the file to. Only
|
|
2562
|
+
# voice contacts with Telephony subtype are supported.
|
|
2563
|
+
#
|
|
2564
|
+
# <note markdown="1"> This value must be a valid ARN.
|
|
2565
|
+
#
|
|
2566
|
+
# </note>
|
|
2567
|
+
#
|
|
2568
|
+
# @option params [Hash<String,String>] :tags
|
|
2569
|
+
# The tags used to organize, track, or control access for this resource.
|
|
2570
|
+
# For example, `{ "Tags": {"key1":"value1", "key2":"value2"} }`.
|
|
2571
|
+
#
|
|
2572
|
+
# @return [Types::CreateAttachedFileResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2573
|
+
#
|
|
2574
|
+
# * {Types::CreateAttachedFileResponse#file_arn #file_arn} => String
|
|
2575
|
+
# * {Types::CreateAttachedFileResponse#file_id #file_id} => String
|
|
2576
|
+
# * {Types::CreateAttachedFileResponse#creation_time #creation_time} => String
|
|
2577
|
+
# * {Types::CreateAttachedFileResponse#file_status #file_status} => String
|
|
2578
|
+
#
|
|
2579
|
+
# @example Request syntax with placeholder values
|
|
2580
|
+
#
|
|
2581
|
+
# resp = client.create_attached_file({
|
|
2582
|
+
# client_token: "ClientToken",
|
|
2583
|
+
# instance_id: "InstanceId", # required
|
|
2584
|
+
# file_use_case_type: "CONTACT_ANALYSIS", # required, accepts CONTACT_ANALYSIS, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_REDACTED, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, ATTACHMENT, VOICE_RECORDING
|
|
2585
|
+
# file_source_uri: "FileSourceUri", # required
|
|
2586
|
+
# associated_resource_arn: "ARN", # required
|
|
2587
|
+
# tags: {
|
|
2588
|
+
# "TagKey" => "TagValue",
|
|
2589
|
+
# },
|
|
2590
|
+
# })
|
|
2591
|
+
#
|
|
2592
|
+
# @example Response structure
|
|
2593
|
+
#
|
|
2594
|
+
# resp.file_arn #=> String
|
|
2595
|
+
# resp.file_id #=> String
|
|
2596
|
+
# resp.creation_time #=> String
|
|
2597
|
+
# resp.file_status #=> String, one of "APPROVED", "REJECTED", "PROCESSING", "FAILED"
|
|
2598
|
+
#
|
|
2599
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateAttachedFile AWS API Documentation
|
|
2600
|
+
#
|
|
2601
|
+
# @overload create_attached_file(params = {})
|
|
2602
|
+
# @param [Hash] params ({})
|
|
2603
|
+
def create_attached_file(params = {}, options = {})
|
|
2604
|
+
req = build_request(:create_attached_file, params)
|
|
2605
|
+
req.send_request(options)
|
|
2606
|
+
end
|
|
2607
|
+
|
|
2515
2608
|
# Only the VOICE, EMAIL, and TASK channels are supported.
|
|
2516
2609
|
#
|
|
2517
2610
|
# * For VOICE: The supported initiation method is `TRANSFER`. The
|
|
@@ -3362,6 +3455,14 @@ module Aws::Connect
|
|
|
3362
3455
|
# # recursive EvaluationFormItemsList
|
|
3363
3456
|
# },
|
|
3364
3457
|
# weight: 1.0,
|
|
3458
|
+
# is_excluded_from_scoring: false,
|
|
3459
|
+
# score_thresholds: [
|
|
3460
|
+
# {
|
|
3461
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
3462
|
+
# min_score_percentage: 1.0,
|
|
3463
|
+
# max_score_percentage: 1.0,
|
|
3464
|
+
# },
|
|
3465
|
+
# ],
|
|
3365
3466
|
# },
|
|
3366
3467
|
# question: {
|
|
3367
3468
|
# title: "EvaluationFormQuestionTitle", # required
|
|
@@ -3382,6 +3483,10 @@ module Aws::Connect
|
|
|
3382
3483
|
# automatic_fail_configuration: {
|
|
3383
3484
|
# target_section: "ReferenceId",
|
|
3384
3485
|
# },
|
|
3486
|
+
# points_configuration: {
|
|
3487
|
+
# point_value: 1, # required
|
|
3488
|
+
# is_bonus: false,
|
|
3489
|
+
# },
|
|
3385
3490
|
# },
|
|
3386
3491
|
# ],
|
|
3387
3492
|
# automation: {
|
|
@@ -3403,6 +3508,10 @@ module Aws::Connect
|
|
|
3403
3508
|
# automatic_fail_configuration: {
|
|
3404
3509
|
# target_section: "ReferenceId",
|
|
3405
3510
|
# },
|
|
3511
|
+
# points_configuration: {
|
|
3512
|
+
# point_value: 1, # required
|
|
3513
|
+
# is_bonus: false,
|
|
3514
|
+
# },
|
|
3406
3515
|
# },
|
|
3407
3516
|
# ],
|
|
3408
3517
|
# display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
|
|
@@ -3434,6 +3543,15 @@ module Aws::Connect
|
|
|
3434
3543
|
# {
|
|
3435
3544
|
# ref_id: "ReferenceId", # required
|
|
3436
3545
|
# text: "EvaluationFormMultiSelectQuestionOptionText", # required
|
|
3546
|
+
# score: 1,
|
|
3547
|
+
# automatic_fail: false,
|
|
3548
|
+
# automatic_fail_configuration: {
|
|
3549
|
+
# target_section: "ReferenceId",
|
|
3550
|
+
# },
|
|
3551
|
+
# points_configuration: {
|
|
3552
|
+
# point_value: 1, # required
|
|
3553
|
+
# is_bonus: false,
|
|
3554
|
+
# },
|
|
3437
3555
|
# },
|
|
3438
3556
|
# ],
|
|
3439
3557
|
# display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
|
|
@@ -3482,12 +3600,34 @@ module Aws::Connect
|
|
|
3482
3600
|
# default_action: "DISABLE", # accepts DISABLE, ENABLE
|
|
3483
3601
|
# },
|
|
3484
3602
|
# weight: 1.0,
|
|
3603
|
+
# scoring_configuration: {
|
|
3604
|
+
# points_configuration: {
|
|
3605
|
+
# max_point_value: 1,
|
|
3606
|
+
# min_point_value: 1,
|
|
3607
|
+
# is_bonus: false,
|
|
3608
|
+
# },
|
|
3609
|
+
# is_excluded_from_scoring: false,
|
|
3610
|
+
# score_thresholds: [
|
|
3611
|
+
# {
|
|
3612
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
3613
|
+
# min_score_percentage: 1.0,
|
|
3614
|
+
# max_score_percentage: 1.0,
|
|
3615
|
+
# },
|
|
3616
|
+
# ],
|
|
3617
|
+
# },
|
|
3485
3618
|
# },
|
|
3486
3619
|
# },
|
|
3487
3620
|
# ],
|
|
3488
3621
|
# scoring_strategy: {
|
|
3489
|
-
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
|
|
3622
|
+
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY, POINTS_BASED
|
|
3490
3623
|
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
|
3624
|
+
# score_thresholds: [
|
|
3625
|
+
# {
|
|
3626
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
3627
|
+
# min_score_percentage: 1.0,
|
|
3628
|
+
# max_score_percentage: 1.0,
|
|
3629
|
+
# },
|
|
3630
|
+
# ],
|
|
3491
3631
|
# },
|
|
3492
3632
|
# auto_evaluation_configuration: {
|
|
3493
3633
|
# enabled: false, # required
|
|
@@ -7774,6 +7914,9 @@ module Aws::Connect
|
|
|
7774
7914
|
# resp.evaluation.metadata.score.not_applicable #=> Boolean
|
|
7775
7915
|
# resp.evaluation.metadata.score.automatic_fail #=> Boolean
|
|
7776
7916
|
# resp.evaluation.metadata.score.applied_weight #=> Float
|
|
7917
|
+
# resp.evaluation.metadata.score.earned_points #=> Integer
|
|
7918
|
+
# resp.evaluation.metadata.score.max_base_point #=> Integer
|
|
7919
|
+
# resp.evaluation.metadata.score.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
7777
7920
|
# resp.evaluation.metadata.auto_evaluation.auto_evaluation_enabled #=> Boolean
|
|
7778
7921
|
# resp.evaluation.metadata.auto_evaluation.auto_evaluation_status #=> String, one of "IN_PROGRESS", "FAILED", "SUCCEEDED"
|
|
7779
7922
|
# resp.evaluation.metadata.acknowledgement.acknowledged_time #=> Time
|
|
@@ -7832,6 +7975,9 @@ module Aws::Connect
|
|
|
7832
7975
|
# resp.evaluation.scores["ResourceId"].not_applicable #=> Boolean
|
|
7833
7976
|
# resp.evaluation.scores["ResourceId"].automatic_fail #=> Boolean
|
|
7834
7977
|
# resp.evaluation.scores["ResourceId"].applied_weight #=> Float
|
|
7978
|
+
# resp.evaluation.scores["ResourceId"].earned_points #=> Integer
|
|
7979
|
+
# resp.evaluation.scores["ResourceId"].max_base_point #=> Integer
|
|
7980
|
+
# resp.evaluation.scores["ResourceId"].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
7835
7981
|
# resp.evaluation.created_time #=> Time
|
|
7836
7982
|
# resp.evaluation.last_modified_time #=> Time
|
|
7837
7983
|
# resp.evaluation.evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
|
|
@@ -7848,6 +7994,11 @@ module Aws::Connect
|
|
|
7848
7994
|
# resp.evaluation_form.items[0].section.instructions #=> String
|
|
7849
7995
|
# resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
|
|
7850
7996
|
# resp.evaluation_form.items[0].section.weight #=> Float
|
|
7997
|
+
# resp.evaluation_form.items[0].section.is_excluded_from_scoring #=> Boolean
|
|
7998
|
+
# resp.evaluation_form.items[0].section.score_thresholds #=> Array
|
|
7999
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8000
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].min_score_percentage #=> Float
|
|
8001
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].max_score_percentage #=> Float
|
|
7851
8002
|
# resp.evaluation_form.items[0].question.title #=> String
|
|
7852
8003
|
# resp.evaluation_form.items[0].question.instructions #=> String
|
|
7853
8004
|
# resp.evaluation_form.items[0].question.ref_id #=> String
|
|
@@ -7861,6 +8012,8 @@ module Aws::Connect
|
|
|
7861
8012
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
|
7862
8013
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
|
7863
8014
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
|
|
8015
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.point_value #=> Integer
|
|
8016
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.is_bonus #=> Boolean
|
|
7864
8017
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT", "CUSTOMER_SENTIMENT_SCORE_WITH_AGENT", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME", "LONGEST_HOLD_DURATION", "NUMBER_OF_HOLDS", "AGENT_INTERACTION_AND_HOLD_DURATION"
|
|
7865
8018
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
7866
8019
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
|
@@ -7869,6 +8022,8 @@ module Aws::Connect
|
|
|
7869
8022
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
|
|
7870
8023
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
|
|
7871
8024
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail_configuration.target_section #=> String
|
|
8025
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.point_value #=> Integer
|
|
8026
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.is_bonus #=> Boolean
|
|
7872
8027
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
|
|
7873
8028
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
|
|
7874
8029
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
|
|
@@ -7880,6 +8035,11 @@ module Aws::Connect
|
|
|
7880
8035
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
|
|
7881
8036
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
|
|
7882
8037
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
|
|
8038
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].score #=> Integer
|
|
8039
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail #=> Boolean
|
|
8040
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail_configuration.target_section #=> String
|
|
8041
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.point_value #=> Integer
|
|
8042
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.is_bonus #=> Boolean
|
|
7883
8043
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
|
|
7884
8044
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
|
|
7885
8045
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
|
|
@@ -7901,8 +8061,20 @@ module Aws::Connect
|
|
|
7901
8061
|
# resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
|
|
7902
8062
|
# resp.evaluation_form.items[0].question.enablement.default_action #=> String, one of "DISABLE", "ENABLE"
|
|
7903
8063
|
# resp.evaluation_form.items[0].question.weight #=> Float
|
|
7904
|
-
# resp.evaluation_form.
|
|
8064
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.max_point_value #=> Integer
|
|
8065
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.min_point_value #=> Integer
|
|
8066
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.is_bonus #=> Boolean
|
|
8067
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.is_excluded_from_scoring #=> Boolean
|
|
8068
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds #=> Array
|
|
8069
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8070
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].min_score_percentage #=> Float
|
|
8071
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].max_score_percentage #=> Float
|
|
8072
|
+
# resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY", "POINTS_BASED"
|
|
7905
8073
|
# resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
|
|
8074
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds #=> Array
|
|
8075
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8076
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].min_score_percentage #=> Float
|
|
8077
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].max_score_percentage #=> Float
|
|
7906
8078
|
# resp.evaluation_form.auto_evaluation_configuration.enabled #=> Boolean
|
|
7907
8079
|
# resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED", "CUSTOMER"
|
|
7908
8080
|
# resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
|
|
@@ -8311,6 +8483,11 @@ module Aws::Connect
|
|
|
8311
8483
|
# resp.evaluation_form.items[0].section.instructions #=> String
|
|
8312
8484
|
# resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
|
|
8313
8485
|
# resp.evaluation_form.items[0].section.weight #=> Float
|
|
8486
|
+
# resp.evaluation_form.items[0].section.is_excluded_from_scoring #=> Boolean
|
|
8487
|
+
# resp.evaluation_form.items[0].section.score_thresholds #=> Array
|
|
8488
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8489
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].min_score_percentage #=> Float
|
|
8490
|
+
# resp.evaluation_form.items[0].section.score_thresholds[0].max_score_percentage #=> Float
|
|
8314
8491
|
# resp.evaluation_form.items[0].question.title #=> String
|
|
8315
8492
|
# resp.evaluation_form.items[0].question.instructions #=> String
|
|
8316
8493
|
# resp.evaluation_form.items[0].question.ref_id #=> String
|
|
@@ -8324,6 +8501,8 @@ module Aws::Connect
|
|
|
8324
8501
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
|
8325
8502
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
|
8326
8503
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail_configuration.target_section #=> String
|
|
8504
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.point_value #=> Integer
|
|
8505
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].points_configuration.is_bonus #=> Boolean
|
|
8327
8506
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.property_value.label #=> String, one of "OVERALL_CUSTOMER_SENTIMENT_SCORE", "OVERALL_AGENT_SENTIMENT_SCORE", "CUSTOMER_SENTIMENT_SCORE_WITHOUT_AGENT", "CUSTOMER_SENTIMENT_SCORE_WITH_AGENT", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME", "LONGEST_HOLD_DURATION", "NUMBER_OF_HOLDS", "AGENT_INTERACTION_AND_HOLD_DURATION"
|
|
8328
8507
|
# resp.evaluation_form.items[0].question.question_type_properties.numeric.automation.answer_source.source_type #=> String, one of "CONTACT_LENS_DATA", "GEN_AI"
|
|
8329
8508
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
|
@@ -8332,6 +8511,8 @@ module Aws::Connect
|
|
|
8332
8511
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
|
|
8333
8512
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
|
|
8334
8513
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail_configuration.target_section #=> String
|
|
8514
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.point_value #=> Integer
|
|
8515
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].points_configuration.is_bonus #=> Boolean
|
|
8335
8516
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
|
|
8336
8517
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
|
|
8337
8518
|
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
|
|
@@ -8343,6 +8524,11 @@ module Aws::Connect
|
|
|
8343
8524
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options #=> Array
|
|
8344
8525
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].ref_id #=> String
|
|
8345
8526
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].text #=> String
|
|
8527
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].score #=> Integer
|
|
8528
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail #=> Boolean
|
|
8529
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].automatic_fail_configuration.target_section #=> String
|
|
8530
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.point_value #=> Integer
|
|
8531
|
+
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.options[0].points_configuration.is_bonus #=> Boolean
|
|
8346
8532
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.display_as #=> String, one of "DROPDOWN", "CHECKBOX"
|
|
8347
8533
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options #=> Array
|
|
8348
8534
|
# resp.evaluation_form.items[0].question.question_type_properties.multi_select.automation.options[0].rule_category.category #=> String
|
|
@@ -8364,8 +8550,20 @@ module Aws::Connect
|
|
|
8364
8550
|
# resp.evaluation_form.items[0].question.enablement.action #=> String, one of "DISABLE", "ENABLE"
|
|
8365
8551
|
# resp.evaluation_form.items[0].question.enablement.default_action #=> String, one of "DISABLE", "ENABLE"
|
|
8366
8552
|
# resp.evaluation_form.items[0].question.weight #=> Float
|
|
8367
|
-
# resp.evaluation_form.
|
|
8553
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.max_point_value #=> Integer
|
|
8554
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.min_point_value #=> Integer
|
|
8555
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.points_configuration.is_bonus #=> Boolean
|
|
8556
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.is_excluded_from_scoring #=> Boolean
|
|
8557
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds #=> Array
|
|
8558
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8559
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].min_score_percentage #=> Float
|
|
8560
|
+
# resp.evaluation_form.items[0].question.scoring_configuration.score_thresholds[0].max_score_percentage #=> Float
|
|
8561
|
+
# resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY", "POINTS_BASED"
|
|
8368
8562
|
# resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
|
|
8563
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds #=> Array
|
|
8564
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
8565
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].min_score_percentage #=> Float
|
|
8566
|
+
# resp.evaluation_form.scoring_strategy.score_thresholds[0].max_score_percentage #=> Float
|
|
8369
8567
|
# resp.evaluation_form.created_time #=> Time
|
|
8370
8568
|
# resp.evaluation_form.created_by #=> String
|
|
8371
8569
|
# resp.evaluation_form.last_modified_time #=> Time
|
|
@@ -8379,6 +8577,8 @@ module Aws::Connect
|
|
|
8379
8577
|
# resp.evaluation_form.tags["TagKey"] #=> String
|
|
8380
8578
|
# resp.evaluation_form.target_configuration.contact_interaction_type #=> String, one of "AGENT", "AUTOMATED", "CUSTOMER"
|
|
8381
8579
|
# resp.evaluation_form.language_configuration.form_language #=> String, one of "de-DE", "en-US", "es-ES", "fr-FR", "it-IT", "pt-BR", "ja-JP", "ko-KR", "zh-CN"
|
|
8580
|
+
# resp.evaluation_form.latest_validation_status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
|
8581
|
+
# resp.evaluation_form.last_validation_time #=> Time
|
|
8382
8582
|
#
|
|
8383
8583
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEvaluationForm AWS API Documentation
|
|
8384
8584
|
#
|
|
@@ -10807,7 +11007,7 @@ module Aws::Connect
|
|
|
10807
11007
|
# resp.file_name #=> String
|
|
10808
11008
|
# resp.file_size_in_bytes #=> Integer
|
|
10809
11009
|
# resp.associated_resource_arn #=> String
|
|
10810
|
-
# resp.file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT"
|
|
11010
|
+
# resp.file_use_case_type #=> String, one of "CONTACT_ANALYSIS", "EMAIL_MESSAGE", "EMAIL_MESSAGE_PLAIN_TEXT", "EMAIL_MESSAGE_REDACTED", "EMAIL_MESSAGE_PLAIN_TEXT_REDACTED", "ATTACHMENT", "VOICE_RECORDING"
|
|
10811
11011
|
# resp.created_by.connect_user_arn #=> String
|
|
10812
11012
|
# resp.created_by.aws_identity_arn #=> String
|
|
10813
11013
|
# resp.download_url_metadata.url #=> String
|
|
@@ -11466,6 +11666,74 @@ module Aws::Connect
|
|
|
11466
11666
|
req.send_request(options)
|
|
11467
11667
|
end
|
|
11468
11668
|
|
|
11669
|
+
# Retrieves the status and results of a validation process started by
|
|
11670
|
+
# [StartEvaluationFormValidation][1]. Returns the current execution
|
|
11671
|
+
# status (`IN_PROGRESS`, `COMPLETED`, or `FAILED`), the validated form
|
|
11672
|
+
# version, and when completed, a list of findings that identify
|
|
11673
|
+
# structural issues and quality improvements for the evaluation form,
|
|
11674
|
+
# and may include suggested fixes. If the validation failed, a reason is
|
|
11675
|
+
# provided indicating the cause of the failure.
|
|
11676
|
+
#
|
|
11677
|
+
#
|
|
11678
|
+
#
|
|
11679
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartEvaluationFormValidation.html
|
|
11680
|
+
#
|
|
11681
|
+
# @option params [required, String] :instance_id
|
|
11682
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
11683
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
11684
|
+
#
|
|
11685
|
+
#
|
|
11686
|
+
#
|
|
11687
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
11688
|
+
#
|
|
11689
|
+
# @option params [required, String] :evaluation_form_id
|
|
11690
|
+
# The unique identifier for the evaluation form.
|
|
11691
|
+
#
|
|
11692
|
+
# @option params [Integer] :evaluation_form_version
|
|
11693
|
+
# The version of the evaluation form to retrieve validation results for.
|
|
11694
|
+
#
|
|
11695
|
+
# @return [Types::GetEvaluationFormValidationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
11696
|
+
#
|
|
11697
|
+
# * {Types::GetEvaluationFormValidationResponse#status #status} => String
|
|
11698
|
+
# * {Types::GetEvaluationFormValidationResponse#failure_reason #failure_reason} => String
|
|
11699
|
+
# * {Types::GetEvaluationFormValidationResponse#evaluation_form_id #evaluation_form_id} => String
|
|
11700
|
+
# * {Types::GetEvaluationFormValidationResponse#evaluation_form_version #evaluation_form_version} => Integer
|
|
11701
|
+
# * {Types::GetEvaluationFormValidationResponse#started_time #started_time} => Time
|
|
11702
|
+
# * {Types::GetEvaluationFormValidationResponse#findings #findings} => Array<Types::EvaluationFormValidationFinding>
|
|
11703
|
+
#
|
|
11704
|
+
# @example Request syntax with placeholder values
|
|
11705
|
+
#
|
|
11706
|
+
# resp = client.get_evaluation_form_validation({
|
|
11707
|
+
# instance_id: "InstanceId", # required
|
|
11708
|
+
# evaluation_form_id: "ResourceId", # required
|
|
11709
|
+
# evaluation_form_version: 1,
|
|
11710
|
+
# })
|
|
11711
|
+
#
|
|
11712
|
+
# @example Response structure
|
|
11713
|
+
#
|
|
11714
|
+
# resp.status #=> String, one of "IN_PROGRESS", "COMPLETED", "FAILED"
|
|
11715
|
+
# resp.failure_reason #=> String
|
|
11716
|
+
# resp.evaluation_form_id #=> String
|
|
11717
|
+
# resp.evaluation_form_version #=> Integer
|
|
11718
|
+
# resp.started_time #=> Time
|
|
11719
|
+
# resp.findings #=> Array
|
|
11720
|
+
# resp.findings[0].issue_code #=> String
|
|
11721
|
+
# resp.findings[0].items #=> Array
|
|
11722
|
+
# resp.findings[0].items[0].ref_id #=> String
|
|
11723
|
+
# resp.findings[0].items[0].property #=> String
|
|
11724
|
+
# resp.findings[0].description #=> String
|
|
11725
|
+
# resp.findings[0].suggestion #=> String
|
|
11726
|
+
# resp.findings[0].severity #=> String, one of "WARNING", "ERROR"
|
|
11727
|
+
#
|
|
11728
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetEvaluationFormValidation AWS API Documentation
|
|
11729
|
+
#
|
|
11730
|
+
# @overload get_evaluation_form_validation(params = {})
|
|
11731
|
+
# @param [Hash] params ({})
|
|
11732
|
+
def get_evaluation_form_validation(params = {}, options = {})
|
|
11733
|
+
req = build_request(:get_evaluation_form_validation, params)
|
|
11734
|
+
req.send_request(options)
|
|
11735
|
+
end
|
|
11736
|
+
|
|
11469
11737
|
# Supports SAML sign-in for Connect Customer. Retrieves a token for
|
|
11470
11738
|
# federation. The token is for the Connect Customer user which
|
|
11471
11739
|
# corresponds to the IAM credentials that were used to invoke this
|
|
@@ -12140,9 +12408,9 @@ module Aws::Connect
|
|
|
12140
12408
|
# for the `contact/segmentAttributes/connect:Subtype` filter key.
|
|
12141
12409
|
#
|
|
12142
12410
|
# * `ROUTING_STEP_EXPRESSION` accepts a filter value up to 3,000
|
|
12143
|
-
# characters in length.
|
|
12144
|
-
# order
|
|
12145
|
-
#
|
|
12411
|
+
# characters in length. Filter values are case-sensitive. JSON object
|
|
12412
|
+
# key order and whitespace may be arbitrary; array order and tree
|
|
12413
|
+
# structure must be preserved.
|
|
12146
12414
|
#
|
|
12147
12415
|
# * TRUE and FALSE are the only valid filter values for the
|
|
12148
12416
|
# `Q_CONNECT_ENABLED` filter key.
|
|
@@ -15222,6 +15490,9 @@ module Aws::Connect
|
|
|
15222
15490
|
# resp.evaluation_summary_list[0].score.not_applicable #=> Boolean
|
|
15223
15491
|
# resp.evaluation_summary_list[0].score.automatic_fail #=> Boolean
|
|
15224
15492
|
# resp.evaluation_summary_list[0].score.applied_weight #=> Float
|
|
15493
|
+
# resp.evaluation_summary_list[0].score.earned_points #=> Integer
|
|
15494
|
+
# resp.evaluation_summary_list[0].score.max_base_point #=> Integer
|
|
15495
|
+
# resp.evaluation_summary_list[0].score.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
15225
15496
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledged_time #=> Time
|
|
15226
15497
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledged_by #=> String
|
|
15227
15498
|
# resp.evaluation_summary_list[0].acknowledgement.acknowledger_comment #=> String
|
|
@@ -19588,6 +19859,55 @@ module Aws::Connect
|
|
|
19588
19859
|
# tag_value: "String",
|
|
19589
19860
|
# },
|
|
19590
19861
|
# },
|
|
19862
|
+
# contact_evaluation_attribute_filter: {
|
|
19863
|
+
# or_conditions: [
|
|
19864
|
+
# {
|
|
19865
|
+
# tag_conditions: [
|
|
19866
|
+
# {
|
|
19867
|
+
# tag_key: "String",
|
|
19868
|
+
# tag_value: "String",
|
|
19869
|
+
# },
|
|
19870
|
+
# ],
|
|
19871
|
+
# attribute_conditions: [
|
|
19872
|
+
# {
|
|
19873
|
+
# attribute_key: "ContactAgentId", # accepts ContactAgentId
|
|
19874
|
+
# attribute_value: {
|
|
19875
|
+
# string_value: "String",
|
|
19876
|
+
# },
|
|
19877
|
+
# comparison_type: "EXACT", # accepts EXACT
|
|
19878
|
+
# },
|
|
19879
|
+
# ],
|
|
19880
|
+
# },
|
|
19881
|
+
# ],
|
|
19882
|
+
# and_condition: {
|
|
19883
|
+
# tag_conditions: [
|
|
19884
|
+
# {
|
|
19885
|
+
# tag_key: "String",
|
|
19886
|
+
# tag_value: "String",
|
|
19887
|
+
# },
|
|
19888
|
+
# ],
|
|
19889
|
+
# attribute_conditions: [
|
|
19890
|
+
# {
|
|
19891
|
+
# attribute_key: "ContactAgentId", # accepts ContactAgentId
|
|
19892
|
+
# attribute_value: {
|
|
19893
|
+
# string_value: "String",
|
|
19894
|
+
# },
|
|
19895
|
+
# comparison_type: "EXACT", # accepts EXACT
|
|
19896
|
+
# },
|
|
19897
|
+
# ],
|
|
19898
|
+
# },
|
|
19899
|
+
# tag_condition: {
|
|
19900
|
+
# tag_key: "String",
|
|
19901
|
+
# tag_value: "String",
|
|
19902
|
+
# },
|
|
19903
|
+
# contact_evaluation_attribute_condition: {
|
|
19904
|
+
# attribute_key: "ContactAgentId", # accepts ContactAgentId
|
|
19905
|
+
# attribute_value: {
|
|
19906
|
+
# string_value: "String",
|
|
19907
|
+
# },
|
|
19908
|
+
# comparison_type: "EXACT", # accepts EXACT
|
|
19909
|
+
# },
|
|
19910
|
+
# },
|
|
19591
19911
|
# },
|
|
19592
19912
|
# })
|
|
19593
19913
|
#
|
|
@@ -19615,6 +19935,9 @@ module Aws::Connect
|
|
|
19615
19935
|
# resp.evaluation_search_summary_list[0].metadata.review_id #=> String
|
|
19616
19936
|
# resp.evaluation_search_summary_list[0].metadata.contact_participant_role #=> String, one of "AGENT", "SYSTEM", "CUSTOM_BOT", "CUSTOMER"
|
|
19617
19937
|
# resp.evaluation_search_summary_list[0].metadata.contact_participant_id #=> String
|
|
19938
|
+
# resp.evaluation_search_summary_list[0].metadata.earned_points #=> Integer
|
|
19939
|
+
# resp.evaluation_search_summary_list[0].metadata.max_base_point #=> Integer
|
|
19940
|
+
# resp.evaluation_search_summary_list[0].metadata.performance_category #=> String, one of "NEEDS_IMPROVEMENT", "EXCEEDS_EXPECTATIONS"
|
|
19618
19941
|
# resp.evaluation_search_summary_list[0].status #=> String, one of "DRAFT", "SUBMITTED", "REVIEW_REQUESTED", "UNDER_REVIEW"
|
|
19619
19942
|
# resp.evaluation_search_summary_list[0].evaluation_type #=> String, one of "STANDARD", "CALIBRATION"
|
|
19620
19943
|
# resp.evaluation_search_summary_list[0].created_time #=> Time
|
|
@@ -22732,7 +23055,7 @@ module Aws::Connect
|
|
|
22732
23055
|
# file_name: "FileName", # required
|
|
22733
23056
|
# file_size_in_bytes: 1, # required
|
|
22734
23057
|
# url_expiry_in_seconds: 1,
|
|
22735
|
-
# file_use_case_type: "CONTACT_ANALYSIS", # required, accepts CONTACT_ANALYSIS, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_REDACTED, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, ATTACHMENT
|
|
23058
|
+
# file_use_case_type: "CONTACT_ANALYSIS", # required, accepts CONTACT_ANALYSIS, EMAIL_MESSAGE, EMAIL_MESSAGE_PLAIN_TEXT, EMAIL_MESSAGE_REDACTED, EMAIL_MESSAGE_PLAIN_TEXT_REDACTED, ATTACHMENT, VOICE_RECORDING
|
|
22736
23059
|
# associated_resource_arn: "ARN", # required
|
|
22737
23060
|
# created_by: {
|
|
22738
23061
|
# connect_user_arn: "ARN",
|
|
@@ -22995,6 +23318,98 @@ module Aws::Connect
|
|
|
22995
23318
|
req.send_request(options)
|
|
22996
23319
|
end
|
|
22997
23320
|
|
|
23321
|
+
# Starts a Contact Lens post-call analytics job for the specified
|
|
23322
|
+
# contact. This API runs Conversational Analytics post-contact analysis
|
|
23323
|
+
# on a voice recording that is already attached to the contact,
|
|
23324
|
+
# generating transcription, sentiment analysis, redaction, and
|
|
23325
|
+
# summarization results based on the provided configuration.
|
|
23326
|
+
#
|
|
23327
|
+
# A voice recording must already be attached to the contact before
|
|
23328
|
+
# calling this API. Use `CreateAttachedFile` to attach a recording from
|
|
23329
|
+
# an S3 source URI.
|
|
23330
|
+
#
|
|
23331
|
+
# <note markdown="1"> For example, you can call `CreateContact`, then `CreateAttachedFile`,
|
|
23332
|
+
# then `StartContactConversationalAnalyticsJob` to create a contact,
|
|
23333
|
+
# attach a recording, and run post-call analytics.
|
|
23334
|
+
#
|
|
23335
|
+
# </note>
|
|
23336
|
+
#
|
|
23337
|
+
# @option params [required, String] :instance_id
|
|
23338
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
23339
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
23340
|
+
#
|
|
23341
|
+
#
|
|
23342
|
+
#
|
|
23343
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
23344
|
+
#
|
|
23345
|
+
# @option params [required, String] :contact_id
|
|
23346
|
+
# The identifier of the contact in this instance of Connect Customer.
|
|
23347
|
+
#
|
|
23348
|
+
# @option params [required, Array<String>] :analytics_modes
|
|
23349
|
+
# The analytics modes to run for the contact. Valid values:
|
|
23350
|
+
# `PostContact`.
|
|
23351
|
+
#
|
|
23352
|
+
# @option params [required, Types::AnalyticsConfiguration] :analytics_configuration
|
|
23353
|
+
# The configuration for the conversational analytics job.
|
|
23354
|
+
#
|
|
23355
|
+
# @option params [String] :client_token
|
|
23356
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
23357
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
23358
|
+
# SDK populates this field. For more information about idempotency, see
|
|
23359
|
+
# [Making retries safe with idempotent APIs][1].
|
|
23360
|
+
#
|
|
23361
|
+
#
|
|
23362
|
+
#
|
|
23363
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
23364
|
+
#
|
|
23365
|
+
# @return [Types::StartContactConversationalAnalyticsJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23366
|
+
#
|
|
23367
|
+
# * {Types::StartContactConversationalAnalyticsJobResponse#instance_id #instance_id} => String
|
|
23368
|
+
# * {Types::StartContactConversationalAnalyticsJobResponse#contact_id #contact_id} => String
|
|
23369
|
+
#
|
|
23370
|
+
# @example Request syntax with placeholder values
|
|
23371
|
+
#
|
|
23372
|
+
# resp = client.start_contact_conversational_analytics_job({
|
|
23373
|
+
# instance_id: "InstanceId", # required
|
|
23374
|
+
# contact_id: "ContactId", # required
|
|
23375
|
+
# analytics_modes: ["PostContact"], # required, accepts PostContact, RealTime, ContactLens, AutomatedInteraction
|
|
23376
|
+
# analytics_configuration: { # required
|
|
23377
|
+
# language_configuration: { # required
|
|
23378
|
+
# language_locale: "LanguageLocale",
|
|
23379
|
+
# },
|
|
23380
|
+
# redaction_configuration: { # required
|
|
23381
|
+
# behavior: "Enable", # required, accepts Enable, Disable
|
|
23382
|
+
# policy: "None", # required, accepts None, RedactedOnly, RedactedAndOriginal
|
|
23383
|
+
# entities: ["Entity"],
|
|
23384
|
+
# mask_mode: "PII", # accepts PII, EntityType
|
|
23385
|
+
# },
|
|
23386
|
+
# sentiment_configuration: { # required
|
|
23387
|
+
# behavior: "Enable", # required, accepts Enable, Disable
|
|
23388
|
+
# },
|
|
23389
|
+
# summary_configuration: { # required
|
|
23390
|
+
# summary_modes: ["PostContact"], # required, accepts PostContact, AutomatedInteraction, ContactChain
|
|
23391
|
+
# },
|
|
23392
|
+
# rules_configuration: { # required
|
|
23393
|
+
# behavior: "Enable", # accepts Enable, Disable
|
|
23394
|
+
# },
|
|
23395
|
+
# },
|
|
23396
|
+
# client_token: "ClientToken",
|
|
23397
|
+
# })
|
|
23398
|
+
#
|
|
23399
|
+
# @example Response structure
|
|
23400
|
+
#
|
|
23401
|
+
# resp.instance_id #=> String
|
|
23402
|
+
# resp.contact_id #=> String
|
|
23403
|
+
#
|
|
23404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactConversationalAnalyticsJob AWS API Documentation
|
|
23405
|
+
#
|
|
23406
|
+
# @overload start_contact_conversational_analytics_job(params = {})
|
|
23407
|
+
# @param [Hash] params ({})
|
|
23408
|
+
def start_contact_conversational_analytics_job(params = {}, options = {})
|
|
23409
|
+
req = build_request(:start_contact_conversational_analytics_job, params)
|
|
23410
|
+
req.send_request(options)
|
|
23411
|
+
end
|
|
23412
|
+
|
|
22998
23413
|
# Starts an empty evaluation in the specified Connect Customer instance,
|
|
22999
23414
|
# using the given evaluation form for the particular contact. The
|
|
23000
23415
|
# evaluation form version used for the contact evaluation corresponds to
|
|
@@ -23450,6 +23865,62 @@ module Aws::Connect
|
|
|
23450
23865
|
req.send_request(options)
|
|
23451
23866
|
end
|
|
23452
23867
|
|
|
23868
|
+
# Starts an asynchronous validation process for an evaluation form
|
|
23869
|
+
# version in the specified Connect Customer instance. The validation
|
|
23870
|
+
# first performs structural checks on the form content (such as
|
|
23871
|
+
# verifying required fields, valid scoring configuration, and correct
|
|
23872
|
+
# conditional logic), then asynchronously analyzes questions configured
|
|
23873
|
+
# for generative AI evaluation against a set of best practices. Use
|
|
23874
|
+
# [GetEvaluationFormValidation][1] to retrieve the status and results
|
|
23875
|
+
# once the validation completes.
|
|
23876
|
+
#
|
|
23877
|
+
#
|
|
23878
|
+
#
|
|
23879
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/APIReference/API_GetEvaluationFormValidation.html
|
|
23880
|
+
#
|
|
23881
|
+
# @option params [required, String] :instance_id
|
|
23882
|
+
# The identifier of the Connect Customer instance. You can [find the
|
|
23883
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
23884
|
+
#
|
|
23885
|
+
#
|
|
23886
|
+
#
|
|
23887
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
23888
|
+
#
|
|
23889
|
+
# @option params [required, String] :evaluation_form_id
|
|
23890
|
+
# The unique identifier for the evaluation form.
|
|
23891
|
+
#
|
|
23892
|
+
# @option params [required, Integer] :evaluation_form_version
|
|
23893
|
+
# The version of the evaluation form to validate.
|
|
23894
|
+
#
|
|
23895
|
+
# @return [Types::StartEvaluationFormValidationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
23896
|
+
#
|
|
23897
|
+
# * {Types::StartEvaluationFormValidationResponse#evaluation_form_id #evaluation_form_id} => String
|
|
23898
|
+
# * {Types::StartEvaluationFormValidationResponse#evaluation_form_arn #evaluation_form_arn} => String
|
|
23899
|
+
# * {Types::StartEvaluationFormValidationResponse#evaluation_form_version #evaluation_form_version} => Integer
|
|
23900
|
+
#
|
|
23901
|
+
# @example Request syntax with placeholder values
|
|
23902
|
+
#
|
|
23903
|
+
# resp = client.start_evaluation_form_validation({
|
|
23904
|
+
# instance_id: "InstanceId", # required
|
|
23905
|
+
# evaluation_form_id: "ResourceId", # required
|
|
23906
|
+
# evaluation_form_version: 1, # required
|
|
23907
|
+
# })
|
|
23908
|
+
#
|
|
23909
|
+
# @example Response structure
|
|
23910
|
+
#
|
|
23911
|
+
# resp.evaluation_form_id #=> String
|
|
23912
|
+
# resp.evaluation_form_arn #=> String
|
|
23913
|
+
# resp.evaluation_form_version #=> Integer
|
|
23914
|
+
#
|
|
23915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartEvaluationFormValidation AWS API Documentation
|
|
23916
|
+
#
|
|
23917
|
+
# @overload start_evaluation_form_validation(params = {})
|
|
23918
|
+
# @param [Hash] params ({})
|
|
23919
|
+
def start_evaluation_form_validation(params = {}, options = {})
|
|
23920
|
+
req = build_request(:start_evaluation_form_validation, params)
|
|
23921
|
+
req.send_request(options)
|
|
23922
|
+
end
|
|
23923
|
+
|
|
23453
23924
|
# Initiates a new outbound SMS or WhatsApp contact to a customer.
|
|
23454
23925
|
# Response of this API provides the `ContactId` of the outbound SMS or
|
|
23455
23926
|
# WhatsApp contact created.
|
|
@@ -26344,6 +26815,14 @@ module Aws::Connect
|
|
|
26344
26815
|
# # recursive EvaluationFormItemsList
|
|
26345
26816
|
# },
|
|
26346
26817
|
# weight: 1.0,
|
|
26818
|
+
# is_excluded_from_scoring: false,
|
|
26819
|
+
# score_thresholds: [
|
|
26820
|
+
# {
|
|
26821
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
26822
|
+
# min_score_percentage: 1.0,
|
|
26823
|
+
# max_score_percentage: 1.0,
|
|
26824
|
+
# },
|
|
26825
|
+
# ],
|
|
26347
26826
|
# },
|
|
26348
26827
|
# question: {
|
|
26349
26828
|
# title: "EvaluationFormQuestionTitle", # required
|
|
@@ -26364,6 +26843,10 @@ module Aws::Connect
|
|
|
26364
26843
|
# automatic_fail_configuration: {
|
|
26365
26844
|
# target_section: "ReferenceId",
|
|
26366
26845
|
# },
|
|
26846
|
+
# points_configuration: {
|
|
26847
|
+
# point_value: 1, # required
|
|
26848
|
+
# is_bonus: false,
|
|
26849
|
+
# },
|
|
26367
26850
|
# },
|
|
26368
26851
|
# ],
|
|
26369
26852
|
# automation: {
|
|
@@ -26385,6 +26868,10 @@ module Aws::Connect
|
|
|
26385
26868
|
# automatic_fail_configuration: {
|
|
26386
26869
|
# target_section: "ReferenceId",
|
|
26387
26870
|
# },
|
|
26871
|
+
# points_configuration: {
|
|
26872
|
+
# point_value: 1, # required
|
|
26873
|
+
# is_bonus: false,
|
|
26874
|
+
# },
|
|
26388
26875
|
# },
|
|
26389
26876
|
# ],
|
|
26390
26877
|
# display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
|
|
@@ -26416,6 +26903,15 @@ module Aws::Connect
|
|
|
26416
26903
|
# {
|
|
26417
26904
|
# ref_id: "ReferenceId", # required
|
|
26418
26905
|
# text: "EvaluationFormMultiSelectQuestionOptionText", # required
|
|
26906
|
+
# score: 1,
|
|
26907
|
+
# automatic_fail: false,
|
|
26908
|
+
# automatic_fail_configuration: {
|
|
26909
|
+
# target_section: "ReferenceId",
|
|
26910
|
+
# },
|
|
26911
|
+
# points_configuration: {
|
|
26912
|
+
# point_value: 1, # required
|
|
26913
|
+
# is_bonus: false,
|
|
26914
|
+
# },
|
|
26419
26915
|
# },
|
|
26420
26916
|
# ],
|
|
26421
26917
|
# display_as: "DROPDOWN", # accepts DROPDOWN, CHECKBOX
|
|
@@ -26464,12 +26960,34 @@ module Aws::Connect
|
|
|
26464
26960
|
# default_action: "DISABLE", # accepts DISABLE, ENABLE
|
|
26465
26961
|
# },
|
|
26466
26962
|
# weight: 1.0,
|
|
26963
|
+
# scoring_configuration: {
|
|
26964
|
+
# points_configuration: {
|
|
26965
|
+
# max_point_value: 1,
|
|
26966
|
+
# min_point_value: 1,
|
|
26967
|
+
# is_bonus: false,
|
|
26968
|
+
# },
|
|
26969
|
+
# is_excluded_from_scoring: false,
|
|
26970
|
+
# score_thresholds: [
|
|
26971
|
+
# {
|
|
26972
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
26973
|
+
# min_score_percentage: 1.0,
|
|
26974
|
+
# max_score_percentage: 1.0,
|
|
26975
|
+
# },
|
|
26976
|
+
# ],
|
|
26977
|
+
# },
|
|
26467
26978
|
# },
|
|
26468
26979
|
# },
|
|
26469
26980
|
# ],
|
|
26470
26981
|
# scoring_strategy: {
|
|
26471
|
-
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
|
|
26982
|
+
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY, POINTS_BASED
|
|
26472
26983
|
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
|
26984
|
+
# score_thresholds: [
|
|
26985
|
+
# {
|
|
26986
|
+
# performance_category: "NEEDS_IMPROVEMENT", # required, accepts NEEDS_IMPROVEMENT, EXCEEDS_EXPECTATIONS
|
|
26987
|
+
# min_score_percentage: 1.0,
|
|
26988
|
+
# max_score_percentage: 1.0,
|
|
26989
|
+
# },
|
|
26990
|
+
# ],
|
|
26473
26991
|
# },
|
|
26474
26992
|
# auto_evaluation_configuration: {
|
|
26475
26993
|
# enabled: false, # required
|
|
@@ -29223,7 +29741,7 @@ module Aws::Connect
|
|
|
29223
29741
|
tracer: tracer
|
|
29224
29742
|
)
|
|
29225
29743
|
context[:gem_name] = 'aws-sdk-connect'
|
|
29226
|
-
context[:gem_version] = '1.
|
|
29744
|
+
context[:gem_version] = '1.261.0'
|
|
29227
29745
|
Seahorse::Client::Request.new(handlers, context)
|
|
29228
29746
|
end
|
|
29229
29747
|
|