aws-sdk-connect 1.101.0 → 1.103.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +1100 -5
- data/lib/aws-sdk-connect/client_api.rb +668 -0
- data/lib/aws-sdk-connect/endpoints.rb +210 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +30 -0
- data/lib/aws-sdk-connect/types.rb +1784 -45
- data/lib/aws-sdk-connect.rb +2 -2
- metadata +2 -2
@@ -37,6 +37,57 @@ module Aws::Connect
|
|
37
37
|
include Aws::Structure
|
38
38
|
end
|
39
39
|
|
40
|
+
# @!attribute [rw] instance_id
|
41
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
42
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
43
|
+
#
|
44
|
+
#
|
45
|
+
#
|
46
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
47
|
+
# @return [String]
|
48
|
+
#
|
49
|
+
# @!attribute [rw] evaluation_form_id
|
50
|
+
# The unique identifier for the evaluation form.
|
51
|
+
# @return [String]
|
52
|
+
#
|
53
|
+
# @!attribute [rw] evaluation_form_version
|
54
|
+
# The version of the evaluation form to activate. If the version
|
55
|
+
# property is not provided, the latest version of the evaluation form
|
56
|
+
# is activated.
|
57
|
+
# @return [Integer]
|
58
|
+
#
|
59
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ActivateEvaluationFormRequest AWS API Documentation
|
60
|
+
#
|
61
|
+
class ActivateEvaluationFormRequest < Struct.new(
|
62
|
+
:instance_id,
|
63
|
+
:evaluation_form_id,
|
64
|
+
:evaluation_form_version)
|
65
|
+
SENSITIVE = []
|
66
|
+
include Aws::Structure
|
67
|
+
end
|
68
|
+
|
69
|
+
# @!attribute [rw] evaluation_form_id
|
70
|
+
# The unique identifier for the evaluation form.
|
71
|
+
# @return [String]
|
72
|
+
#
|
73
|
+
# @!attribute [rw] evaluation_form_arn
|
74
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
75
|
+
# @return [String]
|
76
|
+
#
|
77
|
+
# @!attribute [rw] evaluation_form_version
|
78
|
+
# A version of the evaluation form.
|
79
|
+
# @return [Integer]
|
80
|
+
#
|
81
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ActivateEvaluationFormResponse AWS API Documentation
|
82
|
+
#
|
83
|
+
class ActivateEvaluationFormResponse < Struct.new(
|
84
|
+
:evaluation_form_id,
|
85
|
+
:evaluation_form_arn,
|
86
|
+
:evaluation_form_version)
|
87
|
+
SENSITIVE = []
|
88
|
+
include Aws::Structure
|
89
|
+
end
|
90
|
+
|
40
91
|
# Information about the [contact][1] associated to the user.
|
41
92
|
#
|
42
93
|
#
|
@@ -1380,6 +1431,77 @@ module Aws::Connect
|
|
1380
1431
|
include Aws::Structure
|
1381
1432
|
end
|
1382
1433
|
|
1434
|
+
# @!attribute [rw] instance_id
|
1435
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
1436
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
1437
|
+
#
|
1438
|
+
#
|
1439
|
+
#
|
1440
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1441
|
+
# @return [String]
|
1442
|
+
#
|
1443
|
+
# @!attribute [rw] title
|
1444
|
+
# A unique title of the evaluation form.
|
1445
|
+
# @return [String]
|
1446
|
+
#
|
1447
|
+
# @!attribute [rw] description
|
1448
|
+
# The description of the evaluation form.
|
1449
|
+
# @return [String]
|
1450
|
+
#
|
1451
|
+
# @!attribute [rw] items
|
1452
|
+
# Items that are part of the evaluation form. The total number of
|
1453
|
+
# sections and questions must not exceed 100 each. Questions must be
|
1454
|
+
# contained in a section.
|
1455
|
+
# @return [Array<Types::EvaluationFormItem>]
|
1456
|
+
#
|
1457
|
+
# @!attribute [rw] scoring_strategy
|
1458
|
+
# A scoring strategy of the evaluation form.
|
1459
|
+
# @return [Types::EvaluationFormScoringStrategy]
|
1460
|
+
#
|
1461
|
+
# @!attribute [rw] client_token
|
1462
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1463
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1464
|
+
# SDK populates this field. For more information about idempotency,
|
1465
|
+
# see [Making retries safe with idempotent APIs][1].
|
1466
|
+
#
|
1467
|
+
# **A suitable default value is auto-generated.** You should normally
|
1468
|
+
# not need to pass this option.
|
1469
|
+
#
|
1470
|
+
#
|
1471
|
+
#
|
1472
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1473
|
+
# @return [String]
|
1474
|
+
#
|
1475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationFormRequest AWS API Documentation
|
1476
|
+
#
|
1477
|
+
class CreateEvaluationFormRequest < Struct.new(
|
1478
|
+
:instance_id,
|
1479
|
+
:title,
|
1480
|
+
:description,
|
1481
|
+
:items,
|
1482
|
+
:scoring_strategy,
|
1483
|
+
:client_token)
|
1484
|
+
SENSITIVE = []
|
1485
|
+
include Aws::Structure
|
1486
|
+
end
|
1487
|
+
|
1488
|
+
# @!attribute [rw] evaluation_form_id
|
1489
|
+
# The unique identifier for the evaluation form.
|
1490
|
+
# @return [String]
|
1491
|
+
#
|
1492
|
+
# @!attribute [rw] evaluation_form_arn
|
1493
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
1494
|
+
# @return [String]
|
1495
|
+
#
|
1496
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationFormResponse AWS API Documentation
|
1497
|
+
#
|
1498
|
+
class CreateEvaluationFormResponse < Struct.new(
|
1499
|
+
:evaluation_form_id,
|
1500
|
+
:evaluation_form_arn)
|
1501
|
+
SENSITIVE = []
|
1502
|
+
include Aws::Structure
|
1503
|
+
end
|
1504
|
+
|
1383
1505
|
# @!attribute [rw] instance_id
|
1384
1506
|
# The identifier of the Amazon Connect instance. You can [find the
|
1385
1507
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -1570,6 +1692,73 @@ module Aws::Connect
|
|
1570
1692
|
include Aws::Structure
|
1571
1693
|
end
|
1572
1694
|
|
1695
|
+
# @!attribute [rw] instance_id
|
1696
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
1697
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
1698
|
+
#
|
1699
|
+
#
|
1700
|
+
#
|
1701
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
1702
|
+
# @return [String]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] contact_id
|
1705
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
1706
|
+
# Only contacts in the CHAT channel are supported.
|
1707
|
+
# @return [String]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] client_token
|
1710
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
1711
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
1712
|
+
# SDK populates this field. For more information about idempotency,
|
1713
|
+
# see [Making retries safe with idempotent APIs][1].
|
1714
|
+
#
|
1715
|
+
# **A suitable default value is auto-generated.** You should normally
|
1716
|
+
# not need to pass this option.
|
1717
|
+
#
|
1718
|
+
#
|
1719
|
+
#
|
1720
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
1721
|
+
# @return [String]
|
1722
|
+
#
|
1723
|
+
# @!attribute [rw] participant_details
|
1724
|
+
# Information identifying the participant.
|
1725
|
+
#
|
1726
|
+
# The only Valid value for `ParticipantRole` is `CUSTOM_BOT`.
|
1727
|
+
#
|
1728
|
+
# `DisplayName` is **Required**.
|
1729
|
+
# @return [Types::ParticipantDetailsToAdd]
|
1730
|
+
#
|
1731
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateParticipantRequest AWS API Documentation
|
1732
|
+
#
|
1733
|
+
class CreateParticipantRequest < Struct.new(
|
1734
|
+
:instance_id,
|
1735
|
+
:contact_id,
|
1736
|
+
:client_token,
|
1737
|
+
:participant_details)
|
1738
|
+
SENSITIVE = []
|
1739
|
+
include Aws::Structure
|
1740
|
+
end
|
1741
|
+
|
1742
|
+
# @!attribute [rw] participant_credentials
|
1743
|
+
# The token used by the chat participant to call
|
1744
|
+
# `CreateParticipantConnection`. The participant token is valid for
|
1745
|
+
# the lifetime of a chat participant.
|
1746
|
+
# @return [Types::ParticipantTokenCredentials]
|
1747
|
+
#
|
1748
|
+
# @!attribute [rw] participant_id
|
1749
|
+
# The identifier for a chat participant. The participantId for a chat
|
1750
|
+
# participant is the same throughout the chat lifecycle.
|
1751
|
+
# @return [String]
|
1752
|
+
#
|
1753
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateParticipantResponse AWS API Documentation
|
1754
|
+
#
|
1755
|
+
class CreateParticipantResponse < Struct.new(
|
1756
|
+
:participant_credentials,
|
1757
|
+
:participant_id)
|
1758
|
+
SENSITIVE = []
|
1759
|
+
include Aws::Structure
|
1760
|
+
end
|
1761
|
+
|
1573
1762
|
# @!attribute [rw] instance_id
|
1574
1763
|
# The identifier of the Amazon Connect instance. You can [find the
|
1575
1764
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -2532,6 +2721,56 @@ module Aws::Connect
|
|
2532
2721
|
include Aws::Structure
|
2533
2722
|
end
|
2534
2723
|
|
2724
|
+
# @!attribute [rw] instance_id
|
2725
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2726
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2727
|
+
#
|
2728
|
+
#
|
2729
|
+
#
|
2730
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2731
|
+
# @return [String]
|
2732
|
+
#
|
2733
|
+
# @!attribute [rw] evaluation_form_id
|
2734
|
+
# The unique identifier for the evaluation form.
|
2735
|
+
# @return [String]
|
2736
|
+
#
|
2737
|
+
# @!attribute [rw] evaluation_form_version
|
2738
|
+
# A version of the evaluation form. If the version property is not
|
2739
|
+
# provided, the latest version of the evaluation form is deactivated.
|
2740
|
+
# @return [Integer]
|
2741
|
+
#
|
2742
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeactivateEvaluationFormRequest AWS API Documentation
|
2743
|
+
#
|
2744
|
+
class DeactivateEvaluationFormRequest < Struct.new(
|
2745
|
+
:instance_id,
|
2746
|
+
:evaluation_form_id,
|
2747
|
+
:evaluation_form_version)
|
2748
|
+
SENSITIVE = []
|
2749
|
+
include Aws::Structure
|
2750
|
+
end
|
2751
|
+
|
2752
|
+
# @!attribute [rw] evaluation_form_id
|
2753
|
+
# The unique identifier for the evaluation form.
|
2754
|
+
# @return [String]
|
2755
|
+
#
|
2756
|
+
# @!attribute [rw] evaluation_form_arn
|
2757
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
2758
|
+
# @return [String]
|
2759
|
+
#
|
2760
|
+
# @!attribute [rw] evaluation_form_version
|
2761
|
+
# The version of the deactivated evaluation form resource.
|
2762
|
+
# @return [Integer]
|
2763
|
+
#
|
2764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeactivateEvaluationFormResponse AWS API Documentation
|
2765
|
+
#
|
2766
|
+
class DeactivateEvaluationFormResponse < Struct.new(
|
2767
|
+
:evaluation_form_id,
|
2768
|
+
:evaluation_form_arn,
|
2769
|
+
:evaluation_form_version)
|
2770
|
+
SENSITIVE = []
|
2771
|
+
include Aws::Structure
|
2772
|
+
end
|
2773
|
+
|
2535
2774
|
# Contains information about a default vocabulary.
|
2536
2775
|
#
|
2537
2776
|
# @!attribute [rw] instance_id
|
@@ -2572,6 +2811,28 @@ module Aws::Connect
|
|
2572
2811
|
include Aws::Structure
|
2573
2812
|
end
|
2574
2813
|
|
2814
|
+
# @!attribute [rw] instance_id
|
2815
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2816
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2817
|
+
#
|
2818
|
+
#
|
2819
|
+
#
|
2820
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2821
|
+
# @return [String]
|
2822
|
+
#
|
2823
|
+
# @!attribute [rw] evaluation_id
|
2824
|
+
# A unique identifier for the contact evaluation.
|
2825
|
+
# @return [String]
|
2826
|
+
#
|
2827
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteContactEvaluationRequest AWS API Documentation
|
2828
|
+
#
|
2829
|
+
class DeleteContactEvaluationRequest < Struct.new(
|
2830
|
+
:instance_id,
|
2831
|
+
:evaluation_id)
|
2832
|
+
SENSITIVE = []
|
2833
|
+
include Aws::Structure
|
2834
|
+
end
|
2835
|
+
|
2575
2836
|
# @!attribute [rw] instance_id
|
2576
2837
|
# The identifier of the Amazon Connect instance. You can [find the
|
2577
2838
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -2624,6 +2885,33 @@ module Aws::Connect
|
|
2624
2885
|
#
|
2625
2886
|
class DeleteContactFlowResponse < Aws::EmptyStructure; end
|
2626
2887
|
|
2888
|
+
# @!attribute [rw] instance_id
|
2889
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
2890
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
2891
|
+
#
|
2892
|
+
#
|
2893
|
+
#
|
2894
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
2895
|
+
# @return [String]
|
2896
|
+
#
|
2897
|
+
# @!attribute [rw] evaluation_form_id
|
2898
|
+
# The unique identifier for the evaluation form.
|
2899
|
+
# @return [String]
|
2900
|
+
#
|
2901
|
+
# @!attribute [rw] evaluation_form_version
|
2902
|
+
# The unique identifier for the evaluation form.
|
2903
|
+
# @return [Integer]
|
2904
|
+
#
|
2905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DeleteEvaluationFormRequest AWS API Documentation
|
2906
|
+
#
|
2907
|
+
class DeleteEvaluationFormRequest < Struct.new(
|
2908
|
+
:instance_id,
|
2909
|
+
:evaluation_form_id,
|
2910
|
+
:evaluation_form_version)
|
2911
|
+
SENSITIVE = []
|
2912
|
+
include Aws::Structure
|
2913
|
+
end
|
2914
|
+
|
2627
2915
|
# @!attribute [rw] instance_id
|
2628
2916
|
# The identifier of the Amazon Connect instance. You can [find the
|
2629
2917
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -2945,6 +3233,46 @@ module Aws::Connect
|
|
2945
3233
|
include Aws::Structure
|
2946
3234
|
end
|
2947
3235
|
|
3236
|
+
# @!attribute [rw] instance_id
|
3237
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3238
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3239
|
+
#
|
3240
|
+
#
|
3241
|
+
#
|
3242
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3243
|
+
# @return [String]
|
3244
|
+
#
|
3245
|
+
# @!attribute [rw] evaluation_id
|
3246
|
+
# A unique identifier for the contact evaluation.
|
3247
|
+
# @return [String]
|
3248
|
+
#
|
3249
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactEvaluationRequest AWS API Documentation
|
3250
|
+
#
|
3251
|
+
class DescribeContactEvaluationRequest < Struct.new(
|
3252
|
+
:instance_id,
|
3253
|
+
:evaluation_id)
|
3254
|
+
SENSITIVE = []
|
3255
|
+
include Aws::Structure
|
3256
|
+
end
|
3257
|
+
|
3258
|
+
# @!attribute [rw] evaluation
|
3259
|
+
# Information about the evaluation form completed for a specific
|
3260
|
+
# contact.
|
3261
|
+
# @return [Types::Evaluation]
|
3262
|
+
#
|
3263
|
+
# @!attribute [rw] evaluation_form
|
3264
|
+
# Information about the evaluation form.
|
3265
|
+
# @return [Types::EvaluationFormContent]
|
3266
|
+
#
|
3267
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeContactEvaluationResponse AWS API Documentation
|
3268
|
+
#
|
3269
|
+
class DescribeContactEvaluationResponse < Struct.new(
|
3270
|
+
:evaluation,
|
3271
|
+
:evaluation_form)
|
3272
|
+
SENSITIVE = []
|
3273
|
+
include Aws::Structure
|
3274
|
+
end
|
3275
|
+
|
2948
3276
|
# @!attribute [rw] instance_id
|
2949
3277
|
# The identifier of the Amazon Connect instance. You can [find the
|
2950
3278
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -3042,6 +3370,45 @@ module Aws::Connect
|
|
3042
3370
|
include Aws::Structure
|
3043
3371
|
end
|
3044
3372
|
|
3373
|
+
# @!attribute [rw] instance_id
|
3374
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
3375
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
3376
|
+
#
|
3377
|
+
#
|
3378
|
+
#
|
3379
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
3380
|
+
# @return [String]
|
3381
|
+
#
|
3382
|
+
# @!attribute [rw] evaluation_form_id
|
3383
|
+
# A unique identifier for the contact evaluation.
|
3384
|
+
# @return [String]
|
3385
|
+
#
|
3386
|
+
# @!attribute [rw] evaluation_form_version
|
3387
|
+
# A version of the evaluation form.
|
3388
|
+
# @return [Integer]
|
3389
|
+
#
|
3390
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEvaluationFormRequest AWS API Documentation
|
3391
|
+
#
|
3392
|
+
class DescribeEvaluationFormRequest < Struct.new(
|
3393
|
+
:instance_id,
|
3394
|
+
:evaluation_form_id,
|
3395
|
+
:evaluation_form_version)
|
3396
|
+
SENSITIVE = []
|
3397
|
+
include Aws::Structure
|
3398
|
+
end
|
3399
|
+
|
3400
|
+
# @!attribute [rw] evaluation_form
|
3401
|
+
# Information about the evaluation form.
|
3402
|
+
# @return [Types::EvaluationForm]
|
3403
|
+
#
|
3404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeEvaluationFormResponse AWS API Documentation
|
3405
|
+
#
|
3406
|
+
class DescribeEvaluationFormResponse < Struct.new(
|
3407
|
+
:evaluation_form)
|
3408
|
+
SENSITIVE = []
|
3409
|
+
include Aws::Structure
|
3410
|
+
end
|
3411
|
+
|
3045
3412
|
# @!attribute [rw] instance_id
|
3046
3413
|
# The identifier of the Amazon Connect instance. You can [find the
|
3047
3414
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -3911,20 +4278,881 @@ module Aws::Connect
|
|
3911
4278
|
include Aws::Structure
|
3912
4279
|
end
|
3913
4280
|
|
3914
|
-
#
|
4281
|
+
# Information about a contact evaluation.
|
3915
4282
|
#
|
3916
|
-
# @!attribute [rw]
|
3917
|
-
#
|
4283
|
+
# @!attribute [rw] evaluation_id
|
4284
|
+
# A unique identifier for the contact evaluation.
|
3918
4285
|
# @return [String]
|
3919
4286
|
#
|
3920
|
-
#
|
4287
|
+
# @!attribute [rw] evaluation_arn
|
4288
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
4289
|
+
# @return [String]
|
3921
4290
|
#
|
3922
|
-
|
3923
|
-
|
3924
|
-
|
3925
|
-
|
3926
|
-
|
3927
|
-
|
4291
|
+
# @!attribute [rw] metadata
|
4292
|
+
# Metadata about the contact evaluation.
|
4293
|
+
# @return [Types::EvaluationMetadata]
|
4294
|
+
#
|
4295
|
+
# @!attribute [rw] answers
|
4296
|
+
# A map of question identifiers to answer value.
|
4297
|
+
# @return [Hash<String,Types::EvaluationAnswerOutput>]
|
4298
|
+
#
|
4299
|
+
# @!attribute [rw] notes
|
4300
|
+
# A map of question identifiers to note value.
|
4301
|
+
# @return [Hash<String,Types::EvaluationNote>]
|
4302
|
+
#
|
4303
|
+
# @!attribute [rw] status
|
4304
|
+
# The status of the contact evaluation.
|
4305
|
+
# @return [String]
|
4306
|
+
#
|
4307
|
+
# @!attribute [rw] scores
|
4308
|
+
# A map of item (section or question) identifiers to score value.
|
4309
|
+
# @return [Hash<String,Types::EvaluationScore>]
|
4310
|
+
#
|
4311
|
+
# @!attribute [rw] created_time
|
4312
|
+
# The timestamp for when the evaluation was created.
|
4313
|
+
# @return [Time]
|
4314
|
+
#
|
4315
|
+
# @!attribute [rw] last_modified_time
|
4316
|
+
# The timestamp for when the evaluation was last updated.
|
4317
|
+
# @return [Time]
|
4318
|
+
#
|
4319
|
+
# @!attribute [rw] tags
|
4320
|
+
# The tags used to organize, track, or control access for this
|
4321
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
4322
|
+
# "key2":"value2"\\} \\}.
|
4323
|
+
# @return [Hash<String,String>]
|
4324
|
+
#
|
4325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Evaluation AWS API Documentation
|
4326
|
+
#
|
4327
|
+
class Evaluation < Struct.new(
|
4328
|
+
:evaluation_id,
|
4329
|
+
:evaluation_arn,
|
4330
|
+
:metadata,
|
4331
|
+
:answers,
|
4332
|
+
:notes,
|
4333
|
+
:status,
|
4334
|
+
:scores,
|
4335
|
+
:created_time,
|
4336
|
+
:last_modified_time,
|
4337
|
+
:tags)
|
4338
|
+
SENSITIVE = []
|
4339
|
+
include Aws::Structure
|
4340
|
+
end
|
4341
|
+
|
4342
|
+
# Information about answer data for a contact evaluation. Answer data
|
4343
|
+
# must be either string, numeric, or not applicable.
|
4344
|
+
#
|
4345
|
+
# @note EvaluationAnswerData is a union - when making an API calls you must set exactly one of the members.
|
4346
|
+
#
|
4347
|
+
# @note EvaluationAnswerData is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationAnswerData corresponding to the set member.
|
4348
|
+
#
|
4349
|
+
# @!attribute [rw] string_value
|
4350
|
+
# The string value for an answer in a contact evaluation.
|
4351
|
+
# @return [String]
|
4352
|
+
#
|
4353
|
+
# @!attribute [rw] numeric_value
|
4354
|
+
# The numeric value for an answer in a contact evaluation.
|
4355
|
+
# @return [Float]
|
4356
|
+
#
|
4357
|
+
# @!attribute [rw] not_applicable
|
4358
|
+
# The flag to mark the question as not applicable.
|
4359
|
+
# @return [Boolean]
|
4360
|
+
#
|
4361
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAnswerData AWS API Documentation
|
4362
|
+
#
|
4363
|
+
class EvaluationAnswerData < Struct.new(
|
4364
|
+
:string_value,
|
4365
|
+
:numeric_value,
|
4366
|
+
:not_applicable,
|
4367
|
+
:unknown)
|
4368
|
+
SENSITIVE = []
|
4369
|
+
include Aws::Structure
|
4370
|
+
include Aws::Structure::Union
|
4371
|
+
|
4372
|
+
class StringValue < EvaluationAnswerData; end
|
4373
|
+
class NumericValue < EvaluationAnswerData; end
|
4374
|
+
class NotApplicable < EvaluationAnswerData; end
|
4375
|
+
class Unknown < EvaluationAnswerData; end
|
4376
|
+
end
|
4377
|
+
|
4378
|
+
# Information about input answers for a contact evaluation.
|
4379
|
+
#
|
4380
|
+
# @!attribute [rw] value
|
4381
|
+
# The value for an answer in a contact evaluation.
|
4382
|
+
# @return [Types::EvaluationAnswerData]
|
4383
|
+
#
|
4384
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAnswerInput AWS API Documentation
|
4385
|
+
#
|
4386
|
+
class EvaluationAnswerInput < Struct.new(
|
4387
|
+
:value)
|
4388
|
+
SENSITIVE = []
|
4389
|
+
include Aws::Structure
|
4390
|
+
end
|
4391
|
+
|
4392
|
+
# Information about output answers for a contact evaluation.
|
4393
|
+
#
|
4394
|
+
# @!attribute [rw] value
|
4395
|
+
# The value for an answer in a contact evaluation.
|
4396
|
+
# @return [Types::EvaluationAnswerData]
|
4397
|
+
#
|
4398
|
+
# @!attribute [rw] system_suggested_value
|
4399
|
+
# The system suggested value for an answer in a contact evaluation.
|
4400
|
+
# @return [Types::EvaluationAnswerData]
|
4401
|
+
#
|
4402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAnswerOutput AWS API Documentation
|
4403
|
+
#
|
4404
|
+
class EvaluationAnswerOutput < Struct.new(
|
4405
|
+
:value,
|
4406
|
+
:system_suggested_value)
|
4407
|
+
SENSITIVE = []
|
4408
|
+
include Aws::Structure
|
4409
|
+
end
|
4410
|
+
|
4411
|
+
# Information about the evaluation form.
|
4412
|
+
#
|
4413
|
+
# @!attribute [rw] evaluation_form_id
|
4414
|
+
# The unique identifier for the evaluation form.
|
4415
|
+
# @return [String]
|
4416
|
+
#
|
4417
|
+
# @!attribute [rw] evaluation_form_version
|
4418
|
+
# A version of the evaluation form.
|
4419
|
+
# @return [Integer]
|
4420
|
+
#
|
4421
|
+
# @!attribute [rw] locked
|
4422
|
+
# The flag indicating whether the evaluation form is locked for
|
4423
|
+
# changes.
|
4424
|
+
# @return [Boolean]
|
4425
|
+
#
|
4426
|
+
# @!attribute [rw] evaluation_form_arn
|
4427
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
4428
|
+
# @return [String]
|
4429
|
+
#
|
4430
|
+
# @!attribute [rw] title
|
4431
|
+
# A unique title of the evaluation form.
|
4432
|
+
# @return [String]
|
4433
|
+
#
|
4434
|
+
# @!attribute [rw] description
|
4435
|
+
# The description of the evaluation form.
|
4436
|
+
# @return [String]
|
4437
|
+
#
|
4438
|
+
# @!attribute [rw] status
|
4439
|
+
# The status of the evaluation form.
|
4440
|
+
# @return [String]
|
4441
|
+
#
|
4442
|
+
# @!attribute [rw] items
|
4443
|
+
# Items that are part of the evaluation form. The total number of
|
4444
|
+
# sections and questions must not exceed 100 each. Questions must be
|
4445
|
+
# contained in a section.
|
4446
|
+
# @return [Array<Types::EvaluationFormItem>]
|
4447
|
+
#
|
4448
|
+
# @!attribute [rw] scoring_strategy
|
4449
|
+
# A scoring strategy of the evaluation form.
|
4450
|
+
# @return [Types::EvaluationFormScoringStrategy]
|
4451
|
+
#
|
4452
|
+
# @!attribute [rw] created_time
|
4453
|
+
# The timestamp for when the evaluation form was created.
|
4454
|
+
# @return [Time]
|
4455
|
+
#
|
4456
|
+
# @!attribute [rw] created_by
|
4457
|
+
# The Amazon Resource Name (ARN) of the user who created the
|
4458
|
+
# evaluation form.
|
4459
|
+
# @return [String]
|
4460
|
+
#
|
4461
|
+
# @!attribute [rw] last_modified_time
|
4462
|
+
# The timestamp for when the evaluation form was last updated.
|
4463
|
+
# @return [Time]
|
4464
|
+
#
|
4465
|
+
# @!attribute [rw] last_modified_by
|
4466
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
4467
|
+
# evaluation form.
|
4468
|
+
# @return [String]
|
4469
|
+
#
|
4470
|
+
# @!attribute [rw] tags
|
4471
|
+
# The tags used to organize, track, or control access for this
|
4472
|
+
# resource. For example, \\\{ "tags": \\\{"key1":"value1",
|
4473
|
+
# "key2":"value2"\\} \\}.
|
4474
|
+
# @return [Hash<String,String>]
|
4475
|
+
#
|
4476
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationForm AWS API Documentation
|
4477
|
+
#
|
4478
|
+
class EvaluationForm < Struct.new(
|
4479
|
+
:evaluation_form_id,
|
4480
|
+
:evaluation_form_version,
|
4481
|
+
:locked,
|
4482
|
+
:evaluation_form_arn,
|
4483
|
+
:title,
|
4484
|
+
:description,
|
4485
|
+
:status,
|
4486
|
+
:items,
|
4487
|
+
:scoring_strategy,
|
4488
|
+
:created_time,
|
4489
|
+
:created_by,
|
4490
|
+
:last_modified_time,
|
4491
|
+
:last_modified_by,
|
4492
|
+
:tags)
|
4493
|
+
SENSITIVE = []
|
4494
|
+
include Aws::Structure
|
4495
|
+
end
|
4496
|
+
|
4497
|
+
# Information about an evaluation form used in a contact evaluation.
|
4498
|
+
#
|
4499
|
+
# @!attribute [rw] evaluation_form_version
|
4500
|
+
# A version of the evaluation form.
|
4501
|
+
# @return [Integer]
|
4502
|
+
#
|
4503
|
+
# @!attribute [rw] evaluation_form_id
|
4504
|
+
# The unique identifier for the evaluation form.
|
4505
|
+
# @return [String]
|
4506
|
+
#
|
4507
|
+
# @!attribute [rw] evaluation_form_arn
|
4508
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
4509
|
+
# @return [String]
|
4510
|
+
#
|
4511
|
+
# @!attribute [rw] title
|
4512
|
+
# A unique title of the evaluation form.
|
4513
|
+
# @return [String]
|
4514
|
+
#
|
4515
|
+
# @!attribute [rw] description
|
4516
|
+
# The description of the evaluation form.
|
4517
|
+
# @return [String]
|
4518
|
+
#
|
4519
|
+
# @!attribute [rw] items
|
4520
|
+
# Items that are part of the evaluation form. The total number of
|
4521
|
+
# sections and questions must not exceed 100 each. Questions must be
|
4522
|
+
# contained in a section.
|
4523
|
+
# @return [Array<Types::EvaluationFormItem>]
|
4524
|
+
#
|
4525
|
+
# @!attribute [rw] scoring_strategy
|
4526
|
+
# A scoring strategy of the evaluation form.
|
4527
|
+
# @return [Types::EvaluationFormScoringStrategy]
|
4528
|
+
#
|
4529
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormContent AWS API Documentation
|
4530
|
+
#
|
4531
|
+
class EvaluationFormContent < Struct.new(
|
4532
|
+
:evaluation_form_version,
|
4533
|
+
:evaluation_form_id,
|
4534
|
+
:evaluation_form_arn,
|
4535
|
+
:title,
|
4536
|
+
:description,
|
4537
|
+
:items,
|
4538
|
+
:scoring_strategy)
|
4539
|
+
SENSITIVE = []
|
4540
|
+
include Aws::Structure
|
4541
|
+
end
|
4542
|
+
|
4543
|
+
# Information about an item from an evaluation form. The item must be
|
4544
|
+
# either a section or a question.
|
4545
|
+
#
|
4546
|
+
# @note EvaluationFormItem is a union - when making an API calls you must set exactly one of the members.
|
4547
|
+
#
|
4548
|
+
# @note EvaluationFormItem is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationFormItem corresponding to the set member.
|
4549
|
+
#
|
4550
|
+
# @!attribute [rw] section
|
4551
|
+
# The information of the section.
|
4552
|
+
# @return [Types::EvaluationFormSection]
|
4553
|
+
#
|
4554
|
+
# @!attribute [rw] question
|
4555
|
+
# The information of the question.
|
4556
|
+
# @return [Types::EvaluationFormQuestion]
|
4557
|
+
#
|
4558
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItem AWS API Documentation
|
4559
|
+
#
|
4560
|
+
class EvaluationFormItem < Struct.new(
|
4561
|
+
:section,
|
4562
|
+
:question,
|
4563
|
+
:unknown)
|
4564
|
+
SENSITIVE = []
|
4565
|
+
include Aws::Structure
|
4566
|
+
include Aws::Structure::Union
|
4567
|
+
|
4568
|
+
class Section < EvaluationFormItem; end
|
4569
|
+
class Question < EvaluationFormItem; end
|
4570
|
+
class Unknown < EvaluationFormItem; end
|
4571
|
+
end
|
4572
|
+
|
4573
|
+
# Information about the automation configuration in numeric questions.
|
4574
|
+
#
|
4575
|
+
# @note EvaluationFormNumericQuestionAutomation is a union - when making an API calls you must set exactly one of the members.
|
4576
|
+
#
|
4577
|
+
# @note EvaluationFormNumericQuestionAutomation is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationFormNumericQuestionAutomation corresponding to the set member.
|
4578
|
+
#
|
4579
|
+
# @!attribute [rw] property_value
|
4580
|
+
# The property value of the automation.
|
4581
|
+
# @return [Types::NumericQuestionPropertyValueAutomation]
|
4582
|
+
#
|
4583
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormNumericQuestionAutomation AWS API Documentation
|
4584
|
+
#
|
4585
|
+
class EvaluationFormNumericQuestionAutomation < Struct.new(
|
4586
|
+
:property_value,
|
4587
|
+
:unknown)
|
4588
|
+
SENSITIVE = []
|
4589
|
+
include Aws::Structure
|
4590
|
+
include Aws::Structure::Union
|
4591
|
+
|
4592
|
+
class PropertyValue < EvaluationFormNumericQuestionAutomation; end
|
4593
|
+
class Unknown < EvaluationFormNumericQuestionAutomation; end
|
4594
|
+
end
|
4595
|
+
|
4596
|
+
# Information about the option range used for scoring in numeric
|
4597
|
+
# questions.
|
4598
|
+
#
|
4599
|
+
# @!attribute [rw] min_value
|
4600
|
+
# The minimum answer value of the range option.
|
4601
|
+
# @return [Integer]
|
4602
|
+
#
|
4603
|
+
# @!attribute [rw] max_value
|
4604
|
+
# The maximum answer value of the range option.
|
4605
|
+
# @return [Integer]
|
4606
|
+
#
|
4607
|
+
# @!attribute [rw] score
|
4608
|
+
# The score assigned to answer values within the range option.
|
4609
|
+
# @return [Integer]
|
4610
|
+
#
|
4611
|
+
# @!attribute [rw] automatic_fail
|
4612
|
+
# The flag to mark the option as automatic fail. If an automatic fail
|
4613
|
+
# answer is provided, the overall evaluation gets a score of 0.
|
4614
|
+
# @return [Boolean]
|
4615
|
+
#
|
4616
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormNumericQuestionOption AWS API Documentation
|
4617
|
+
#
|
4618
|
+
class EvaluationFormNumericQuestionOption < Struct.new(
|
4619
|
+
:min_value,
|
4620
|
+
:max_value,
|
4621
|
+
:score,
|
4622
|
+
:automatic_fail)
|
4623
|
+
SENSITIVE = []
|
4624
|
+
include Aws::Structure
|
4625
|
+
end
|
4626
|
+
|
4627
|
+
# Information about properties for a numeric question in an evaluation
|
4628
|
+
# form.
|
4629
|
+
#
|
4630
|
+
# @!attribute [rw] min_value
|
4631
|
+
# The minimum answer value.
|
4632
|
+
# @return [Integer]
|
4633
|
+
#
|
4634
|
+
# @!attribute [rw] max_value
|
4635
|
+
# The maximum answer value.
|
4636
|
+
# @return [Integer]
|
4637
|
+
#
|
4638
|
+
# @!attribute [rw] options
|
4639
|
+
# The scoring options of the numeric question.
|
4640
|
+
# @return [Array<Types::EvaluationFormNumericQuestionOption>]
|
4641
|
+
#
|
4642
|
+
# @!attribute [rw] automation
|
4643
|
+
# The automation properties of the numeric question.
|
4644
|
+
# @return [Types::EvaluationFormNumericQuestionAutomation]
|
4645
|
+
#
|
4646
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormNumericQuestionProperties AWS API Documentation
|
4647
|
+
#
|
4648
|
+
class EvaluationFormNumericQuestionProperties < Struct.new(
|
4649
|
+
:min_value,
|
4650
|
+
:max_value,
|
4651
|
+
:options,
|
4652
|
+
:automation)
|
4653
|
+
SENSITIVE = []
|
4654
|
+
include Aws::Structure
|
4655
|
+
end
|
4656
|
+
|
4657
|
+
# Information about a question from an evaluation form.
|
4658
|
+
#
|
4659
|
+
# @!attribute [rw] title
|
4660
|
+
# The title of the question.
|
4661
|
+
# @return [String]
|
4662
|
+
#
|
4663
|
+
# @!attribute [rw] instructions
|
4664
|
+
# The instructions of the section.
|
4665
|
+
# @return [String]
|
4666
|
+
#
|
4667
|
+
# @!attribute [rw] ref_id
|
4668
|
+
# The identifier of the question. An identifier must be unique within
|
4669
|
+
# the evaluation form.
|
4670
|
+
# @return [String]
|
4671
|
+
#
|
4672
|
+
# @!attribute [rw] not_applicable_enabled
|
4673
|
+
# The flag to enable not applicable answers to the question.
|
4674
|
+
# @return [Boolean]
|
4675
|
+
#
|
4676
|
+
# @!attribute [rw] question_type
|
4677
|
+
# The type of the question.
|
4678
|
+
# @return [String]
|
4679
|
+
#
|
4680
|
+
# @!attribute [rw] question_type_properties
|
4681
|
+
# The properties of the type of question. Text questions do not have
|
4682
|
+
# to define question type properties.
|
4683
|
+
# @return [Types::EvaluationFormQuestionTypeProperties]
|
4684
|
+
#
|
4685
|
+
# @!attribute [rw] weight
|
4686
|
+
# The scoring weight of the section.
|
4687
|
+
# @return [Float]
|
4688
|
+
#
|
4689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormQuestion AWS API Documentation
|
4690
|
+
#
|
4691
|
+
class EvaluationFormQuestion < Struct.new(
|
4692
|
+
:title,
|
4693
|
+
:instructions,
|
4694
|
+
:ref_id,
|
4695
|
+
:not_applicable_enabled,
|
4696
|
+
:question_type,
|
4697
|
+
:question_type_properties,
|
4698
|
+
:weight)
|
4699
|
+
SENSITIVE = []
|
4700
|
+
include Aws::Structure
|
4701
|
+
end
|
4702
|
+
|
4703
|
+
# Information about properties for a question in an evaluation form. The
|
4704
|
+
# question type properties must be either for a numeric question or a
|
4705
|
+
# single select question.
|
4706
|
+
#
|
4707
|
+
# @note EvaluationFormQuestionTypeProperties is a union - when making an API calls you must set exactly one of the members.
|
4708
|
+
#
|
4709
|
+
# @note EvaluationFormQuestionTypeProperties is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationFormQuestionTypeProperties corresponding to the set member.
|
4710
|
+
#
|
4711
|
+
# @!attribute [rw] numeric
|
4712
|
+
# The properties of the numeric question.
|
4713
|
+
# @return [Types::EvaluationFormNumericQuestionProperties]
|
4714
|
+
#
|
4715
|
+
# @!attribute [rw] single_select
|
4716
|
+
# The properties of the numeric question.
|
4717
|
+
# @return [Types::EvaluationFormSingleSelectQuestionProperties]
|
4718
|
+
#
|
4719
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormQuestionTypeProperties AWS API Documentation
|
4720
|
+
#
|
4721
|
+
class EvaluationFormQuestionTypeProperties < Struct.new(
|
4722
|
+
:numeric,
|
4723
|
+
:single_select,
|
4724
|
+
:unknown)
|
4725
|
+
SENSITIVE = []
|
4726
|
+
include Aws::Structure
|
4727
|
+
include Aws::Structure::Union
|
4728
|
+
|
4729
|
+
class Numeric < EvaluationFormQuestionTypeProperties; end
|
4730
|
+
class SingleSelect < EvaluationFormQuestionTypeProperties; end
|
4731
|
+
class Unknown < EvaluationFormQuestionTypeProperties; end
|
4732
|
+
end
|
4733
|
+
|
4734
|
+
# Information about scoring strategy for an evaluation form.
|
4735
|
+
#
|
4736
|
+
# @!attribute [rw] mode
|
4737
|
+
# The scoring mode of the evaluation form.
|
4738
|
+
# @return [String]
|
4739
|
+
#
|
4740
|
+
# @!attribute [rw] status
|
4741
|
+
# The scoring status of the evaluation form.
|
4742
|
+
# @return [String]
|
4743
|
+
#
|
4744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormScoringStrategy AWS API Documentation
|
4745
|
+
#
|
4746
|
+
class EvaluationFormScoringStrategy < Struct.new(
|
4747
|
+
:mode,
|
4748
|
+
:status)
|
4749
|
+
SENSITIVE = []
|
4750
|
+
include Aws::Structure
|
4751
|
+
end
|
4752
|
+
|
4753
|
+
# Information about a section from an evaluation form. A section can
|
4754
|
+
# contain sections and/or questions. Evaluation forms can only contain
|
4755
|
+
# sections and subsections (two level nesting).
|
4756
|
+
#
|
4757
|
+
# @!attribute [rw] title
|
4758
|
+
# The title of the section.
|
4759
|
+
# @return [String]
|
4760
|
+
#
|
4761
|
+
# @!attribute [rw] ref_id
|
4762
|
+
# The identifier of the section. An identifier must be unique within
|
4763
|
+
# the evaluation form.
|
4764
|
+
# @return [String]
|
4765
|
+
#
|
4766
|
+
# @!attribute [rw] instructions
|
4767
|
+
# The instructions of the section.
|
4768
|
+
# @return [String]
|
4769
|
+
#
|
4770
|
+
# @!attribute [rw] items
|
4771
|
+
# The items of the section.
|
4772
|
+
# @return [Array<Types::EvaluationFormItem>]
|
4773
|
+
#
|
4774
|
+
# @!attribute [rw] weight
|
4775
|
+
# The scoring weight of the section.
|
4776
|
+
# @return [Float]
|
4777
|
+
#
|
4778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSection AWS API Documentation
|
4779
|
+
#
|
4780
|
+
class EvaluationFormSection < Struct.new(
|
4781
|
+
:title,
|
4782
|
+
:ref_id,
|
4783
|
+
:instructions,
|
4784
|
+
:items,
|
4785
|
+
:weight)
|
4786
|
+
SENSITIVE = []
|
4787
|
+
include Aws::Structure
|
4788
|
+
end
|
4789
|
+
|
4790
|
+
# Information about the automation configuration in single select
|
4791
|
+
# questions. Automation options are evaluated in order, and the first
|
4792
|
+
# matched option is applied. If no automation option matches, and there
|
4793
|
+
# is a default option, then the default option is applied.
|
4794
|
+
#
|
4795
|
+
# @!attribute [rw] options
|
4796
|
+
# The automation options of the single select question.
|
4797
|
+
# @return [Array<Types::EvaluationFormSingleSelectQuestionAutomationOption>]
|
4798
|
+
#
|
4799
|
+
# @!attribute [rw] default_option_ref_id
|
4800
|
+
# The identifier of the default answer option, when none of the
|
4801
|
+
# automation options match the criteria.
|
4802
|
+
# @return [String]
|
4803
|
+
#
|
4804
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionAutomation AWS API Documentation
|
4805
|
+
#
|
4806
|
+
class EvaluationFormSingleSelectQuestionAutomation < Struct.new(
|
4807
|
+
:options,
|
4808
|
+
:default_option_ref_id)
|
4809
|
+
SENSITIVE = []
|
4810
|
+
include Aws::Structure
|
4811
|
+
end
|
4812
|
+
|
4813
|
+
# Information about the automation option of a single select question.
|
4814
|
+
#
|
4815
|
+
# @note EvaluationFormSingleSelectQuestionAutomationOption is a union - when making an API calls you must set exactly one of the members.
|
4816
|
+
#
|
4817
|
+
# @note EvaluationFormSingleSelectQuestionAutomationOption is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationFormSingleSelectQuestionAutomationOption corresponding to the set member.
|
4818
|
+
#
|
4819
|
+
# @!attribute [rw] rule_category
|
4820
|
+
# The automation option based on a rule category for the single select
|
4821
|
+
# question.
|
4822
|
+
# @return [Types::SingleSelectQuestionRuleCategoryAutomation]
|
4823
|
+
#
|
4824
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionAutomationOption AWS API Documentation
|
4825
|
+
#
|
4826
|
+
class EvaluationFormSingleSelectQuestionAutomationOption < Struct.new(
|
4827
|
+
:rule_category,
|
4828
|
+
:unknown)
|
4829
|
+
SENSITIVE = []
|
4830
|
+
include Aws::Structure
|
4831
|
+
include Aws::Structure::Union
|
4832
|
+
|
4833
|
+
class RuleCategory < EvaluationFormSingleSelectQuestionAutomationOption; end
|
4834
|
+
class Unknown < EvaluationFormSingleSelectQuestionAutomationOption; end
|
4835
|
+
end
|
4836
|
+
|
4837
|
+
# Information about the automation configuration in single select
|
4838
|
+
# questions.
|
4839
|
+
#
|
4840
|
+
# @!attribute [rw] ref_id
|
4841
|
+
# The identifier of the answer option. An identifier must be unique
|
4842
|
+
# within the question.
|
4843
|
+
# @return [String]
|
4844
|
+
#
|
4845
|
+
# @!attribute [rw] text
|
4846
|
+
# The title of the answer option.
|
4847
|
+
# @return [String]
|
4848
|
+
#
|
4849
|
+
# @!attribute [rw] score
|
4850
|
+
# The score assigned to the answer option.
|
4851
|
+
# @return [Integer]
|
4852
|
+
#
|
4853
|
+
# @!attribute [rw] automatic_fail
|
4854
|
+
# The flag to mark the option as automatic fail. If an automatic fail
|
4855
|
+
# answer is provided, the overall evaluation gets a score of 0.
|
4856
|
+
# @return [Boolean]
|
4857
|
+
#
|
4858
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionOption AWS API Documentation
|
4859
|
+
#
|
4860
|
+
class EvaluationFormSingleSelectQuestionOption < Struct.new(
|
4861
|
+
:ref_id,
|
4862
|
+
:text,
|
4863
|
+
:score,
|
4864
|
+
:automatic_fail)
|
4865
|
+
SENSITIVE = []
|
4866
|
+
include Aws::Structure
|
4867
|
+
end
|
4868
|
+
|
4869
|
+
# Information about the options in single select questions.
|
4870
|
+
#
|
4871
|
+
# @!attribute [rw] options
|
4872
|
+
# The answer options of the single select question.
|
4873
|
+
# @return [Array<Types::EvaluationFormSingleSelectQuestionOption>]
|
4874
|
+
#
|
4875
|
+
# @!attribute [rw] display_as
|
4876
|
+
# The display mode of the single select question.
|
4877
|
+
# @return [String]
|
4878
|
+
#
|
4879
|
+
# @!attribute [rw] automation
|
4880
|
+
# The display mode of the single select question.
|
4881
|
+
# @return [Types::EvaluationFormSingleSelectQuestionAutomation]
|
4882
|
+
#
|
4883
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionProperties AWS API Documentation
|
4884
|
+
#
|
4885
|
+
class EvaluationFormSingleSelectQuestionProperties < Struct.new(
|
4886
|
+
:options,
|
4887
|
+
:display_as,
|
4888
|
+
:automation)
|
4889
|
+
SENSITIVE = []
|
4890
|
+
include Aws::Structure
|
4891
|
+
end
|
4892
|
+
|
4893
|
+
# Summary information about an evaluation form.
|
4894
|
+
#
|
4895
|
+
# @!attribute [rw] evaluation_form_id
|
4896
|
+
# The unique identifier for the evaluation form.
|
4897
|
+
# @return [String]
|
4898
|
+
#
|
4899
|
+
# @!attribute [rw] evaluation_form_arn
|
4900
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
4901
|
+
# @return [String]
|
4902
|
+
#
|
4903
|
+
# @!attribute [rw] title
|
4904
|
+
# A unique title of the evaluation form.
|
4905
|
+
# @return [String]
|
4906
|
+
#
|
4907
|
+
# @!attribute [rw] created_time
|
4908
|
+
# The timestamp for when the evaluation form was created.
|
4909
|
+
# @return [Time]
|
4910
|
+
#
|
4911
|
+
# @!attribute [rw] created_by
|
4912
|
+
# The Amazon Resource Name (ARN) of the user who created the
|
4913
|
+
# evaluation form.
|
4914
|
+
# @return [String]
|
4915
|
+
#
|
4916
|
+
# @!attribute [rw] last_modified_time
|
4917
|
+
# The timestamp for when the evaluation form was last updated.
|
4918
|
+
# @return [Time]
|
4919
|
+
#
|
4920
|
+
# @!attribute [rw] last_modified_by
|
4921
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
4922
|
+
# evaluation form.
|
4923
|
+
# @return [String]
|
4924
|
+
#
|
4925
|
+
# @!attribute [rw] last_activated_time
|
4926
|
+
# The timestamp for when the evaluation form was last activated.
|
4927
|
+
# @return [Time]
|
4928
|
+
#
|
4929
|
+
# @!attribute [rw] last_activated_by
|
4930
|
+
# The Amazon Resource Name (ARN) of the user who last activated the
|
4931
|
+
# evaluation form.
|
4932
|
+
# @return [String]
|
4933
|
+
#
|
4934
|
+
# @!attribute [rw] latest_version
|
4935
|
+
# The version number of the latest evaluation form version.
|
4936
|
+
# @return [Integer]
|
4937
|
+
#
|
4938
|
+
# @!attribute [rw] active_version
|
4939
|
+
# The version of the active evaluation form version.
|
4940
|
+
# @return [Integer]
|
4941
|
+
#
|
4942
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSummary AWS API Documentation
|
4943
|
+
#
|
4944
|
+
class EvaluationFormSummary < Struct.new(
|
4945
|
+
:evaluation_form_id,
|
4946
|
+
:evaluation_form_arn,
|
4947
|
+
:title,
|
4948
|
+
:created_time,
|
4949
|
+
:created_by,
|
4950
|
+
:last_modified_time,
|
4951
|
+
:last_modified_by,
|
4952
|
+
:last_activated_time,
|
4953
|
+
:last_activated_by,
|
4954
|
+
:latest_version,
|
4955
|
+
:active_version)
|
4956
|
+
SENSITIVE = []
|
4957
|
+
include Aws::Structure
|
4958
|
+
end
|
4959
|
+
|
4960
|
+
# Summary information about an evaluation form.
|
4961
|
+
#
|
4962
|
+
# @!attribute [rw] evaluation_form_arn
|
4963
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
4964
|
+
# @return [String]
|
4965
|
+
#
|
4966
|
+
# @!attribute [rw] evaluation_form_id
|
4967
|
+
# The unique identifier for the evaluation form.
|
4968
|
+
# @return [String]
|
4969
|
+
#
|
4970
|
+
# @!attribute [rw] evaluation_form_version
|
4971
|
+
# A version of the evaluation form.
|
4972
|
+
# @return [Integer]
|
4973
|
+
#
|
4974
|
+
# @!attribute [rw] locked
|
4975
|
+
# The flag indicating whether the evaluation form is locked for
|
4976
|
+
# changes.
|
4977
|
+
# @return [Boolean]
|
4978
|
+
#
|
4979
|
+
# @!attribute [rw] status
|
4980
|
+
# The status of the evaluation form.
|
4981
|
+
# @return [String]
|
4982
|
+
#
|
4983
|
+
# @!attribute [rw] created_time
|
4984
|
+
# The timestamp for when the evaluation form was created.
|
4985
|
+
# @return [Time]
|
4986
|
+
#
|
4987
|
+
# @!attribute [rw] created_by
|
4988
|
+
# The Amazon Resource Name (ARN) of the user who created the
|
4989
|
+
# evaluation form.
|
4990
|
+
# @return [String]
|
4991
|
+
#
|
4992
|
+
# @!attribute [rw] last_modified_time
|
4993
|
+
# The timestamp for when the evaluation form was last updated.
|
4994
|
+
# @return [Time]
|
4995
|
+
#
|
4996
|
+
# @!attribute [rw] last_modified_by
|
4997
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
4998
|
+
# evaluation form.
|
4999
|
+
# @return [String]
|
5000
|
+
#
|
5001
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormVersionSummary AWS API Documentation
|
5002
|
+
#
|
5003
|
+
class EvaluationFormVersionSummary < Struct.new(
|
5004
|
+
:evaluation_form_arn,
|
5005
|
+
:evaluation_form_id,
|
5006
|
+
:evaluation_form_version,
|
5007
|
+
:locked,
|
5008
|
+
:status,
|
5009
|
+
:created_time,
|
5010
|
+
:created_by,
|
5011
|
+
:last_modified_time,
|
5012
|
+
:last_modified_by)
|
5013
|
+
SENSITIVE = []
|
5014
|
+
include Aws::Structure
|
5015
|
+
end
|
5016
|
+
|
5017
|
+
# Metadata information about a contact evaluation.
|
5018
|
+
#
|
5019
|
+
# @!attribute [rw] contact_id
|
5020
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
5021
|
+
# @return [String]
|
5022
|
+
#
|
5023
|
+
# @!attribute [rw] evaluator_arn
|
5024
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
5025
|
+
# evaluation.
|
5026
|
+
# @return [String]
|
5027
|
+
#
|
5028
|
+
# @!attribute [rw] contact_agent_id
|
5029
|
+
# The identifier of the agent who performed the contact.
|
5030
|
+
# @return [String]
|
5031
|
+
#
|
5032
|
+
# @!attribute [rw] score
|
5033
|
+
# The overall score of the contact evaluation.
|
5034
|
+
# @return [Types::EvaluationScore]
|
5035
|
+
#
|
5036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationMetadata AWS API Documentation
|
5037
|
+
#
|
5038
|
+
class EvaluationMetadata < Struct.new(
|
5039
|
+
:contact_id,
|
5040
|
+
:evaluator_arn,
|
5041
|
+
:contact_agent_id,
|
5042
|
+
:score)
|
5043
|
+
SENSITIVE = []
|
5044
|
+
include Aws::Structure
|
5045
|
+
end
|
5046
|
+
|
5047
|
+
# Information about notes for a contact evaluation.
|
5048
|
+
#
|
5049
|
+
# @!attribute [rw] value
|
5050
|
+
# The note for an item (section or question) in a contact evaluation.
|
5051
|
+
# @return [String]
|
5052
|
+
#
|
5053
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationNote AWS API Documentation
|
5054
|
+
#
|
5055
|
+
class EvaluationNote < Struct.new(
|
5056
|
+
:value)
|
5057
|
+
SENSITIVE = []
|
5058
|
+
include Aws::Structure
|
5059
|
+
end
|
5060
|
+
|
5061
|
+
# Information about scores of a contact evaluation item (section or
|
5062
|
+
# question).
|
5063
|
+
#
|
5064
|
+
# @!attribute [rw] percentage
|
5065
|
+
# The score percentage for an item in a contact evaluation.
|
5066
|
+
# @return [Float]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] not_applicable
|
5069
|
+
# The flag to mark the item as not applicable for scoring.
|
5070
|
+
# @return [Boolean]
|
5071
|
+
#
|
5072
|
+
# @!attribute [rw] automatic_fail
|
5073
|
+
# The flag that marks the item as automatic fail. If the item or a
|
5074
|
+
# child item gets an automatic fail answer, this flag will be true.
|
5075
|
+
# @return [Boolean]
|
5076
|
+
#
|
5077
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationScore AWS API Documentation
|
5078
|
+
#
|
5079
|
+
class EvaluationScore < Struct.new(
|
5080
|
+
:percentage,
|
5081
|
+
:not_applicable,
|
5082
|
+
:automatic_fail)
|
5083
|
+
SENSITIVE = []
|
5084
|
+
include Aws::Structure
|
5085
|
+
end
|
5086
|
+
|
5087
|
+
# Summary information about a contact evaluation.
|
5088
|
+
#
|
5089
|
+
# @!attribute [rw] evaluation_id
|
5090
|
+
# A unique identifier for the contact evaluation.
|
5091
|
+
# @return [String]
|
5092
|
+
#
|
5093
|
+
# @!attribute [rw] evaluation_arn
|
5094
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
5095
|
+
# @return [String]
|
5096
|
+
#
|
5097
|
+
# @!attribute [rw] evaluation_form_title
|
5098
|
+
# A unique title of the evaluation form.
|
5099
|
+
# @return [String]
|
5100
|
+
#
|
5101
|
+
# @!attribute [rw] evaluation_form_id
|
5102
|
+
# The unique identifier for the evaluation form.
|
5103
|
+
# @return [String]
|
5104
|
+
#
|
5105
|
+
# @!attribute [rw] status
|
5106
|
+
# The status of the contact evaluation.
|
5107
|
+
# @return [String]
|
5108
|
+
#
|
5109
|
+
# @!attribute [rw] evaluator_arn
|
5110
|
+
# The Amazon Resource Name (ARN) of the user who last updated the
|
5111
|
+
# evaluation.
|
5112
|
+
# @return [String]
|
5113
|
+
#
|
5114
|
+
# @!attribute [rw] score
|
5115
|
+
# The overall score of the contact evaluation.
|
5116
|
+
# @return [Types::EvaluationScore]
|
5117
|
+
#
|
5118
|
+
# @!attribute [rw] created_time
|
5119
|
+
# The timestamp for when the evaluation was created.
|
5120
|
+
# @return [Time]
|
5121
|
+
#
|
5122
|
+
# @!attribute [rw] last_modified_time
|
5123
|
+
# The timestamp for when the evaluation was last updated.
|
5124
|
+
# @return [Time]
|
5125
|
+
#
|
5126
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSummary AWS API Documentation
|
5127
|
+
#
|
5128
|
+
class EvaluationSummary < Struct.new(
|
5129
|
+
:evaluation_id,
|
5130
|
+
:evaluation_arn,
|
5131
|
+
:evaluation_form_title,
|
5132
|
+
:evaluation_form_id,
|
5133
|
+
:status,
|
5134
|
+
:evaluator_arn,
|
5135
|
+
:score,
|
5136
|
+
:created_time,
|
5137
|
+
:last_modified_time)
|
5138
|
+
SENSITIVE = []
|
5139
|
+
include Aws::Structure
|
5140
|
+
end
|
5141
|
+
|
5142
|
+
# The EventBridge action definition.
|
5143
|
+
#
|
5144
|
+
# @!attribute [rw] name
|
5145
|
+
# The name.
|
5146
|
+
# @return [String]
|
5147
|
+
#
|
5148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EventBridgeActionDefinition AWS API Documentation
|
5149
|
+
#
|
5150
|
+
class EventBridgeActionDefinition < Struct.new(
|
5151
|
+
:name)
|
5152
|
+
SENSITIVE = []
|
5153
|
+
include Aws::Structure
|
5154
|
+
end
|
5155
|
+
|
3928
5156
|
# Contains the filter to apply when retrieving metrics with the
|
3929
5157
|
# [GetMetricDataV2][1] API.
|
3930
5158
|
#
|
@@ -6196,6 +7424,59 @@ module Aws::Connect
|
|
6196
7424
|
include Aws::Structure
|
6197
7425
|
end
|
6198
7426
|
|
7427
|
+
# @!attribute [rw] instance_id
|
7428
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
7429
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
7430
|
+
#
|
7431
|
+
#
|
7432
|
+
#
|
7433
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
7434
|
+
# @return [String]
|
7435
|
+
#
|
7436
|
+
# @!attribute [rw] contact_id
|
7437
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
7438
|
+
# @return [String]
|
7439
|
+
#
|
7440
|
+
# @!attribute [rw] next_token
|
7441
|
+
# The token for the next set of results. Use the value returned in the
|
7442
|
+
# previous response in the next request to retrieve the next set of
|
7443
|
+
# results.
|
7444
|
+
#
|
7445
|
+
# This is not expected to be set because the value returned in the
|
7446
|
+
# previous response is always null.
|
7447
|
+
# @return [String]
|
7448
|
+
#
|
7449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactEvaluationsRequest AWS API Documentation
|
7450
|
+
#
|
7451
|
+
class ListContactEvaluationsRequest < Struct.new(
|
7452
|
+
:instance_id,
|
7453
|
+
:contact_id,
|
7454
|
+
:next_token)
|
7455
|
+
SENSITIVE = []
|
7456
|
+
include Aws::Structure
|
7457
|
+
end
|
7458
|
+
|
7459
|
+
# @!attribute [rw] evaluation_summary_list
|
7460
|
+
# Provides details about a list of contact evaluations belonging to an
|
7461
|
+
# instance.
|
7462
|
+
# @return [Array<Types::EvaluationSummary>]
|
7463
|
+
#
|
7464
|
+
# @!attribute [rw] next_token
|
7465
|
+
# If there are additional results, this is the token for the next set
|
7466
|
+
# of results.
|
7467
|
+
#
|
7468
|
+
# This is always returned as null in the response.
|
7469
|
+
# @return [String]
|
7470
|
+
#
|
7471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactEvaluationsResponse AWS API Documentation
|
7472
|
+
#
|
7473
|
+
class ListContactEvaluationsResponse < Struct.new(
|
7474
|
+
:evaluation_summary_list,
|
7475
|
+
:next_token)
|
7476
|
+
SENSITIVE = []
|
7477
|
+
include Aws::Structure
|
7478
|
+
end
|
7479
|
+
|
6199
7480
|
# @!attribute [rw] instance_id
|
6200
7481
|
# The identifier of the Amazon Connect instance. You can [find the
|
6201
7482
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -6322,37 +7603,148 @@ module Aws::Connect
|
|
6322
7603
|
# The token for the next set of results. Use the value returned in the
|
6323
7604
|
# previous response in the next request to retrieve the next set of
|
6324
7605
|
# results.
|
6325
|
-
#
|
6326
|
-
# This is not expected to be set, because the value returned in the
|
6327
|
-
# previous response is always null.
|
7606
|
+
#
|
7607
|
+
# This is not expected to be set, because the value returned in the
|
7608
|
+
# previous response is always null.
|
7609
|
+
# @return [String]
|
7610
|
+
#
|
7611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesRequest AWS API Documentation
|
7612
|
+
#
|
7613
|
+
class ListContactReferencesRequest < Struct.new(
|
7614
|
+
:instance_id,
|
7615
|
+
:contact_id,
|
7616
|
+
:reference_types,
|
7617
|
+
:next_token)
|
7618
|
+
SENSITIVE = []
|
7619
|
+
include Aws::Structure
|
7620
|
+
end
|
7621
|
+
|
7622
|
+
# @!attribute [rw] reference_summary_list
|
7623
|
+
# Information about the flows.
|
7624
|
+
# @return [Array<Types::ReferenceSummary>]
|
7625
|
+
#
|
7626
|
+
# @!attribute [rw] next_token
|
7627
|
+
# If there are additional results, this is the token for the next set
|
7628
|
+
# of results.
|
7629
|
+
#
|
7630
|
+
# This is always returned as null in the response.
|
7631
|
+
# @return [String]
|
7632
|
+
#
|
7633
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListContactReferencesResponse AWS API Documentation
|
7634
|
+
#
|
7635
|
+
class ListContactReferencesResponse < Struct.new(
|
7636
|
+
:reference_summary_list,
|
7637
|
+
:next_token)
|
7638
|
+
SENSITIVE = []
|
7639
|
+
include Aws::Structure
|
7640
|
+
end
|
7641
|
+
|
7642
|
+
# @!attribute [rw] instance_id
|
7643
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
7644
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
7645
|
+
#
|
7646
|
+
#
|
7647
|
+
#
|
7648
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
7649
|
+
# @return [String]
|
7650
|
+
#
|
7651
|
+
# @!attribute [rw] language_code
|
7652
|
+
# The language code of the vocabulary entries. For a list of languages
|
7653
|
+
# and their corresponding language codes, see [What is Amazon
|
7654
|
+
# Transcribe?][1]
|
7655
|
+
#
|
7656
|
+
#
|
7657
|
+
#
|
7658
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
|
7659
|
+
# @return [String]
|
7660
|
+
#
|
7661
|
+
# @!attribute [rw] max_results
|
7662
|
+
# The maximum number of results to return per page.
|
7663
|
+
# @return [Integer]
|
7664
|
+
#
|
7665
|
+
# @!attribute [rw] next_token
|
7666
|
+
# The token for the next set of results. Use the value returned in the
|
7667
|
+
# previous response in the next request to retrieve the next set of
|
7668
|
+
# results.
|
7669
|
+
# @return [String]
|
7670
|
+
#
|
7671
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDefaultVocabulariesRequest AWS API Documentation
|
7672
|
+
#
|
7673
|
+
class ListDefaultVocabulariesRequest < Struct.new(
|
7674
|
+
:instance_id,
|
7675
|
+
:language_code,
|
7676
|
+
:max_results,
|
7677
|
+
:next_token)
|
7678
|
+
SENSITIVE = []
|
7679
|
+
include Aws::Structure
|
7680
|
+
end
|
7681
|
+
|
7682
|
+
# @!attribute [rw] default_vocabulary_list
|
7683
|
+
# A list of default vocabularies.
|
7684
|
+
# @return [Array<Types::DefaultVocabulary>]
|
7685
|
+
#
|
7686
|
+
# @!attribute [rw] next_token
|
7687
|
+
# If there are additional results, this is the token for the next set
|
7688
|
+
# of results.
|
7689
|
+
# @return [String]
|
7690
|
+
#
|
7691
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListDefaultVocabulariesResponse AWS API Documentation
|
7692
|
+
#
|
7693
|
+
class ListDefaultVocabulariesResponse < Struct.new(
|
7694
|
+
:default_vocabulary_list,
|
7695
|
+
:next_token)
|
7696
|
+
SENSITIVE = []
|
7697
|
+
include Aws::Structure
|
7698
|
+
end
|
7699
|
+
|
7700
|
+
# @!attribute [rw] instance_id
|
7701
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
7702
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
7703
|
+
#
|
7704
|
+
#
|
7705
|
+
#
|
7706
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
7707
|
+
# @return [String]
|
7708
|
+
#
|
7709
|
+
# @!attribute [rw] evaluation_form_id
|
7710
|
+
# The unique identifier for the evaluation form.
|
7711
|
+
# @return [String]
|
7712
|
+
#
|
7713
|
+
# @!attribute [rw] max_results
|
7714
|
+
# The maximum number of results to return per page.
|
7715
|
+
# @return [Integer]
|
7716
|
+
#
|
7717
|
+
# @!attribute [rw] next_token
|
7718
|
+
# The token for the next set of results. Use the value returned in the
|
7719
|
+
# previous response in the next request to retrieve the next set of
|
7720
|
+
# results.
|
6328
7721
|
# @return [String]
|
6329
7722
|
#
|
6330
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7723
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationFormVersionsRequest AWS API Documentation
|
6331
7724
|
#
|
6332
|
-
class
|
7725
|
+
class ListEvaluationFormVersionsRequest < Struct.new(
|
6333
7726
|
:instance_id,
|
6334
|
-
:
|
6335
|
-
:
|
7727
|
+
:evaluation_form_id,
|
7728
|
+
:max_results,
|
6336
7729
|
:next_token)
|
6337
7730
|
SENSITIVE = []
|
6338
7731
|
include Aws::Structure
|
6339
7732
|
end
|
6340
7733
|
|
6341
|
-
# @!attribute [rw]
|
6342
|
-
#
|
6343
|
-
#
|
7734
|
+
# @!attribute [rw] evaluation_form_version_summary_list
|
7735
|
+
# Provides details about a list of evaluation forms belonging to an
|
7736
|
+
# instance.
|
7737
|
+
# @return [Array<Types::EvaluationFormVersionSummary>]
|
6344
7738
|
#
|
6345
7739
|
# @!attribute [rw] next_token
|
6346
7740
|
# If there are additional results, this is the token for the next set
|
6347
7741
|
# of results.
|
6348
|
-
#
|
6349
|
-
# This is always returned as null in the response.
|
6350
7742
|
# @return [String]
|
6351
7743
|
#
|
6352
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7744
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationFormVersionsResponse AWS API Documentation
|
6353
7745
|
#
|
6354
|
-
class
|
6355
|
-
:
|
7746
|
+
class ListEvaluationFormVersionsResponse < Struct.new(
|
7747
|
+
:evaluation_form_version_summary_list,
|
6356
7748
|
:next_token)
|
6357
7749
|
SENSITIVE = []
|
6358
7750
|
include Aws::Structure
|
@@ -6367,16 +7759,6 @@ module Aws::Connect
|
|
6367
7759
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
6368
7760
|
# @return [String]
|
6369
7761
|
#
|
6370
|
-
# @!attribute [rw] language_code
|
6371
|
-
# The language code of the vocabulary entries. For a list of languages
|
6372
|
-
# and their corresponding language codes, see [What is Amazon
|
6373
|
-
# Transcribe?][1]
|
6374
|
-
#
|
6375
|
-
#
|
6376
|
-
#
|
6377
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html
|
6378
|
-
# @return [String]
|
6379
|
-
#
|
6380
7762
|
# @!attribute [rw] max_results
|
6381
7763
|
# The maximum number of results to return per page.
|
6382
7764
|
# @return [Integer]
|
@@ -6387,30 +7769,30 @@ module Aws::Connect
|
|
6387
7769
|
# results.
|
6388
7770
|
# @return [String]
|
6389
7771
|
#
|
6390
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7772
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationFormsRequest AWS API Documentation
|
6391
7773
|
#
|
6392
|
-
class
|
7774
|
+
class ListEvaluationFormsRequest < Struct.new(
|
6393
7775
|
:instance_id,
|
6394
|
-
:language_code,
|
6395
7776
|
:max_results,
|
6396
7777
|
:next_token)
|
6397
7778
|
SENSITIVE = []
|
6398
7779
|
include Aws::Structure
|
6399
7780
|
end
|
6400
7781
|
|
6401
|
-
# @!attribute [rw]
|
6402
|
-
#
|
6403
|
-
#
|
7782
|
+
# @!attribute [rw] evaluation_form_summary_list
|
7783
|
+
# Provides details about a list of evaluation forms belonging to an
|
7784
|
+
# instance.
|
7785
|
+
# @return [Array<Types::EvaluationFormSummary>]
|
6404
7786
|
#
|
6405
7787
|
# @!attribute [rw] next_token
|
6406
7788
|
# If there are additional results, this is the token for the next set
|
6407
7789
|
# of results.
|
6408
7790
|
# @return [String]
|
6409
7791
|
#
|
6410
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
7792
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListEvaluationFormsResponse AWS API Documentation
|
6411
7793
|
#
|
6412
|
-
class
|
6413
|
-
:
|
7794
|
+
class ListEvaluationFormsResponse < Struct.new(
|
7795
|
+
:evaluation_form_summary_list,
|
6414
7796
|
:next_token)
|
6415
7797
|
SENSITIVE = []
|
6416
7798
|
include Aws::Structure
|
@@ -7787,7 +9169,15 @@ module Aws::Connect
|
|
7787
9169
|
# @!attribute [rw] metric_filter_key
|
7788
9170
|
# The key to use for filtering data.
|
7789
9171
|
#
|
7790
|
-
# Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON
|
9172
|
+
# Valid metric filter keys: `INITIATION_METHOD`, `DISCONNECT_REASON`.
|
9173
|
+
# These are the same values as the `InitiationMethod` and
|
9174
|
+
# `DisconnectReason` in the contact record. For more information, see
|
9175
|
+
# [ContactTraceRecord][1] in the *Amazon Connect Administrator's
|
9176
|
+
# Guide*.
|
9177
|
+
#
|
9178
|
+
#
|
9179
|
+
#
|
9180
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
7791
9181
|
# @return [String]
|
7792
9182
|
#
|
7793
9183
|
# @!attribute [rw] metric_filter_values
|
@@ -7958,6 +9348,33 @@ module Aws::Connect
|
|
7958
9348
|
include Aws::Structure
|
7959
9349
|
end
|
7960
9350
|
|
9351
|
+
# Information about the property value used in automation of a numeric
|
9352
|
+
# questions. Label values are associated with minimum and maximum values
|
9353
|
+
# for the numeric question.
|
9354
|
+
#
|
9355
|
+
# * Sentiment scores have a minimum value of -5 and maximum value of 5.
|
9356
|
+
#
|
9357
|
+
# * Duration labels, such as `NON_TALK_TIME`, `CONTACT_DURATION`,
|
9358
|
+
# `AGENT_INTERACTION_DURATION`, `CUSTOMER_HOLD_TIME` have a minimum
|
9359
|
+
# value of 0 and maximum value of 28800.
|
9360
|
+
#
|
9361
|
+
# * Percantages have a minimum value of 0 and maximum value of 100.
|
9362
|
+
#
|
9363
|
+
# * `NUMBER_OF_INTERRUPTIONS` has a minimum value of 0 and maximum value
|
9364
|
+
# of 100.
|
9365
|
+
#
|
9366
|
+
# @!attribute [rw] label
|
9367
|
+
# The property label of the automation.
|
9368
|
+
# @return [String]
|
9369
|
+
#
|
9370
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/NumericQuestionPropertyValueAutomation AWS API Documentation
|
9371
|
+
#
|
9372
|
+
class NumericQuestionPropertyValueAutomation < Struct.new(
|
9373
|
+
:label)
|
9374
|
+
SENSITIVE = []
|
9375
|
+
include Aws::Structure
|
9376
|
+
end
|
9377
|
+
|
7961
9378
|
# The outbound caller ID name, number, and outbound whisper flow.
|
7962
9379
|
#
|
7963
9380
|
# @!attribute [rw] outbound_caller_id_name
|
@@ -8010,6 +9427,25 @@ module Aws::Connect
|
|
8010
9427
|
include Aws::Structure
|
8011
9428
|
end
|
8012
9429
|
|
9430
|
+
# The details to add for the participant.
|
9431
|
+
#
|
9432
|
+
# @!attribute [rw] participant_role
|
9433
|
+
# The role of the participant being added.
|
9434
|
+
# @return [String]
|
9435
|
+
#
|
9436
|
+
# @!attribute [rw] display_name
|
9437
|
+
# The display name of the participant.
|
9438
|
+
# @return [String]
|
9439
|
+
#
|
9440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantDetailsToAdd AWS API Documentation
|
9441
|
+
#
|
9442
|
+
class ParticipantDetailsToAdd < Struct.new(
|
9443
|
+
:participant_role,
|
9444
|
+
:display_name)
|
9445
|
+
SENSITIVE = []
|
9446
|
+
include Aws::Structure
|
9447
|
+
end
|
9448
|
+
|
8013
9449
|
# Configuration information for the timer. After the timer configuration
|
8014
9450
|
# is set, it persists for the duration of the chat. It persists across
|
8015
9451
|
# new contacts in the chain, for example, transfer contacts.
|
@@ -8085,6 +9521,32 @@ module Aws::Connect
|
|
8085
9521
|
class Unknown < ParticipantTimerValue; end
|
8086
9522
|
end
|
8087
9523
|
|
9524
|
+
# The credentials used by the participant.
|
9525
|
+
#
|
9526
|
+
# @!attribute [rw] participant_token
|
9527
|
+
# The token used by the chat participant to call
|
9528
|
+
# [CreateParticipantConnection][1]. The participant token is valid for
|
9529
|
+
# the lifetime of a chat participant.
|
9530
|
+
#
|
9531
|
+
#
|
9532
|
+
#
|
9533
|
+
# [1]: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html
|
9534
|
+
# @return [String]
|
9535
|
+
#
|
9536
|
+
# @!attribute [rw] expiry
|
9537
|
+
# The expiration of the token. It's specified in ISO 8601 format:
|
9538
|
+
# yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
|
9539
|
+
# @return [String]
|
9540
|
+
#
|
9541
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ParticipantTokenCredentials AWS API Documentation
|
9542
|
+
#
|
9543
|
+
class ParticipantTokenCredentials < Struct.new(
|
9544
|
+
:participant_token,
|
9545
|
+
:expiry)
|
9546
|
+
SENSITIVE = []
|
9547
|
+
include Aws::Structure
|
9548
|
+
end
|
9549
|
+
|
8088
9550
|
# Enable persistent chats. For more information about enabling
|
8089
9551
|
# persistent chat, and for example use cases and how to configure for
|
8090
9552
|
# them, see [Enable persistent chat][1].
|
@@ -10089,6 +11551,35 @@ module Aws::Connect
|
|
10089
11551
|
include Aws::Structure
|
10090
11552
|
end
|
10091
11553
|
|
11554
|
+
# Information about the automation option based on a rule category for a
|
11555
|
+
# single select question.
|
11556
|
+
#
|
11557
|
+
# @!attribute [rw] category
|
11558
|
+
# The category name, as defined in Rules.
|
11559
|
+
# @return [String]
|
11560
|
+
#
|
11561
|
+
# @!attribute [rw] condition
|
11562
|
+
# The condition to apply for the automation option. If the condition
|
11563
|
+
# is `PRESENT`, then the option is applied when the contact data
|
11564
|
+
# includes the category. Similarly, if the condition is `NOT_PRESENT`,
|
11565
|
+
# then the option is applied when the contact data does not include
|
11566
|
+
# the category.
|
11567
|
+
# @return [String]
|
11568
|
+
#
|
11569
|
+
# @!attribute [rw] option_ref_id
|
11570
|
+
# The identifier of the answer option tha
|
11571
|
+
# @return [String]
|
11572
|
+
#
|
11573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SingleSelectQuestionRuleCategoryAutomation AWS API Documentation
|
11574
|
+
#
|
11575
|
+
class SingleSelectQuestionRuleCategoryAutomation < Struct.new(
|
11576
|
+
:category,
|
11577
|
+
:condition,
|
11578
|
+
:option_ref_id)
|
11579
|
+
SENSITIVE = []
|
11580
|
+
include Aws::Structure
|
11581
|
+
end
|
11582
|
+
|
10092
11583
|
# @!attribute [rw] instance_id
|
10093
11584
|
# The identifier of the Amazon Connect instance. You can [find the
|
10094
11585
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -10243,6 +11734,65 @@ module Aws::Connect
|
|
10243
11734
|
include Aws::Structure
|
10244
11735
|
end
|
10245
11736
|
|
11737
|
+
# @!attribute [rw] instance_id
|
11738
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
11739
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
11740
|
+
#
|
11741
|
+
#
|
11742
|
+
#
|
11743
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
11744
|
+
# @return [String]
|
11745
|
+
#
|
11746
|
+
# @!attribute [rw] contact_id
|
11747
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
11748
|
+
# @return [String]
|
11749
|
+
#
|
11750
|
+
# @!attribute [rw] evaluation_form_id
|
11751
|
+
# The unique identifier for the evaluation form.
|
11752
|
+
# @return [String]
|
11753
|
+
#
|
11754
|
+
# @!attribute [rw] client_token
|
11755
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
11756
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
11757
|
+
# SDK populates this field. For more information about idempotency,
|
11758
|
+
# see [Making retries safe with idempotent APIs][1].
|
11759
|
+
#
|
11760
|
+
# **A suitable default value is auto-generated.** You should normally
|
11761
|
+
# not need to pass this option.
|
11762
|
+
#
|
11763
|
+
#
|
11764
|
+
#
|
11765
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
11766
|
+
# @return [String]
|
11767
|
+
#
|
11768
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactEvaluationRequest AWS API Documentation
|
11769
|
+
#
|
11770
|
+
class StartContactEvaluationRequest < Struct.new(
|
11771
|
+
:instance_id,
|
11772
|
+
:contact_id,
|
11773
|
+
:evaluation_form_id,
|
11774
|
+
:client_token)
|
11775
|
+
SENSITIVE = []
|
11776
|
+
include Aws::Structure
|
11777
|
+
end
|
11778
|
+
|
11779
|
+
# @!attribute [rw] evaluation_id
|
11780
|
+
# A unique identifier for the contact evaluation.
|
11781
|
+
# @return [String]
|
11782
|
+
#
|
11783
|
+
# @!attribute [rw] evaluation_arn
|
11784
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
11785
|
+
# @return [String]
|
11786
|
+
#
|
11787
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactEvaluationResponse AWS API Documentation
|
11788
|
+
#
|
11789
|
+
class StartContactEvaluationResponse < Struct.new(
|
11790
|
+
:evaluation_id,
|
11791
|
+
:evaluation_arn)
|
11792
|
+
SENSITIVE = []
|
11793
|
+
include Aws::Structure
|
11794
|
+
end
|
11795
|
+
|
10246
11796
|
# @!attribute [rw] instance_id
|
10247
11797
|
# The identifier of the Amazon Connect instance. You can [find the
|
10248
11798
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -10700,6 +12250,55 @@ module Aws::Connect
|
|
10700
12250
|
include Aws::Structure
|
10701
12251
|
end
|
10702
12252
|
|
12253
|
+
# @!attribute [rw] instance_id
|
12254
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
12255
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12256
|
+
#
|
12257
|
+
#
|
12258
|
+
#
|
12259
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
12260
|
+
# @return [String]
|
12261
|
+
#
|
12262
|
+
# @!attribute [rw] evaluation_id
|
12263
|
+
# A unique identifier for the contact evaluation.
|
12264
|
+
# @return [String]
|
12265
|
+
#
|
12266
|
+
# @!attribute [rw] answers
|
12267
|
+
# A map of question identifiers to answer value.
|
12268
|
+
# @return [Hash<String,Types::EvaluationAnswerInput>]
|
12269
|
+
#
|
12270
|
+
# @!attribute [rw] notes
|
12271
|
+
# A map of question identifiers to note value.
|
12272
|
+
# @return [Hash<String,Types::EvaluationNote>]
|
12273
|
+
#
|
12274
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SubmitContactEvaluationRequest AWS API Documentation
|
12275
|
+
#
|
12276
|
+
class SubmitContactEvaluationRequest < Struct.new(
|
12277
|
+
:instance_id,
|
12278
|
+
:evaluation_id,
|
12279
|
+
:answers,
|
12280
|
+
:notes)
|
12281
|
+
SENSITIVE = []
|
12282
|
+
include Aws::Structure
|
12283
|
+
end
|
12284
|
+
|
12285
|
+
# @!attribute [rw] evaluation_id
|
12286
|
+
# A unique identifier for the contact evaluation.
|
12287
|
+
# @return [String]
|
12288
|
+
#
|
12289
|
+
# @!attribute [rw] evaluation_arn
|
12290
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
12291
|
+
# @return [String]
|
12292
|
+
#
|
12293
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SubmitContactEvaluationResponse AWS API Documentation
|
12294
|
+
#
|
12295
|
+
class SubmitContactEvaluationResponse < Struct.new(
|
12296
|
+
:evaluation_id,
|
12297
|
+
:evaluation_arn)
|
12298
|
+
SENSITIVE = []
|
12299
|
+
include Aws::Structure
|
12300
|
+
end
|
12301
|
+
|
10703
12302
|
# @!attribute [rw] instance_id
|
10704
12303
|
# The identifier of the Amazon Connect instance. You can [find the
|
10705
12304
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -11337,6 +12936,55 @@ module Aws::Connect
|
|
11337
12936
|
#
|
11338
12937
|
class UpdateContactAttributesResponse < Aws::EmptyStructure; end
|
11339
12938
|
|
12939
|
+
# @!attribute [rw] instance_id
|
12940
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
12941
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
12942
|
+
#
|
12943
|
+
#
|
12944
|
+
#
|
12945
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
12946
|
+
# @return [String]
|
12947
|
+
#
|
12948
|
+
# @!attribute [rw] evaluation_id
|
12949
|
+
# A unique identifier for the contact evaluation.
|
12950
|
+
# @return [String]
|
12951
|
+
#
|
12952
|
+
# @!attribute [rw] answers
|
12953
|
+
# A map of question identifiers to answer value.
|
12954
|
+
# @return [Hash<String,Types::EvaluationAnswerInput>]
|
12955
|
+
#
|
12956
|
+
# @!attribute [rw] notes
|
12957
|
+
# A map of question identifiers to note value.
|
12958
|
+
# @return [Hash<String,Types::EvaluationNote>]
|
12959
|
+
#
|
12960
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactEvaluationRequest AWS API Documentation
|
12961
|
+
#
|
12962
|
+
class UpdateContactEvaluationRequest < Struct.new(
|
12963
|
+
:instance_id,
|
12964
|
+
:evaluation_id,
|
12965
|
+
:answers,
|
12966
|
+
:notes)
|
12967
|
+
SENSITIVE = []
|
12968
|
+
include Aws::Structure
|
12969
|
+
end
|
12970
|
+
|
12971
|
+
# @!attribute [rw] evaluation_id
|
12972
|
+
# A unique identifier for the contact evaluation.
|
12973
|
+
# @return [String]
|
12974
|
+
#
|
12975
|
+
# @!attribute [rw] evaluation_arn
|
12976
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
12977
|
+
# @return [String]
|
12978
|
+
#
|
12979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactEvaluationResponse AWS API Documentation
|
12980
|
+
#
|
12981
|
+
class UpdateContactEvaluationResponse < Struct.new(
|
12982
|
+
:evaluation_id,
|
12983
|
+
:evaluation_arn)
|
12984
|
+
SENSITIVE = []
|
12985
|
+
include Aws::Structure
|
12986
|
+
end
|
12987
|
+
|
11340
12988
|
# @!attribute [rw] instance_id
|
11341
12989
|
# The identifier of the Amazon Connect instance.
|
11342
12990
|
# @return [String]
|
@@ -11588,6 +13236,97 @@ module Aws::Connect
|
|
11588
13236
|
#
|
11589
13237
|
class UpdateContactScheduleResponse < Aws::EmptyStructure; end
|
11590
13238
|
|
13239
|
+
# @!attribute [rw] instance_id
|
13240
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
13241
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
13242
|
+
#
|
13243
|
+
#
|
13244
|
+
#
|
13245
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
13246
|
+
# @return [String]
|
13247
|
+
#
|
13248
|
+
# @!attribute [rw] evaluation_form_id
|
13249
|
+
# The unique identifier for the evaluation form.
|
13250
|
+
# @return [String]
|
13251
|
+
#
|
13252
|
+
# @!attribute [rw] evaluation_form_version
|
13253
|
+
# A version of the evaluation form to update.
|
13254
|
+
# @return [Integer]
|
13255
|
+
#
|
13256
|
+
# @!attribute [rw] create_new_version
|
13257
|
+
# A flag indicating whether the operation must create a new version.
|
13258
|
+
# @return [Boolean]
|
13259
|
+
#
|
13260
|
+
# @!attribute [rw] title
|
13261
|
+
# A unique title of the evaluation form.
|
13262
|
+
# @return [String]
|
13263
|
+
#
|
13264
|
+
# @!attribute [rw] description
|
13265
|
+
# The description of the evaluation form.
|
13266
|
+
# @return [String]
|
13267
|
+
#
|
13268
|
+
# @!attribute [rw] items
|
13269
|
+
# Items that are part of the evaluation form. The total number of
|
13270
|
+
# sections and questions must not exceed 100 each. Questions must be
|
13271
|
+
# contained in a section.
|
13272
|
+
# @return [Array<Types::EvaluationFormItem>]
|
13273
|
+
#
|
13274
|
+
# @!attribute [rw] scoring_strategy
|
13275
|
+
# A scoring strategy of the evaluation form.
|
13276
|
+
# @return [Types::EvaluationFormScoringStrategy]
|
13277
|
+
#
|
13278
|
+
# @!attribute [rw] client_token
|
13279
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
13280
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
13281
|
+
# SDK populates this field. For more information about idempotency,
|
13282
|
+
# see [Making retries safe with idempotent APIs][1].
|
13283
|
+
#
|
13284
|
+
# **A suitable default value is auto-generated.** You should normally
|
13285
|
+
# not need to pass this option.
|
13286
|
+
#
|
13287
|
+
#
|
13288
|
+
#
|
13289
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
13290
|
+
# @return [String]
|
13291
|
+
#
|
13292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEvaluationFormRequest AWS API Documentation
|
13293
|
+
#
|
13294
|
+
class UpdateEvaluationFormRequest < Struct.new(
|
13295
|
+
:instance_id,
|
13296
|
+
:evaluation_form_id,
|
13297
|
+
:evaluation_form_version,
|
13298
|
+
:create_new_version,
|
13299
|
+
:title,
|
13300
|
+
:description,
|
13301
|
+
:items,
|
13302
|
+
:scoring_strategy,
|
13303
|
+
:client_token)
|
13304
|
+
SENSITIVE = []
|
13305
|
+
include Aws::Structure
|
13306
|
+
end
|
13307
|
+
|
13308
|
+
# @!attribute [rw] evaluation_form_id
|
13309
|
+
# The unique identifier for the evaluation form.
|
13310
|
+
# @return [String]
|
13311
|
+
#
|
13312
|
+
# @!attribute [rw] evaluation_form_arn
|
13313
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
13314
|
+
# @return [String]
|
13315
|
+
#
|
13316
|
+
# @!attribute [rw] evaluation_form_version
|
13317
|
+
# The version of the updated evaluation form resource.
|
13318
|
+
# @return [Integer]
|
13319
|
+
#
|
13320
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateEvaluationFormResponse AWS API Documentation
|
13321
|
+
#
|
13322
|
+
class UpdateEvaluationFormResponse < Struct.new(
|
13323
|
+
:evaluation_form_id,
|
13324
|
+
:evaluation_form_arn,
|
13325
|
+
:evaluation_form_version)
|
13326
|
+
SENSITIVE = []
|
13327
|
+
include Aws::Structure
|
13328
|
+
end
|
13329
|
+
|
11591
13330
|
# @!attribute [rw] instance_id
|
11592
13331
|
# The identifier of the Amazon Connect instance. You can [find the
|
11593
13332
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|