aws-sdk-connect 1.167.0 → 1.169.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-connect/client.rb +534 -139
- data/lib/aws-sdk-connect/client_api.rb +146 -0
- data/lib/aws-sdk-connect/endpoints.rb +28 -0
- data/lib/aws-sdk-connect/plugins/endpoints.rb +4 -0
- data/lib/aws-sdk-connect/types.rb +701 -167
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +125 -1
- data/sig/types.rbs +100 -1
- metadata +2 -2
@@ -7476,6 +7476,8 @@ module Aws::Connect
|
|
7476
7476
|
#
|
7477
7477
|
# * Agents
|
7478
7478
|
#
|
7479
|
+
# * Campaigns
|
7480
|
+
#
|
7479
7481
|
# * Channels
|
7480
7482
|
#
|
7481
7483
|
# * Feature
|
@@ -7491,6 +7493,9 @@ module Aws::Connect
|
|
7491
7493
|
# At least one filter must be passed from queues, routing profiles,
|
7492
7494
|
# agents, or user hierarchy groups.
|
7493
7495
|
#
|
7496
|
+
# For metrics for outbound campaigns analytics, you can also use
|
7497
|
+
# campaigns to satisfy at least one filter requirement.
|
7498
|
+
#
|
7494
7499
|
# To filter by phone number, see [Create a historical metrics report][1]
|
7495
7500
|
# in the *Amazon Connect Administrator Guide*.
|
7496
7501
|
#
|
@@ -7500,12 +7505,13 @@ module Aws::Connect
|
|
7500
7505
|
# single request. Valid filter keys: `AGENT` \|
|
7501
7506
|
# `AGENT_HIERARCHY_LEVEL_ONE` \| `AGENT_HIERARCHY_LEVEL_TWO` \|
|
7502
7507
|
# `AGENT_HIERARCHY_LEVEL_THREE` \| `AGENT_HIERARCHY_LEVEL_FOUR` \|
|
7503
|
-
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `
|
7504
|
-
# \| `
|
7505
|
-
#
|
7506
|
-
# `
|
7507
|
-
# `
|
7508
|
-
# `
|
7508
|
+
# `AGENT_HIERARCHY_LEVEL_FIVE` \| `ANSWERING_MACHINE_DETECTION_STATUS`
|
7509
|
+
# \| `CAMPAIGN` \| `CASE_TEMPLATE_ARN` \| `CASE_STATUS` \| `CHANNEL`
|
7510
|
+
# \| `contact/segmentAttributes/connect:Subtype` \|
|
7511
|
+
# `DISCONNECT_REASON` \| `FEATURE` \| `FLOW_TYPE` \|
|
7512
|
+
# `FLOWS_NEXT_RESOURCE_ID` \| `FLOWS_NEXT_RESOURCE_QUEUE_ID` \|
|
7513
|
+
# `FLOWS_OUTCOME_TYPE` \| `FLOWS_RESOURCE_ID` \| `INITIATION_METHOD`
|
7514
|
+
# \| `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
7509
7515
|
# `ROUTING_STEP_EXPRESSION` \| `QUEUE` \| `Q_CONNECT_ENABLED` \|
|
7510
7516
|
#
|
7511
7517
|
# * **Filter values**: A maximum of 100 filter values are supported in a
|
@@ -7539,9 +7545,13 @@ module Aws::Connect
|
|
7539
7545
|
#
|
7540
7546
|
# This filter is available only for contact record-driven metrics.
|
7541
7547
|
#
|
7548
|
+
# [Campaign][2] ARNs are valid `filterValues` for the `CAMPAIGN`
|
7549
|
+
# filter key.
|
7550
|
+
#
|
7542
7551
|
#
|
7543
7552
|
#
|
7544
7553
|
# [1]: https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html
|
7554
|
+
# [2]: https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html
|
7545
7555
|
#
|
7546
7556
|
# @option params [Array<String>] :groupings
|
7547
7557
|
# The grouping applied to the metrics that are returned. For example,
|
@@ -7554,11 +7564,12 @@ module Aws::Connect
|
|
7554
7564
|
# Valid grouping keys: `AGENT` \| `AGENT_HIERARCHY_LEVEL_ONE` \|
|
7555
7565
|
# `AGENT_HIERARCHY_LEVEL_TWO` \| `AGENT_HIERARCHY_LEVEL_THREE` \|
|
7556
7566
|
# `AGENT_HIERARCHY_LEVEL_FOUR` \| `AGENT_HIERARCHY_LEVEL_FIVE` \|
|
7567
|
+
# `ANSWERING_MACHINE_DETECTION_STATUS` \| `CAMPAIGN` \|
|
7557
7568
|
# `CASE_TEMPLATE_ARN` \| `CASE_STATUS` \| `CHANNEL` \|
|
7558
|
-
# `contact/segmentAttributes/connect:Subtype` \| `
|
7559
|
-
# `
|
7560
|
-
# `
|
7561
|
-
# `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
7569
|
+
# `contact/segmentAttributes/connect:Subtype` \| `DISCONNECT_REASON` \|
|
7570
|
+
# `FLOWS_RESOURCE_ID` \| `FLOWS_MODULE_RESOURCE_ID` \| `FLOW_TYPE` \|
|
7571
|
+
# `FLOWS_OUTCOME_TYPE` \| `INITIATION_METHOD` \| `Q_CONNECT_ENABLED` \|
|
7572
|
+
# `QUEUE` \| `RESOURCE_PUBLISHED_TIMESTAMP` \| `ROUTING_PROFILE` \|
|
7562
7573
|
# `ROUTING_STEP_EXPRESSION`
|
7563
7574
|
#
|
7564
7575
|
# @option params [required, Array<Types::MetricV2>] :metrics
|
@@ -7766,6 +7777,17 @@ module Aws::Connect
|
|
7766
7777
|
#
|
7767
7778
|
# UI name: [Average conversation duration][20]
|
7768
7779
|
#
|
7780
|
+
# AVG\_DIALS\_PER\_MINUTE
|
7781
|
+
#
|
7782
|
+
# : This metric is available only for contacts analyzed by outbound
|
7783
|
+
# campaigns analytics.
|
7784
|
+
#
|
7785
|
+
# Unit: Count
|
7786
|
+
#
|
7787
|
+
# Valid groupings and filters: Campaign, Agent, Queue, Routing Profile
|
7788
|
+
#
|
7789
|
+
# UI name: [Average dials per minute][21]
|
7790
|
+
#
|
7769
7791
|
# AVG\_FLOW\_TIME
|
7770
7792
|
#
|
7771
7793
|
# : Unit: Seconds
|
@@ -7776,7 +7798,7 @@ module Aws::Connect
|
|
7776
7798
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
7777
7799
|
# published timestamp
|
7778
7800
|
#
|
7779
|
-
# UI name: [Average flow time][
|
7801
|
+
# UI name: [Average flow time][22]
|
7780
7802
|
#
|
7781
7803
|
# AVG\_GREETING\_TIME\_AGENT
|
7782
7804
|
#
|
@@ -7789,7 +7811,7 @@ module Aws::Connect
|
|
7789
7811
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7790
7812
|
# Connect
|
7791
7813
|
#
|
7792
|
-
# UI name: [Average agent greeting time][
|
7814
|
+
# UI name: [Average agent greeting time][23]
|
7793
7815
|
#
|
7794
7816
|
# AVG\_HANDLE\_TIME
|
7795
7817
|
#
|
@@ -7799,7 +7821,7 @@ module Aws::Connect
|
|
7799
7821
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
7800
7822
|
# RoutingStepExpression
|
7801
7823
|
#
|
7802
|
-
# UI name: [Average handle time][
|
7824
|
+
# UI name: [Average handle time][24]
|
7803
7825
|
#
|
7804
7826
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7805
7827
|
#
|
@@ -7813,7 +7835,7 @@ module Aws::Connect
|
|
7813
7835
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
7814
7836
|
# Q in Connect
|
7815
7837
|
#
|
7816
|
-
# UI name: [Average customer hold time][
|
7838
|
+
# UI name: [Average customer hold time][25]
|
7817
7839
|
#
|
7818
7840
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7819
7841
|
#
|
@@ -7827,7 +7849,7 @@ module Aws::Connect
|
|
7827
7849
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7828
7850
|
# Connect
|
7829
7851
|
#
|
7830
|
-
# UI name: [Average customer hold time all contacts][
|
7852
|
+
# UI name: [Average customer hold time all contacts][26]
|
7831
7853
|
#
|
7832
7854
|
# AVG\_HOLDS
|
7833
7855
|
#
|
@@ -7837,7 +7859,7 @@ module Aws::Connect
|
|
7837
7859
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
7838
7860
|
# Q in Connect
|
7839
7861
|
#
|
7840
|
-
# UI name: [Average holds][
|
7862
|
+
# UI name: [Average holds][27]
|
7841
7863
|
#
|
7842
7864
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7843
7865
|
#
|
@@ -7851,7 +7873,7 @@ module Aws::Connect
|
|
7851
7873
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7852
7874
|
# Connect
|
7853
7875
|
#
|
7854
|
-
# UI name: [Average agent interaction and customer hold time][
|
7876
|
+
# UI name: [Average agent interaction and customer hold time][28]
|
7855
7877
|
#
|
7856
7878
|
# AVG\_INTERACTION\_TIME
|
7857
7879
|
#
|
@@ -7862,7 +7884,7 @@ module Aws::Connect
|
|
7862
7884
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7863
7885
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
7864
7886
|
#
|
7865
|
-
# UI name: [Average agent interaction time][
|
7887
|
+
# UI name: [Average agent interaction time][29]
|
7866
7888
|
#
|
7867
7889
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7868
7890
|
#
|
@@ -7879,7 +7901,7 @@ module Aws::Connect
|
|
7879
7901
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7880
7902
|
# Connect
|
7881
7903
|
#
|
7882
|
-
# UI name: [Average agent interruptions][
|
7904
|
+
# UI name: [Average agent interruptions][30]
|
7883
7905
|
#
|
7884
7906
|
# AVG\_INTERRUPTION\_TIME\_AGENT
|
7885
7907
|
#
|
@@ -7892,7 +7914,7 @@ module Aws::Connect
|
|
7892
7914
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7893
7915
|
# Connect
|
7894
7916
|
#
|
7895
|
-
# UI name: [Average agent interruption time][
|
7917
|
+
# UI name: [Average agent interruption time][31]
|
7896
7918
|
#
|
7897
7919
|
# AVG\_NON\_TALK\_TIME
|
7898
7920
|
#
|
@@ -7905,7 +7927,7 @@ module Aws::Connect
|
|
7905
7927
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7906
7928
|
# Connect
|
7907
7929
|
#
|
7908
|
-
# UI name: [Average non-talk time][
|
7930
|
+
# UI name: [Average non-talk time][32]
|
7909
7931
|
#
|
7910
7932
|
# AVG\_QUEUE\_ANSWER\_TIME
|
7911
7933
|
#
|
@@ -7914,7 +7936,7 @@ module Aws::Connect
|
|
7914
7936
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7915
7937
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
7916
7938
|
#
|
7917
|
-
# UI name: [Average queue answer time][
|
7939
|
+
# UI name: [Average queue answer time][33]
|
7918
7940
|
#
|
7919
7941
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7920
7942
|
#
|
@@ -7927,7 +7949,7 @@ module Aws::Connect
|
|
7927
7949
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7928
7950
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
7929
7951
|
#
|
7930
|
-
# UI name: [Average resolution time][
|
7952
|
+
# UI name: [Average resolution time][34]
|
7931
7953
|
#
|
7932
7954
|
# AVG\_TALK\_TIME
|
7933
7955
|
#
|
@@ -7940,7 +7962,7 @@ module Aws::Connect
|
|
7940
7962
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7941
7963
|
# Connect
|
7942
7964
|
#
|
7943
|
-
# UI name: [Average talk time][
|
7965
|
+
# UI name: [Average talk time][35]
|
7944
7966
|
#
|
7945
7967
|
# AVG\_TALK\_TIME\_AGENT
|
7946
7968
|
#
|
@@ -7953,7 +7975,7 @@ module Aws::Connect
|
|
7953
7975
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7954
7976
|
# Connect
|
7955
7977
|
#
|
7956
|
-
# UI name: [Average agent talk time][
|
7978
|
+
# UI name: [Average agent talk time][36]
|
7957
7979
|
#
|
7958
7980
|
# AVG\_TALK\_TIME\_CUSTOMER
|
7959
7981
|
#
|
@@ -7966,7 +7988,48 @@ module Aws::Connect
|
|
7966
7988
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
7967
7989
|
# Connect
|
7968
7990
|
#
|
7969
|
-
# UI name: [Average customer talk time][
|
7991
|
+
# UI name: [Average customer talk time][37]
|
7992
|
+
#
|
7993
|
+
# AVG\_WAIT\_TIME\_AFTER\_CUSTOMER\_CONNECTION
|
7994
|
+
#
|
7995
|
+
# : This metric is available only for contacts analyzed by outbound
|
7996
|
+
# campaigns analytics.
|
7997
|
+
#
|
7998
|
+
# Unit: Seconds
|
7999
|
+
#
|
8000
|
+
# Valid groupings and filters: Campaign
|
8001
|
+
#
|
8002
|
+
# UI name: [Average wait time after customer connection][38]
|
8003
|
+
#
|
8004
|
+
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X
|
8005
|
+
#
|
8006
|
+
# : This metric is available only for contacts analyzed by outbound
|
8007
|
+
# campaigns analytics.
|
8008
|
+
#
|
8009
|
+
# Unit: Count
|
8010
|
+
#
|
8011
|
+
# Valid groupings and filters: Campaign, Agent
|
8012
|
+
#
|
8013
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8014
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8015
|
+
# `GT` (for *Greater than*).
|
8016
|
+
#
|
8017
|
+
# UI name: [Campaign contacts abandoned after X][39]
|
8018
|
+
#
|
8019
|
+
# CAMPAIGN\_CONTACTS\_ABANDONED\_AFTER\_X\_RATE
|
8020
|
+
#
|
8021
|
+
# : This metric is available only for contacts analyzed by outbound
|
8022
|
+
# campaigns analytics.
|
8023
|
+
#
|
8024
|
+
# Unit: Percent
|
8025
|
+
#
|
8026
|
+
# Valid groupings and filters: Campaign, Agent
|
8027
|
+
#
|
8028
|
+
# Threshold: For `ThresholdValue`, enter any whole number from 1 to
|
8029
|
+
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8030
|
+
# `GT` (for *Greater than*).
|
8031
|
+
#
|
8032
|
+
# UI name: [Campaign contacts abandoned after X rate][40]
|
7970
8033
|
#
|
7971
8034
|
# CASES\_CREATED
|
7972
8035
|
#
|
@@ -7976,7 +8039,7 @@ module Aws::Connect
|
|
7976
8039
|
#
|
7977
8040
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
7978
8041
|
#
|
7979
|
-
# UI name: [Cases created][
|
8042
|
+
# UI name: [Cases created][41]
|
7980
8043
|
#
|
7981
8044
|
# CONTACTS\_CREATED
|
7982
8045
|
#
|
@@ -7987,7 +8050,7 @@ module Aws::Connect
|
|
7987
8050
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
7988
8051
|
# Feature, contact/segmentAttributes/connect:Subtype, Q in Connect
|
7989
8052
|
#
|
7990
|
-
# UI name: [Contacts created][
|
8053
|
+
# UI name: [Contacts created][42]
|
7991
8054
|
#
|
7992
8055
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
7993
8056
|
#
|
@@ -8003,7 +8066,7 @@ module Aws::Connect
|
|
8003
8066
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
8004
8067
|
# RoutingStepExpression, Q in Connect
|
8005
8068
|
#
|
8006
|
-
# UI name: [API contacts handled][
|
8069
|
+
# UI name: [API contacts handled][43]
|
8007
8070
|
#
|
8008
8071
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8009
8072
|
#
|
@@ -8018,7 +8081,7 @@ module Aws::Connect
|
|
8018
8081
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
8019
8082
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8020
8083
|
#
|
8021
|
-
# UI name: [Contacts handled (connected to agent timestamp)][
|
8084
|
+
# UI name: [Contacts handled (connected to agent timestamp)][44]
|
8022
8085
|
#
|
8023
8086
|
# CONTACTS\_HOLD\_ABANDONS
|
8024
8087
|
#
|
@@ -8028,7 +8091,7 @@ module Aws::Connect
|
|
8028
8091
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8029
8092
|
# Connect
|
8030
8093
|
#
|
8031
|
-
# UI name: [Contacts hold disconnect][
|
8094
|
+
# UI name: [Contacts hold disconnect][44]
|
8032
8095
|
#
|
8033
8096
|
# CONTACTS\_ON\_HOLD\_AGENT\_DISCONNECT
|
8034
8097
|
#
|
@@ -8037,7 +8100,7 @@ module Aws::Connect
|
|
8037
8100
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8038
8101
|
# Agent Hierarchy, Q in Connect
|
8039
8102
|
#
|
8040
|
-
# UI name: [Contacts hold agent disconnect][
|
8103
|
+
# UI name: [Contacts hold agent disconnect][45]
|
8041
8104
|
#
|
8042
8105
|
# CONTACTS\_ON\_HOLD\_CUSTOMER\_DISCONNECT
|
8043
8106
|
#
|
@@ -8046,7 +8109,7 @@ module Aws::Connect
|
|
8046
8109
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8047
8110
|
# Agent Hierarchy, Q in Connect
|
8048
8111
|
#
|
8049
|
-
# UI name: [Contacts hold customer disconnect][
|
8112
|
+
# UI name: [Contacts hold customer disconnect][46]
|
8050
8113
|
#
|
8051
8114
|
# CONTACTS\_PUT\_ON\_HOLD
|
8052
8115
|
#
|
@@ -8055,7 +8118,7 @@ module Aws::Connect
|
|
8055
8118
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8056
8119
|
# Agent Hierarchy, Q in Connect
|
8057
8120
|
#
|
8058
|
-
# UI name: [Contacts put on hold][
|
8121
|
+
# UI name: [Contacts put on hold][46]
|
8059
8122
|
#
|
8060
8123
|
# CONTACTS\_TRANSFERRED\_OUT\_EXTERNAL
|
8061
8124
|
#
|
@@ -8064,7 +8127,7 @@ module Aws::Connect
|
|
8064
8127
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8065
8128
|
# Agent Hierarchy, Q in Connect
|
8066
8129
|
#
|
8067
|
-
# UI name: [Contacts transferred out external][
|
8130
|
+
# UI name: [Contacts transferred out external][47]
|
8068
8131
|
#
|
8069
8132
|
# CONTACTS\_TRANSFERRED\_OUT\_INTERNAL
|
8070
8133
|
#
|
@@ -8073,7 +8136,7 @@ module Aws::Connect
|
|
8073
8136
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8074
8137
|
# Agent Hierarchy, Q in Connect
|
8075
8138
|
#
|
8076
|
-
# UI name: [Contacts transferred out internal][
|
8139
|
+
# UI name: [Contacts transferred out internal][48]
|
8077
8140
|
#
|
8078
8141
|
# CONTACTS\_QUEUED
|
8079
8142
|
#
|
@@ -8083,7 +8146,7 @@ module Aws::Connect
|
|
8083
8146
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8084
8147
|
# Connect
|
8085
8148
|
#
|
8086
|
-
# UI name: [Contacts queued][
|
8149
|
+
# UI name: [Contacts queued][49]
|
8087
8150
|
#
|
8088
8151
|
# CONTACTS\_QUEUED\_BY\_ENQUEUE
|
8089
8152
|
#
|
@@ -8092,7 +8155,7 @@ module Aws::Connect
|
|
8092
8155
|
# Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
8093
8156
|
# contact/segmentAttributes/connect:Subtype
|
8094
8157
|
#
|
8095
|
-
# UI name: [Contacts queued (enqueue timestamp)][
|
8158
|
+
# UI name: [Contacts queued (enqueue timestamp)][50]
|
8096
8159
|
#
|
8097
8160
|
# CONTACTS\_REMOVED\_FROM\_QUEUE\_IN\_X
|
8098
8161
|
#
|
@@ -8105,8 +8168,7 @@ module Aws::Connect
|
|
8105
8168
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8106
8169
|
# `LT` (for "Less than").
|
8107
8170
|
#
|
8108
|
-
# UI name:
|
8109
|
-
# website.
|
8171
|
+
# UI name: [Contacts removed from queue in X seconds][51]
|
8110
8172
|
#
|
8111
8173
|
# CONTACTS\_RESOLVED\_IN\_X
|
8112
8174
|
#
|
@@ -8119,7 +8181,7 @@ module Aws::Connect
|
|
8119
8181
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8120
8182
|
# `LT` (for "Less than").
|
8121
8183
|
#
|
8122
|
-
# UI name: [Contacts resolved in X][
|
8184
|
+
# UI name: [Contacts resolved in X][52]
|
8123
8185
|
#
|
8124
8186
|
# CONTACTS\_TRANSFERRED\_OUT
|
8125
8187
|
#
|
@@ -8129,7 +8191,7 @@ module Aws::Connect
|
|
8129
8191
|
# Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype,
|
8130
8192
|
# Q in Connect
|
8131
8193
|
#
|
8132
|
-
# UI name: [Contacts transferred out][
|
8194
|
+
# UI name: [Contacts transferred out][53]
|
8133
8195
|
#
|
8134
8196
|
# <note markdown="1"> Feature is a valid filter but not a valid grouping.
|
8135
8197
|
#
|
@@ -8143,7 +8205,7 @@ module Aws::Connect
|
|
8143
8205
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8144
8206
|
# Connect
|
8145
8207
|
#
|
8146
|
-
# UI name: [Contacts transferred out by agent][
|
8208
|
+
# UI name: [Contacts transferred out by agent][54]
|
8147
8209
|
#
|
8148
8210
|
# CONTACTS\_TRANSFERRED\_OUT\_FROM\_QUEUE
|
8149
8211
|
#
|
@@ -8153,7 +8215,7 @@ module Aws::Connect
|
|
8153
8215
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8154
8216
|
# Connect
|
8155
8217
|
#
|
8156
|
-
# UI name: [Contacts transferred out queue][
|
8218
|
+
# UI name: [Contacts transferred out queue][54]
|
8157
8219
|
#
|
8158
8220
|
# CURRENT\_CASES
|
8159
8221
|
#
|
@@ -8163,7 +8225,43 @@ module Aws::Connect
|
|
8163
8225
|
#
|
8164
8226
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8165
8227
|
#
|
8166
|
-
# UI name: [Current cases][
|
8228
|
+
# UI name: [Current cases][55]
|
8229
|
+
#
|
8230
|
+
# DELIVERY\_ATTEMPTS
|
8231
|
+
#
|
8232
|
+
# : This metric is available only for contacts analyzed by outbound
|
8233
|
+
# campaigns analytics.
|
8234
|
+
#
|
8235
|
+
# Unit: Count
|
8236
|
+
#
|
8237
|
+
# Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
|
8238
|
+
# `DISCONNECT_REASON`
|
8239
|
+
#
|
8240
|
+
# Valid groupings and filters: Campaign, Agent, Queue, Routing
|
8241
|
+
# Profile, Answering Machine Detection Status, Disconnect Reason
|
8242
|
+
#
|
8243
|
+
# UI name: [Delivery attempts][56]
|
8244
|
+
#
|
8245
|
+
# DELIVERY\_ATTEMPT\_DISPOSITION\_RATE
|
8246
|
+
#
|
8247
|
+
# : This metric is available only for contacts analyzed by outbound
|
8248
|
+
# campaigns analytics, and with the answering machine detection
|
8249
|
+
# enabled.
|
8250
|
+
#
|
8251
|
+
# Unit: Percent
|
8252
|
+
#
|
8253
|
+
# Valid metric filter key: `ANSWERING_MACHINE_DETECTION_STATUS`,
|
8254
|
+
# `DISCONNECT_REASON`
|
8255
|
+
#
|
8256
|
+
# Valid groupings and filters: Campaign, Agent, Answering Machine
|
8257
|
+
# Detection Status, Disconnect Reason
|
8258
|
+
#
|
8259
|
+
# <note markdown="1"> Answering Machine Detection Status and Disconnect Reason are valid
|
8260
|
+
# filters but not valid groupings.
|
8261
|
+
#
|
8262
|
+
# </note>
|
8263
|
+
#
|
8264
|
+
# UI name: [Delivery attempt disposition rate][57]
|
8167
8265
|
#
|
8168
8266
|
# FLOWS\_OUTCOME
|
8169
8267
|
#
|
@@ -8175,7 +8273,7 @@ module Aws::Connect
|
|
8175
8273
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8176
8274
|
# published timestamp
|
8177
8275
|
#
|
8178
|
-
# UI name: [Flows outcome][
|
8276
|
+
# UI name: [Flows outcome][58]
|
8179
8277
|
#
|
8180
8278
|
# FLOWS\_STARTED
|
8181
8279
|
#
|
@@ -8186,7 +8284,19 @@ module Aws::Connect
|
|
8186
8284
|
# resource ID, Flows resource ID, Initiation method, Resource
|
8187
8285
|
# published timestamp
|
8188
8286
|
#
|
8189
|
-
# UI name: [Flows started][
|
8287
|
+
# UI name: [Flows started][59]
|
8288
|
+
#
|
8289
|
+
# HUMAN\_ANSWERED\_CALLS
|
8290
|
+
#
|
8291
|
+
# : This metric is available only for contacts analyzed by outbound
|
8292
|
+
# campaigns analytics, and with the answering machine detection
|
8293
|
+
# enabled.
|
8294
|
+
#
|
8295
|
+
# Unit: Count
|
8296
|
+
#
|
8297
|
+
# Valid groupings and filters: Campaign, Agent
|
8298
|
+
#
|
8299
|
+
# UI name: [Human answered][60]
|
8190
8300
|
#
|
8191
8301
|
# MAX\_FLOW\_TIME
|
8192
8302
|
#
|
@@ -8198,7 +8308,7 @@ module Aws::Connect
|
|
8198
8308
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8199
8309
|
# published timestamp
|
8200
8310
|
#
|
8201
|
-
# UI name: [Maximum flow time][
|
8311
|
+
# UI name: [Maximum flow time][61]
|
8202
8312
|
#
|
8203
8313
|
# MAX\_QUEUED\_TIME
|
8204
8314
|
#
|
@@ -8208,7 +8318,7 @@ module Aws::Connect
|
|
8208
8318
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8209
8319
|
# Connect
|
8210
8320
|
#
|
8211
|
-
# UI name: [Maximum queued time][
|
8321
|
+
# UI name: [Maximum queued time][62]
|
8212
8322
|
#
|
8213
8323
|
# MIN\_FLOW\_TIME
|
8214
8324
|
#
|
@@ -8220,7 +8330,7 @@ module Aws::Connect
|
|
8220
8330
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8221
8331
|
# published timestamp
|
8222
8332
|
#
|
8223
|
-
# UI name: [Minimum flow time][
|
8333
|
+
# UI name: [Minimum flow time][63]
|
8224
8334
|
#
|
8225
8335
|
# PERCENT\_CASES\_FIRST\_CONTACT\_RESOLVED
|
8226
8336
|
#
|
@@ -8230,7 +8340,7 @@ module Aws::Connect
|
|
8230
8340
|
#
|
8231
8341
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8232
8342
|
#
|
8233
|
-
# UI name: [Cases resolved on first contact][
|
8343
|
+
# UI name: [Cases resolved on first contact][64]
|
8234
8344
|
#
|
8235
8345
|
# PERCENT\_CONTACTS\_STEP\_EXPIRED
|
8236
8346
|
#
|
@@ -8262,7 +8372,7 @@ module Aws::Connect
|
|
8262
8372
|
# Flows outcome type, Flows resource ID, Initiation method, Resource
|
8263
8373
|
# published timestamp
|
8264
8374
|
#
|
8265
|
-
# UI name: [Flows outcome percentage][
|
8375
|
+
# UI name: [Flows outcome percentage][65].
|
8266
8376
|
#
|
8267
8377
|
# <note markdown="1"> The `FLOWS_OUTCOME_TYPE` is not a valid grouping.
|
8268
8378
|
#
|
@@ -8279,7 +8389,7 @@ module Aws::Connect
|
|
8279
8389
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8280
8390
|
# Connect
|
8281
8391
|
#
|
8282
|
-
# UI name: [Non-talk time percent][
|
8392
|
+
# UI name: [Non-talk time percent][66]
|
8283
8393
|
#
|
8284
8394
|
# PERCENT\_TALK\_TIME
|
8285
8395
|
#
|
@@ -8292,7 +8402,7 @@ module Aws::Connect
|
|
8292
8402
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8293
8403
|
# Connect
|
8294
8404
|
#
|
8295
|
-
# UI name: [Talk time percent][
|
8405
|
+
# UI name: [Talk time percent][67]
|
8296
8406
|
#
|
8297
8407
|
# PERCENT\_TALK\_TIME\_AGENT
|
8298
8408
|
#
|
@@ -8305,7 +8415,7 @@ module Aws::Connect
|
|
8305
8415
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8306
8416
|
# Connect
|
8307
8417
|
#
|
8308
|
-
# UI name: [Agent talk time percent][
|
8418
|
+
# UI name: [Agent talk time percent][68]
|
8309
8419
|
#
|
8310
8420
|
# PERCENT\_TALK\_TIME\_CUSTOMER
|
8311
8421
|
#
|
@@ -8318,7 +8428,7 @@ module Aws::Connect
|
|
8318
8428
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8319
8429
|
# Connect
|
8320
8430
|
#
|
8321
|
-
# UI name: [Customer talk time percent][
|
8431
|
+
# UI name: [Customer talk time percent][69]
|
8322
8432
|
#
|
8323
8433
|
# REOPENED\_CASE\_ACTIONS
|
8324
8434
|
#
|
@@ -8328,7 +8438,7 @@ module Aws::Connect
|
|
8328
8438
|
#
|
8329
8439
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8330
8440
|
#
|
8331
|
-
# UI name: [Cases reopened][
|
8441
|
+
# UI name: [Cases reopened][70]
|
8332
8442
|
#
|
8333
8443
|
# RESOLVED\_CASE\_ACTIONS
|
8334
8444
|
#
|
@@ -8338,7 +8448,7 @@ module Aws::Connect
|
|
8338
8448
|
#
|
8339
8449
|
# Valid groupings and filters: CASE\_TEMPLATE\_ARN, CASE\_STATUS
|
8340
8450
|
#
|
8341
|
-
# UI name: [Cases resolved][
|
8451
|
+
# UI name: [Cases resolved][71]
|
8342
8452
|
#
|
8343
8453
|
# SERVICE\_LEVEL
|
8344
8454
|
#
|
@@ -8353,7 +8463,7 @@ module Aws::Connect
|
|
8353
8463
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8354
8464
|
# `LT` (for "Less than").
|
8355
8465
|
#
|
8356
|
-
# UI name: [Service level X][
|
8466
|
+
# UI name: [Service level X][72]
|
8357
8467
|
#
|
8358
8468
|
# STEP\_CONTACTS\_QUEUED
|
8359
8469
|
#
|
@@ -8371,7 +8481,7 @@ module Aws::Connect
|
|
8371
8481
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8372
8482
|
# Agent Hierarchy, Q in Connect
|
8373
8483
|
#
|
8374
|
-
# UI name: [After contact work time][
|
8484
|
+
# UI name: [After contact work time][73]
|
8375
8485
|
#
|
8376
8486
|
# SUM\_CONNECTING\_TIME\_AGENT
|
8377
8487
|
#
|
@@ -8384,7 +8494,7 @@ module Aws::Connect
|
|
8384
8494
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8385
8495
|
# Agent Hierarchy
|
8386
8496
|
#
|
8387
|
-
# UI name: [Agent API connecting time][
|
8497
|
+
# UI name: [Agent API connecting time][74]
|
8388
8498
|
#
|
8389
8499
|
# <note markdown="1"> The `Negate` key in Metric Level Filters is not applicable for this
|
8390
8500
|
# metric.
|
@@ -8406,7 +8516,7 @@ module Aws::Connect
|
|
8406
8516
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype,
|
8407
8517
|
# RoutingStepExpression, Q in Connect
|
8408
8518
|
#
|
8409
|
-
# UI name: [Contact abandoned][
|
8519
|
+
# UI name: [Contact abandoned][75]
|
8410
8520
|
#
|
8411
8521
|
# SUM\_CONTACTS\_ABANDONED\_IN\_X
|
8412
8522
|
#
|
@@ -8419,7 +8529,7 @@ module Aws::Connect
|
|
8419
8529
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8420
8530
|
# `LT` (for "Less than").
|
8421
8531
|
#
|
8422
|
-
# UI name: [Contacts abandoned in X seconds][
|
8532
|
+
# UI name: [Contacts abandoned in X seconds][76]
|
8423
8533
|
#
|
8424
8534
|
# SUM\_CONTACTS\_ANSWERED\_IN\_X
|
8425
8535
|
#
|
@@ -8432,7 +8542,7 @@ module Aws::Connect
|
|
8432
8542
|
# 604800 (inclusive), in seconds. For `Comparison`, you must enter
|
8433
8543
|
# `LT` (for "Less than").
|
8434
8544
|
#
|
8435
|
-
# UI name: [Contacts answered in X seconds][
|
8545
|
+
# UI name: [Contacts answered in X seconds][77]
|
8436
8546
|
#
|
8437
8547
|
# SUM\_CONTACT\_FLOW\_TIME
|
8438
8548
|
#
|
@@ -8441,7 +8551,7 @@ module Aws::Connect
|
|
8441
8551
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8442
8552
|
# Agent Hierarchy, Q in Connect
|
8443
8553
|
#
|
8444
|
-
# UI name: [Contact flow time][
|
8554
|
+
# UI name: [Contact flow time][78]
|
8445
8555
|
#
|
8446
8556
|
# SUM\_CONTACT\_TIME\_AGENT
|
8447
8557
|
#
|
@@ -8449,7 +8559,7 @@ module Aws::Connect
|
|
8449
8559
|
#
|
8450
8560
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8451
8561
|
#
|
8452
|
-
# UI name: [Agent on contact time][
|
8562
|
+
# UI name: [Agent on contact time][79]
|
8453
8563
|
#
|
8454
8564
|
# SUM\_CONTACTS\_DISCONNECTED
|
8455
8565
|
#
|
@@ -8461,7 +8571,7 @@ module Aws::Connect
|
|
8461
8571
|
# Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in
|
8462
8572
|
# Connect
|
8463
8573
|
#
|
8464
|
-
# UI name: [Contact disconnected][
|
8574
|
+
# UI name: [Contact disconnected][80]
|
8465
8575
|
#
|
8466
8576
|
# SUM\_ERROR\_STATUS\_TIME\_AGENT
|
8467
8577
|
#
|
@@ -8469,7 +8579,7 @@ module Aws::Connect
|
|
8469
8579
|
#
|
8470
8580
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8471
8581
|
#
|
8472
|
-
# UI name: [Error status time][
|
8582
|
+
# UI name: [Error status time][81]
|
8473
8583
|
#
|
8474
8584
|
# SUM\_HANDLE\_TIME
|
8475
8585
|
#
|
@@ -8478,7 +8588,7 @@ module Aws::Connect
|
|
8478
8588
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8479
8589
|
# Agent Hierarchy, Q in Connect
|
8480
8590
|
#
|
8481
|
-
# UI name: [Contact handle time][
|
8591
|
+
# UI name: [Contact handle time][82]
|
8482
8592
|
#
|
8483
8593
|
# SUM\_HOLD\_TIME
|
8484
8594
|
#
|
@@ -8487,7 +8597,7 @@ module Aws::Connect
|
|
8487
8597
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8488
8598
|
# Agent Hierarchy, Q in Connect
|
8489
8599
|
#
|
8490
|
-
# UI name: [Customer hold time][
|
8600
|
+
# UI name: [Customer hold time][83]
|
8491
8601
|
#
|
8492
8602
|
# SUM\_IDLE\_TIME\_AGENT
|
8493
8603
|
#
|
@@ -8495,7 +8605,7 @@ module Aws::Connect
|
|
8495
8605
|
#
|
8496
8606
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8497
8607
|
#
|
8498
|
-
# UI name: [Agent idle time][
|
8608
|
+
# UI name: [Agent idle time][84]
|
8499
8609
|
#
|
8500
8610
|
# SUM\_INTERACTION\_AND\_HOLD\_TIME
|
8501
8611
|
#
|
@@ -8504,7 +8614,7 @@ module Aws::Connect
|
|
8504
8614
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8505
8615
|
# Agent Hierarchy, Q in Connect
|
8506
8616
|
#
|
8507
|
-
# UI name: [Agent interaction and hold time][
|
8617
|
+
# UI name: [Agent interaction and hold time][85]
|
8508
8618
|
#
|
8509
8619
|
# SUM\_INTERACTION\_TIME
|
8510
8620
|
#
|
@@ -8513,7 +8623,7 @@ module Aws::Connect
|
|
8513
8623
|
# Valid groupings and filters: Queue, Channel, Routing Profile, Agent,
|
8514
8624
|
# Agent Hierarchy
|
8515
8625
|
#
|
8516
|
-
# UI name: [Agent interaction time][
|
8626
|
+
# UI name: [Agent interaction time][86]
|
8517
8627
|
#
|
8518
8628
|
# SUM\_NON\_PRODUCTIVE\_TIME\_AGENT
|
8519
8629
|
#
|
@@ -8521,7 +8631,7 @@ module Aws::Connect
|
|
8521
8631
|
#
|
8522
8632
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8523
8633
|
#
|
8524
|
-
# UI name: [Non-Productive Time][
|
8634
|
+
# UI name: [Non-Productive Time][87]
|
8525
8635
|
#
|
8526
8636
|
# SUM\_ONLINE\_TIME\_AGENT
|
8527
8637
|
#
|
@@ -8529,7 +8639,7 @@ module Aws::Connect
|
|
8529
8639
|
#
|
8530
8640
|
# Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
|
8531
8641
|
#
|
8532
|
-
# UI name: [Online time][
|
8642
|
+
# UI name: [Online time][88]
|
8533
8643
|
#
|
8534
8644
|
# SUM\_RETRY\_CALLBACK\_ATTEMPTS
|
8535
8645
|
#
|
@@ -8538,7 +8648,7 @@ module Aws::Connect
|
|
8538
8648
|
# Valid groupings and filters: Queue, Channel, Routing Profile,
|
8539
8649
|
# contact/segmentAttributes/connect:Subtype, Q in Connect
|
8540
8650
|
#
|
8541
|
-
# UI name: [Callback attempts][
|
8651
|
+
# UI name: [Callback attempts][89]
|
8542
8652
|
#
|
8543
8653
|
#
|
8544
8654
|
#
|
@@ -8562,67 +8672,75 @@ module Aws::Connect
|
|
8562
8672
|
# [18]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical
|
8563
8673
|
# [19]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical
|
8564
8674
|
# [20]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical
|
8565
|
-
# [21]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8566
|
-
# [22]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8567
|
-
# [23]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8568
|
-
# [24]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8569
|
-
# [25]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8570
|
-
# [26]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8571
|
-
# [27]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8572
|
-
# [28]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical
|
8573
|
-
# [29]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8574
|
-
# [30]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-
|
8575
|
-
# [31]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
8576
|
-
# [32]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
8577
|
-
# [33]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8578
|
-
# [34]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-
|
8579
|
-
# [35]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-
|
8580
|
-
# [36]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-
|
8581
|
-
# [37]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html
|
8582
|
-
# [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8583
|
-
# [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8584
|
-
# [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8585
|
-
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8586
|
-
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8587
|
-
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8588
|
-
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8589
|
-
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8590
|
-
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8591
|
-
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8592
|
-
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
|
8593
|
-
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-
|
8594
|
-
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8595
|
-
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8596
|
-
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8597
|
-
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8598
|
-
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8599
|
-
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8600
|
-
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8601
|
-
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8602
|
-
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8603
|
-
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8604
|
-
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8605
|
-
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8606
|
-
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8607
|
-
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8608
|
-
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8609
|
-
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8610
|
-
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8611
|
-
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8612
|
-
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8613
|
-
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8614
|
-
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8615
|
-
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8616
|
-
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8617
|
-
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8618
|
-
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8619
|
-
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8620
|
-
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8621
|
-
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8622
|
-
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8623
|
-
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8624
|
-
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8625
|
-
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#
|
8675
|
+
# [21]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical
|
8676
|
+
# [22]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical
|
8677
|
+
# [23]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical
|
8678
|
+
# [24]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical
|
8679
|
+
# [25]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical
|
8680
|
+
# [26]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical
|
8681
|
+
# [27]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical
|
8682
|
+
# [28]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical
|
8683
|
+
# [29]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical
|
8684
|
+
# [30]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical
|
8685
|
+
# [31]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical
|
8686
|
+
# [32]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical
|
8687
|
+
# [33]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical
|
8688
|
+
# [34]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical
|
8689
|
+
# [35]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical
|
8690
|
+
# [36]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical
|
8691
|
+
# [37]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical
|
8692
|
+
# [38]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical
|
8693
|
+
# [39]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical
|
8694
|
+
# [40]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical
|
8695
|
+
# [41]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical
|
8696
|
+
# [42]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical
|
8697
|
+
# [43]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical
|
8698
|
+
# [44]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical
|
8699
|
+
# [45]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical
|
8700
|
+
# [46]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical
|
8701
|
+
# [47]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical
|
8702
|
+
# [48]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical
|
8703
|
+
# [49]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical
|
8704
|
+
# [50]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical
|
8705
|
+
# [51]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical
|
8706
|
+
# [52]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical
|
8707
|
+
# [53]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical
|
8708
|
+
# [54]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical
|
8709
|
+
# [55]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical
|
8710
|
+
# [56]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical
|
8711
|
+
# [57]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical
|
8712
|
+
# [58]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical
|
8713
|
+
# [59]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical
|
8714
|
+
# [60]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical
|
8715
|
+
# [61]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical
|
8716
|
+
# [62]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical
|
8717
|
+
# [63]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical
|
8718
|
+
# [64]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical
|
8719
|
+
# [65]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical
|
8720
|
+
# [66]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical
|
8721
|
+
# [67]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical
|
8722
|
+
# [68]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical
|
8723
|
+
# [69]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical
|
8724
|
+
# [70]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical
|
8725
|
+
# [71]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical
|
8726
|
+
# [72]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical
|
8727
|
+
# [73]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical
|
8728
|
+
# [74]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time
|
8729
|
+
# [75]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical
|
8730
|
+
# [76]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical
|
8731
|
+
# [77]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical
|
8732
|
+
# [78]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical
|
8733
|
+
# [79]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical
|
8734
|
+
# [80]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical
|
8735
|
+
# [81]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical
|
8736
|
+
# [82]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical
|
8737
|
+
# [83]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical
|
8738
|
+
# [84]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica
|
8739
|
+
# [85]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical
|
8740
|
+
# [86]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical
|
8741
|
+
# [87]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical
|
8742
|
+
# [88]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical
|
8743
|
+
# [89]: https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical
|
8626
8744
|
#
|
8627
8745
|
# @option params [String] :next_token
|
8628
8746
|
# The token for the next set of results. Use the value returned in the
|
@@ -10698,7 +10816,7 @@ module Aws::Connect
|
|
10698
10816
|
# max_results: 1,
|
10699
10817
|
# next_token: "LargeNextToken",
|
10700
10818
|
# output_type: "Raw", # required, accepts Raw, Redacted
|
10701
|
-
# segment_types: ["Transcript"], # required, accepts Transcript, Categories, Issues, Event, Attachments
|
10819
|
+
# segment_types: ["Transcript"], # required, accepts Transcript, Categories, Issues, Event, Attachments, PostContactSummary
|
10702
10820
|
# })
|
10703
10821
|
#
|
10704
10822
|
# @example Response structure
|
@@ -10745,6 +10863,9 @@ module Aws::Connect
|
|
10745
10863
|
# resp.segments[0].attachments.attachments[0].attachment_id #=> String
|
10746
10864
|
# resp.segments[0].attachments.attachments[0].status #=> String, one of "APPROVED", "REJECTED", "IN_PROGRESS"
|
10747
10865
|
# resp.segments[0].attachments.time.absolute_time #=> Time
|
10866
|
+
# resp.segments[0].post_contact_summary.content #=> String
|
10867
|
+
# resp.segments[0].post_contact_summary.status #=> String, one of "FAILED", "COMPLETED"
|
10868
|
+
# resp.segments[0].post_contact_summary.failure_code #=> String, one of "QUOTA_EXCEEDED", "INSUFFICIENT_CONVERSATION_CONTENT", "FAILED_SAFETY_GUIDELINES", "INVALID_ANALYSIS_CONFIGURATION", "INTERNAL_ERROR"
|
10748
10869
|
# resp.next_token #=> String
|
10749
10870
|
#
|
10750
10871
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ListRealtimeContactAnalysisSegmentsV2 AWS API Documentation
|
@@ -12069,6 +12190,112 @@ module Aws::Connect
|
|
12069
12190
|
req.send_request(options)
|
12070
12191
|
end
|
12071
12192
|
|
12193
|
+
# Searches AgentStatuses in an Amazon Connect instance, with optional
|
12194
|
+
# filtering.
|
12195
|
+
#
|
12196
|
+
# @option params [required, String] :instance_id
|
12197
|
+
# The identifier of the Amazon Connect instance. You can find the
|
12198
|
+
# instanceId in the ARN of the instance.
|
12199
|
+
#
|
12200
|
+
# @option params [String] :next_token
|
12201
|
+
# The token for the next set of results. Use the value returned in the
|
12202
|
+
# previous response in the next request to retrieve the next set of
|
12203
|
+
# results.
|
12204
|
+
#
|
12205
|
+
# @option params [Integer] :max_results
|
12206
|
+
# The maximum number of results to return per page.
|
12207
|
+
#
|
12208
|
+
# @option params [Types::AgentStatusSearchFilter] :search_filter
|
12209
|
+
# Filters to be applied to search results.
|
12210
|
+
#
|
12211
|
+
# @option params [Types::AgentStatusSearchCriteria] :search_criteria
|
12212
|
+
# The search criteria to be used to return agent statuses.
|
12213
|
+
#
|
12214
|
+
# @return [Types::SearchAgentStatusesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
12215
|
+
#
|
12216
|
+
# * {Types::SearchAgentStatusesResponse#agent_statuses #agent_statuses} => Array<Types::AgentStatus>
|
12217
|
+
# * {Types::SearchAgentStatusesResponse#next_token #next_token} => String
|
12218
|
+
# * {Types::SearchAgentStatusesResponse#approximate_total_count #approximate_total_count} => Integer
|
12219
|
+
#
|
12220
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
12221
|
+
#
|
12222
|
+
# @example Request syntax with placeholder values
|
12223
|
+
#
|
12224
|
+
# resp = client.search_agent_statuses({
|
12225
|
+
# instance_id: "InstanceId", # required
|
12226
|
+
# next_token: "NextToken2500",
|
12227
|
+
# max_results: 1,
|
12228
|
+
# search_filter: {
|
12229
|
+
# attribute_filter: {
|
12230
|
+
# or_conditions: [
|
12231
|
+
# {
|
12232
|
+
# tag_conditions: [
|
12233
|
+
# {
|
12234
|
+
# tag_key: "String",
|
12235
|
+
# tag_value: "String",
|
12236
|
+
# },
|
12237
|
+
# ],
|
12238
|
+
# },
|
12239
|
+
# ],
|
12240
|
+
# and_condition: {
|
12241
|
+
# tag_conditions: [
|
12242
|
+
# {
|
12243
|
+
# tag_key: "String",
|
12244
|
+
# tag_value: "String",
|
12245
|
+
# },
|
12246
|
+
# ],
|
12247
|
+
# },
|
12248
|
+
# tag_condition: {
|
12249
|
+
# tag_key: "String",
|
12250
|
+
# tag_value: "String",
|
12251
|
+
# },
|
12252
|
+
# },
|
12253
|
+
# },
|
12254
|
+
# search_criteria: {
|
12255
|
+
# or_conditions: [
|
12256
|
+
# {
|
12257
|
+
# # recursive AgentStatusSearchCriteria
|
12258
|
+
# },
|
12259
|
+
# ],
|
12260
|
+
# and_conditions: [
|
12261
|
+
# {
|
12262
|
+
# # recursive AgentStatusSearchCriteria
|
12263
|
+
# },
|
12264
|
+
# ],
|
12265
|
+
# string_condition: {
|
12266
|
+
# field_name: "String",
|
12267
|
+
# value: "String",
|
12268
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
12269
|
+
# },
|
12270
|
+
# },
|
12271
|
+
# })
|
12272
|
+
#
|
12273
|
+
# @example Response structure
|
12274
|
+
#
|
12275
|
+
# resp.agent_statuses #=> Array
|
12276
|
+
# resp.agent_statuses[0].agent_status_arn #=> String
|
12277
|
+
# resp.agent_statuses[0].agent_status_id #=> String
|
12278
|
+
# resp.agent_statuses[0].name #=> String
|
12279
|
+
# resp.agent_statuses[0].description #=> String
|
12280
|
+
# resp.agent_statuses[0].type #=> String, one of "ROUTABLE", "CUSTOM", "OFFLINE"
|
12281
|
+
# resp.agent_statuses[0].display_order #=> Integer
|
12282
|
+
# resp.agent_statuses[0].state #=> String, one of "ENABLED", "DISABLED"
|
12283
|
+
# resp.agent_statuses[0].tags #=> Hash
|
12284
|
+
# resp.agent_statuses[0].tags["TagKey"] #=> String
|
12285
|
+
# resp.agent_statuses[0].last_modified_time #=> Time
|
12286
|
+
# resp.agent_statuses[0].last_modified_region #=> String
|
12287
|
+
# resp.next_token #=> String
|
12288
|
+
# resp.approximate_total_count #=> Integer
|
12289
|
+
#
|
12290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchAgentStatuses AWS API Documentation
|
12291
|
+
#
|
12292
|
+
# @overload search_agent_statuses(params = {})
|
12293
|
+
# @param [Hash] params ({})
|
12294
|
+
def search_agent_statuses(params = {}, options = {})
|
12295
|
+
req = build_request(:search_agent_statuses, params)
|
12296
|
+
req.send_request(options)
|
12297
|
+
end
|
12298
|
+
|
12072
12299
|
# Searches for available phone numbers that you can claim to your Amazon
|
12073
12300
|
# Connect instance or traffic distribution group. If the provided
|
12074
12301
|
# `TargetArn` is a traffic distribution group, you can call this API in
|
@@ -12993,6 +13220,24 @@ module Aws::Connect
|
|
12993
13220
|
# provided or if any empty list is provided, this API will search from
|
12994
13221
|
# all supported resource types.
|
12995
13222
|
#
|
13223
|
+
# **Supported resource types**
|
13224
|
+
#
|
13225
|
+
# * AGENT
|
13226
|
+
#
|
13227
|
+
# * ROUTING\_PROFILE
|
13228
|
+
#
|
13229
|
+
# * STANDARD\_QUEUE
|
13230
|
+
#
|
13231
|
+
# * SECURITY\_PROFILE
|
13232
|
+
#
|
13233
|
+
# * OPERATING\_HOURS
|
13234
|
+
#
|
13235
|
+
# * PROMPT
|
13236
|
+
#
|
13237
|
+
# * CONTACT\_FLOW
|
13238
|
+
#
|
13239
|
+
# * FLOW\_MODULE
|
13240
|
+
#
|
12996
13241
|
# @option params [String] :next_token
|
12997
13242
|
# The token for the next set of results. Use the value returned in the
|
12998
13243
|
# previous response in the next request to retrieve the next set of
|
@@ -13278,6 +13523,138 @@ module Aws::Connect
|
|
13278
13523
|
req.send_request(options)
|
13279
13524
|
end
|
13280
13525
|
|
13526
|
+
# Searches UserHierarchyGroups in an Amazon Connect instance, with
|
13527
|
+
# optional filtering.
|
13528
|
+
#
|
13529
|
+
# The UserHierarchyGroup with `"LevelId": "0"` is the foundation for
|
13530
|
+
# building levels on top of an instance. It is not user-definable, nor
|
13531
|
+
# is it visible in the UI.
|
13532
|
+
#
|
13533
|
+
# @option params [required, String] :instance_id
|
13534
|
+
# The identifier of the Amazon Connect instance. You can find the
|
13535
|
+
# instanceId in the ARN of the instance.
|
13536
|
+
#
|
13537
|
+
# @option params [String] :next_token
|
13538
|
+
# The token for the next set of results. Use the value returned in the
|
13539
|
+
# previous response in the next request to retrieve the next set of
|
13540
|
+
# results.
|
13541
|
+
#
|
13542
|
+
# @option params [Integer] :max_results
|
13543
|
+
# The maximum number of results to return per page.
|
13544
|
+
#
|
13545
|
+
# @option params [Types::UserHierarchyGroupSearchFilter] :search_filter
|
13546
|
+
# Filters to be applied to search results.
|
13547
|
+
#
|
13548
|
+
# @option params [Types::UserHierarchyGroupSearchCriteria] :search_criteria
|
13549
|
+
# The search criteria to be used to return UserHierarchyGroups.
|
13550
|
+
#
|
13551
|
+
# @return [Types::SearchUserHierarchyGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
13552
|
+
#
|
13553
|
+
# * {Types::SearchUserHierarchyGroupsResponse#user_hierarchy_groups #user_hierarchy_groups} => Array<Types::HierarchyGroup>
|
13554
|
+
# * {Types::SearchUserHierarchyGroupsResponse#next_token #next_token} => String
|
13555
|
+
# * {Types::SearchUserHierarchyGroupsResponse#approximate_total_count #approximate_total_count} => Integer
|
13556
|
+
#
|
13557
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
13558
|
+
#
|
13559
|
+
# @example Request syntax with placeholder values
|
13560
|
+
#
|
13561
|
+
# resp = client.search_user_hierarchy_groups({
|
13562
|
+
# instance_id: "InstanceId", # required
|
13563
|
+
# next_token: "NextToken2500",
|
13564
|
+
# max_results: 1,
|
13565
|
+
# search_filter: {
|
13566
|
+
# attribute_filter: {
|
13567
|
+
# or_conditions: [
|
13568
|
+
# {
|
13569
|
+
# tag_conditions: [
|
13570
|
+
# {
|
13571
|
+
# tag_key: "String",
|
13572
|
+
# tag_value: "String",
|
13573
|
+
# },
|
13574
|
+
# ],
|
13575
|
+
# },
|
13576
|
+
# ],
|
13577
|
+
# and_condition: {
|
13578
|
+
# tag_conditions: [
|
13579
|
+
# {
|
13580
|
+
# tag_key: "String",
|
13581
|
+
# tag_value: "String",
|
13582
|
+
# },
|
13583
|
+
# ],
|
13584
|
+
# },
|
13585
|
+
# tag_condition: {
|
13586
|
+
# tag_key: "String",
|
13587
|
+
# tag_value: "String",
|
13588
|
+
# },
|
13589
|
+
# },
|
13590
|
+
# },
|
13591
|
+
# search_criteria: {
|
13592
|
+
# or_conditions: [
|
13593
|
+
# {
|
13594
|
+
# # recursive UserHierarchyGroupSearchCriteria
|
13595
|
+
# },
|
13596
|
+
# ],
|
13597
|
+
# and_conditions: [
|
13598
|
+
# {
|
13599
|
+
# # recursive UserHierarchyGroupSearchCriteria
|
13600
|
+
# },
|
13601
|
+
# ],
|
13602
|
+
# string_condition: {
|
13603
|
+
# field_name: "String",
|
13604
|
+
# value: "String",
|
13605
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13606
|
+
# },
|
13607
|
+
# },
|
13608
|
+
# })
|
13609
|
+
#
|
13610
|
+
# @example Response structure
|
13611
|
+
#
|
13612
|
+
# resp.user_hierarchy_groups #=> Array
|
13613
|
+
# resp.user_hierarchy_groups[0].id #=> String
|
13614
|
+
# resp.user_hierarchy_groups[0].arn #=> String
|
13615
|
+
# resp.user_hierarchy_groups[0].name #=> String
|
13616
|
+
# resp.user_hierarchy_groups[0].level_id #=> String
|
13617
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_one.id #=> String
|
13618
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_one.arn #=> String
|
13619
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_one.name #=> String
|
13620
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_one.last_modified_time #=> Time
|
13621
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_one.last_modified_region #=> String
|
13622
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_two.id #=> String
|
13623
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_two.arn #=> String
|
13624
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_two.name #=> String
|
13625
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_two.last_modified_time #=> Time
|
13626
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_two.last_modified_region #=> String
|
13627
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_three.id #=> String
|
13628
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_three.arn #=> String
|
13629
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_three.name #=> String
|
13630
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_three.last_modified_time #=> Time
|
13631
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_three.last_modified_region #=> String
|
13632
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_four.id #=> String
|
13633
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_four.arn #=> String
|
13634
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_four.name #=> String
|
13635
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_four.last_modified_time #=> Time
|
13636
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_four.last_modified_region #=> String
|
13637
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_five.id #=> String
|
13638
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_five.arn #=> String
|
13639
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_five.name #=> String
|
13640
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_five.last_modified_time #=> Time
|
13641
|
+
# resp.user_hierarchy_groups[0].hierarchy_path.level_five.last_modified_region #=> String
|
13642
|
+
# resp.user_hierarchy_groups[0].tags #=> Hash
|
13643
|
+
# resp.user_hierarchy_groups[0].tags["TagKey"] #=> String
|
13644
|
+
# resp.user_hierarchy_groups[0].last_modified_time #=> Time
|
13645
|
+
# resp.user_hierarchy_groups[0].last_modified_region #=> String
|
13646
|
+
# resp.next_token #=> String
|
13647
|
+
# resp.approximate_total_count #=> Integer
|
13648
|
+
#
|
13649
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchUserHierarchyGroups AWS API Documentation
|
13650
|
+
#
|
13651
|
+
# @overload search_user_hierarchy_groups(params = {})
|
13652
|
+
# @param [Hash] params ({})
|
13653
|
+
def search_user_hierarchy_groups(params = {}, options = {})
|
13654
|
+
req = build_request(:search_user_hierarchy_groups, params)
|
13655
|
+
req.send_request(options)
|
13656
|
+
end
|
13657
|
+
|
13281
13658
|
# Searches users in an Amazon Connect instance, with optional filtering.
|
13282
13659
|
#
|
13283
13660
|
# <note markdown="1"> `AfterContactWorkTimeLimit` is returned in milliseconds.
|
@@ -13406,6 +13783,24 @@ module Aws::Connect
|
|
13406
13783
|
# value: "String",
|
13407
13784
|
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13408
13785
|
# },
|
13786
|
+
# list_condition: {
|
13787
|
+
# target_list_type: "PROFICIENCIES", # accepts PROFICIENCIES
|
13788
|
+
# conditions: [
|
13789
|
+
# {
|
13790
|
+
# string_condition: {
|
13791
|
+
# field_name: "String",
|
13792
|
+
# value: "String",
|
13793
|
+
# comparison_type: "STARTS_WITH", # accepts STARTS_WITH, CONTAINS, EXACT
|
13794
|
+
# },
|
13795
|
+
# number_condition: {
|
13796
|
+
# field_name: "String",
|
13797
|
+
# min_value: 1,
|
13798
|
+
# max_value: 1,
|
13799
|
+
# comparison_type: "GREATER_OR_EQUAL", # accepts GREATER_OR_EQUAL, GREATER, LESSER_OR_EQUAL, LESSER, EQUAL, NOT_EQUAL, RANGE
|
13800
|
+
# },
|
13801
|
+
# },
|
13802
|
+
# ],
|
13803
|
+
# },
|
13409
13804
|
# hierarchy_group_condition: {
|
13410
13805
|
# value: "String",
|
13411
13806
|
# hierarchy_group_match_type: "EXACT", # accepts EXACT, WITH_CHILD_GROUPS
|
@@ -17750,7 +18145,7 @@ module Aws::Connect
|
|
17750
18145
|
params: params,
|
17751
18146
|
config: config)
|
17752
18147
|
context[:gem_name] = 'aws-sdk-connect'
|
17753
|
-
context[:gem_version] = '1.
|
18148
|
+
context[:gem_version] = '1.169.0'
|
17754
18149
|
Seahorse::Client::Request.new(handlers, context)
|
17755
18150
|
end
|
17756
18151
|
|