Skip to content

Commit fbdc1b8

Browse files
GetMetricDataV2 API: Update to include new metrics CONTACTS_RESOLVED_IN_X , AVG_HOLD_TIME_ALL_CONTACTS , AVG_RESOLUTION_TIME , ABANDONMENT_RATE , AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS with added features: Interval Period, TimeZone, Negate MetricFilters, Extended date time range.
1 parent dc5d8ae commit fbdc1b8

32 files changed

+832
-293
lines changed

generator/ServiceModels/connect/connect-2017-08-08.api.json

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7143,6 +7143,7 @@
71437143
"ResourceArn":{"shape":"ARN"},
71447144
"StartTime":{"shape":"Timestamp"},
71457145
"EndTime":{"shape":"Timestamp"},
7146+
"Interval":{"shape":"IntervalDetails"},
71467147
"Filters":{"shape":"FiltersV2List"},
71477148
"Groupings":{"shape":"GroupingsV2"},
71487149
"Metrics":{"shape":"MetricsV2"},
@@ -7729,6 +7730,24 @@
77297730
"error":{"httpStatusCode":500},
77307731
"exception":true
77317732
},
7733+
"IntervalDetails":{
7734+
"type":"structure",
7735+
"members":{
7736+
"TimeZone":{"shape":"String"},
7737+
"IntervalPeriod":{"shape":"IntervalPeriod"}
7738+
}
7739+
},
7740+
"IntervalPeriod":{
7741+
"type":"string",
7742+
"enum":[
7743+
"FIFTEEN_MIN",
7744+
"THIRTY_MIN",
7745+
"HOUR",
7746+
"DAY",
7747+
"WEEK",
7748+
"TOTAL"
7749+
]
7750+
},
77327751
"InvalidContactFlowException":{
77337752
"type":"structure",
77347753
"members":{
@@ -9200,7 +9219,8 @@
92009219
"type":"structure",
92019220
"members":{
92029221
"MetricFilterKey":{"shape":"String"},
9203-
"MetricFilterValues":{"shape":"MetricFilterValueList"}
9222+
"MetricFilterValues":{"shape":"MetricFilterValueList"},
9223+
"Negate":{"shape":"Boolean"}
92049224
}
92059225
},
92069226
"MetricFilterValueList":{
@@ -9214,11 +9234,20 @@
92149234
"member":{"shape":"MetricFilterV2"},
92159235
"max":2
92169236
},
9237+
"MetricInterval":{
9238+
"type":"structure",
9239+
"members":{
9240+
"Interval":{"shape":"IntervalPeriod"},
9241+
"StartTime":{"shape":"Timestamp"},
9242+
"EndTime":{"shape":"Timestamp"}
9243+
}
9244+
},
92179245
"MetricNameV2":{"type":"string"},
92189246
"MetricResultV2":{
92199247
"type":"structure",
92209248
"members":{
92219249
"Dimensions":{"shape":"DimensionsV2Map"},
9250+
"MetricInterval":{"shape":"MetricInterval"},
92229251
"Collections":{"shape":"MetricDataCollectionsV2"}
92239252
}
92249253
},

generator/ServiceModels/connect/connect-2017-08-08.docs.json

Lines changed: 38 additions & 15 deletions
Large diffs are not rendered by default.

generator/ServiceModels/connect/connect-2017-08-08.normal.json

Lines changed: 70 additions & 15 deletions
Large diffs are not rendered by default.

sdk/src/Services/Connect/Generated/Model/ContactFlow.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ internal bool IsSetArn()
6363
/// <summary>
6464
/// Gets and sets the property Content.
6565
/// <para>
66-
/// The content of the flow.
66+
/// The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
67+
/// contact flow in Amazon Connect Flow language</a>.
6768
/// </para>
6869
/// </summary>
6970
public string Content

sdk/src/Services/Connect/Generated/Model/ContactFlowModule.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,12 @@ internal bool IsSetArn()
6363
/// <summary>
6464
/// Gets and sets the property Content.
6565
/// <para>
66-
/// The content of the flow module.
66+
/// The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
67+
/// contact flow in Amazon Connect Flow language</a>.
68+
/// </para>
69+
///
70+
/// <para>
71+
/// Length Constraints: Minimum length of 1. Maximum length of 256000.
6772
/// </para>
6873
/// </summary>
6974
[AWSProperty(Min=1, Max=256000)]

sdk/src/Services/Connect/Generated/Model/CreateContactFlowRequest.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,12 @@ public partial class CreateContactFlowRequest : AmazonConnectRequest
5050
/// <summary>
5151
/// Gets and sets the property Content.
5252
/// <para>
53-
/// The content of the flow.
53+
/// The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example
54+
/// contact flow in Amazon Connect Flow language</a>.
55+
/// </para>
56+
///
57+
/// <para>
58+
/// Length Constraints: Minimum length of 1. Maximum length of 256000.
5459
/// </para>
5560
/// </summary>
5661
[AWSProperty(Required=true)]

sdk/src/Services/Connect/Generated/Model/CreateSecurityProfileRequest.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,7 @@ namespace Amazon.Connect.Model
3030
{
3131
/// <summary>
3232
/// Container for the parameters to the CreateSecurityProfile operation.
33-
/// This API is in preview release for Amazon Connect and is subject to change.
34-
///
35-
///
36-
/// <para>
3733
/// Creates a security profile.
38-
/// </para>
3934
/// </summary>
4035
public partial class CreateSecurityProfileRequest : AmazonConnectRequest
4136
{

sdk/src/Services/Connect/Generated/Model/DeleteSecurityProfileRequest.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,7 @@ namespace Amazon.Connect.Model
3030
{
3131
/// <summary>
3232
/// Container for the parameters to the DeleteSecurityProfile operation.
33-
/// This API is in preview release for Amazon Connect and is subject to change.
34-
///
35-
///
36-
/// <para>
3733
/// Deletes a security profile.
38-
/// </para>
3934
/// </summary>
4035
public partial class DeleteSecurityProfileRequest : AmazonConnectRequest
4136
{

sdk/src/Services/Connect/Generated/Model/DescribeSecurityProfileRequest.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,7 @@ namespace Amazon.Connect.Model
3030
{
3131
/// <summary>
3232
/// Container for the parameters to the DescribeSecurityProfile operation.
33-
/// This API is in preview release for Amazon Connect and is subject to change.
34-
///
35-
///
36-
/// <para>
3733
/// Gets basic information about the security profle.
38-
/// </para>
3934
/// </summary>
4035
public partial class DescribeSecurityProfileRequest : AmazonConnectRequest
4136
{

sdk/src/Services/Connect/Generated/Model/GetMetricDataV2Request.cs

Lines changed: 132 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ namespace Amazon.Connect.Model
3838
/// the previous version of this API. It has new metrics, offers filtering at a metric
3939
/// level, and offers the ability to filter and group data by channels, queues, routing
4040
/// profiles, agents, and agent hierarchy levels. It can retrieve historical data for
41-
/// the last 35 days, in 24-hour intervals.
41+
/// the last 3 months, at varying intervals.
4242
/// </para>
4343
///
4444
/// <para>
@@ -52,6 +52,7 @@ public partial class GetMetricDataV2Request : AmazonConnectRequest
5252
private DateTime? _endTime;
5353
private List<FilterV2> _filters = new List<FilterV2>();
5454
private List<string> _groupings = new List<string>();
55+
private IntervalDetails _interval;
5556
private int? _maxResults;
5657
private List<MetricV2> _metrics = new List<MetricV2>();
5758
private string _nextToken;
@@ -65,10 +66,6 @@ public partial class GetMetricDataV2Request : AmazonConnectRequest
6566
/// the retrieval of historical metrics data. The time must be later than the start time
6667
/// timestamp. It cannot be later than the current timestamp.
6768
/// </para>
68-
///
69-
/// <para>
70-
/// The time range between the start and end time must be less than 24 hours.
71-
/// </para>
7269
/// </summary>
7370
[AWSProperty(Required=true)]
7471
public DateTime EndTime
@@ -195,6 +192,77 @@ internal bool IsSetGroupings()
195192
return this._groupings != null && this._groupings.Count > 0;
196193
}
197194

195+
/// <summary>
196+
/// Gets and sets the property Interval.
197+
/// <para>
198+
/// The interval period and timezone to apply to returned metrics.
199+
/// </para>
200+
/// <ul> <li>
201+
/// <para>
202+
/// <code>IntervalPeriod</code>: An aggregated grouping applied to request metrics. Valid
203+
/// <code>IntervalPeriod</code> values are: <code>FIFTEEN_MIN</code> | <code>THIRTY_MIN</code>
204+
/// | <code>HOUR</code> | <code>DAY</code> | <code>WEEK</code> | <code>TOTAL</code>.
205+
/// </para>
206+
///
207+
/// <para>
208+
/// For example, if <code>IntervalPeriod</code> is selected <code>THIRTY_MIN</code>, <code>StartTime</code>
209+
/// and <code>EndTime</code> differs by 1 day, then Amazon Connect returns 48 results
210+
/// in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon
211+
/// Connect aggregates results based on the <code>TOTAL</code> interval period.
212+
/// </para>
213+
///
214+
/// <para>
215+
/// The following list describes restrictions on <code>StartTime</code> and <code>EndTime</code>
216+
/// based on which <code>IntervalPeriod</code> is requested.
217+
/// </para>
218+
/// <ul> <li>
219+
/// <para>
220+
/// <code>FIFTEEN_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
221+
/// must be less than 3 days.
222+
/// </para>
223+
/// </li> <li>
224+
/// <para>
225+
/// <code>THIRTY_MIN</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
226+
/// must be less than 3 days.
227+
/// </para>
228+
/// </li> <li>
229+
/// <para>
230+
/// <code>HOUR</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
231+
/// must be less than 3 days.
232+
/// </para>
233+
/// </li> <li>
234+
/// <para>
235+
/// <code>DAY</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
236+
/// must be less than 35 days.
237+
/// </para>
238+
/// </li> <li>
239+
/// <para>
240+
/// <code>WEEK</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
241+
/// must be less than 35 days.
242+
/// </para>
243+
/// </li> <li>
244+
/// <para>
245+
/// <code>TOTAL</code>: The difference between <code>StartTime</code> and <code>EndTime</code>
246+
/// must be less than 35 days.
247+
/// </para>
248+
/// </li> </ul> </li> <li>
249+
/// <para>
250+
/// <code>TimeZone</code>: The timezone applied to requested metrics.
251+
/// </para>
252+
/// </li> </ul>
253+
/// </summary>
254+
public IntervalDetails Interval
255+
{
256+
get { return this._interval; }
257+
set { this._interval = value; }
258+
}
259+
260+
// Check to see if Interval property is set
261+
internal bool IsSetInterval()
262+
{
263+
return this._interval != null;
264+
}
265+
198266
/// <summary>
199267
/// Gets and sets the property MaxResults.
200268
/// <para>
@@ -222,7 +290,15 @@ internal bool IsSetMaxResults()
222290
/// see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical
223291
/// metrics definitions</a> in the <i>Amazon Connect Administrator's Guide</i>.
224292
/// </para>
225-
/// <dl> <dt>AGENT_ADHERENT_TIME</dt> <dd>
293+
/// <dl> <dt>ABANDONMENT_RATE</dt> <dd>
294+
/// <para>
295+
/// Unit: Percent
296+
/// </para>
297+
///
298+
/// <para>
299+
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
300+
/// </para>
301+
/// </dd> <dt>AGENT_ADHERENT_TIME</dt> <dd>
226302
/// <para>
227303
/// This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting,
228304
/// capacity planning, and scheduling</a> is available.
@@ -245,6 +321,18 @@ internal bool IsSetMaxResults()
245321
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
246322
///
247323
/// </para>
324+
/// </dd> <dt>AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS</dt> <dd>
325+
/// <para>
326+
/// Unit: Count
327+
/// </para>
328+
///
329+
/// <para>
330+
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
331+
/// </para>
332+
///
333+
/// <para>
334+
/// Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
335+
/// </para>
248336
/// </dd> <dt>AGENT_OCCUPANCY</dt> <dd>
249337
/// <para>
250338
/// Unit: Percentage
@@ -314,21 +402,11 @@ internal bool IsSetMaxResults()
314402
/// <para>
315403
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
316404
/// </para>
317-
/// </dd> <dt>AVG_AGENT_CONNECTING_TIME</dt> <dd>
318-
/// <para>
319-
/// Unit: Seconds
320-
/// </para>
321-
///
322-
/// <para>
323-
/// Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
324-
/// supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> | <code>OUTBOUND</code>
325-
/// | <code>CALLBACK</code> | <code>API</code>
326-
/// </para>
327-
///
405+
/// <note>
328406
/// <para>
329-
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
407+
/// The <code>Negate</code> key in Metric Level Filters is not applicable for this metric.
330408
/// </para>
331-
/// </dd> <dt>AVG_CONTACT_DURATION</dt> <dd>
409+
/// </note> </dd> <dt>AVG_CONTACT_DURATION</dt> <dd>
332410
/// <para>
333411
/// Unit: Seconds
334412
/// </para>
@@ -388,7 +466,15 @@ internal bool IsSetMaxResults()
388466
/// <para>
389467
/// Feature is a valid filter but not a valid grouping.
390468
/// </para>
391-
/// </note> </dd> <dt>AVG_HOLDS</dt> <dd>
469+
/// </note> </dd> <dt>AVG_HOLD_TIME_ALL_CONTACTS</dt> <dd>
470+
/// <para>
471+
/// Unit: Seconds
472+
/// </para>
473+
///
474+
/// <para>
475+
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
476+
/// </para>
477+
/// </dd> <dt>AVG_HOLDS</dt> <dd>
392478
/// <para>
393479
/// Unit: Count
394480
/// </para>
@@ -472,7 +558,15 @@ internal bool IsSetMaxResults()
472558
/// <para>
473559
/// Feature is a valid filter but not a valid grouping.
474560
/// </para>
475-
/// </note> </dd> <dt>AVG_TALK_TIME</dt> <dd>
561+
/// </note> </dd> <dt>AVG_RESOLUTION_TIME</dt> <dd>
562+
/// <para>
563+
/// Unit: Seconds
564+
/// </para>
565+
///
566+
/// <para>
567+
/// Valid groupings and filters: Queue, Channel, Routing Profile
568+
/// </para>
569+
/// </dd> <dt>AVG_TALK_TIME</dt> <dd>
476570
/// <para>
477571
/// This metric is available only for contacts analyzed by Contact Lens conversational
478572
/// analytics.
@@ -569,6 +663,20 @@ internal bool IsSetMaxResults()
569663
/// <para>
570664
/// Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
571665
/// </para>
666+
/// </dd> <dt>CONTACTS_RESOLVED_IN_X</dt> <dd>
667+
/// <para>
668+
/// Unit: Count
669+
/// </para>
670+
///
671+
/// <para>
672+
/// Valid groupings and filters: Queue, Channel, Routing Profile
673+
/// </para>
674+
///
675+
/// <para>
676+
/// Threshold: For <code>ThresholdValue</code> enter any whole number from 1 to 604800
677+
/// (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code>
678+
/// (for "Less than").
679+
/// </para>
572680
/// </dd> <dt>CONTACTS_TRANSFERRED_OUT</dt> <dd>
573681
/// <para>
574682
/// Unit: Count
@@ -732,9 +840,9 @@ internal bool IsSetResourceArn()
732840
/// <para>
733841
/// The timestamp, in UNIX Epoch time format, at which to start the reporting interval
734842
/// for the retrieval of historical metrics data. The time must be before the end time
735-
/// timestamp. The time range between the start and end time must be less than 24 hours.
736-
/// The start time cannot be earlier than 35 days before the time of the request. Historical
737-
/// metrics are available for 35 days.
843+
/// timestamp. The start and end time depends on the <code>IntervalPeriod</code> selected.
844+
/// By default the time range between start and end time is 35 days. Historical metrics
845+
/// are available for 3 months.
738846
/// </para>
739847
/// </summary>
740848
[AWSProperty(Required=true)]

0 commit comments

Comments
 (0)