aws-sdk-connect 1.215.0 → 1.218.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 +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +690 -199
- data/lib/aws-sdk-connect/client_api.rb +155 -3
- data/lib/aws-sdk-connect/types.rb +637 -170
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +130 -17
- data/sig/types.rbs +117 -7
- metadata +1 -1
@@ -683,6 +683,85 @@ module Aws::Connect
|
|
683
683
|
req.send_request(options)
|
684
684
|
end
|
685
685
|
|
686
|
+
# Associates a queued contact with an agent.
|
687
|
+
#
|
688
|
+
# **Use cases**
|
689
|
+
#
|
690
|
+
# Following are common uses cases for this API:
|
691
|
+
#
|
692
|
+
# * Custom contact routing. You can build custom contact routing
|
693
|
+
# mechanisms beyond the default system routing in Amazon Connect. You
|
694
|
+
# can create tailored contact distribution logic that offers queued
|
695
|
+
# contacts directly to specific agents.
|
696
|
+
#
|
697
|
+
# * Manual contact assignment. You can programmatically assign queued
|
698
|
+
# contacts to available users. This provides flexibility to contact
|
699
|
+
# centers that require manual oversight or specialized routing
|
700
|
+
# workflows outside of standard queue management.
|
701
|
+
#
|
702
|
+
# For information about how manual contact assignment works in the
|
703
|
+
# agent workspace, see the [Access the Worklist app in the Amazon
|
704
|
+
# Connect agent workspace][1] in the *Amazon Connect Administrator
|
705
|
+
# Guide*.
|
706
|
+
#
|
707
|
+
# **Important things to know**
|
708
|
+
#
|
709
|
+
# * Use this API chat/SMS, email, and task contacts. It does not support
|
710
|
+
# voice contacts.
|
711
|
+
#
|
712
|
+
# * Use it to associate contacts with users regardless of their current
|
713
|
+
# state, including custom states. Ensure your application logic
|
714
|
+
# accounts for user availability before making associations.
|
715
|
+
#
|
716
|
+
# * It honors the IAM context key `connect:PreferredUserArn` to prevent
|
717
|
+
# unauthorized contact associations.
|
718
|
+
#
|
719
|
+
# * It respects the IAM context key `connect:PreferredUserArn` to
|
720
|
+
# enforce authorization controls and prevent unauthorized contact
|
721
|
+
# associations. Verify that your IAM policies are properly configured
|
722
|
+
# to support your intended use cases.
|
723
|
+
#
|
724
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][2].
|
725
|
+
#
|
726
|
+
#
|
727
|
+
#
|
728
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html
|
729
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
730
|
+
#
|
731
|
+
# @option params [required, String] :instance_id
|
732
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
733
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
734
|
+
#
|
735
|
+
#
|
736
|
+
#
|
737
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
738
|
+
#
|
739
|
+
# @option params [required, String] :contact_id
|
740
|
+
# The identifier of the contact in this instance of Amazon Connect.
|
741
|
+
#
|
742
|
+
# @option params [required, String] :user_id
|
743
|
+
# The identifier for the user. This can be the ID or the ARN of the
|
744
|
+
# user.
|
745
|
+
#
|
746
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
747
|
+
#
|
748
|
+
# @example Request syntax with placeholder values
|
749
|
+
#
|
750
|
+
# resp = client.associate_contact_with_user({
|
751
|
+
# instance_id: "InstanceId", # required
|
752
|
+
# contact_id: "ContactId", # required
|
753
|
+
# user_id: "AgentResourceId", # required
|
754
|
+
# })
|
755
|
+
#
|
756
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateContactWithUser AWS API Documentation
|
757
|
+
#
|
758
|
+
# @overload associate_contact_with_user(params = {})
|
759
|
+
# @param [Hash] params ({})
|
760
|
+
def associate_contact_with_user(params = {}, options = {})
|
761
|
+
req = build_request(:associate_contact_with_user, params)
|
762
|
+
req.send_request(options)
|
763
|
+
end
|
764
|
+
|
686
765
|
# Associates an existing vocabulary as the default. Contact Lens for
|
687
766
|
# Amazon Connect uses the vocabulary in post-call and real-time analysis
|
688
767
|
# sessions for the given language.
|
@@ -1081,9 +1160,12 @@ module Aws::Connect
|
|
1081
1160
|
# @option params [required, String] :routing_profile_id
|
1082
1161
|
# The identifier of the routing profile.
|
1083
1162
|
#
|
1084
|
-
# @option params [
|
1163
|
+
# @option params [Array<Types::RoutingProfileQueueConfig>] :queue_configs
|
1085
1164
|
# The queues to associate with this routing profile.
|
1086
1165
|
#
|
1166
|
+
# @option params [Array<Types::RoutingProfileManualAssignmentQueueConfig>] :manual_assignment_queue_configs
|
1167
|
+
# The manual assignment queues to associate with this routing profile.
|
1168
|
+
#
|
1087
1169
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1088
1170
|
#
|
1089
1171
|
# @example Request syntax with placeholder values
|
@@ -1091,7 +1173,7 @@ module Aws::Connect
|
|
1091
1173
|
# resp = client.associate_routing_profile_queues({
|
1092
1174
|
# instance_id: "InstanceId", # required
|
1093
1175
|
# routing_profile_id: "RoutingProfileId", # required
|
1094
|
-
# queue_configs: [
|
1176
|
+
# queue_configs: [
|
1095
1177
|
# {
|
1096
1178
|
# queue_reference: { # required
|
1097
1179
|
# queue_id: "QueueId", # required
|
@@ -1101,6 +1183,14 @@ module Aws::Connect
|
|
1101
1183
|
# delay: 1, # required
|
1102
1184
|
# },
|
1103
1185
|
# ],
|
1186
|
+
# manual_assignment_queue_configs: [
|
1187
|
+
# {
|
1188
|
+
# queue_reference: { # required
|
1189
|
+
# queue_id: "QueueId", # required
|
1190
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
1191
|
+
# },
|
1192
|
+
# },
|
1193
|
+
# ],
|
1104
1194
|
# })
|
1105
1195
|
#
|
1106
1196
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/AssociateRoutingProfileQueues AWS API Documentation
|
@@ -1938,6 +2028,12 @@ module Aws::Connect
|
|
1938
2028
|
# },
|
1939
2029
|
# },
|
1940
2030
|
# value_integer: 1,
|
2031
|
+
# value_list: [
|
2032
|
+
# {
|
2033
|
+
# # recursive SegmentAttributeValue
|
2034
|
+
# },
|
2035
|
+
# ],
|
2036
|
+
# value_arn: "SegmentAttributeValueString",
|
1941
2037
|
# },
|
1942
2038
|
# },
|
1943
2039
|
# previous_contact_id: "ContactId",
|
@@ -2872,14 +2968,34 @@ module Aws::Connect
|
|
2872
2968
|
end
|
2873
2969
|
|
2874
2970
|
# Creates a new predefined attribute for the specified Amazon Connect
|
2875
|
-
# instance. *
|
2876
|
-
# instance that can be used to route contacts to an agent or pools of
|
2877
|
-
# agents within a queue. For more information, see [Create predefined
|
2878
|
-
# attributes for routing contacts to agents][1].
|
2971
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
2879
2972
|
#
|
2973
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
2974
|
+
# quotas][1].
|
2880
2975
|
#
|
2976
|
+
# **Use cases**
|
2881
2977
|
#
|
2882
|
-
#
|
2978
|
+
# Following are common uses cases for this API:
|
2979
|
+
#
|
2980
|
+
# * Create an attribute for routing proficiency (for example, agent
|
2981
|
+
# certification) that has predefined values (for example, a list of
|
2982
|
+
# possible certifications). For more information, see [Create
|
2983
|
+
# predefined attributes for routing contacts to agents][2].
|
2984
|
+
#
|
2985
|
+
# * Create an attribute for business unit name that has a list of
|
2986
|
+
# predefined business unit names used in your organization. This is a
|
2987
|
+
# use case where information for a contact varies between transfers or
|
2988
|
+
# conferences. For more information, see [Use contact segment
|
2989
|
+
# attributes][3].
|
2990
|
+
#
|
2991
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
2992
|
+
#
|
2993
|
+
#
|
2994
|
+
#
|
2995
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
2996
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
2997
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
2998
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
2883
2999
|
#
|
2884
3000
|
# @option params [required, String] :instance_id
|
2885
3001
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -2888,9 +3004,19 @@ module Aws::Connect
|
|
2888
3004
|
# @option params [required, String] :name
|
2889
3005
|
# The name of the predefined attribute.
|
2890
3006
|
#
|
2891
|
-
# @option params [
|
3007
|
+
# @option params [Types::PredefinedAttributeValues] :values
|
2892
3008
|
# The values of the predefined attribute.
|
2893
3009
|
#
|
3010
|
+
# @option params [Array<String>] :purposes
|
3011
|
+
# Values that enable you to categorize your predefined attributes. You
|
3012
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
3013
|
+
# website.
|
3014
|
+
#
|
3015
|
+
# @option params [Types::InputPredefinedAttributeConfiguration] :attribute_configuration
|
3016
|
+
# Custom metadata that is associated to predefined attributes to control
|
3017
|
+
# behavior in upstream services, such as controlling how a predefined
|
3018
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
3019
|
+
#
|
2894
3020
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2895
3021
|
#
|
2896
3022
|
# @example Request syntax with placeholder values
|
@@ -2898,9 +3024,13 @@ module Aws::Connect
|
|
2898
3024
|
# resp = client.create_predefined_attribute({
|
2899
3025
|
# instance_id: "InstanceId", # required
|
2900
3026
|
# name: "PredefinedAttributeName", # required
|
2901
|
-
# values: {
|
3027
|
+
# values: {
|
2902
3028
|
# string_list: ["PredefinedAttributeStringValue"],
|
2903
3029
|
# },
|
3030
|
+
# purposes: ["PredefinedAttributePurposeName"],
|
3031
|
+
# attribute_configuration: {
|
3032
|
+
# enable_value_validation_on_association: false,
|
3033
|
+
# },
|
2904
3034
|
# })
|
2905
3035
|
#
|
2906
3036
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/CreatePredefinedAttribute AWS API Documentation
|
@@ -3260,6 +3390,16 @@ module Aws::Connect
|
|
3260
3390
|
#
|
3261
3391
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html
|
3262
3392
|
#
|
3393
|
+
# @option params [Array<Types::RoutingProfileManualAssignmentQueueConfig>] :manual_assignment_queue_configs
|
3394
|
+
# The manual assignment queues associated with the routing profile. If
|
3395
|
+
# no queue is added, agents and supervisors can't pick or assign any
|
3396
|
+
# contacts from this routing profile. The limit of 10 array members
|
3397
|
+
# applies to the maximum number of
|
3398
|
+
# RoutingProfileManualAssignmentQueueConfig objects that can be passed
|
3399
|
+
# during a CreateRoutingProfile API request. It is different from the
|
3400
|
+
# quota of 50 queues per routing profile per instance that is listed in
|
3401
|
+
# Amazon Connect service quotas.
|
3402
|
+
#
|
3263
3403
|
# @option params [required, Array<Types::MediaConcurrency>] :media_concurrencies
|
3264
3404
|
# The channels that agents can handle in the Contact Control Panel (CCP)
|
3265
3405
|
# for this routing profile.
|
@@ -3296,6 +3436,14 @@ module Aws::Connect
|
|
3296
3436
|
# delay: 1, # required
|
3297
3437
|
# },
|
3298
3438
|
# ],
|
3439
|
+
# manual_assignment_queue_configs: [
|
3440
|
+
# {
|
3441
|
+
# queue_reference: { # required
|
3442
|
+
# queue_id: "QueueId", # required
|
3443
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
3444
|
+
# },
|
3445
|
+
# },
|
3446
|
+
# ],
|
3299
3447
|
# media_concurrencies: [ # required
|
3300
3448
|
# {
|
3301
3449
|
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
@@ -3956,6 +4104,7 @@ module Aws::Connect
|
|
3956
4104
|
# auto_accept: false,
|
3957
4105
|
# after_contact_work_time_limit: 1,
|
3958
4106
|
# desk_phone_number: "PhoneNumber",
|
4107
|
+
# persistent_connection: false,
|
3959
4108
|
# },
|
3960
4109
|
# directory_user_id: "DirectoryUserId",
|
3961
4110
|
# security_profile_ids: ["SecurityProfileId"], # required
|
@@ -5543,6 +5692,9 @@ module Aws::Connect
|
|
5543
5692
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_map #=> Hash
|
5544
5693
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"] #=> Types::SegmentAttributeValue
|
5545
5694
|
# resp.contact.segment_attributes["SegmentAttributeName"].value_integer #=> Integer
|
5695
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_list #=> Array
|
5696
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_list[0] #=> Types::SegmentAttributeValue
|
5697
|
+
# resp.contact.segment_attributes["SegmentAttributeName"].value_arn #=> String
|
5546
5698
|
# resp.contact.recordings #=> Array
|
5547
5699
|
# resp.contact.recordings[0].storage_type #=> String, one of "S3", "KINESIS_VIDEO_STREAM", "KINESIS_STREAM", "KINESIS_FIREHOSE"
|
5548
5700
|
# resp.contact.recordings[0].location #=> String
|
@@ -6246,14 +6398,29 @@ module Aws::Connect
|
|
6246
6398
|
end
|
6247
6399
|
|
6248
6400
|
# Describes a predefined attribute for the specified Amazon Connect
|
6249
|
-
# instance. *
|
6250
|
-
#
|
6251
|
-
#
|
6252
|
-
#
|
6401
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
6402
|
+
# You can use predefined attributes for:
|
6403
|
+
#
|
6404
|
+
# * Routing proficiency (for example, agent certification) that has
|
6405
|
+
# predefined values (for example, a list of possible certifications).
|
6406
|
+
# For more information, see [Create predefined attributes for routing
|
6407
|
+
# contacts to agents][1].
|
6408
|
+
#
|
6409
|
+
# * Contact information that varies between transfers or conferences,
|
6410
|
+
# such as the name of the business unit handling the contact. For more
|
6411
|
+
# information, see [Use contact segment attributes][2].
|
6412
|
+
#
|
6413
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
6414
|
+
# quotas][3].
|
6415
|
+
#
|
6416
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
6253
6417
|
#
|
6254
6418
|
#
|
6255
6419
|
#
|
6256
6420
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
6421
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
6422
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
6423
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
6257
6424
|
#
|
6258
6425
|
# @option params [required, String] :instance_id
|
6259
6426
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -6278,6 +6445,10 @@ module Aws::Connect
|
|
6278
6445
|
# resp.predefined_attribute.name #=> String
|
6279
6446
|
# resp.predefined_attribute.values.string_list #=> Array
|
6280
6447
|
# resp.predefined_attribute.values.string_list[0] #=> String
|
6448
|
+
# resp.predefined_attribute.purposes #=> Array
|
6449
|
+
# resp.predefined_attribute.purposes[0] #=> String
|
6450
|
+
# resp.predefined_attribute.attribute_configuration.enable_value_validation_on_association #=> Boolean
|
6451
|
+
# resp.predefined_attribute.attribute_configuration.is_read_only #=> Boolean
|
6281
6452
|
# resp.predefined_attribute.last_modified_time #=> Time
|
6282
6453
|
# resp.predefined_attribute.last_modified_region #=> String
|
6283
6454
|
#
|
@@ -6485,6 +6656,7 @@ module Aws::Connect
|
|
6485
6656
|
# resp.routing_profile.tags #=> Hash
|
6486
6657
|
# resp.routing_profile.tags["TagKey"] #=> String
|
6487
6658
|
# resp.routing_profile.number_of_associated_queues #=> Integer
|
6659
|
+
# resp.routing_profile.number_of_associated_manual_assignment_queues #=> Integer
|
6488
6660
|
# resp.routing_profile.number_of_associated_users #=> Integer
|
6489
6661
|
# resp.routing_profile.agent_availability_timer #=> String, one of "TIME_SINCE_LAST_ACTIVITY", "TIME_SINCE_LAST_INBOUND"
|
6490
6662
|
# resp.routing_profile.last_modified_time #=> Time
|
@@ -6492,6 +6664,8 @@ module Aws::Connect
|
|
6492
6664
|
# resp.routing_profile.is_default #=> Boolean
|
6493
6665
|
# resp.routing_profile.associated_queue_ids #=> Array
|
6494
6666
|
# resp.routing_profile.associated_queue_ids[0] #=> String
|
6667
|
+
# resp.routing_profile.associated_manual_assignment_queue_ids #=> Array
|
6668
|
+
# resp.routing_profile.associated_manual_assignment_queue_ids[0] #=> String
|
6495
6669
|
#
|
6496
6670
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/DescribeRoutingProfile AWS API Documentation
|
6497
6671
|
#
|
@@ -6737,6 +6911,7 @@ module Aws::Connect
|
|
6737
6911
|
# resp.user.phone_config.auto_accept #=> Boolean
|
6738
6912
|
# resp.user.phone_config.after_contact_work_time_limit #=> Integer
|
6739
6913
|
# resp.user.phone_config.desk_phone_number #=> String
|
6914
|
+
# resp.user.phone_config.persistent_connection #=> Boolean
|
6740
6915
|
# resp.user.directory_user_id #=> String
|
6741
6916
|
# resp.user.security_profile_ids #=> Array
|
6742
6917
|
# resp.user.security_profile_ids[0] #=> String
|
@@ -7415,6 +7590,10 @@ module Aws::Connect
|
|
7415
7590
|
|
7416
7591
|
# Disassociates a set of queues from a routing profile.
|
7417
7592
|
#
|
7593
|
+
# Up to 10 queue references can be disassociated in a single API call.
|
7594
|
+
# More than 10 queue references results in a single call results in an
|
7595
|
+
# InvalidParameterException.
|
7596
|
+
#
|
7418
7597
|
# @option params [required, String] :instance_id
|
7419
7598
|
# The identifier of the Amazon Connect instance. You can [find the
|
7420
7599
|
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
@@ -7426,9 +7605,13 @@ module Aws::Connect
|
|
7426
7605
|
# @option params [required, String] :routing_profile_id
|
7427
7606
|
# The identifier of the routing profile.
|
7428
7607
|
#
|
7429
|
-
# @option params [
|
7608
|
+
# @option params [Array<Types::RoutingProfileQueueReference>] :queue_references
|
7430
7609
|
# The queues to disassociate from this routing profile.
|
7431
7610
|
#
|
7611
|
+
# @option params [Array<Types::RoutingProfileQueueReference>] :manual_assignment_queue_references
|
7612
|
+
# The manual assignment queues to disassociate with this routing
|
7613
|
+
# profile.
|
7614
|
+
#
|
7432
7615
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
7433
7616
|
#
|
7434
7617
|
# @example Request syntax with placeholder values
|
@@ -7436,7 +7619,13 @@ module Aws::Connect
|
|
7436
7619
|
# resp = client.disassociate_routing_profile_queues({
|
7437
7620
|
# instance_id: "InstanceId", # required
|
7438
7621
|
# routing_profile_id: "RoutingProfileId", # required
|
7439
|
-
# queue_references: [
|
7622
|
+
# queue_references: [
|
7623
|
+
# {
|
7624
|
+
# queue_id: "QueueId", # required
|
7625
|
+
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
7626
|
+
# },
|
7627
|
+
# ],
|
7628
|
+
# manual_assignment_queue_references: [
|
7440
7629
|
# {
|
7441
7630
|
# queue_id: "QueueId", # required
|
7442
7631
|
# channel: "VOICE", # required, accepts VOICE, CHAT, TASK, EMAIL
|
@@ -7724,22 +7913,38 @@ module Aws::Connect
|
|
7724
7913
|
req.send_request(options)
|
7725
7914
|
end
|
7726
7915
|
|
7727
|
-
#
|
7916
|
+
# Retrieves the position of the contact in the queue.
|
7728
7917
|
#
|
7729
7918
|
# **Use cases**
|
7730
7919
|
#
|
7731
|
-
# Following are common uses cases for
|
7920
|
+
# Following are common uses cases for position in queue:
|
7732
7921
|
#
|
7733
|
-
# *
|
7734
|
-
# queue.
|
7922
|
+
# * Understand the expected wait experience of a contact.
|
7735
7923
|
#
|
7736
|
-
#
|
7924
|
+
# * Inform customers of their position in queue and potentially offer a
|
7925
|
+
# callback.
|
7926
|
+
#
|
7927
|
+
# * Make data-driven routing decisions between primary and alternative
|
7928
|
+
# queues.
|
7737
7929
|
#
|
7738
|
-
#
|
7930
|
+
# * Enhance queue visibility and leverage agent proficiencies to
|
7931
|
+
# streamline contact routing.
|
7739
7932
|
#
|
7933
|
+
# **Important things to know**
|
7934
|
+
#
|
7935
|
+
# * The only way to retrieve the position of the contact in queue is by
|
7936
|
+
# using this API. You can't retrieve the position by using flows and
|
7937
|
+
# attributes.
|
7938
|
+
#
|
7939
|
+
# * For more information, see the [Position in queue][1] metric in the
|
7940
|
+
# *Amazon Connect Administrator Guide*.
|
7740
7941
|
#
|
7942
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][2].
|
7741
7943
|
#
|
7742
|
-
#
|
7944
|
+
#
|
7945
|
+
#
|
7946
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html
|
7947
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
7743
7948
|
#
|
7744
7949
|
# @option params [required, String] :instance_id
|
7745
7950
|
# The identifier of the Amazon Connect instance. You can [find the
|
@@ -9089,6 +9294,8 @@ module Aws::Connect
|
|
9089
9294
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
9090
9295
|
# Q in Connect
|
9091
9296
|
#
|
9297
|
+
# Valid metric filter key: `INITIATION_METHOD`
|
9298
|
+
#
|
9092
9299
|
# UI name: [Average queue abandon time][12]
|
9093
9300
|
#
|
9094
9301
|
# AVG\_ACTIVE\_TIME
|
@@ -9481,10 +9688,23 @@ module Aws::Connect
|
|
9481
9688
|
#
|
9482
9689
|
# UI name: [Average queue answer time][45]
|
9483
9690
|
#
|
9691
|
+
# Valid metric level filters: `INITIATION_METHOD`, `FEATURE`,
|
9692
|
+
# `DISCONNECT_REASON`
|
9693
|
+
#
|
9484
9694
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
9485
9695
|
#
|
9486
9696
|
# </note>
|
9487
9697
|
#
|
9698
|
+
# AVG\_QUEUE\_ANSWER\_TIME\_CUSTOMER\_FIRST\_CALLBACK
|
9699
|
+
#
|
9700
|
+
# : Unit: Seconds
|
9701
|
+
#
|
9702
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9703
|
+
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect,
|
9704
|
+
# Agent Hierarchy
|
9705
|
+
#
|
9706
|
+
# UI name: [Avg. queue answer time - customer first callback][46]
|
9707
|
+
#
|
9488
9708
|
# AVG\_RESPONSE\_TIME\_AGENT
|
9489
9709
|
#
|
9490
9710
|
# : Unit: Seconds
|
@@ -9494,7 +9714,7 @@ module Aws::Connect
|
|
9494
9714
|
# Feature, RoutingStepExpression, Initiation method, Routing Profile,
|
9495
9715
|
# Queue, Q in Connect
|
9496
9716
|
#
|
9497
|
-
# UI name: [Average agent response time][
|
9717
|
+
# UI name: [Average agent response time][47]
|
9498
9718
|
#
|
9499
9719
|
# AVG\_RESPONSE\_TIME\_CUSTOMER
|
9500
9720
|
#
|
@@ -9505,7 +9725,7 @@ module Aws::Connect
|
|
9505
9725
|
# Feature, RoutingStepExpression, Initiation method, Routing Profile,
|
9506
9726
|
# Queue, Q in Connect
|
9507
9727
|
#
|
9508
|
-
# UI name: [Average customer response time][
|
9728
|
+
# UI name: [Average customer response time][48]
|
9509
9729
|
#
|
9510
9730
|
# AVG\_RESOLUTION\_TIME
|
9511
9731
|
#
|
@@ -9514,7 +9734,7 @@ module Aws::Connect
|
|
9514
9734
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
9515
9735
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
9516
9736
|
#
|
9517
|
-
# UI name: [Average resolution time][
|
9737
|
+
# UI name: [Average resolution time][49]
|
9518
9738
|
#
|
9519
9739
|
# AVG\_TALK\_TIME
|
9520
9740
|
#
|
@@ -9527,7 +9747,7 @@ module Aws::Connect
|
|
9527
9747
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9528
9748
|
# Connect
|
9529
9749
|
#
|
9530
|
-
# UI name: [Average talk time][
|
9750
|
+
# UI name: [Average talk time][50]
|
9531
9751
|
#
|
9532
9752
|
# AVG\_TALK\_TIME\_AGENT
|
9533
9753
|
#
|
@@ -9540,7 +9760,7 @@ module Aws::Connect
|
|
9540
9760
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9541
9761
|
# Connect
|
9542
9762
|
#
|
9543
|
-
# UI name: [Average agent talk time][
|
9763
|
+
# UI name: [Average agent talk time][51]
|
9544
9764
|
#
|
9545
9765
|
# AVG\_TALK\_TIME\_CUSTOMER
|
9546
9766
|
#
|
@@ -9553,7 +9773,7 @@ module Aws::Connect
|
|
9553
9773
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9554
9774
|
# Connect
|
9555
9775
|
#
|
9556
|
-
# UI name: [Average customer talk time][
|
9776
|
+
# UI name: [Average customer talk time][52]
|
9557
9777
|
#
|
9558
9778
|
# AVG\_WAIT\_TIME\_AFTER\_CUSTOMER\_CONNECTION
|
9559
9779
|
#
|
@@ -9564,7 +9784,18 @@ module Aws::Connect
|
|
9564
9784
|
#
|
9565
9785
|
# Valid groupings and filters: Campaign
|
9566
9786
|
#
|
9567
|
-
# UI name: [Average wait time after customer connection][
|
9787
|
+
# UI name: [Average wait time after customer connection][53]
|
9788
|
+
#
|
9789
|
+
# AVG\_WAIT\_TIME\_AFTER\_CUSTOMER\_FIRST\_CALLBACK\_CONNECTION
|
9790
|
+
#
|
9791
|
+
# : Unit: Seconds
|
9792
|
+
#
|
9793
|
+
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9794
|
+
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect,
|
9795
|
+
# Agent Hierarchy
|
9796
|
+
#
|
9797
|
+
# UI name: [Avg. wait time after customer connection - customer first
|
9798
|
+
# callback][54]
|
9568
9799
|
#
|
9569
9800
|
# AVG\_WEIGHTED\_EVALUATION\_SCORE
|
9570
9801
|
#
|
@@ -9574,7 +9805,7 @@ module Aws::Connect
|
|
9574
9805
|
# Evaluation Form Id, Evaluation Section ID, Evaluation Question ID,
|
9575
9806
|
# Evaluation Source, Form Version, Queue, Routing Profile
|
9576
9807
|
#
|
9577
|
-
# UI name: [Average weighted evaluation score][
|
9808
|
+
# UI name: [Average weighted evaluation score][55]
|
9578
9809
|
#
|
9579
9810
|
# BOT\_CONVERSATIONS\_COMPLETED
|
9580
9811
|
#
|
@@ -9586,7 +9817,7 @@ module Aws::Connect
|
|
9586
9817
|
# Flow type, Flow action ID, Invoking resource published timestamp,
|
9587
9818
|
# Initiation method, Invoking resource type, Parent flows resource ID
|
9588
9819
|
#
|
9589
|
-
# UI name: [Bot conversations completed][
|
9820
|
+
# UI name: [Bot conversations completed][56]
|
9590
9821
|
#
|
9591
9822
|
# BOT\_INTENTS\_COMPLETED
|
9592
9823
|
#
|
@@ -9599,7 +9830,7 @@ module Aws::Connect
|
|
9599
9830
|
# published timestamp, Initiation method, Invoking resource type,
|
9600
9831
|
# Parent flows resource ID
|
9601
9832
|
#
|
9602
|
-
# UI name: [Bot intents completed][
|
9833
|
+
# UI name: [Bot intents completed][57]
|
9603
9834
|
#
|
9604
9835
|
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X
|
9605
9836
|
#
|
@@ -9614,7 +9845,7 @@ module Aws::Connect
|
|
9614
9845
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
9615
9846
|
# `GT` (for *Greater than*).
|
9616
9847
|
#
|
9617
|
-
# UI name: [Campaign contacts abandoned after X][
|
9848
|
+
# UI name: [Campaign contacts abandoned after X][58]
|
9618
9849
|
#
|
9619
9850
|
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X\_RATE
|
9620
9851
|
#
|
@@ -9629,7 +9860,7 @@ module Aws::Connect
|
|
9629
9860
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
9630
9861
|
# `GT` (for *Greater than*).
|
9631
9862
|
#
|
9632
|
-
# UI name: [Campaign contacts abandoned after X rate][
|
9863
|
+
# UI name: [Campaign contacts abandoned after X rate][59]
|
9633
9864
|
#
|
9634
9865
|
# CAMPAIGN\_INTERACTIONS
|
9635
9866
|
#
|
@@ -9642,7 +9873,7 @@ module Aws::Connect
|
|
9642
9873
|
#
|
9643
9874
|
# Valid groupings and filters: Campaign
|
9644
9875
|
#
|
9645
|
-
# UI name: [Campaign interactions][
|
9876
|
+
# UI name: [Campaign interactions][60]
|
9646
9877
|
#
|
9647
9878
|
# CAMPAIGN\_PROGRESS\_RATE
|
9648
9879
|
#
|
@@ -9654,7 +9885,7 @@ module Aws::Connect
|
|
9654
9885
|
#
|
9655
9886
|
# Valid groupings and filters: Campaign, Campaign Execution Timestamp
|
9656
9887
|
#
|
9657
|
-
# UI name: [Campaign progress rate][
|
9888
|
+
# UI name: [Campaign progress rate][61]
|
9658
9889
|
#
|
9659
9890
|
# CAMPAIGN\_SEND\_ATTEMPTS
|
9660
9891
|
#
|
@@ -9665,7 +9896,7 @@ module Aws::Connect
|
|
9665
9896
|
# Valid groupings and filters: Campaign, Channel,
|
9666
9897
|
# contact/segmentAttributes/connect:Subtype
|
9667
9898
|
#
|
9668
|
-
# UI name: [Campaign send attempts][
|
9899
|
+
# UI name: [Campaign send attempts][62]
|
9669
9900
|
#
|
9670
9901
|
# CAMPAIGN\_SEND\_EXCLUSIONS
|
9671
9902
|
#
|
@@ -9678,7 +9909,7 @@ module Aws::Connect
|
|
9678
9909
|
# Valid groupings and filters: Campaign, Campaign Excluded Event Type,
|
9679
9910
|
# Campaign Execution Timestamp
|
9680
9911
|
#
|
9681
|
-
# UI name: [Campaign send exclusions][
|
9912
|
+
# UI name: [Campaign send exclusions][63]
|
9682
9913
|
#
|
9683
9914
|
# CASES\_CREATED
|
9684
9915
|
#
|
@@ -9688,7 +9919,7 @@ module Aws::Connect
|
|
9688
9919
|
#
|
9689
9920
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
9690
9921
|
#
|
9691
|
-
# UI name: [Cases created][
|
9922
|
+
# UI name: [Cases created][64]
|
9692
9923
|
#
|
9693
9924
|
# CONTACTS\_CREATED
|
9694
9925
|
#
|
@@ -9699,7 +9930,7 @@ module Aws::Connect
|
|
9699
9930
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
9700
9931
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
9701
9932
|
#
|
9702
|
-
# UI name: [Contacts created][
|
9933
|
+
# UI name: [Contacts created][65]
|
9703
9934
|
#
|
9704
9935
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
9705
9936
|
#
|
@@ -9715,7 +9946,7 @@ module Aws::Connect
|
|
9715
9946
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
9716
9947
|
# RoutingStepExpression, Q in Connect
|
9717
9948
|
#
|
9718
|
-
# UI name: [
|
9949
|
+
# UI name: [Contacts handled][66]
|
9719
9950
|
#
|
9720
9951
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
9721
9952
|
#
|
@@ -9730,7 +9961,7 @@ module Aws::Connect
|
|
9730
9961
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
9731
9962
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
9732
9963
|
#
|
9733
|
-
# UI name: [Contacts handled (connected to agent timestamp)][
|
9964
|
+
# UI name: [Contacts handled (connected to agent timestamp)][67]
|
9734
9965
|
#
|
9735
9966
|
# CONTACTS\_HOLD\_ABANDONS
|
9736
9967
|
#
|
@@ -9740,7 +9971,7 @@ module Aws::Connect
|
|
9740
9971
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9741
9972
|
# Connect
|
9742
9973
|
#
|
9743
|
-
# UI name: [Contacts hold disconnect][
|
9974
|
+
# UI name: [Contacts hold disconnect][68]
|
9744
9975
|
#
|
9745
9976
|
# CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
|
9746
9977
|
#
|
@@ -9749,7 +9980,7 @@ module Aws::Connect
|
|
9749
9980
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9750
9981
|
# Agent Hierarchy, Q in Connect
|
9751
9982
|
#
|
9752
|
-
# UI name: [Contacts hold agent disconnect][
|
9983
|
+
# UI name: [Contacts hold agent disconnect][69]
|
9753
9984
|
#
|
9754
9985
|
# CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
|
9755
9986
|
#
|
@@ -9758,7 +9989,7 @@ module Aws::Connect
|
|
9758
9989
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9759
9990
|
# Agent Hierarchy, Q in Connect
|
9760
9991
|
#
|
9761
|
-
# UI name: [Contacts hold customer disconnect][
|
9992
|
+
# UI name: [Contacts hold customer disconnect][70]
|
9762
9993
|
#
|
9763
9994
|
# CONTACTS\_PUT\_ON\_HOLD
|
9764
9995
|
#
|
@@ -9767,7 +9998,7 @@ module Aws::Connect
|
|
9767
9998
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9768
9999
|
# Agent Hierarchy, Q in Connect
|
9769
10000
|
#
|
9770
|
-
# UI name: [Contacts put on hold][
|
10001
|
+
# UI name: [Contacts put on hold][71]
|
9771
10002
|
#
|
9772
10003
|
# CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
|
9773
10004
|
#
|
@@ -9776,7 +10007,7 @@ module Aws::Connect
|
|
9776
10007
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9777
10008
|
# Agent Hierarchy, Q in Connect
|
9778
10009
|
#
|
9779
|
-
# UI name: [Contacts transferred out external][
|
10010
|
+
# UI name: [Contacts transferred out external][72]
|
9780
10011
|
#
|
9781
10012
|
# CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
|
9782
10013
|
#
|
@@ -9785,7 +10016,7 @@ module Aws::Connect
|
|
9785
10016
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
9786
10017
|
# Agent Hierarchy, Q in Connect
|
9787
10018
|
#
|
9788
|
-
# UI name: [Contacts transferred out internal][
|
10019
|
+
# UI name: [Contacts transferred out internal][73]
|
9789
10020
|
#
|
9790
10021
|
# CONTACTS\_QUEUED
|
9791
10022
|
#
|
@@ -9795,7 +10026,7 @@ module Aws::Connect
|
|
9795
10026
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9796
10027
|
# Connect
|
9797
10028
|
#
|
9798
|
-
# UI name: [Contacts queued][
|
10029
|
+
# UI name: [Contacts queued][74]
|
9799
10030
|
#
|
9800
10031
|
# CONTACTS\_QUEUED\_BY\_ENQUEUE
|
9801
10032
|
#
|
@@ -9804,7 +10035,7 @@ module Aws::Connect
|
|
9804
10035
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
9805
10036
|
# contact/segmentAttributes/connect:Subtype
|
9806
10037
|
#
|
9807
|
-
# UI name: [Contacts queued (enqueue timestamp)][
|
10038
|
+
# UI name: [Contacts queued (enqueue timestamp)][75]
|
9808
10039
|
#
|
9809
10040
|
# CONTACTS\_REMOVED\_FROM\_QUEUE\_IN\_X
|
9810
10041
|
#
|
@@ -9817,7 +10048,7 @@ module Aws::Connect
|
|
9817
10048
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
9818
10049
|
# (for "Less than") or `LTE` (for "Less than equal").
|
9819
10050
|
#
|
9820
|
-
# UI name: [Contacts removed from queue in X seconds][
|
10051
|
+
# UI name: [Contacts removed from queue in X seconds][76]
|
9821
10052
|
#
|
9822
10053
|
# CONTACTS\_RESOLVED\_IN\_X
|
9823
10054
|
#
|
@@ -9830,7 +10061,7 @@ module Aws::Connect
|
|
9830
10061
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
9831
10062
|
# (for "Less than") or `LTE` (for "Less than equal").
|
9832
10063
|
#
|
9833
|
-
# UI name: [Contacts resolved in X][
|
10064
|
+
# UI name: [Contacts resolved in X][77]
|
9834
10065
|
#
|
9835
10066
|
# CONTACTS\_TRANSFERRED\_OUT
|
9836
10067
|
#
|
@@ -9840,7 +10071,7 @@ module Aws::Connect
|
|
9840
10071
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
9841
10072
|
# Q in Connect
|
9842
10073
|
#
|
9843
|
-
# UI name: [Contacts transferred out][
|
10074
|
+
# UI name: [Contacts transferred out][78]
|
9844
10075
|
#
|
9845
10076
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
9846
10077
|
#
|
@@ -9854,7 +10085,7 @@ module Aws::Connect
|
|
9854
10085
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9855
10086
|
# Connect
|
9856
10087
|
#
|
9857
|
-
# UI name: [Contacts transferred out by agent][
|
10088
|
+
# UI name: [Contacts transferred out by agent][79]
|
9858
10089
|
#
|
9859
10090
|
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
9860
10091
|
#
|
@@ -9864,7 +10095,7 @@ module Aws::Connect
|
|
9864
10095
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
9865
10096
|
# Connect
|
9866
10097
|
#
|
9867
|
-
# UI name: [Contacts transferred out queue][
|
10098
|
+
# UI name: [Contacts transferred out queue][80]
|
9868
10099
|
#
|
9869
10100
|
# CURRENT\_CASES
|
9870
10101
|
#
|
@@ -9874,7 +10105,7 @@ module Aws::Connect
|
|
9874
10105
|
#
|
9875
10106
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
9876
10107
|
#
|
9877
|
-
# UI name: [Current cases][
|
10108
|
+
# UI name: [Current cases][81]
|
9878
10109
|
#
|
9879
10110
|
# CONVERSATIONS\_ABANDONED
|
9880
10111
|
#
|
@@ -9885,7 +10116,7 @@ module Aws::Connect
|
|
9885
10116
|
# Feature, RoutingStepExpression, Initiation method, Routing Profile,
|
9886
10117
|
# Queue, Q in Connect
|
9887
10118
|
#
|
9888
|
-
# UI name: [Conversations abandoned][
|
10119
|
+
# UI name: [Conversations abandoned][82]
|
9889
10120
|
#
|
9890
10121
|
# DELIVERY\_ATTEMPTS
|
9891
10122
|
#
|
@@ -9901,7 +10132,7 @@ module Aws::Connect
|
|
9901
10132
|
# contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,
|
9902
10133
|
# Routing Profile
|
9903
10134
|
#
|
9904
|
-
# UI name: [Delivery attempts][
|
10135
|
+
# UI name: [Delivery attempts][83]
|
9905
10136
|
#
|
9906
10137
|
# <note markdown="1"> Campaign Delivery EventType filter and grouping are only available
|
9907
10138
|
# for SMS and Email campaign delivery modes. Agent, Queue, Routing
|
@@ -9927,7 +10158,7 @@ module Aws::Connect
|
|
9927
10158
|
# contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,
|
9928
10159
|
# Routing Profile
|
9929
10160
|
#
|
9930
|
-
# UI name: [Delivery attempt disposition rate][
|
10161
|
+
# UI name: [Delivery attempt disposition rate][84]
|
9931
10162
|
#
|
9932
10163
|
# <note markdown="1"> Campaign Delivery Event Type filter and grouping are only available
|
9933
10164
|
# for SMS and Email campaign delivery modes. Agent, Queue, Routing
|
@@ -9945,7 +10176,7 @@ module Aws::Connect
|
|
9945
10176
|
# Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing
|
9946
10177
|
# Profile
|
9947
10178
|
#
|
9948
|
-
# UI name: [Evaluations performed][
|
10179
|
+
# UI name: [Evaluations performed][85]
|
9949
10180
|
#
|
9950
10181
|
# FLOWS\_OUTCOME
|
9951
10182
|
#
|
@@ -9957,7 +10188,7 @@ module Aws::Connect
|
|
9957
10188
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
9958
10189
|
# published timestamp
|
9959
10190
|
#
|
9960
|
-
# UI name: [Flows outcome][
|
10191
|
+
# UI name: [Flows outcome][86]
|
9961
10192
|
#
|
9962
10193
|
# FLOWS\_STARTED
|
9963
10194
|
#
|
@@ -9968,7 +10199,7 @@ module Aws::Connect
|
|
9968
10199
|
# resource ID, Flows resource ID, Initiation method, Resource
|
9969
10200
|
# published timestamp
|
9970
10201
|
#
|
9971
|
-
# UI name: [Flows started][
|
10202
|
+
# UI name: [Flows started][87]
|
9972
10203
|
#
|
9973
10204
|
# HUMAN\_ANSWERED\_CALLS
|
9974
10205
|
#
|
@@ -9980,7 +10211,7 @@ module Aws::Connect
|
|
9980
10211
|
#
|
9981
10212
|
# Valid groupings and filters: Agent, Campaign
|
9982
10213
|
#
|
9983
|
-
# UI name: [Human answered][
|
10214
|
+
# UI name: [Human answered][88]
|
9984
10215
|
#
|
9985
10216
|
# MAX\_FLOW\_TIME
|
9986
10217
|
#
|
@@ -9992,7 +10223,7 @@ module Aws::Connect
|
|
9992
10223
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
9993
10224
|
# published timestamp
|
9994
10225
|
#
|
9995
|
-
# UI name: [Maximum flow time][
|
10226
|
+
# UI name: [Maximum flow time][89]
|
9996
10227
|
#
|
9997
10228
|
# MAX\_QUEUED\_TIME
|
9998
10229
|
#
|
@@ -10002,7 +10233,7 @@ module Aws::Connect
|
|
10002
10233
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10003
10234
|
# Connect
|
10004
10235
|
#
|
10005
|
-
# UI name: [Maximum queued time][
|
10236
|
+
# UI name: [Maximum queued time][90]
|
10006
10237
|
#
|
10007
10238
|
# MIN\_FLOW\_TIME
|
10008
10239
|
#
|
@@ -10014,7 +10245,7 @@ module Aws::Connect
|
|
10014
10245
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
10015
10246
|
# published timestamp
|
10016
10247
|
#
|
10017
|
-
# UI name: [Minimum flow time][
|
10248
|
+
# UI name: [Minimum flow time][91]
|
10018
10249
|
#
|
10019
10250
|
# PERCENT\_AUTOMATIC\_FAILS
|
10020
10251
|
#
|
@@ -10024,7 +10255,7 @@ module Aws::Connect
|
|
10024
10255
|
# Evaluation Form ID, Evaluation Source, Form Version, Queue, Routing
|
10025
10256
|
# Profile
|
10026
10257
|
#
|
10027
|
-
# UI name: [Automatic fails percent][
|
10258
|
+
# UI name: [Automatic fails percent][92]
|
10028
10259
|
#
|
10029
10260
|
# PERCENT\_BOT\_CONVERSATIONS\_OUTCOME
|
10030
10261
|
#
|
@@ -10036,7 +10267,7 @@ module Aws::Connect
|
|
10036
10267
|
# Flow type, Flow action ID, Invoking resource published timestamp,
|
10037
10268
|
# Initiation method, Invoking resource type, Parent flows resource ID
|
10038
10269
|
#
|
10039
|
-
# UI name: [Percent bot conversations outcome][
|
10270
|
+
# UI name: [Percent bot conversations outcome][93]
|
10040
10271
|
#
|
10041
10272
|
# PERCENT\_BOT\_INTENTS\_OUTCOME
|
10042
10273
|
#
|
@@ -10049,7 +10280,7 @@ module Aws::Connect
|
|
10049
10280
|
# published timestamp, Initiation method, Invoking resource type,
|
10050
10281
|
# Parent flows resource ID
|
10051
10282
|
#
|
10052
|
-
# UI name: [Percent bot intents outcome][
|
10283
|
+
# UI name: [Percent bot intents outcome][94]
|
10053
10284
|
#
|
10054
10285
|
# PERCENT\_CASES\_FIRST\_CONTACT\_RESOLVED
|
10055
10286
|
#
|
@@ -10059,7 +10290,7 @@ module Aws::Connect
|
|
10059
10290
|
#
|
10060
10291
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
10061
10292
|
#
|
10062
|
-
# UI name: [Cases resolved on first contact][
|
10293
|
+
# UI name: [Cases resolved on first contact][95]
|
10063
10294
|
#
|
10064
10295
|
# PERCENT\_CONTACTS\_STEP\_EXPIRED
|
10065
10296
|
#
|
@@ -10091,7 +10322,7 @@ module Aws::Connect
|
|
10091
10322
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
10092
10323
|
# published timestamp
|
10093
10324
|
#
|
10094
|
-
# UI name: [Flows outcome percentage][
|
10325
|
+
# UI name: [Flows outcome percentage][96].
|
10095
10326
|
#
|
10096
10327
|
# <note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
|
10097
10328
|
#
|
@@ -10108,7 +10339,7 @@ module Aws::Connect
|
|
10108
10339
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10109
10340
|
# Connect
|
10110
10341
|
#
|
10111
|
-
# UI name: [Non-talk time percent][
|
10342
|
+
# UI name: [Non-talk time percent][97]
|
10112
10343
|
#
|
10113
10344
|
# PERCENT\_TALK\_TIME
|
10114
10345
|
#
|
@@ -10121,7 +10352,7 @@ module Aws::Connect
|
|
10121
10352
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10122
10353
|
# Connect
|
10123
10354
|
#
|
10124
|
-
# UI name: [Talk time percent][
|
10355
|
+
# UI name: [Talk time percent][98]
|
10125
10356
|
#
|
10126
10357
|
# PERCENT\_TALK\_TIME\_AGENT
|
10127
10358
|
#
|
@@ -10134,7 +10365,7 @@ module Aws::Connect
|
|
10134
10365
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10135
10366
|
# Connect
|
10136
10367
|
#
|
10137
|
-
# UI name: [Agent talk time percent][
|
10368
|
+
# UI name: [Agent talk time percent][99]
|
10138
10369
|
#
|
10139
10370
|
# PERCENT\_TALK\_TIME\_CUSTOMER
|
10140
10371
|
#
|
@@ -10147,7 +10378,7 @@ module Aws::Connect
|
|
10147
10378
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10148
10379
|
# Connect
|
10149
10380
|
#
|
10150
|
-
# UI name: [Customer talk time percent][
|
10381
|
+
# UI name: [Customer talk time percent][100]
|
10151
10382
|
#
|
10152
10383
|
# RECIPIENTS\_ATTEMPTED
|
10153
10384
|
#
|
@@ -10159,7 +10390,7 @@ module Aws::Connect
|
|
10159
10390
|
#
|
10160
10391
|
# Valid groupings and filters: Campaign, Campaign Execution Timestamp
|
10161
10392
|
#
|
10162
|
-
# UI name: [Recipients attempted][
|
10393
|
+
# UI name: [Recipients attempted][101]
|
10163
10394
|
#
|
10164
10395
|
# RECIPIENTS\_INTERACTED
|
10165
10396
|
#
|
@@ -10175,7 +10406,7 @@ module Aws::Connect
|
|
10175
10406
|
# contact/segmentAttributes/connect:Subtype, Campaign Execution
|
10176
10407
|
# Timestamp
|
10177
10408
|
#
|
10178
|
-
# UI name: [Recipients interacted][
|
10409
|
+
# UI name: [Recipients interacted][102]
|
10179
10410
|
#
|
10180
10411
|
# RECIPIENTS\_TARGETED
|
10181
10412
|
#
|
@@ -10187,7 +10418,7 @@ module Aws::Connect
|
|
10187
10418
|
#
|
10188
10419
|
# Valid groupings and filters: Campaign, Campaign Execution Timestamp
|
10189
10420
|
#
|
10190
|
-
# UI name: [Recipients targeted][
|
10421
|
+
# UI name: [Recipients targeted][103]
|
10191
10422
|
#
|
10192
10423
|
# REOPENED\_CASE\_ACTIONS
|
10193
10424
|
#
|
@@ -10197,7 +10428,7 @@ module Aws::Connect
|
|
10197
10428
|
#
|
10198
10429
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
10199
10430
|
#
|
10200
|
-
# UI name: [Cases reopened][
|
10431
|
+
# UI name: [Cases reopened][104]
|
10201
10432
|
#
|
10202
10433
|
# RESOLVED\_CASE\_ACTIONS
|
10203
10434
|
#
|
@@ -10207,7 +10438,7 @@ module Aws::Connect
|
|
10207
10438
|
#
|
10208
10439
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
10209
10440
|
#
|
10210
|
-
# UI name: [Cases resolved][
|
10441
|
+
# UI name: [Cases resolved][105]
|
10211
10442
|
#
|
10212
10443
|
# SERVICE\_LEVEL
|
10213
10444
|
#
|
@@ -10222,7 +10453,7 @@ module Aws::Connect
|
|
10222
10453
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10223
10454
|
# (for "Less than") or `LTE` (for "Less than equal").
|
10224
10455
|
#
|
10225
|
-
# UI name: [Service level X][
|
10456
|
+
# UI name: [Service level X][106]
|
10226
10457
|
#
|
10227
10458
|
# STEP\_CONTACTS\_QUEUED
|
10228
10459
|
#
|
@@ -10248,12 +10479,13 @@ module Aws::Connect
|
|
10248
10479
|
#
|
10249
10480
|
# Valid metric filter key: `INITIATION_METHOD`. This metric only
|
10250
10481
|
# supports the following filter keys as `INITIATION_METHOD`: `INBOUND`
|
10251
|
-
# \| `OUTBOUND` \| `CALLBACK` \| `API`
|
10482
|
+
# \| `OUTBOUND` \| `CALLBACK` \| `API` \|
|
10483
|
+
# `CALLBACK_CUSTOMER_FIRST_DIALED`
|
10252
10484
|
#
|
10253
10485
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10254
10486
|
# Agent Hierarchy
|
10255
10487
|
#
|
10256
|
-
# UI name: [Agent API connecting time][
|
10488
|
+
# UI name: [Agent API connecting time][107]
|
10257
10489
|
#
|
10258
10490
|
# <note markdown="1"> The `Negate` key in metric-level filters is not applicable for this
|
10259
10491
|
# metric.
|
@@ -10266,8 +10498,9 @@ module Aws::Connect
|
|
10266
10498
|
#
|
10267
10499
|
# Metric filter:
|
10268
10500
|
#
|
10269
|
-
# * Valid values: `API`\| `
|
10270
|
-
# `
|
10501
|
+
# * Valid values: `API`\| `INCOMING` \| `OUTBOUND` \| `TRANSFER` \|
|
10502
|
+
# `CALLBACK` \| `QUEUE_TRANSFER`\| `Disconnect` \|
|
10503
|
+
# `CALLBACK_CUSTOMER_FIRST_DIALED`
|
10271
10504
|
#
|
10272
10505
|
# ^
|
10273
10506
|
#
|
@@ -10275,7 +10508,7 @@ module Aws::Connect
|
|
10275
10508
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
|
10276
10509
|
# RoutingStepExpression, Q in Connect
|
10277
10510
|
#
|
10278
|
-
# UI name: [Contact abandoned][
|
10511
|
+
# UI name: [Contact abandoned][108]
|
10279
10512
|
#
|
10280
10513
|
# SUM\_CONTACTS\_ABANDONED\_IN\_X
|
10281
10514
|
#
|
@@ -10288,7 +10521,7 @@ module Aws::Connect
|
|
10288
10521
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10289
10522
|
# (for "Less than") or `LTE` (for "Less than equal").
|
10290
10523
|
#
|
10291
|
-
# UI name: [Contacts abandoned in X seconds][
|
10524
|
+
# UI name: [Contacts abandoned in X seconds][109]
|
10292
10525
|
#
|
10293
10526
|
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
10294
10527
|
#
|
@@ -10301,7 +10534,7 @@ module Aws::Connect
|
|
10301
10534
|
# 604800 (inclusive), in seconds. For `Comparison`, you can use `LT`
|
10302
10535
|
# (for "Less than") or `LTE` (for "Less than equal").
|
10303
10536
|
#
|
10304
|
-
# UI name: [Contacts answered in X seconds][
|
10537
|
+
# UI name: [Contacts answered in X seconds][110]
|
10305
10538
|
#
|
10306
10539
|
# SUM\_CONTACT\_FLOW\_TIME
|
10307
10540
|
#
|
@@ -10310,7 +10543,7 @@ module Aws::Connect
|
|
10310
10543
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10311
10544
|
# Agent Hierarchy, Q in Connect
|
10312
10545
|
#
|
10313
|
-
# UI name: [Contact flow time][
|
10546
|
+
# UI name: [Contact flow time][111]
|
10314
10547
|
#
|
10315
10548
|
# SUM\_CONTACT\_TIME\_AGENT
|
10316
10549
|
#
|
@@ -10318,7 +10551,7 @@ module Aws::Connect
|
|
10318
10551
|
#
|
10319
10552
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
10320
10553
|
#
|
10321
|
-
# UI name: [Agent on contact time][
|
10554
|
+
# UI name: [Agent on contact time][112]
|
10322
10555
|
#
|
10323
10556
|
# SUM\_CONTACTS\_DISCONNECTED
|
10324
10557
|
#
|
@@ -10330,7 +10563,7 @@ module Aws::Connect
|
|
10330
10563
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
10331
10564
|
# Connect
|
10332
10565
|
#
|
10333
|
-
# UI name: [Contact disconnected][
|
10566
|
+
# UI name: [Contact disconnected][113]
|
10334
10567
|
#
|
10335
10568
|
# SUM\_ERROR\_STATUS\_TIME\_AGENT
|
10336
10569
|
#
|
@@ -10338,7 +10571,7 @@ module Aws::Connect
|
|
10338
10571
|
#
|
10339
10572
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
10340
10573
|
#
|
10341
|
-
# UI name: [Error status time][
|
10574
|
+
# UI name: [Error status time][114]
|
10342
10575
|
#
|
10343
10576
|
# SUM\_HANDLE\_TIME
|
10344
10577
|
#
|
@@ -10347,7 +10580,7 @@ module Aws::Connect
|
|
10347
10580
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10348
10581
|
# Agent Hierarchy, Q in Connect
|
10349
10582
|
#
|
10350
|
-
# UI name: [Contact handle time][
|
10583
|
+
# UI name: [Contact handle time][115]
|
10351
10584
|
#
|
10352
10585
|
# SUM\_HOLD\_TIME
|
10353
10586
|
#
|
@@ -10356,7 +10589,7 @@ module Aws::Connect
|
|
10356
10589
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10357
10590
|
# Agent Hierarchy, Q in Connect
|
10358
10591
|
#
|
10359
|
-
# UI name: [Customer hold time][
|
10592
|
+
# UI name: [Customer hold time][116]
|
10360
10593
|
#
|
10361
10594
|
# SUM\_IDLE\_TIME\_AGENT
|
10362
10595
|
#
|
@@ -10364,7 +10597,7 @@ module Aws::Connect
|
|
10364
10597
|
#
|
10365
10598
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
10366
10599
|
#
|
10367
|
-
# UI name: [Agent idle time][
|
10600
|
+
# UI name: [Agent idle time][117]
|
10368
10601
|
#
|
10369
10602
|
# SUM\_INTERACTION\_AND\_HOLD\_TIME
|
10370
10603
|
#
|
@@ -10373,7 +10606,7 @@ module Aws::Connect
|
|
10373
10606
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10374
10607
|
# Agent Hierarchy, Q in Connect
|
10375
10608
|
#
|
10376
|
-
# UI name: [Agent interaction and hold time][
|
10609
|
+
# UI name: [Agent interaction and hold time][118]
|
10377
10610
|
#
|
10378
10611
|
# SUM\_INTERACTION\_TIME
|
10379
10612
|
#
|
@@ -10382,7 +10615,7 @@ module Aws::Connect
|
|
10382
10615
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
10383
10616
|
# Agent Hierarchy
|
10384
10617
|
#
|
10385
|
-
# UI name: [Agent interaction time][
|
10618
|
+
# UI name: [Agent interaction time][119]
|
10386
10619
|
#
|
10387
10620
|
# SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
|
10388
10621
|
#
|
@@ -10390,7 +10623,7 @@ module Aws::Connect
|
|
10390
10623
|
#
|
10391
10624
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
10392
10625
|
#
|
10393
|
-
# UI name: [Agent non-productive time][
|
10626
|
+
# UI name: [Agent non-productive time][120]
|
10394
10627
|
#
|
10395
10628
|
# SUM\_ONLINE\_TIME\_AGENT
|
10396
10629
|
#
|
@@ -10398,7 +10631,7 @@ module Aws::Connect
|
|
10398
10631
|
#
|
10399
10632
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
10400
10633
|
#
|
10401
|
-
# UI name: [Online time][
|
10634
|
+
# UI name: [Online time][121]
|
10402
10635
|
#
|
10403
10636
|
# SUM\_RETRY\_CALLBACK\_ATTEMPTS
|
10404
10637
|
#
|
@@ -10407,7 +10640,7 @@ module Aws::Connect
|
|
10407
10640
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
10408
10641
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
10409
10642
|
#
|
10410
|
-
# UI name: [Callback attempts][
|
10643
|
+
# UI name: [Callback attempts][122]
|
10411
10644
|
#
|
10412
10645
|
#
|
10413
10646
|
#
|
@@ -10456,81 +10689,83 @@ module Aws::Connect
|
|
10456
10689
|
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-messages
|
10457
10690
|
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-non-talk-time
|
10458
10691
|
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time
|
10459
|
-
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10460
|
-
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10461
|
-
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10462
|
-
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10463
|
-
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10464
|
-
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10465
|
-
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10466
|
-
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-
|
10467
|
-
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
10468
|
-
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
10469
|
-
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics
|
10470
|
-
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics
|
10471
|
-
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-
|
10472
|
-
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-
|
10473
|
-
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-
|
10474
|
-
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-
|
10475
|
-
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10476
|
-
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10477
|
-
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10478
|
-
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10479
|
-
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10480
|
-
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10481
|
-
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-
|
10482
|
-
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10483
|
-
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10484
|
-
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10485
|
-
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10486
|
-
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10487
|
-
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10488
|
-
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10489
|
-
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10490
|
-
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10491
|
-
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out
|
10492
|
-
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10493
|
-
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10494
|
-
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10495
|
-
# [82]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10496
|
-
# [83]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10497
|
-
# [84]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10498
|
-
# [85]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10499
|
-
# [86]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10500
|
-
# [87]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10501
|
-
# [88]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10502
|
-
# [89]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10503
|
-
# [90]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10504
|
-
# [91]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
10505
|
-
# [92]: https://docs.aws.amazon.com/connect/latest/adminguide/
|
10506
|
-
# [93]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics
|
10507
|
-
# [94]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics
|
10508
|
-
# [95]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10509
|
-
# [96]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10510
|
-
# [97]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10511
|
-
# [98]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10512
|
-
# [99]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10513
|
-
# [100]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10514
|
-
# [101]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-
|
10515
|
-
# [102]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10516
|
-
# [103]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10517
|
-
# [104]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10518
|
-
# [105]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10519
|
-
# [106]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10520
|
-
# [107]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10521
|
-
# [108]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-
|
10522
|
-
# [109]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10523
|
-
# [110]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10524
|
-
# [111]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-
|
10525
|
-
# [112]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10526
|
-
# [113]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-
|
10527
|
-
# [114]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10528
|
-
# [115]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10529
|
-
# [116]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10530
|
-
# [117]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-
|
10531
|
-
# [118]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-
|
10532
|
-
# [119]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10533
|
-
# [120]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#
|
10692
|
+
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time-customer-first-callback
|
10693
|
+
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-response-time-agent
|
10694
|
+
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-time-agent
|
10695
|
+
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-resolution-time
|
10696
|
+
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-talk-time
|
10697
|
+
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-talk-time
|
10698
|
+
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-talk-time
|
10699
|
+
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection
|
10700
|
+
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection-customer-first-callback
|
10701
|
+
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-weighted-evaluation-score
|
10702
|
+
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed
|
10703
|
+
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed
|
10704
|
+
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x
|
10705
|
+
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x-rate
|
10706
|
+
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-interactions
|
10707
|
+
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate
|
10708
|
+
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-attempts
|
10709
|
+
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions
|
10710
|
+
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-created
|
10711
|
+
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-created
|
10712
|
+
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled
|
10713
|
+
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-by-connected-to-agent-timestamp
|
10714
|
+
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect
|
10715
|
+
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-agent-disconnect
|
10716
|
+
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-customer-disconnect
|
10717
|
+
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-put-on-hold
|
10718
|
+
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-external
|
10719
|
+
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-internal
|
10720
|
+
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued
|
10721
|
+
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued-by-enqueue
|
10722
|
+
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-removed-from-queue
|
10723
|
+
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-resolved
|
10724
|
+
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out
|
10725
|
+
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-by-agent
|
10726
|
+
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue
|
10727
|
+
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases
|
10728
|
+
# [82]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#conversations-abandoned
|
10729
|
+
# [83]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempts
|
10730
|
+
# [84]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempt-disposition-rate
|
10731
|
+
# [85]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluations-performed
|
10732
|
+
# [86]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome
|
10733
|
+
# [87]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-started
|
10734
|
+
# [88]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#human-answered
|
10735
|
+
# [89]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-flow-time
|
10736
|
+
# [90]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-queued-time
|
10737
|
+
# [91]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time
|
10738
|
+
# [92]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#automatic-fails-percent
|
10739
|
+
# [93]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome
|
10740
|
+
# [94]: https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome
|
10741
|
+
# [95]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved-on-first-contact
|
10742
|
+
# [96]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome-percentage
|
10743
|
+
# [97]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-talk-time-percent
|
10744
|
+
# [98]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#talk-time-percent
|
10745
|
+
# [99]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-talk-time-percent
|
10746
|
+
# [100]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-talk-time-percent
|
10747
|
+
# [101]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted
|
10748
|
+
# [102]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted
|
10749
|
+
# [103]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted
|
10750
|
+
# [104]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-reopened
|
10751
|
+
# [105]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved
|
10752
|
+
# [106]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level
|
10753
|
+
# [107]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-api-connecting-time
|
10754
|
+
# [108]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned
|
10755
|
+
# [109]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned-in-x-seconds
|
10756
|
+
# [110]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-answered-in-x-seconds
|
10757
|
+
# [111]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-flow-time
|
10758
|
+
# [112]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-on-contact-time
|
10759
|
+
# [113]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-disconnected
|
10760
|
+
# [114]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-status-time
|
10761
|
+
# [115]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-handle-time
|
10762
|
+
# [116]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-hold-time
|
10763
|
+
# [117]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-idle-time
|
10764
|
+
# [118]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-and-hold-time
|
10765
|
+
# [119]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-time
|
10766
|
+
# [120]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-productive-time
|
10767
|
+
# [121]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-time
|
10768
|
+
# [122]: https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-attempts
|
10534
10769
|
#
|
10535
10770
|
# @option params [String] :next_token
|
10536
10771
|
# The token for the next set of results. Use the value returned in the
|
@@ -12489,14 +12724,29 @@ module Aws::Connect
|
|
12489
12724
|
end
|
12490
12725
|
|
12491
12726
|
# Lists predefined attributes for the specified Amazon Connect instance.
|
12492
|
-
# *
|
12493
|
-
#
|
12494
|
-
#
|
12495
|
-
#
|
12727
|
+
# A *predefined attribute* is made up of a name and a value. You can use
|
12728
|
+
# predefined attributes for:
|
12729
|
+
#
|
12730
|
+
# * Routing proficiency (for example, agent certification) that has
|
12731
|
+
# predefined values (for example, a list of possible certifications).
|
12732
|
+
# For more information, see [Create predefined attributes for routing
|
12733
|
+
# contacts to agents][1].
|
12734
|
+
#
|
12735
|
+
# * Contact information that varies between transfers or conferences,
|
12736
|
+
# such as the name of the business unit handling the contact. For more
|
12737
|
+
# information, see [Use contact segment attributes][2].
|
12738
|
+
#
|
12739
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
12740
|
+
# quotas][3].
|
12741
|
+
#
|
12742
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
12496
12743
|
#
|
12497
12744
|
#
|
12498
12745
|
#
|
12499
12746
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
12747
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
12748
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
12749
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
12500
12750
|
#
|
12501
12751
|
# @option params [required, String] :instance_id
|
12502
12752
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -12898,6 +13148,94 @@ module Aws::Connect
|
|
12898
13148
|
req.send_request(options)
|
12899
13149
|
end
|
12900
13150
|
|
13151
|
+
# Lists the manual assignment queues associated with a routing profile.
|
13152
|
+
#
|
13153
|
+
# **Use cases**
|
13154
|
+
#
|
13155
|
+
# Following are common uses cases for this API:
|
13156
|
+
#
|
13157
|
+
# * This API returns list of queues where contacts can be manually
|
13158
|
+
# assigned or picked. The user can additionally filter on queues, if
|
13159
|
+
# they have access to those queues (otherwise a invalid request
|
13160
|
+
# exception will be thrown).
|
13161
|
+
#
|
13162
|
+
# For information about how manual contact assignment works in the
|
13163
|
+
# agent workspace, see the [Access the Worklist app in the Amazon
|
13164
|
+
# Connect agent workspace][1] in the *Amazon Connect Administrator
|
13165
|
+
# Guide*.
|
13166
|
+
#
|
13167
|
+
# **Important things to know**
|
13168
|
+
#
|
13169
|
+
# * This API only returns the manual assignment queues associated with a
|
13170
|
+
# routing profile. Use the ListRoutingProfileQueues API to list the
|
13171
|
+
# auto assignment queues for the routing profile.
|
13172
|
+
#
|
13173
|
+
# ^
|
13174
|
+
#
|
13175
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][2].
|
13176
|
+
#
|
13177
|
+
#
|
13178
|
+
#
|
13179
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html
|
13180
|
+
# [2]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
13181
|
+
#
|
13182
|
+
# @option params [required, String] :instance_id
|
13183
|
+
# The identifier of the Amazon Connect instance. You can [find the
|
13184
|
+
# instance ID][1] in the Amazon Resource Name (ARN) of the instance.
|
13185
|
+
#
|
13186
|
+
#
|
13187
|
+
#
|
13188
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html
|
13189
|
+
#
|
13190
|
+
# @option params [required, String] :routing_profile_id
|
13191
|
+
# The identifier of the routing profile.
|
13192
|
+
#
|
13193
|
+
# @option params [String] :next_token
|
13194
|
+
# The token for the next set of results. Use the value returned in the
|
13195
|
+
# previous response in the next request to retrieve the next set of
|
13196
|
+
# results.
|
13197
|
+
#
|
13198
|
+
# @option params [Integer] :max_results
|
13199
|
+
# The maximum number of results to return per page.
|
13200
|
+
#
|
13201
|
+
# @return [Types::ListRoutingProfileManualAssignmentQueuesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13202
|
+
#
|
13203
|
+
# * {Types::ListRoutingProfileManualAssignmentQueuesResponse#next_token #next_token} => String
|
13204
|
+
# * {Types::ListRoutingProfileManualAssignmentQueuesResponse#routing_profile_manual_assignment_queue_config_summary_list #routing_profile_manual_assignment_queue_config_summary_list} => Array<Types::RoutingProfileManualAssignmentQueueConfigSummary>
|
13205
|
+
# * {Types::ListRoutingProfileManualAssignmentQueuesResponse#last_modified_time #last_modified_time} => Time
|
13206
|
+
# * {Types::ListRoutingProfileManualAssignmentQueuesResponse#last_modified_region #last_modified_region} => String
|
13207
|
+
#
|
13208
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
13209
|
+
#
|
13210
|
+
# @example Request syntax with placeholder values
|
13211
|
+
#
|
13212
|
+
# resp = client.list_routing_profile_manual_assignment_queues({
|
13213
|
+
# instance_id: "InstanceId", # required
|
13214
|
+
# routing_profile_id: "RoutingProfileId", # required
|
13215
|
+
# next_token: "NextToken",
|
13216
|
+
# max_results: 1,
|
13217
|
+
# })
|
13218
|
+
#
|
13219
|
+
# @example Response structure
|
13220
|
+
#
|
13221
|
+
# resp.next_token #=> String
|
13222
|
+
# resp.routing_profile_manual_assignment_queue_config_summary_list #=> Array
|
13223
|
+
# resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_id #=> String
|
13224
|
+
# resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_arn #=> String
|
13225
|
+
# resp.routing_profile_manual_assignment_queue_config_summary_list[0].queue_name #=> String
|
13226
|
+
# resp.routing_profile_manual_assignment_queue_config_summary_list[0].channel #=> String, one of "VOICE", "CHAT", "TASK", "EMAIL"
|
13227
|
+
# resp.last_modified_time #=> Time
|
13228
|
+
# resp.last_modified_region #=> String
|
13229
|
+
#
|
13230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRoutingProfileManualAssignmentQueues AWS API Documentation
|
13231
|
+
#
|
13232
|
+
# @overload list_routing_profile_manual_assignment_queues(params = {})
|
13233
|
+
# @param [Hash] params ({})
|
13234
|
+
def list_routing_profile_manual_assignment_queues(params = {}, options = {})
|
13235
|
+
req = build_request(:list_routing_profile_manual_assignment_queues, params)
|
13236
|
+
req.send_request(options)
|
13237
|
+
end
|
13238
|
+
|
12901
13239
|
# Lists the queues associated with a routing profile.
|
12902
13240
|
#
|
12903
13241
|
# @option params [required, String] :instance_id
|
@@ -14670,11 +15008,15 @@ module Aws::Connect
|
|
14670
15008
|
# resp = client.search_contacts({
|
14671
15009
|
# instance_id: "InstanceId", # required
|
14672
15010
|
# time_range: { # required
|
14673
|
-
# type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP
|
15011
|
+
# type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
|
14674
15012
|
# start_time: Time.now, # required
|
14675
15013
|
# end_time: Time.now, # required
|
14676
15014
|
# },
|
14677
15015
|
# search_criteria: {
|
15016
|
+
# name: {
|
15017
|
+
# search_text: ["SearchText"], # required
|
15018
|
+
# match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
15019
|
+
# },
|
14678
15020
|
# agent_ids: ["AgentResourceId"],
|
14679
15021
|
# agent_hierarchy_groups: {
|
14680
15022
|
# l1_ids: ["HierarchyGroupId"],
|
@@ -14690,14 +15032,40 @@ module Aws::Connect
|
|
14690
15032
|
# {
|
14691
15033
|
# participant_role: "AGENT", # required, accepts AGENT, CUSTOMER, SYSTEM, CUSTOM_BOT, SUPERVISOR
|
14692
15034
|
# search_text: ["SearchText"], # required
|
14693
|
-
# match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY
|
15035
|
+
# match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
14694
15036
|
# },
|
14695
15037
|
# ],
|
14696
|
-
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
15038
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
14697
15039
|
# },
|
14698
15040
|
# },
|
14699
15041
|
# initiation_methods: ["INBOUND"], # accepts INBOUND, OUTBOUND, TRANSFER, QUEUE_TRANSFER, CALLBACK, API, DISCONNECT, MONITOR, EXTERNAL_OUTBOUND, WEBRTC_API, AGENT_REPLY, FLOW
|
14700
15042
|
# queue_ids: ["QueueId"],
|
15043
|
+
# routing_criteria: {
|
15044
|
+
# steps: [
|
15045
|
+
# {
|
15046
|
+
# agent_criteria: {
|
15047
|
+
# agent_ids: ["AgentResourceId"],
|
15048
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
15049
|
+
# },
|
15050
|
+
# },
|
15051
|
+
# ],
|
15052
|
+
# },
|
15053
|
+
# additional_time_range: {
|
15054
|
+
# criteria: [ # required
|
15055
|
+
# {
|
15056
|
+
# time_range: {
|
15057
|
+
# type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
|
15058
|
+
# start_time: Time.now, # required
|
15059
|
+
# end_time: Time.now, # required
|
15060
|
+
# },
|
15061
|
+
# timestamp_condition: {
|
15062
|
+
# type: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, ENQUEUE_TIMESTAMP
|
15063
|
+
# condition_type: "NOT_EXISTS", # required, accepts NOT_EXISTS
|
15064
|
+
# },
|
15065
|
+
# },
|
15066
|
+
# ],
|
15067
|
+
# match_type: "MATCH_ALL", # required, accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
15068
|
+
# },
|
14701
15069
|
# searchable_contact_attributes: {
|
14702
15070
|
# criteria: [ # required
|
14703
15071
|
# {
|
@@ -14705,7 +15073,7 @@ module Aws::Connect
|
|
14705
15073
|
# values: ["SearchableContactAttributeValue"], # required
|
14706
15074
|
# },
|
14707
15075
|
# ],
|
14708
|
-
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
15076
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
14709
15077
|
# },
|
14710
15078
|
# searchable_segment_attributes: {
|
14711
15079
|
# criteria: [ # required
|
@@ -14714,13 +15082,13 @@ module Aws::Connect
|
|
14714
15082
|
# values: ["SearchableSegmentAttributeValue"], # required
|
14715
15083
|
# },
|
14716
15084
|
# ],
|
14717
|
-
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY
|
15085
|
+
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
14718
15086
|
# },
|
14719
15087
|
# },
|
14720
15088
|
# max_results: 1,
|
14721
15089
|
# next_token: "LargeNextToken",
|
14722
15090
|
# sort: {
|
14723
|
-
# field_name: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, INITIATION_METHOD, CHANNEL
|
15091
|
+
# field_name: "INITIATION_TIMESTAMP", # required, accepts INITIATION_TIMESTAMP, SCHEDULED_TIMESTAMP, CONNECTED_TO_AGENT_TIMESTAMP, DISCONNECT_TIMESTAMP, INITIATION_METHOD, CHANNEL, EXPIRY_TIMESTAMP
|
14724
15092
|
# order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
|
14725
15093
|
# },
|
14726
15094
|
# })
|
@@ -14743,6 +15111,40 @@ module Aws::Connect
|
|
14743
15111
|
# resp.contacts[0].scheduled_timestamp #=> Time
|
14744
15112
|
# resp.contacts[0].segment_attributes #=> Hash
|
14745
15113
|
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_string #=> String
|
15114
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map #=> Hash
|
15115
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_string #=> String
|
15116
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_map #=> Types::SegmentAttributeValueMap
|
15117
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_integer #=> Integer
|
15118
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_list #=> Array
|
15119
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_list[0] #=> Types::SegmentAttributeValue
|
15120
|
+
# resp.contacts[0].segment_attributes["SegmentAttributeName"].value_map["SegmentAttributeName"].value_arn #=> String
|
15121
|
+
# resp.contacts[0].name #=> String
|
15122
|
+
# resp.contacts[0].routing_criteria.steps #=> Array
|
15123
|
+
# resp.contacts[0].routing_criteria.steps[0].expiry.duration_in_seconds #=> Integer
|
15124
|
+
# resp.contacts[0].routing_criteria.steps[0].expiry.expiry_timestamp #=> Time
|
15125
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.name #=> String
|
15126
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.value #=> String
|
15127
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.proficiency_level #=> Float
|
15128
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.range.min_proficiency_level #=> Float
|
15129
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.range.max_proficiency_level #=> Float
|
15130
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
|
15131
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
|
15132
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.attribute_condition.comparison_operator #=> String
|
15133
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.and_expression #=> Array
|
15134
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.and_expression[0] #=> Types::Expression
|
15135
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.or_expression #=> Array
|
15136
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.or_expression[0] #=> Types::Expression
|
15137
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.name #=> String
|
15138
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.value #=> String
|
15139
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.proficiency_level #=> Float
|
15140
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.range.min_proficiency_level #=> Float
|
15141
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.range.max_proficiency_level #=> Float
|
15142
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids #=> Array
|
15143
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.match_criteria.agents_criteria.agent_ids[0] #=> String
|
15144
|
+
# resp.contacts[0].routing_criteria.steps[0].expression.not_attribute_condition.comparison_operator #=> String
|
15145
|
+
# resp.contacts[0].routing_criteria.steps[0].status #=> String, one of "ACTIVE", "INACTIVE", "JOINED", "EXPIRED"
|
15146
|
+
# resp.contacts[0].routing_criteria.activation_timestamp #=> Time
|
15147
|
+
# resp.contacts[0].routing_criteria.index #=> Integer
|
14746
15148
|
# resp.next_token #=> String
|
14747
15149
|
# resp.total_count #=> Integer
|
14748
15150
|
#
|
@@ -15070,15 +15472,30 @@ module Aws::Connect
|
|
15070
15472
|
req.send_request(options)
|
15071
15473
|
end
|
15072
15474
|
|
15073
|
-
# Searches predefined attributes that meet certain criteria.
|
15074
|
-
#
|
15075
|
-
#
|
15076
|
-
#
|
15077
|
-
#
|
15475
|
+
# Searches predefined attributes that meet certain criteria. A
|
15476
|
+
# *predefined attribute* is made up of a name and a value. You can use
|
15477
|
+
# predefined attributes for:
|
15478
|
+
#
|
15479
|
+
# * Routing proficiency (for example, agent certification) that has
|
15480
|
+
# predefined values (for example, a list of possible certifications).
|
15481
|
+
# For more information, see [Create predefined attributes for routing
|
15482
|
+
# contacts to agents][1].
|
15483
|
+
#
|
15484
|
+
# * Contact information that varies between transfers or conferences,
|
15485
|
+
# such as the name of the business unit handling the contact. For more
|
15486
|
+
# information, see [Use contact segment attributes][2].
|
15487
|
+
#
|
15488
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
15489
|
+
# quotas][3].
|
15490
|
+
#
|
15491
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
15078
15492
|
#
|
15079
15493
|
#
|
15080
15494
|
#
|
15081
15495
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
15496
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
15497
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
15498
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
15082
15499
|
#
|
15083
15500
|
# @option params [required, String] :instance_id
|
15084
15501
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -15134,6 +15551,10 @@ module Aws::Connect
|
|
15134
15551
|
# resp.predefined_attributes[0].name #=> String
|
15135
15552
|
# resp.predefined_attributes[0].values.string_list #=> Array
|
15136
15553
|
# resp.predefined_attributes[0].values.string_list[0] #=> String
|
15554
|
+
# resp.predefined_attributes[0].purposes #=> Array
|
15555
|
+
# resp.predefined_attributes[0].purposes[0] #=> String
|
15556
|
+
# resp.predefined_attributes[0].attribute_configuration.enable_value_validation_on_association #=> Boolean
|
15557
|
+
# resp.predefined_attributes[0].attribute_configuration.is_read_only #=> Boolean
|
15137
15558
|
# resp.predefined_attributes[0].last_modified_time #=> Time
|
15138
15559
|
# resp.predefined_attributes[0].last_modified_region #=> String
|
15139
15560
|
# resp.next_token #=> String
|
@@ -15677,6 +16098,7 @@ module Aws::Connect
|
|
15677
16098
|
# resp.routing_profiles[0].tags #=> Hash
|
15678
16099
|
# resp.routing_profiles[0].tags["TagKey"] #=> String
|
15679
16100
|
# resp.routing_profiles[0].number_of_associated_queues #=> Integer
|
16101
|
+
# resp.routing_profiles[0].number_of_associated_manual_assignment_queues #=> Integer
|
15680
16102
|
# resp.routing_profiles[0].number_of_associated_users #=> Integer
|
15681
16103
|
# resp.routing_profiles[0].agent_availability_timer #=> String, one of "TIME_SINCE_LAST_ACTIVITY", "TIME_SINCE_LAST_INBOUND"
|
15682
16104
|
# resp.routing_profiles[0].last_modified_time #=> Time
|
@@ -15684,6 +16106,8 @@ module Aws::Connect
|
|
15684
16106
|
# resp.routing_profiles[0].is_default #=> Boolean
|
15685
16107
|
# resp.routing_profiles[0].associated_queue_ids #=> Array
|
15686
16108
|
# resp.routing_profiles[0].associated_queue_ids[0] #=> String
|
16109
|
+
# resp.routing_profiles[0].associated_manual_assignment_queue_ids #=> Array
|
16110
|
+
# resp.routing_profiles[0].associated_manual_assignment_queue_ids[0] #=> String
|
15687
16111
|
# resp.next_token #=> String
|
15688
16112
|
# resp.approximate_total_count #=> Integer
|
15689
16113
|
#
|
@@ -16111,6 +16535,7 @@ module Aws::Connect
|
|
16111
16535
|
# resp.users[0].phone_config.auto_accept #=> Boolean
|
16112
16536
|
# resp.users[0].phone_config.after_contact_work_time_limit #=> Integer
|
16113
16537
|
# resp.users[0].phone_config.desk_phone_number #=> String
|
16538
|
+
# resp.users[0].phone_config.persistent_connection #=> Boolean
|
16114
16539
|
# resp.users[0].routing_profile_id #=> String
|
16115
16540
|
# resp.users[0].security_profile_ids #=> Array
|
16116
16541
|
# resp.users[0].security_profile_ids[0] #=> String
|
@@ -16702,6 +17127,12 @@ module Aws::Connect
|
|
16702
17127
|
# },
|
16703
17128
|
# },
|
16704
17129
|
# value_integer: 1,
|
17130
|
+
# value_list: [
|
17131
|
+
# {
|
17132
|
+
# # recursive SegmentAttributeValue
|
17133
|
+
# },
|
17134
|
+
# ],
|
17135
|
+
# value_arn: "SegmentAttributeValueString",
|
16705
17136
|
# },
|
16706
17137
|
# },
|
16707
17138
|
# customer_id: "CustomerIdNonEmpty",
|
@@ -17098,6 +17529,12 @@ module Aws::Connect
|
|
17098
17529
|
# },
|
17099
17530
|
# },
|
17100
17531
|
# value_integer: 1,
|
17532
|
+
# value_list: [
|
17533
|
+
# {
|
17534
|
+
# # recursive SegmentAttributeValue
|
17535
|
+
# },
|
17536
|
+
# ],
|
17537
|
+
# value_arn: "SegmentAttributeValueString",
|
17101
17538
|
# },
|
17102
17539
|
# },
|
17103
17540
|
# client_token: "ClientToken",
|
@@ -17258,6 +17695,12 @@ module Aws::Connect
|
|
17258
17695
|
# },
|
17259
17696
|
# },
|
17260
17697
|
# value_integer: 1,
|
17698
|
+
# value_list: [
|
17699
|
+
# {
|
17700
|
+
# # recursive SegmentAttributeValue
|
17701
|
+
# },
|
17702
|
+
# ],
|
17703
|
+
# value_arn: "SegmentAttributeValueString",
|
17261
17704
|
# },
|
17262
17705
|
# },
|
17263
17706
|
# attributes: {
|
@@ -17819,6 +18262,12 @@ module Aws::Connect
|
|
17819
18262
|
# },
|
17820
18263
|
# },
|
17821
18264
|
# value_integer: 1,
|
18265
|
+
# value_list: [
|
18266
|
+
# {
|
18267
|
+
# # recursive SegmentAttributeValue
|
18268
|
+
# },
|
18269
|
+
# ],
|
18270
|
+
# value_arn: "SegmentAttributeValueString",
|
17822
18271
|
# },
|
17823
18272
|
# },
|
17824
18273
|
# })
|
@@ -18649,8 +19098,9 @@ module Aws::Connect
|
|
18649
19098
|
# This field can be used to show channel subtype, such as
|
18650
19099
|
# `connect:Guide`.
|
18651
19100
|
#
|
18652
|
-
#
|
18653
|
-
# updated by using the
|
19101
|
+
# Contact Expiry, and user-defined attributes (String - String) that are
|
19102
|
+
# defined in predefined attributes, can be updated by using the
|
19103
|
+
# UpdateContact API.
|
18654
19104
|
#
|
18655
19105
|
# @option params [Types::QueueInfoInput] :queue_info
|
18656
19106
|
# Information about the queue associated with a contact. This parameter
|
@@ -18723,6 +19173,12 @@ module Aws::Connect
|
|
18723
19173
|
# },
|
18724
19174
|
# },
|
18725
19175
|
# value_integer: 1,
|
19176
|
+
# value_list: [
|
19177
|
+
# {
|
19178
|
+
# # recursive SegmentAttributeValue
|
19179
|
+
# },
|
19180
|
+
# ],
|
19181
|
+
# value_arn: "SegmentAttributeValueString",
|
18726
19182
|
# },
|
18727
19183
|
# },
|
18728
19184
|
# queue_info: {
|
@@ -19572,7 +20028,7 @@ module Aws::Connect
|
|
19572
20028
|
# The date from when the hours of operation override would be effective.
|
19573
20029
|
#
|
19574
20030
|
# @option params [String] :effective_till
|
19575
|
-
# The date
|
20031
|
+
# The date until the hours of operation override is effective.
|
19576
20032
|
#
|
19577
20033
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
19578
20034
|
#
|
@@ -20006,14 +20462,34 @@ module Aws::Connect
|
|
20006
20462
|
end
|
20007
20463
|
|
20008
20464
|
# Updates a predefined attribute for the specified Amazon Connect
|
20009
|
-
# instance. *
|
20010
|
-
# instance that can be used to route contacts to an agent or pools of
|
20011
|
-
# agents within a queue. For more information, see [Create predefined
|
20012
|
-
# attributes for routing contacts to agents][1].
|
20465
|
+
# instance. A *predefined attribute* is made up of a name and a value.
|
20013
20466
|
#
|
20467
|
+
# For the predefined attributes per instance quota, see [Amazon Connect
|
20468
|
+
# quotas][1].
|
20014
20469
|
#
|
20470
|
+
# **Use cases**
|
20015
20471
|
#
|
20016
|
-
#
|
20472
|
+
# Following are common uses cases for this API:
|
20473
|
+
#
|
20474
|
+
# * Update routing proficiency (for example, agent certification) that
|
20475
|
+
# has predefined values (for example, a list of possible
|
20476
|
+
# certifications). For more information, see [Create predefined
|
20477
|
+
# attributes for routing contacts to agents][2].
|
20478
|
+
#
|
20479
|
+
# * Update an attribute for business unit name that has a list of
|
20480
|
+
# predefined business unit names used in your organization. This is a
|
20481
|
+
# use case where information for a contact varies between transfers or
|
20482
|
+
# conferences. For more information, see [Use contact segment
|
20483
|
+
# attributes][3].
|
20484
|
+
#
|
20485
|
+
# **Endpoints**: See [Amazon Connect endpoints and quotas][4].
|
20486
|
+
#
|
20487
|
+
#
|
20488
|
+
#
|
20489
|
+
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas
|
20490
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html
|
20491
|
+
# [3]: https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html
|
20492
|
+
# [4]: https://docs.aws.amazon.com/general/latest/gr/connect_region.html
|
20017
20493
|
#
|
20018
20494
|
# @option params [required, String] :instance_id
|
20019
20495
|
# The identifier of the Amazon Connect instance. You can find the
|
@@ -20025,6 +20501,16 @@ module Aws::Connect
|
|
20025
20501
|
# @option params [Types::PredefinedAttributeValues] :values
|
20026
20502
|
# The values of the predefined attribute.
|
20027
20503
|
#
|
20504
|
+
# @option params [Array<String>] :purposes
|
20505
|
+
# Values that enable you to categorize your predefined attributes. You
|
20506
|
+
# can use them in custom UI elements across the Amazon Connect admin
|
20507
|
+
# website.
|
20508
|
+
#
|
20509
|
+
# @option params [Types::InputPredefinedAttributeConfiguration] :attribute_configuration
|
20510
|
+
# Custom metadata that is associated to predefined attributes to control
|
20511
|
+
# behavior in upstream services, such as controlling how a predefined
|
20512
|
+
# attribute should be displayed in the Amazon Connect admin website.
|
20513
|
+
#
|
20028
20514
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
20029
20515
|
#
|
20030
20516
|
# @example Request syntax with placeholder values
|
@@ -20035,6 +20521,10 @@ module Aws::Connect
|
|
20035
20521
|
# values: {
|
20036
20522
|
# string_list: ["PredefinedAttributeStringValue"],
|
20037
20523
|
# },
|
20524
|
+
# purposes: ["PredefinedAttributePurposeName"],
|
20525
|
+
# attribute_configuration: {
|
20526
|
+
# enable_value_validation_on_association: false,
|
20527
|
+
# },
|
20038
20528
|
# })
|
20039
20529
|
#
|
20040
20530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/UpdatePredefinedAttribute AWS API Documentation
|
@@ -21314,6 +21804,7 @@ module Aws::Connect
|
|
21314
21804
|
# auto_accept: false,
|
21315
21805
|
# after_contact_work_time_limit: 1,
|
21316
21806
|
# desk_phone_number: "PhoneNumber",
|
21807
|
+
# persistent_connection: false,
|
21317
21808
|
# },
|
21318
21809
|
# user_id: "UserId", # required
|
21319
21810
|
# instance_id: "InstanceId", # required
|
@@ -21562,7 +22053,7 @@ module Aws::Connect
|
|
21562
22053
|
tracer: tracer
|
21563
22054
|
)
|
21564
22055
|
context[:gem_name] = 'aws-sdk-connect'
|
21565
|
-
context[:gem_version] = '1.
|
22056
|
+
context[:gem_version] = '1.218.0'
|
21566
22057
|
Seahorse::Client::Request.new(handlers, context)
|
21567
22058
|
end
|
21568
22059
|
|