@aws-sdk/client-connect 3.699.0 → 3.703.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.
Files changed (73) hide show
  1. package/README.md +1 -1
  2. package/dist-cjs/index.js +123 -49
  3. package/dist-es/commands/CreateContactCommand.js +1 -1
  4. package/dist-es/commands/StartEmailContactCommand.js +1 -1
  5. package/dist-es/commands/StartTaskContactCommand.js +1 -1
  6. package/dist-es/commands/UpdateContactCommand.js +1 -1
  7. package/dist-es/models/models_0.js +6 -5
  8. package/dist-es/models/models_1.js +5 -0
  9. package/dist-es/models/models_2.js +13 -27
  10. package/dist-es/models/models_3.js +23 -0
  11. package/dist-es/protocols/Aws_restJson1.js +64 -8
  12. package/dist-types/Connect.d.ts +1 -1
  13. package/dist-types/ConnectClient.d.ts +1 -1
  14. package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
  15. package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
  16. package/dist-types/commands/CreateContactCommand.d.ts +13 -2
  17. package/dist-types/commands/CreateEmailAddressCommand.d.ts +3 -1
  18. package/dist-types/commands/CreateEvaluationFormCommand.d.ts +1 -1
  19. package/dist-types/commands/CreateIntegrationAssociationCommand.d.ts +1 -1
  20. package/dist-types/commands/DeleteEmailAddressCommand.d.ts +1 -1
  21. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -2
  22. package/dist-types/commands/DeleteVocabularyCommand.d.ts +2 -1
  23. package/dist-types/commands/DescribeContactCommand.d.ts +10 -0
  24. package/dist-types/commands/DescribeContactFlowCommand.d.ts +1 -2
  25. package/dist-types/commands/DescribeContactFlowModuleCommand.d.ts +1 -1
  26. package/dist-types/commands/DescribeEmailAddressCommand.d.ts +1 -1
  27. package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -1
  28. package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
  29. package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
  30. package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
  31. package/dist-types/commands/ListAssociatedContactsCommand.d.ts +2 -1
  32. package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
  33. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
  34. package/dist-types/commands/ListRealtimeContactAnalysisSegmentsV2Command.d.ts +1 -1
  35. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
  36. package/dist-types/commands/SearchContactFlowsCommand.d.ts +1 -3
  37. package/dist-types/commands/SearchEmailAddressesCommand.d.ts +1 -1
  38. package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +1 -1
  39. package/dist-types/commands/SendOutboundEmailCommand.d.ts +6 -1
  40. package/dist-types/commands/StartAttachedFileUploadCommand.d.ts +3 -1
  41. package/dist-types/commands/StartChatContactCommand.d.ts +12 -1
  42. package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
  43. package/dist-types/commands/StartEmailContactCommand.d.ts +14 -2
  44. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +14 -3
  45. package/dist-types/commands/StartOutboundEmailContactCommand.d.ts +2 -1
  46. package/dist-types/commands/StartTaskContactCommand.d.ts +12 -1
  47. package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
  48. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
  49. package/dist-types/commands/TagResourceCommand.d.ts +2 -2
  50. package/dist-types/commands/UpdateContactCommand.d.ts +33 -1
  51. package/dist-types/commands/UpdateContactFlowContentCommand.d.ts +1 -1
  52. package/dist-types/commands/UpdateContactFlowModuleContentCommand.d.ts +1 -1
  53. package/dist-types/commands/UpdateEmailAddressMetadataCommand.d.ts +2 -1
  54. package/dist-types/commands/UpdateQueueOutboundEmailConfigCommand.d.ts +2 -2
  55. package/dist-types/index.d.ts +1 -1
  56. package/dist-types/models/models_0.d.ts +87 -119
  57. package/dist-types/models/models_1.d.ts +238 -89
  58. package/dist-types/models/models_2.d.ts +442 -699
  59. package/dist-types/models/models_3.d.ts +598 -127
  60. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +2 -4
  61. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  62. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +4 -2
  63. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +2 -4
  64. package/dist-types/ts3.4/commands/StartChatContactCommand.d.ts +2 -4
  65. package/dist-types/ts3.4/commands/StartEmailContactCommand.d.ts +2 -4
  66. package/dist-types/ts3.4/commands/StartOutboundChatContactCommand.d.ts +2 -4
  67. package/dist-types/ts3.4/commands/StartTaskContactCommand.d.ts +2 -4
  68. package/dist-types/ts3.4/commands/UpdateContactCommand.d.ts +2 -4
  69. package/dist-types/ts3.4/models/models_0.d.ts +11 -21
  70. package/dist-types/ts3.4/models/models_1.d.ts +18 -6
  71. package/dist-types/ts3.4/models/models_2.d.ts +63 -96
  72. package/dist-types/ts3.4/models/models_3.d.ts +99 -27
  73. package/package.json +1 -1
@@ -1,94 +1,18 @@
1
- import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, EvaluationFormScoringStrategy, SegmentAttributeValue, StringCondition } from "./models_0";
2
- import { AnsweringMachineDetectionStatus, AttributeCondition, ContactFlowState, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, RoutingCriteriaStepStatus, WisdomInfo } from "./models_1";
3
- import { AgentStatusSearchCriteria, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, ContactFlowSearchFilter, EmailAddressSearchFilter, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, ListCondition, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
1
+ import { AdditionalEmailRecipients, AgentInfo, AgentStatusSearchFilter, Campaign, Channel, ContactInitiationMethod, Endpoint, EvaluationFormScoringStrategy, Reference, StringCondition, UserInfo } from "./models_0";
2
+ import { AnsweringMachineDetectionStatus, AttributeCondition, Customer, CustomerVoiceActivity, DisconnectDetails, EndpointInfo, Evaluation, EvaluationFormVersionStatus, Expiry, QualityMetrics, QueueInfo, RoutingCriteriaStepStatus, WisdomInfo } from "./models_1";
3
+ import { AgentStatusSearchCriteria, ChatMessage, ContactFlowModuleSearchCriteria, ContactFlowModuleSearchFilter, ContactFlowSearchCriteria, ContactFlowSearchFilter, EmailAddressInfo, EmailAddressSearchFilter, EmailAttachment, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchFilter, InboundAdditionalRecipients, InboundEmailContent, ListCondition, ParticipantDetails, PersistentChat, PromptSearchFilter, QueueInfoInput, QueueSearchFilter, QuickConnectSearchFilter, RoutingCriteriaInputStepExpiry, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, SegmentAttributeValue, UserHierarchyGroupSearchFilter, UserSearchFilter } from "./models_2";
4
4
  /**
5
- * <p>The search criteria to be used to return contact flows.</p>
6
- * @public
7
- */
8
- export interface ContactFlowSearchCriteria {
9
- /**
10
- * <p>A list of conditions which would be applied together with an <code>OR</code>
11
- * condition.</p>
12
- * @public
13
- */
14
- OrConditions?: ContactFlowSearchCriteria[] | undefined;
15
- /**
16
- * <p>A list of conditions which would be applied together with an <code>AND</code>
17
- * condition.</p>
18
- * @public
19
- */
20
- AndConditions?: ContactFlowSearchCriteria[] | undefined;
21
- /**
22
- * <p>A leaf node condition which can be used to specify a string condition.</p>
23
- * @public
24
- */
25
- StringCondition?: StringCondition | undefined;
26
- /**
27
- * <p>The type of flow.</p>
28
- * @public
29
- */
30
- TypeCondition?: ContactFlowType | undefined;
31
- /**
32
- * <p>The state of the flow.</p>
33
- * @public
34
- */
35
- StateCondition?: ContactFlowState | undefined;
36
- /**
37
- * <p>The status of the flow.</p>
38
- * @public
39
- */
40
- StatusCondition?: ContactFlowStatus | undefined;
41
- }
42
- /**
43
- * @public
44
- */
45
- export interface CreateEvaluationFormRequest {
46
- /**
47
- * <p>The identifier of the Amazon Connect instance. 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>
48
- * @public
49
- */
50
- InstanceId: string | undefined;
51
- /**
52
- * <p>A title of the evaluation form.</p>
53
- * @public
54
- */
55
- Title: string | undefined;
56
- /**
57
- * <p>The description of the evaluation form.</p>
58
- * @public
59
- */
60
- Description?: string | undefined;
61
- /**
62
- * <p>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</p>
63
- * @public
64
- */
65
- Items: EvaluationFormItem[] | undefined;
66
- /**
67
- * <p>A scoring strategy of the evaluation form.</p>
68
- * @public
69
- */
70
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
71
- /**
72
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
73
- * request. If not provided, the Amazon Web Services
74
- * SDK populates this field. For more information about idempotency, see
75
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
76
- * @public
77
- */
78
- ClientToken?: string | undefined;
79
- }
80
- /**
81
- * <p></p>
5
+ * <p>The search criteria to be used to return email addresses.</p>
82
6
  * @public
83
7
  */
84
8
  export interface EmailAddressSearchCriteria {
85
9
  /**
86
- * <p></p>
10
+ * <p>A list of conditions which would be applied together with an OR condition.</p>
87
11
  * @public
88
12
  */
89
13
  OrConditions?: EmailAddressSearchCriteria[] | undefined;
90
14
  /**
91
- * <p></p>
15
+ * <p>A list of conditions which would be applied together with an AND condition.</p>
92
16
  * @public
93
17
  */
94
18
  AndConditions?: EmailAddressSearchCriteria[] | undefined;
@@ -426,6 +350,536 @@ export interface SecurityProfileSearchCriteria {
426
350
  */
427
351
  StringCondition?: StringCondition | undefined;
428
352
  }
353
+ /**
354
+ * @public
355
+ */
356
+ export interface StartChatContactRequest {
357
+ /**
358
+ * <p>The identifier of the Amazon Connect instance. 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>
359
+ * @public
360
+ */
361
+ InstanceId: string | undefined;
362
+ /**
363
+ * <p>The identifier of the flow for initiating the chat.
364
+ * To
365
+ * see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page,
366
+ * under the name of the flow, choose <b>Show additional flow
367
+ * information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </p>
368
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
369
+ * </p>
370
+ * @public
371
+ */
372
+ ContactFlowId: string | undefined;
373
+ /**
374
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows just like any other contact attributes. </p>
375
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
376
+ * can include only alphanumeric, dash, and underscore characters.</p>
377
+ * @public
378
+ */
379
+ Attributes?: Record<string, string> | undefined;
380
+ /**
381
+ * <p>Information identifying the participant.</p>
382
+ * @public
383
+ */
384
+ ParticipantDetails: ParticipantDetails | undefined;
385
+ /**
386
+ * <p>The initial message to be sent to the newly created chat. If you have a Lex bot in your
387
+ * flow, the initial message is not delivered to the Lex bot.</p>
388
+ * @public
389
+ */
390
+ InitialMessage?: ChatMessage | undefined;
391
+ /**
392
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
393
+ * request. If not provided, the Amazon Web Services
394
+ * SDK populates this field. For more information about idempotency, see
395
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
396
+ * @public
397
+ */
398
+ ClientToken?: string | undefined;
399
+ /**
400
+ * <p>The total duration of the newly started chat session. If not specified, the chat session
401
+ * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
402
+ * configurable time is 10,080 minutes (7 days).</p>
403
+ * @public
404
+ */
405
+ ChatDurationInMinutes?: number | undefined;
406
+ /**
407
+ * <p>The supported chat message content types. Supported types are <code>text/plain</code>,
408
+ * <code>text/markdown</code>, <code>application/json</code>,
409
+ * <code>application/vnd.amazonaws.connect.message.interactive</code>, and
410
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>. </p>
411
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other
412
+ * supported type in the list. For example, all the following lists are valid because they contain
413
+ * <code>text/plain</code>: <code>[text/plain, text/markdown, application/json]</code>,
414
+ * <code>[text/markdown, text/plain]</code>, <code>[text/plain, application/json,
415
+ * application/vnd.amazonaws.connect.message.interactive.response]</code>. </p>
416
+ * <note>
417
+ * <p>The type <code>application/vnd.amazonaws.connect.message.interactive</code> is required to
418
+ * use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show
419
+ * view</a> flow block.</p>
420
+ * </note>
421
+ * @public
422
+ */
423
+ SupportedMessagingContentTypes?: string[] | undefined;
424
+ /**
425
+ * <p>Enable persistent chats. For more information about enabling persistent chat, and for
426
+ * example use cases and how to configure for them, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>.</p>
427
+ * @public
428
+ */
429
+ PersistentChat?: PersistentChat | undefined;
430
+ /**
431
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
432
+ * chat starting.</p>
433
+ * <note>
434
+ * <p>You cannot provide data for both RelatedContactId and PersistentChat. </p>
435
+ * </note>
436
+ * @public
437
+ */
438
+ RelatedContactId?: string | undefined;
439
+ /**
440
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
441
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
442
+ * flows.</p>
443
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
444
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
445
+ * <note>
446
+ * <p>The types <code>application/vnd.amazonaws.connect.message.interactive</code> and
447
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code> must be present in
448
+ * the SupportedMessagingContentTypes field of this API in order to set
449
+ * <code>SegmentAttributes</code> as \{<code> "connect:Subtype": \{"valueString" : "connect:Guide"
450
+ * \}\}</code>.</p>
451
+ * </note>
452
+ * @public
453
+ */
454
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
455
+ }
456
+ /**
457
+ * @public
458
+ */
459
+ export interface StartEmailContactRequest {
460
+ /**
461
+ * <p>The identifier of the Amazon Connect instance. 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>
462
+ * @public
463
+ */
464
+ InstanceId: string | undefined;
465
+ /**
466
+ * <p>The email address of the customer.</p>
467
+ * @public
468
+ */
469
+ FromEmailAddress: EmailAddressInfo | undefined;
470
+ /**
471
+ * <p>The email address associated with the instance.</p>
472
+ * @public
473
+ */
474
+ DestinationEmailAddress: string | undefined;
475
+ /**
476
+ * <p>A description of the email contact.</p>
477
+ * @public
478
+ */
479
+ Description?: string | undefined;
480
+ /**
481
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can
482
+ * have the following reference types at the time of creation: <code>URL</code> |
483
+ * <code>NUMBER</code> | <code>STRING</code> | <code>DATE</code>. <code>EMAIL</code> |
484
+ * <code>EMAIL_MESSAGE</code> |<code>ATTACHMENT</code> are not a supported reference type during
485
+ * email creation.</p>
486
+ * @public
487
+ */
488
+ References?: Record<string, Reference> | undefined;
489
+ /**
490
+ * <p>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</p>
491
+ * @public
492
+ */
493
+ Name?: string | undefined;
494
+ /**
495
+ * <p>The email message body to be sent to the newly created email.</p>
496
+ * @public
497
+ */
498
+ EmailMessage: InboundEmailContent | undefined;
499
+ /**
500
+ * <p>The addtional recipients address of the email.</p>
501
+ * @public
502
+ */
503
+ AdditionalRecipients?: InboundAdditionalRecipients | undefined;
504
+ /**
505
+ * <p>List of S3 presigned URLs of email attachments and their file name. </p>
506
+ * @public
507
+ */
508
+ Attachments?: EmailAttachment[] | undefined;
509
+ /**
510
+ * <p>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website,
511
+ * on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
512
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
513
+ * part of the ARN, shown here in bold: </p>
514
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
515
+ * </p>
516
+ * @public
517
+ */
518
+ ContactFlowId?: string | undefined;
519
+ /**
520
+ * <p>The contactId that is related to this contact. Linking emails together by using
521
+ * <code>RelatedContactID</code> copies over contact attributes from the related email contact to
522
+ * the new email contact. All updates to user-defined attributes in the new email contact are
523
+ * limited to the individual contact ID. There are no limits to the number of contacts that can be
524
+ * linked by using <code>RelatedContactId</code>. </p>
525
+ * @public
526
+ */
527
+ RelatedContactId?: string | undefined;
528
+ /**
529
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
530
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
531
+ * can include only alphanumeric, dash, and underscore characters.</p>
532
+ * @public
533
+ */
534
+ Attributes?: Record<string, string> | undefined;
535
+ /**
536
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
537
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
538
+ * flows.</p>
539
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
540
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
541
+ * <note>
542
+ * <p>To set contact expiry, a <code>ValueMap</code> must be specified containing the integer
543
+ * number of minutes the contact will be active for before expiring, with
544
+ * <code>SegmentAttributes</code> like \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{
545
+ * "ExpiryDuration": \{ "ValueInteger":135\}\}\}\}</code>.</p>
546
+ * </note>
547
+ * @public
548
+ */
549
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
550
+ /**
551
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
552
+ * request. If not provided, the Amazon Web Services
553
+ * SDK populates this field. For more information about idempotency, see
554
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
555
+ * @public
556
+ */
557
+ ClientToken?: string | undefined;
558
+ }
559
+ /**
560
+ * @public
561
+ */
562
+ export interface StartOutboundChatContactRequest {
563
+ /**
564
+ * <p>Information about the endpoint.</p>
565
+ * @public
566
+ */
567
+ SourceEndpoint: Endpoint | undefined;
568
+ /**
569
+ * <p>Information about the endpoint.</p>
570
+ * @public
571
+ */
572
+ DestinationEndpoint: Endpoint | undefined;
573
+ /**
574
+ * <p>The identifier of the Amazon Connect instance. You can find the instance ID in the
575
+ * Amazon Resource Name (ARN) of the instance.</p>
576
+ * @public
577
+ */
578
+ InstanceId: string | undefined;
579
+ /**
580
+ * <p>A set of system defined key-value pairs stored on individual contact segments using an
581
+ * attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in
582
+ * flows.</p>
583
+ * <ul>
584
+ * <li>
585
+ * <p>Attribute keys can include only alphanumeric, <code>-</code>, and <code>_</code>.</p>
586
+ * </li>
587
+ * <li>
588
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code> and
589
+ * <code>connect:SMS</code>.</p>
590
+ * </li>
591
+ * </ul>
592
+ * @public
593
+ */
594
+ SegmentAttributes: Record<string, SegmentAttributeValue> | undefined;
595
+ /**
596
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
597
+ * @public
598
+ */
599
+ Attributes?: Record<string, string> | undefined;
600
+ /**
601
+ * <p>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect
602
+ * console user interface, on the navigation menu go to <b>Routing, Contact
603
+ * Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
604
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
605
+ * part of the ARN, shown here in bold:</p>
606
+ * <ul>
607
+ * <li>
608
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b>
609
+ * </p>
610
+ * </li>
611
+ * </ul>
612
+ * @public
613
+ */
614
+ ContactFlowId: string | undefined;
615
+ /**
616
+ * <p>The total duration of the newly started chat session. If not specified, the chat session
617
+ * duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum
618
+ * configurable time is 10,080 minutes (7 days).</p>
619
+ * @public
620
+ */
621
+ ChatDurationInMinutes?: number | undefined;
622
+ /**
623
+ * <p>The customer's details.</p>
624
+ * @public
625
+ */
626
+ ParticipantDetails?: ParticipantDetails | undefined;
627
+ /**
628
+ * <p>A chat message.</p>
629
+ * @public
630
+ */
631
+ InitialSystemMessage?: ChatMessage | undefined;
632
+ /**
633
+ * <p>The unique identifier for an Amazon Connect contact. This identifier is related to the
634
+ * contact starting.</p>
635
+ * @public
636
+ */
637
+ RelatedContactId?: string | undefined;
638
+ /**
639
+ * <p>The supported chat message content types. Supported types are:</p>
640
+ * <ul>
641
+ * <li>
642
+ * <p>
643
+ * <code>text/plain</code>
644
+ * </p>
645
+ * </li>
646
+ * <li>
647
+ * <p>
648
+ * <code>text/markdown</code>
649
+ * </p>
650
+ * </li>
651
+ * <li>
652
+ * <p>
653
+ * <code>application/json,
654
+ * application/vnd.amazonaws.connect.message.interactive</code>
655
+ * </p>
656
+ * </li>
657
+ * <li>
658
+ * <p>
659
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>
660
+ * </p>
661
+ * </li>
662
+ * </ul>
663
+ * <p>Content types must always contain <code>text/plain</code>. You can then put any other
664
+ * supported type in the list. For example, all the following lists are valid because they contain
665
+ * <code>text/plain</code>:</p>
666
+ * <ul>
667
+ * <li>
668
+ * <p>
669
+ * <code>[text/plain, text/markdown, application/json]</code>
670
+ * </p>
671
+ * </li>
672
+ * <li>
673
+ * <p>
674
+ * <code>[text/markdown, text/plain]</code>
675
+ * </p>
676
+ * </li>
677
+ * <li>
678
+ * <p>
679
+ * <code>[text/plain, application/json,
680
+ * application/vnd.amazonaws.connect.message.interactive.response]</code>
681
+ * </p>
682
+ * </li>
683
+ * </ul>
684
+ * @public
685
+ */
686
+ SupportedMessagingContentTypes?: string[] | undefined;
687
+ /**
688
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
689
+ * request. If not provided, the AWS SDK populates this field. For more information about
690
+ * idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making
691
+ * retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a
692
+ * contact is already started, the contact ID is returned.</p>
693
+ * @public
694
+ */
695
+ ClientToken?: string | undefined;
696
+ }
697
+ /**
698
+ * @public
699
+ */
700
+ export interface StartTaskContactRequest {
701
+ /**
702
+ * <p>The identifier of the Amazon Connect instance. 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>
703
+ * @public
704
+ */
705
+ InstanceId: string | undefined;
706
+ /**
707
+ * <p>The identifier of the previous chat, voice, or task contact. Any updates to user-defined
708
+ * attributes to task contacts linked using the same <code>PreviousContactID</code> will affect
709
+ * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</p>
710
+ * @public
711
+ */
712
+ PreviousContactId?: string | undefined;
713
+ /**
714
+ * <p>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website,
715
+ * on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose
716
+ * <b>Show additional flow information</b>. The ContactFlowId is the last
717
+ * part of the ARN, shown here in bold: </p>
718
+ * <p>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b>
719
+ * </p>
720
+ * @public
721
+ */
722
+ ContactFlowId?: string | undefined;
723
+ /**
724
+ * <p>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</p>
725
+ * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
726
+ * can include only alphanumeric, dash, and underscore characters.</p>
727
+ * @public
728
+ */
729
+ Attributes?: Record<string, string> | undefined;
730
+ /**
731
+ * <p>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</p>
732
+ * @public
733
+ */
734
+ Name: string | undefined;
735
+ /**
736
+ * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
737
+ * the following reference types at the time of creation: <code>URL</code> | <code>NUMBER</code> |
738
+ * <code>STRING</code> | <code>DATE</code> | <code>EMAIL</code>. <code>ATTACHMENT</code> is not a
739
+ * supported reference type during task creation.</p>
740
+ * @public
741
+ */
742
+ References?: Record<string, Reference> | undefined;
743
+ /**
744
+ * <p>A description of the task that is shown to an agent in the Contact Control Panel
745
+ * (CCP).</p>
746
+ * @public
747
+ */
748
+ Description?: string | undefined;
749
+ /**
750
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
751
+ * request. If not provided, the Amazon Web Services
752
+ * SDK populates this field. For more information about idempotency, see
753
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
754
+ * @public
755
+ */
756
+ ClientToken?: string | undefined;
757
+ /**
758
+ * <p>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </p>
759
+ * @public
760
+ */
761
+ ScheduledTime?: Date | undefined;
762
+ /**
763
+ * <p>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the
764
+ * <i>Amazon Connect Administrator Guide</i>. </p>
765
+ * @public
766
+ */
767
+ TaskTemplateId?: string | undefined;
768
+ /**
769
+ * <p>The identifier for the quick connect. Tasks that are created by using <code>QuickConnectId</code> will use the
770
+ * flow that is defined on agent or queue quick connect. For more information about quick connects,
771
+ * see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick
772
+ * connects</a>.</p>
773
+ * @public
774
+ */
775
+ QuickConnectId?: string | undefined;
776
+ /**
777
+ * <p>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking
778
+ * tasks together by using <code>RelatedContactID</code> copies over contact attributes from the
779
+ * related task contact to the new task contact. All updates to user-defined attributes in the new
780
+ * task contact are limited to the individual contact ID, unlike what happens when tasks are linked
781
+ * by using <code>PreviousContactID</code>. There are no limits to the number of contacts that can
782
+ * be linked by using <code>RelatedContactId</code>. </p>
783
+ * @public
784
+ */
785
+ RelatedContactId?: string | undefined;
786
+ /**
787
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique
788
+ * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
789
+ * They can be accessed in flows.</p>
790
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
791
+ * <p>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for
792
+ * the User who created a task.</p>
793
+ * <note>
794
+ * <p>To set contact expiry, a ValueMap must be specified containing the integer number of
795
+ * minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
796
+ * \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
797
+ * 135\}\}\}\}</code>. </p>
798
+ * <p>To set the created by user, a valid AgentResourceId must be supplied, with
799
+ * <code>SegmentAttributes</code> like \{ <code>"connect:CreatedByUser" \{ "ValueString":
800
+ * "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"\}\}\}</code>.
801
+ * </p>
802
+ * </note>
803
+ * @public
804
+ */
805
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
806
+ }
807
+ /**
808
+ * @public
809
+ */
810
+ export interface UpdateContactRequest {
811
+ /**
812
+ * <p>The identifier of the Amazon Connect instance. 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>
813
+ * @public
814
+ */
815
+ InstanceId: string | undefined;
816
+ /**
817
+ * <p>The identifier of the contact. This is the identifier of the contact associated with the
818
+ * first interaction with your contact center.</p>
819
+ * @public
820
+ */
821
+ ContactId: string | undefined;
822
+ /**
823
+ * <p>The name of the contact.</p>
824
+ * @public
825
+ */
826
+ Name?: string | undefined;
827
+ /**
828
+ * <p>The description of the contact.</p>
829
+ * @public
830
+ */
831
+ Description?: string | undefined;
832
+ /**
833
+ * <p>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</p>
834
+ * @public
835
+ */
836
+ References?: Record<string, Reference> | undefined;
837
+ /**
838
+ * <p>A set of system defined key-value pairs stored on individual contact segments (unique
839
+ * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
840
+ * They can be accessed in flows.</p>
841
+ * <p>Attribute keys can include only alphanumeric, -, and _.</p>
842
+ * <p>This field can be used to show channel subtype, such as <code>connect:Guide</code>.</p>
843
+ * <p>Currently Contact Expiry is the only segment attribute which can be updated by using the
844
+ * UpdateContact API.</p>
845
+ * @public
846
+ */
847
+ SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
848
+ /**
849
+ * <p> Information about the queue associated with a contact. This parameter can only be updated
850
+ * for external audio contacts. It is used when you integrate third-party systems with Contact Lens for
851
+ * analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
852
+ * the <i>
853
+ * Amazon Connect Administrator Guide</i>.</p>
854
+ * @public
855
+ */
856
+ QueueInfo?: QueueInfoInput | undefined;
857
+ /**
858
+ * <p>Information about the agent associated with a contact. This parameter can only be updated
859
+ * for external audio contacts. It is used when you integrate third-party systems with Contact Lens for
860
+ * analytics. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect Contact Lens integration</a> in
861
+ * the <i>
862
+ * Amazon Connect Administrator Guide</i>.</p>
863
+ * @public
864
+ */
865
+ UserInfo?: UserInfo | undefined;
866
+ /**
867
+ * <p>The endpoint of the customer for which the contact was initiated. For external audio
868
+ * contacts, this is usually the end customer's phone number. This value can only be updated for
869
+ * external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect
870
+ * Contact Lens integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
871
+ * @public
872
+ */
873
+ CustomerEndpoint?: Endpoint | undefined;
874
+ /**
875
+ * <p>External system endpoint for the contact was initiated. For external audio contacts, this is
876
+ * the phone number of the external system such as the contact center. This value can only be
877
+ * updated for external audio contacts. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-integration.html">Amazon Connect
878
+ * Contact Lens integration</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
879
+ * @public
880
+ */
881
+ SystemEndpoint?: Endpoint | undefined;
882
+ }
429
883
  /**
430
884
  * @public
431
885
  */
@@ -647,7 +1101,7 @@ export interface SearchContactFlowModulesRequest {
647
1101
  */
648
1102
  SearchFilter?: ContactFlowModuleSearchFilter | undefined;
649
1103
  /**
650
- * <p>The search criteria to be used to return contact flow modules.</p>
1104
+ * <p>The search criteria to be used to return flow modules.</p>
651
1105
  * <note>
652
1106
  * <p>The <code>name</code> and <code>description</code> fields support "contains" queries with a
653
1107
  * minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
@@ -699,27 +1153,28 @@ export interface SearchContactFlowsRequest {
699
1153
  */
700
1154
  export interface SearchEmailAddressesRequest {
701
1155
  /**
702
- * <p></p>
1156
+ * <p>The identifier of the Amazon Connect instance. 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>
703
1157
  * @public
704
1158
  */
705
1159
  InstanceId: string | undefined;
706
1160
  /**
707
- * <p></p>
1161
+ * <p>The maximum number of results to return per page.</p>
708
1162
  * @public
709
1163
  */
710
1164
  MaxResults?: number | undefined;
711
1165
  /**
712
- * <p></p>
1166
+ * <p>The token for the next set of results. Use the value returned in the previous
1167
+ * response in the next request to retrieve the next set of results.</p>
713
1168
  * @public
714
1169
  */
715
1170
  NextToken?: string | undefined;
716
1171
  /**
717
- * <p></p>
1172
+ * <p>The search criteria to be used to return email addresses.</p>
718
1173
  * @public
719
1174
  */
720
1175
  SearchCriteria?: EmailAddressSearchCriteria | undefined;
721
1176
  /**
722
- * <p></p>
1177
+ * <p>Filters to be applied to search results.</p>
723
1178
  * @public
724
1179
  */
725
1180
  SearchFilter?: EmailAddressSearchFilter | undefined;
@@ -1091,6 +1546,41 @@ export interface RoutingCriteriaInput {
1091
1546
  */
1092
1547
  Steps?: RoutingCriteriaInputStep[] | undefined;
1093
1548
  }
1549
+ /**
1550
+ * @public
1551
+ */
1552
+ export interface UpdateContactRoutingDataRequest {
1553
+ /**
1554
+ * <p>The identifier of the Amazon Connect instance. 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>
1555
+ * @public
1556
+ */
1557
+ InstanceId: string | undefined;
1558
+ /**
1559
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
1560
+ * @public
1561
+ */
1562
+ ContactId: string | undefined;
1563
+ /**
1564
+ * <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
1565
+ * to agents on a first-come, first-serve basis. This means that changing their amount of time in
1566
+ * queue compared to others also changes their position in queue.</p>
1567
+ * @public
1568
+ */
1569
+ QueueTimeAdjustmentSeconds?: number | undefined;
1570
+ /**
1571
+ * <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
1572
+ * raise the priority of a contact compared to other contacts in the queue by assigning them a
1573
+ * higher priority, such as 1 or 2.</p>
1574
+ * @public
1575
+ */
1576
+ QueuePriority?: number | undefined;
1577
+ /**
1578
+ * <p>Updates the routing criteria on the contact. These properties can be used to change how a
1579
+ * contact is routed within the queue.</p>
1580
+ * @public
1581
+ */
1582
+ RoutingCriteria?: RoutingCriteriaInput | undefined;
1583
+ }
1094
1584
  /**
1095
1585
  * <p>Contains information about a contact.</p>
1096
1586
  * @public
@@ -1117,7 +1607,8 @@ export interface Contact {
1117
1607
  */
1118
1608
  PreviousContactId?: string | undefined;
1119
1609
  /**
1120
- * <p></p>
1610
+ * <p>This is the root contactId which is used as a unique identifier for all subsequent contacts
1611
+ * in a contact tree.</p>
1121
1612
  * @public
1122
1613
  */
1123
1614
  ContactAssociationId?: string | undefined;
@@ -1210,12 +1701,15 @@ export interface Contact {
1210
1701
  */
1211
1702
  WisdomInfo?: WisdomInfo | undefined;
1212
1703
  /**
1213
- * <p></p>
1704
+ * <p>The customer or external third party participant endpoint.</p>
1214
1705
  * @public
1215
1706
  */
1216
1707
  CustomerEndpoint?: EndpointInfo | undefined;
1217
1708
  /**
1218
- * <p></p>
1709
+ * <p>The system endpoint. For <code>INBOUND</code>, this is the phone number or email address
1710
+ * that the customer dialed. For <code>OUTBOUND</code> and <code>EXTERNAL_OUTBOUND</code>, this is
1711
+ * the outbound caller ID number assigned to the outbound queue that is used to dial the customer.
1712
+ * For callback, this shows up as Softphone for calls handled by agents with softphone.</p>
1219
1713
  * @public
1220
1714
  */
1221
1715
  SystemEndpoint?: EndpointInfo | undefined;
@@ -1282,7 +1776,7 @@ export interface Contact {
1282
1776
  */
1283
1777
  DisconnectDetails?: DisconnectDetails | undefined;
1284
1778
  /**
1285
- * <p></p>
1779
+ * <p>List of additional email addresses for an email contact.</p>
1286
1780
  * @public
1287
1781
  */
1288
1782
  AdditionalEmailRecipients?: AdditionalEmailRecipients | undefined;
@@ -1296,41 +1790,6 @@ export interface Contact {
1296
1790
  */
1297
1791
  SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
1298
1792
  }
1299
- /**
1300
- * @public
1301
- */
1302
- export interface UpdateContactRoutingDataRequest {
1303
- /**
1304
- * <p>The identifier of the Amazon Connect instance. 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>
1305
- * @public
1306
- */
1307
- InstanceId: string | undefined;
1308
- /**
1309
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
1310
- * @public
1311
- */
1312
- ContactId: string | undefined;
1313
- /**
1314
- * <p>The number of seconds to add or subtract from the contact's routing age. Contacts are routed
1315
- * to agents on a first-come, first-serve basis. This means that changing their amount of time in
1316
- * queue compared to others also changes their position in queue.</p>
1317
- * @public
1318
- */
1319
- QueueTimeAdjustmentSeconds?: number | undefined;
1320
- /**
1321
- * <p>Priority of the contact in the queue. The default priority for new contacts is 5. You can
1322
- * raise the priority of a contact compared to other contacts in the queue by assigning them a
1323
- * higher priority, such as 1 or 2.</p>
1324
- * @public
1325
- */
1326
- QueuePriority?: number | undefined;
1327
- /**
1328
- * <p>Updates the routing criteria on the contact. These properties can be used to change how a
1329
- * contact is routed within the queue.</p>
1330
- * @public
1331
- */
1332
- RoutingCriteria?: RoutingCriteriaInput | undefined;
1333
- }
1334
1793
  /**
1335
1794
  * @public
1336
1795
  */
@@ -1341,6 +1800,18 @@ export interface DescribeContactResponse {
1341
1800
  */
1342
1801
  Contact?: Contact | undefined;
1343
1802
  }
1803
+ /**
1804
+ * @internal
1805
+ */
1806
+ export declare const StartEmailContactRequestFilterSensitiveLog: (obj: StartEmailContactRequest) => any;
1807
+ /**
1808
+ * @internal
1809
+ */
1810
+ export declare const StartTaskContactRequestFilterSensitiveLog: (obj: StartTaskContactRequest) => any;
1811
+ /**
1812
+ * @internal
1813
+ */
1814
+ export declare const UpdateContactRequestFilterSensitiveLog: (obj: UpdateContactRequest) => any;
1344
1815
  /**
1345
1816
  * @internal
1346
1817
  */