Skip to content

Commit 069e57e

Browse files
author
awstools
committed
feat(client-connect): This release increases MaxResults limit to 500 in request for SearchUsers, SearchQueues and SearchRoutingProfiles APIs of Amazon Connect.
1 parent 5526ef7 commit 069e57e

File tree

8 files changed

+301
-32
lines changed

8 files changed

+301
-32
lines changed

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

+19-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,25 @@ export interface DeleteQuickConnectCommandOutput extends __MetadataBearer {}
2828

2929
/**
3030
* @public
31-
* <p>Deletes a quick connect.</p>
31+
* <p>Deletes a quick connect. </p>
32+
* <important>
33+
* <p>After calling <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html">DeleteUser</a>, it's important to
34+
* call <code>DeleteQuickConnect</code> to delete any records related to the deleted users. This
35+
* will help you:</p>
36+
* <ul>
37+
* <li>
38+
* <p>Avoid dangling resources that impact your service quotas.</p>
39+
* </li>
40+
* <li>
41+
* <p>Remove deleted users so they don't appear to agents as transfer options.</p>
42+
* </li>
43+
* <li>
44+
* <p>Avoid the disruption of other Amazon Connect processes, such as instance replication
45+
* and syncing if you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Amazon Connect
46+
* Global Resiliency</a>. </p>
47+
* </li>
48+
* </ul>
49+
* </important>
3250
* @example
3351
* Use a bare-bones client and the command you need to make an API call.
3452
* ```javascript

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

+17
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,23 @@ export interface DeleteUserCommandOutput extends __MetadataBearer {}
3333
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html">Delete Users from
3434
* Your Amazon Connect Instance</a> in the <i>Amazon Connect Administrator
3535
* Guide</i>.</p>
36+
* <important>
37+
* <p>After calling DeleteUser, call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html">DeleteQuickConnect</a> to
38+
* delete any records related to the deleted users. This will help you:</p>
39+
* <ul>
40+
* <li>
41+
* <p>Avoid dangling resources that impact your service quotas.</p>
42+
* </li>
43+
* <li>
44+
* <p>Remove deleted users so they don't appear to agents as transfer options.</p>
45+
* </li>
46+
* <li>
47+
* <p>Avoid the disruption of other Amazon Connect processes, such as instance replication
48+
* and syncing if you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Amazon Connect
49+
* Global Resiliency</a>. </p>
50+
* </li>
51+
* </ul>
52+
* </important>
3653
* @example
3754
* Use a bare-bones client and the command you need to make an API call.
3855
* ```javascript

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ export interface ListContactReferencesCommandOutput extends ListContactReference
3030
* @public
3131
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
3232
* <p>For the specified <code>referenceTypes</code>, returns a list of references associated with
33-
* the contact. </p>
33+
* the contact. <i>References</i> are links to documents that are related to a
34+
* contact, such as emails, attachments, or URLs.</p>
3435
* @example
3536
* Use a bare-bones client and the command you need to make an API call.
3637
* ```javascript

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ export interface StopContactCommandOutput extends StopContactResponse, __Metadat
2828

2929
/**
3030
* @public
31-
* <p>Ends the specified contact. This call does not work for voice contacts that use the
32-
* following initiation methods:</p>
31+
* <p>Ends the specified contact. Use this API to stop queued callbacks. It does not work for
32+
* voice contacts that use the following initiation methods:</p>
3333
* <ul>
3434
* <li>
3535
* <p>DISCONNECT</p>
@@ -41,7 +41,7 @@ export interface StopContactCommandOutput extends StopContactResponse, __Metadat
4141
* <p>QUEUE_TRANSFER</p>
4242
* </li>
4343
* </ul>
44-
* <p>Chat and task contacts, however, can be terminated in any state, regardless of initiation
44+
* <p>Chat and task contacts can be terminated in any state, regardless of initiation
4545
* method.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.

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

+27-1
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,11 @@ export interface AgentContactReference {
371371
/**
372372
* @public
373373
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">state of the contact</a>.</p>
374+
* <note>
375+
* <p>When <code>AgentContactState</code> is set to <code>CONNECTED_ONHOLD</code>,
376+
* <code>StateStartTimestamp</code> is not changed. Instead, <code>StateStartTimestamp</code>
377+
* reflects the time the contact was <code>CONNECTED</code> to the agent.</p>
378+
* </note>
374379
*/
375380
AgentContactState?: ContactState;
376381

@@ -4864,6 +4869,12 @@ export interface CreateUseCaseResponse {
48644869
/**
48654870
* @public
48664871
* <p>Contains information about the identity of a user.</p>
4872+
* <note>
4873+
* <p>For Amazon Connect instances that are created with the <code>EXISTING_DIRECTORY</code>
4874+
* identity management type, <code>FirstName</code>, <code>LastName</code>, and <code>Email</code>
4875+
* cannot be updated from within Amazon Connect because they are managed by the
4876+
* directory.</p>
4877+
* </note>
48674878
*/
48684879
export interface UserIdentityInfo {
48694880
/**
@@ -4937,7 +4948,10 @@ export interface UserPhoneConfig {
49374948

49384949
/**
49394950
* @public
4940-
* <p>The After Call Work (ACW) timeout setting, in seconds.</p>
4951+
* <p>The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of
4952+
* 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don't want to allocate a
4953+
* specific amount of ACW time. It essentially means an indefinite amount of time. When the
4954+
* conversation ends, ACW starts; the agent must choose Close contact to end ACW. </p>
49414955
* <note>
49424956
* <p>When returned by a <code>SearchUsers</code> call, <code>AfterContactWorkTimeLimit</code> is
49434957
* returned in milliseconds. </p>
@@ -4961,6 +4975,18 @@ export interface CreateUserRequest {
49614975
* <p>The user name for the account. For instances not using SAML for identity management, the
49624976
* user name can include up to 20 characters. If you are using SAML for identity management, the
49634977
* user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.</p>
4978+
* <p>Username can include @ only if used in an email format. For example:</p>
4979+
* <ul>
4980+
* <li>
4981+
* <p>Correct: testuser</p>
4982+
* </li>
4983+
* <li>
4984+
* <p>Correct: [email protected]</p>
4985+
* </li>
4986+
* <li>
4987+
* <p>Incorrect: testuser@example</p>
4988+
* </li>
4989+
* </ul>
49644990
*/
49654991
Username: string | undefined;
49664992

0 commit comments

Comments
 (0)