Skip to content

Commit 9fe3f13

Browse files
author
awstools
committed
feat(client-connect): This release adds the following value to an InitiateAs enum: COMPLETED
1 parent 5be5c0b commit 9fe3f13

File tree

8 files changed

+126
-40
lines changed

8 files changed

+126
-40
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ export interface CreateContactCommandOutput extends CreateContactResponse, __Met
6363
* UserInfo: { // UserInfo
6464
* UserId: "STRING_VALUE",
6565
* },
66-
* InitiateAs: "CONNECTED_TO_USER",
66+
* InitiateAs: "CONNECTED_TO_USER" || "COMPLETED",
6767
* Name: "STRING_VALUE",
6868
* Description: "STRING_VALUE",
6969
* SegmentAttributes: { // SegmentAttributes

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ export interface DescribeRoutingProfileCommandOutput extends DescribeRoutingProf
2929

3030
/**
3131
* <p>Describes the specified routing profile.</p>
32+
* <note>
33+
* <p>
34+
* <code>DescribeRoutingProfile</code> does not populate AssociatedQueueIds in its response.
35+
* The example Response Syntax shown on this page is incorrect; we are working to update it. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfiles</a> does include AssociatedQueueIds.</p>
36+
* </note>
3237
* @example
3338
* Use a bare-bones client and the command you need to make an API call.
3439
* ```javascript

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ export interface SearchRoutingProfilesCommandOutput extends SearchRoutingProfile
3030

3131
/**
3232
* <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
33+
* <note>
34+
* <p>
35+
* <code>SearchRoutingProfiles</code> does not populate LastModifiedRegion, LastModifiedTime,
36+
* MediaConcurrencies.CrossChannelBehavior, and AgentAvailabilityTimer in its response, but <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> does.</p>
37+
* </note>
3338
* @example
3439
* Use a bare-bones client and the command you need to make an API call.
3540
* ```javascript

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3012,6 +3012,7 @@ export class ConflictException extends __BaseException {
30123012
* @enum
30133013
*/
30143014
export const InitiateAs = {
3015+
COMPLETED: "COMPLETED",
30153016
CONNECTED_TO_USER: "CONNECTED_TO_USER",
30163017
} as const;
30173018

@@ -3441,7 +3442,7 @@ export interface CreateEmailAddressRequest {
34413442
InstanceId: string | undefined;
34423443

34433444
/**
3444-
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
3445+
* <p>The email address, including the domain.</p>
34453446
* @public
34463447
*/
34473448
EmailAddress: string | undefined;
@@ -4938,7 +4939,7 @@ export interface OutboundCallerConfig {
49384939
}
49394940

49404941
/**
4941-
* <p>The outbound email address Id.</p>
4942+
* <p>The outbound email address ID.</p>
49424943
* @public
49434944
*/
49444945
export interface OutboundEmailConfig {

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

Lines changed: 57 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1606,7 +1606,7 @@ export interface DescribeEmailAddressResponse {
16061606
EmailAddressArn?: string | undefined;
16071607

16081608
/**
1609-
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
1609+
* <p>The email address, including the domain.</p>
16101610
* @public
16111611
*/
16121612
EmailAddress?: string | undefined;
@@ -6163,8 +6163,8 @@ export interface GetMetricDataV2Request {
61636163
* <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
61646164
* <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> |
61656165
* <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> |
6166-
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> |
6167-
* <code>CASE_STATUS</code> | <code>CHANNEL</code> |
6166+
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CAMPAIGN_EXCLUDED_EVENT_TYPE </code> |
6167+
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
61686168
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
61696169
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
61706170
* <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> |
@@ -6228,6 +6228,7 @@ export interface GetMetricDataV2Request {
62286228
* <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> |
62296229
* <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> |
62306230
* <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
6231+
* <code>CAMPAIGN_EXCLUDED_EVENT_TYPE</code> | <code>CAMPAIGN_EXECUTION_TIMESTAMP</code> |
62316232
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
62326233
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
62336234
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
@@ -6702,6 +6703,16 @@ export interface GetMetricDataV2Request {
67026703
* interactions</a>
67036704
* </p>
67046705
* </dd>
6706+
* <dt>CAMPAIGN_PROGRESS_RATE</dt>
6707+
* <dd>
6708+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
6709+
* It is not available for event triggered campaigns.</p>
6710+
* <p>Unit: Percent</p>
6711+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
6712+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate">Campaign
6713+
* progress rate</a>
6714+
* </p>
6715+
* </dd>
67056716
* <dt>CAMPAIGN_SEND_ATTEMPTS</dt>
67066717
* <dd>
67076718
* <p>This metric is available only for outbound campaigns.</p>
@@ -6711,6 +6722,17 @@ export interface GetMetricDataV2Request {
67116722
* attempts</a>
67126723
* </p>
67136724
* </dd>
6725+
* <dt>CAMPAIGN_SEND_EXCLUSIONS</dt>
6726+
* <dd>
6727+
* <p>This metric is available only for outbound campaigns.</p>
6728+
* <p>Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE</p>
6729+
* <p>Unit: Count</p>
6730+
* <p>Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution
6731+
* Timestamp</p>
6732+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions">Campaign
6733+
* send exclusions</a>
6734+
* </p>
6735+
* </dd>
67146736
* <dt>CASES_CREATED</dt>
67156737
* <dd>
67166738
* <p>Unit: Count</p>
@@ -7099,6 +7121,38 @@ export interface GetMetricDataV2Request {
70997121
* talk time percent</a>
71007122
* </p>
71017123
* </dd>
7124+
* <dt>RECIPIENTS_ATTEMPTED</dt>
7125+
* <dd>
7126+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
7127+
* It is not available for event triggered campaigns.</p>
7128+
* <p>Unit: Count</p>
7129+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
7130+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted">Recipients
7131+
* attempted</a>
7132+
* </p>
7133+
* </dd>
7134+
* <dt>RECIPIENTS_INTERACTED</dt>
7135+
* <dd>
7136+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
7137+
* It is not available for event triggered campaigns.</p>
7138+
* <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p>
7139+
* <p>Unit: Count</p>
7140+
* <p>Valid groupings and filters: Campaign, Channel,
7141+
* contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp</p>
7142+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted">Recipients
7143+
* interacted</a>
7144+
* </p>
7145+
* </dd>
7146+
* <dt>RECIPIENTS_TARGETED</dt>
7147+
* <dd>
7148+
* <p>This metric is only available for outbound campaigns initiated using a customer segment.
7149+
* It is not available for event triggered campaigns.</p>
7150+
* <p>Unit: Count</p>
7151+
* <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
7152+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted">Recipients
7153+
* targeted</a>
7154+
* </p>
7155+
* </dd>
71027156
* <dt>REOPENED_CASE_ACTIONS</dt>
71037157
* <dd>
71047158
* <p>Unit: Count</p>

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

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3665,7 +3665,7 @@ export interface EmailAddressMetadata {
36653665
EmailAddressArn?: string | undefined;
36663666

36673667
/**
3668-
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
3668+
* <p>The email address, including the domain.</p>
36693669
* @public
36703670
*/
36713671
EmailAddress?: string | undefined;
@@ -5021,12 +5021,12 @@ export interface SendChatIntegrationEventResponse {
50215021
}
50225022

50235023
/**
5024-
* <p>Contains information about a source or destination email address</p>
5024+
* <p>Contains information about a source or destination email address.</p>
50255025
* @public
50265026
*/
50275027
export interface EmailAddressInfo {
50285028
/**
5029-
* <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
5029+
* <p>The email address, including the domain.</p>
50305030
* @public
50315031
*/
50325032
EmailAddress: string | undefined;
@@ -5039,12 +5039,14 @@ export interface EmailAddressInfo {
50395039
}
50405040

50415041
/**
5042-
* <p>The additional recipients information of outbound email.</p>
5042+
* <p>Information about the additional recipients of outbound email.</p>
50435043
* @public
50445044
*/
50455045
export interface OutboundAdditionalRecipients {
50465046
/**
5047-
* <p>The additional CC email address recipients information.</p>
5047+
* <p>Information about the <b>additional</b> CC email address recipients.
5048+
* Email recipients are limited to 50 total addresses: 1 required recipient in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SendOutboundEmail.html#API_SendOutboundEmail_RequestBody">DestinationEmailAddress</a> field and up to 49 recipients in the 'CcEmailAddresses'
5049+
* field.</p>
50485050
* @public
50495051
*/
50505052
CcEmailAddresses?: EmailAddressInfo[] | undefined;
@@ -5676,18 +5678,28 @@ export interface StartContactStreamingResponse {
56765678
}
56775679

56785680
/**
5679-
* <p>The additional TO CC recipients information of inbound email.</p>
5681+
* <p>Information about the additional TO and CC recipients of an inbound email contact.</p>
5682+
* <note>
5683+
* <p>You can include up to 50 email addresses in total, distributed across
5684+
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartEmailContact.html#API_StartEmailContact_RequestBody">DestinationEmailAddress</a>, <code>ToAddresses</code>, and <code>CcAddresses</code>. This total must include one required
5685+
* <code>DestinationEmailAddress</code>. You can then specify up to 49 addresses allocated across <code>ToAddresses</code>
5686+
* and <code>CcAddresses</code> as needed.</p>
5687+
* </note>
56805688
* @public
56815689
*/
56825690
export interface InboundAdditionalRecipients {
56835691
/**
5684-
* <p>The additional recipients information present in to list.</p>
5692+
* <p>The <b>additional</b> recipients information present in to list.
5693+
* You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to
5694+
* 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>
56855695
* @public
56865696
*/
56875697
ToAddresses?: EmailAddressInfo[] | undefined;
56885698

56895699
/**
5690-
* <p>The additional recipients information present in cc list.</p>
5700+
* <p>The <b>additional</b> recipients information present in cc list.
5701+
* You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to
5702+
* 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>
56915703
* @public
56925704
*/
56935705
CcAddresses?: EmailAddressInfo[] | undefined;
@@ -5828,7 +5840,7 @@ export interface StartOutboundEmailContactRequest {
58285840
ContactId: string | undefined;
58295841

58305842
/**
5831-
* <p>The email address associated with the instance.</p>
5843+
* <p>The email address associated with the Amazon Connect instance.</p>
58325844
* @public
58335845
*/
58345846
FromEmailAddress?: EmailAddressInfo | undefined;
@@ -5840,7 +5852,7 @@ export interface StartOutboundEmailContactRequest {
58405852
DestinationEmailAddress: EmailAddressInfo | undefined;
58415853

58425854
/**
5843-
* <p>The addtional recipients address of email in CC.</p>
5855+
* <p>The additional recipients address of email in CC.</p>
58445856
* @public
58455857
*/
58465858
AdditionalRecipients?: OutboundAdditionalRecipients | undefined;

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1461,6 +1461,10 @@ export interface CreateContactRequest {
14611461

14621462
/**
14631463
* <p>User details for the contact</p>
1464+
* <important>
1465+
* <p>UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact
1466+
* initiation methods.</p>
1467+
* </important>
14641468
* @public
14651469
*/
14661470
UserInfo?: UserInfo | undefined;
@@ -2024,8 +2028,7 @@ export interface StartChatContactRequest {
20242028
ParticipantDetails: ParticipantDetails | undefined;
20252029

20262030
/**
2027-
* <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
2028-
* flow, the initial message is not delivered to the Lex bot.</p>
2031+
* <p>The initial message to be sent to the newly created chat.</p>
20292032
* @public
20302033
*/
20312034
InitialMessage?: ChatMessage | undefined;
@@ -2125,7 +2128,7 @@ export interface StartEmailContactRequest {
21252128
FromEmailAddress: EmailAddressInfo | undefined;
21262129

21272130
/**
2128-
* <p>The email address associated with the instance.</p>
2131+
* <p>The email address associated with the Amazon Connect instance.</p>
21292132
* @public
21302133
*/
21312134
DestinationEmailAddress: string | undefined;

0 commit comments

Comments
 (0)