Skip to content

Commit d52597c

Browse files
author
awstools
committed
feat(client-connect): This release includes changes to DescribeContact API's response by including ConnectedToSystemTimestamp, RoutingCriteria, Customer, Campaign, AnsweringMachineDetectionStatus, CustomerVoiceActivity, QualityMetrics, DisconnectDetails, and SegmentAttributes information from a contact in Amazon Connect.
1 parent a66b85b commit d52597c

19 files changed

+2203
-878
lines changed

Diff for: ‎clients/client-connect/src/commands/ClaimPhoneNumberCommand.ts

+6-6
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,16 @@ export interface ClaimPhoneNumberCommandOutput extends ClaimPhoneNumberResponse,
3838
* the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API to verify the status of a previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a>
3939
* operation.</p>
4040
* </important>
41-
* <p>If you plan to claim and release numbers frequently during a 30 day period,
41+
* <p>If you plan to claim and release numbers frequently,
4242
* contact us for a service quota exception. Otherwise, it is possible you will be blocked from
43-
* claiming and releasing any more numbers until 30 days past the oldest number
43+
* claiming and releasing any more numbers until up to 180 days past the oldest number
4444
* released has expired.</p>
4545
* <p>By default you can claim and release up to 200% of your maximum number of active
46-
* phone numbers during any 30 day period. If you claim and release phone numbers using
47-
* the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number
48-
* service level quota, you will be blocked from claiming any more numbers until 30
46+
* phone numbers. If you claim and release phone numbers using
47+
* the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number
48+
* service level quota, you will be blocked from claiming any more numbers until 180
4949
* days past the oldest number released has expired. </p>
50-
* <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30
50+
* <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180
5151
* day period you release 99, claim 99, and then release 99, you will have exceeded the
5252
* 200% limit. At that point you are blocked from claiming any more numbers until you
5353
* open an Amazon Web Services support ticket.</p>

Diff for: ‎clients/client-connect/src/commands/DescribeContactCommand.ts

+112-5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import {
10-
DescribeContactRequest,
11-
DescribeContactResponse,
12-
DescribeContactResponseFilterSensitiveLog,
13-
} from "../models/models_0";
9+
import { DescribeContactRequest } from "../models/models_0";
10+
import { DescribeContactResponse, DescribeContactResponseFilterSensitiveLog } from "../models/models_2";
1411
import { de_DescribeContactCommand, se_DescribeContactCommand } from "../protocols/Aws_restJson1";
1512

1613
/**
@@ -69,6 +66,31 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
6966
* // Id: "STRING_VALUE",
7067
* // ConnectedToAgentTimestamp: new Date("TIMESTAMP"),
7168
* // AgentPauseDurationInSeconds: Number("int"),
69+
* // HierarchyGroups: { // HierarchyGroups
70+
* // Level1: { // AgentHierarchyGroup
71+
* // Arn: "STRING_VALUE",
72+
* // },
73+
* // Level2: {
74+
* // Arn: "STRING_VALUE",
75+
* // },
76+
* // Level3: {
77+
* // Arn: "STRING_VALUE",
78+
* // },
79+
* // Level4: {
80+
* // Arn: "STRING_VALUE",
81+
* // },
82+
* // Level5: {
83+
* // Arn: "STRING_VALUE",
84+
* // },
85+
* // },
86+
* // DeviceInfo: { // DeviceInfo
87+
* // PlatformName: "STRING_VALUE",
88+
* // PlatformVersion: "STRING_VALUE",
89+
* // OperatingSystem: "STRING_VALUE",
90+
* // },
91+
* // Capabilities: { // ParticipantCapabilities
92+
* // Video: "SEND",
93+
* // },
7294
* // },
7395
* // InitiationTimestamp: new Date("TIMESTAMP"),
7496
* // DisconnectTimestamp: new Date("TIMESTAMP"),
@@ -87,6 +109,91 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
87109
* // Tags: { // ContactTagMap
88110
* // "<keys>": "STRING_VALUE",
89111
* // },
112+
* // ConnectedToSystemTimestamp: new Date("TIMESTAMP"),
113+
* // RoutingCriteria: { // RoutingCriteria
114+
* // Steps: [ // Steps
115+
* // { // Step
116+
* // Expiry: { // Expiry
117+
* // DurationInSeconds: Number("int"),
118+
* // ExpiryTimestamp: new Date("TIMESTAMP"),
119+
* // },
120+
* // Expression: { // Expression
121+
* // AttributeCondition: { // AttributeCondition
122+
* // Name: "STRING_VALUE",
123+
* // Value: "STRING_VALUE",
124+
* // ProficiencyLevel: Number("float"),
125+
* // ComparisonOperator: "STRING_VALUE",
126+
* // },
127+
* // AndExpression: [ // Expressions
128+
* // {
129+
* // AttributeCondition: {
130+
* // Name: "STRING_VALUE",
131+
* // Value: "STRING_VALUE",
132+
* // ProficiencyLevel: Number("float"),
133+
* // ComparisonOperator: "STRING_VALUE",
134+
* // },
135+
* // AndExpression: [
136+
* // "<Expression>",
137+
* // ],
138+
* // OrExpression: [
139+
* // "<Expression>",
140+
* // ],
141+
* // },
142+
* // ],
143+
* // OrExpression: [
144+
* // "<Expression>",
145+
* // ],
146+
* // },
147+
* // Status: "ACTIVE" || "INACTIVE" || "JOINED" || "EXPIRED",
148+
* // },
149+
* // ],
150+
* // ActivationTimestamp: new Date("TIMESTAMP"),
151+
* // Index: Number("int"),
152+
* // },
153+
* // Customer: { // Customer
154+
* // DeviceInfo: {
155+
* // PlatformName: "STRING_VALUE",
156+
* // PlatformVersion: "STRING_VALUE",
157+
* // OperatingSystem: "STRING_VALUE",
158+
* // },
159+
* // Capabilities: {
160+
* // Video: "SEND",
161+
* // },
162+
* // },
163+
* // Campaign: { // Campaign
164+
* // CampaignId: "STRING_VALUE",
165+
* // },
166+
* // AnsweringMachineDetectionStatus: "ANSWERED" || "UNDETECTED" || "ERROR" || "HUMAN_ANSWERED" || "SIT_TONE_DETECTED" || "SIT_TONE_BUSY" || "SIT_TONE_INVALID_NUMBER" || "FAX_MACHINE_DETECTED" || "VOICEMAIL_BEEP" || "VOICEMAIL_NO_BEEP" || "AMD_UNRESOLVED" || "AMD_UNANSWERED" || "AMD_ERROR" || "AMD_NOT_APPLICABLE",
167+
* // CustomerVoiceActivity: { // CustomerVoiceActivity
168+
* // GreetingStartTimestamp: new Date("TIMESTAMP"),
169+
* // GreetingEndTimestamp: new Date("TIMESTAMP"),
170+
* // },
171+
* // QualityMetrics: { // QualityMetrics
172+
* // Agent: { // AgentQualityMetrics
173+
* // Audio: { // AudioQualityMetricsInfo
174+
* // QualityScore: Number("float"),
175+
* // PotentialQualityIssues: [ // PotentialAudioQualityIssues
176+
* // "STRING_VALUE",
177+
* // ],
178+
* // },
179+
* // },
180+
* // Customer: { // CustomerQualityMetrics
181+
* // Audio: {
182+
* // QualityScore: Number("float"),
183+
* // PotentialQualityIssues: [
184+
* // "STRING_VALUE",
185+
* // ],
186+
* // },
187+
* // },
188+
* // },
189+
* // DisconnectDetails: { // DisconnectDetails
190+
* // PotentialDisconnectIssue: "STRING_VALUE",
191+
* // },
192+
* // SegmentAttributes: { // SegmentAttributes
193+
* // "<keys>": { // SegmentAttributeValue
194+
* // ValueString: "STRING_VALUE",
195+
* // },
196+
* // },
90197
* // },
91198
* // };
92199
*

Diff for: ‎clients/client-connect/src/commands/DescribeContactFlowCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DescribeContactFlowRequest, DescribeContactFlowResponse } from "../models/models_0";
9+
import { DescribeContactFlowRequest, DescribeContactFlowResponse } from "../models/models_1";
1010
import { de_DescribeContactFlowCommand, se_DescribeContactFlowCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

Diff for: ‎clients/client-connect/src/commands/DescribeContactFlowModuleCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DescribeContactFlowModuleRequest, DescribeContactFlowModuleResponse } from "../models/models_0";
9+
import { DescribeContactFlowModuleRequest, DescribeContactFlowModuleResponse } from "../models/models_1";
1010
import { de_DescribeContactFlowModuleCommand, se_DescribeContactFlowModuleCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

Diff for: ‎clients/client-connect/src/commands/DescribeEvaluationFormCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DescribeEvaluationFormRequest } from "../models/models_0";
9+
import { DescribeEvaluationFormRequest } from "../models/models_1";
1010
import { DescribeEvaluationFormResponse } from "../models/models_2";
1111
import { de_DescribeEvaluationFormCommand, se_DescribeEvaluationFormCommand } from "../protocols/Aws_restJson1";
1212

Diff for: ‎clients/client-connect/src/commands/DescribeHoursOfOperationCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { DescribeHoursOfOperationRequest } from "../models/models_0";
10-
import { DescribeHoursOfOperationResponse } from "../models/models_1";
9+
import { DescribeHoursOfOperationRequest, DescribeHoursOfOperationResponse } from "../models/models_1";
1110
import { de_DescribeHoursOfOperationCommand, se_DescribeHoursOfOperationCommand } from "../protocols/Aws_restJson1";
1211

1312
/**

Diff for: ‎clients/client-connect/src/commands/ListViewVersionsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
ListViewVersionsRequest,
1111
ListViewVersionsResponse,
1212
ListViewVersionsResponseFilterSensitiveLog,
13-
} from "../models/models_1";
13+
} from "../models/models_2";
1414
import { de_ListViewVersionsCommand, se_ListViewVersionsCommand } from "../protocols/Aws_restJson1";
1515

1616
/**

Diff for: ‎clients/client-connect/src/commands/ListViewsCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { ListViewsRequest, ListViewsResponse, ListViewsResponseFilterSensitiveLog } from "../models/models_1";
9+
import { ListViewsRequest } from "../models/models_1";
10+
import { ListViewsResponse, ListViewsResponseFilterSensitiveLog } from "../models/models_2";
1011
import { de_ListViewsCommand, se_ListViewsCommand } from "../protocols/Aws_restJson1";
1112

1213
/**

Diff for: ‎clients/client-connect/src/commands/MonitorContactCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { MonitorContactRequest, MonitorContactResponse } from "../models/models_1";
9+
import { MonitorContactRequest, MonitorContactResponse } from "../models/models_2";
1010
import { de_MonitorContactCommand, se_MonitorContactCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

Diff for: ‎clients/client-connect/src/commands/PauseContactCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { PauseContactRequest, PauseContactResponse } from "../models/models_1";
9+
import { PauseContactRequest, PauseContactResponse } from "../models/models_2";
1010
import { de_PauseContactCommand, se_PauseContactCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

Diff for: ‎clients/client-connect/src/commands/PutUserStatusCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { PutUserStatusRequest, PutUserStatusResponse } from "../models/models_1";
9+
import { PutUserStatusRequest, PutUserStatusResponse } from "../models/models_2";
1010
import { de_PutUserStatusCommand, se_PutUserStatusCommand } from "../protocols/Aws_restJson1";
1111

1212
/**

Diff for: ‎clients/client-connect/src/commands/ReleasePhoneNumberCommand.ts

+10-10
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
66

77
import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient";
88
import { commonParams } from "../endpoint/EndpointParameters";
9-
import { ReleasePhoneNumberRequest } from "../models/models_1";
9+
import { ReleasePhoneNumberRequest } from "../models/models_2";
1010
import { de_ReleasePhoneNumberCommand, se_ReleasePhoneNumberCommand } from "../protocols/Aws_restJson1";
1111

1212
/**
@@ -32,20 +32,20 @@ export interface ReleasePhoneNumberCommandOutput extends __MetadataBearer {}
3232
* <important>
3333
* <p>To release phone numbers from a traffic distribution group, use the <code>ReleasePhoneNumber</code> API, not the
3434
* Amazon Connect admin website.</p>
35-
* <p>After releasing a phone number, the phone number enters into a cooldown period of 30 days.
36-
* It cannot be searched for or claimed again until the period has ended. If you accidentally
37-
* release a phone number, contact Amazon Web Services Support.</p>
35+
* <p>After releasing a phone number, the phone number enters into a cooldown period for up to
36+
* 180 days. It cannot be searched for or claimed again until the period has ended. If you
37+
* accidentally release a phone number, contact Amazon Web Services Support.</p>
3838
* </important>
39-
* <p>If you plan to claim and release numbers frequently during a 30 day period,
39+
* <p>If you plan to claim and release numbers frequently,
4040
* contact us for a service quota exception. Otherwise, it is possible you will be blocked from
41-
* claiming and releasing any more numbers until 30 days past the oldest number
41+
* claiming and releasing any more numbers until up to 180 days past the oldest number
4242
* released has expired.</p>
4343
* <p>By default you can claim and release up to 200% of your maximum number of active
44-
* phone numbers during any 30 day period. If you claim and release phone numbers using
45-
* the UI or API during a rolling 30 day cycle that exceeds 200% of your phone number
46-
* service level quota, you will be blocked from claiming any more numbers until 30
44+
* phone numbers. If you claim and release phone numbers using
45+
* the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number
46+
* service level quota, you will be blocked from claiming any more numbers until 180
4747
* days past the oldest number released has expired. </p>
48-
* <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 30
48+
* <p>For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180
4949
* day period you release 99, claim 99, and then release 99, you will have exceeded the
5050
* 200% limit. At that point you are blocked from claiming any more numbers until you
5151
* open an Amazon Web Services support ticket.</p>

Diff for: ‎clients/client-connect/src/commands/StopContactCommand.ts

+6
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ export interface StopContactCommandOutput extends StopContactResponse, __Metadat
3939
* <li>
4040
* <p>QUEUE_TRANSFER</p>
4141
* </li>
42+
* <li>
43+
* <p>EXTERNAL_OUTBOUND</p>
44+
* </li>
45+
* <li>
46+
* <p>MONITOR</p>
47+
* </li>
4248
* </ul>
4349
* <p>Chat and task contacts can be terminated in any state, regardless of initiation
4450
* method.</p>

Diff for: ‎clients/client-connect/src/commands/UpdateContactRoutingDataCommand.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ export interface UpdateContactRoutingDataCommandInput extends UpdateContactRouti
2727
export interface UpdateContactRoutingDataCommandOutput extends UpdateContactRoutingDataResponse, __MetadataBearer {}
2828

2929
/**
30-
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
31-
* <p>Updates routing priority and age on the contact (<b>QueuePriority</b> and <b>QueueTimeAdjustmentInSeconds</b>).
30+
* <p>Updates routing priority and age on the contact (<b>QueuePriority</b> and <b>QueueTimeAdjustmentInSeconds</b>).
3231
* These properties can be used to change a customer's position in the queue. For example, you can
3332
* move a contact to the back of the queue by setting a lower routing priority relative to other
3433
* contacts in queue; or you can move a contact to the front of the queue by increasing the routing
@@ -37,6 +36,10 @@ export interface UpdateContactRoutingDataCommandOutput extends UpdateContactRout
3736
* its position in queue, and not its actual queue wait time as reported through metrics. These
3837
* properties can also be updated by using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html">the Set routing priority / age flow
3938
* block</a>.</p>
39+
* <note>
40+
* <p>Either <b>QueuePriority</b> or <b>QueueTimeAdjustmentInSeconds</b> should be provided within the request body, but not
41+
* both.</p>
42+
* </note>
4043
* @example
4144
* Use a bare-bones client and the command you need to make an API call.
4245
* ```javascript

0 commit comments

Comments
 (0)