aws-sdk-connect 1.102.0 → 1.103.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +1024 -1
- data/lib/aws-sdk-connect/client_api.rb +630 -0
- data/lib/aws-sdk-connect/endpoints.rb +196 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +28 -0
- data/lib/aws-sdk-connect/types.rb +1706 -87
- data/lib/aws-sdk-connect.rb +2 -2
- metadata +2 -2
@@ -368,6 +368,55 @@ module Aws::Connect
|
|
368
368
|
|
369
369
|
# @!group API Operations
|
370
370
|
|
371
|
+
# Activates an evaluation form in the specified Amazon Connect instance.
|
372
|
+
# After the evaluation form is activated, it is available to start new
|
373
|
+
# evaluations based on the form.
|
374
|
+
#
|
375
|
+
# @option params [required, String] :instance_id
|
376
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
377
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
378
|
+
#
|
379
|
+
#
|
380
|
+
#
|
381
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
382
|
+
#
|
383
|
+
# @option params [required, String] :evaluation_form_id
|
384
|
+
# The unique identifier for the evaluation form.
|
385
|
+
#
|
386
|
+
# @option params [required, Integer] :evaluation_form_version
|
387
|
+
# The version of the evaluation form to activate. If the version
|
388
|
+
# property is not provided, the latest version of the evaluation form is
|
389
|
+
# activated.
|
390
|
+
#
|
391
|
+
# @return [Types::ActivateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
392
|
+
#
|
393
|
+
# * {Types::ActivateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
394
|
+
# * {Types::ActivateEvaluationFormResponse#evaluation_form_arn #evaluation_form_arn} => String
|
395
|
+
# * {Types::ActivateEvaluationFormResponse#evaluation_form_version #evaluation_form_version} => Integer
|
396
|
+
#
|
397
|
+
# @example Request syntax with placeholder values
|
398
|
+
#
|
399
|
+
# resp = client.activate_evaluation_form({
|
400
|
+
# instance_id: "InstanceId", # required
|
401
|
+
# evaluation_form_id: "ResourceId", # required
|
402
|
+
# evaluation_form_version: 1, # required
|
403
|
+
# })
|
404
|
+
#
|
405
|
+
# @example Response structure
|
406
|
+
#
|
407
|
+
# resp.evaluation_form_id #=> String
|
408
|
+
# resp.evaluation_form_arn #=> String
|
409
|
+
# resp.evaluation_form_version #=> Integer
|
410
|
+
#
|
411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ActivateEvaluationForm AWS API Documentation
|
412
|
+
#
|
413
|
+
# @overload activate_evaluation_form(params = {})
|
414
|
+
# @param [Hash] params ({})
|
415
|
+
def activate_evaluation_form(params = {}, options = {})
|
416
|
+
req = build_request(:activate_evaluation_form, params)
|
417
|
+
req.send_request(options)
|
418
|
+
end
|
419
|
+
|
371
420
|
# This API is in preview release for Amazon Connect and is subject to
|
372
421
|
# change.
|
373
422
|
#
|
@@ -1093,6 +1142,142 @@ module Aws::Connect
|
|
1093
1142
|
req.send_request(options)
|
1094
1143
|
end
|
1095
1144
|
|
1145
|
+
# Creates an evaluation form in the specified Amazon Connect instance.
|
1146
|
+
# The form can be used to define questions related to agent performance,
|
1147
|
+
# and create sections to organize such questions. An evaluation form
|
1148
|
+
# must have a unique title within an instance. Question and section
|
1149
|
+
# identifiers cannot be duplicated within the same evaluation form.
|
1150
|
+
#
|
1151
|
+
# @option params [required, String] :instance_id
|
1152
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
1153
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
1154
|
+
#
|
1155
|
+
#
|
1156
|
+
#
|
1157
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1158
|
+
#
|
1159
|
+
# @option params [required, String] :title
|
1160
|
+
# A unique title of the evaluation form.
|
1161
|
+
#
|
1162
|
+
# @option params [String] :description
|
1163
|
+
# The description of the evaluation form.
|
1164
|
+
#
|
1165
|
+
# @option params [required, Array<Types::EvaluationFormItem>] :items
|
1166
|
+
# Items that are part of the evaluation form. The total number of
|
1167
|
+
# sections and questions must not exceed 100 each. Questions must be
|
1168
|
+
# contained in a section.
|
1169
|
+
#
|
1170
|
+
# @option params [Types::EvaluationFormScoringStrategy] :scoring_strategy
|
1171
|
+
# A scoring strategy of the evaluation form.
|
1172
|
+
#
|
1173
|
+
# @option params [String] :client_token
|
1174
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1175
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1176
|
+
# SDK populates this field. For more information about idempotency, see
|
1177
|
+
# [Making retries safe with idempotent APIs][1].
|
1178
|
+
#
|
1179
|
+
# **A suitable default value is auto-generated.** You should normally
|
1180
|
+
# not need to pass this option.**
|
1181
|
+
#
|
1182
|
+
#
|
1183
|
+
#
|
1184
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1185
|
+
#
|
1186
|
+
# @return [Types::CreateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1187
|
+
#
|
1188
|
+
# * {Types::CreateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
1189
|
+
# * {Types::CreateEvaluationFormResponse#evaluation_form_arn #evaluation_form_arn} => String
|
1190
|
+
#
|
1191
|
+
# @example Request syntax with placeholder values
|
1192
|
+
#
|
1193
|
+
# resp = client.create_evaluation_form({
|
1194
|
+
# instance_id: "InstanceId", # required
|
1195
|
+
# title: "EvaluationFormTitle", # required
|
1196
|
+
# description: "EvaluationFormDescription",
|
1197
|
+
# items: [ # required
|
1198
|
+
# {
|
1199
|
+
# section: {
|
1200
|
+
# title: "EvaluationFormSectionTitle", # required
|
1201
|
+
# ref_id: "ReferenceId", # required
|
1202
|
+
# instructions: "EvaluationFormQuestionInstructions",
|
1203
|
+
# items: {
|
1204
|
+
# # recursive EvaluationFormItemsList
|
1205
|
+
# },
|
1206
|
+
# weight: 1.0,
|
1207
|
+
# },
|
1208
|
+
# question: {
|
1209
|
+
# title: "EvaluationFormQuestionTitle", # required
|
1210
|
+
# instructions: "EvaluationFormQuestionInstructions",
|
1211
|
+
# ref_id: "ReferenceId", # required
|
1212
|
+
# not_applicable_enabled: false,
|
1213
|
+
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
|
1214
|
+
# question_type_properties: {
|
1215
|
+
# numeric: {
|
1216
|
+
# min_value: 1, # required
|
1217
|
+
# max_value: 1, # required
|
1218
|
+
# options: [
|
1219
|
+
# {
|
1220
|
+
# min_value: 1, # required
|
1221
|
+
# max_value: 1, # required
|
1222
|
+
# score: 1,
|
1223
|
+
# automatic_fail: false,
|
1224
|
+
# },
|
1225
|
+
# ],
|
1226
|
+
# automation: {
|
1227
|
+
# property_value: {
|
1228
|
+
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, NON_TALK_TIME, NON_TALK_TIME_PERCENTAGE, NUMBER_OF_INTERRUPTIONS, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME
|
1229
|
+
# },
|
1230
|
+
# },
|
1231
|
+
# },
|
1232
|
+
# single_select: {
|
1233
|
+
# options: [ # required
|
1234
|
+
# {
|
1235
|
+
# ref_id: "ReferenceId", # required
|
1236
|
+
# text: "EvaluationFormSingleSelectQuestionOptionText", # required
|
1237
|
+
# score: 1,
|
1238
|
+
# automatic_fail: false,
|
1239
|
+
# },
|
1240
|
+
# ],
|
1241
|
+
# display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
|
1242
|
+
# automation: {
|
1243
|
+
# options: [ # required
|
1244
|
+
# {
|
1245
|
+
# rule_category: {
|
1246
|
+
# category: "SingleSelectQuestionRuleCategoryAutomationLabel", # required
|
1247
|
+
# condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
|
1248
|
+
# option_ref_id: "ReferenceId", # required
|
1249
|
+
# },
|
1250
|
+
# },
|
1251
|
+
# ],
|
1252
|
+
# default_option_ref_id: "ReferenceId",
|
1253
|
+
# },
|
1254
|
+
# },
|
1255
|
+
# },
|
1256
|
+
# weight: 1.0,
|
1257
|
+
# },
|
1258
|
+
# },
|
1259
|
+
# ],
|
1260
|
+
# scoring_strategy: {
|
1261
|
+
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
|
1262
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
1263
|
+
# },
|
1264
|
+
# client_token: "ClientToken",
|
1265
|
+
# })
|
1266
|
+
#
|
1267
|
+
# @example Response structure
|
1268
|
+
#
|
1269
|
+
# resp.evaluation_form_id #=> String
|
1270
|
+
# resp.evaluation_form_arn #=> String
|
1271
|
+
#
|
1272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationForm AWS API Documentation
|
1273
|
+
#
|
1274
|
+
# @overload create_evaluation_form(params = {})
|
1275
|
+
# @param [Hash] params ({})
|
1276
|
+
def create_evaluation_form(params = {}, options = {})
|
1277
|
+
req = build_request(:create_evaluation_form, params)
|
1278
|
+
req.send_request(options)
|
1279
|
+
end
|
1280
|
+
|
1096
1281
|
# This API is in preview release for Amazon Connect and is subject to
|
1097
1282
|
# change.
|
1098
1283
|
#
|
@@ -2310,6 +2495,85 @@ module Aws::Connect
|
|
2310
2495
|
req.send_request(options)
|
2311
2496
|
end
|
2312
2497
|
|
2498
|
+
# Deactivates an evaluation form in the specified Amazon Connect
|
2499
|
+
# instance. After a form is deactivated, it is no longer available for
|
2500
|
+
# users to start new evaluations based on the form.
|
2501
|
+
#
|
2502
|
+
# @option params [required, String] :instance_id
|
2503
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2504
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2505
|
+
#
|
2506
|
+
#
|
2507
|
+
#
|
2508
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2509
|
+
#
|
2510
|
+
# @option params [required, String] :evaluation_form_id
|
2511
|
+
# The unique identifier for the evaluation form.
|
2512
|
+
#
|
2513
|
+
# @option params [required, Integer] :evaluation_form_version
|
2514
|
+
# A version of the evaluation form. If the version property is not
|
2515
|
+
# provided, the latest version of the evaluation form is deactivated.
|
2516
|
+
#
|
2517
|
+
# @return [Types::DeactivateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2518
|
+
#
|
2519
|
+
# * {Types::DeactivateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
2520
|
+
# * {Types::DeactivateEvaluationFormResponse#evaluation_form_arn #evaluation_form_arn} => String
|
2521
|
+
# * {Types::DeactivateEvaluationFormResponse#evaluation_form_version #evaluation_form_version} => Integer
|
2522
|
+
#
|
2523
|
+
# @example Request syntax with placeholder values
|
2524
|
+
#
|
2525
|
+
# resp = client.deactivate_evaluation_form({
|
2526
|
+
# instance_id: "InstanceId", # required
|
2527
|
+
# evaluation_form_id: "ResourceId", # required
|
2528
|
+
# evaluation_form_version: 1, # required
|
2529
|
+
# })
|
2530
|
+
#
|
2531
|
+
# @example Response structure
|
2532
|
+
#
|
2533
|
+
# resp.evaluation_form_id #=> String
|
2534
|
+
# resp.evaluation_form_arn #=> String
|
2535
|
+
# resp.evaluation_form_version #=> Integer
|
2536
|
+
#
|
2537
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeactivateEvaluationForm AWS API Documentation
|
2538
|
+
#
|
2539
|
+
# @overload deactivate_evaluation_form(params = {})
|
2540
|
+
# @param [Hash] params ({})
|
2541
|
+
def deactivate_evaluation_form(params = {}, options = {})
|
2542
|
+
req = build_request(:deactivate_evaluation_form, params)
|
2543
|
+
req.send_request(options)
|
2544
|
+
end
|
2545
|
+
|
2546
|
+
# Deletes a contact evaluation in the specified Amazon Connect instance.
|
2547
|
+
#
|
2548
|
+
# @option params [required, String] :instance_id
|
2549
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2550
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2551
|
+
#
|
2552
|
+
#
|
2553
|
+
#
|
2554
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2555
|
+
#
|
2556
|
+
# @option params [required, String] :evaluation_id
|
2557
|
+
# A unique identifier for the contact evaluation.
|
2558
|
+
#
|
2559
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2560
|
+
#
|
2561
|
+
# @example Request syntax with placeholder values
|
2562
|
+
#
|
2563
|
+
# resp = client.delete_contact_evaluation({
|
2564
|
+
# instance_id: "InstanceId", # required
|
2565
|
+
# evaluation_id: "ResourceId", # required
|
2566
|
+
# })
|
2567
|
+
#
|
2568
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactEvaluation AWS API Documentation
|
2569
|
+
#
|
2570
|
+
# @overload delete_contact_evaluation(params = {})
|
2571
|
+
# @param [Hash] params ({})
|
2572
|
+
def delete_contact_evaluation(params = {}, options = {})
|
2573
|
+
req = build_request(:delete_contact_evaluation, params)
|
2574
|
+
req.send_request(options)
|
2575
|
+
end
|
2576
|
+
|
2313
2577
|
# Deletes a flow for the specified Amazon Connect instance.
|
2314
2578
|
#
|
2315
2579
|
# @option params [required, String] :instance_id
|
@@ -2372,6 +2636,47 @@ module Aws::Connect
|
|
2372
2636
|
req.send_request(options)
|
2373
2637
|
end
|
2374
2638
|
|
2639
|
+
# Deletes an evaluation form in the specified Amazon Connect instance.
|
2640
|
+
#
|
2641
|
+
# * If the version property is provided, only the specified version of
|
2642
|
+
# the evaluation form is deleted.
|
2643
|
+
#
|
2644
|
+
# * If no version is provided, then the full form (all versions) is
|
2645
|
+
# deleted.
|
2646
|
+
#
|
2647
|
+
# @option params [required, String] :instance_id
|
2648
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2649
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2650
|
+
#
|
2651
|
+
#
|
2652
|
+
#
|
2653
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2654
|
+
#
|
2655
|
+
# @option params [required, String] :evaluation_form_id
|
2656
|
+
# The unique identifier for the evaluation form.
|
2657
|
+
#
|
2658
|
+
# @option params [Integer] :evaluation_form_version
|
2659
|
+
# The unique identifier for the evaluation form.
|
2660
|
+
#
|
2661
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2662
|
+
#
|
2663
|
+
# @example Request syntax with placeholder values
|
2664
|
+
#
|
2665
|
+
# resp = client.delete_evaluation_form({
|
2666
|
+
# instance_id: "InstanceId", # required
|
2667
|
+
# evaluation_form_id: "ResourceId", # required
|
2668
|
+
# evaluation_form_version: 1,
|
2669
|
+
# })
|
2670
|
+
#
|
2671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEvaluationForm AWS API Documentation
|
2672
|
+
#
|
2673
|
+
# @overload delete_evaluation_form(params = {})
|
2674
|
+
# @param [Hash] params ({})
|
2675
|
+
def delete_evaluation_form(params = {}, options = {})
|
2676
|
+
req = build_request(:delete_evaluation_form, params)
|
2677
|
+
req.send_request(options)
|
2678
|
+
end
|
2679
|
+
|
2375
2680
|
# This API is in preview release for Amazon Connect and is subject to
|
2376
2681
|
# change.
|
2377
2682
|
#
|
@@ -2894,6 +3199,108 @@ module Aws::Connect
|
|
2894
3199
|
req.send_request(options)
|
2895
3200
|
end
|
2896
3201
|
|
3202
|
+
# Describes a contact evaluation in the specified Amazon Connect
|
3203
|
+
# instance.
|
3204
|
+
#
|
3205
|
+
# @option params [required, String] :instance_id
|
3206
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3207
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3208
|
+
#
|
3209
|
+
#
|
3210
|
+
#
|
3211
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3212
|
+
#
|
3213
|
+
# @option params [required, String] :evaluation_id
|
3214
|
+
# A unique identifier for the contact evaluation.
|
3215
|
+
#
|
3216
|
+
# @return [Types::DescribeContactEvaluationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3217
|
+
#
|
3218
|
+
# * {Types::DescribeContactEvaluationResponse#evaluation #evaluation} => Types::Evaluation
|
3219
|
+
# * {Types::DescribeContactEvaluationResponse#evaluation_form #evaluation_form} => Types::EvaluationFormContent
|
3220
|
+
#
|
3221
|
+
# @example Request syntax with placeholder values
|
3222
|
+
#
|
3223
|
+
# resp = client.describe_contact_evaluation({
|
3224
|
+
# instance_id: "InstanceId", # required
|
3225
|
+
# evaluation_id: "ResourceId", # required
|
3226
|
+
# })
|
3227
|
+
#
|
3228
|
+
# @example Response structure
|
3229
|
+
#
|
3230
|
+
# resp.evaluation.evaluation_id #=> String
|
3231
|
+
# resp.evaluation.evaluation_arn #=> String
|
3232
|
+
# resp.evaluation.metadata.contact_id #=> String
|
3233
|
+
# resp.evaluation.metadata.evaluator_arn #=> String
|
3234
|
+
# resp.evaluation.metadata.contact_agent_id #=> String
|
3235
|
+
# resp.evaluation.metadata.score.percentage #=> Float
|
3236
|
+
# resp.evaluation.metadata.score.not_applicable #=> Boolean
|
3237
|
+
# resp.evaluation.metadata.score.automatic_fail #=> Boolean
|
3238
|
+
# resp.evaluation.answers #=> Hash
|
3239
|
+
# resp.evaluation.answers["ResourceId"].value.string_value #=> String
|
3240
|
+
# resp.evaluation.answers["ResourceId"].value.numeric_value #=> Float
|
3241
|
+
# resp.evaluation.answers["ResourceId"].value.not_applicable #=> Boolean
|
3242
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.string_value #=> String
|
3243
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.numeric_value #=> Float
|
3244
|
+
# resp.evaluation.answers["ResourceId"].system_suggested_value.not_applicable #=> Boolean
|
3245
|
+
# resp.evaluation.notes #=> Hash
|
3246
|
+
# resp.evaluation.notes["ResourceId"].value #=> String
|
3247
|
+
# resp.evaluation.status #=> String, one of "DRAFT", "SUBMITTED"
|
3248
|
+
# resp.evaluation.scores #=> Hash
|
3249
|
+
# resp.evaluation.scores["ResourceId"].percentage #=> Float
|
3250
|
+
# resp.evaluation.scores["ResourceId"].not_applicable #=> Boolean
|
3251
|
+
# resp.evaluation.scores["ResourceId"].automatic_fail #=> Boolean
|
3252
|
+
# resp.evaluation.created_time #=> Time
|
3253
|
+
# resp.evaluation.last_modified_time #=> Time
|
3254
|
+
# resp.evaluation.tags #=> Hash
|
3255
|
+
# resp.evaluation.tags["TagKey"] #=> String
|
3256
|
+
# resp.evaluation_form.evaluation_form_version #=> Integer
|
3257
|
+
# resp.evaluation_form.evaluation_form_id #=> String
|
3258
|
+
# resp.evaluation_form.evaluation_form_arn #=> String
|
3259
|
+
# resp.evaluation_form.title #=> String
|
3260
|
+
# resp.evaluation_form.description #=> String
|
3261
|
+
# resp.evaluation_form.items #=> Array
|
3262
|
+
# resp.evaluation_form.items[0].section.title #=> String
|
3263
|
+
# resp.evaluation_form.items[0].section.ref_id #=> String
|
3264
|
+
# resp.evaluation_form.items[0].section.instructions #=> String
|
3265
|
+
# resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
|
3266
|
+
# resp.evaluation_form.items[0].section.weight #=> Float
|
3267
|
+
# resp.evaluation_form.items[0].question.title #=> String
|
3268
|
+
# resp.evaluation_form.items[0].question.instructions #=> String
|
3269
|
+
# resp.evaluation_form.items[0].question.ref_id #=> String
|
3270
|
+
# resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
|
3271
|
+
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC"
|
3272
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
|
3273
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
|
3274
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
|
3275
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].min_value #=> Integer
|
3276
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].max_value #=> Integer
|
3277
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
3278
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
3279
|
+
# 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", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME"
|
3280
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
3281
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
|
3282
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].text #=> String
|
3283
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
|
3284
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
|
3285
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
|
3286
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
|
3287
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
|
3288
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
|
3289
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.option_ref_id #=> String
|
3290
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
|
3291
|
+
# resp.evaluation_form.items[0].question.weight #=> Float
|
3292
|
+
# resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY"
|
3293
|
+
# resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
|
3294
|
+
#
|
3295
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactEvaluation AWS API Documentation
|
3296
|
+
#
|
3297
|
+
# @overload describe_contact_evaluation(params = {})
|
3298
|
+
# @param [Hash] params ({})
|
3299
|
+
def describe_contact_evaluation(params = {}, options = {})
|
3300
|
+
req = build_request(:describe_contact_evaluation, params)
|
3301
|
+
req.send_request(options)
|
3302
|
+
end
|
3303
|
+
|
2897
3304
|
# Describes the specified flow.
|
2898
3305
|
#
|
2899
3306
|
# You can also create and update flows using the [Amazon Connect Flow
|
@@ -2986,6 +3393,94 @@ module Aws::Connect
|
|
2986
3393
|
req.send_request(options)
|
2987
3394
|
end
|
2988
3395
|
|
3396
|
+
# Describes an evaluation form in the specified Amazon Connect instance.
|
3397
|
+
# If the version property is not provided, the latest version of the
|
3398
|
+
# evaluation form is described.
|
3399
|
+
#
|
3400
|
+
# @option params [required, String] :instance_id
|
3401
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3402
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3403
|
+
#
|
3404
|
+
#
|
3405
|
+
#
|
3406
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3407
|
+
#
|
3408
|
+
# @option params [required, String] :evaluation_form_id
|
3409
|
+
# A unique identifier for the contact evaluation.
|
3410
|
+
#
|
3411
|
+
# @option params [Integer] :evaluation_form_version
|
3412
|
+
# A version of the evaluation form.
|
3413
|
+
#
|
3414
|
+
# @return [Types::DescribeEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3415
|
+
#
|
3416
|
+
# * {Types::DescribeEvaluationFormResponse#evaluation_form #evaluation_form} => Types::EvaluationForm
|
3417
|
+
#
|
3418
|
+
# @example Request syntax with placeholder values
|
3419
|
+
#
|
3420
|
+
# resp = client.describe_evaluation_form({
|
3421
|
+
# instance_id: "InstanceId", # required
|
3422
|
+
# evaluation_form_id: "ResourceId", # required
|
3423
|
+
# evaluation_form_version: 1,
|
3424
|
+
# })
|
3425
|
+
#
|
3426
|
+
# @example Response structure
|
3427
|
+
#
|
3428
|
+
# resp.evaluation_form.evaluation_form_id #=> String
|
3429
|
+
# resp.evaluation_form.evaluation_form_version #=> Integer
|
3430
|
+
# resp.evaluation_form.locked #=> Boolean
|
3431
|
+
# resp.evaluation_form.evaluation_form_arn #=> String
|
3432
|
+
# resp.evaluation_form.title #=> String
|
3433
|
+
# resp.evaluation_form.description #=> String
|
3434
|
+
# resp.evaluation_form.status #=> String, one of "DRAFT", "ACTIVE"
|
3435
|
+
# resp.evaluation_form.items #=> Array
|
3436
|
+
# resp.evaluation_form.items[0].section.title #=> String
|
3437
|
+
# resp.evaluation_form.items[0].section.ref_id #=> String
|
3438
|
+
# resp.evaluation_form.items[0].section.instructions #=> String
|
3439
|
+
# resp.evaluation_form.items[0].section.items #=> Types::EvaluationFormItemsList
|
3440
|
+
# resp.evaluation_form.items[0].section.weight #=> Float
|
3441
|
+
# resp.evaluation_form.items[0].question.title #=> String
|
3442
|
+
# resp.evaluation_form.items[0].question.instructions #=> String
|
3443
|
+
# resp.evaluation_form.items[0].question.ref_id #=> String
|
3444
|
+
# resp.evaluation_form.items[0].question.not_applicable_enabled #=> Boolean
|
3445
|
+
# resp.evaluation_form.items[0].question.question_type #=> String, one of "TEXT", "SINGLESELECT", "NUMERIC"
|
3446
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.min_value #=> Integer
|
3447
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.max_value #=> Integer
|
3448
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options #=> Array
|
3449
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].min_value #=> Integer
|
3450
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].max_value #=> Integer
|
3451
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].score #=> Integer
|
3452
|
+
# resp.evaluation_form.items[0].question.question_type_properties.numeric.options[0].automatic_fail #=> Boolean
|
3453
|
+
# 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", "NON_TALK_TIME", "NON_TALK_TIME_PERCENTAGE", "NUMBER_OF_INTERRUPTIONS", "CONTACT_DURATION", "AGENT_INTERACTION_DURATION", "CUSTOMER_HOLD_TIME"
|
3454
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options #=> Array
|
3455
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].ref_id #=> String
|
3456
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].text #=> String
|
3457
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].score #=> Integer
|
3458
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.options[0].automatic_fail #=> Boolean
|
3459
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.display_as #=> String, one of "DROPDOWN", "RADIO"
|
3460
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options #=> Array
|
3461
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.category #=> String
|
3462
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.condition #=> String, one of "PRESENT", "NOT_PRESENT"
|
3463
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.options[0].rule_category.option_ref_id #=> String
|
3464
|
+
# resp.evaluation_form.items[0].question.question_type_properties.single_select.automation.default_option_ref_id #=> String
|
3465
|
+
# resp.evaluation_form.items[0].question.weight #=> Float
|
3466
|
+
# resp.evaluation_form.scoring_strategy.mode #=> String, one of "QUESTION_ONLY", "SECTION_ONLY"
|
3467
|
+
# resp.evaluation_form.scoring_strategy.status #=> String, one of "ENABLED", "DISABLED"
|
3468
|
+
# resp.evaluation_form.created_time #=> Time
|
3469
|
+
# resp.evaluation_form.created_by #=> String
|
3470
|
+
# resp.evaluation_form.last_modified_time #=> Time
|
3471
|
+
# resp.evaluation_form.last_modified_by #=> String
|
3472
|
+
# resp.evaluation_form.tags #=> Hash
|
3473
|
+
# resp.evaluation_form.tags["TagKey"] #=> String
|
3474
|
+
#
|
3475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEvaluationForm AWS API Documentation
|
3476
|
+
#
|
3477
|
+
# @overload describe_evaluation_form(params = {})
|
3478
|
+
# @param [Hash] params ({})
|
3479
|
+
def describe_evaluation_form(params = {}, options = {})
|
3480
|
+
req = build_request(:describe_evaluation_form, params)
|
3481
|
+
req.send_request(options)
|
3482
|
+
end
|
3483
|
+
|
2989
3484
|
# This API is in preview release for Amazon Connect and is subject to
|
2990
3485
|
# change.
|
2991
3486
|
#
|
@@ -5557,6 +6052,67 @@ module Aws::Connect
|
|
5557
6052
|
req.send_request(options)
|
5558
6053
|
end
|
5559
6054
|
|
6055
|
+
# Lists contact evaluations in the specified Amazon Connect instance.
|
6056
|
+
#
|
6057
|
+
# @option params [required, String] :instance_id
|
6058
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
6059
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
6060
|
+
#
|
6061
|
+
#
|
6062
|
+
#
|
6063
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6064
|
+
#
|
6065
|
+
# @option params [required, String] :contact_id
|
6066
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
6067
|
+
#
|
6068
|
+
# @option params [String] :next_token
|
6069
|
+
# The token for the next set of results. Use the value returned in the
|
6070
|
+
# previous response in the next request to retrieve the next set of
|
6071
|
+
# results.
|
6072
|
+
#
|
6073
|
+
# This is not expected to be set because the value returned in the
|
6074
|
+
# previous response is always null.
|
6075
|
+
#
|
6076
|
+
# @return [Types::ListContactEvaluationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6077
|
+
#
|
6078
|
+
# * {Types::ListContactEvaluationsResponse#evaluation_summary_list #evaluation_summary_list} => Array<Types::EvaluationSummary>
|
6079
|
+
# * {Types::ListContactEvaluationsResponse#next_token #next_token} => String
|
6080
|
+
#
|
6081
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6082
|
+
#
|
6083
|
+
# @example Request syntax with placeholder values
|
6084
|
+
#
|
6085
|
+
# resp = client.list_contact_evaluations({
|
6086
|
+
# instance_id: "InstanceId", # required
|
6087
|
+
# contact_id: "ContactId", # required
|
6088
|
+
# next_token: "NextToken",
|
6089
|
+
# })
|
6090
|
+
#
|
6091
|
+
# @example Response structure
|
6092
|
+
#
|
6093
|
+
# resp.evaluation_summary_list #=> Array
|
6094
|
+
# resp.evaluation_summary_list[0].evaluation_id #=> String
|
6095
|
+
# resp.evaluation_summary_list[0].evaluation_arn #=> String
|
6096
|
+
# resp.evaluation_summary_list[0].evaluation_form_title #=> String
|
6097
|
+
# resp.evaluation_summary_list[0].evaluation_form_id #=> String
|
6098
|
+
# resp.evaluation_summary_list[0].status #=> String, one of "DRAFT", "SUBMITTED"
|
6099
|
+
# resp.evaluation_summary_list[0].evaluator_arn #=> String
|
6100
|
+
# resp.evaluation_summary_list[0].score.percentage #=> Float
|
6101
|
+
# resp.evaluation_summary_list[0].score.not_applicable #=> Boolean
|
6102
|
+
# resp.evaluation_summary_list[0].score.automatic_fail #=> Boolean
|
6103
|
+
# resp.evaluation_summary_list[0].created_time #=> Time
|
6104
|
+
# resp.evaluation_summary_list[0].last_modified_time #=> Time
|
6105
|
+
# resp.next_token #=> String
|
6106
|
+
#
|
6107
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactEvaluations AWS API Documentation
|
6108
|
+
#
|
6109
|
+
# @overload list_contact_evaluations(params = {})
|
6110
|
+
# @param [Hash] params ({})
|
6111
|
+
def list_contact_evaluations(params = {}, options = {})
|
6112
|
+
req = build_request(:list_contact_evaluations, params)
|
6113
|
+
req.send_request(options)
|
6114
|
+
end
|
6115
|
+
|
5560
6116
|
# Provides information about the flow modules for the specified Amazon
|
5561
6117
|
# Connect instance.
|
5562
6118
|
#
|
@@ -5815,6 +6371,125 @@ module Aws::Connect
|
|
5815
6371
|
req.send_request(options)
|
5816
6372
|
end
|
5817
6373
|
|
6374
|
+
# Lists versions of an evaluation form in the specified Amazon Connect
|
6375
|
+
# instance.
|
6376
|
+
#
|
6377
|
+
# @option params [required, String] :instance_id
|
6378
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
6379
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
6380
|
+
#
|
6381
|
+
#
|
6382
|
+
#
|
6383
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6384
|
+
#
|
6385
|
+
# @option params [required, String] :evaluation_form_id
|
6386
|
+
# The unique identifier for the evaluation form.
|
6387
|
+
#
|
6388
|
+
# @option params [Integer] :max_results
|
6389
|
+
# The maximum number of results to return per page.
|
6390
|
+
#
|
6391
|
+
# @option params [String] :next_token
|
6392
|
+
# The token for the next set of results. Use the value returned in the
|
6393
|
+
# previous response in the next request to retrieve the next set of
|
6394
|
+
# results.
|
6395
|
+
#
|
6396
|
+
# @return [Types::ListEvaluationFormVersionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6397
|
+
#
|
6398
|
+
# * {Types::ListEvaluationFormVersionsResponse#evaluation_form_version_summary_list #evaluation_form_version_summary_list} => Array<Types::EvaluationFormVersionSummary>
|
6399
|
+
# * {Types::ListEvaluationFormVersionsResponse#next_token #next_token} => String
|
6400
|
+
#
|
6401
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6402
|
+
#
|
6403
|
+
# @example Request syntax with placeholder values
|
6404
|
+
#
|
6405
|
+
# resp = client.list_evaluation_form_versions({
|
6406
|
+
# instance_id: "InstanceId", # required
|
6407
|
+
# evaluation_form_id: "ResourceId", # required
|
6408
|
+
# max_results: 1,
|
6409
|
+
# next_token: "NextToken",
|
6410
|
+
# })
|
6411
|
+
#
|
6412
|
+
# @example Response structure
|
6413
|
+
#
|
6414
|
+
# resp.evaluation_form_version_summary_list #=> Array
|
6415
|
+
# resp.evaluation_form_version_summary_list[0].evaluation_form_arn #=> String
|
6416
|
+
# resp.evaluation_form_version_summary_list[0].evaluation_form_id #=> String
|
6417
|
+
# resp.evaluation_form_version_summary_list[0].evaluation_form_version #=> Integer
|
6418
|
+
# resp.evaluation_form_version_summary_list[0].locked #=> Boolean
|
6419
|
+
# resp.evaluation_form_version_summary_list[0].status #=> String, one of "DRAFT", "ACTIVE"
|
6420
|
+
# resp.evaluation_form_version_summary_list[0].created_time #=> Time
|
6421
|
+
# resp.evaluation_form_version_summary_list[0].created_by #=> String
|
6422
|
+
# resp.evaluation_form_version_summary_list[0].last_modified_time #=> Time
|
6423
|
+
# resp.evaluation_form_version_summary_list[0].last_modified_by #=> String
|
6424
|
+
# resp.next_token #=> String
|
6425
|
+
#
|
6426
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationFormVersions AWS API Documentation
|
6427
|
+
#
|
6428
|
+
# @overload list_evaluation_form_versions(params = {})
|
6429
|
+
# @param [Hash] params ({})
|
6430
|
+
def list_evaluation_form_versions(params = {}, options = {})
|
6431
|
+
req = build_request(:list_evaluation_form_versions, params)
|
6432
|
+
req.send_request(options)
|
6433
|
+
end
|
6434
|
+
|
6435
|
+
# Lists evaluation forms in the specified Amazon Connect instance.
|
6436
|
+
#
|
6437
|
+
# @option params [required, String] :instance_id
|
6438
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
6439
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
6440
|
+
#
|
6441
|
+
#
|
6442
|
+
#
|
6443
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6444
|
+
#
|
6445
|
+
# @option params [Integer] :max_results
|
6446
|
+
# The maximum number of results to return per page.
|
6447
|
+
#
|
6448
|
+
# @option params [String] :next_token
|
6449
|
+
# The token for the next set of results. Use the value returned in the
|
6450
|
+
# previous response in the next request to retrieve the next set of
|
6451
|
+
# results.
|
6452
|
+
#
|
6453
|
+
# @return [Types::ListEvaluationFormsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6454
|
+
#
|
6455
|
+
# * {Types::ListEvaluationFormsResponse#evaluation_form_summary_list #evaluation_form_summary_list} => Array<Types::EvaluationFormSummary>
|
6456
|
+
# * {Types::ListEvaluationFormsResponse#next_token #next_token} => String
|
6457
|
+
#
|
6458
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6459
|
+
#
|
6460
|
+
# @example Request syntax with placeholder values
|
6461
|
+
#
|
6462
|
+
# resp = client.list_evaluation_forms({
|
6463
|
+
# instance_id: "InstanceId", # required
|
6464
|
+
# max_results: 1,
|
6465
|
+
# next_token: "NextToken",
|
6466
|
+
# })
|
6467
|
+
#
|
6468
|
+
# @example Response structure
|
6469
|
+
#
|
6470
|
+
# resp.evaluation_form_summary_list #=> Array
|
6471
|
+
# resp.evaluation_form_summary_list[0].evaluation_form_id #=> String
|
6472
|
+
# resp.evaluation_form_summary_list[0].evaluation_form_arn #=> String
|
6473
|
+
# resp.evaluation_form_summary_list[0].title #=> String
|
6474
|
+
# resp.evaluation_form_summary_list[0].created_time #=> Time
|
6475
|
+
# resp.evaluation_form_summary_list[0].created_by #=> String
|
6476
|
+
# resp.evaluation_form_summary_list[0].last_modified_time #=> Time
|
6477
|
+
# resp.evaluation_form_summary_list[0].last_modified_by #=> String
|
6478
|
+
# resp.evaluation_form_summary_list[0].last_activated_time #=> Time
|
6479
|
+
# resp.evaluation_form_summary_list[0].last_activated_by #=> String
|
6480
|
+
# resp.evaluation_form_summary_list[0].latest_version #=> Integer
|
6481
|
+
# resp.evaluation_form_summary_list[0].active_version #=> Integer
|
6482
|
+
# resp.next_token #=> String
|
6483
|
+
#
|
6484
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationForms AWS API Documentation
|
6485
|
+
#
|
6486
|
+
# @overload list_evaluation_forms(params = {})
|
6487
|
+
# @param [Hash] params ({})
|
6488
|
+
def list_evaluation_forms(params = {}, options = {})
|
6489
|
+
req = build_request(:list_evaluation_forms, params)
|
6490
|
+
req.send_request(options)
|
6491
|
+
end
|
6492
|
+
|
5818
6493
|
# Provides information about the hours of operation for the specified
|
5819
6494
|
# Amazon Connect instance.
|
5820
6495
|
#
|
@@ -8333,6 +9008,72 @@ module Aws::Connect
|
|
8333
9008
|
req.send_request(options)
|
8334
9009
|
end
|
8335
9010
|
|
9011
|
+
# Starts an empty evaluation in the specified Amazon Connect instance,
|
9012
|
+
# using the given evaluation form for the particular contact. The
|
9013
|
+
# evaluation form version used for the contact evaluation corresponds to
|
9014
|
+
# the currently activated version. If no version is activated for the
|
9015
|
+
# evaluation form, the contact evaluation cannot be started.
|
9016
|
+
#
|
9017
|
+
# <note markdown="1"> Evaluations created through the public API do not contain answer
|
9018
|
+
# values suggested from automation.
|
9019
|
+
#
|
9020
|
+
# </note>
|
9021
|
+
#
|
9022
|
+
# @option params [required, String] :instance_id
|
9023
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
9024
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
9025
|
+
#
|
9026
|
+
#
|
9027
|
+
#
|
9028
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
9029
|
+
#
|
9030
|
+
# @option params [required, String] :contact_id
|
9031
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
9032
|
+
#
|
9033
|
+
# @option params [required, String] :evaluation_form_id
|
9034
|
+
# The unique identifier for the evaluation form.
|
9035
|
+
#
|
9036
|
+
# @option params [String] :client_token
|
9037
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
9038
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
9039
|
+
# SDK populates this field. For more information about idempotency, see
|
9040
|
+
# [Making retries safe with idempotent APIs][1].
|
9041
|
+
#
|
9042
|
+
# **A suitable default value is auto-generated.** You should normally
|
9043
|
+
# not need to pass this option.**
|
9044
|
+
#
|
9045
|
+
#
|
9046
|
+
#
|
9047
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
9048
|
+
#
|
9049
|
+
# @return [Types::StartContactEvaluationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9050
|
+
#
|
9051
|
+
# * {Types::StartContactEvaluationResponse#evaluation_id #evaluation_id} => String
|
9052
|
+
# * {Types::StartContactEvaluationResponse#evaluation_arn #evaluation_arn} => String
|
9053
|
+
#
|
9054
|
+
# @example Request syntax with placeholder values
|
9055
|
+
#
|
9056
|
+
# resp = client.start_contact_evaluation({
|
9057
|
+
# instance_id: "InstanceId", # required
|
9058
|
+
# contact_id: "ContactId", # required
|
9059
|
+
# evaluation_form_id: "ResourceId", # required
|
9060
|
+
# client_token: "ClientToken",
|
9061
|
+
# })
|
9062
|
+
#
|
9063
|
+
# @example Response structure
|
9064
|
+
#
|
9065
|
+
# resp.evaluation_id #=> String
|
9066
|
+
# resp.evaluation_arn #=> String
|
9067
|
+
#
|
9068
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactEvaluation AWS API Documentation
|
9069
|
+
#
|
9070
|
+
# @overload start_contact_evaluation(params = {})
|
9071
|
+
# @param [Hash] params ({})
|
9072
|
+
def start_contact_evaluation(params = {}, options = {})
|
9073
|
+
req = build_request(:start_contact_evaluation, params)
|
9074
|
+
req.send_request(options)
|
9075
|
+
end
|
9076
|
+
|
8336
9077
|
# Starts recording the contact:
|
8337
9078
|
#
|
8338
9079
|
# * If the API is called *before* the agent joins the call, recording
|
@@ -8839,6 +9580,73 @@ module Aws::Connect
|
|
8839
9580
|
req.send_request(options)
|
8840
9581
|
end
|
8841
9582
|
|
9583
|
+
# Submits a contact evaluation in the specified Amazon Connect instance.
|
9584
|
+
# Answers included in the request are merged with existing answers for
|
9585
|
+
# the given evaluation. If no answers or notes are passed, the
|
9586
|
+
# evaluation is submitted with the existing answers and notes. You can
|
9587
|
+
# delete an answer or note by passing an empty object (`\{\}`) to the
|
9588
|
+
# question identifier.
|
9589
|
+
#
|
9590
|
+
# If a contact evaluation is already in submitted state, this operation
|
9591
|
+
# will trigger a resubmission.
|
9592
|
+
#
|
9593
|
+
# @option params [required, String] :instance_id
|
9594
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
9595
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
9596
|
+
#
|
9597
|
+
#
|
9598
|
+
#
|
9599
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
9600
|
+
#
|
9601
|
+
# @option params [required, String] :evaluation_id
|
9602
|
+
# A unique identifier for the contact evaluation.
|
9603
|
+
#
|
9604
|
+
# @option params [Hash<String,Types::EvaluationAnswerInput>] :answers
|
9605
|
+
# A map of question identifiers to answer value.
|
9606
|
+
#
|
9607
|
+
# @option params [Hash<String,Types::EvaluationNote>] :notes
|
9608
|
+
# A map of question identifiers to note value.
|
9609
|
+
#
|
9610
|
+
# @return [Types::SubmitContactEvaluationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
9611
|
+
#
|
9612
|
+
# * {Types::SubmitContactEvaluationResponse#evaluation_id #evaluation_id} => String
|
9613
|
+
# * {Types::SubmitContactEvaluationResponse#evaluation_arn #evaluation_arn} => String
|
9614
|
+
#
|
9615
|
+
# @example Request syntax with placeholder values
|
9616
|
+
#
|
9617
|
+
# resp = client.submit_contact_evaluation({
|
9618
|
+
# instance_id: "InstanceId", # required
|
9619
|
+
# evaluation_id: "ResourceId", # required
|
9620
|
+
# answers: {
|
9621
|
+
# "ResourceId" => {
|
9622
|
+
# value: {
|
9623
|
+
# string_value: "EvaluationAnswerDataStringValue",
|
9624
|
+
# numeric_value: 1.0,
|
9625
|
+
# not_applicable: false,
|
9626
|
+
# },
|
9627
|
+
# },
|
9628
|
+
# },
|
9629
|
+
# notes: {
|
9630
|
+
# "ResourceId" => {
|
9631
|
+
# value: "EvaluationNoteString",
|
9632
|
+
# },
|
9633
|
+
# },
|
9634
|
+
# })
|
9635
|
+
#
|
9636
|
+
# @example Response structure
|
9637
|
+
#
|
9638
|
+
# resp.evaluation_id #=> String
|
9639
|
+
# resp.evaluation_arn #=> String
|
9640
|
+
#
|
9641
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SubmitContactEvaluation AWS API Documentation
|
9642
|
+
#
|
9643
|
+
# @overload submit_contact_evaluation(params = {})
|
9644
|
+
# @param [Hash] params ({})
|
9645
|
+
def submit_contact_evaluation(params = {}, options = {})
|
9646
|
+
req = build_request(:submit_contact_evaluation, params)
|
9647
|
+
req.send_request(options)
|
9648
|
+
end
|
9649
|
+
|
8842
9650
|
# When a contact is being recorded, this API suspends recording the
|
8843
9651
|
# call. For example, you might suspend the call recording while
|
8844
9652
|
# collecting sensitive information, such as a credit card number. Then
|
@@ -9211,6 +10019,69 @@ module Aws::Connect
|
|
9211
10019
|
req.send_request(options)
|
9212
10020
|
end
|
9213
10021
|
|
10022
|
+
# Updates details about a contact evaluation in the specified Amazon
|
10023
|
+
# Connect instance. A contact evaluation must be in draft state. Answers
|
10024
|
+
# included in the request are merged with existing answers for the given
|
10025
|
+
# evaluation. An answer or note can be deleted by passing an empty
|
10026
|
+
# object (`\{\}`) to the question identifier.
|
10027
|
+
#
|
10028
|
+
# @option params [required, String] :instance_id
|
10029
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
10030
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
10031
|
+
#
|
10032
|
+
#
|
10033
|
+
#
|
10034
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
10035
|
+
#
|
10036
|
+
# @option params [required, String] :evaluation_id
|
10037
|
+
# A unique identifier for the contact evaluation.
|
10038
|
+
#
|
10039
|
+
# @option params [Hash<String,Types::EvaluationAnswerInput>] :answers
|
10040
|
+
# A map of question identifiers to answer value.
|
10041
|
+
#
|
10042
|
+
# @option params [Hash<String,Types::EvaluationNote>] :notes
|
10043
|
+
# A map of question identifiers to note value.
|
10044
|
+
#
|
10045
|
+
# @return [Types::UpdateContactEvaluationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10046
|
+
#
|
10047
|
+
# * {Types::UpdateContactEvaluationResponse#evaluation_id #evaluation_id} => String
|
10048
|
+
# * {Types::UpdateContactEvaluationResponse#evaluation_arn #evaluation_arn} => String
|
10049
|
+
#
|
10050
|
+
# @example Request syntax with placeholder values
|
10051
|
+
#
|
10052
|
+
# resp = client.update_contact_evaluation({
|
10053
|
+
# instance_id: "InstanceId", # required
|
10054
|
+
# evaluation_id: "ResourceId", # required
|
10055
|
+
# answers: {
|
10056
|
+
# "ResourceId" => {
|
10057
|
+
# value: {
|
10058
|
+
# string_value: "EvaluationAnswerDataStringValue",
|
10059
|
+
# numeric_value: 1.0,
|
10060
|
+
# not_applicable: false,
|
10061
|
+
# },
|
10062
|
+
# },
|
10063
|
+
# },
|
10064
|
+
# notes: {
|
10065
|
+
# "ResourceId" => {
|
10066
|
+
# value: "EvaluationNoteString",
|
10067
|
+
# },
|
10068
|
+
# },
|
10069
|
+
# })
|
10070
|
+
#
|
10071
|
+
# @example Response structure
|
10072
|
+
#
|
10073
|
+
# resp.evaluation_id #=> String
|
10074
|
+
# resp.evaluation_arn #=> String
|
10075
|
+
#
|
10076
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactEvaluation AWS API Documentation
|
10077
|
+
#
|
10078
|
+
# @overload update_contact_evaluation(params = {})
|
10079
|
+
# @param [Hash] params ({})
|
10080
|
+
def update_contact_evaluation(params = {}, options = {})
|
10081
|
+
req = build_request(:update_contact_evaluation, params)
|
10082
|
+
req.send_request(options)
|
10083
|
+
end
|
10084
|
+
|
9214
10085
|
# Updates the specified flow.
|
9215
10086
|
#
|
9216
10087
|
# You can also create and update flows using the [Amazon Connect Flow
|
@@ -9454,6 +10325,158 @@ module Aws::Connect
|
|
9454
10325
|
req.send_request(options)
|
9455
10326
|
end
|
9456
10327
|
|
10328
|
+
# Updates details about a specific evaluation form version in the
|
10329
|
+
# specified Amazon Connect instance. An evaluation form must have a
|
10330
|
+
# unique title within an instance. Question and section identifiers
|
10331
|
+
# cannot be duplicated within the same evaluation form.
|
10332
|
+
#
|
10333
|
+
# This operation does not support partial updates. Instead it does a
|
10334
|
+
# full update of evaluation form content.
|
10335
|
+
#
|
10336
|
+
# @option params [required, String] :instance_id
|
10337
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
10338
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
10339
|
+
#
|
10340
|
+
#
|
10341
|
+
#
|
10342
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
10343
|
+
#
|
10344
|
+
# @option params [required, String] :evaluation_form_id
|
10345
|
+
# The unique identifier for the evaluation form.
|
10346
|
+
#
|
10347
|
+
# @option params [required, Integer] :evaluation_form_version
|
10348
|
+
# A version of the evaluation form to update.
|
10349
|
+
#
|
10350
|
+
# @option params [Boolean] :create_new_version
|
10351
|
+
# A flag indicating whether the operation must create a new version.
|
10352
|
+
#
|
10353
|
+
# @option params [required, String] :title
|
10354
|
+
# A unique title of the evaluation form.
|
10355
|
+
#
|
10356
|
+
# @option params [String] :description
|
10357
|
+
# The description of the evaluation form.
|
10358
|
+
#
|
10359
|
+
# @option params [required, Array<Types::EvaluationFormItem>] :items
|
10360
|
+
# Items that are part of the evaluation form. The total number of
|
10361
|
+
# sections and questions must not exceed 100 each. Questions must be
|
10362
|
+
# contained in a section.
|
10363
|
+
#
|
10364
|
+
# @option params [Types::EvaluationFormScoringStrategy] :scoring_strategy
|
10365
|
+
# A scoring strategy of the evaluation form.
|
10366
|
+
#
|
10367
|
+
# @option params [String] :client_token
|
10368
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
10369
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
10370
|
+
# SDK populates this field. For more information about idempotency, see
|
10371
|
+
# [Making retries safe with idempotent APIs][1].
|
10372
|
+
#
|
10373
|
+
# **A suitable default value is auto-generated.** You should normally
|
10374
|
+
# not need to pass this option.**
|
10375
|
+
#
|
10376
|
+
#
|
10377
|
+
#
|
10378
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
10379
|
+
#
|
10380
|
+
# @return [Types::UpdateEvaluationFormResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10381
|
+
#
|
10382
|
+
# * {Types::UpdateEvaluationFormResponse#evaluation_form_id #evaluation_form_id} => String
|
10383
|
+
# * {Types::UpdateEvaluationFormResponse#evaluation_form_arn #evaluation_form_arn} => String
|
10384
|
+
# * {Types::UpdateEvaluationFormResponse#evaluation_form_version #evaluation_form_version} => Integer
|
10385
|
+
#
|
10386
|
+
# @example Request syntax with placeholder values
|
10387
|
+
#
|
10388
|
+
# resp = client.update_evaluation_form({
|
10389
|
+
# instance_id: "InstanceId", # required
|
10390
|
+
# evaluation_form_id: "ResourceId", # required
|
10391
|
+
# evaluation_form_version: 1, # required
|
10392
|
+
# create_new_version: false,
|
10393
|
+
# title: "EvaluationFormTitle", # required
|
10394
|
+
# description: "EvaluationFormDescription",
|
10395
|
+
# items: [ # required
|
10396
|
+
# {
|
10397
|
+
# section: {
|
10398
|
+
# title: "EvaluationFormSectionTitle", # required
|
10399
|
+
# ref_id: "ReferenceId", # required
|
10400
|
+
# instructions: "EvaluationFormQuestionInstructions",
|
10401
|
+
# items: {
|
10402
|
+
# # recursive EvaluationFormItemsList
|
10403
|
+
# },
|
10404
|
+
# weight: 1.0,
|
10405
|
+
# },
|
10406
|
+
# question: {
|
10407
|
+
# title: "EvaluationFormQuestionTitle", # required
|
10408
|
+
# instructions: "EvaluationFormQuestionInstructions",
|
10409
|
+
# ref_id: "ReferenceId", # required
|
10410
|
+
# not_applicable_enabled: false,
|
10411
|
+
# question_type: "TEXT", # required, accepts TEXT, SINGLESELECT, NUMERIC
|
10412
|
+
# question_type_properties: {
|
10413
|
+
# numeric: {
|
10414
|
+
# min_value: 1, # required
|
10415
|
+
# max_value: 1, # required
|
10416
|
+
# options: [
|
10417
|
+
# {
|
10418
|
+
# min_value: 1, # required
|
10419
|
+
# max_value: 1, # required
|
10420
|
+
# score: 1,
|
10421
|
+
# automatic_fail: false,
|
10422
|
+
# },
|
10423
|
+
# ],
|
10424
|
+
# automation: {
|
10425
|
+
# property_value: {
|
10426
|
+
# label: "OVERALL_CUSTOMER_SENTIMENT_SCORE", # required, accepts OVERALL_CUSTOMER_SENTIMENT_SCORE, OVERALL_AGENT_SENTIMENT_SCORE, NON_TALK_TIME, NON_TALK_TIME_PERCENTAGE, NUMBER_OF_INTERRUPTIONS, CONTACT_DURATION, AGENT_INTERACTION_DURATION, CUSTOMER_HOLD_TIME
|
10427
|
+
# },
|
10428
|
+
# },
|
10429
|
+
# },
|
10430
|
+
# single_select: {
|
10431
|
+
# options: [ # required
|
10432
|
+
# {
|
10433
|
+
# ref_id: "ReferenceId", # required
|
10434
|
+
# text: "EvaluationFormSingleSelectQuestionOptionText", # required
|
10435
|
+
# score: 1,
|
10436
|
+
# automatic_fail: false,
|
10437
|
+
# },
|
10438
|
+
# ],
|
10439
|
+
# display_as: "DROPDOWN", # accepts DROPDOWN, RADIO
|
10440
|
+
# automation: {
|
10441
|
+
# options: [ # required
|
10442
|
+
# {
|
10443
|
+
# rule_category: {
|
10444
|
+
# category: "SingleSelectQuestionRuleCategoryAutomationLabel", # required
|
10445
|
+
# condition: "PRESENT", # required, accepts PRESENT, NOT_PRESENT
|
10446
|
+
# option_ref_id: "ReferenceId", # required
|
10447
|
+
# },
|
10448
|
+
# },
|
10449
|
+
# ],
|
10450
|
+
# default_option_ref_id: "ReferenceId",
|
10451
|
+
# },
|
10452
|
+
# },
|
10453
|
+
# },
|
10454
|
+
# weight: 1.0,
|
10455
|
+
# },
|
10456
|
+
# },
|
10457
|
+
# ],
|
10458
|
+
# scoring_strategy: {
|
10459
|
+
# mode: "QUESTION_ONLY", # required, accepts QUESTION_ONLY, SECTION_ONLY
|
10460
|
+
# status: "ENABLED", # required, accepts ENABLED, DISABLED
|
10461
|
+
# },
|
10462
|
+
# client_token: "ClientToken",
|
10463
|
+
# })
|
10464
|
+
#
|
10465
|
+
# @example Response structure
|
10466
|
+
#
|
10467
|
+
# resp.evaluation_form_id #=> String
|
10468
|
+
# resp.evaluation_form_arn #=> String
|
10469
|
+
# resp.evaluation_form_version #=> Integer
|
10470
|
+
#
|
10471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEvaluationForm AWS API Documentation
|
10472
|
+
#
|
10473
|
+
# @overload update_evaluation_form(params = {})
|
10474
|
+
# @param [Hash] params ({})
|
10475
|
+
def update_evaluation_form(params = {}, options = {})
|
10476
|
+
req = build_request(:update_evaluation_form, params)
|
10477
|
+
req.send_request(options)
|
10478
|
+
end
|
10479
|
+
|
9457
10480
|
# This API is in preview release for Amazon Connect and is subject to
|
9458
10481
|
# change.
|
9459
10482
|
#
|
@@ -10862,7 +11885,7 @@ module Aws::Connect
|
|
10862
11885
|
params: params,
|
10863
11886
|
config: config)
|
10864
11887
|
context[:gem_name] = 'aws-sdk-connect'
|
10865
|
-
context[:gem_version] = '1.
|
11888
|
+
context[:gem_version] = '1.103.0'
|
10866
11889
|
Seahorse::Client::Request.new(handlers, context)
|
10867
11890
|
end
|
10868
11891
|
|