Skip to content

Commit d05a332

Browse files
author
awstools
committed
feat(client-connect): This release adds InstanceId field for phone number APIs.
1 parent 12d4db1 commit d05a332

17 files changed

+166
-69
lines changed

‎clients/client-connect/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ manage a customer contact center and provide reliable customer engagement at any
1212
contact routing. You can also resolve customer issues more efficiently by getting customers in
1313
touch with the appropriate agents.</p>
1414
<p>There are limits to the number of Amazon Connect resources that you can create. There
15-
are also limits to the number of requests that you can make per second. For more information,
16-
seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
17-
Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
15+
are also limits to the number of requests that you can make per second. For more information, see
16+
<a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
17+
Guide</i>.</p>
1818
<p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
1919
a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
2020

‎clients/client-connect/src/Connect.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4533,9 +4533,9 @@ export interface Connect {
45334533
* contact routing. You can also resolve customer issues more efficiently by getting customers in
45344534
* touch with the appropriate agents.</p>
45354535
* <p>There are limits to the number of Amazon Connect resources that you can create. There
4536-
* are also limits to the number of requests that you can make per second. For more information,
4537-
* seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
4538-
* Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
4536+
* are also limits to the number of requests that you can make per second. For more information, see
4537+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
4538+
* Guide</i>.</p>
45394539
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
45404540
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
45414541
*/

‎clients/client-connect/src/ConnectClient.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1251,9 +1251,9 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
12511251
* contact routing. You can also resolve customer issues more efficiently by getting customers in
12521252
* touch with the appropriate agents.</p>
12531253
* <p>There are limits to the number of Amazon Connect resources that you can create. There
1254-
* are also limits to the number of requests that you can make per second. For more information,
1255-
* seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
1256-
* Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
1254+
* are also limits to the number of requests that you can make per second. For more information, see
1255+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
1256+
* Guide</i>.</p>
12571257
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
12581258
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
12591259
*/

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ export interface ClaimPhoneNumberCommandOutput extends ClaimPhoneNumberResponse,
6868
* // const { ConnectClient, ClaimPhoneNumberCommand } = require("@aws-sdk/client-connect"); // CommonJS import
6969
* const client = new ConnectClient(config);
7070
* const input = { // ClaimPhoneNumberRequest
71-
* TargetArn: "STRING_VALUE", // required
71+
* TargetArn: "STRING_VALUE",
72+
* InstanceId: "STRING_VALUE",
7273
* PhoneNumber: "STRING_VALUE", // required
7374
* PhoneNumberDescription: "STRING_VALUE",
7475
* Tags: { // TagMap

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ export interface DescribePhoneNumberCommandOutput extends DescribePhoneNumberRes
6969
* // PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID",
7070
* // PhoneNumberDescription: "STRING_VALUE",
7171
* // TargetArn: "STRING_VALUE",
72+
* // InstanceId: "STRING_VALUE",
7273
* // Tags: { // TagMap
7374
* // "<keys>": "STRING_VALUE",
7475
* // },

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ export interface ListPhoneNumbersV2CommandOutput extends ListPhoneNumbersV2Respo
6363
* const client = new ConnectClient(config);
6464
* const input = { // ListPhoneNumbersV2Request
6565
* TargetArn: "STRING_VALUE",
66+
* InstanceId: "STRING_VALUE",
6667
* MaxResults: Number("int"),
6768
* NextToken: "STRING_VALUE",
6869
* PhoneNumberCountryCodes: [ // PhoneNumberCountryCodes
@@ -85,6 +86,7 @@ export interface ListPhoneNumbersV2CommandOutput extends ListPhoneNumbersV2Respo
8586
* // PhoneNumberCountryCode: "AF" || "AL" || "DZ" || "AS" || "AD" || "AO" || "AI" || "AQ" || "AG" || "AR" || "AM" || "AW" || "AU" || "AT" || "AZ" || "BS" || "BH" || "BD" || "BB" || "BY" || "BE" || "BZ" || "BJ" || "BM" || "BT" || "BO" || "BA" || "BW" || "BR" || "IO" || "VG" || "BN" || "BG" || "BF" || "BI" || "KH" || "CM" || "CA" || "CV" || "KY" || "CF" || "TD" || "CL" || "CN" || "CX" || "CC" || "CO" || "KM" || "CK" || "CR" || "HR" || "CU" || "CW" || "CY" || "CZ" || "CD" || "DK" || "DJ" || "DM" || "DO" || "TL" || "EC" || "EG" || "SV" || "GQ" || "ER" || "EE" || "ET" || "FK" || "FO" || "FJ" || "FI" || "FR" || "PF" || "GA" || "GM" || "GE" || "DE" || "GH" || "GI" || "GR" || "GL" || "GD" || "GU" || "GT" || "GG" || "GN" || "GW" || "GY" || "HT" || "HN" || "HK" || "HU" || "IS" || "IN" || "ID" || "IR" || "IQ" || "IE" || "IM" || "IL" || "IT" || "CI" || "JM" || "JP" || "JE" || "JO" || "KZ" || "KE" || "KI" || "KW" || "KG" || "LA" || "LV" || "LB" || "LS" || "LR" || "LY" || "LI" || "LT" || "LU" || "MO" || "MK" || "MG" || "MW" || "MY" || "MV" || "ML" || "MT" || "MH" || "MR" || "MU" || "YT" || "MX" || "FM" || "MD" || "MC" || "MN" || "ME" || "MS" || "MA" || "MZ" || "MM" || "NA" || "NR" || "NP" || "NL" || "AN" || "NC" || "NZ" || "NI" || "NE" || "NG" || "NU" || "KP" || "MP" || "NO" || "OM" || "PK" || "PW" || "PA" || "PG" || "PY" || "PE" || "PH" || "PN" || "PL" || "PT" || "PR" || "QA" || "CG" || "RE" || "RO" || "RU" || "RW" || "BL" || "SH" || "KN" || "LC" || "MF" || "PM" || "VC" || "WS" || "SM" || "ST" || "SA" || "SN" || "RS" || "SC" || "SL" || "SG" || "SX" || "SK" || "SI" || "SB" || "SO" || "ZA" || "KR" || "ES" || "LK" || "SD" || "SR" || "SJ" || "SZ" || "SE" || "CH" || "SY" || "TW" || "TJ" || "TZ" || "TH" || "TG" || "TK" || "TO" || "TT" || "TN" || "TR" || "TM" || "TC" || "TV" || "VI" || "UG" || "UA" || "AE" || "GB" || "US" || "UY" || "UZ" || "VU" || "VA" || "VE" || "VN" || "WF" || "EH" || "YE" || "ZM" || "ZW",
8687
* // PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID",
8788
* // TargetArn: "STRING_VALUE",
89+
* // InstanceId: "STRING_VALUE",
8890
* // },
8991
* // ],
9092
* // };

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export interface ListSecurityProfileApplicationsCommandOutput
4242

4343
/**
4444
* @public
45-
* <p>Returns a list of third party applications in a specific security profile.</p>
45+
* <p>Returns a list of third-party applications in a specific security profile.</p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,9 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord
3838
/**
3939
* @public
4040
* <p>When a contact is being recorded, and the recording has been suspended using
41-
* SuspendContactRecording, this API resumes recording the call or screen.</p>
41+
* SuspendContactRecording, this API resumes recording whatever recording is selected in the flow
42+
* configuration: call, screen, or both. If only call recording or only screen recording is enabled,
43+
* then it would resume.</p>
4244
* <p>Voice and screen recordings are supported.</p>
4345
* @example
4446
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ export interface SearchAvailablePhoneNumbersCommandOutput
5252
* // const { ConnectClient, SearchAvailablePhoneNumbersCommand } = require("@aws-sdk/client-connect"); // CommonJS import
5353
* const client = new ConnectClient(config);
5454
* const input = { // SearchAvailablePhoneNumbersRequest
55-
* TargetArn: "STRING_VALUE", // required
55+
* TargetArn: "STRING_VALUE",
56+
* InstanceId: "STRING_VALUE",
5657
* PhoneNumberCountryCode: "AF" || "AL" || "DZ" || "AS" || "AD" || "AO" || "AI" || "AQ" || "AG" || "AR" || "AM" || "AW" || "AU" || "AT" || "AZ" || "BS" || "BH" || "BD" || "BB" || "BY" || "BE" || "BZ" || "BJ" || "BM" || "BT" || "BO" || "BA" || "BW" || "BR" || "IO" || "VG" || "BN" || "BG" || "BF" || "BI" || "KH" || "CM" || "CA" || "CV" || "KY" || "CF" || "TD" || "CL" || "CN" || "CX" || "CC" || "CO" || "KM" || "CK" || "CR" || "HR" || "CU" || "CW" || "CY" || "CZ" || "CD" || "DK" || "DJ" || "DM" || "DO" || "TL" || "EC" || "EG" || "SV" || "GQ" || "ER" || "EE" || "ET" || "FK" || "FO" || "FJ" || "FI" || "FR" || "PF" || "GA" || "GM" || "GE" || "DE" || "GH" || "GI" || "GR" || "GL" || "GD" || "GU" || "GT" || "GG" || "GN" || "GW" || "GY" || "HT" || "HN" || "HK" || "HU" || "IS" || "IN" || "ID" || "IR" || "IQ" || "IE" || "IM" || "IL" || "IT" || "CI" || "JM" || "JP" || "JE" || "JO" || "KZ" || "KE" || "KI" || "KW" || "KG" || "LA" || "LV" || "LB" || "LS" || "LR" || "LY" || "LI" || "LT" || "LU" || "MO" || "MK" || "MG" || "MW" || "MY" || "MV" || "ML" || "MT" || "MH" || "MR" || "MU" || "YT" || "MX" || "FM" || "MD" || "MC" || "MN" || "ME" || "MS" || "MA" || "MZ" || "MM" || "NA" || "NR" || "NP" || "NL" || "AN" || "NC" || "NZ" || "NI" || "NE" || "NG" || "NU" || "KP" || "MP" || "NO" || "OM" || "PK" || "PW" || "PA" || "PG" || "PY" || "PE" || "PH" || "PN" || "PL" || "PT" || "PR" || "QA" || "CG" || "RE" || "RO" || "RU" || "RW" || "BL" || "SH" || "KN" || "LC" || "MF" || "PM" || "VC" || "WS" || "SM" || "ST" || "SA" || "SN" || "RS" || "SC" || "SL" || "SG" || "SX" || "SK" || "SI" || "SB" || "SO" || "ZA" || "KR" || "ES" || "LK" || "SD" || "SR" || "SJ" || "SZ" || "SE" || "CH" || "SY" || "TW" || "TJ" || "TZ" || "TH" || "TG" || "TK" || "TO" || "TT" || "TN" || "TR" || "TM" || "TC" || "TV" || "VI" || "UG" || "UA" || "AE" || "GB" || "US" || "UY" || "UZ" || "VU" || "VA" || "VE" || "VN" || "WF" || "EH" || "YE" || "ZM" || "ZW", // required
5758
* PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID", // required
5859
* PhoneNumberPrefix: "STRING_VALUE",

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,11 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco
3737

3838
/**
3939
* @public
40-
* <p>When a contact is being recorded, this API suspends recording the call or screen. For
41-
* example, you might suspend the call or screen recording while collecting sensitive information,
42-
* such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
40+
* <p>When a contact is being recorded, this API suspends recording whatever is selected in the
41+
* flow configuration: call, screen, or both. If only call recording or only screen recording is
42+
* enabled, then it would be suspended. For example, you might suspend the screen
43+
* recording while collecting sensitive information, such as a credit card number. Then use
44+
* ResumeContactRecording to restart recording the screen.</p>
4345
* <p>The period of time that the recording is suspended is filled with silence in the final
4446
* recording.</p>
4547
* <p>Voice and screen recordings are supported.</p>

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons
5656
* const client = new ConnectClient(config);
5757
* const input = { // UpdatePhoneNumberRequest
5858
* PhoneNumberId: "STRING_VALUE", // required
59-
* TargetArn: "STRING_VALUE", // required
59+
* TargetArn: "STRING_VALUE",
60+
* InstanceId: "STRING_VALUE",
6061
* ClientToken: "STRING_VALUE",
6162
* };
6263
* const command = new UpdatePhoneNumberCommand(input);

‎clients/client-connect/src/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@
77
* contact routing. You can also resolve customer issues more efficiently by getting customers in
88
* touch with the appropriate agents.</p>
99
* <p>There are limits to the number of Amazon Connect resources that you can create. There
10-
* are also limits to the number of requests that you can make per second. For more information,
11-
* seeP98941055 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service
12-
* Quotas</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
10+
* are also limits to the number of requests that you can make per second. For more information, see
11+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator
12+
* Guide</i>.</p>
1313
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
1414
* a list of Amazon Connect endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect Endpoints</a>.</p>
1515
*

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

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1212,9 +1212,17 @@ export interface AssociateTrafficDistributionGroupUserResponse {}
12121212
export interface ClaimPhoneNumberRequest {
12131213
/**
12141214
* @public
1215-
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
1215+
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
12161216
*/
1217-
TargetArn: string | undefined;
1217+
TargetArn?: string;
1218+
1219+
/**
1220+
* @public
1221+
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
1222+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
1223+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
1224+
*/
1225+
InstanceId?: string;
12181226

12191227
/**
12201228
* @public
@@ -3277,7 +3285,7 @@ export interface CreateRuleResponse {
32773285
/**
32783286
* @public
32793287
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
3280-
* <p>A third party application's metadata.</p>
3288+
* <p>A third-party application's metadata.</p>
32813289
*/
32823290
export interface Application {
32833291
/**
@@ -3346,7 +3354,7 @@ export interface CreateSecurityProfileRequest {
33463354
/**
33473355
* @public
33483356
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
3349-
* <p>A list of third party applications that the security profile will give access to.</p>
3357+
* <p>A list of third-party applications that the security profile will give access to.</p>
33503358
*/
33513359
Applications?: Application[];
33523360
}
@@ -6356,10 +6364,18 @@ export interface ClaimedPhoneNumberSummary {
63566364

63576365
/**
63586366
* @public
6359-
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
6367+
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>
63606368
*/
63616369
TargetArn?: string;
63626370

6371+
/**
6372+
* @public
6373+
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
6374+
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
6375+
* instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
6376+
*/
6377+
InstanceId?: string;
6378+
63636379
/**
63646380
* @public
63656381
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>

0 commit comments

Comments
 (0)