Skip to content

Commit a34b5ea

Browse files
author
awstools
committed
feat(client-connect): SDK release for TaskTemplateInfo in Contact for DescribeContact response.
1 parent eefe247 commit a34b5ea

File tree

10 files changed

+171
-81
lines changed

10 files changed

+171
-81
lines changed

‎clients/client-connect/src/commands/AssociateContactWithUserCommand.ts‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,24 +35,19 @@ export interface AssociateContactWithUserCommandOutput extends AssociateContactW
3535
* <p>Following are common uses cases for this API:</p>
3636
* <ul>
3737
* <li>
38-
* <p>Custom contact routing. You can build custom contact routing mechanisms beyond the default
39-
* system routing in Amazon Connect. You can create tailored contact distribution logic that
40-
* offers queued contacts directly to specific agents.</p>
38+
* <p>Programmatically assign queued contacts to available users.</p>
4139
* </li>
4240
* <li>
43-
* <p>Manual contact assignment. You can programmatically assign queued contacts to available users. This
44-
* provides flexibility to contact centers that require manual oversight or specialized routing
45-
* workflows outside of standard queue management.</p>
46-
* <p>For information about how manual contact assignment works in the agent workspace, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html">Access the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator
47-
* Guide</i>. </p>
41+
* <p>Leverage the IAM context key <code>connect:PreferredUserArn</code> to restrict contact
42+
* association to specific preferred user.</p>
4843
* </li>
4944
* </ul>
5045
* <p>
5146
* <b>Important things to know</b>
5247
* </p>
5348
* <ul>
5449
* <li>
55-
* <p>Use this API chat/SMS, email, and task contacts. It does not support voice
50+
* <p>Use this API with chat, email, and task contacts. It does not support voice
5651
* contacts.</p>
5752
* </li>
5853
* <li>
@@ -69,6 +64,11 @@ export interface AssociateContactWithUserCommandOutput extends AssociateContactW
6964
* authorization controls and prevent unauthorized contact associations. Verify that your IAM
7065
* policies are properly configured to support your intended use cases.</p>
7166
* </li>
67+
* <li>
68+
* <p>The service quota <i>Queues per routing profile per instance</i> applies to
69+
* manually assigned queues, too. For more information about this quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a> in the <i>Amazon Connect Administrator
70+
* Guide</i>.</p>
71+
* </li>
7272
* </ul>
7373
* <p>
7474
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and

‎clients/client-connect/src/commands/DescribeContactCommand.ts‎

Lines changed: 40 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,42 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
3131
/**
3232
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
3333
* <p>Describes the specified contact. </p>
34-
* <important>
35-
* <ul>
36-
* <li>
37-
* <p>
38-
* <code>SystemEndpoint</code> is not populated for contacts with initiation method of
39-
* MONITOR, QUEUE_TRANSFER, or CALLBACK</p>
40-
* </li>
41-
* <li>
42-
* <p>Contact information remains available in Amazon Connect for 24 months from the
43-
* <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is
44-
* available in Amazon Connect is returned by this API.</p>
45-
* </li>
46-
* </ul>
47-
* </important>
34+
* <p>
35+
* <b>Use cases</b>
36+
* </p>
37+
* <p>Following are common uses cases for this API:</p>
38+
* <ul>
39+
* <li>
40+
* <p>Retrieve contact information such as the caller's phone number and the specific number the
41+
* caller dialed to integrate into custom monitoring or custom agent experience solutions.</p>
42+
* </li>
43+
* <li>
44+
* <p>Detect when a customer chat session disconnects due to a network issue on the agent's end.
45+
* Use the DisconnectReason field in the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> to detect this event and then re-queue the chat for followup.</p>
46+
* </li>
47+
* <li>
48+
* <p>Identify after contact work (ACW) duration and call recordings information when a
49+
* COMPLETED event is received by using the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-events.html">contact event stream</a>. </p>
50+
* </li>
51+
* </ul>
52+
* <p>
53+
* <b>Important things to know</b>
54+
* </p>
55+
* <ul>
56+
* <li>
57+
* <p>
58+
* <code>SystemEndpoint</code> is not populated for contacts with initiation method of
59+
* MONITOR, QUEUE_TRANSFER, or CALLBACK</p>
60+
* </li>
61+
* <li>
62+
* <p>Contact information remains available in Amazon Connect for 24 months from the
63+
* <code>InitiationTimestamp</code>, and then it is deleted. Only contact information that is
64+
* available in Amazon Connect is returned by this API.</p>
65+
* </li>
66+
* </ul>
67+
* <p>
68+
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
69+
* quotas</a>.</p>
4870
* @example
4971
* Use a bare-bones client and the command you need to make an API call.
5072
* ```javascript
@@ -378,6 +400,10 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
378400
* // ExportLocation: "STRING_VALUE",
379401
* // },
380402
* // },
403+
* // TaskTemplateInfo: { // TaskTemplateInfoV2
404+
* // Arn: "STRING_VALUE",
405+
* // Name: "STRING_VALUE",
406+
* // },
381407
* // ContactDetails: { // ContactDetails
382408
* // Name: "STRING_VALUE",
383409
* // Description: "STRING_VALUE",

‎clients/client-connect/src/commands/ListInstancesCommand.ts‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { ListInstancesRequest } from "../models/models_1";
10-
import { ListInstancesResponse, ListInstancesResponseFilterSensitiveLog } from "../models/models_2";
9+
import {
10+
ListInstancesRequest,
11+
ListInstancesResponse,
12+
ListInstancesResponseFilterSensitiveLog,
13+
} from "../models/models_2";
1114
import { de_ListInstancesCommand, se_ListInstancesCommand } from "../protocols/Aws_restJson1";
1215

1316
/**

‎clients/client-connect/src/commands/ListRoutingProfileManualAssignmentQueuesCommand.ts‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,12 @@ export interface ListRoutingProfileManualAssignmentQueuesCommandOutput
4444
* <p>Following are common uses cases for this API:</p>
4545
* <ul>
4646
* <li>
47-
* <p>This API returns list of queues where contacts can be manually assigned or picked. The
48-
* user can additionally filter on queues, if they have access to those queues (otherwise a
49-
* invalid request exception will be thrown).</p>
50-
* <p>For information about how manual contact assignment works in the agent workspace, see the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html">Access the Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator
51-
* Guide</i>. </p>
47+
* <p>This API returns list of queues where contacts can be manually assigned or picked by an
48+
* agent who has access to the Worklist app. The user can additionally filter on queues, if they
49+
* have access to those queues (otherwise a invalid request exception will be thrown).</p>
50+
* <p>For information about how manual contact assignment works in the agent workspace, see the
51+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/worklist-app.html">Access the
52+
* Worklist app in the Amazon Connect agent workspace</a> in the <i>Amazon Connect Administrator Guide</i>. </p>
5253
* </li>
5354
* </ul>
5455
* <p>

‎clients/client-connect/src/endpoint/ruleset.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ e="endpoint",
1818
f="tree",
1919
g="PartitionResult",
2020
h="getAttr",
21-
i={[u]:false,"type":"String"},
22-
j={[u]:true,"default":false,"type":"Boolean"},
21+
i={[u]:false,"type":"string"},
22+
j={[u]:true,"default":false,"type":"boolean"},
2323
k={[x]:"Endpoint"},
2424
l={[v]:c,[w]:[{[x]:"UseFIPS"},true]},
2525
m={[v]:c,[w]:[{[x]:"UseDualStack"},true]},

‎clients/client-connect/src/models/models_1.ts‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1267,6 +1267,24 @@ export const RoutingCriteriaStepStatus = {
12671267
*/
12681268
export type RoutingCriteriaStepStatus = (typeof RoutingCriteriaStepStatus)[keyof typeof RoutingCriteriaStepStatus];
12691269

1270+
/**
1271+
* <p>Information about the task template used to create this contact.</p>
1272+
* @public
1273+
*/
1274+
export interface TaskTemplateInfoV2 {
1275+
/**
1276+
* <p>The Amazon Resource Name (ARN) of the task template used to create this contact.</p>
1277+
* @public
1278+
*/
1279+
Arn?: string | undefined;
1280+
1281+
/**
1282+
* <p>The name of the task template used to create this contact.</p>
1283+
* @public
1284+
*/
1285+
Name?: string | undefined;
1286+
}
1287+
12701288
/**
12711289
* <p>Information about Amazon Connect Wisdom.</p>
12721290
* @public
@@ -10329,24 +10347,6 @@ export interface ListInstanceAttributesResponse {
1032910347
NextToken?: string | undefined;
1033010348
}
1033110349

10332-
/**
10333-
* @public
10334-
*/
10335-
export interface ListInstancesRequest {
10336-
/**
10337-
* <p>The token for the next set of results. Use the value returned in the previous
10338-
* response in the next request to retrieve the next set of results.</p>
10339-
* @public
10340-
*/
10341-
NextToken?: string | undefined;
10342-
10343-
/**
10344-
* <p>The maximum number of results to return per page.</p>
10345-
* @public
10346-
*/
10347-
MaxResults?: number | undefined;
10348-
}
10349-
1035010350
/**
1035110351
* @internal
1035210352
*/

‎clients/client-connect/src/models/models_2.ts‎

Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,24 @@ import {
6565
TrafficDistributionGroupStatus,
6666
} from "./models_1";
6767

68+
/**
69+
* @public
70+
*/
71+
export interface ListInstancesRequest {
72+
/**
73+
* <p>The token for the next set of results. Use the value returned in the previous
74+
* response in the next request to retrieve the next set of results.</p>
75+
* @public
76+
*/
77+
NextToken?: string | undefined;
78+
79+
/**
80+
* <p>The maximum number of results to return per page.</p>
81+
* @public
82+
*/
83+
MaxResults?: number | undefined;
84+
}
85+
6886
/**
6987
* <p>Information about the instance.</p>
7088
* @public
@@ -972,7 +990,7 @@ export interface ListQueuesResponse {
972990
*/
973991
export interface ListQuickConnectsRequest {
974992
/**
975-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
993+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. Both Instance ID and Instance ARN are supported input formats. </p>
976994
* @public
977995
*/
978996
InstanceId: string | undefined;
@@ -1850,6 +1868,10 @@ export interface RoutingProfileManualAssignmentQueueConfigSummary {
18501868

18511869
/**
18521870
* <p>The channels this queue supports. Valid Values: CHAT | TASK | EMAIL </p>
1871+
* <important>
1872+
* <p>VOICE is not supported. The information shown below is incorrect. We're working to correct
1873+
* it. </p>
1874+
* </important>
18531875
* @public
18541876
*/
18551877
Channel: Channel | undefined;
@@ -3754,8 +3776,8 @@ export type SearchContactsTimeRangeConditionType =
37543776
(typeof SearchContactsTimeRangeConditionType)[keyof typeof SearchContactsTimeRangeConditionType];
37553777

37563778
/**
3757-
* <p>The timestamp condition indicating which timestamp should be used and how it should be
3758-
* filtered.</p>
3779+
* <p>The timestamp condition indicating which contact timestamp should be used and how it should
3780+
* be filtered. It is not an actual timestamp value. </p>
37593781
* @public
37603782
*/
37613783
export interface SearchContactsTimestampCondition {
@@ -3807,7 +3829,10 @@ export const SearchContactsMatchType = {
38073829
export type SearchContactsMatchType = (typeof SearchContactsMatchType)[keyof typeof SearchContactsMatchType];
38083830

38093831
/**
3810-
* <p>Time range that you additionally want to filter on.</p>
3832+
* <p>Time range that you <b>additionally</b> want to filter on.</p>
3833+
* <note>
3834+
* <p>This is different from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchContactsTimeRange.html">SearchContactsTimeRange</a> data type.</p>
3835+
* </note>
38113836
* @public
38123837
*/
38133838
export interface SearchContactsAdditionalTimeRange {
@@ -7738,20 +7763,6 @@ export interface UpdateContactFlowNameRequest {
77387763
*/
77397764
export interface UpdateContactFlowNameResponse {}
77407765

7741-
/**
7742-
* <p>Specify whether this routing criteria step should apply for only a limited amount of time,
7743-
* or if it should never expire.</p>
7744-
* @public
7745-
*/
7746-
export interface RoutingCriteriaInputStepExpiry {
7747-
/**
7748-
* <p>The number of seconds that the contact will be routed only to agents matching this routing
7749-
* step, if expiry was configured for this routing step.</p>
7750-
* @public
7751-
*/
7752-
DurationInSeconds?: number | undefined;
7753-
}
7754-
77557766
/**
77567767
* @internal
77577768
*/

‎clients/client-connect/src/models/models_3.ts‎

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ import {
7373
RecordingInfo,
7474
RoutingCriteriaStepStatus,
7575
SignInConfig,
76+
TaskTemplateInfoV2,
7677
TelephonyConfig,
7778
WisdomInfo,
7879
} from "./models_1";
@@ -101,14 +102,27 @@ import {
101102
QueueInfoInput,
102103
QueueSearchFilter,
103104
QuickConnectSearchFilter,
104-
RoutingCriteriaInputStepExpiry,
105105
RoutingProfileSearchFilter,
106106
SearchableQueueType,
107107
SecurityProfilesSearchFilter,
108108
UserHierarchyGroupSearchFilter,
109109
UserSearchFilter,
110110
} from "./models_2";
111111

112+
/**
113+
* <p>Specify whether this routing criteria step should apply for only a limited amount of time,
114+
* or if it should never expire.</p>
115+
* @public
116+
*/
117+
export interface RoutingCriteriaInputStepExpiry {
118+
/**
119+
* <p>The number of seconds that the contact will be routed only to agents matching this routing
120+
* step, if expiry was configured for this routing step.</p>
121+
* @public
122+
*/
123+
DurationInSeconds?: number | undefined;
124+
}
125+
112126
/**
113127
* @public
114128
*/
@@ -4359,6 +4373,12 @@ export interface Contact {
43594373
*/
43604374
ContactEvaluations?: Record<string, ContactEvaluation> | undefined;
43614375

4376+
/**
4377+
* <p>If this contact was created using a task template, this contains information about the task template.</p>
4378+
* @public
4379+
*/
4380+
TaskTemplateInfo?: TaskTemplateInfoV2 | undefined;
4381+
43624382
/**
43634383
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed
43644384
* within the contact. This object is used only for task contacts.</p>

‎clients/client-connect/src/protocols/Aws_restJson1.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,6 @@ import {
11021102
RealTimeContactAnalysisSegmentType,
11031103
RealTimeContactAnalysisTimeData,
11041104
ResourceTagsSearchCriteria,
1105-
RoutingCriteriaInputStepExpiry,
11061105
RoutingProfileSearchFilter,
11071106
RoutingProfileSummary,
11081107
RuleSummary,
@@ -1163,6 +1162,7 @@ import {
11631162
RoutingCriteria,
11641163
RoutingCriteriaInput,
11651164
RoutingCriteriaInputStep,
1165+
RoutingCriteriaInputStepExpiry,
11661166
RoutingProfileSearchCriteria,
11671167
SecurityProfileSearchCriteria,
11681168
SegmentAttributeValue,
@@ -15804,6 +15804,7 @@ const de_Contact = (output: any, context: __SerdeContext): Contact => {
1580415804
SegmentAttributes: (_: any) => de_SegmentAttributes(_, context),
1580515805
SystemEndpoint: _json,
1580615806
Tags: _json,
15807+
TaskTemplateInfo: _json,
1580715808
TotalPauseCount: __expectInt32,
1580815809
TotalPauseDurationInSeconds: __expectInt32,
1580915810
WisdomInfo: _json,
@@ -17837,6 +17838,8 @@ const de_Steps = (output: any, context: __SerdeContext): Step[] => {
1783717838

1783817839
// de_TaskTemplateFields omitted.
1783917840

17841+
// de_TaskTemplateInfoV2 omitted.
17842+
1784017843
/**
1784117844
* deserializeAws_restJson1TaskTemplateList
1784217845
*/

0 commit comments

Comments
 (0)