Skip to content

Commit

Permalink
feat(client-connect): This release adds InstanceId field for phone nu…
Browse files Browse the repository at this point in the history
…mber APIs.
  • Loading branch information
awstools committed Oct 30, 2023
1 parent 12d4db1 commit d05a332
Show file tree
Hide file tree
Showing 17 changed files with 166 additions and 69 deletions.
6 changes: 3 additions & 3 deletions clients/client-connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ manage a customer contact center and provide reliable customer engagement at any
contact routing. You can also resolve customer issues more efficiently by getting customers in
touch with the appropriate agents.</p>
<p>There are limits to the number of Amazon Connect resources that you can create. There
are also limits to the number of requests that you can make per second. For more information,
seeP98941055 <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 Guide</i>.</p>
are also limits to the number of requests that you can make per second. For more information, see
<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
Guide</i>.</p>
<p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
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>

Expand Down
6 changes: 3 additions & 3 deletions clients/client-connect/src/Connect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4533,9 +4533,9 @@ export interface Connect {
* contact routing. You can also resolve customer issues more efficiently by getting customers in
* touch with the appropriate agents.</p>
* <p>There are limits to the number of Amazon Connect resources that you can create. There
* are also limits to the number of requests that you can make per second. For more information,
* seeP98941055 <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 Guide</i>.</p>
* are also limits to the number of requests that you can make per second. For more information, see
* <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
* Guide</i>.</p>
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
* 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>
*/
Expand Down
6 changes: 3 additions & 3 deletions clients/client-connect/src/ConnectClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1251,9 +1251,9 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig
* contact routing. You can also resolve customer issues more efficiently by getting customers in
* touch with the appropriate agents.</p>
* <p>There are limits to the number of Amazon Connect resources that you can create. There
* are also limits to the number of requests that you can make per second. For more information,
* seeP98941055 <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 Guide</i>.</p>
* are also limits to the number of requests that you can make per second. For more information, see
* <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
* Guide</i>.</p>
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
* 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>
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ export interface ClaimPhoneNumberCommandOutput extends ClaimPhoneNumberResponse,
* // const { ConnectClient, ClaimPhoneNumberCommand } = require("@aws-sdk/client-connect"); // CommonJS import
* const client = new ConnectClient(config);
* const input = { // ClaimPhoneNumberRequest
* TargetArn: "STRING_VALUE", // required
* TargetArn: "STRING_VALUE",
* InstanceId: "STRING_VALUE",
* PhoneNumber: "STRING_VALUE", // required
* PhoneNumberDescription: "STRING_VALUE",
* Tags: { // TagMap
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ export interface DescribePhoneNumberCommandOutput extends DescribePhoneNumberRes
* // PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID",
* // PhoneNumberDescription: "STRING_VALUE",
* // TargetArn: "STRING_VALUE",
* // InstanceId: "STRING_VALUE",
* // Tags: { // TagMap
* // "<keys>": "STRING_VALUE",
* // },
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ export interface ListPhoneNumbersV2CommandOutput extends ListPhoneNumbersV2Respo
* const client = new ConnectClient(config);
* const input = { // ListPhoneNumbersV2Request
* TargetArn: "STRING_VALUE",
* InstanceId: "STRING_VALUE",
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* PhoneNumberCountryCodes: [ // PhoneNumberCountryCodes
Expand All @@ -85,6 +86,7 @@ export interface ListPhoneNumbersV2CommandOutput extends ListPhoneNumbersV2Respo
* // 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",
* // PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID",
* // TargetArn: "STRING_VALUE",
* // InstanceId: "STRING_VALUE",
* // },
* // ],
* // };
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export interface ListSecurityProfileApplicationsCommandOutput

/**
* @public
* <p>Returns a list of third party applications in a specific security profile.</p>
* <p>Returns a list of third-party applications in a specific security profile.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ export interface ResumeContactRecordingCommandOutput extends ResumeContactRecord
/**
* @public
* <p>When a contact is being recorded, and the recording has been suspended using
* SuspendContactRecording, this API resumes recording the call or screen.</p>
* SuspendContactRecording, this API resumes recording whatever recording is selected in the flow
* configuration: call, screen, or both. If only call recording or only screen recording is enabled,
* then it would resume.</p>
* <p>Voice and screen recordings are supported.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ export interface SearchAvailablePhoneNumbersCommandOutput
* // const { ConnectClient, SearchAvailablePhoneNumbersCommand } = require("@aws-sdk/client-connect"); // CommonJS import
* const client = new ConnectClient(config);
* const input = { // SearchAvailablePhoneNumbersRequest
* TargetArn: "STRING_VALUE", // required
* TargetArn: "STRING_VALUE",
* InstanceId: "STRING_VALUE",
* 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
* PhoneNumberType: "TOLL_FREE" || "DID" || "UIFN" || "SHARED" || "THIRD_PARTY_TF" || "THIRD_PARTY_DID", // required
* PhoneNumberPrefix: "STRING_VALUE",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,11 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco

/**
* @public
* <p>When a contact is being recorded, this API suspends recording the call or screen. For
* example, you might suspend the call or screen recording while collecting sensitive information,
* such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
* <p>When a contact is being recorded, this API suspends recording whatever is selected in the
* flow configuration: call, screen, or both. If only call recording or only screen recording is
* enabled, then it would be suspended. For example, you might suspend the screen
* recording while collecting sensitive information, such as a credit card number. Then use
* ResumeContactRecording to restart recording the screen.</p>
* <p>The period of time that the recording is suspended is filled with silence in the final
* recording.</p>
* <p>Voice and screen recordings are supported.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ export interface UpdatePhoneNumberCommandOutput extends UpdatePhoneNumberRespons
* const client = new ConnectClient(config);
* const input = { // UpdatePhoneNumberRequest
* PhoneNumberId: "STRING_VALUE", // required
* TargetArn: "STRING_VALUE", // required
* TargetArn: "STRING_VALUE",
* InstanceId: "STRING_VALUE",
* ClientToken: "STRING_VALUE",
* };
* const command = new UpdatePhoneNumberCommand(input);
Expand Down
6 changes: 3 additions & 3 deletions clients/client-connect/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
* contact routing. You can also resolve customer issues more efficiently by getting customers in
* touch with the appropriate agents.</p>
* <p>There are limits to the number of Amazon Connect resources that you can create. There
* are also limits to the number of requests that you can make per second. For more information,
* seeP98941055 <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 Guide</i>.</p>
* are also limits to the number of requests that you can make per second. For more information, see
* <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
* Guide</i>.</p>
* <p>You can connect programmatically to an Amazon Web Services service by using an endpoint. For
* 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>
*
Expand Down
26 changes: 21 additions & 5 deletions clients/client-connect/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1212,9 +1212,17 @@ export interface AssociateTrafficDistributionGroupUserResponse {}
export interface ClaimPhoneNumberRequest {
/**
* @public
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone numbers are claimed to.</p>
* <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>
*/
TargetArn: string | undefined;
TargetArn?: string;

/**
* @public
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
* instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <code>InstanceId</code> or <code>TargetArn</code>. </p>
*/
InstanceId?: string;

/**
* @public
Expand Down Expand Up @@ -3277,7 +3285,7 @@ export interface CreateRuleResponse {
/**
* @public
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>A third party application's metadata.</p>
* <p>A third-party application's metadata.</p>
*/
export interface Application {
/**
Expand Down Expand Up @@ -3346,7 +3354,7 @@ export interface CreateSecurityProfileRequest {
/**
* @public
* <p>This API is in preview release for Amazon Connect and is subject to change.</p>
* <p>A list of third party applications that the security profile will give access to.</p>
* <p>A list of third-party applications that the security profile will give access to.</p>
*/
Applications?: Application[];
}
Expand Down Expand Up @@ -6356,10 +6364,18 @@ export interface ClaimedPhoneNumberSummary {

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

/**
* @public
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
* instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
*/
InstanceId?: string;

/**
* @public
* <p>The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
Expand Down
Loading

0 comments on commit d05a332

Please sign in to comment.