Skip to content

Commit f234cff

Browse files
author
awstools
committed
feat(client-connect): This release supports showing PreferredAgentRouting step via DescribeContact API.
1 parent 2a5d41e commit f234cff

File tree

11 files changed

+396
-212
lines changed

11 files changed

+396
-212
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,13 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
123123
* // Name: "STRING_VALUE",
124124
* // Value: "STRING_VALUE",
125125
* // ProficiencyLevel: Number("float"),
126+
* // MatchCriteria: { // MatchCriteria
127+
* // AgentsCriteria: { // AgentsCriteria
128+
* // AgentIds: [ // AgentIds
129+
* // "STRING_VALUE",
130+
* // ],
131+
* // },
132+
* // },
126133
* // ComparisonOperator: "STRING_VALUE",
127134
* // },
128135
* // AndExpression: [ // Expressions
@@ -131,6 +138,13 @@ export interface DescribeContactCommandOutput extends DescribeContactResponse, _
131138
* // Name: "STRING_VALUE",
132139
* // Value: "STRING_VALUE",
133140
* // ProficiencyLevel: Number("float"),
141+
* // MatchCriteria: {
142+
* // AgentsCriteria: {
143+
* // AgentIds: [
144+
* // "STRING_VALUE",
145+
* // ],
146+
* // },
147+
* // },
134148
* // ComparisonOperator: "STRING_VALUE",
135149
* // },
136150
* // AndExpression: [

clients/client-connect/src/commands/ImportPhoneNumberCommand.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,22 @@ export interface ImportPhoneNumberCommandOutput extends ImportPhoneNumberRespons
3131
* <p>Imports a claimed phone number from an external service, such as Amazon Pinpoint, into an
3232
* Amazon Connect instance. You can call this API only in the same Amazon Web Services Region
3333
* where the Amazon Connect instance was created.</p>
34+
* <important>
35+
* <p>Call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API
36+
* to verify the status of a previous <code>ImportPhoneNumber</code> operation. </p>
37+
* </important>
38+
* <p>If you plan to claim or import numbers and then release numbers frequently, contact us for a
39+
* service quota exception. Otherwise, it is possible you will be blocked from claiming and
40+
* releasing any more numbers until up to 180 days past the oldest number released has expired. </p>
41+
* <p> By default you can claim or import and then release up to 200% of your maximum number of
42+
* active phone numbers. If you claim or import and then release phone numbers using the UI or API
43+
* during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you
44+
* will be blocked from claiming or importing any more numbers until 180 days past the oldest number
45+
* released has expired. </p>
46+
* <p>For example, if you already have 99 claimed or imported numbers and a service level quota of
47+
* 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you
48+
* will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers
49+
* until you open an Amazon Web Services Support ticket. </p>
3450
* @example
3551
* Use a bare-bones client and the command you need to make an API call.
3652
* ```javascript

clients/client-connect/src/commands/ListUsersCommand.ts

Lines changed: 2 additions & 1 deletion
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 { ListUsersRequest, ListUsersResponse } from "../models/models_1";
9+
import { ListUsersRequest } from "../models/models_1";
10+
import { ListUsersResponse } from "../models/models_2";
1011
import { de_ListUsersCommand, se_ListUsersCommand } from "../protocols/Aws_restJson1";
1112

1213
/**

clients/client-connect/src/commands/ListViewsCommand.ts

Lines changed: 1 addition & 2 deletions
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 { ListViewsRequest } from "../models/models_1";
10-
import { ListViewsResponse, ListViewsResponseFilterSensitiveLog } from "../models/models_2";
9+
import { ListViewsRequest, ListViewsResponse, ListViewsResponseFilterSensitiveLog } from "../models/models_2";
1110
import { de_ListViewsCommand, se_ListViewsCommand } from "../protocols/Aws_restJson1";
1211

1312
/**

clients/client-connect/src/commands/StartChatContactCommand.ts

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,20 @@ export interface StartChatContactCommandOutput extends StartChatContactResponse,
4747
* <p>If you use the <code>ChatDurationInMinutes</code> parameter and receive a 400 error, your
4848
* account may not support the ability to configure custom chat durations. For more information,
4949
* contact Amazon Web Services Support. </p>
50-
* <p>For more information about chat, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat.html">Chat</a> in the <i>Amazon Connect
51-
* Administrator Guide</i>.</p>
50+
* <p>For more information about chat, see the following topics in the <i>Amazon Connect
51+
* Administrator Guide</i>: </p>
52+
* <ul>
53+
* <li>
54+
* <p>
55+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a>
56+
* </p>
57+
* </li>
58+
* <li>
59+
* <p>
60+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>
61+
* </p>
62+
* </li>
63+
* </ul>
5264
* @example
5365
* Use a bare-bones client and the command you need to make an API call.
5466
* ```javascript

clients/client-connect/src/commands/StartContactStreamingCommand.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,20 @@ export interface StartContactStreamingCommandOutput extends StartContactStreamin
3131
* <p> Initiates real-time message streaming for a new chat contact.</p>
3232
* <p> For more information about message streaming, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message
3333
* streaming</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
34+
* <p>For more information about chat, see the following topics in the <i>Amazon Connect
35+
* Administrator Guide</i>: </p>
36+
* <ul>
37+
* <li>
38+
* <p>
39+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a>
40+
* </p>
41+
* </li>
42+
* <li>
43+
* <p>
44+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>
45+
* </p>
46+
* </li>
47+
* </ul>
3448
* @example
3549
* Use a bare-bones client and the command you need to make an API call.
3650
* ```javascript

clients/client-connect/src/models/models_0.ts

Lines changed: 43 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,8 @@ export interface DeviceInfo {
501501
}
502502

503503
/**
504-
* <p>Information about the agent hierarchy. Hierarchies can be configured with up to five levels.</p>
504+
* <p>Information about the agent hierarchy. Hierarchies can be configured with up to five
505+
* levels.</p>
505506
* @public
506507
*/
507508
export interface HierarchyGroups {
@@ -591,8 +592,10 @@ export interface AudioQualityMetricsInfo {
591592
QualityScore?: number;
592593

593594
/**
594-
* <p>List of potential issues causing degradation of quality on a media connection. If the service did not detect any potential quality issues the list is empty.</p>
595-
* <p>Valid values: <code>HighPacketLoss</code> | <code>HighRoundTripTime</code> | <code>HighJitterBuffer</code>
595+
* <p>List of potential issues causing degradation of quality on a media connection. If the
596+
* service did not detect any potential quality issues the list is empty.</p>
597+
* <p>Valid values: <code>HighPacketLoss</code> | <code>HighRoundTripTime</code> |
598+
* <code>HighJitterBuffer</code>
596599
* </p>
597600
* @public
598601
*/
@@ -611,6 +614,20 @@ export interface AgentQualityMetrics {
611614
Audio?: AudioQualityMetricsInfo;
612615
}
613616

617+
/**
618+
* <p>Can be used to define a list of preferred agents to target the contact within the queue.
619+
* Note that agents must have the queue in their routing profile in order to be offered the
620+
* contact.</p>
621+
* @public
622+
*/
623+
export interface AgentsCriteria {
624+
/**
625+
* <p>An object to specify a list of agents, by Agent ID.</p>
626+
* @public
627+
*/
628+
AgentIds?: string[];
629+
}
630+
614631
/**
615632
* @public
616633
* @enum
@@ -4360,7 +4377,7 @@ export interface FieldValueUnion {
43604377
BooleanValue?: boolean;
43614378

43624379
/**
4363-
* <p>a Double number value type.</p>
4380+
* <p>A Double number value type.</p>
43644381
* @public
43654382
*/
43664383
DoubleValue?: number;
@@ -6689,7 +6706,8 @@ export interface Customer {
66896706
*/
66906707
export interface CustomerVoiceActivity {
66916708
/**
6692-
* <p>Timestamp that measures the beginning of the customer greeting from an outbound voice call.</p>
6709+
* <p>Timestamp that measures the beginning of the customer greeting from an outbound voice
6710+
* call.</p>
66936711
* @public
66946712
*/
66956713
GreetingStartTimestamp?: Date;
@@ -6707,7 +6725,8 @@ export interface CustomerVoiceActivity {
67076725
*/
67086726
export interface DisconnectDetails {
67096727
/**
6710-
* <p>Indicates the potential disconnection issues for a call. This field is not populated if the service does not detect potential issues.</p>
6728+
* <p>Indicates the potential disconnection issues for a call. This field is not populated if the
6729+
* service does not detect potential issues.</p>
67116730
* @public
67126731
*/
67136732
PotentialDisconnectIssue?: string;
@@ -6779,6 +6798,18 @@ export interface Expiry {
67796798
ExpiryTimestamp?: Date;
67806799
}
67816800

6801+
/**
6802+
* <p>An object to define <code>AgentsCriteria</code>.</p>
6803+
* @public
6804+
*/
6805+
export interface MatchCriteria {
6806+
/**
6807+
* <p>An object to define <code>AgentIds</code>.</p>
6808+
* @public
6809+
*/
6810+
AgentsCriteria?: AgentsCriteria;
6811+
}
6812+
67826813
/**
67836814
* <p>An object to specify the predefined attribute condition.</p>
67846815
* @public
@@ -6802,6 +6833,12 @@ export interface AttributeCondition {
68026833
*/
68036834
ProficiencyLevel?: number;
68046835

6836+
/**
6837+
* <p>An object to define <code>AgentsCriteria</code>.</p>
6838+
* @public
6839+
*/
6840+
MatchCriteria?: MatchCriteria;
6841+
68056842
/**
68066843
* <p>The operator of the condition.</p>
68076844
* @public
@@ -7031,86 +7068,6 @@ export interface EvaluationNote {
70317068
Value?: string;
70327069
}
70337070

7034-
/**
7035-
* @public
7036-
* @enum
7037-
*/
7038-
export const EvaluationStatus = {
7039-
DRAFT: "DRAFT",
7040-
SUBMITTED: "SUBMITTED",
7041-
} as const;
7042-
7043-
/**
7044-
* @public
7045-
*/
7046-
export type EvaluationStatus = (typeof EvaluationStatus)[keyof typeof EvaluationStatus];
7047-
7048-
/**
7049-
* <p>Information about a contact evaluation.</p>
7050-
* @public
7051-
*/
7052-
export interface Evaluation {
7053-
/**
7054-
* <p>A unique identifier for the contact evaluation.</p>
7055-
* @public
7056-
*/
7057-
EvaluationId: string | undefined;
7058-
7059-
/**
7060-
* <p>The Amazon Resource Name (ARN) for the contact evaluation resource.</p>
7061-
* @public
7062-
*/
7063-
EvaluationArn: string | undefined;
7064-
7065-
/**
7066-
* <p>Metadata about the contact evaluation.</p>
7067-
* @public
7068-
*/
7069-
Metadata: EvaluationMetadata | undefined;
7070-
7071-
/**
7072-
* <p>A map of question identifiers to answer value.</p>
7073-
* @public
7074-
*/
7075-
Answers: Record<string, EvaluationAnswerOutput> | undefined;
7076-
7077-
/**
7078-
* <p>A map of question identifiers to note value.</p>
7079-
* @public
7080-
*/
7081-
Notes: Record<string, EvaluationNote> | undefined;
7082-
7083-
/**
7084-
* <p>The status of the contact evaluation.</p>
7085-
* @public
7086-
*/
7087-
Status: EvaluationStatus | undefined;
7088-
7089-
/**
7090-
* <p>A map of item (section or question) identifiers to score value.</p>
7091-
* @public
7092-
*/
7093-
Scores?: Record<string, EvaluationScore>;
7094-
7095-
/**
7096-
* <p>The timestamp for when the evaluation was created.</p>
7097-
* @public
7098-
*/
7099-
CreatedTime: Date | undefined;
7100-
7101-
/**
7102-
* <p>The timestamp for when the evaluation was last updated.</p>
7103-
* @public
7104-
*/
7105-
LastModifiedTime: Date | undefined;
7106-
7107-
/**
7108-
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
7109-
* @public
7110-
*/
7111-
Tags?: Record<string, string>;
7112-
}
7113-
71147071
/**
71157072
* @internal
71167073
*/

0 commit comments

Comments
 (0)