aws-sdk-connect 1.238.0 → 1.240.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 +62 -19
- data/lib/aws-sdk-connect/client_api.rb +2 -0
- data/lib/aws-sdk-connect/types.rb +64 -12
- data/lib/aws-sdk-connect.rb +1 -1
- data/sig/client.rbs +24 -4
- data/sig/types.rbs +6 -4
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cb921746c184c54810fdf1b42c004e30a5091bf9aa9fcfff393744f6af7b3835
|
|
4
|
+
data.tar.gz: 45a033801fa115a9e99a1c87f5614316c207b2e13abdd660242432f7dece03f9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cd20724d5defc9ad17ea08b22f7b4360d7636959451d63d396d2dfa9d56f57dd7352b77349efc40fe9a2f658f4565d33984e9bc89efca5254dcc5eeee5ad9e22
|
|
7
|
+
data.tar.gz: 5ecc45bf9ceb2806ebf01df00df0d5579bbf2ecb62be8ff754b5829c54337c4dee9bdb9e24d0e2c4169d7e92a38f767c9c8254d35476d77b10218ed2714c940e
|
data/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
Unreleased Changes
|
|
2
2
|
------------------
|
|
3
3
|
|
|
4
|
+
1.240.0 (2026-01-30)
|
|
5
|
+
------------------
|
|
6
|
+
|
|
7
|
+
* Feature - This release adds Estimated Wait Time support to the GetContactMetrics API for Amazon Connect.
|
|
8
|
+
|
|
9
|
+
1.239.0 (2026-01-28)
|
|
10
|
+
------------------
|
|
11
|
+
|
|
12
|
+
* Feature - Adds support for filtering search results based on tags assigned to contacts.
|
|
13
|
+
|
|
4
14
|
1.238.0 (2026-01-27)
|
|
5
15
|
------------------
|
|
6
16
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
1.
|
|
1
|
+
1.240.0
|
|
@@ -10375,28 +10375,32 @@ module Aws::Connect
|
|
|
10375
10375
|
req.send_request(options)
|
|
10376
10376
|
end
|
|
10377
10377
|
|
|
10378
|
-
# Retrieves
|
|
10378
|
+
# Retrieves contact metric data for a specified contact.
|
|
10379
10379
|
#
|
|
10380
10380
|
# **Use cases**
|
|
10381
10381
|
#
|
|
10382
|
-
# Following are common
|
|
10382
|
+
# Following are common use cases for position in queue and estimated
|
|
10383
|
+
# wait time:
|
|
10383
10384
|
#
|
|
10384
|
-
# *
|
|
10385
|
+
# * Customer-Facing Wait Time Announcements - Display or announce the
|
|
10386
|
+
# estimated wait time and position in queue to customers before or
|
|
10387
|
+
# during their queue experience.
|
|
10385
10388
|
#
|
|
10386
|
-
# *
|
|
10387
|
-
#
|
|
10389
|
+
# * Callback Offerings - Offer customers a callback option when the
|
|
10390
|
+
# estimated wait time or position in queue exceeds a defined
|
|
10391
|
+
# threshold.
|
|
10388
10392
|
#
|
|
10389
|
-
# *
|
|
10390
|
-
# queues
|
|
10393
|
+
# * Queue Routing Decisions - Route incoming contacts to less congested
|
|
10394
|
+
# queues by comparing estimated wait time and position in queue across
|
|
10395
|
+
# multiple queues.
|
|
10391
10396
|
#
|
|
10392
|
-
# *
|
|
10393
|
-
#
|
|
10397
|
+
# * Self-Service Deflection - Redirect customers to self-service options
|
|
10398
|
+
# like chatbots or FAQs when estimated wait time is high or position
|
|
10399
|
+
# in queue is unfavorable.
|
|
10394
10400
|
#
|
|
10395
10401
|
# **Important things to know**
|
|
10396
10402
|
#
|
|
10397
|
-
# *
|
|
10398
|
-
# using this API. You can't retrieve the position by using flows and
|
|
10399
|
-
# attributes.
|
|
10403
|
+
# * Metrics are only available while the contact is actively in queue.
|
|
10400
10404
|
#
|
|
10401
10405
|
# * For more information, see the [Position in queue][1] metric in the
|
|
10402
10406
|
# *Amazon Connect Administrator Guide*.
|
|
@@ -10420,7 +10424,10 @@ module Aws::Connect
|
|
|
10420
10424
|
# The identifier of the contact in this instance of Amazon Connect.
|
|
10421
10425
|
#
|
|
10422
10426
|
# @option params [required, Array<Types::ContactMetricInfo>] :metrics
|
|
10423
|
-
# A list of contact
|
|
10427
|
+
# A list of contact level metrics to retrieve.Supported metrics include
|
|
10428
|
+
# POSITION\_IN\_QUEUE (the contact's current position in the queue) and
|
|
10429
|
+
# ESTIMATED\_WAIT\_TIME (the predicted time in seconds until the contact
|
|
10430
|
+
# is connected to an agent)
|
|
10424
10431
|
#
|
|
10425
10432
|
# @return [Types::GetContactMetricsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
10426
10433
|
#
|
|
@@ -10435,7 +10442,7 @@ module Aws::Connect
|
|
|
10435
10442
|
# contact_id: "InstanceIdOrArn", # required
|
|
10436
10443
|
# metrics: [ # required
|
|
10437
10444
|
# {
|
|
10438
|
-
# name: "
|
|
10445
|
+
# name: "ESTIMATED_WAIT_TIME", # required, accepts ESTIMATED_WAIT_TIME, POSITION_IN_QUEUE
|
|
10439
10446
|
# },
|
|
10440
10447
|
# ],
|
|
10441
10448
|
# })
|
|
@@ -10443,7 +10450,7 @@ module Aws::Connect
|
|
|
10443
10450
|
# @example Response structure
|
|
10444
10451
|
#
|
|
10445
10452
|
# resp.metric_results #=> Array
|
|
10446
|
-
# resp.metric_results[0].name #=> String, one of "POSITION_IN_QUEUE"
|
|
10453
|
+
# resp.metric_results[0].name #=> String, one of "ESTIMATED_WAIT_TIME", "POSITION_IN_QUEUE"
|
|
10447
10454
|
# resp.metric_results[0].value.number #=> Float
|
|
10448
10455
|
# resp.id #=> String
|
|
10449
10456
|
# resp.arn #=> String
|
|
@@ -10645,6 +10652,20 @@ module Aws::Connect
|
|
|
10645
10652
|
#
|
|
10646
10653
|
# Name in real-time metrics report: [Scheduled][10]
|
|
10647
10654
|
#
|
|
10655
|
+
# ESTIMATED\_WAIT\_TIME
|
|
10656
|
+
#
|
|
10657
|
+
# : Unit: SECONDS
|
|
10658
|
+
#
|
|
10659
|
+
# This metric supports filter and grouping combination only used for
|
|
10660
|
+
# core routing purpose. Valid filter and grouping use cases:
|
|
10661
|
+
#
|
|
10662
|
+
# * Filter by a list of \[Queues\] and a list of \[Channels\], group
|
|
10663
|
+
# by \[“QUEUE”, “CHANNEL”\]
|
|
10664
|
+
#
|
|
10665
|
+
# * Filter by a singleton list of \[Queue\], a singleton list of
|
|
10666
|
+
# \[Channel\], a list of \[RoutingStepExpression\], group by
|
|
10667
|
+
# \[“ROUTING\_STEP\_EXPRESSION”\].
|
|
10668
|
+
#
|
|
10648
10669
|
# OLDEST\_CONTACT\_AGE
|
|
10649
10670
|
#
|
|
10650
10671
|
# : Unit: SECONDS
|
|
@@ -10746,7 +10767,7 @@ module Aws::Connect
|
|
|
10746
10767
|
# groupings: ["QUEUE"], # accepts QUEUE, CHANNEL, ROUTING_PROFILE, ROUTING_STEP_EXPRESSION, AGENT_STATUS, SUBTYPE, VALIDATION_TEST_TYPE
|
|
10747
10768
|
# current_metrics: [ # required
|
|
10748
10769
|
# {
|
|
10749
|
-
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
|
10770
|
+
# name: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE, ESTIMATED_WAIT_TIME
|
|
10750
10771
|
# metric_id: "CurrentMetricId",
|
|
10751
10772
|
# unit: "SECONDS", # accepts SECONDS, COUNT, PERCENT
|
|
10752
10773
|
# },
|
|
@@ -10755,7 +10776,7 @@ module Aws::Connect
|
|
|
10755
10776
|
# max_results: 1,
|
|
10756
10777
|
# sort_criteria: [
|
|
10757
10778
|
# {
|
|
10758
|
-
# sort_by_metric: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE
|
|
10779
|
+
# sort_by_metric: "AGENTS_ONLINE", # accepts AGENTS_ONLINE, AGENTS_AVAILABLE, AGENTS_ON_CALL, AGENTS_NON_PRODUCTIVE, AGENTS_AFTER_CONTACT_WORK, AGENTS_ERROR, AGENTS_STAFFED, CONTACTS_IN_QUEUE, OLDEST_CONTACT_AGE, CONTACTS_SCHEDULED, AGENTS_ON_CONTACT, SLOTS_ACTIVE, SLOTS_AVAILABLE, ESTIMATED_WAIT_TIME
|
|
10759
10780
|
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
|
10760
10781
|
# },
|
|
10761
10782
|
# ],
|
|
@@ -10776,7 +10797,7 @@ module Aws::Connect
|
|
|
10776
10797
|
# resp.metric_results[0].dimensions.subtype #=> String
|
|
10777
10798
|
# resp.metric_results[0].dimensions.validation_test_type #=> String
|
|
10778
10799
|
# resp.metric_results[0].collections #=> Array
|
|
10779
|
-
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE"
|
|
10800
|
+
# resp.metric_results[0].collections[0].metric.name #=> String, one of "AGENTS_ONLINE", "AGENTS_AVAILABLE", "AGENTS_ON_CALL", "AGENTS_NON_PRODUCTIVE", "AGENTS_AFTER_CONTACT_WORK", "AGENTS_ERROR", "AGENTS_STAFFED", "CONTACTS_IN_QUEUE", "OLDEST_CONTACT_AGE", "CONTACTS_SCHEDULED", "AGENTS_ON_CONTACT", "SLOTS_ACTIVE", "SLOTS_AVAILABLE", "ESTIMATED_WAIT_TIME"
|
|
10780
10801
|
# resp.metric_results[0].collections[0].metric.metric_id #=> String
|
|
10781
10802
|
# resp.metric_results[0].collections[0].metric.unit #=> String, one of "SECONDS", "COUNT", "PERCENT"
|
|
10782
10803
|
# resp.metric_results[0].collections[0].value #=> Float
|
|
@@ -19086,6 +19107,26 @@ module Aws::Connect
|
|
|
19086
19107
|
# match_type: "MATCH_ALL", # accepts MATCH_ALL, MATCH_ANY, MATCH_EXACT, MATCH_NONE
|
|
19087
19108
|
# },
|
|
19088
19109
|
# active_regions: ["RegionName"],
|
|
19110
|
+
# contact_tags: {
|
|
19111
|
+
# or_conditions: [
|
|
19112
|
+
# [
|
|
19113
|
+
# {
|
|
19114
|
+
# tag_key: "String",
|
|
19115
|
+
# tag_value: "String",
|
|
19116
|
+
# },
|
|
19117
|
+
# ],
|
|
19118
|
+
# ],
|
|
19119
|
+
# and_conditions: [
|
|
19120
|
+
# {
|
|
19121
|
+
# tag_key: "String",
|
|
19122
|
+
# tag_value: "String",
|
|
19123
|
+
# },
|
|
19124
|
+
# ],
|
|
19125
|
+
# tag_condition: {
|
|
19126
|
+
# tag_key: "String",
|
|
19127
|
+
# tag_value: "String",
|
|
19128
|
+
# },
|
|
19129
|
+
# },
|
|
19089
19130
|
# },
|
|
19090
19131
|
# max_results: 1,
|
|
19091
19132
|
# next_token: "LargeNextToken",
|
|
@@ -19147,6 +19188,8 @@ module Aws::Connect
|
|
|
19147
19188
|
# resp.contacts[0].routing_criteria.steps[0].status #=> String, one of "ACTIVE", "INACTIVE", "JOINED", "EXPIRED"
|
|
19148
19189
|
# resp.contacts[0].routing_criteria.activation_timestamp #=> Time
|
|
19149
19190
|
# resp.contacts[0].routing_criteria.index #=> Integer
|
|
19191
|
+
# resp.contacts[0].tags #=> Hash
|
|
19192
|
+
# resp.contacts[0].tags["ContactTagKey"] #=> String
|
|
19150
19193
|
# resp.contacts[0].global_resiliency_metadata.active_region #=> String
|
|
19151
19194
|
# resp.contacts[0].global_resiliency_metadata.origin_region #=> String
|
|
19152
19195
|
# resp.contacts[0].global_resiliency_metadata.traffic_distribution_group_id #=> String
|
|
@@ -27834,7 +27877,7 @@ module Aws::Connect
|
|
|
27834
27877
|
tracer: tracer
|
|
27835
27878
|
)
|
|
27836
27879
|
context[:gem_name] = 'aws-sdk-connect'
|
|
27837
|
-
context[:gem_version] = '1.
|
|
27880
|
+
context[:gem_version] = '1.240.0'
|
|
27838
27881
|
Seahorse::Client::Request.new(handlers, context)
|
|
27839
27882
|
end
|
|
27840
27883
|
|
|
@@ -3012,6 +3012,7 @@ module Aws::Connect
|
|
|
3012
3012
|
ContactSearchSummary.add_member(:segment_attributes, Shapes::ShapeRef.new(shape: ContactSearchSummarySegmentAttributes, location_name: "SegmentAttributes"))
|
|
3013
3013
|
ContactSearchSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "Name"))
|
|
3014
3014
|
ContactSearchSummary.add_member(:routing_criteria, Shapes::ShapeRef.new(shape: RoutingCriteria, location_name: "RoutingCriteria"))
|
|
3015
|
+
ContactSearchSummary.add_member(:tags, Shapes::ShapeRef.new(shape: ContactTagMap, location_name: "Tags"))
|
|
3015
3016
|
ContactSearchSummary.add_member(:global_resiliency_metadata, Shapes::ShapeRef.new(shape: GlobalResiliencyMetadata, location_name: "GlobalResiliencyMetadata"))
|
|
3016
3017
|
ContactSearchSummary.struct_class = Types::ContactSearchSummary
|
|
3017
3018
|
|
|
@@ -7235,6 +7236,7 @@ module Aws::Connect
|
|
|
7235
7236
|
SearchCriteria.add_member(:searchable_contact_attributes, Shapes::ShapeRef.new(shape: SearchableContactAttributes, location_name: "SearchableContactAttributes"))
|
|
7236
7237
|
SearchCriteria.add_member(:searchable_segment_attributes, Shapes::ShapeRef.new(shape: SearchableSegmentAttributes, location_name: "SearchableSegmentAttributes"))
|
|
7237
7238
|
SearchCriteria.add_member(:active_regions, Shapes::ShapeRef.new(shape: ActiveRegionList, location_name: "ActiveRegions"))
|
|
7239
|
+
SearchCriteria.add_member(:contact_tags, Shapes::ShapeRef.new(shape: ControlPlaneTagFilter, location_name: "ContactTags"))
|
|
7238
7240
|
SearchCriteria.struct_class = Types::SearchCriteria
|
|
7239
7241
|
|
|
7240
7242
|
SearchDataTablesRequest.add_member(:instance_id, Shapes::ShapeRef.new(shape: InstanceId, required: true, location_name: "InstanceId"))
|
|
@@ -4409,10 +4409,15 @@ module Aws::Connect
|
|
|
4409
4409
|
include Aws::Structure
|
|
4410
4410
|
end
|
|
4411
4411
|
|
|
4412
|
-
#
|
|
4412
|
+
# Contains the details of a metric to be retrieved for a contact. Use
|
|
4413
|
+
# this object to specify which contact level metrics you want to include
|
|
4414
|
+
# in your GetContactMetrics request.
|
|
4413
4415
|
#
|
|
4414
4416
|
# @!attribute [rw] name
|
|
4415
|
-
# The name of the metric
|
|
4417
|
+
# The name of the metric to retrieve. Supported values are
|
|
4418
|
+
# POSITION\_IN\_QUEUE (returns the contact's current position in the
|
|
4419
|
+
# queue) and ESTIMATED\_WAIT\_TIME (returns the predicted wait time in
|
|
4420
|
+
# seconds).
|
|
4416
4421
|
# @return [String]
|
|
4417
4422
|
#
|
|
4418
4423
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactMetricInfo AWS API Documentation
|
|
@@ -4423,14 +4428,20 @@ module Aws::Connect
|
|
|
4423
4428
|
include Aws::Structure
|
|
4424
4429
|
end
|
|
4425
4430
|
|
|
4426
|
-
#
|
|
4431
|
+
# Contains the result of a requested metric for the contact. This object
|
|
4432
|
+
# is returned as part of the GetContactMetrics response and includes
|
|
4433
|
+
# both the metric name and its calculated value.
|
|
4427
4434
|
#
|
|
4428
4435
|
# @!attribute [rw] name
|
|
4429
|
-
# The name of the metric
|
|
4436
|
+
# The name of the metric that was retrieved. This corresponds to the
|
|
4437
|
+
# metric name specified in the request, such as POSITION\_IN\_QUEUE or
|
|
4438
|
+
# ESTIMATED\_WAIT\_TIME.
|
|
4430
4439
|
# @return [String]
|
|
4431
4440
|
#
|
|
4432
4441
|
# @!attribute [rw] value
|
|
4433
|
-
#
|
|
4442
|
+
# The calculated value for the requested metric. This object contains
|
|
4443
|
+
# the numeric result based on the contact's current state in the
|
|
4444
|
+
# queue.
|
|
4434
4445
|
# @return [Types::ContactMetricValue]
|
|
4435
4446
|
#
|
|
4436
4447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactMetricResult AWS API Documentation
|
|
@@ -4442,13 +4453,16 @@ module Aws::Connect
|
|
|
4442
4453
|
include Aws::Structure
|
|
4443
4454
|
end
|
|
4444
4455
|
|
|
4445
|
-
#
|
|
4456
|
+
# Contains the numeric value of a contact metric result.
|
|
4446
4457
|
#
|
|
4447
4458
|
# @note ContactMetricValue is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ContactMetricValue corresponding to the set member.
|
|
4448
4459
|
#
|
|
4449
4460
|
# @!attribute [rw] number
|
|
4450
|
-
# The
|
|
4451
|
-
# queue.
|
|
4461
|
+
# The numeric value of the metric result. For POSITION\_IN\_QUEUE,
|
|
4462
|
+
# this represents the contact's current position in the queue (e.g.,
|
|
4463
|
+
# 3.00 means third in line). For ESTIMATED\_WAIT\_TIME, this
|
|
4464
|
+
# represents the predicted wait time in seconds (e.g., 120.00 means
|
|
4465
|
+
# approximately 2 minutes).
|
|
4452
4466
|
# @return [Float]
|
|
4453
4467
|
#
|
|
4454
4468
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/ContactMetricValue AWS API Documentation
|
|
@@ -4548,6 +4562,11 @@ module Aws::Connect
|
|
|
4548
4562
|
# Latest routing criteria on the contact.
|
|
4549
4563
|
# @return [Types::RoutingCriteria]
|
|
4550
4564
|
#
|
|
4565
|
+
# @!attribute [rw] tags
|
|
4566
|
+
# Tags associated with the contact. This contains both Amazon Web
|
|
4567
|
+
# Services generated and user-defined tags.
|
|
4568
|
+
# @return [Hash<String,String>]
|
|
4569
|
+
#
|
|
4551
4570
|
# @!attribute [rw] global_resiliency_metadata
|
|
4552
4571
|
# Additional routing information for contacts created in ACGR
|
|
4553
4572
|
# instances.
|
|
@@ -4570,6 +4589,7 @@ module Aws::Connect
|
|
|
4570
4589
|
:segment_attributes,
|
|
4571
4590
|
:name,
|
|
4572
4591
|
:routing_criteria,
|
|
4592
|
+
:tags,
|
|
4573
4593
|
:global_resiliency_metadata)
|
|
4574
4594
|
SENSITIVE = [:segment_attributes, :name]
|
|
4575
4595
|
include Aws::Structure
|
|
@@ -14334,7 +14354,10 @@ module Aws::Connect
|
|
|
14334
14354
|
# @return [String]
|
|
14335
14355
|
#
|
|
14336
14356
|
# @!attribute [rw] metrics
|
|
14337
|
-
# A list of contact
|
|
14357
|
+
# A list of contact level metrics to retrieve.Supported metrics
|
|
14358
|
+
# include POSITION\_IN\_QUEUE (the contact's current position in the
|
|
14359
|
+
# queue) and ESTIMATED\_WAIT\_TIME (the predicted time in seconds
|
|
14360
|
+
# until the contact is connected to an agent)
|
|
14338
14361
|
# @return [Array<Types::ContactMetricInfo>]
|
|
14339
14362
|
#
|
|
14340
14363
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetContactMetricsRequest AWS API Documentation
|
|
@@ -14350,12 +14373,14 @@ module Aws::Connect
|
|
|
14350
14373
|
# @!attribute [rw] metric_results
|
|
14351
14374
|
# A list of metric results containing the calculated values for each
|
|
14352
14375
|
# requested metric. Each result includes the metric name and its
|
|
14353
|
-
# corresponding
|
|
14376
|
+
# corresponding value. For example, POSITION\_IN\_QUEUE returns a
|
|
14377
|
+
# numeric value representing the contact's position in queue, and
|
|
14378
|
+
# ESTIMATED\_WAIT\_TIME returns the predicted wait time in seconds.
|
|
14354
14379
|
# @return [Array<Types::ContactMetricResult>]
|
|
14355
14380
|
#
|
|
14356
14381
|
# @!attribute [rw] id
|
|
14357
14382
|
# The unique identifier of the contact for which metrics were
|
|
14358
|
-
# retrieved.
|
|
14383
|
+
# retrieved. This matches the ContactId provided in the request.
|
|
14359
14384
|
# @return [String]
|
|
14360
14385
|
#
|
|
14361
14386
|
# @!attribute [rw] arn
|
|
@@ -14526,6 +14551,20 @@ module Aws::Connect
|
|
|
14526
14551
|
#
|
|
14527
14552
|
# Name in real-time metrics report: [Scheduled][10]
|
|
14528
14553
|
#
|
|
14554
|
+
# ESTIMATED\_WAIT\_TIME
|
|
14555
|
+
#
|
|
14556
|
+
# : Unit: SECONDS
|
|
14557
|
+
#
|
|
14558
|
+
# This metric supports filter and grouping combination only used for
|
|
14559
|
+
# core routing purpose. Valid filter and grouping use cases:
|
|
14560
|
+
#
|
|
14561
|
+
# * Filter by a list of \[Queues\] and a list of \[Channels\], group
|
|
14562
|
+
# by \[“QUEUE”, “CHANNEL”\]
|
|
14563
|
+
#
|
|
14564
|
+
# * Filter by a singleton list of \[Queue\], a singleton list of
|
|
14565
|
+
# \[Channel\], a list of \[RoutingStepExpression\], group by
|
|
14566
|
+
# \[“ROUTING\_STEP\_EXPRESSION”\].
|
|
14567
|
+
#
|
|
14529
14568
|
# OLDEST\_CONTACT\_AGE
|
|
14530
14569
|
#
|
|
14531
14570
|
# : Unit: SECONDS
|
|
@@ -27862,6 +27901,18 @@ module Aws::Connect
|
|
|
27862
27901
|
# The list of active regions for contacts in ACGR instances.
|
|
27863
27902
|
# @return [Array<String>]
|
|
27864
27903
|
#
|
|
27904
|
+
# @!attribute [rw] contact_tags
|
|
27905
|
+
# An object that can be used to specify Tag conditions inside the
|
|
27906
|
+
# `SearchFilter`. This accepts an `OR` of `AND` (List of List) input
|
|
27907
|
+
# where:
|
|
27908
|
+
#
|
|
27909
|
+
# * Top level list specifies conditions that need to be applied with
|
|
27910
|
+
# `OR` operator
|
|
27911
|
+
#
|
|
27912
|
+
# * Inner list specifies conditions that need to be applied with `AND`
|
|
27913
|
+
# operator.
|
|
27914
|
+
# @return [Types::ControlPlaneTagFilter]
|
|
27915
|
+
#
|
|
27865
27916
|
# @see http://docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/SearchCriteria AWS API Documentation
|
|
27866
27917
|
#
|
|
27867
27918
|
class SearchCriteria < Struct.new(
|
|
@@ -27876,7 +27927,8 @@ module Aws::Connect
|
|
|
27876
27927
|
:additional_time_range,
|
|
27877
27928
|
:searchable_contact_attributes,
|
|
27878
27929
|
:searchable_segment_attributes,
|
|
27879
|
-
:active_regions
|
|
27930
|
+
:active_regions,
|
|
27931
|
+
:contact_tags)
|
|
27880
27932
|
SENSITIVE = []
|
|
27881
27933
|
include Aws::Structure
|
|
27882
27934
|
end
|
data/lib/aws-sdk-connect.rb
CHANGED
data/sig/client.rbs
CHANGED
|
@@ -2684,7 +2684,7 @@ module Aws
|
|
|
2684
2684
|
contact_id: ::String,
|
|
2685
2685
|
metrics: Array[
|
|
2686
2686
|
{
|
|
2687
|
-
name: ("POSITION_IN_QUEUE")
|
|
2687
|
+
name: ("ESTIMATED_WAIT_TIME" | "POSITION_IN_QUEUE")
|
|
2688
2688
|
},
|
|
2689
2689
|
]
|
|
2690
2690
|
) -> _GetContactMetricsResponseSuccess
|
|
@@ -2712,7 +2712,7 @@ module Aws
|
|
|
2712
2712
|
?groupings: Array[("QUEUE" | "CHANNEL" | "ROUTING_PROFILE" | "ROUTING_STEP_EXPRESSION" | "AGENT_STATUS" | "SUBTYPE" | "VALIDATION_TEST_TYPE")],
|
|
2713
2713
|
current_metrics: Array[
|
|
2714
2714
|
{
|
|
2715
|
-
name: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE")?,
|
|
2715
|
+
name: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE" | "ESTIMATED_WAIT_TIME")?,
|
|
2716
2716
|
metric_id: ::String?,
|
|
2717
2717
|
unit: ("SECONDS" | "COUNT" | "PERCENT")?
|
|
2718
2718
|
},
|
|
@@ -2721,7 +2721,7 @@ module Aws
|
|
|
2721
2721
|
?max_results: ::Integer,
|
|
2722
2722
|
?sort_criteria: Array[
|
|
2723
2723
|
{
|
|
2724
|
-
sort_by_metric: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE")?,
|
|
2724
|
+
sort_by_metric: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE" | "ESTIMATED_WAIT_TIME")?,
|
|
2725
2725
|
sort_order: ("ASCENDING" | "DESCENDING")?
|
|
2726
2726
|
},
|
|
2727
2727
|
]
|
|
@@ -4350,7 +4350,27 @@ module Aws
|
|
|
4350
4350
|
],
|
|
4351
4351
|
match_type: ("MATCH_ALL" | "MATCH_ANY" | "MATCH_EXACT" | "MATCH_NONE")?
|
|
4352
4352
|
}?,
|
|
4353
|
-
active_regions: Array[::String]
|
|
4353
|
+
active_regions: Array[::String]?,
|
|
4354
|
+
contact_tags: {
|
|
4355
|
+
or_conditions: Array[
|
|
4356
|
+
Array[
|
|
4357
|
+
{
|
|
4358
|
+
tag_key: ::String?,
|
|
4359
|
+
tag_value: ::String?
|
|
4360
|
+
},
|
|
4361
|
+
],
|
|
4362
|
+
]?,
|
|
4363
|
+
and_conditions: Array[
|
|
4364
|
+
{
|
|
4365
|
+
tag_key: ::String?,
|
|
4366
|
+
tag_value: ::String?
|
|
4367
|
+
},
|
|
4368
|
+
]?,
|
|
4369
|
+
tag_condition: {
|
|
4370
|
+
tag_key: ::String?,
|
|
4371
|
+
tag_value: ::String?
|
|
4372
|
+
}?
|
|
4373
|
+
}?
|
|
4354
4374
|
},
|
|
4355
4375
|
?max_results: ::Integer,
|
|
4356
4376
|
?next_token: ::String,
|
data/sig/types.rbs
CHANGED
|
@@ -1063,12 +1063,12 @@ module Aws::Connect
|
|
|
1063
1063
|
end
|
|
1064
1064
|
|
|
1065
1065
|
class ContactMetricInfo
|
|
1066
|
-
attr_accessor name: ("POSITION_IN_QUEUE")
|
|
1066
|
+
attr_accessor name: ("ESTIMATED_WAIT_TIME" | "POSITION_IN_QUEUE")
|
|
1067
1067
|
SENSITIVE: []
|
|
1068
1068
|
end
|
|
1069
1069
|
|
|
1070
1070
|
class ContactMetricResult
|
|
1071
|
-
attr_accessor name: ("POSITION_IN_QUEUE")
|
|
1071
|
+
attr_accessor name: ("ESTIMATED_WAIT_TIME" | "POSITION_IN_QUEUE")
|
|
1072
1072
|
attr_accessor value: Types::ContactMetricValue
|
|
1073
1073
|
SENSITIVE: []
|
|
1074
1074
|
end
|
|
@@ -1104,6 +1104,7 @@ module Aws::Connect
|
|
|
1104
1104
|
attr_accessor segment_attributes: ::Hash[::String, Types::ContactSearchSummarySegmentAttributeValue]
|
|
1105
1105
|
attr_accessor name: ::String
|
|
1106
1106
|
attr_accessor routing_criteria: Types::RoutingCriteria
|
|
1107
|
+
attr_accessor tags: ::Hash[::String, ::String]
|
|
1107
1108
|
attr_accessor global_resiliency_metadata: Types::GlobalResiliencyMetadata
|
|
1108
1109
|
SENSITIVE: [:segment_attributes, :name]
|
|
1109
1110
|
end
|
|
@@ -1785,7 +1786,7 @@ module Aws::Connect
|
|
|
1785
1786
|
end
|
|
1786
1787
|
|
|
1787
1788
|
class CurrentMetric
|
|
1788
|
-
attr_accessor name: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE")
|
|
1789
|
+
attr_accessor name: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE" | "ESTIMATED_WAIT_TIME")
|
|
1789
1790
|
attr_accessor metric_id: ::String
|
|
1790
1791
|
attr_accessor unit: ("SECONDS" | "COUNT" | "PERCENT")
|
|
1791
1792
|
SENSITIVE: []
|
|
@@ -1804,7 +1805,7 @@ module Aws::Connect
|
|
|
1804
1805
|
end
|
|
1805
1806
|
|
|
1806
1807
|
class CurrentMetricSortCriteria
|
|
1807
|
-
attr_accessor sort_by_metric: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE")
|
|
1808
|
+
attr_accessor sort_by_metric: ("AGENTS_ONLINE" | "AGENTS_AVAILABLE" | "AGENTS_ON_CALL" | "AGENTS_NON_PRODUCTIVE" | "AGENTS_AFTER_CONTACT_WORK" | "AGENTS_ERROR" | "AGENTS_STAFFED" | "CONTACTS_IN_QUEUE" | "OLDEST_CONTACT_AGE" | "CONTACTS_SCHEDULED" | "AGENTS_ON_CONTACT" | "SLOTS_ACTIVE" | "SLOTS_AVAILABLE" | "ESTIMATED_WAIT_TIME")
|
|
1808
1809
|
attr_accessor sort_order: ("ASCENDING" | "DESCENDING")
|
|
1809
1810
|
SENSITIVE: []
|
|
1810
1811
|
end
|
|
@@ -6499,6 +6500,7 @@ module Aws::Connect
|
|
|
6499
6500
|
attr_accessor searchable_contact_attributes: Types::SearchableContactAttributes
|
|
6500
6501
|
attr_accessor searchable_segment_attributes: Types::SearchableSegmentAttributes
|
|
6501
6502
|
attr_accessor active_regions: ::Array[::String]
|
|
6503
|
+
attr_accessor contact_tags: Types::ControlPlaneTagFilter
|
|
6502
6504
|
SENSITIVE: []
|
|
6503
6505
|
end
|
|
6504
6506
|
|