Skip to content

Commit 59e863b

Browse files
author
awstools
committed
feat(client-connect): This release adds a persistent connection field to UserPhoneConfig that maintains agent's softphone media connection for faster call connections.
1 parent 22e49d1 commit 59e863b

15 files changed

+127
-53
lines changed

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ export interface CreatePredefinedAttributeCommandOutput extends __MetadataBearer
4444
* </li>
4545
* <li>
4646
* <p>Create an attribute for business unit name that has a list of predefined business unit
47-
* names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see
48-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
47+
* names used in your organization. This is a use case where information for a contact varies
48+
* between transfers or conferences. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment
49+
* attributes</a>.</p>
4950
* </li>
5051
* </ul>
5152
* <p>

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
5959
* AutoAccept: true || false,
6060
* AfterContactWorkTimeLimit: Number("int"),
6161
* DeskPhoneNumber: "STRING_VALUE",
62+
* PersistentConnection: true || false,
6263
* },
6364
* DirectoryUserId: "STRING_VALUE",
6465
* SecurityProfileIds: [ // SecurityProfileIds // required

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,25 @@ export interface DescribePredefinedAttributeCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Describes a predefined attribute for the specified Amazon Connect instance. A <i>predefined
37-
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
36+
* <p>Describes a predefined attribute for the specified Amazon Connect instance. A <i>predefined
37+
* attribute</i> is made up of a name and a value. You can use predefined attributes
38+
* for:</p>
3839
* <ul>
3940
* <li>
40-
* <p>Routing proficiency (for example, agent certification) that has
41-
* predefined values (for example, a list of possible certifications). For more information, see
42-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
41+
* <p>Routing proficiency (for example, agent certification) that has predefined values (for
42+
* example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
4343
* predefined attributes for routing contacts to agents</a>.</p>
4444
* </li>
4545
* <li>
46-
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
47-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
46+
* <p>Contact information that varies between transfers or conferences, such as the name of the
47+
* business unit handling the contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment
48+
* attributes</a>.</p>
4849
* </li>
4950
* </ul>
5051
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
5152
* <p>
5253
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
53-
* quotas</a>.</p>
54+
* quotas</a>.</p>
5455
* @example
5556
* Use a bare-bones client and the command you need to make an API call.
5657
* ```javascript

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ export interface DescribeUserCommandOutput extends DescribeUserResponse, __Metad
6161
* // AutoAccept: true || false,
6262
* // AfterContactWorkTimeLimit: Number("int"),
6363
* // DeskPhoneNumber: "STRING_VALUE",
64+
* // PersistentConnection: true || false,
6465
* // },
6566
* // DirectoryUserId: "STRING_VALUE",
6667
* // SecurityProfileIds: [ // SecurityProfileIds

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ export interface DisassociateRoutingProfileQueuesCommandOutput extends __Metadat
3232

3333
/**
3434
* <p>Disassociates a set of queues from a routing profile.</p>
35+
* <p>Up to 10 queue references can be disassociated in a single API call. More than 10 queue
36+
* references results in a single call results in an InvalidParameterException.</p>
3537
* @example
3638
* Use a bare-bones client and the command you need to make an API call.
3739
* ```javascript

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

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,37 @@ export interface GetContactMetricsCommandInput extends GetContactMetricsRequest
2828
export interface GetContactMetricsCommandOutput extends GetContactMetricsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Gets the real-time metrics of the specified contact.</p>
31+
* <p>Retrieves the position of the contact in the queue.</p>
3232
* <p>
3333
* <b>Use cases</b>
3434
* </p>
35-
* <p>Following are common uses cases for this API:</p>
35+
* <p>Following are common uses cases for position in queue:</p>
3636
* <ul>
3737
* <li>
38-
* <p>You can use this API to retrieve the position of the contact in the queue.</p>
38+
* <p>Understand the expected wait experience of a contact.</p>
39+
* </li>
40+
* <li>
41+
* <p>Inform customers of their position in queue and potentially offer a callback.</p>
42+
* </li>
43+
* <li>
44+
* <p>Make data-driven routing decisions between primary and alternative queues.</p>
45+
* </li>
46+
* <li>
47+
* <p>Enhance queue visibility and leverage agent proficiencies to streamline contact
48+
* routing.</p>
49+
* </li>
50+
* </ul>
51+
* <p>
52+
* <b>Important things to know</b>
53+
* </p>
54+
* <ul>
55+
* <li>
56+
* <p>The only way to retrieve the position of the contact in queue is by using this API. You
57+
* can't retrieve the position by using flows and attributes.</p>
58+
* </li>
59+
* <li>
60+
* <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
61+
* <i>Amazon Connect Administrator Guide</i>. </p>
3962
* </li>
4063
* </ul>
4164
* <p>

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,24 +28,25 @@ export interface ListPredefinedAttributesCommandInput extends ListPredefinedAttr
2828
export interface ListPredefinedAttributesCommandOutput extends ListPredefinedAttributesResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Lists predefined attributes for the specified Amazon Connect instance. A <i>predefined
32-
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
31+
* <p>Lists predefined attributes for the specified Amazon Connect instance. A <i>predefined
32+
* attribute</i> is made up of a name and a value. You can use predefined attributes
33+
* for:</p>
3334
* <ul>
3435
* <li>
35-
* <p>Routing proficiency (for example, agent certification) that has
36-
* predefined values (for example, a list of possible certifications). For more information, see
37-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
36+
* <p>Routing proficiency (for example, agent certification) that has predefined values (for
37+
* example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
3838
* predefined attributes for routing contacts to agents</a>.</p>
3939
* </li>
4040
* <li>
41-
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
42-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
41+
* <p>Contact information that varies between transfers or conferences, such as the name of the
42+
* business unit handling the contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment
43+
* attributes</a>.</p>
4344
* </li>
4445
* </ul>
4546
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
4647
* <p>
4748
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
48-
* quotas</a>.</p>
49+
* quotas</a>.</p>
4950
* @example
5051
* Use a bare-bones client and the command you need to make an API call.
5152
* ```javascript

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

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,25 @@ export interface SearchPredefinedAttributesCommandInput extends SearchPredefined
2929
export interface SearchPredefinedAttributesCommandOutput extends SearchPredefinedAttributesResponse, __MetadataBearer {}
3030

3131
/**
32-
* <p>Searches predefined attributes that meet certain criteria. A <i>predefined
33-
* attribute</i> is made up of a name and a value. You can use predefined attributes for:</p>
32+
* <p>Searches predefined attributes that meet certain criteria. A <i>predefined
33+
* attribute</i> is made up of a name and a value. You can use predefined attributes
34+
* for:</p>
3435
* <ul>
3536
* <li>
36-
* <p>Routing proficiency (for example, agent certification) that has
37-
* predefined values (for example, a list of possible certifications). For more information, see
38-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
37+
* <p>Routing proficiency (for example, agent certification) that has predefined values (for
38+
* example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
3939
* predefined attributes for routing contacts to agents</a>.</p>
4040
* </li>
4141
* <li>
42-
* <p>Contact information that varies between transfers or conferences, such as the name of the business unit handling the contact. For more information, see
43-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
42+
* <p>Contact information that varies between transfers or conferences, such as the name of the
43+
* business unit handling the contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment
44+
* attributes</a>.</p>
4445
* </li>
4546
* </ul>
4647
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
4748
* <p>
4849
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
49-
* quotas</a>.</p>
50+
* quotas</a>.</p>
5051
* @example
5152
* Use a bare-bones client and the command you need to make an API call.
5253
* ```javascript

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ export interface SearchUsersCommandOutput extends SearchUsersResponse, __Metadat
159159
* // AutoAccept: true || false,
160160
* // AfterContactWorkTimeLimit: Number("int"),
161161
* // DeskPhoneNumber: "STRING_VALUE",
162+
* // PersistentConnection: true || false,
162163
* // },
163164
* // RoutingProfileId: "STRING_VALUE",
164165
* // SecurityProfileIds: [ // SecurityProfileIds

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface UpdatePredefinedAttributeCommandInput extends UpdatePredefinedA
2828
export interface UpdatePredefinedAttributeCommandOutput extends __MetadataBearer {}
2929

3030
/**
31-
* <p>Updates a predefined attribute for the specified Amazon Connect instance. A <i>predefined
31+
* <p>Updates a predefined attribute for the specified Amazon Connect instance. A <i>predefined
3232
* attribute</i> is made up of a name and a value.</p>
3333
* <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
3434
* <p>
@@ -37,20 +37,20 @@ export interface UpdatePredefinedAttributeCommandOutput extends __MetadataBearer
3737
* <p>Following are common uses cases for this API:</p>
3838
* <ul>
3939
* <li>
40-
* <p>Update routing proficiency (for example, agent certification) that has
41-
* predefined values (for example, a list of possible certifications). For more information, see
42-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
40+
* <p>Update routing proficiency (for example, agent certification) that has predefined values
41+
* (for example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create
4342
* predefined attributes for routing contacts to agents</a>.</p>
4443
* </li>
4544
* <li>
4645
* <p>Update an attribute for business unit name that has a list of predefined business unit
47-
* names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see
48-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
46+
* names used in your organization. This is a use case where information for a contact varies
47+
* between transfers or conferences. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment
48+
* attributes</a>.</p>
4949
* </li>
5050
* </ul>
5151
* <p>
5252
* <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
53-
* quotas</a>.</p>
53+
* quotas</a>.</p>
5454
* @example
5555
* Use a bare-bones client and the command you need to make an API call.
5656
* ```javascript

0 commit comments

Comments
 (0)