aws-sdk-connect 1.220.0 → 1.222.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +839 -9
- data/lib/aws-sdk-connect/client_api.rb +445 -1
- data/lib/aws-sdk-connect/types.rb +1501 -72
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +319 -15
- data/sig/types.rbs +390 -2
- metadata +1 -1
|
@@ -180,6 +180,21 @@ module Aws::Connect
|
|
|
180
180
|
include Aws::Structure
|
|
181
181
|
end
|
|
182
182
|
|
|
183
|
+
# Information about agent-first outbound strategy configuration.
|
|
184
|
+
#
|
|
185
|
+
# @!attribute [rw] preview
|
|
186
|
+
# Information about preview configuration of agent first outbound
|
|
187
|
+
# strategy
|
|
188
|
+
# @return [Types::Preview]
|
|
189
|
+
#
|
|
190
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AgentFirst AWS API Documentation
|
|
191
|
+
#
|
|
192
|
+
class AgentFirst < Struct.new(
|
|
193
|
+
:preview)
|
|
194
|
+
SENSITIVE = []
|
|
195
|
+
include Aws::Structure
|
|
196
|
+
end
|
|
197
|
+
|
|
183
198
|
# Information about an agent hierarchy group.
|
|
184
199
|
#
|
|
185
200
|
# @!attribute [rw] arn
|
|
@@ -241,6 +256,14 @@ module Aws::Connect
|
|
|
241
256
|
# The identifier of the agent who accepted the contact.
|
|
242
257
|
# @return [String]
|
|
243
258
|
#
|
|
259
|
+
# @!attribute [rw] accepted_by_agent_timestamp
|
|
260
|
+
# The timestamp when the contact was accepted by the agent.
|
|
261
|
+
# @return [Time]
|
|
262
|
+
#
|
|
263
|
+
# @!attribute [rw] preview_end_timestamp
|
|
264
|
+
# The timestamp when the agent finished previewing the contact.
|
|
265
|
+
# @return [Time]
|
|
266
|
+
#
|
|
244
267
|
# @!attribute [rw] connected_to_agent_timestamp
|
|
245
268
|
# The timestamp when the contact was connected to the agent.
|
|
246
269
|
# @return [Time]
|
|
@@ -299,6 +322,8 @@ module Aws::Connect
|
|
|
299
322
|
#
|
|
300
323
|
class AgentInfo < Struct.new(
|
|
301
324
|
:id,
|
|
325
|
+
:accepted_by_agent_timestamp,
|
|
326
|
+
:preview_end_timestamp,
|
|
302
327
|
:connected_to_agent_timestamp,
|
|
303
328
|
:agent_pause_duration_in_seconds,
|
|
304
329
|
:hierarchy_groups,
|
|
@@ -547,6 +572,20 @@ module Aws::Connect
|
|
|
547
572
|
include Aws::Structure
|
|
548
573
|
end
|
|
549
574
|
|
|
575
|
+
# Configuration information of an email alias.
|
|
576
|
+
#
|
|
577
|
+
# @!attribute [rw] email_address_id
|
|
578
|
+
# The email address ID.
|
|
579
|
+
# @return [String]
|
|
580
|
+
#
|
|
581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AliasConfiguration AWS API Documentation
|
|
582
|
+
#
|
|
583
|
+
class AliasConfiguration < Struct.new(
|
|
584
|
+
:email_address_id)
|
|
585
|
+
SENSITIVE = []
|
|
586
|
+
include Aws::Structure
|
|
587
|
+
end
|
|
588
|
+
|
|
550
589
|
# Information about the capabilities enabled for participants of the
|
|
551
590
|
# contact.
|
|
552
591
|
#
|
|
@@ -909,6 +948,55 @@ module Aws::Connect
|
|
|
909
948
|
#
|
|
910
949
|
class AssociateDefaultVocabularyResponse < Aws::EmptyStructure; end
|
|
911
950
|
|
|
951
|
+
# @!attribute [rw] email_address_id
|
|
952
|
+
# The identifier of the email address.
|
|
953
|
+
# @return [String]
|
|
954
|
+
#
|
|
955
|
+
# @!attribute [rw] instance_id
|
|
956
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
957
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
958
|
+
#
|
|
959
|
+
#
|
|
960
|
+
#
|
|
961
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
962
|
+
# @return [String]
|
|
963
|
+
#
|
|
964
|
+
# @!attribute [rw] alias_configuration
|
|
965
|
+
# Configuration object that specifies which email address will serve
|
|
966
|
+
# as the alias. The specified email address must already exist in the
|
|
967
|
+
# Amazon Connect instance and cannot already be configured as an alias
|
|
968
|
+
# or have an alias of its own.
|
|
969
|
+
# @return [Types::AliasConfiguration]
|
|
970
|
+
#
|
|
971
|
+
# @!attribute [rw] client_token
|
|
972
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
973
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
974
|
+
# SDK populates this field. For more information about idempotency,
|
|
975
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
976
|
+
#
|
|
977
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
978
|
+
# not need to pass this option.
|
|
979
|
+
#
|
|
980
|
+
#
|
|
981
|
+
#
|
|
982
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
983
|
+
# @return [String]
|
|
984
|
+
#
|
|
985
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateEmailAddressAliasRequest AWS API Documentation
|
|
986
|
+
#
|
|
987
|
+
class AssociateEmailAddressAliasRequest < Struct.new(
|
|
988
|
+
:email_address_id,
|
|
989
|
+
:instance_id,
|
|
990
|
+
:alias_configuration,
|
|
991
|
+
:client_token)
|
|
992
|
+
SENSITIVE = []
|
|
993
|
+
include Aws::Structure
|
|
994
|
+
end
|
|
995
|
+
|
|
996
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateEmailAddressAliasResponse AWS API Documentation
|
|
997
|
+
#
|
|
998
|
+
class AssociateEmailAddressAliasResponse < Aws::EmptyStructure; end
|
|
999
|
+
|
|
912
1000
|
# @!attribute [rw] instance_id
|
|
913
1001
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
914
1002
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -1782,6 +1870,53 @@ module Aws::Connect
|
|
|
1782
1870
|
include Aws::Structure
|
|
1783
1871
|
end
|
|
1784
1872
|
|
|
1873
|
+
# Configuration information about automated evaluations.
|
|
1874
|
+
#
|
|
1875
|
+
# @!attribute [rw] enabled
|
|
1876
|
+
# Whether automated evaluations are enabled.
|
|
1877
|
+
# @return [Boolean]
|
|
1878
|
+
#
|
|
1879
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AutoEvaluationConfiguration AWS API Documentation
|
|
1880
|
+
#
|
|
1881
|
+
class AutoEvaluationConfiguration < Struct.new(
|
|
1882
|
+
:enabled)
|
|
1883
|
+
SENSITIVE = []
|
|
1884
|
+
include Aws::Structure
|
|
1885
|
+
end
|
|
1886
|
+
|
|
1887
|
+
# Details about automated evaluations.
|
|
1888
|
+
#
|
|
1889
|
+
# @!attribute [rw] auto_evaluation_enabled
|
|
1890
|
+
# Whether automated evaluation is enabled.
|
|
1891
|
+
# @return [Boolean]
|
|
1892
|
+
#
|
|
1893
|
+
# @!attribute [rw] auto_evaluation_status
|
|
1894
|
+
# The status of the contact auto-evaluation.
|
|
1895
|
+
# @return [String]
|
|
1896
|
+
#
|
|
1897
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AutoEvaluationDetails AWS API Documentation
|
|
1898
|
+
#
|
|
1899
|
+
class AutoEvaluationDetails < Struct.new(
|
|
1900
|
+
:auto_evaluation_enabled,
|
|
1901
|
+
:auto_evaluation_status)
|
|
1902
|
+
SENSITIVE = []
|
|
1903
|
+
include Aws::Structure
|
|
1904
|
+
end
|
|
1905
|
+
|
|
1906
|
+
# Information about automatic fail configuration for an evaluation form.
|
|
1907
|
+
#
|
|
1908
|
+
# @!attribute [rw] target_section
|
|
1909
|
+
# The referenceId of the target section for auto failure.
|
|
1910
|
+
# @return [String]
|
|
1911
|
+
#
|
|
1912
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AutomaticFailConfiguration AWS API Documentation
|
|
1913
|
+
#
|
|
1914
|
+
class AutomaticFailConfiguration < Struct.new(
|
|
1915
|
+
:target_section)
|
|
1916
|
+
SENSITIVE = []
|
|
1917
|
+
include Aws::Structure
|
|
1918
|
+
end
|
|
1919
|
+
|
|
1785
1920
|
# Information about available phone numbers.
|
|
1786
1921
|
#
|
|
1787
1922
|
# @!attribute [rw] phone_number
|
|
@@ -2052,6 +2187,25 @@ module Aws::Connect
|
|
|
2052
2187
|
include Aws::Structure
|
|
2053
2188
|
end
|
|
2054
2189
|
|
|
2190
|
+
# A boolean search condition for Search APIs.
|
|
2191
|
+
#
|
|
2192
|
+
# @!attribute [rw] field_name
|
|
2193
|
+
# A name of the property to be searched.
|
|
2194
|
+
# @return [String]
|
|
2195
|
+
#
|
|
2196
|
+
# @!attribute [rw] comparison_type
|
|
2197
|
+
# Boolean property comparison type.
|
|
2198
|
+
# @return [String]
|
|
2199
|
+
#
|
|
2200
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/BooleanCondition AWS API Documentation
|
|
2201
|
+
#
|
|
2202
|
+
class BooleanCondition < Struct.new(
|
|
2203
|
+
:field_name,
|
|
2204
|
+
:comparison_type)
|
|
2205
|
+
SENSITIVE = []
|
|
2206
|
+
include Aws::Structure
|
|
2207
|
+
end
|
|
2208
|
+
|
|
2055
2209
|
# Information associated with a campaign.
|
|
2056
2210
|
#
|
|
2057
2211
|
# @!attribute [rw] campaign_id
|
|
@@ -2831,7 +2985,14 @@ module Aws::Connect
|
|
|
2831
2985
|
# @return [Array<Types::RecordingInfo>]
|
|
2832
2986
|
#
|
|
2833
2987
|
# @!attribute [rw] disconnect_reason
|
|
2834
|
-
# The disconnect reason for the contact.
|
|
2988
|
+
# The disconnect reason for the contact. For a list and description of
|
|
2989
|
+
# all the possible disconnect reasons by channel, see DisconnectReason
|
|
2990
|
+
# under [ContactTraceRecord][1] in the *Amazon Connect Administrator
|
|
2991
|
+
# Guide*.
|
|
2992
|
+
#
|
|
2993
|
+
#
|
|
2994
|
+
#
|
|
2995
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
|
2835
2996
|
# @return [String]
|
|
2836
2997
|
#
|
|
2837
2998
|
# @!attribute [rw] contact_evaluations
|
|
@@ -2850,6 +3011,10 @@ module Aws::Connect
|
|
|
2850
3011
|
# for task contacts.
|
|
2851
3012
|
# @return [Types::ContactDetails]
|
|
2852
3013
|
#
|
|
3014
|
+
# @!attribute [rw] outbound_strategy
|
|
3015
|
+
# Information about the outbound strategy.
|
|
3016
|
+
# @return [Types::OutboundStrategy]
|
|
3017
|
+
#
|
|
2853
3018
|
# @!attribute [rw] attributes
|
|
2854
3019
|
# The attributes of the contact.
|
|
2855
3020
|
# @return [Hash<String,String>]
|
|
@@ -2900,6 +3065,7 @@ module Aws::Connect
|
|
|
2900
3065
|
:contact_evaluations,
|
|
2901
3066
|
:task_template_info,
|
|
2902
3067
|
:contact_details,
|
|
3068
|
+
:outbound_strategy,
|
|
2903
3069
|
:attributes)
|
|
2904
3070
|
SENSITIVE = [:name, :description]
|
|
2905
3071
|
include Aws::Structure
|
|
@@ -2979,6 +3145,10 @@ module Aws::Connect
|
|
|
2979
3145
|
# Structure to store information associated with a campaign.
|
|
2980
3146
|
# @return [Types::Campaign]
|
|
2981
3147
|
#
|
|
3148
|
+
# @!attribute [rw] outbound_strategy
|
|
3149
|
+
# Information about the outbound strategy.
|
|
3150
|
+
# @return [Types::OutboundStrategy]
|
|
3151
|
+
#
|
|
2982
3152
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactDataRequest AWS API Documentation
|
|
2983
3153
|
#
|
|
2984
3154
|
class ContactDataRequest < Struct.new(
|
|
@@ -2987,7 +3157,8 @@ module Aws::Connect
|
|
|
2987
3157
|
:request_identifier,
|
|
2988
3158
|
:queue_id,
|
|
2989
3159
|
:attributes,
|
|
2990
|
-
:campaign
|
|
3160
|
+
:campaign,
|
|
3161
|
+
:outbound_strategy)
|
|
2991
3162
|
SENSITIVE = []
|
|
2992
3163
|
include Aws::Structure
|
|
2993
3164
|
end
|
|
@@ -3521,7 +3692,7 @@ module Aws::Connect
|
|
|
3521
3692
|
class Unknown < ContactMetricValue; end
|
|
3522
3693
|
end
|
|
3523
3694
|
|
|
3524
|
-
# The contact with the specified ID
|
|
3695
|
+
# The contact with the specified ID does not exist.
|
|
3525
3696
|
#
|
|
3526
3697
|
# @!attribute [rw] message
|
|
3527
3698
|
# The message.
|
|
@@ -4357,6 +4528,10 @@ module Aws::Connect
|
|
|
4357
4528
|
# A scoring strategy of the evaluation form.
|
|
4358
4529
|
# @return [Types::EvaluationFormScoringStrategy]
|
|
4359
4530
|
#
|
|
4531
|
+
# @!attribute [rw] auto_evaluation_configuration
|
|
4532
|
+
# Configuration information about automated evaluations.
|
|
4533
|
+
# @return [Types::EvaluationFormAutoEvaluationConfiguration]
|
|
4534
|
+
#
|
|
4360
4535
|
# @!attribute [rw] client_token
|
|
4361
4536
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
4362
4537
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -4371,6 +4546,12 @@ module Aws::Connect
|
|
|
4371
4546
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
4372
4547
|
# @return [String]
|
|
4373
4548
|
#
|
|
4549
|
+
# @!attribute [rw] tags
|
|
4550
|
+
# The tags used to organize, track, or control access for this
|
|
4551
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
4552
|
+
# "key2":"value2"} }.
|
|
4553
|
+
# @return [Hash<String,String>]
|
|
4554
|
+
#
|
|
4374
4555
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreateEvaluationFormRequest AWS API Documentation
|
|
4375
4556
|
#
|
|
4376
4557
|
class CreateEvaluationFormRequest < Struct.new(
|
|
@@ -4379,7 +4560,9 @@ module Aws::Connect
|
|
|
4379
4560
|
:description,
|
|
4380
4561
|
:items,
|
|
4381
4562
|
:scoring_strategy,
|
|
4382
|
-
:
|
|
4563
|
+
:auto_evaluation_configuration,
|
|
4564
|
+
:client_token,
|
|
4565
|
+
:tags)
|
|
4383
4566
|
SENSITIVE = []
|
|
4384
4567
|
include Aws::Structure
|
|
4385
4568
|
end
|
|
@@ -6258,6 +6441,35 @@ module Aws::Connect
|
|
|
6258
6441
|
include Aws::Structure
|
|
6259
6442
|
end
|
|
6260
6443
|
|
|
6444
|
+
# A datetime search condition for Search APIs.
|
|
6445
|
+
#
|
|
6446
|
+
# @!attribute [rw] field_name
|
|
6447
|
+
# A name of the datetime property to be searched
|
|
6448
|
+
# @return [String]
|
|
6449
|
+
#
|
|
6450
|
+
# @!attribute [rw] min_value
|
|
6451
|
+
# A minimum value of the property.
|
|
6452
|
+
# @return [String]
|
|
6453
|
+
#
|
|
6454
|
+
# @!attribute [rw] max_value
|
|
6455
|
+
# A maximum value of the property.
|
|
6456
|
+
# @return [String]
|
|
6457
|
+
#
|
|
6458
|
+
# @!attribute [rw] comparison_type
|
|
6459
|
+
# Datetime property comparison type.
|
|
6460
|
+
# @return [String]
|
|
6461
|
+
#
|
|
6462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DateTimeCondition AWS API Documentation
|
|
6463
|
+
#
|
|
6464
|
+
class DateTimeCondition < Struct.new(
|
|
6465
|
+
:field_name,
|
|
6466
|
+
:min_value,
|
|
6467
|
+
:max_value,
|
|
6468
|
+
:comparison_type)
|
|
6469
|
+
SENSITIVE = []
|
|
6470
|
+
include Aws::Structure
|
|
6471
|
+
end
|
|
6472
|
+
|
|
6261
6473
|
# @!attribute [rw] instance_id
|
|
6262
6474
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
6263
6475
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -6308,6 +6520,36 @@ module Aws::Connect
|
|
|
6308
6520
|
include Aws::Structure
|
|
6309
6521
|
end
|
|
6310
6522
|
|
|
6523
|
+
# A decimal search condition for Search APIs.
|
|
6524
|
+
#
|
|
6525
|
+
# @!attribute [rw] field_name
|
|
6526
|
+
# A name of the decimal property to be searched.
|
|
6527
|
+
# @return [String]
|
|
6528
|
+
#
|
|
6529
|
+
# @!attribute [rw] min_value
|
|
6530
|
+
# A minimum value of the decimal property.
|
|
6531
|
+
# @return [Float]
|
|
6532
|
+
#
|
|
6533
|
+
# @!attribute [rw] max_value
|
|
6534
|
+
# A maximum value of the decimal property.
|
|
6535
|
+
# @return [Float]
|
|
6536
|
+
#
|
|
6537
|
+
# @!attribute [rw] comparison_type
|
|
6538
|
+
# The type of comparison to be made when evaluating the decimal
|
|
6539
|
+
# condition.
|
|
6540
|
+
# @return [String]
|
|
6541
|
+
#
|
|
6542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DecimalCondition AWS API Documentation
|
|
6543
|
+
#
|
|
6544
|
+
class DecimalCondition < Struct.new(
|
|
6545
|
+
:field_name,
|
|
6546
|
+
:min_value,
|
|
6547
|
+
:max_value,
|
|
6548
|
+
:comparison_type)
|
|
6549
|
+
SENSITIVE = []
|
|
6550
|
+
include Aws::Structure
|
|
6551
|
+
end
|
|
6552
|
+
|
|
6311
6553
|
# Contains information about a default vocabulary.
|
|
6312
6554
|
#
|
|
6313
6555
|
# @!attribute [rw] instance_id
|
|
@@ -7286,6 +7528,13 @@ module Aws::Connect
|
|
|
7286
7528
|
# The email address last modification timestamp in ISO 8601 Datetime.
|
|
7287
7529
|
# @return [String]
|
|
7288
7530
|
#
|
|
7531
|
+
# @!attribute [rw] alias_configurations
|
|
7532
|
+
# A list of alias configurations associated with this email address.
|
|
7533
|
+
# Contains details about email addresses that forward to this primary
|
|
7534
|
+
# email address. The list can contain at most one alias configuration
|
|
7535
|
+
# per email address.
|
|
7536
|
+
# @return [Array<Types::AliasConfiguration>]
|
|
7537
|
+
#
|
|
7289
7538
|
# @!attribute [rw] tags
|
|
7290
7539
|
# The tags used to organize, track, or control access for this
|
|
7291
7540
|
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
@@ -7302,6 +7551,7 @@ module Aws::Connect
|
|
|
7302
7551
|
:description,
|
|
7303
7552
|
:create_timestamp,
|
|
7304
7553
|
:modified_timestamp,
|
|
7554
|
+
:alias_configurations,
|
|
7305
7555
|
:tags)
|
|
7306
7556
|
SENSITIVE = [:email_address, :display_name, :description]
|
|
7307
7557
|
include Aws::Structure
|
|
@@ -8164,6 +8414,54 @@ module Aws::Connect
|
|
|
8164
8414
|
include Aws::Structure
|
|
8165
8415
|
end
|
|
8166
8416
|
|
|
8417
|
+
# @!attribute [rw] email_address_id
|
|
8418
|
+
# The identifier of the email address.
|
|
8419
|
+
# @return [String]
|
|
8420
|
+
#
|
|
8421
|
+
# @!attribute [rw] instance_id
|
|
8422
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
8423
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
8424
|
+
#
|
|
8425
|
+
#
|
|
8426
|
+
#
|
|
8427
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
8428
|
+
# @return [String]
|
|
8429
|
+
#
|
|
8430
|
+
# @!attribute [rw] alias_configuration
|
|
8431
|
+
# Configuration object that specifies which alias relationship to
|
|
8432
|
+
# remove. The alias association must currently exist between the
|
|
8433
|
+
# primary email address and the specified alias email address.
|
|
8434
|
+
# @return [Types::AliasConfiguration]
|
|
8435
|
+
#
|
|
8436
|
+
# @!attribute [rw] client_token
|
|
8437
|
+
# A unique, case-sensitive identifier that you provide to ensure the
|
|
8438
|
+
# idempotency of the request. If not provided, the Amazon Web Services
|
|
8439
|
+
# SDK populates this field. For more information about idempotency,
|
|
8440
|
+
# see [Making retries safe with idempotent APIs][1].
|
|
8441
|
+
#
|
|
8442
|
+
# **A suitable default value is auto-generated.** You should normally
|
|
8443
|
+
# not need to pass this option.
|
|
8444
|
+
#
|
|
8445
|
+
#
|
|
8446
|
+
#
|
|
8447
|
+
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
8448
|
+
# @return [String]
|
|
8449
|
+
#
|
|
8450
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateEmailAddressAliasRequest AWS API Documentation
|
|
8451
|
+
#
|
|
8452
|
+
class DisassociateEmailAddressAliasRequest < Struct.new(
|
|
8453
|
+
:email_address_id,
|
|
8454
|
+
:instance_id,
|
|
8455
|
+
:alias_configuration,
|
|
8456
|
+
:client_token)
|
|
8457
|
+
SENSITIVE = []
|
|
8458
|
+
include Aws::Structure
|
|
8459
|
+
end
|
|
8460
|
+
|
|
8461
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DisassociateEmailAddressAliasResponse AWS API Documentation
|
|
8462
|
+
#
|
|
8463
|
+
class DisassociateEmailAddressAliasResponse < Aws::EmptyStructure; end
|
|
8464
|
+
|
|
8167
8465
|
# @!attribute [rw] instance_id
|
|
8168
8466
|
# The identifier of the Amazon Connect instance. You can [find the
|
|
8169
8467
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -8674,6 +8972,13 @@ module Aws::Connect
|
|
|
8674
8972
|
# The display name of email address.
|
|
8675
8973
|
# @return [String]
|
|
8676
8974
|
#
|
|
8975
|
+
# @!attribute [rw] alias_configurations
|
|
8976
|
+
# A list of alias configurations for this email address, showing which
|
|
8977
|
+
# email addresses forward to this primary address. Each configuration
|
|
8978
|
+
# contains the email address ID of an alias that forwards emails to
|
|
8979
|
+
# this address.
|
|
8980
|
+
# @return [Array<Types::AliasConfiguration>]
|
|
8981
|
+
#
|
|
8677
8982
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EmailAddressMetadata AWS API Documentation
|
|
8678
8983
|
#
|
|
8679
8984
|
class EmailAddressMetadata < Struct.new(
|
|
@@ -8681,7 +8986,8 @@ module Aws::Connect
|
|
|
8681
8986
|
:email_address_arn,
|
|
8682
8987
|
:email_address,
|
|
8683
8988
|
:description,
|
|
8684
|
-
:display_name
|
|
8989
|
+
:display_name,
|
|
8990
|
+
:alias_configurations)
|
|
8685
8991
|
SENSITIVE = [:email_address, :description, :display_name]
|
|
8686
8992
|
include Aws::Structure
|
|
8687
8993
|
end
|
|
@@ -8964,6 +9270,10 @@ module Aws::Connect
|
|
|
8964
9270
|
# The timestamp for when the evaluation was last updated.
|
|
8965
9271
|
# @return [Time]
|
|
8966
9272
|
#
|
|
9273
|
+
# @!attribute [rw] evaluation_type
|
|
9274
|
+
# Type of the evaluation.
|
|
9275
|
+
# @return [String]
|
|
9276
|
+
#
|
|
8967
9277
|
# @!attribute [rw] tags
|
|
8968
9278
|
# The tags used to organize, track, or control access for this
|
|
8969
9279
|
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
@@ -8982,11 +9292,62 @@ module Aws::Connect
|
|
|
8982
9292
|
:scores,
|
|
8983
9293
|
:created_time,
|
|
8984
9294
|
:last_modified_time,
|
|
9295
|
+
:evaluation_type,
|
|
8985
9296
|
:tags)
|
|
8986
9297
|
SENSITIVE = []
|
|
8987
9298
|
include Aws::Structure
|
|
8988
9299
|
end
|
|
8989
9300
|
|
|
9301
|
+
# Information about the evaluation acknowledgement.
|
|
9302
|
+
#
|
|
9303
|
+
# @!attribute [rw] acknowledged_time
|
|
9304
|
+
# When the agent acknowledged the evaluation.
|
|
9305
|
+
# @return [Time]
|
|
9306
|
+
#
|
|
9307
|
+
# @!attribute [rw] acknowledged_by
|
|
9308
|
+
# The agent who acknowledged the evaluation.
|
|
9309
|
+
# @return [String]
|
|
9310
|
+
#
|
|
9311
|
+
# @!attribute [rw] acknowledger_comment
|
|
9312
|
+
# A comment from the agent when they confirmed they acknowledged the
|
|
9313
|
+
# evaluation.
|
|
9314
|
+
# @return [String]
|
|
9315
|
+
#
|
|
9316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAcknowledgement AWS API Documentation
|
|
9317
|
+
#
|
|
9318
|
+
class EvaluationAcknowledgement < Struct.new(
|
|
9319
|
+
:acknowledged_time,
|
|
9320
|
+
:acknowledged_by,
|
|
9321
|
+
:acknowledger_comment)
|
|
9322
|
+
SENSITIVE = []
|
|
9323
|
+
include Aws::Structure
|
|
9324
|
+
end
|
|
9325
|
+
|
|
9326
|
+
# Summary information about an evaluation acknowledgement.
|
|
9327
|
+
#
|
|
9328
|
+
# @!attribute [rw] acknowledged_time
|
|
9329
|
+
# The time when an agent acknowledged the evaluation.
|
|
9330
|
+
# @return [Time]
|
|
9331
|
+
#
|
|
9332
|
+
# @!attribute [rw] acknowledged_by
|
|
9333
|
+
# The agent who acknowledged the evaluation.
|
|
9334
|
+
# @return [String]
|
|
9335
|
+
#
|
|
9336
|
+
# @!attribute [rw] acknowledger_comment
|
|
9337
|
+
# A comment from the agent when they confirmed they acknowledged the
|
|
9338
|
+
# evaluation.
|
|
9339
|
+
# @return [String]
|
|
9340
|
+
#
|
|
9341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAcknowledgementSummary AWS API Documentation
|
|
9342
|
+
#
|
|
9343
|
+
class EvaluationAcknowledgementSummary < Struct.new(
|
|
9344
|
+
:acknowledged_time,
|
|
9345
|
+
:acknowledged_by,
|
|
9346
|
+
:acknowledger_comment)
|
|
9347
|
+
SENSITIVE = []
|
|
9348
|
+
include Aws::Structure
|
|
9349
|
+
end
|
|
9350
|
+
|
|
8990
9351
|
# Information about answer data for a contact evaluation. Answer data
|
|
8991
9352
|
# must be either string, numeric, or not applicable.
|
|
8992
9353
|
#
|
|
@@ -9047,37 +9408,82 @@ module Aws::Connect
|
|
|
9047
9408
|
# The system suggested value for an answer in a contact evaluation.
|
|
9048
9409
|
# @return [Types::EvaluationAnswerData]
|
|
9049
9410
|
#
|
|
9411
|
+
# @!attribute [rw] suggested_answers
|
|
9412
|
+
# Automation suggested answers for the questions.
|
|
9413
|
+
# @return [Array<Types::EvaluationSuggestedAnswer>]
|
|
9414
|
+
#
|
|
9050
9415
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAnswerOutput AWS API Documentation
|
|
9051
9416
|
#
|
|
9052
9417
|
class EvaluationAnswerOutput < Struct.new(
|
|
9053
9418
|
:value,
|
|
9054
|
-
:system_suggested_value
|
|
9419
|
+
:system_suggested_value,
|
|
9420
|
+
:suggested_answers)
|
|
9055
9421
|
SENSITIVE = []
|
|
9056
9422
|
include Aws::Structure
|
|
9057
9423
|
end
|
|
9058
9424
|
|
|
9059
|
-
#
|
|
9425
|
+
# The Contact Lens category used by evaluation automation.
|
|
9060
9426
|
#
|
|
9061
|
-
# @!attribute [rw]
|
|
9062
|
-
#
|
|
9427
|
+
# @!attribute [rw] category
|
|
9428
|
+
# A category label.
|
|
9063
9429
|
# @return [String]
|
|
9064
9430
|
#
|
|
9065
|
-
# @!attribute [rw]
|
|
9066
|
-
#
|
|
9067
|
-
# @return [Integer]
|
|
9068
|
-
#
|
|
9069
|
-
# @!attribute [rw] locked
|
|
9070
|
-
# The flag indicating whether the evaluation form is locked for
|
|
9071
|
-
# changes.
|
|
9072
|
-
# @return [Boolean]
|
|
9073
|
-
#
|
|
9074
|
-
# @!attribute [rw] evaluation_form_arn
|
|
9075
|
-
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
|
9431
|
+
# @!attribute [rw] condition
|
|
9432
|
+
# An automation condition for a Contact Lens category.
|
|
9076
9433
|
# @return [String]
|
|
9077
9434
|
#
|
|
9078
|
-
# @!attribute [rw]
|
|
9079
|
-
# A
|
|
9080
|
-
#
|
|
9435
|
+
# @!attribute [rw] points_of_interest
|
|
9436
|
+
# A point of interest in a contact transcript that indicates match of
|
|
9437
|
+
# condition.
|
|
9438
|
+
# @return [Array<Types::EvaluationTranscriptPointOfInterest>]
|
|
9439
|
+
#
|
|
9440
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationAutomationRuleCategory AWS API Documentation
|
|
9441
|
+
#
|
|
9442
|
+
class EvaluationAutomationRuleCategory < Struct.new(
|
|
9443
|
+
:category,
|
|
9444
|
+
:condition,
|
|
9445
|
+
:points_of_interest)
|
|
9446
|
+
SENSITIVE = []
|
|
9447
|
+
include Aws::Structure
|
|
9448
|
+
end
|
|
9449
|
+
|
|
9450
|
+
# Analysis details providing explanation for Contact Lens automation
|
|
9451
|
+
# decision.
|
|
9452
|
+
#
|
|
9453
|
+
# @!attribute [rw] matched_rule_categories
|
|
9454
|
+
# A list of match rule categories.
|
|
9455
|
+
# @return [Array<Types::EvaluationAutomationRuleCategory>]
|
|
9456
|
+
#
|
|
9457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationContactLensAnswerAnalysisDetails AWS API Documentation
|
|
9458
|
+
#
|
|
9459
|
+
class EvaluationContactLensAnswerAnalysisDetails < Struct.new(
|
|
9460
|
+
:matched_rule_categories)
|
|
9461
|
+
SENSITIVE = []
|
|
9462
|
+
include Aws::Structure
|
|
9463
|
+
end
|
|
9464
|
+
|
|
9465
|
+
# Information about the evaluation form.
|
|
9466
|
+
#
|
|
9467
|
+
# @!attribute [rw] evaluation_form_id
|
|
9468
|
+
# The unique identifier for the evaluation form.
|
|
9469
|
+
# @return [String]
|
|
9470
|
+
#
|
|
9471
|
+
# @!attribute [rw] evaluation_form_version
|
|
9472
|
+
# A version of the evaluation form.
|
|
9473
|
+
# @return [Integer]
|
|
9474
|
+
#
|
|
9475
|
+
# @!attribute [rw] locked
|
|
9476
|
+
# The flag indicating whether the evaluation form is locked for
|
|
9477
|
+
# changes.
|
|
9478
|
+
# @return [Boolean]
|
|
9479
|
+
#
|
|
9480
|
+
# @!attribute [rw] evaluation_form_arn
|
|
9481
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
|
9482
|
+
# @return [String]
|
|
9483
|
+
#
|
|
9484
|
+
# @!attribute [rw] title
|
|
9485
|
+
# A title of the evaluation form.
|
|
9486
|
+
# @return [String]
|
|
9081
9487
|
#
|
|
9082
9488
|
# @!attribute [rw] description
|
|
9083
9489
|
# The description of the evaluation form.
|
|
@@ -9115,6 +9521,10 @@ module Aws::Connect
|
|
|
9115
9521
|
# evaluation form.
|
|
9116
9522
|
# @return [String]
|
|
9117
9523
|
#
|
|
9524
|
+
# @!attribute [rw] auto_evaluation_configuration
|
|
9525
|
+
# The automatic evaluation configuration of an evaluation form.
|
|
9526
|
+
# @return [Types::EvaluationFormAutoEvaluationConfiguration]
|
|
9527
|
+
#
|
|
9118
9528
|
# @!attribute [rw] tags
|
|
9119
9529
|
# The tags used to organize, track, or control access for this
|
|
9120
9530
|
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
@@ -9137,11 +9547,26 @@ module Aws::Connect
|
|
|
9137
9547
|
:created_by,
|
|
9138
9548
|
:last_modified_time,
|
|
9139
9549
|
:last_modified_by,
|
|
9550
|
+
:auto_evaluation_configuration,
|
|
9140
9551
|
:tags)
|
|
9141
9552
|
SENSITIVE = []
|
|
9142
9553
|
include Aws::Structure
|
|
9143
9554
|
end
|
|
9144
9555
|
|
|
9556
|
+
# The automatic evaluation configuration of an evaluation form.
|
|
9557
|
+
#
|
|
9558
|
+
# @!attribute [rw] enabled
|
|
9559
|
+
# When automated evaluation is enabled.
|
|
9560
|
+
# @return [Boolean]
|
|
9561
|
+
#
|
|
9562
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormAutoEvaluationConfiguration AWS API Documentation
|
|
9563
|
+
#
|
|
9564
|
+
class EvaluationFormAutoEvaluationConfiguration < Struct.new(
|
|
9565
|
+
:enabled)
|
|
9566
|
+
SENSITIVE = []
|
|
9567
|
+
include Aws::Structure
|
|
9568
|
+
end
|
|
9569
|
+
|
|
9145
9570
|
# Information about an evaluation form used in a contact evaluation.
|
|
9146
9571
|
#
|
|
9147
9572
|
# @!attribute [rw] evaluation_form_version
|
|
@@ -9174,6 +9599,10 @@ module Aws::Connect
|
|
|
9174
9599
|
# A scoring strategy of the evaluation form.
|
|
9175
9600
|
# @return [Types::EvaluationFormScoringStrategy]
|
|
9176
9601
|
#
|
|
9602
|
+
# @!attribute [rw] auto_evaluation_configuration
|
|
9603
|
+
# The configuration of the automated evaluation.
|
|
9604
|
+
# @return [Types::EvaluationFormAutoEvaluationConfiguration]
|
|
9605
|
+
#
|
|
9177
9606
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormContent AWS API Documentation
|
|
9178
9607
|
#
|
|
9179
9608
|
class EvaluationFormContent < Struct.new(
|
|
@@ -9183,7 +9612,8 @@ module Aws::Connect
|
|
|
9183
9612
|
:title,
|
|
9184
9613
|
:description,
|
|
9185
9614
|
:items,
|
|
9186
|
-
:scoring_strategy
|
|
9615
|
+
:scoring_strategy,
|
|
9616
|
+
:auto_evaluation_configuration)
|
|
9187
9617
|
SENSITIVE = []
|
|
9188
9618
|
include Aws::Structure
|
|
9189
9619
|
end
|
|
@@ -9218,6 +9648,142 @@ module Aws::Connect
|
|
|
9218
9648
|
class Unknown < EvaluationFormItem; end
|
|
9219
9649
|
end
|
|
9220
9650
|
|
|
9651
|
+
# A condition for item enablement.
|
|
9652
|
+
#
|
|
9653
|
+
# @!attribute [rw] operands
|
|
9654
|
+
# Operands of the enablement condition.
|
|
9655
|
+
# @return [Array<Types::EvaluationFormItemEnablementConditionOperand>]
|
|
9656
|
+
#
|
|
9657
|
+
# @!attribute [rw] operator
|
|
9658
|
+
# The operator to be used to be applied to operands if more than one
|
|
9659
|
+
# provided.
|
|
9660
|
+
# @return [String]
|
|
9661
|
+
#
|
|
9662
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementCondition AWS API Documentation
|
|
9663
|
+
#
|
|
9664
|
+
class EvaluationFormItemEnablementCondition < Struct.new(
|
|
9665
|
+
:operands,
|
|
9666
|
+
:operator)
|
|
9667
|
+
SENSITIVE = []
|
|
9668
|
+
include Aws::Structure
|
|
9669
|
+
end
|
|
9670
|
+
|
|
9671
|
+
# An operand of the enablement condition.
|
|
9672
|
+
#
|
|
9673
|
+
# @note EvaluationFormItemEnablementConditionOperand is a union - when making an API calls you must set exactly one of the members.
|
|
9674
|
+
#
|
|
9675
|
+
# @note EvaluationFormItemEnablementConditionOperand is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationFormItemEnablementConditionOperand corresponding to the set member.
|
|
9676
|
+
#
|
|
9677
|
+
# @!attribute [rw] expression
|
|
9678
|
+
# An expression of the enablement condition.
|
|
9679
|
+
# @return [Types::EvaluationFormItemEnablementExpression]
|
|
9680
|
+
#
|
|
9681
|
+
# @!attribute [rw] condition
|
|
9682
|
+
# A condition for item enablement.
|
|
9683
|
+
# @return [Types::EvaluationFormItemEnablementCondition]
|
|
9684
|
+
#
|
|
9685
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementConditionOperand AWS API Documentation
|
|
9686
|
+
#
|
|
9687
|
+
class EvaluationFormItemEnablementConditionOperand < Struct.new(
|
|
9688
|
+
:expression,
|
|
9689
|
+
:condition,
|
|
9690
|
+
:unknown)
|
|
9691
|
+
SENSITIVE = []
|
|
9692
|
+
include Aws::Structure
|
|
9693
|
+
include Aws::Structure::Union
|
|
9694
|
+
|
|
9695
|
+
class Expression < EvaluationFormItemEnablementConditionOperand; end
|
|
9696
|
+
class Condition < EvaluationFormItemEnablementConditionOperand; end
|
|
9697
|
+
class Unknown < EvaluationFormItemEnablementConditionOperand; end
|
|
9698
|
+
end
|
|
9699
|
+
|
|
9700
|
+
# An item enablement configuration.
|
|
9701
|
+
#
|
|
9702
|
+
# @!attribute [rw] condition
|
|
9703
|
+
# A condition for item enablement configuration.
|
|
9704
|
+
# @return [Types::EvaluationFormItemEnablementCondition]
|
|
9705
|
+
#
|
|
9706
|
+
# @!attribute [rw] action
|
|
9707
|
+
# An enablement action that if condition is satisfied.
|
|
9708
|
+
# @return [String]
|
|
9709
|
+
#
|
|
9710
|
+
# @!attribute [rw] default_action
|
|
9711
|
+
# An enablement action that if condition is not satisfied.
|
|
9712
|
+
# @return [String]
|
|
9713
|
+
#
|
|
9714
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementConfiguration AWS API Documentation
|
|
9715
|
+
#
|
|
9716
|
+
class EvaluationFormItemEnablementConfiguration < Struct.new(
|
|
9717
|
+
:condition,
|
|
9718
|
+
:action,
|
|
9719
|
+
:default_action)
|
|
9720
|
+
SENSITIVE = []
|
|
9721
|
+
include Aws::Structure
|
|
9722
|
+
end
|
|
9723
|
+
|
|
9724
|
+
# An expression that defines a basic building block of conditional
|
|
9725
|
+
# enablement.
|
|
9726
|
+
#
|
|
9727
|
+
# @!attribute [rw] source
|
|
9728
|
+
# A source item of enablement expression.
|
|
9729
|
+
# @return [Types::EvaluationFormItemEnablementSource]
|
|
9730
|
+
#
|
|
9731
|
+
# @!attribute [rw] values
|
|
9732
|
+
# A list of values from source item.
|
|
9733
|
+
# @return [Array<Types::EvaluationFormItemEnablementSourceValue>]
|
|
9734
|
+
#
|
|
9735
|
+
# @!attribute [rw] comparator
|
|
9736
|
+
# A comparator to be used against list of values.
|
|
9737
|
+
# @return [String]
|
|
9738
|
+
#
|
|
9739
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementExpression AWS API Documentation
|
|
9740
|
+
#
|
|
9741
|
+
class EvaluationFormItemEnablementExpression < Struct.new(
|
|
9742
|
+
:source,
|
|
9743
|
+
:values,
|
|
9744
|
+
:comparator)
|
|
9745
|
+
SENSITIVE = []
|
|
9746
|
+
include Aws::Structure
|
|
9747
|
+
end
|
|
9748
|
+
|
|
9749
|
+
# An enablement expression source item.
|
|
9750
|
+
#
|
|
9751
|
+
# @!attribute [rw] type
|
|
9752
|
+
# A type of source item.
|
|
9753
|
+
# @return [String]
|
|
9754
|
+
#
|
|
9755
|
+
# @!attribute [rw] ref_id
|
|
9756
|
+
# A referenceId of the source item.
|
|
9757
|
+
# @return [String]
|
|
9758
|
+
#
|
|
9759
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementSource AWS API Documentation
|
|
9760
|
+
#
|
|
9761
|
+
class EvaluationFormItemEnablementSource < Struct.new(
|
|
9762
|
+
:type,
|
|
9763
|
+
:ref_id)
|
|
9764
|
+
SENSITIVE = []
|
|
9765
|
+
include Aws::Structure
|
|
9766
|
+
end
|
|
9767
|
+
|
|
9768
|
+
# An enablement expression source value.
|
|
9769
|
+
#
|
|
9770
|
+
# @!attribute [rw] type
|
|
9771
|
+
# A type of source item value.
|
|
9772
|
+
# @return [String]
|
|
9773
|
+
#
|
|
9774
|
+
# @!attribute [rw] ref_id
|
|
9775
|
+
# A referenceId of the source value.
|
|
9776
|
+
# @return [String]
|
|
9777
|
+
#
|
|
9778
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormItemEnablementSourceValue AWS API Documentation
|
|
9779
|
+
#
|
|
9780
|
+
class EvaluationFormItemEnablementSourceValue < Struct.new(
|
|
9781
|
+
:type,
|
|
9782
|
+
:ref_id)
|
|
9783
|
+
SENSITIVE = []
|
|
9784
|
+
include Aws::Structure
|
|
9785
|
+
end
|
|
9786
|
+
|
|
9221
9787
|
# Information about the automation configuration in numeric questions.
|
|
9222
9788
|
#
|
|
9223
9789
|
# @note EvaluationFormNumericQuestionAutomation is a union - when making an API calls you must set exactly one of the members.
|
|
@@ -9228,16 +9794,22 @@ module Aws::Connect
|
|
|
9228
9794
|
# The property value of the automation.
|
|
9229
9795
|
# @return [Types::NumericQuestionPropertyValueAutomation]
|
|
9230
9796
|
#
|
|
9797
|
+
# @!attribute [rw] answer_source
|
|
9798
|
+
# A source of automation answer for numeric question.
|
|
9799
|
+
# @return [Types::EvaluationFormQuestionAutomationAnswerSource]
|
|
9800
|
+
#
|
|
9231
9801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormNumericQuestionAutomation AWS API Documentation
|
|
9232
9802
|
#
|
|
9233
9803
|
class EvaluationFormNumericQuestionAutomation < Struct.new(
|
|
9234
9804
|
:property_value,
|
|
9805
|
+
:answer_source,
|
|
9235
9806
|
:unknown)
|
|
9236
9807
|
SENSITIVE = []
|
|
9237
9808
|
include Aws::Structure
|
|
9238
9809
|
include Aws::Structure::Union
|
|
9239
9810
|
|
|
9240
9811
|
class PropertyValue < EvaluationFormNumericQuestionAutomation; end
|
|
9812
|
+
class AnswerSource < EvaluationFormNumericQuestionAutomation; end
|
|
9241
9813
|
class Unknown < EvaluationFormNumericQuestionAutomation; end
|
|
9242
9814
|
end
|
|
9243
9815
|
|
|
@@ -9261,13 +9833,18 @@ module Aws::Connect
|
|
|
9261
9833
|
# answer is provided, the overall evaluation gets a score of 0.
|
|
9262
9834
|
# @return [Boolean]
|
|
9263
9835
|
#
|
|
9836
|
+
# @!attribute [rw] automatic_fail_configuration
|
|
9837
|
+
# A configuration for automatic fail.
|
|
9838
|
+
# @return [Types::AutomaticFailConfiguration]
|
|
9839
|
+
#
|
|
9264
9840
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormNumericQuestionOption AWS API Documentation
|
|
9265
9841
|
#
|
|
9266
9842
|
class EvaluationFormNumericQuestionOption < Struct.new(
|
|
9267
9843
|
:min_value,
|
|
9268
9844
|
:max_value,
|
|
9269
9845
|
:score,
|
|
9270
|
-
:automatic_fail
|
|
9846
|
+
:automatic_fail,
|
|
9847
|
+
:automatic_fail_configuration)
|
|
9271
9848
|
SENSITIVE = []
|
|
9272
9849
|
include Aws::Structure
|
|
9273
9850
|
end
|
|
@@ -9330,6 +9907,10 @@ module Aws::Connect
|
|
|
9330
9907
|
# to define question type properties.
|
|
9331
9908
|
# @return [Types::EvaluationFormQuestionTypeProperties]
|
|
9332
9909
|
#
|
|
9910
|
+
# @!attribute [rw] enablement
|
|
9911
|
+
# A question conditional enablement.
|
|
9912
|
+
# @return [Types::EvaluationFormItemEnablementConfiguration]
|
|
9913
|
+
#
|
|
9333
9914
|
# @!attribute [rw] weight
|
|
9334
9915
|
# The scoring weight of the section.
|
|
9335
9916
|
# @return [Float]
|
|
@@ -9343,11 +9924,26 @@ module Aws::Connect
|
|
|
9343
9924
|
:not_applicable_enabled,
|
|
9344
9925
|
:question_type,
|
|
9345
9926
|
:question_type_properties,
|
|
9927
|
+
:enablement,
|
|
9346
9928
|
:weight)
|
|
9347
9929
|
SENSITIVE = []
|
|
9348
9930
|
include Aws::Structure
|
|
9349
9931
|
end
|
|
9350
9932
|
|
|
9933
|
+
# A question automation answer.
|
|
9934
|
+
#
|
|
9935
|
+
# @!attribute [rw] source_type
|
|
9936
|
+
# The automation answer source type.
|
|
9937
|
+
# @return [String]
|
|
9938
|
+
#
|
|
9939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormQuestionAutomationAnswerSource AWS API Documentation
|
|
9940
|
+
#
|
|
9941
|
+
class EvaluationFormQuestionAutomationAnswerSource < Struct.new(
|
|
9942
|
+
:source_type)
|
|
9943
|
+
SENSITIVE = []
|
|
9944
|
+
include Aws::Structure
|
|
9945
|
+
end
|
|
9946
|
+
|
|
9351
9947
|
# Information about properties for a question in an evaluation form. The
|
|
9352
9948
|
# question type properties must be either for a numeric question or a
|
|
9353
9949
|
# single select question.
|
|
@@ -9364,11 +9960,16 @@ module Aws::Connect
|
|
|
9364
9960
|
# The properties of the numeric question.
|
|
9365
9961
|
# @return [Types::EvaluationFormSingleSelectQuestionProperties]
|
|
9366
9962
|
#
|
|
9963
|
+
# @!attribute [rw] text
|
|
9964
|
+
# The properties of the text question.
|
|
9965
|
+
# @return [Types::EvaluationFormTextQuestionProperties]
|
|
9966
|
+
#
|
|
9367
9967
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormQuestionTypeProperties AWS API Documentation
|
|
9368
9968
|
#
|
|
9369
9969
|
class EvaluationFormQuestionTypeProperties < Struct.new(
|
|
9370
9970
|
:numeric,
|
|
9371
9971
|
:single_select,
|
|
9972
|
+
:text,
|
|
9372
9973
|
:unknown)
|
|
9373
9974
|
SENSITIVE = []
|
|
9374
9975
|
include Aws::Structure
|
|
@@ -9376,6 +9977,7 @@ module Aws::Connect
|
|
|
9376
9977
|
|
|
9377
9978
|
class Numeric < EvaluationFormQuestionTypeProperties; end
|
|
9378
9979
|
class SingleSelect < EvaluationFormQuestionTypeProperties; end
|
|
9980
|
+
class Text < EvaluationFormQuestionTypeProperties; end
|
|
9379
9981
|
class Unknown < EvaluationFormQuestionTypeProperties; end
|
|
9380
9982
|
end
|
|
9381
9983
|
|
|
@@ -9398,6 +10000,161 @@ module Aws::Connect
|
|
|
9398
10000
|
include Aws::Structure
|
|
9399
10001
|
end
|
|
9400
10002
|
|
|
10003
|
+
# The search criteria to be used to return evaluation forms.
|
|
10004
|
+
#
|
|
10005
|
+
# @!attribute [rw] or_conditions
|
|
10006
|
+
# A list of conditions which would be applied together with an OR
|
|
10007
|
+
# condition.
|
|
10008
|
+
# @return [Array<Types::EvaluationFormSearchCriteria>]
|
|
10009
|
+
#
|
|
10010
|
+
# @!attribute [rw] and_conditions
|
|
10011
|
+
# A list of conditions which would be applied together with an AND
|
|
10012
|
+
# condition.
|
|
10013
|
+
# @return [Array<Types::EvaluationFormSearchCriteria>]
|
|
10014
|
+
#
|
|
10015
|
+
# @!attribute [rw] string_condition
|
|
10016
|
+
# A leaf node condition which can be used to specify a string
|
|
10017
|
+
# condition.
|
|
10018
|
+
# @return [Types::StringCondition]
|
|
10019
|
+
#
|
|
10020
|
+
# @!attribute [rw] number_condition
|
|
10021
|
+
# A leaf node condition which can be used to specify a numeric
|
|
10022
|
+
# condition.
|
|
10023
|
+
#
|
|
10024
|
+
# <note markdown="1"> The currently supported value for `FieldName` is `limit`.
|
|
10025
|
+
#
|
|
10026
|
+
# </note>
|
|
10027
|
+
# @return [Types::NumberCondition]
|
|
10028
|
+
#
|
|
10029
|
+
# @!attribute [rw] boolean_condition
|
|
10030
|
+
# Boolean search condition.
|
|
10031
|
+
# @return [Types::BooleanCondition]
|
|
10032
|
+
#
|
|
10033
|
+
# @!attribute [rw] date_time_condition
|
|
10034
|
+
# Datetime search condition.
|
|
10035
|
+
# @return [Types::DateTimeCondition]
|
|
10036
|
+
#
|
|
10037
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSearchCriteria AWS API Documentation
|
|
10038
|
+
#
|
|
10039
|
+
class EvaluationFormSearchCriteria < Struct.new(
|
|
10040
|
+
:or_conditions,
|
|
10041
|
+
:and_conditions,
|
|
10042
|
+
:string_condition,
|
|
10043
|
+
:number_condition,
|
|
10044
|
+
:boolean_condition,
|
|
10045
|
+
:date_time_condition)
|
|
10046
|
+
SENSITIVE = []
|
|
10047
|
+
include Aws::Structure
|
|
10048
|
+
end
|
|
10049
|
+
|
|
10050
|
+
# Filters to be applied to search results.
|
|
10051
|
+
#
|
|
10052
|
+
# @!attribute [rw] attribute_filter
|
|
10053
|
+
# An object that can be used to specify Tag conditions inside the
|
|
10054
|
+
# `SearchFilter`. This accepts an `OR` or `AND` (List of List) input
|
|
10055
|
+
# where:
|
|
10056
|
+
#
|
|
10057
|
+
# * The top level list specifies conditions that need to be applied
|
|
10058
|
+
# with `OR` operator.
|
|
10059
|
+
#
|
|
10060
|
+
# * The inner list specifies conditions that need to be applied with
|
|
10061
|
+
# `AND` operator.
|
|
10062
|
+
# @return [Types::ControlPlaneAttributeFilter]
|
|
10063
|
+
#
|
|
10064
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSearchFilter AWS API Documentation
|
|
10065
|
+
#
|
|
10066
|
+
class EvaluationFormSearchFilter < Struct.new(
|
|
10067
|
+
:attribute_filter)
|
|
10068
|
+
SENSITIVE = []
|
|
10069
|
+
include Aws::Structure
|
|
10070
|
+
end
|
|
10071
|
+
|
|
10072
|
+
# Information about the returned evaluation forms.
|
|
10073
|
+
#
|
|
10074
|
+
# @!attribute [rw] evaluation_form_id
|
|
10075
|
+
# The unique identifier for the evaluation form.
|
|
10076
|
+
# @return [String]
|
|
10077
|
+
#
|
|
10078
|
+
# @!attribute [rw] evaluation_form_arn
|
|
10079
|
+
# The Amazon Resource Name (ARN) for the evaluation form resource.
|
|
10080
|
+
# @return [String]
|
|
10081
|
+
#
|
|
10082
|
+
# @!attribute [rw] title
|
|
10083
|
+
# The title of the evaluation form.
|
|
10084
|
+
# @return [String]
|
|
10085
|
+
#
|
|
10086
|
+
# @!attribute [rw] status
|
|
10087
|
+
# The status of the evaluation form.
|
|
10088
|
+
# @return [String]
|
|
10089
|
+
#
|
|
10090
|
+
# @!attribute [rw] description
|
|
10091
|
+
# The description of the evaluation form.
|
|
10092
|
+
# @return [String]
|
|
10093
|
+
#
|
|
10094
|
+
# @!attribute [rw] created_time
|
|
10095
|
+
# When the evaluation form was created.
|
|
10096
|
+
# @return [Time]
|
|
10097
|
+
#
|
|
10098
|
+
# @!attribute [rw] created_by
|
|
10099
|
+
# Who created the evaluation form.
|
|
10100
|
+
# @return [String]
|
|
10101
|
+
#
|
|
10102
|
+
# @!attribute [rw] last_modified_time
|
|
10103
|
+
# When the evaluation form was last changed.
|
|
10104
|
+
# @return [Time]
|
|
10105
|
+
#
|
|
10106
|
+
# @!attribute [rw] last_modified_by
|
|
10107
|
+
# Who changed the evaluation form.
|
|
10108
|
+
# @return [String]
|
|
10109
|
+
#
|
|
10110
|
+
# @!attribute [rw] last_activated_time
|
|
10111
|
+
# When the evaluation format was last activated.
|
|
10112
|
+
# @return [Time]
|
|
10113
|
+
#
|
|
10114
|
+
# @!attribute [rw] last_activated_by
|
|
10115
|
+
# The ID of user who last activated evaluation form.
|
|
10116
|
+
# @return [String]
|
|
10117
|
+
#
|
|
10118
|
+
# @!attribute [rw] latest_version
|
|
10119
|
+
# Latest version of the evaluation form.
|
|
10120
|
+
# @return [Integer]
|
|
10121
|
+
#
|
|
10122
|
+
# @!attribute [rw] active_version
|
|
10123
|
+
# Active version of the evaluation form.
|
|
10124
|
+
# @return [Integer]
|
|
10125
|
+
#
|
|
10126
|
+
# @!attribute [rw] auto_evaluation_enabled
|
|
10127
|
+
# Whether automated evaluation is enabled.
|
|
10128
|
+
# @return [Boolean]
|
|
10129
|
+
#
|
|
10130
|
+
# @!attribute [rw] tags
|
|
10131
|
+
# The tags used to organize, track, or control access for this
|
|
10132
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
10133
|
+
# "key2":"value2"} }.
|
|
10134
|
+
# @return [Hash<String,String>]
|
|
10135
|
+
#
|
|
10136
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSearchSummary AWS API Documentation
|
|
10137
|
+
#
|
|
10138
|
+
class EvaluationFormSearchSummary < Struct.new(
|
|
10139
|
+
:evaluation_form_id,
|
|
10140
|
+
:evaluation_form_arn,
|
|
10141
|
+
:title,
|
|
10142
|
+
:status,
|
|
10143
|
+
:description,
|
|
10144
|
+
:created_time,
|
|
10145
|
+
:created_by,
|
|
10146
|
+
:last_modified_time,
|
|
10147
|
+
:last_modified_by,
|
|
10148
|
+
:last_activated_time,
|
|
10149
|
+
:last_activated_by,
|
|
10150
|
+
:latest_version,
|
|
10151
|
+
:active_version,
|
|
10152
|
+
:auto_evaluation_enabled,
|
|
10153
|
+
:tags)
|
|
10154
|
+
SENSITIVE = []
|
|
10155
|
+
include Aws::Structure
|
|
10156
|
+
end
|
|
10157
|
+
|
|
9401
10158
|
# Information about a section from an evaluation form. A section can
|
|
9402
10159
|
# contain sections and/or questions. Evaluation forms can only contain
|
|
9403
10160
|
# sections and subsections (two level nesting).
|
|
@@ -9449,11 +10206,16 @@ module Aws::Connect
|
|
|
9449
10206
|
# automation options match the criteria.
|
|
9450
10207
|
# @return [String]
|
|
9451
10208
|
#
|
|
10209
|
+
# @!attribute [rw] answer_source
|
|
10210
|
+
# Automation answer source.
|
|
10211
|
+
# @return [Types::EvaluationFormQuestionAutomationAnswerSource]
|
|
10212
|
+
#
|
|
9452
10213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionAutomation AWS API Documentation
|
|
9453
10214
|
#
|
|
9454
10215
|
class EvaluationFormSingleSelectQuestionAutomation < Struct.new(
|
|
9455
10216
|
:options,
|
|
9456
|
-
:default_option_ref_id
|
|
10217
|
+
:default_option_ref_id,
|
|
10218
|
+
:answer_source)
|
|
9457
10219
|
SENSITIVE = []
|
|
9458
10220
|
include Aws::Structure
|
|
9459
10221
|
end
|
|
@@ -9503,13 +10265,18 @@ module Aws::Connect
|
|
|
9503
10265
|
# answer is provided, the overall evaluation gets a score of 0.
|
|
9504
10266
|
# @return [Boolean]
|
|
9505
10267
|
#
|
|
10268
|
+
# @!attribute [rw] automatic_fail_configuration
|
|
10269
|
+
# Whether automatic fail is configured on a single select question.
|
|
10270
|
+
# @return [Types::AutomaticFailConfiguration]
|
|
10271
|
+
#
|
|
9506
10272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormSingleSelectQuestionOption AWS API Documentation
|
|
9507
10273
|
#
|
|
9508
10274
|
class EvaluationFormSingleSelectQuestionOption < Struct.new(
|
|
9509
10275
|
:ref_id,
|
|
9510
10276
|
:text,
|
|
9511
10277
|
:score,
|
|
9512
|
-
:automatic_fail
|
|
10278
|
+
:automatic_fail,
|
|
10279
|
+
:automatic_fail_configuration)
|
|
9513
10280
|
SENSITIVE = []
|
|
9514
10281
|
include Aws::Structure
|
|
9515
10282
|
end
|
|
@@ -9605,6 +10372,35 @@ module Aws::Connect
|
|
|
9605
10372
|
include Aws::Structure
|
|
9606
10373
|
end
|
|
9607
10374
|
|
|
10375
|
+
# Information about the automation configuration in text questions.
|
|
10376
|
+
#
|
|
10377
|
+
# @!attribute [rw] answer_source
|
|
10378
|
+
# Automation answer source.
|
|
10379
|
+
# @return [Types::EvaluationFormQuestionAutomationAnswerSource]
|
|
10380
|
+
#
|
|
10381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormTextQuestionAutomation AWS API Documentation
|
|
10382
|
+
#
|
|
10383
|
+
class EvaluationFormTextQuestionAutomation < Struct.new(
|
|
10384
|
+
:answer_source)
|
|
10385
|
+
SENSITIVE = []
|
|
10386
|
+
include Aws::Structure
|
|
10387
|
+
end
|
|
10388
|
+
|
|
10389
|
+
# Information about properties for a text question in an evaluation
|
|
10390
|
+
# form.
|
|
10391
|
+
#
|
|
10392
|
+
# @!attribute [rw] automation
|
|
10393
|
+
# The automation properties of the text question.
|
|
10394
|
+
# @return [Types::EvaluationFormTextQuestionAutomation]
|
|
10395
|
+
#
|
|
10396
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationFormTextQuestionProperties AWS API Documentation
|
|
10397
|
+
#
|
|
10398
|
+
class EvaluationFormTextQuestionProperties < Struct.new(
|
|
10399
|
+
:automation)
|
|
10400
|
+
SENSITIVE = []
|
|
10401
|
+
include Aws::Structure
|
|
10402
|
+
end
|
|
10403
|
+
|
|
9608
10404
|
# Summary information about an evaluation form.
|
|
9609
10405
|
#
|
|
9610
10406
|
# @!attribute [rw] evaluation_form_arn
|
|
@@ -9662,6 +10458,25 @@ module Aws::Connect
|
|
|
9662
10458
|
include Aws::Structure
|
|
9663
10459
|
end
|
|
9664
10460
|
|
|
10461
|
+
# An analysis for a generative AI answer to the question.
|
|
10462
|
+
#
|
|
10463
|
+
# @!attribute [rw] justification
|
|
10464
|
+
# Generative AI automation answer justification.
|
|
10465
|
+
# @return [String]
|
|
10466
|
+
#
|
|
10467
|
+
# @!attribute [rw] points_of_interest
|
|
10468
|
+
# Generative AI automation answer analysis points of interest.
|
|
10469
|
+
# @return [Array<Types::EvaluationTranscriptPointOfInterest>]
|
|
10470
|
+
#
|
|
10471
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationGenAIAnswerAnalysisDetails AWS API Documentation
|
|
10472
|
+
#
|
|
10473
|
+
class EvaluationGenAIAnswerAnalysisDetails < Struct.new(
|
|
10474
|
+
:justification,
|
|
10475
|
+
:points_of_interest)
|
|
10476
|
+
SENSITIVE = []
|
|
10477
|
+
include Aws::Structure
|
|
10478
|
+
end
|
|
10479
|
+
|
|
9665
10480
|
# Metadata information about a contact evaluation.
|
|
9666
10481
|
#
|
|
9667
10482
|
# @!attribute [rw] contact_id
|
|
@@ -9677,65 +10492,378 @@ module Aws::Connect
|
|
|
9677
10492
|
# The identifier of the agent who performed the contact.
|
|
9678
10493
|
# @return [String]
|
|
9679
10494
|
#
|
|
9680
|
-
# @!attribute [rw]
|
|
9681
|
-
# The
|
|
9682
|
-
# @return [
|
|
10495
|
+
# @!attribute [rw] calibration_session_id
|
|
10496
|
+
# The calibration session ID that this evaluation belongs to.
|
|
10497
|
+
# @return [String]
|
|
10498
|
+
#
|
|
10499
|
+
# @!attribute [rw] score
|
|
10500
|
+
# The overall score of the contact evaluation.
|
|
10501
|
+
# @return [Types::EvaluationScore]
|
|
10502
|
+
#
|
|
10503
|
+
# @!attribute [rw] auto_evaluation
|
|
10504
|
+
# Information related to automated evaluation.
|
|
10505
|
+
# @return [Types::AutoEvaluationDetails]
|
|
10506
|
+
#
|
|
10507
|
+
# @!attribute [rw] acknowledgement
|
|
10508
|
+
# Information related to evaluation acknowledgement.
|
|
10509
|
+
# @return [Types::EvaluationAcknowledgement]
|
|
10510
|
+
#
|
|
10511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationMetadata AWS API Documentation
|
|
10512
|
+
#
|
|
10513
|
+
class EvaluationMetadata < Struct.new(
|
|
10514
|
+
:contact_id,
|
|
10515
|
+
:evaluator_arn,
|
|
10516
|
+
:contact_agent_id,
|
|
10517
|
+
:calibration_session_id,
|
|
10518
|
+
:score,
|
|
10519
|
+
:auto_evaluation,
|
|
10520
|
+
:acknowledgement)
|
|
10521
|
+
SENSITIVE = []
|
|
10522
|
+
include Aws::Structure
|
|
10523
|
+
end
|
|
10524
|
+
|
|
10525
|
+
# Information about notes for a contact evaluation.
|
|
10526
|
+
#
|
|
10527
|
+
# @!attribute [rw] value
|
|
10528
|
+
# The note for an item (section or question) in a contact evaluation.
|
|
10529
|
+
#
|
|
10530
|
+
# <note markdown="1"> Even though a note in an evaluation can have up to 3072 chars, there
|
|
10531
|
+
# is also a limit on the total number of chars for all the notes in
|
|
10532
|
+
# the evaluation combined. Assuming there are N questions in the
|
|
10533
|
+
# evaluation being submitted, then the max char limit for all notes
|
|
10534
|
+
# combined is N x 1024.
|
|
10535
|
+
#
|
|
10536
|
+
# </note>
|
|
10537
|
+
# @return [String]
|
|
10538
|
+
#
|
|
10539
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationNote AWS API Documentation
|
|
10540
|
+
#
|
|
10541
|
+
class EvaluationNote < Struct.new(
|
|
10542
|
+
:value)
|
|
10543
|
+
SENSITIVE = []
|
|
10544
|
+
include Aws::Structure
|
|
10545
|
+
end
|
|
10546
|
+
|
|
10547
|
+
# Detailed analysis results of the automated answer to the evaluation
|
|
10548
|
+
# question.
|
|
10549
|
+
#
|
|
10550
|
+
# @note EvaluationQuestionAnswerAnalysisDetails is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of EvaluationQuestionAnswerAnalysisDetails corresponding to the set member.
|
|
10551
|
+
#
|
|
10552
|
+
# @!attribute [rw] gen_ai
|
|
10553
|
+
# Analysis results from the generative AI automation for the question.
|
|
10554
|
+
# @return [Types::EvaluationGenAIAnswerAnalysisDetails]
|
|
10555
|
+
#
|
|
10556
|
+
# @!attribute [rw] contact_lens
|
|
10557
|
+
# Analysis results from the Contact Lens automation for the question.
|
|
10558
|
+
# @return [Types::EvaluationContactLensAnswerAnalysisDetails]
|
|
10559
|
+
#
|
|
10560
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationQuestionAnswerAnalysisDetails AWS API Documentation
|
|
10561
|
+
#
|
|
10562
|
+
class EvaluationQuestionAnswerAnalysisDetails < Struct.new(
|
|
10563
|
+
:gen_ai,
|
|
10564
|
+
:contact_lens,
|
|
10565
|
+
:unknown)
|
|
10566
|
+
SENSITIVE = []
|
|
10567
|
+
include Aws::Structure
|
|
10568
|
+
include Aws::Structure::Union
|
|
10569
|
+
|
|
10570
|
+
class GenAi < EvaluationQuestionAnswerAnalysisDetails; end
|
|
10571
|
+
class ContactLens < EvaluationQuestionAnswerAnalysisDetails; end
|
|
10572
|
+
class Unknown < EvaluationQuestionAnswerAnalysisDetails; end
|
|
10573
|
+
end
|
|
10574
|
+
|
|
10575
|
+
# Details of the input data used for automated question processing.
|
|
10576
|
+
#
|
|
10577
|
+
# @!attribute [rw] transcript_type
|
|
10578
|
+
# Transcript type.
|
|
10579
|
+
# @return [String]
|
|
10580
|
+
#
|
|
10581
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationQuestionInputDetails AWS API Documentation
|
|
10582
|
+
#
|
|
10583
|
+
class EvaluationQuestionInputDetails < Struct.new(
|
|
10584
|
+
:transcript_type)
|
|
10585
|
+
SENSITIVE = []
|
|
10586
|
+
include Aws::Structure
|
|
10587
|
+
end
|
|
10588
|
+
|
|
10589
|
+
# Information about scores of a contact evaluation item (section or
|
|
10590
|
+
# question).
|
|
10591
|
+
#
|
|
10592
|
+
# @!attribute [rw] percentage
|
|
10593
|
+
# The score percentage for an item in a contact evaluation.
|
|
10594
|
+
# @return [Float]
|
|
10595
|
+
#
|
|
10596
|
+
# @!attribute [rw] not_applicable
|
|
10597
|
+
# The flag to mark the item as not applicable for scoring.
|
|
10598
|
+
# @return [Boolean]
|
|
10599
|
+
#
|
|
10600
|
+
# @!attribute [rw] automatic_fail
|
|
10601
|
+
# The flag that marks the item as automatic fail. If the item or a
|
|
10602
|
+
# child item gets an automatic fail answer, this flag will be true.
|
|
10603
|
+
# @return [Boolean]
|
|
10604
|
+
#
|
|
10605
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationScore AWS API Documentation
|
|
10606
|
+
#
|
|
10607
|
+
class EvaluationScore < Struct.new(
|
|
10608
|
+
:percentage,
|
|
10609
|
+
:not_applicable,
|
|
10610
|
+
:automatic_fail)
|
|
10611
|
+
SENSITIVE = []
|
|
10612
|
+
include Aws::Structure
|
|
10613
|
+
end
|
|
10614
|
+
|
|
10615
|
+
# The search criteria to be used to return evaluations.
|
|
10616
|
+
#
|
|
10617
|
+
# @!attribute [rw] or_conditions
|
|
10618
|
+
# A list of conditions which would be applied together with an OR
|
|
10619
|
+
# condition.
|
|
10620
|
+
# @return [Array<Types::EvaluationSearchCriteria>]
|
|
10621
|
+
#
|
|
10622
|
+
# @!attribute [rw] and_conditions
|
|
10623
|
+
# A list of conditions which would be applied together with an AND
|
|
10624
|
+
# condition.
|
|
10625
|
+
# @return [Array<Types::EvaluationSearchCriteria>]
|
|
10626
|
+
#
|
|
10627
|
+
# @!attribute [rw] string_condition
|
|
10628
|
+
# A leaf node condition which can be used to specify a string
|
|
10629
|
+
# condition.
|
|
10630
|
+
# @return [Types::StringCondition]
|
|
10631
|
+
#
|
|
10632
|
+
# @!attribute [rw] number_condition
|
|
10633
|
+
# A leaf node condition which can be used to specify a numeric
|
|
10634
|
+
# condition.
|
|
10635
|
+
#
|
|
10636
|
+
# <note markdown="1"> The currently supported value for `FieldName` is `limit`.
|
|
10637
|
+
#
|
|
10638
|
+
# </note>
|
|
10639
|
+
# @return [Types::NumberCondition]
|
|
10640
|
+
#
|
|
10641
|
+
# @!attribute [rw] boolean_condition
|
|
10642
|
+
# The boolean condition search criteria for searching evaluations.
|
|
10643
|
+
# @return [Types::BooleanCondition]
|
|
10644
|
+
#
|
|
10645
|
+
# @!attribute [rw] date_time_condition
|
|
10646
|
+
# The datetime condition search criteria for searching evaluations.
|
|
10647
|
+
# @return [Types::DateTimeCondition]
|
|
10648
|
+
#
|
|
10649
|
+
# @!attribute [rw] decimal_condition
|
|
10650
|
+
# The decimal condition search criteria for searching evaluations.
|
|
10651
|
+
# @return [Types::DecimalCondition]
|
|
10652
|
+
#
|
|
10653
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSearchCriteria AWS API Documentation
|
|
10654
|
+
#
|
|
10655
|
+
class EvaluationSearchCriteria < Struct.new(
|
|
10656
|
+
:or_conditions,
|
|
10657
|
+
:and_conditions,
|
|
10658
|
+
:string_condition,
|
|
10659
|
+
:number_condition,
|
|
10660
|
+
:boolean_condition,
|
|
10661
|
+
:date_time_condition,
|
|
10662
|
+
:decimal_condition)
|
|
10663
|
+
SENSITIVE = []
|
|
10664
|
+
include Aws::Structure
|
|
10665
|
+
end
|
|
10666
|
+
|
|
10667
|
+
# Filters to be applied to search results.
|
|
10668
|
+
#
|
|
10669
|
+
# @!attribute [rw] attribute_filter
|
|
10670
|
+
# An object that can be used to specify Tag conditions inside the
|
|
10671
|
+
# `SearchFilter`. This accepts an `OR` or `AND` (List of List) input
|
|
10672
|
+
# where:
|
|
10673
|
+
#
|
|
10674
|
+
# * The top level list specifies conditions that need to be applied
|
|
10675
|
+
# with `OR` operator.
|
|
10676
|
+
#
|
|
10677
|
+
# * The inner list specifies conditions that need to be applied with
|
|
10678
|
+
# `AND` operator.
|
|
10679
|
+
# @return [Types::ControlPlaneAttributeFilter]
|
|
10680
|
+
#
|
|
10681
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSearchFilter AWS API Documentation
|
|
10682
|
+
#
|
|
10683
|
+
class EvaluationSearchFilter < Struct.new(
|
|
10684
|
+
:attribute_filter)
|
|
10685
|
+
SENSITIVE = []
|
|
10686
|
+
include Aws::Structure
|
|
10687
|
+
end
|
|
10688
|
+
|
|
10689
|
+
# Metadata information about an evaluation search.
|
|
10690
|
+
#
|
|
10691
|
+
# @!attribute [rw] contact_id
|
|
10692
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
|
10693
|
+
# @return [String]
|
|
10694
|
+
#
|
|
10695
|
+
# @!attribute [rw] evaluator_arn
|
|
10696
|
+
# The Amazon Resource Name (ARN) of the person who evaluated the
|
|
10697
|
+
# contact.
|
|
10698
|
+
# @return [String]
|
|
10699
|
+
#
|
|
10700
|
+
# @!attribute [rw] contact_agent_id
|
|
10701
|
+
# The unique ID of the agent who handled the contact.
|
|
10702
|
+
# @return [String]
|
|
10703
|
+
#
|
|
10704
|
+
# @!attribute [rw] calibration_session_id
|
|
10705
|
+
# The calibration session ID that this evaluation belongs to.
|
|
10706
|
+
# @return [String]
|
|
10707
|
+
#
|
|
10708
|
+
# @!attribute [rw] score_percentage
|
|
10709
|
+
# The total evaluation score expressed as a percentage.
|
|
10710
|
+
# @return [Float]
|
|
10711
|
+
#
|
|
10712
|
+
# @!attribute [rw] score_automatic_fail
|
|
10713
|
+
# The flag that marks the item as automatic fail. If the item or a
|
|
10714
|
+
# child item gets an automatic fail answer, this flag is true.
|
|
10715
|
+
# @return [Boolean]
|
|
10716
|
+
#
|
|
10717
|
+
# @!attribute [rw] score_not_applicable
|
|
10718
|
+
# The flag to mark the item as not applicable for scoring.
|
|
10719
|
+
# @return [Boolean]
|
|
10720
|
+
#
|
|
10721
|
+
# @!attribute [rw] auto_evaluation_enabled
|
|
10722
|
+
# Whether auto-evaluation is enabled.
|
|
10723
|
+
# @return [Boolean]
|
|
10724
|
+
#
|
|
10725
|
+
# @!attribute [rw] auto_evaluation_status
|
|
10726
|
+
# The status of the contact auto evaluation.
|
|
10727
|
+
# @return [String]
|
|
10728
|
+
#
|
|
10729
|
+
# @!attribute [rw] acknowledged_time
|
|
10730
|
+
# When the evaluation was acknowledged by the agent.
|
|
10731
|
+
# @return [Time]
|
|
10732
|
+
#
|
|
10733
|
+
# @!attribute [rw] acknowledged_by
|
|
10734
|
+
# The agent who acknowledged the evaluation.
|
|
10735
|
+
# @return [String]
|
|
10736
|
+
#
|
|
10737
|
+
# @!attribute [rw] acknowledger_comment
|
|
10738
|
+
# The comment from the agent when they acknowledged the evaluation.
|
|
10739
|
+
# @return [String]
|
|
10740
|
+
#
|
|
10741
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSearchMetadata AWS API Documentation
|
|
10742
|
+
#
|
|
10743
|
+
class EvaluationSearchMetadata < Struct.new(
|
|
10744
|
+
:contact_id,
|
|
10745
|
+
:evaluator_arn,
|
|
10746
|
+
:contact_agent_id,
|
|
10747
|
+
:calibration_session_id,
|
|
10748
|
+
:score_percentage,
|
|
10749
|
+
:score_automatic_fail,
|
|
10750
|
+
:score_not_applicable,
|
|
10751
|
+
:auto_evaluation_enabled,
|
|
10752
|
+
:auto_evaluation_status,
|
|
10753
|
+
:acknowledged_time,
|
|
10754
|
+
:acknowledged_by,
|
|
10755
|
+
:acknowledger_comment)
|
|
10756
|
+
SENSITIVE = []
|
|
10757
|
+
include Aws::Structure
|
|
10758
|
+
end
|
|
10759
|
+
|
|
10760
|
+
# Summary of evaluation obtained from the search operation.
|
|
10761
|
+
#
|
|
10762
|
+
# @!attribute [rw] evaluation_id
|
|
10763
|
+
# A unique identifier for the contact evaluation.
|
|
10764
|
+
# @return [String]
|
|
10765
|
+
#
|
|
10766
|
+
# @!attribute [rw] evaluation_arn
|
|
10767
|
+
# The Amazon Resource Name (ARN) for the contact evaluation resource.
|
|
10768
|
+
# @return [String]
|
|
10769
|
+
#
|
|
10770
|
+
# @!attribute [rw] evaluation_form_id
|
|
10771
|
+
# The unique identifier for the evaluation form.
|
|
10772
|
+
# @return [String]
|
|
10773
|
+
#
|
|
10774
|
+
# @!attribute [rw] evaluation_form_version
|
|
10775
|
+
# A version of the evaluation form.
|
|
10776
|
+
# @return [Integer]
|
|
10777
|
+
#
|
|
10778
|
+
# @!attribute [rw] metadata
|
|
10779
|
+
# Summary information about the evaluation search.
|
|
10780
|
+
# @return [Types::EvaluationSearchMetadata]
|
|
10781
|
+
#
|
|
10782
|
+
# @!attribute [rw] status
|
|
10783
|
+
# The status of the evaluation.
|
|
10784
|
+
# @return [String]
|
|
10785
|
+
#
|
|
10786
|
+
# @!attribute [rw] evaluation_type
|
|
10787
|
+
# Type of the evaluation.
|
|
10788
|
+
# @return [String]
|
|
10789
|
+
#
|
|
10790
|
+
# @!attribute [rw] created_time
|
|
10791
|
+
# The date and time when the evaluation was created, in UTC time.
|
|
10792
|
+
# @return [Time]
|
|
10793
|
+
#
|
|
10794
|
+
# @!attribute [rw] last_modified_time
|
|
10795
|
+
# The date and time when the evaluation was modified last time, in UTC
|
|
10796
|
+
# time.
|
|
10797
|
+
# @return [Time]
|
|
10798
|
+
#
|
|
10799
|
+
# @!attribute [rw] tags
|
|
10800
|
+
# The tags used to organize, track, or control access for this
|
|
10801
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
10802
|
+
# "key2":"value2"} }.
|
|
10803
|
+
# @return [Hash<String,String>]
|
|
9683
10804
|
#
|
|
9684
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
|
10805
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSearchSummary AWS API Documentation
|
|
9685
10806
|
#
|
|
9686
|
-
class
|
|
9687
|
-
:
|
|
9688
|
-
:
|
|
9689
|
-
:
|
|
9690
|
-
:
|
|
10807
|
+
class EvaluationSearchSummary < Struct.new(
|
|
10808
|
+
:evaluation_id,
|
|
10809
|
+
:evaluation_arn,
|
|
10810
|
+
:evaluation_form_id,
|
|
10811
|
+
:evaluation_form_version,
|
|
10812
|
+
:metadata,
|
|
10813
|
+
:status,
|
|
10814
|
+
:evaluation_type,
|
|
10815
|
+
:created_time,
|
|
10816
|
+
:last_modified_time,
|
|
10817
|
+
:tags)
|
|
9691
10818
|
SENSITIVE = []
|
|
9692
10819
|
include Aws::Structure
|
|
9693
10820
|
end
|
|
9694
10821
|
|
|
9695
|
-
#
|
|
10822
|
+
# The information about the suggested answer for the question.
|
|
9696
10823
|
#
|
|
9697
10824
|
# @!attribute [rw] value
|
|
9698
|
-
#
|
|
10825
|
+
# Information about answer data for a contact evaluation. Answer data
|
|
10826
|
+
# must be either string, numeric, or not applicable.
|
|
10827
|
+
# @return [Types::EvaluationAnswerData]
|
|
9699
10828
|
#
|
|
9700
|
-
#
|
|
9701
|
-
#
|
|
9702
|
-
#
|
|
9703
|
-
# evaluation being submitted, then the max char limit for all notes
|
|
9704
|
-
# combined is N x 1024.
|
|
10829
|
+
# @!attribute [rw] status
|
|
10830
|
+
# The status of the suggested answer. D
|
|
10831
|
+
# @return [String]
|
|
9705
10832
|
#
|
|
9706
|
-
#
|
|
10833
|
+
# @!attribute [rw] input
|
|
10834
|
+
# Details about the input used to question automation.
|
|
10835
|
+
# @return [Types::EvaluationQuestionInputDetails]
|
|
10836
|
+
#
|
|
10837
|
+
# @!attribute [rw] analysis_type
|
|
10838
|
+
# Type of analysis used to provide suggested answer.
|
|
9707
10839
|
# @return [String]
|
|
9708
10840
|
#
|
|
9709
|
-
#
|
|
10841
|
+
# @!attribute [rw] analysis_details
|
|
10842
|
+
# Detailed analysis results.
|
|
10843
|
+
# @return [Types::EvaluationQuestionAnswerAnalysisDetails]
|
|
9710
10844
|
#
|
|
9711
|
-
|
|
9712
|
-
|
|
10845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSuggestedAnswer AWS API Documentation
|
|
10846
|
+
#
|
|
10847
|
+
class EvaluationSuggestedAnswer < Struct.new(
|
|
10848
|
+
:value,
|
|
10849
|
+
:status,
|
|
10850
|
+
:input,
|
|
10851
|
+
:analysis_type,
|
|
10852
|
+
:analysis_details)
|
|
9713
10853
|
SENSITIVE = []
|
|
9714
10854
|
include Aws::Structure
|
|
9715
10855
|
end
|
|
9716
10856
|
|
|
9717
|
-
#
|
|
9718
|
-
# question).
|
|
9719
|
-
#
|
|
9720
|
-
# @!attribute [rw] percentage
|
|
9721
|
-
# The score percentage for an item in a contact evaluation.
|
|
9722
|
-
# @return [Float]
|
|
10857
|
+
# The milliseconds offset for transcript reference in suggested answer.
|
|
9723
10858
|
#
|
|
9724
|
-
# @!attribute [rw]
|
|
9725
|
-
#
|
|
9726
|
-
# @return [
|
|
9727
|
-
#
|
|
9728
|
-
# @!attribute [rw] automatic_fail
|
|
9729
|
-
# The flag that marks the item as automatic fail. If the item or a
|
|
9730
|
-
# child item gets an automatic fail answer, this flag will be true.
|
|
9731
|
-
# @return [Boolean]
|
|
10859
|
+
# @!attribute [rw] begin_offset_millis
|
|
10860
|
+
# Offset in milliseconds from the beginning of the transcript.
|
|
10861
|
+
# @return [Integer]
|
|
9732
10862
|
#
|
|
9733
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/
|
|
10863
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationSuggestedAnswerTranscriptMillisecondOffsets AWS API Documentation
|
|
9734
10864
|
#
|
|
9735
|
-
class
|
|
9736
|
-
:
|
|
9737
|
-
:not_applicable,
|
|
9738
|
-
:automatic_fail)
|
|
10865
|
+
class EvaluationSuggestedAnswerTranscriptMillisecondOffsets < Struct.new(
|
|
10866
|
+
:begin_offset_millis)
|
|
9739
10867
|
SENSITIVE = []
|
|
9740
10868
|
include Aws::Structure
|
|
9741
10869
|
end
|
|
@@ -9758,10 +10886,22 @@ module Aws::Connect
|
|
|
9758
10886
|
# The unique identifier for the evaluation form.
|
|
9759
10887
|
# @return [String]
|
|
9760
10888
|
#
|
|
10889
|
+
# @!attribute [rw] calibration_session_id
|
|
10890
|
+
# The calibration session ID that this evaluation belongs to.
|
|
10891
|
+
# @return [String]
|
|
10892
|
+
#
|
|
9761
10893
|
# @!attribute [rw] status
|
|
9762
10894
|
# The status of the contact evaluation.
|
|
9763
10895
|
# @return [String]
|
|
9764
10896
|
#
|
|
10897
|
+
# @!attribute [rw] auto_evaluation_enabled
|
|
10898
|
+
# Whether automated evaluation is enabled.
|
|
10899
|
+
# @return [Boolean]
|
|
10900
|
+
#
|
|
10901
|
+
# @!attribute [rw] auto_evaluation_status
|
|
10902
|
+
# The status of the contact auto evaluation.
|
|
10903
|
+
# @return [String]
|
|
10904
|
+
#
|
|
9765
10905
|
# @!attribute [rw] evaluator_arn
|
|
9766
10906
|
# The Amazon Resource Name (ARN) of the user who last updated the
|
|
9767
10907
|
# evaluation.
|
|
@@ -9771,6 +10911,14 @@ module Aws::Connect
|
|
|
9771
10911
|
# The overall score of the contact evaluation.
|
|
9772
10912
|
# @return [Types::EvaluationScore]
|
|
9773
10913
|
#
|
|
10914
|
+
# @!attribute [rw] acknowledgement
|
|
10915
|
+
# Information related to evaluation acknowledgement.
|
|
10916
|
+
# @return [Types::EvaluationAcknowledgementSummary]
|
|
10917
|
+
#
|
|
10918
|
+
# @!attribute [rw] evaluation_type
|
|
10919
|
+
# Type of the evaluation.
|
|
10920
|
+
# @return [String]
|
|
10921
|
+
#
|
|
9774
10922
|
# @!attribute [rw] created_time
|
|
9775
10923
|
# The timestamp for when the evaluation was created.
|
|
9776
10924
|
# @return [Time]
|
|
@@ -9786,15 +10934,61 @@ module Aws::Connect
|
|
|
9786
10934
|
:evaluation_arn,
|
|
9787
10935
|
:evaluation_form_title,
|
|
9788
10936
|
:evaluation_form_id,
|
|
10937
|
+
:calibration_session_id,
|
|
9789
10938
|
:status,
|
|
10939
|
+
:auto_evaluation_enabled,
|
|
10940
|
+
:auto_evaluation_status,
|
|
9790
10941
|
:evaluator_arn,
|
|
9791
10942
|
:score,
|
|
10943
|
+
:acknowledgement,
|
|
10944
|
+
:evaluation_type,
|
|
9792
10945
|
:created_time,
|
|
9793
10946
|
:last_modified_time)
|
|
9794
10947
|
SENSITIVE = []
|
|
9795
10948
|
include Aws::Structure
|
|
9796
10949
|
end
|
|
9797
10950
|
|
|
10951
|
+
# Information about the point of interest in transcript provided to
|
|
10952
|
+
# evaluation.
|
|
10953
|
+
#
|
|
10954
|
+
# @!attribute [rw] millisecond_offsets
|
|
10955
|
+
# Offset in milliseconds from the beginning of transcript.
|
|
10956
|
+
# @return [Types::EvaluationSuggestedAnswerTranscriptMillisecondOffsets]
|
|
10957
|
+
#
|
|
10958
|
+
# @!attribute [rw] transcript_segment
|
|
10959
|
+
# Segment of transcript.
|
|
10960
|
+
# @return [String]
|
|
10961
|
+
#
|
|
10962
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluationTranscriptPointOfInterest AWS API Documentation
|
|
10963
|
+
#
|
|
10964
|
+
class EvaluationTranscriptPointOfInterest < Struct.new(
|
|
10965
|
+
:millisecond_offsets,
|
|
10966
|
+
:transcript_segment)
|
|
10967
|
+
SENSITIVE = []
|
|
10968
|
+
include Aws::Structure
|
|
10969
|
+
end
|
|
10970
|
+
|
|
10971
|
+
# Represents the entity that performed the action on the evaluation.
|
|
10972
|
+
#
|
|
10973
|
+
# @note EvaluatorUserUnion is a union - when making an API calls you must set exactly one of the members.
|
|
10974
|
+
#
|
|
10975
|
+
# @!attribute [rw] connect_user_arn
|
|
10976
|
+
# Represents the Amazon Connect ARN of the user.
|
|
10977
|
+
# @return [String]
|
|
10978
|
+
#
|
|
10979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/EvaluatorUserUnion AWS API Documentation
|
|
10980
|
+
#
|
|
10981
|
+
class EvaluatorUserUnion < Struct.new(
|
|
10982
|
+
:connect_user_arn,
|
|
10983
|
+
:unknown)
|
|
10984
|
+
SENSITIVE = []
|
|
10985
|
+
include Aws::Structure
|
|
10986
|
+
include Aws::Structure::Union
|
|
10987
|
+
|
|
10988
|
+
class ConnectUserArn < EvaluatorUserUnion; end
|
|
10989
|
+
class Unknown < EvaluatorUserUnion; end
|
|
10990
|
+
end
|
|
10991
|
+
|
|
9798
10992
|
# The EventBridge action definition.
|
|
9799
10993
|
#
|
|
9800
10994
|
# @!attribute [rw] name
|
|
@@ -18199,6 +19393,39 @@ module Aws::Connect
|
|
|
18199
19393
|
include Aws::Structure
|
|
18200
19394
|
end
|
|
18201
19395
|
|
|
19396
|
+
# Information about the outbound strategy.
|
|
19397
|
+
#
|
|
19398
|
+
# @!attribute [rw] type
|
|
19399
|
+
# Type of the outbound strategy.
|
|
19400
|
+
# @return [String]
|
|
19401
|
+
#
|
|
19402
|
+
# @!attribute [rw] config
|
|
19403
|
+
# Config of the outbound strategy.
|
|
19404
|
+
# @return [Types::OutboundStrategyConfig]
|
|
19405
|
+
#
|
|
19406
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundStrategy AWS API Documentation
|
|
19407
|
+
#
|
|
19408
|
+
class OutboundStrategy < Struct.new(
|
|
19409
|
+
:type,
|
|
19410
|
+
:config)
|
|
19411
|
+
SENSITIVE = []
|
|
19412
|
+
include Aws::Structure
|
|
19413
|
+
end
|
|
19414
|
+
|
|
19415
|
+
# The config of the outbound strategy.
|
|
19416
|
+
#
|
|
19417
|
+
# @!attribute [rw] agent_first
|
|
19418
|
+
# The config of agent first outbound strategy.
|
|
19419
|
+
# @return [Types::AgentFirst]
|
|
19420
|
+
#
|
|
19421
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/OutboundStrategyConfig AWS API Documentation
|
|
19422
|
+
#
|
|
19423
|
+
class OutboundStrategyConfig < Struct.new(
|
|
19424
|
+
:agent_first)
|
|
19425
|
+
SENSITIVE = []
|
|
19426
|
+
include Aws::Structure
|
|
19427
|
+
end
|
|
19428
|
+
|
|
18202
19429
|
# Thrown for analyzed content when requested OutputType was not enabled
|
|
18203
19430
|
# for a given contact. For example, if an OutputType.Raw was requested
|
|
18204
19431
|
# for a contact that had `RedactedOnly` Redaction policy set in the
|
|
@@ -18625,6 +19852,21 @@ module Aws::Connect
|
|
|
18625
19852
|
include Aws::Structure
|
|
18626
19853
|
end
|
|
18627
19854
|
|
|
19855
|
+
# Countdown timer configuration after the agent accepted the contact.
|
|
19856
|
+
#
|
|
19857
|
+
# @!attribute [rw] duration_in_seconds
|
|
19858
|
+
# Duration in seconds for the countdown timer after the agent accepted
|
|
19859
|
+
# the contact.
|
|
19860
|
+
# @return [Integer]
|
|
19861
|
+
#
|
|
19862
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/PostAcceptTimeoutConfig AWS API Documentation
|
|
19863
|
+
#
|
|
19864
|
+
class PostAcceptTimeoutConfig < Struct.new(
|
|
19865
|
+
:duration_in_seconds)
|
|
19866
|
+
SENSITIVE = []
|
|
19867
|
+
include Aws::Structure
|
|
19868
|
+
end
|
|
19869
|
+
|
|
18628
19870
|
# Information about a predefined attribute.
|
|
18629
19871
|
#
|
|
18630
19872
|
# @!attribute [rw] name
|
|
@@ -18768,6 +20010,28 @@ module Aws::Connect
|
|
|
18768
20010
|
class Unknown < PredefinedAttributeValues; end
|
|
18769
20011
|
end
|
|
18770
20012
|
|
|
20013
|
+
# Information about agent-first preview mode outbound strategy
|
|
20014
|
+
# configuration.
|
|
20015
|
+
#
|
|
20016
|
+
# @!attribute [rw] post_accept_timeout_config
|
|
20017
|
+
# Countdown timer configuration after the agent accepted the preview
|
|
20018
|
+
# outbound contact.
|
|
20019
|
+
# @return [Types::PostAcceptTimeoutConfig]
|
|
20020
|
+
#
|
|
20021
|
+
# @!attribute [rw] allowed_user_actions
|
|
20022
|
+
# The actions the agent can perform after accepting the preview
|
|
20023
|
+
# outbound contact.
|
|
20024
|
+
# @return [Array<String>]
|
|
20025
|
+
#
|
|
20026
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/Preview AWS API Documentation
|
|
20027
|
+
#
|
|
20028
|
+
class Preview < Struct.new(
|
|
20029
|
+
:post_accept_timeout_config,
|
|
20030
|
+
:allowed_user_actions)
|
|
20031
|
+
SENSITIVE = []
|
|
20032
|
+
include Aws::Structure
|
|
20033
|
+
end
|
|
20034
|
+
|
|
18771
20035
|
# Information about a problem detail.
|
|
18772
20036
|
#
|
|
18773
20037
|
# @!attribute [rw] message
|
|
@@ -21310,6 +22574,69 @@ module Aws::Connect
|
|
|
21310
22574
|
include Aws::Structure
|
|
21311
22575
|
end
|
|
21312
22576
|
|
|
22577
|
+
# @!attribute [rw] instance_id
|
|
22578
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
22579
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
22580
|
+
#
|
|
22581
|
+
#
|
|
22582
|
+
#
|
|
22583
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
22584
|
+
# @return [String]
|
|
22585
|
+
#
|
|
22586
|
+
# @!attribute [rw] next_token
|
|
22587
|
+
# The token for the next set of results. Use the value returned in the
|
|
22588
|
+
# previous response in the next request to retrieve the next set of
|
|
22589
|
+
# results.
|
|
22590
|
+
# @return [String]
|
|
22591
|
+
#
|
|
22592
|
+
# @!attribute [rw] max_results
|
|
22593
|
+
# The maximum number of results to return per page.
|
|
22594
|
+
# @return [Integer]
|
|
22595
|
+
#
|
|
22596
|
+
# @!attribute [rw] search_criteria
|
|
22597
|
+
# The search criteria to be used to return contact evaluations.
|
|
22598
|
+
# @return [Types::EvaluationSearchCriteria]
|
|
22599
|
+
#
|
|
22600
|
+
# @!attribute [rw] search_filter
|
|
22601
|
+
# Filters to be applied to search results.
|
|
22602
|
+
# @return [Types::EvaluationSearchFilter]
|
|
22603
|
+
#
|
|
22604
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactEvaluationsRequest AWS API Documentation
|
|
22605
|
+
#
|
|
22606
|
+
class SearchContactEvaluationsRequest < Struct.new(
|
|
22607
|
+
:instance_id,
|
|
22608
|
+
:next_token,
|
|
22609
|
+
:max_results,
|
|
22610
|
+
:search_criteria,
|
|
22611
|
+
:search_filter)
|
|
22612
|
+
SENSITIVE = []
|
|
22613
|
+
include Aws::Structure
|
|
22614
|
+
end
|
|
22615
|
+
|
|
22616
|
+
# @!attribute [rw] evaluation_search_summary_list
|
|
22617
|
+
# Contains information about contact evaluations.
|
|
22618
|
+
# @return [Array<Types::EvaluationSearchSummary>]
|
|
22619
|
+
#
|
|
22620
|
+
# @!attribute [rw] next_token
|
|
22621
|
+
# If there are additional results, this is the token for the next set
|
|
22622
|
+
# of results.
|
|
22623
|
+
# @return [String]
|
|
22624
|
+
#
|
|
22625
|
+
# @!attribute [rw] approximate_total_count
|
|
22626
|
+
# The total number of contact evaluations that matched your search
|
|
22627
|
+
# query.
|
|
22628
|
+
# @return [Integer]
|
|
22629
|
+
#
|
|
22630
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchContactEvaluationsResponse AWS API Documentation
|
|
22631
|
+
#
|
|
22632
|
+
class SearchContactEvaluationsResponse < Struct.new(
|
|
22633
|
+
:evaluation_search_summary_list,
|
|
22634
|
+
:next_token,
|
|
22635
|
+
:approximate_total_count)
|
|
22636
|
+
SENSITIVE = []
|
|
22637
|
+
include Aws::Structure
|
|
22638
|
+
end
|
|
22639
|
+
|
|
21313
22640
|
# @!attribute [rw] instance_id
|
|
21314
22641
|
# The identifier of the Amazon Connect instance. You can find the
|
|
21315
22642
|
# instance ID in the Amazon Resource Name (ARN) of the instance.
|
|
@@ -21737,6 +23064,68 @@ module Aws::Connect
|
|
|
21737
23064
|
include Aws::Structure
|
|
21738
23065
|
end
|
|
21739
23066
|
|
|
23067
|
+
# @!attribute [rw] instance_id
|
|
23068
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
|
23069
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
|
23070
|
+
#
|
|
23071
|
+
#
|
|
23072
|
+
#
|
|
23073
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
|
23074
|
+
# @return [String]
|
|
23075
|
+
#
|
|
23076
|
+
# @!attribute [rw] next_token
|
|
23077
|
+
# The token for the next set of results. Use the value returned in the
|
|
23078
|
+
# previous response in the next request to retrieve the next set of
|
|
23079
|
+
# results.
|
|
23080
|
+
# @return [String]
|
|
23081
|
+
#
|
|
23082
|
+
# @!attribute [rw] max_results
|
|
23083
|
+
# The maximum number of results to return per page.
|
|
23084
|
+
# @return [Integer]
|
|
23085
|
+
#
|
|
23086
|
+
# @!attribute [rw] search_criteria
|
|
23087
|
+
# The search criteria to be used to return evaluation forms.
|
|
23088
|
+
# @return [Types::EvaluationFormSearchCriteria]
|
|
23089
|
+
#
|
|
23090
|
+
# @!attribute [rw] search_filter
|
|
23091
|
+
# Filters to be applied to search results.
|
|
23092
|
+
# @return [Types::EvaluationFormSearchFilter]
|
|
23093
|
+
#
|
|
23094
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEvaluationFormsRequest AWS API Documentation
|
|
23095
|
+
#
|
|
23096
|
+
class SearchEvaluationFormsRequest < Struct.new(
|
|
23097
|
+
:instance_id,
|
|
23098
|
+
:next_token,
|
|
23099
|
+
:max_results,
|
|
23100
|
+
:search_criteria,
|
|
23101
|
+
:search_filter)
|
|
23102
|
+
SENSITIVE = []
|
|
23103
|
+
include Aws::Structure
|
|
23104
|
+
end
|
|
23105
|
+
|
|
23106
|
+
# @!attribute [rw] evaluation_form_search_summary_list
|
|
23107
|
+
# Information about the returned evaluation forms.
|
|
23108
|
+
# @return [Array<Types::EvaluationFormSearchSummary>]
|
|
23109
|
+
#
|
|
23110
|
+
# @!attribute [rw] next_token
|
|
23111
|
+
# If there are additional results, this is the token for the next set
|
|
23112
|
+
# of results.
|
|
23113
|
+
# @return [String]
|
|
23114
|
+
#
|
|
23115
|
+
# @!attribute [rw] approximate_total_count
|
|
23116
|
+
# The total number of evaluation forms that matched your search query.
|
|
23117
|
+
# @return [Integer]
|
|
23118
|
+
#
|
|
23119
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchEvaluationFormsResponse AWS API Documentation
|
|
23120
|
+
#
|
|
23121
|
+
class SearchEvaluationFormsResponse < Struct.new(
|
|
23122
|
+
:evaluation_form_search_summary_list,
|
|
23123
|
+
:next_token,
|
|
23124
|
+
:approximate_total_count)
|
|
23125
|
+
SENSITIVE = []
|
|
23126
|
+
include Aws::Structure
|
|
23127
|
+
end
|
|
23128
|
+
|
|
21740
23129
|
# @!attribute [rw] instance_id
|
|
21741
23130
|
# The identifier of the Amazon Connect instance.
|
|
21742
23131
|
# @return [String]
|
|
@@ -23564,6 +24953,10 @@ module Aws::Connect
|
|
|
23564
24953
|
# The unique identifier for the evaluation form.
|
|
23565
24954
|
# @return [String]
|
|
23566
24955
|
#
|
|
24956
|
+
# @!attribute [rw] auto_evaluation_configuration
|
|
24957
|
+
# Whether automated evaluations are enabled.
|
|
24958
|
+
# @return [Types::AutoEvaluationConfiguration]
|
|
24959
|
+
#
|
|
23567
24960
|
# @!attribute [rw] client_token
|
|
23568
24961
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
23569
24962
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -23578,13 +24971,21 @@ module Aws::Connect
|
|
|
23578
24971
|
# [1]: https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/
|
|
23579
24972
|
# @return [String]
|
|
23580
24973
|
#
|
|
24974
|
+
# @!attribute [rw] tags
|
|
24975
|
+
# The tags used to organize, track, or control access for this
|
|
24976
|
+
# resource. For example, \{ "Tags": \{"key1":"value1",
|
|
24977
|
+
# "key2":"value2"} }.
|
|
24978
|
+
# @return [Hash<String,String>]
|
|
24979
|
+
#
|
|
23581
24980
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartContactEvaluationRequest AWS API Documentation
|
|
23582
24981
|
#
|
|
23583
24982
|
class StartContactEvaluationRequest < Struct.new(
|
|
23584
24983
|
:instance_id,
|
|
23585
24984
|
:contact_id,
|
|
23586
24985
|
:evaluation_form_id,
|
|
23587
|
-
:
|
|
24986
|
+
:auto_evaluation_configuration,
|
|
24987
|
+
:client_token,
|
|
24988
|
+
:tags)
|
|
23588
24989
|
SENSITIVE = []
|
|
23589
24990
|
include Aws::Structure
|
|
23590
24991
|
end
|
|
@@ -24156,6 +25557,10 @@ module Aws::Connect
|
|
|
24156
25557
|
# to `true`. For all other cases, use `GENERAL`.
|
|
24157
25558
|
# @return [String]
|
|
24158
25559
|
#
|
|
25560
|
+
# @!attribute [rw] outbound_strategy
|
|
25561
|
+
# Information about the outbound strategy.
|
|
25562
|
+
# @return [Types::OutboundStrategy]
|
|
25563
|
+
#
|
|
24159
25564
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StartOutboundVoiceContactRequest AWS API Documentation
|
|
24160
25565
|
#
|
|
24161
25566
|
class StartOutboundVoiceContactRequest < Struct.new(
|
|
@@ -24172,7 +25577,8 @@ module Aws::Connect
|
|
|
24172
25577
|
:attributes,
|
|
24173
25578
|
:answer_machine_detection_config,
|
|
24174
25579
|
:campaign_id,
|
|
24175
|
-
:traffic_type
|
|
25580
|
+
:traffic_type,
|
|
25581
|
+
:outbound_strategy)
|
|
24176
25582
|
SENSITIVE = [:name, :description]
|
|
24177
25583
|
include Aws::Structure
|
|
24178
25584
|
end
|
|
@@ -24621,7 +26027,15 @@ module Aws::Connect
|
|
|
24621
26027
|
#
|
|
24622
26028
|
# @!attribute [rw] disconnect_reason
|
|
24623
26029
|
# The reason a contact can be disconnected. Only Amazon Connect
|
|
24624
|
-
# outbound campaigns can provide this field.
|
|
26030
|
+
# outbound campaigns can provide this field. For a list and
|
|
26031
|
+
# description of all the possible disconnect reasons by channel
|
|
26032
|
+
# (including outbound campaign voice contacts) see DisconnectReason
|
|
26033
|
+
# under [ContactTraceRecord][1] in the *Amazon Connect Administrator
|
|
26034
|
+
# Guide*.
|
|
26035
|
+
#
|
|
26036
|
+
#
|
|
26037
|
+
#
|
|
26038
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord
|
|
24625
26039
|
# @return [Types::DisconnectReason]
|
|
24626
26040
|
#
|
|
24627
26041
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/StopContactRequest AWS API Documentation
|
|
@@ -24751,13 +26165,18 @@ module Aws::Connect
|
|
|
24751
26165
|
# A map of question identifiers to note value.
|
|
24752
26166
|
# @return [Hash<String,Types::EvaluationNote>]
|
|
24753
26167
|
#
|
|
26168
|
+
# @!attribute [rw] submitted_by
|
|
26169
|
+
# The ID of the user who submitted the contact evaluation.
|
|
26170
|
+
# @return [Types::EvaluatorUserUnion]
|
|
26171
|
+
#
|
|
24754
26172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SubmitContactEvaluationRequest AWS API Documentation
|
|
24755
26173
|
#
|
|
24756
26174
|
class SubmitContactEvaluationRequest < Struct.new(
|
|
24757
26175
|
:instance_id,
|
|
24758
26176
|
:evaluation_id,
|
|
24759
26177
|
:answers,
|
|
24760
|
-
:notes
|
|
26178
|
+
:notes,
|
|
26179
|
+
:submitted_by)
|
|
24761
26180
|
SENSITIVE = []
|
|
24762
26181
|
include Aws::Structure
|
|
24763
26182
|
end
|
|
@@ -25862,13 +27281,18 @@ module Aws::Connect
|
|
|
25862
27281
|
# A map of question identifiers to note value.
|
|
25863
27282
|
# @return [Hash<String,Types::EvaluationNote>]
|
|
25864
27283
|
#
|
|
27284
|
+
# @!attribute [rw] updated_by
|
|
27285
|
+
# The ID of the user who updated the contact evaluation.
|
|
27286
|
+
# @return [Types::EvaluatorUserUnion]
|
|
27287
|
+
#
|
|
25865
27288
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdateContactEvaluationRequest AWS API Documentation
|
|
25866
27289
|
#
|
|
25867
27290
|
class UpdateContactEvaluationRequest < Struct.new(
|
|
25868
27291
|
:instance_id,
|
|
25869
27292
|
:evaluation_id,
|
|
25870
27293
|
:answers,
|
|
25871
|
-
:notes
|
|
27294
|
+
:notes,
|
|
27295
|
+
:updated_by)
|
|
25872
27296
|
SENSITIVE = []
|
|
25873
27297
|
include Aws::Structure
|
|
25874
27298
|
end
|
|
@@ -26365,6 +27789,10 @@ module Aws::Connect
|
|
|
26365
27789
|
# A scoring strategy of the evaluation form.
|
|
26366
27790
|
# @return [Types::EvaluationFormScoringStrategy]
|
|
26367
27791
|
#
|
|
27792
|
+
# @!attribute [rw] auto_evaluation_configuration
|
|
27793
|
+
# Whether automated evaluations are enabled.
|
|
27794
|
+
# @return [Types::EvaluationFormAutoEvaluationConfiguration]
|
|
27795
|
+
#
|
|
26368
27796
|
# @!attribute [rw] client_token
|
|
26369
27797
|
# A unique, case-sensitive identifier that you provide to ensure the
|
|
26370
27798
|
# idempotency of the request. If not provided, the Amazon Web Services
|
|
@@ -26390,6 +27818,7 @@ module Aws::Connect
|
|
|
26390
27818
|
:description,
|
|
26391
27819
|
:items,
|
|
26392
27820
|
:scoring_strategy,
|
|
27821
|
+
:auto_evaluation_configuration,
|
|
26393
27822
|
:client_token)
|
|
26394
27823
|
SENSITIVE = []
|
|
26395
27824
|
include Aws::Structure
|
|
@@ -28422,7 +29851,7 @@ module Aws::Connect
|
|
|
28422
29851
|
#
|
|
28423
29852
|
# The currently supported values for `FieldName` are `Username`,
|
|
28424
29853
|
# `FirstName`, `LastName`, `RoutingProfileId`, `SecurityProfileId`,
|
|
28425
|
-
# `
|
|
29854
|
+
# `resourceId`.
|
|
28426
29855
|
# @return [Types::StringCondition]
|
|
28427
29856
|
#
|
|
28428
29857
|
# @!attribute [rw] list_condition
|