@aws-sdk/client-connect 3.830.0 → 3.839.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist-cjs/index.js CHANGED
@@ -1257,6 +1257,7 @@ var ConflictException = class _ConflictException extends ConnectServiceException
1257
1257
  }
1258
1258
  };
1259
1259
  var InitiateAs = {
1260
+ COMPLETED: "COMPLETED",
1260
1261
  CONNECTED_TO_USER: "CONNECTED_TO_USER"
1261
1262
  };
1262
1263
  var ReferenceStatus = {
@@ -386,6 +386,7 @@ export class ConflictException extends __BaseException {
386
386
  }
387
387
  }
388
388
  export const InitiateAs = {
389
+ COMPLETED: "COMPLETED",
389
390
  CONNECTED_TO_USER: "CONNECTED_TO_USER",
390
391
  };
391
392
  export const ReferenceStatus = {
@@ -62,7 +62,7 @@ declare const CreateContactCommand_base: {
62
62
  * UserInfo: { // UserInfo
63
63
  * UserId: "STRING_VALUE",
64
64
  * },
65
- * InitiateAs: "CONNECTED_TO_USER",
65
+ * InitiateAs: "CONNECTED_TO_USER" || "COMPLETED",
66
66
  * Name: "STRING_VALUE",
67
67
  * Description: "STRING_VALUE",
68
68
  * SegmentAttributes: { // SegmentAttributes
@@ -28,6 +28,11 @@ declare const DescribeRoutingProfileCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Describes the specified routing profile.</p>
31
+ * <note>
32
+ * <p>
33
+ * <code>DescribeRoutingProfile</code> does not populate AssociatedQueueIds in its response.
34
+ * 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>
35
+ * </note>
31
36
  * @example
32
37
  * Use a bare-bones client and the command you need to make an API call.
33
38
  * ```javascript
@@ -29,6 +29,11 @@ declare const SearchRoutingProfilesCommand_base: {
29
29
  };
30
30
  /**
31
31
  * <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
32
+ * <note>
33
+ * <p>
34
+ * <code>SearchRoutingProfiles</code> does not populate LastModifiedRegion, LastModifiedTime,
35
+ * 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>
36
+ * </note>
32
37
  * @example
33
38
  * Use a bare-bones client and the command you need to make an API call.
34
39
  * ```javascript
@@ -8,7 +8,7 @@ export interface ClientInputEndpointParameters {
8
8
  useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
9
9
  endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
10
10
  }
11
- export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
11
+ export type ClientResolvedEndpointParameters = Omit<ClientInputEndpointParameters, "endpoint"> & {
12
12
  defaultSigningName: string;
13
13
  };
14
14
  export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientResolvedEndpointParameters;
@@ -2562,6 +2562,7 @@ export declare class ConflictException extends __BaseException {
2562
2562
  * @enum
2563
2563
  */
2564
2564
  export declare const InitiateAs: {
2565
+ readonly COMPLETED: "COMPLETED";
2565
2566
  readonly CONNECTED_TO_USER: "CONNECTED_TO_USER";
2566
2567
  };
2567
2568
  /**
@@ -2925,7 +2926,7 @@ export interface CreateEmailAddressRequest {
2925
2926
  */
2926
2927
  InstanceId: string | undefined;
2927
2928
  /**
2928
- * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
2929
+ * <p>The email address, including the domain.</p>
2929
2930
  * @public
2930
2931
  */
2931
2932
  EmailAddress: string | undefined;
@@ -4226,7 +4227,7 @@ export interface OutboundCallerConfig {
4226
4227
  OutboundFlowId?: string | undefined;
4227
4228
  }
4228
4229
  /**
4229
- * <p>The outbound email address Id.</p>
4230
+ * <p>The outbound email address ID.</p>
4230
4231
  * @public
4231
4232
  */
4232
4233
  export interface OutboundEmailConfig {
@@ -1342,7 +1342,7 @@ export interface DescribeEmailAddressResponse {
1342
1342
  */
1343
1343
  EmailAddressArn?: string | undefined;
1344
1344
  /**
1345
- * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
1345
+ * <p>The email address, including the domain.</p>
1346
1346
  * @public
1347
1347
  */
1348
1348
  EmailAddress?: string | undefined;
@@ -5425,8 +5425,8 @@ export interface GetMetricDataV2Request {
5425
5425
  * <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>ANSWERING_MACHINE_DETECTION_STATUS</code> |
5426
5426
  * <code> BOT_ID</code> | <code>BOT_ALIAS</code> | <code>BOT_VERSION</code> |
5427
5427
  * <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> | <code>CAMPAIGN</code> |
5428
- * <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> |
5429
- * <code>CASE_STATUS</code> | <code>CHANNEL</code> |
5428
+ * <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> | <code>CAMPAIGN_EXCLUDED_EVENT_TYPE </code> |
5429
+ * <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
5430
5430
  * <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
5431
5431
  * <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
5432
5432
  * <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> |
@@ -5489,6 +5489,7 @@ export interface GetMetricDataV2Request {
5489
5489
  * <code>ANSWERING_MACHINE_DETECTION_STATUS</code> | <code>BOT_ID</code> | <code>BOT_ALIAS</code> |
5490
5490
  * <code>BOT_VERSION</code> | <code>BOT_LOCALE</code> | <code>BOT_INTENT_NAME</code> |
5491
5491
  * <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
5492
+ * <code>CAMPAIGN_EXCLUDED_EVENT_TYPE</code> | <code>CAMPAIGN_EXECUTION_TIMESTAMP</code> |
5492
5493
  * <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
5493
5494
  * <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
5494
5495
  * <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
@@ -5962,6 +5963,16 @@ export interface GetMetricDataV2Request {
5962
5963
  * interactions</a>
5963
5964
  * </p>
5964
5965
  * </dd>
5966
+ * <dt>CAMPAIGN_PROGRESS_RATE</dt>
5967
+ * <dd>
5968
+ * <p>This metric is only available for outbound campaigns initiated using a customer segment.
5969
+ * It is not available for event triggered campaigns.</p>
5970
+ * <p>Unit: Percent</p>
5971
+ * <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
5972
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-progress-rate">Campaign
5973
+ * progress rate</a>
5974
+ * </p>
5975
+ * </dd>
5965
5976
  * <dt>CAMPAIGN_SEND_ATTEMPTS</dt>
5966
5977
  * <dd>
5967
5978
  * <p>This metric is available only for outbound campaigns.</p>
@@ -5971,6 +5982,17 @@ export interface GetMetricDataV2Request {
5971
5982
  * attempts</a>
5972
5983
  * </p>
5973
5984
  * </dd>
5985
+ * <dt>CAMPAIGN_SEND_EXCLUSIONS</dt>
5986
+ * <dd>
5987
+ * <p>This metric is available only for outbound campaigns.</p>
5988
+ * <p>Valid metric filter key: CAMPAIGN_EXCLUDED_EVENT_TYPE</p>
5989
+ * <p>Unit: Count</p>
5990
+ * <p>Valid groupings and filters: Campaign, Campaign Excluded Event Type, Campaign Execution
5991
+ * Timestamp</p>
5992
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-exclusions">Campaign
5993
+ * send exclusions</a>
5994
+ * </p>
5995
+ * </dd>
5974
5996
  * <dt>CASES_CREATED</dt>
5975
5997
  * <dd>
5976
5998
  * <p>Unit: Count</p>
@@ -6359,6 +6381,38 @@ export interface GetMetricDataV2Request {
6359
6381
  * talk time percent</a>
6360
6382
  * </p>
6361
6383
  * </dd>
6384
+ * <dt>RECIPIENTS_ATTEMPTED</dt>
6385
+ * <dd>
6386
+ * <p>This metric is only available for outbound campaigns initiated using a customer segment.
6387
+ * It is not available for event triggered campaigns.</p>
6388
+ * <p>Unit: Count</p>
6389
+ * <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
6390
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-attempted">Recipients
6391
+ * attempted</a>
6392
+ * </p>
6393
+ * </dd>
6394
+ * <dt>RECIPIENTS_INTERACTED</dt>
6395
+ * <dd>
6396
+ * <p>This metric is only available for outbound campaigns initiated using a customer segment.
6397
+ * It is not available for event triggered campaigns.</p>
6398
+ * <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p>
6399
+ * <p>Unit: Count</p>
6400
+ * <p>Valid groupings and filters: Campaign, Channel,
6401
+ * contact/segmentAttributes/connect:Subtype, Campaign Execution Timestamp</p>
6402
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-interacted">Recipients
6403
+ * interacted</a>
6404
+ * </p>
6405
+ * </dd>
6406
+ * <dt>RECIPIENTS_TARGETED</dt>
6407
+ * <dd>
6408
+ * <p>This metric is only available for outbound campaigns initiated using a customer segment.
6409
+ * It is not available for event triggered campaigns.</p>
6410
+ * <p>Unit: Count</p>
6411
+ * <p>Valid groupings and filters: Campaign, Campaign Execution Timestamp</p>
6412
+ * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#recipients-targeted">Recipients
6413
+ * targeted</a>
6414
+ * </p>
6415
+ * </dd>
6362
6416
  * <dt>REOPENED_CASE_ACTIONS</dt>
6363
6417
  * <dd>
6364
6418
  * <p>Unit: Count</p>
@@ -3141,7 +3141,7 @@ export interface EmailAddressMetadata {
3141
3141
  */
3142
3142
  EmailAddressArn?: string | undefined;
3143
3143
  /**
3144
- * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
3144
+ * <p>The email address, including the domain.</p>
3145
3145
  * @public
3146
3146
  */
3147
3147
  EmailAddress?: string | undefined;
@@ -4349,12 +4349,12 @@ export interface SendChatIntegrationEventResponse {
4349
4349
  NewChatCreated?: boolean | undefined;
4350
4350
  }
4351
4351
  /**
4352
- * <p>Contains information about a source or destination email address</p>
4352
+ * <p>Contains information about a source or destination email address.</p>
4353
4353
  * @public
4354
4354
  */
4355
4355
  export interface EmailAddressInfo {
4356
4356
  /**
4357
- * <p>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</p>
4357
+ * <p>The email address, including the domain.</p>
4358
4358
  * @public
4359
4359
  */
4360
4360
  EmailAddress: string | undefined;
@@ -4365,12 +4365,14 @@ export interface EmailAddressInfo {
4365
4365
  DisplayName?: string | undefined;
4366
4366
  }
4367
4367
  /**
4368
- * <p>The additional recipients information of outbound email.</p>
4368
+ * <p>Information about the additional recipients of outbound email.</p>
4369
4369
  * @public
4370
4370
  */
4371
4371
  export interface OutboundAdditionalRecipients {
4372
4372
  /**
4373
- * <p>The additional CC email address recipients information.</p>
4373
+ * <p>Information about the <b>additional</b> CC email address recipients.
4374
+ * 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'
4375
+ * field.</p>
4374
4376
  * @public
4375
4377
  */
4376
4378
  CcEmailAddresses?: EmailAddressInfo[] | undefined;
@@ -4929,17 +4931,27 @@ export interface StartContactStreamingResponse {
4929
4931
  StreamingId: string | undefined;
4930
4932
  }
4931
4933
  /**
4932
- * <p>The additional TO CC recipients information of inbound email.</p>
4934
+ * <p>Information about the additional TO and CC recipients of an inbound email contact.</p>
4935
+ * <note>
4936
+ * <p>You can include up to 50 email addresses in total, distributed across
4937
+ * <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
4938
+ * <code>DestinationEmailAddress</code>. You can then specify up to 49 addresses allocated across <code>ToAddresses</code>
4939
+ * and <code>CcAddresses</code> as needed.</p>
4940
+ * </note>
4933
4941
  * @public
4934
4942
  */
4935
4943
  export interface InboundAdditionalRecipients {
4936
4944
  /**
4937
- * <p>The additional recipients information present in to list.</p>
4945
+ * <p>The <b>additional</b> recipients information present in to list.
4946
+ * You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to
4947
+ * 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>
4938
4948
  * @public
4939
4949
  */
4940
4950
  ToAddresses?: EmailAddressInfo[] | undefined;
4941
4951
  /**
4942
- * <p>The additional recipients information present in cc list.</p>
4952
+ * <p>The <b>additional</b> recipients information present in cc list.
4953
+ * You must have 1 required recipient (<code>DestinationEmailAddress</code>). You can then specify up to
4954
+ * 49 additional recipients (across <code>ToAddresses</code> and <code>CcAddresses</code>), for a total of 50 recipients.</p>
4943
4955
  * @public
4944
4956
  */
4945
4957
  CcAddresses?: EmailAddressInfo[] | undefined;
@@ -5063,7 +5075,7 @@ export interface StartOutboundEmailContactRequest {
5063
5075
  */
5064
5076
  ContactId: string | undefined;
5065
5077
  /**
5066
- * <p>The email address associated with the instance.</p>
5078
+ * <p>The email address associated with the Amazon Connect instance.</p>
5067
5079
  * @public
5068
5080
  */
5069
5081
  FromEmailAddress?: EmailAddressInfo | undefined;
@@ -5073,7 +5085,7 @@ export interface StartOutboundEmailContactRequest {
5073
5085
  */
5074
5086
  DestinationEmailAddress: EmailAddressInfo | undefined;
5075
5087
  /**
5076
- * <p>The addtional recipients address of email in CC.</p>
5088
+ * <p>The additional recipients address of email in CC.</p>
5077
5089
  * @public
5078
5090
  */
5079
5091
  AdditionalRecipients?: OutboundAdditionalRecipients | undefined;
@@ -1184,6 +1184,10 @@ export interface CreateContactRequest {
1184
1184
  ExpiryDurationInMinutes?: number | undefined;
1185
1185
  /**
1186
1186
  * <p>User details for the contact</p>
1187
+ * <important>
1188
+ * <p>UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact
1189
+ * initiation methods.</p>
1190
+ * </important>
1187
1191
  * @public
1188
1192
  */
1189
1193
  UserInfo?: UserInfo | undefined;
@@ -1677,8 +1681,7 @@ export interface StartChatContactRequest {
1677
1681
  */
1678
1682
  ParticipantDetails: ParticipantDetails | undefined;
1679
1683
  /**
1680
- * <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
1681
- * flow, the initial message is not delivered to the Lex bot.</p>
1684
+ * <p>The initial message to be sent to the newly created chat.</p>
1682
1685
  * @public
1683
1686
  */
1684
1687
  InitialMessage?: ChatMessage | undefined;
@@ -1768,7 +1771,7 @@ export interface StartEmailContactRequest {
1768
1771
  */
1769
1772
  FromEmailAddress: EmailAddressInfo | undefined;
1770
1773
  /**
1771
- * <p>The email address associated with the instance.</p>
1774
+ * <p>The email address associated with the Amazon Connect instance.</p>
1772
1775
  * @public
1773
1776
  */
1774
1777
  DestinationEmailAddress: string | undefined;
@@ -16,7 +16,10 @@ export interface ClientInputEndpointParameters {
16
16
  | EndpointV2
17
17
  | Provider<EndpointV2>;
18
18
  }
19
- export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
19
+ export type ClientResolvedEndpointParameters = Pick<
20
+ ClientInputEndpointParameters,
21
+ Exclude<keyof ClientInputEndpointParameters, "endpoint">
22
+ > & {
20
23
  defaultSigningName: string;
21
24
  };
22
25
  export declare const resolveClientEndpointParameters: <T>(
@@ -812,6 +812,7 @@ export declare class ConflictException extends __BaseException {
812
812
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
813
813
  }
814
814
  export declare const InitiateAs: {
815
+ readonly COMPLETED: "COMPLETED";
815
816
  readonly CONNECTED_TO_USER: "CONNECTED_TO_USER";
816
817
  };
817
818
  export type InitiateAs = (typeof InitiateAs)[keyof typeof InitiateAs];
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connect",
3
3
  "description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
4
- "version": "3.830.0",
4
+ "version": "3.839.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-connect",
@@ -20,41 +20,41 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.826.0",
24
- "@aws-sdk/credential-provider-node": "3.830.0",
23
+ "@aws-sdk/core": "3.839.0",
24
+ "@aws-sdk/credential-provider-node": "3.839.0",
25
25
  "@aws-sdk/middleware-host-header": "3.821.0",
26
26
  "@aws-sdk/middleware-logger": "3.821.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.821.0",
28
- "@aws-sdk/middleware-user-agent": "3.828.0",
28
+ "@aws-sdk/middleware-user-agent": "3.839.0",
29
29
  "@aws-sdk/region-config-resolver": "3.821.0",
30
30
  "@aws-sdk/types": "3.821.0",
31
31
  "@aws-sdk/util-endpoints": "3.828.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.821.0",
33
- "@aws-sdk/util-user-agent-node": "3.828.0",
33
+ "@aws-sdk/util-user-agent-node": "3.839.0",
34
34
  "@smithy/config-resolver": "^4.1.4",
35
- "@smithy/core": "^3.5.3",
35
+ "@smithy/core": "^3.6.0",
36
36
  "@smithy/fetch-http-handler": "^5.0.4",
37
37
  "@smithy/hash-node": "^4.0.4",
38
38
  "@smithy/invalid-dependency": "^4.0.4",
39
39
  "@smithy/middleware-content-length": "^4.0.4",
40
- "@smithy/middleware-endpoint": "^4.1.11",
41
- "@smithy/middleware-retry": "^4.1.12",
40
+ "@smithy/middleware-endpoint": "^4.1.13",
41
+ "@smithy/middleware-retry": "^4.1.14",
42
42
  "@smithy/middleware-serde": "^4.0.8",
43
43
  "@smithy/middleware-stack": "^4.0.4",
44
44
  "@smithy/node-config-provider": "^4.1.3",
45
45
  "@smithy/node-http-handler": "^4.0.6",
46
46
  "@smithy/protocol-http": "^5.1.2",
47
- "@smithy/smithy-client": "^4.4.3",
47
+ "@smithy/smithy-client": "^4.4.5",
48
48
  "@smithy/types": "^4.3.1",
49
49
  "@smithy/url-parser": "^4.0.4",
50
50
  "@smithy/util-base64": "^4.0.0",
51
51
  "@smithy/util-body-length-browser": "^4.0.0",
52
52
  "@smithy/util-body-length-node": "^4.0.0",
53
- "@smithy/util-defaults-mode-browser": "^4.0.19",
54
- "@smithy/util-defaults-mode-node": "^4.0.19",
53
+ "@smithy/util-defaults-mode-browser": "^4.0.21",
54
+ "@smithy/util-defaults-mode-node": "^4.0.21",
55
55
  "@smithy/util-endpoints": "^3.0.6",
56
56
  "@smithy/util-middleware": "^4.0.4",
57
- "@smithy/util-retry": "^4.0.5",
57
+ "@smithy/util-retry": "^4.0.6",
58
58
  "@smithy/util-utf8": "^4.0.0",
59
59
  "@types/uuid": "^9.0.1",
60
60
  "tslib": "^2.6.2",