Skip to content

Commit 14143c0

Browse files
Merge branch 'release-1.42.39' into develop
* release-1.42.39: Bumping version to 1.42.39 Update endpoints model Update to latest models
2 parents d30db46 + f20e262 commit 14143c0

7 files changed

Lines changed: 79 additions & 23 deletions

File tree

.changes/1.42.39.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[
2+
{
3+
"category": "``connect``",
4+
"description": "This release adds Estimated Wait Time support to the GetContactMetrics API for Amazon Connect.",
5+
"type": "api-change"
6+
},
7+
{
8+
"category": "``quicksight``",
9+
"description": "Improve SessionTag usage guidelines in the GenerateEmbedURLForAnonymousUser API documentation. Update the GetIdentityContext document with the region support context.",
10+
"type": "api-change"
11+
}
12+
]

CHANGELOG.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
CHANGELOG
33
=========
44

5+
1.42.39
6+
=======
7+
8+
* api-change:``connect``: This release adds Estimated Wait Time support to the GetContactMetrics API for Amazon Connect.
9+
* api-change:``quicksight``: Improve SessionTag usage guidelines in the GenerateEmbedURLForAnonymousUser API documentation. Update the GetIdentityContext document with the region support context.
10+
11+
512
1.42.38
613
=======
714

botocore/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
import re
1818
from logging import NullHandler
1919

20-
__version__ = '1.42.38'
20+
__version__ = '1.42.39'
2121

2222

2323
# Configure default logger to do nothing

botocore/data/connect/2017-08-08/service-2.json

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2810,7 +2810,7 @@
28102810
{"shape":"AccessDeniedException"},
28112811
{"shape":"InternalServiceException"}
28122812
],
2813-
"documentation":"<p>Retrieves the position of the contact in the queue.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for position in queue:</p> <ul> <li> <p>Understand the expected wait experience of a contact.</p> </li> <li> <p>Inform customers of their position in queue and potentially offer a callback.</p> </li> <li> <p>Make data-driven routing decisions between primary and alternative queues.</p> </li> <li> <p>Enhance queue visibility and leverage agent proficiencies to streamline contact routing.</p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>The only way to retrieve the position of the contact in queue is by using this API. You can't retrieve the position by using flows and attributes.</p> </li> <li> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Position in queue</a> metric in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
2813+
"documentation":"<p>Retrieves contact metric data for a specified contact.</p> <p> <b>Use cases</b> </p> <p>Following are common use cases for position in queue and estimated wait time:</p> <ul> <li> <p>Customer-Facing Wait Time Announcements - Display or announce the estimated wait time and position in queue to customers before or during their queue experience. </p> </li> <li> <p>Callback Offerings - Offer customers a callback option when the estimated wait time or position in queue exceeds a defined threshold. </p> </li> <li> <p>Queue Routing Decisions - Route incoming contacts to less congested queues by comparing estimated wait time and position in queue across multiple queues. </p> </li> <li> <p>Self-Service Deflection - Redirect customers to self-service options like chatbots or FAQs when estimated wait time is high or position in queue is unfavorable. </p> </li> </ul> <p> <b>Important things to know</b> </p> <ul> <li> <p>Metrics are only available while the contact is actively in queue.</p> </li> <li> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Position in queue</a> metric in the <i>Amazon Connect Administrator Guide</i>. </p> </li> </ul> <p> <b>Endpoints</b>: See <a href=\"https://docs.aws.amazon.com/general/latest/gr/connect_region.html\">Amazon Connect endpoints and quotas</a>.</p>"
28142814
},
28152815
"GetCurrentMetricData":{
28162816
"name":"GetCurrentMetricData",
@@ -10102,14 +10102,17 @@
1010210102
"members":{
1010310103
"Name":{
1010410104
"shape":"ContactMetricName",
10105-
"documentation":"<p>The name of the metric being retrieved in type String.</p>"
10105+
"documentation":"<p>The name of the metric to retrieve. Supported values are POSITION_IN_QUEUE (returns the contact's current position in the queue) and ESTIMATED_WAIT_TIME (returns the predicted wait time in seconds).</p>"
1010610106
}
1010710107
},
10108-
"documentation":"<p>The object that contains information about metric being requested.</p>"
10108+
"documentation":"<p>Contains the details of a metric to be retrieved for a contact. Use this object to specify which contact level metrics you want to include in your GetContactMetrics request.</p>"
1010910109
},
1011010110
"ContactMetricName":{
1011110111
"type":"string",
10112-
"enum":["POSITION_IN_QUEUE"]
10112+
"enum":[
10113+
"ESTIMATED_WAIT_TIME",
10114+
"POSITION_IN_QUEUE"
10115+
]
1011310116
},
1011410117
"ContactMetricResult":{
1011510118
"type":"structure",
@@ -10120,14 +10123,14 @@
1012010123
"members":{
1012110124
"Name":{
1012210125
"shape":"ContactMetricName",
10123-
"documentation":"<p>The name of the metric being retrieved in type String.</p>"
10126+
"documentation":"<p>The name of the metric that was retrieved. This corresponds to the metric name specified in the request, such as POSITION_IN_QUEUE or ESTIMATED_WAIT_TIME.</p>"
1012410127
},
1012510128
"Value":{
1012610129
"shape":"ContactMetricValue",
10127-
"documentation":"<p>Object result associated with the metric received.</p>"
10130+
"documentation":"<p>The calculated value for the requested metric. This object contains the numeric result based on the contact's current state in the queue.</p>"
1012810131
}
1012910132
},
10130-
"documentation":"<p>Object containing information about metric requested for the contact.</p>"
10133+
"documentation":"<p>Contains the result of a requested metric for the contact. This object is returned as part of the GetContactMetrics response and includes both the metric name and its calculated value.</p>"
1013110134
},
1013210135
"ContactMetricResults":{
1013310136
"type":"list",
@@ -10138,10 +10141,10 @@
1013810141
"members":{
1013910142
"Number":{
1014010143
"shape":"Double",
10141-
"documentation":"<p>The number of type Double. This number is the contact's position in queue.</p>"
10144+
"documentation":"<p>The numeric value of the metric result. For POSITION_IN_QUEUE, this represents the contact's current position in the queue (e.g., 3.00 means third in line). For ESTIMATED_WAIT_TIME, this represents the predicted wait time in seconds (e.g., 120.00 means approximately 2 minutes).</p>"
1014210145
}
1014310146
},
10144-
"documentation":"<p>Object which contains the number.</p>",
10147+
"documentation":"<p>Contains the numeric value of a contact metric result.</p>",
1014510148
"union":true
1014610149
},
1014710150
"ContactMetrics":{
@@ -12491,7 +12494,8 @@
1249112494
"CONTACTS_SCHEDULED",
1249212495
"AGENTS_ON_CONTACT",
1249312496
"SLOTS_ACTIVE",
12494-
"SLOTS_AVAILABLE"
12497+
"SLOTS_AVAILABLE",
12498+
"ESTIMATED_WAIT_TIME"
1249512499
]
1249612500
},
1249712501
"CurrentMetricResult":{
@@ -18830,7 +18834,7 @@
1883018834
},
1883118835
"Metrics":{
1883218836
"shape":"ContactMetrics",
18833-
"documentation":"<p>A list of contact-level metrics to retrieve.</p>"
18837+
"documentation":"<p>A list of contact level metrics to retrieve.Supported metrics include POSITION_IN_QUEUE (the contact's current position in the queue) and ESTIMATED_WAIT_TIME (the predicted time in seconds until the contact is connected to an agent)</p>"
1883418838
}
1883518839
}
1883618840
},
@@ -18839,11 +18843,11 @@
1883918843
"members":{
1884018844
"MetricResults":{
1884118845
"shape":"ContactMetricResults",
18842-
"documentation":"<p>A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding calculated value.</p>"
18846+
"documentation":"<p>A list of metric results containing the calculated values for each requested metric. Each result includes the metric name and its corresponding value. For example, POSITION_IN_QUEUE returns a numeric value representing the contact's position in queue, and ESTIMATED_WAIT_TIME returns the predicted wait time in seconds.</p>"
1884318847
},
1884418848
"Id":{
1884518849
"shape":"ContactId",
18846-
"documentation":"<p>The unique identifier of the contact for which metrics were retrieved.</p>"
18850+
"documentation":"<p>The unique identifier of the contact for which metrics were retrieved. This matches the ContactId provided in the request.</p>"
1884718851
},
1884818852
"Arn":{
1884918853
"shape":"ARN",
@@ -18875,7 +18879,7 @@
1887518879
},
1887618880
"CurrentMetrics":{
1887718881
"shape":"CurrentMetrics",
18878-
"documentation":"<p>The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <p> MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.</p> </note> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time\">ACW</a> </p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time\">Available</a> </p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time\">Error</a> </p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time\">NPT (Non-Productive Time)</a> </p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time\">Online</a> </p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time\">Staffed</a> </p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time\">In queue</a> </p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time\">Scheduled</a> </p> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p> <p>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</p> <p> <code>{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 </code>}</p> <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p> <p>When the filter <code>RoutingStepExpression</code> is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <code>&lt;Expression 1&gt;</code> for 10 seconds has expired and <code>&lt;Expression 2&gt;</code> becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue will be counted starting from 10, not 0.</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time\">Oldest</a> </p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time\">Active</a> </p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>"
18882+
"documentation":"<p>The metrics to retrieve. Specify the name or metricId, and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html\">Metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p> <note> <p> MetricId should be used to reference custom metrics or out of the box metrics as Arn. If using MetricId, the limit is 10 MetricId per request.</p> </note> <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time\">ACW</a> </p> </dd> <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time\">Available</a> </p> </dd> <dt>AGENTS_ERROR</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time\">Error</a> </p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time\">NPT (Non-Productive Time)</a> </p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time\">On contact</a> </p> </dd> <dt>AGENTS_ONLINE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time\">Online</a> </p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time\">Staffed</a> </p> </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time\">In queue</a> </p> </dd> <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time\">Scheduled</a> </p> </dd> <dt>ESTIMATED_WAIT_TIME</dt> <dd> <p>Unit: SECONDS</p> <p>This metric supports filter and grouping combination only used for core routing purpose. Valid filter and grouping use cases: </p> <ul> <li> <p>Filter by a list of [Queues] and a list of [Channels], group by [“QUEUE”, “CHANNEL”]</p> </li> <li> <p>Filter by a singleton list of [Queue], a singleton list of [Channel], a list of [RoutingStepExpression], group by [“ROUTING_STEP_EXPRESSION”].</p> </li> </ul> </dd> <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p> <p>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</p> <p> <code>{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 </code>}</p> <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p> <p>When the filter <code>RoutingStepExpression</code> is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <code>&lt;Expression 1&gt;</code> for 10 seconds has expired and <code>&lt;Expression 2&gt;</code> becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue will be counted starting from 10, not 0.</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time\">Oldest</a> </p> </dd> <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time\">Active</a> </p> </dd> <dt>SLOTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> <p>Name in real-time metrics report: <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time\">Availability</a> </p> </dd> </dl>"
1887918883
},
1888018884
"NextToken":{
1888118885
"shape":"NextToken",

botocore/data/endpoints.json

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11990,12 +11990,45 @@
1199011990
},
1199111991
"globalaccelerator" : {
1199211992
"endpoints" : {
11993+
"af-south-1" : { },
11994+
"ap-east-1" : { },
11995+
"ap-east-2" : { },
11996+
"ap-northeast-1" : { },
11997+
"ap-northeast-2" : { },
11998+
"ap-northeast-3" : { },
11999+
"ap-south-1" : { },
12000+
"ap-south-2" : { },
12001+
"ap-southeast-1" : { },
12002+
"ap-southeast-2" : { },
12003+
"ap-southeast-3" : { },
12004+
"ap-southeast-4" : { },
12005+
"ap-southeast-5" : { },
12006+
"ap-southeast-7" : { },
12007+
"ca-central-1" : { },
12008+
"ca-west-1" : { },
12009+
"eu-central-1" : { },
12010+
"eu-central-2" : { },
12011+
"eu-north-1" : { },
12012+
"eu-south-1" : { },
12013+
"eu-south-2" : { },
12014+
"eu-west-1" : { },
12015+
"eu-west-2" : { },
12016+
"eu-west-3" : { },
1199312017
"fips-us-west-2" : {
1199412018
"credentialScope" : {
1199512019
"region" : "us-west-2"
1199612020
},
1199712021
"hostname" : "globalaccelerator-fips.us-west-2.amazonaws.com"
11998-
}
12022+
},
12023+
"il-central-1" : { },
12024+
"me-central-1" : { },
12025+
"me-south-1" : { },
12026+
"mx-central-1" : { },
12027+
"sa-east-1" : { },
12028+
"us-east-1" : { },
12029+
"us-east-2" : { },
12030+
"us-west-1" : { },
12031+
"us-west-2" : { }
1199912032
}
1200012033
},
1200112034
"glue" : {

0 commit comments

Comments
 (0)