@aws-sdk/client-connect 3.701.0 → 3.709.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 (62) hide show
  1. package/README.md +18 -2
  2. package/dist-cjs/index.js +186 -63
  3. package/dist-es/Connect.js +4 -0
  4. package/dist-es/commands/CreateContactCommand.js +1 -1
  5. package/dist-es/commands/CreatePushNotificationRegistrationCommand.js +22 -0
  6. package/dist-es/commands/DeletePushNotificationRegistrationCommand.js +22 -0
  7. package/dist-es/commands/index.js +2 -0
  8. package/dist-es/models/models_0.js +11 -0
  9. package/dist-es/models/models_1.js +0 -16
  10. package/dist-es/models/models_2.js +24 -5
  11. package/dist-es/models/models_3.js +5 -0
  12. package/dist-es/protocols/Aws_restJson1.js +62 -0
  13. package/dist-types/Connect.d.ts +16 -2
  14. package/dist-types/ConnectClient.d.ts +6 -4
  15. package/dist-types/commands/AssociateFlowCommand.d.ts +1 -1
  16. package/dist-types/commands/BatchGetFlowAssociationCommand.d.ts +2 -2
  17. package/dist-types/commands/CreateContactCommand.d.ts +1 -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/CreatePushNotificationRegistrationCommand.d.ts +101 -0
  21. package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +86 -0
  22. package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
  23. package/dist-types/commands/DeleteViewCommand.d.ts +1 -1
  24. package/dist-types/commands/DeleteViewVersionCommand.d.ts +1 -1
  25. package/dist-types/commands/DeleteVocabularyCommand.d.ts +1 -2
  26. package/dist-types/commands/DescribePhoneNumberCommand.d.ts +1 -2
  27. package/dist-types/commands/DisassociateFlowCommand.d.ts +1 -1
  28. package/dist-types/commands/GetFlowAssociationCommand.d.ts +2 -2
  29. package/dist-types/commands/ImportPhoneNumberCommand.d.ts +2 -3
  30. package/dist-types/commands/ListFlowAssociationsCommand.d.ts +2 -2
  31. package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +2 -2
  32. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -0
  33. package/dist-types/commands/SendChatIntegrationEventCommand.d.ts +2 -2
  34. package/dist-types/commands/StartContactRecordingCommand.d.ts +1 -0
  35. package/dist-types/commands/StartOutboundChatContactCommand.d.ts +2 -2
  36. package/dist-types/commands/StopContactRecordingCommand.d.ts +1 -0
  37. package/dist-types/commands/SuspendContactRecordingCommand.d.ts +1 -0
  38. package/dist-types/commands/UpdateContactCommand.d.ts +21 -0
  39. package/dist-types/commands/index.d.ts +2 -0
  40. package/dist-types/index.d.ts +2 -2
  41. package/dist-types/models/models_0.d.ts +142 -81
  42. package/dist-types/models/models_1.d.ts +202 -171
  43. package/dist-types/models/models_2.d.ts +215 -400
  44. package/dist-types/models/models_3.d.ts +430 -3
  45. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  46. package/dist-types/ts3.4/Connect.d.ts +46 -0
  47. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  48. package/dist-types/ts3.4/commands/CreateContactCommand.d.ts +1 -1
  49. package/dist-types/ts3.4/commands/CreateEvaluationFormCommand.d.ts +1 -1
  50. package/dist-types/ts3.4/commands/CreatePushNotificationRegistrationCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +51 -0
  52. package/dist-types/ts3.4/commands/DeleteUserHierarchyGroupCommand.d.ts +1 -1
  53. package/dist-types/ts3.4/commands/DeleteViewCommand.d.ts +1 -1
  54. package/dist-types/ts3.4/commands/DeleteViewVersionCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/DeleteVocabularyCommand.d.ts +4 -2
  56. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  57. package/dist-types/ts3.4/models/models_0.d.ts +34 -19
  58. package/dist-types/ts3.4/models/models_1.d.ts +19 -43
  59. package/dist-types/ts3.4/models/models_2.d.ts +65 -89
  60. package/dist-types/ts3.4/models/models_3.d.ts +92 -6
  61. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  62. package/package.json +35 -35
@@ -1,7 +1,161 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
2
  import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
3
- import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EvaluationFormQuestion, EvaluationFormScoringStrategy, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InitiateAs, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, OutboundEmailConfig, ParticipantRole, PredefinedAttributeValues, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
- import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationFormVersionStatus, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentCategories, RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSegmentPostContactSummary, RealTimeContactAnalysisSegmentTranscript, RealTimeContactAnalysisSupportedChannel, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig, TrafficDistributionGroupStatus } from "./models_1";
3
+ import { ActionSummary, AgentAvailabilityTimer, AgentConfig, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EvaluationFormQuestion, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, InstanceStorageConfig, InstanceStorageResourceType, MediaConcurrency, MonitorCapability, OutboundCallerConfig, OutboundEmailConfig, ParticipantRole, PredefinedAttributeValues, QuickConnectConfig, Reference, RehydrationType, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UseCaseType, UserIdentityInfo, UserPhoneConfig, UserProficiency, View, ViewInputContent, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
4
+ import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, RealTimeContactAnalysisCharacterInterval, RealTimeContactAnalysisSegmentAttachments, RealTimeContactAnalysisSegmentCategories, RealTimeContactAnalysisSegmentEvent, RealTimeContactAnalysisSegmentIssues, RealTimeContactAnalysisSupportedChannel, RealTimeContactAnalysisTimeData, RoutingProfile, SignInConfig, SortOrder, TelephonyConfig, TrafficDistributionGroupStatus } from "./models_1";
5
+ import { EvaluationFormSection } from "./models_3";
6
+ /**
7
+ * @public
8
+ * @enum
9
+ */
10
+ export declare const RealTimeContactAnalysisPostContactSummaryFailureCode: {
11
+ readonly FAILED_SAFETY_GUIDELINES: "FAILED_SAFETY_GUIDELINES";
12
+ readonly INSUFFICIENT_CONVERSATION_CONTENT: "INSUFFICIENT_CONVERSATION_CONTENT";
13
+ readonly INTERNAL_ERROR: "INTERNAL_ERROR";
14
+ readonly INVALID_ANALYSIS_CONFIGURATION: "INVALID_ANALYSIS_CONFIGURATION";
15
+ readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
16
+ };
17
+ /**
18
+ * @public
19
+ */
20
+ export type RealTimeContactAnalysisPostContactSummaryFailureCode = (typeof RealTimeContactAnalysisPostContactSummaryFailureCode)[keyof typeof RealTimeContactAnalysisPostContactSummaryFailureCode];
21
+ /**
22
+ * @public
23
+ * @enum
24
+ */
25
+ export declare const RealTimeContactAnalysisPostContactSummaryStatus: {
26
+ readonly COMPLETED: "COMPLETED";
27
+ readonly FAILED: "FAILED";
28
+ };
29
+ /**
30
+ * @public
31
+ */
32
+ export type RealTimeContactAnalysisPostContactSummaryStatus = (typeof RealTimeContactAnalysisPostContactSummaryStatus)[keyof typeof RealTimeContactAnalysisPostContactSummaryStatus];
33
+ /**
34
+ * <p>Information about the post-contact summary for a real-time contact segment.</p>
35
+ * @public
36
+ */
37
+ export interface RealTimeContactAnalysisSegmentPostContactSummary {
38
+ /**
39
+ * <p>The content of the summary.</p>
40
+ * @public
41
+ */
42
+ Content?: string | undefined;
43
+ /**
44
+ * <p>Whether the summary was successfully COMPLETED or FAILED to be generated.</p>
45
+ * @public
46
+ */
47
+ Status: RealTimeContactAnalysisPostContactSummaryStatus | undefined;
48
+ /**
49
+ * <p>If the summary failed to be generated, one of the following failure codes occurs:</p>
50
+ * <ul>
51
+ * <li>
52
+ * <p>
53
+ * <code>QUOTA_EXCEEDED</code>: The number of concurrent analytics jobs reached your service
54
+ * quota.</p>
55
+ * </li>
56
+ * <li>
57
+ * <p>
58
+ * <code>INSUFFICIENT_CONVERSATION_CONTENT</code>: The conversation needs to have at least
59
+ * one turn from both the participants in order to generate the summary.</p>
60
+ * </li>
61
+ * <li>
62
+ * <p>
63
+ * <code>FAILED_SAFETY_GUIDELINES</code>: The generated summary cannot be provided because it
64
+ * failed to meet system safety guidelines.</p>
65
+ * </li>
66
+ * <li>
67
+ * <p>
68
+ * <code>INVALID_ANALYSIS_CONFIGURATION</code>: This code occurs when, for example, you're
69
+ * using a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/supported-languages.html#supported-languages-contact-lens">language</a> that isn't supported by generative AI-powered post-contact summaries.
70
+ * </p>
71
+ * </li>
72
+ * <li>
73
+ * <p>
74
+ * <code>INTERNAL_ERROR</code>: Internal system error.</p>
75
+ * </li>
76
+ * </ul>
77
+ * @public
78
+ */
79
+ FailureCode?: RealTimeContactAnalysisPostContactSummaryFailureCode | undefined;
80
+ }
81
+ /**
82
+ * <p>Object describing redaction applied to the segment.</p>
83
+ * @public
84
+ */
85
+ export interface RealTimeContactAnalysisTranscriptItemRedaction {
86
+ /**
87
+ * <p>List of character intervals each describing a part of the text that was redacted. For
88
+ * <code>OutputType.Raw</code>, part of the original text that contains data that can be redacted.
89
+ * For <code> OutputType.Redacted</code>, part of the string with redaction tag.</p>
90
+ * @public
91
+ */
92
+ CharacterOffsets?: RealTimeContactAnalysisCharacterInterval[] | undefined;
93
+ }
94
+ /**
95
+ * @public
96
+ * @enum
97
+ */
98
+ export declare const RealTimeContactAnalysisSentimentLabel: {
99
+ readonly NEGATIVE: "NEGATIVE";
100
+ readonly NEUTRAL: "NEUTRAL";
101
+ readonly POSITIVE: "POSITIVE";
102
+ };
103
+ /**
104
+ * @public
105
+ */
106
+ export type RealTimeContactAnalysisSentimentLabel = (typeof RealTimeContactAnalysisSentimentLabel)[keyof typeof RealTimeContactAnalysisSentimentLabel];
107
+ /**
108
+ * <p>The analyzed transcript segment.</p>
109
+ * @public
110
+ */
111
+ export interface RealTimeContactAnalysisSegmentTranscript {
112
+ /**
113
+ * <p>The identifier of the transcript.</p>
114
+ * @public
115
+ */
116
+ Id: string | undefined;
117
+ /**
118
+ * <p>The identifier of the participant.</p>
119
+ * @public
120
+ */
121
+ ParticipantId: string | undefined;
122
+ /**
123
+ * <p>The role of the participant. For example, is it a customer, agent, or system.</p>
124
+ * @public
125
+ */
126
+ ParticipantRole: ParticipantRole | undefined;
127
+ /**
128
+ * <p>The display name of the participant.</p>
129
+ * @public
130
+ */
131
+ DisplayName?: string | undefined;
132
+ /**
133
+ * <p>The content of the transcript. Can be redacted.</p>
134
+ * @public
135
+ */
136
+ Content: string | undefined;
137
+ /**
138
+ * <p>The type of content of the item. For example, <code>text/plain</code>.</p>
139
+ * @public
140
+ */
141
+ ContentType?: string | undefined;
142
+ /**
143
+ * <p>Field describing the time of the event. It can have different representations of time.</p>
144
+ * @public
145
+ */
146
+ Time: RealTimeContactAnalysisTimeData | undefined;
147
+ /**
148
+ * <p>Object describing redaction that was applied to the transcript. If transcript has the field
149
+ * it means part of the transcript was redacted.</p>
150
+ * @public
151
+ */
152
+ Redaction?: RealTimeContactAnalysisTranscriptItemRedaction | undefined;
153
+ /**
154
+ * <p>The sentiment detected for this piece of transcript.</p>
155
+ * @public
156
+ */
157
+ Sentiment?: RealTimeContactAnalysisSentimentLabel | undefined;
158
+ }
5
159
  /**
6
160
  * <p>An analyzed segment for a real-time analysis session.</p>
7
161
  * @public
@@ -1498,6 +1652,19 @@ export interface ResumeContactRequest {
1498
1652
  */
1499
1653
  export interface ResumeContactResponse {
1500
1654
  }
1655
+ /**
1656
+ * @public
1657
+ * @enum
1658
+ */
1659
+ export declare const ContactRecordingType: {
1660
+ readonly AGENT: "AGENT";
1661
+ readonly IVR: "IVR";
1662
+ readonly SCREEN: "SCREEN";
1663
+ };
1664
+ /**
1665
+ * @public
1666
+ */
1667
+ export type ContactRecordingType = (typeof ContactRecordingType)[keyof typeof ContactRecordingType];
1501
1668
  /**
1502
1669
  * @public
1503
1670
  */
@@ -1518,6 +1685,11 @@ export interface ResumeContactRecordingRequest {
1518
1685
  * @public
1519
1686
  */
1520
1687
  InitialContactId: string | undefined;
1688
+ /**
1689
+ * <p>The type of recording being operated on.</p>
1690
+ * @public
1691
+ */
1692
+ ContactRecordingType?: ContactRecordingType | undefined;
1521
1693
  }
1522
1694
  /**
1523
1695
  * @public
@@ -2563,7 +2735,7 @@ export interface SearchResourceTagsRequest {
2563
2735
  */
2564
2736
  export interface TagSet {
2565
2737
  /**
2566
- * <p>The tag key in the tagSet.</p>
2738
+ * <p>The tag key in the TagSet.</p>
2567
2739
  * @public
2568
2740
  */
2569
2741
  key?: string | undefined;
@@ -3307,15 +3479,14 @@ export interface SendChatIntegrationEventRequest {
3307
3479
  SourceId: string | undefined;
3308
3480
  /**
3309
3481
  * <p>Chat system identifier, used in part to uniquely identify chat. This is associated with the
3310
- * Amazon Connect instance and flow to be used to start chats. For SMS, this is the phone
3311
- * number destination of inbound SMS messages represented by an Amazon Pinpoint phone number
3312
- * ARN.</p>
3482
+ * Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is
3483
+ * the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</p>
3313
3484
  * @public
3314
3485
  */
3315
3486
  DestinationId: string | undefined;
3316
3487
  /**
3317
3488
  * <p>Classification of a channel. This is used in part to uniquely identify chat. </p>
3318
- * <p>Valid value: <code>["connect:sms"]</code>
3489
+ * <p>Valid value: <code>["connect:sms", connect:"WhatsApp"]</code>
3319
3490
  * </p>
3320
3491
  * @public
3321
3492
  */
@@ -3815,6 +3986,17 @@ export interface StartContactEvaluationResponse {
3815
3986
  */
3816
3987
  EvaluationArn: string | undefined;
3817
3988
  }
3989
+ /**
3990
+ * @public
3991
+ * @enum
3992
+ */
3993
+ export declare const IvrRecordingTrack: {
3994
+ readonly ALL: "ALL";
3995
+ };
3996
+ /**
3997
+ * @public
3998
+ */
3999
+ export type IvrRecordingTrack = (typeof IvrRecordingTrack)[keyof typeof IvrRecordingTrack];
3818
4000
  /**
3819
4001
  * @public
3820
4002
  * @enum
@@ -3838,6 +4020,11 @@ export interface VoiceRecordingConfiguration {
3838
4020
  * @public
3839
4021
  */
3840
4022
  VoiceRecordingTrack?: VoiceRecordingTrack | undefined;
4023
+ /**
4024
+ * <p>Identifies which IVR track is being recorded.</p>
4025
+ * @public
4026
+ */
4027
+ IvrRecordingTrack?: IvrRecordingTrack | undefined;
3841
4028
  }
3842
4029
  /**
3843
4030
  * @public
@@ -4581,6 +4768,11 @@ export interface StopContactRecordingRequest {
4581
4768
  * @public
4582
4769
  */
4583
4770
  InitialContactId: string | undefined;
4771
+ /**
4772
+ * <p>The type of recording being operated on.</p>
4773
+ * @public
4774
+ */
4775
+ ContactRecordingType?: ContactRecordingType | undefined;
4584
4776
  }
4585
4777
  /**
4586
4778
  * @public
@@ -4684,6 +4876,11 @@ export interface SuspendContactRecordingRequest {
4684
4876
  * @public
4685
4877
  */
4686
4878
  InitialContactId: string | undefined;
4879
+ /**
4880
+ * <p>The type of recording being operated on.</p>
4881
+ * @public
4882
+ */
4883
+ ContactRecordingType?: ContactRecordingType | undefined;
4687
4884
  }
4688
4885
  /**
4689
4886
  * @public
@@ -4917,6 +5114,17 @@ export interface UpdateAuthenticationProfileRequest {
4917
5114
  */
4918
5115
  PeriodicSessionDuration?: number | undefined;
4919
5116
  }
5117
+ /**
5118
+ * <p>Information about a queue.</p>
5119
+ * @public
5120
+ */
5121
+ export interface QueueInfoInput {
5122
+ /**
5123
+ * <p>The identifier of the queue.</p>
5124
+ * @public
5125
+ */
5126
+ Id?: string | undefined;
5127
+ }
4920
5128
  /**
4921
5129
  * @public
4922
5130
  */
@@ -6549,395 +6757,6 @@ export declare namespace EvaluationFormItem {
6549
6757
  }
6550
6758
  const visit: <T>(value: EvaluationFormItem, visitor: Visitor<T>) => T;
6551
6759
  }
6552
- /**
6553
- * <p>Information about a section from an evaluation form. A section can contain sections and/or
6554
- * questions. Evaluation forms can only contain sections and subsections (two level nesting).</p>
6555
- * @public
6556
- */
6557
- export interface EvaluationFormSection {
6558
- /**
6559
- * <p>The title of the section.</p>
6560
- * @public
6561
- */
6562
- Title: string | undefined;
6563
- /**
6564
- * <p>The identifier of the section. An identifier must be unique within the evaluation
6565
- * form.</p>
6566
- * @public
6567
- */
6568
- RefId: string | undefined;
6569
- /**
6570
- * <p>The instructions of the section.</p>
6571
- * @public
6572
- */
6573
- Instructions?: string | undefined;
6574
- /**
6575
- * <p>The items of the section.</p>
6576
- * @public
6577
- */
6578
- Items: EvaluationFormItem[] | undefined;
6579
- /**
6580
- * <p>The scoring weight of the section.</p>
6581
- * @public
6582
- */
6583
- Weight?: number | undefined;
6584
- }
6585
- /**
6586
- * <p>The search criteria to be used to return agent statuses.</p>
6587
- * @public
6588
- */
6589
- export interface AgentStatusSearchCriteria {
6590
- /**
6591
- * <p>A list of conditions which would be applied together with an <code>OR</code>
6592
- * condition.</p>
6593
- * @public
6594
- */
6595
- OrConditions?: AgentStatusSearchCriteria[] | undefined;
6596
- /**
6597
- * <p>A leaf node condition which can be used to specify a string condition.</p>
6598
- * <note>
6599
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6600
- * <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
6601
- * and <code>resourceID</code>.</p>
6602
- * </note>
6603
- * @public
6604
- */
6605
- AndConditions?: AgentStatusSearchCriteria[] | undefined;
6606
- /**
6607
- * <p>A leaf node condition which can be used to specify a string condition.</p>
6608
- * <note>
6609
- * <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
6610
- * <code>description</code>, <code>state</code>, <code>type</code>, <code>displayOrder</code>,
6611
- * and <code>resourceID</code>.</p>
6612
- * </note>
6613
- * @public
6614
- */
6615
- StringCondition?: StringCondition | undefined;
6616
- }
6617
- /**
6618
- * <p>The search criteria to be used to return flow modules.</p>
6619
- * @public
6620
- */
6621
- export interface ContactFlowModuleSearchCriteria {
6622
- /**
6623
- * <p>A list of conditions which would be applied together with an <code>OR</code>
6624
- * condition.</p>
6625
- * @public
6626
- */
6627
- OrConditions?: ContactFlowModuleSearchCriteria[] | undefined;
6628
- /**
6629
- * <p>A list of conditions which would be applied together with an <code>AND</code>
6630
- * condition.</p>
6631
- * @public
6632
- */
6633
- AndConditions?: ContactFlowModuleSearchCriteria[] | undefined;
6634
- /**
6635
- * <p>A leaf node condition which can be used to specify a string condition.</p>
6636
- * @public
6637
- */
6638
- StringCondition?: StringCondition | undefined;
6639
- }
6640
- /**
6641
- * <p>The search criteria to be used to return flows.</p>
6642
- * @public
6643
- */
6644
- export interface ContactFlowSearchCriteria {
6645
- /**
6646
- * <p>A list of conditions which would be applied together with an <code>OR</code>
6647
- * condition.</p>
6648
- * @public
6649
- */
6650
- OrConditions?: ContactFlowSearchCriteria[] | undefined;
6651
- /**
6652
- * <p>A list of conditions which would be applied together with an <code>AND</code>
6653
- * condition.</p>
6654
- * @public
6655
- */
6656
- AndConditions?: ContactFlowSearchCriteria[] | undefined;
6657
- /**
6658
- * <p>A leaf node condition which can be used to specify a string condition.</p>
6659
- * @public
6660
- */
6661
- StringCondition?: StringCondition | undefined;
6662
- /**
6663
- * <p>The type of flow.</p>
6664
- * @public
6665
- */
6666
- TypeCondition?: ContactFlowType | undefined;
6667
- /**
6668
- * <p>The state of the flow.</p>
6669
- * @public
6670
- */
6671
- StateCondition?: ContactFlowState | undefined;
6672
- /**
6673
- * <p>The status of the flow.</p>
6674
- * @public
6675
- */
6676
- StatusCondition?: ContactFlowStatus | undefined;
6677
- }
6678
- /**
6679
- * @public
6680
- */
6681
- export interface CreateContactRequest {
6682
- /**
6683
- * <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>
6684
- * @public
6685
- */
6686
- InstanceId: string | undefined;
6687
- /**
6688
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6689
- * request. If not provided, the Amazon Web Services
6690
- * SDK populates this field. For more information about idempotency, see
6691
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6692
- * @public
6693
- */
6694
- ClientToken?: string | undefined;
6695
- /**
6696
- * <p>The identifier of the contact in this instance of Amazon Connect. </p>
6697
- * @public
6698
- */
6699
- RelatedContactId?: string | undefined;
6700
- /**
6701
- * <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>
6702
- * <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys
6703
- * can include only alphanumeric, dash, and underscore characters.</p>
6704
- * @public
6705
- */
6706
- Attributes?: Record<string, string> | undefined;
6707
- /**
6708
- * <p>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
6709
- * the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL |
6710
- * ATTACHMENT.</p>
6711
- * @public
6712
- */
6713
- References?: Record<string, Reference> | undefined;
6714
- /**
6715
- * <p>The channel for the contact</p>
6716
- * @public
6717
- */
6718
- Channel: Channel | undefined;
6719
- /**
6720
- * <p>Indicates how the contact was initiated.</p>
6721
- * @public
6722
- */
6723
- InitiationMethod: ContactInitiationMethod | undefined;
6724
- /**
6725
- * <p>Number of minutes the contact will be active for before expiring</p>
6726
- * @public
6727
- */
6728
- ExpiryDurationInMinutes?: number | undefined;
6729
- /**
6730
- * <p>User details for the contact</p>
6731
- * @public
6732
- */
6733
- UserInfo?: UserInfo | undefined;
6734
- /**
6735
- * <p>Initial state of the contact when it's created</p>
6736
- * @public
6737
- */
6738
- InitiateAs?: InitiateAs | undefined;
6739
- /**
6740
- * <p>The name of a the contact.</p>
6741
- * @public
6742
- */
6743
- Name?: string | undefined;
6744
- /**
6745
- * <p>A description of the contact.</p>
6746
- * @public
6747
- */
6748
- Description?: string | undefined;
6749
- /**
6750
- * <p>A set of system defined key-value pairs stored on individual contact segments (unique
6751
- * contact ID) using an attribute map. The attributes are standard Amazon Connect attributes.
6752
- * They can be accessed in flows.</p>
6753
- * <p>Attribute keys can include only alphanumeric, -, and _.</p>
6754
- * <p>This field can be used to set Segment Contact Expiry as a duration in minutes.</p>
6755
- * <note>
6756
- * <p>To set contact expiry, a ValueMap must be specified containing the integer number of
6757
- * minutes the contact will be active for before expiring, with <code>SegmentAttributes</code> like
6758
- * \{ <code> "connect:ContactExpiry": \{"ValueMap" : \{ "ExpiryDuration": \{ "ValueInteger":
6759
- * 135\}\}\}\}</code>. </p>
6760
- * </note>
6761
- * @public
6762
- */
6763
- SegmentAttributes?: Record<string, SegmentAttributeValue> | undefined;
6764
- }
6765
- /**
6766
- * @public
6767
- */
6768
- export interface CreateEvaluationFormRequest {
6769
- /**
6770
- * <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>
6771
- * @public
6772
- */
6773
- InstanceId: string | undefined;
6774
- /**
6775
- * <p>A title of the evaluation form.</p>
6776
- * @public
6777
- */
6778
- Title: string | undefined;
6779
- /**
6780
- * <p>The description of the evaluation form.</p>
6781
- * @public
6782
- */
6783
- Description?: string | undefined;
6784
- /**
6785
- * <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>
6786
- * @public
6787
- */
6788
- Items: EvaluationFormItem[] | undefined;
6789
- /**
6790
- * <p>A scoring strategy of the evaluation form.</p>
6791
- * @public
6792
- */
6793
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6794
- /**
6795
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6796
- * request. If not provided, the Amazon Web Services
6797
- * SDK populates this field. For more information about idempotency, see
6798
- * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
6799
- * @public
6800
- */
6801
- ClientToken?: string | undefined;
6802
- }
6803
- /**
6804
- * <p>The search criteria to be used to return email addresses.</p>
6805
- * @public
6806
- */
6807
- export interface EmailAddressSearchCriteria {
6808
- /**
6809
- * <p>A list of conditions which would be applied together with an OR condition.</p>
6810
- * @public
6811
- */
6812
- OrConditions?: EmailAddressSearchCriteria[] | undefined;
6813
- /**
6814
- * <p>A list of conditions which would be applied together with an AND condition.</p>
6815
- * @public
6816
- */
6817
- AndConditions?: EmailAddressSearchCriteria[] | undefined;
6818
- /**
6819
- * <p>A leaf node condition which can be used to specify a string condition.</p>
6820
- * @public
6821
- */
6822
- StringCondition?: StringCondition | undefined;
6823
- }
6824
- /**
6825
- * <p>Information about the evaluation form.</p>
6826
- * @public
6827
- */
6828
- export interface EvaluationForm {
6829
- /**
6830
- * <p>The unique identifier for the evaluation form.</p>
6831
- * @public
6832
- */
6833
- EvaluationFormId: string | undefined;
6834
- /**
6835
- * <p>A version of the evaluation form.</p>
6836
- * @public
6837
- */
6838
- EvaluationFormVersion: number | undefined;
6839
- /**
6840
- * <p>The flag indicating whether the evaluation form is locked for changes.</p>
6841
- * @public
6842
- */
6843
- Locked: boolean | undefined;
6844
- /**
6845
- * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
6846
- * @public
6847
- */
6848
- EvaluationFormArn: string | undefined;
6849
- /**
6850
- * <p>A title of the evaluation form.</p>
6851
- * @public
6852
- */
6853
- Title: string | undefined;
6854
- /**
6855
- * <p>The description of the evaluation form.</p>
6856
- * @public
6857
- */
6858
- Description?: string | undefined;
6859
- /**
6860
- * <p>The status of the evaluation form.</p>
6861
- * @public
6862
- */
6863
- Status: EvaluationFormVersionStatus | undefined;
6864
- /**
6865
- * <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>
6866
- * @public
6867
- */
6868
- Items: EvaluationFormItem[] | undefined;
6869
- /**
6870
- * <p>A scoring strategy of the evaluation form.</p>
6871
- * @public
6872
- */
6873
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6874
- /**
6875
- * <p>The timestamp for when the evaluation form was created.</p>
6876
- * @public
6877
- */
6878
- CreatedTime: Date | undefined;
6879
- /**
6880
- * <p>The Amazon Resource Name (ARN) of the user who created the evaluation form.</p>
6881
- * @public
6882
- */
6883
- CreatedBy: string | undefined;
6884
- /**
6885
- * <p>The timestamp for when the evaluation form was last updated.</p>
6886
- * @public
6887
- */
6888
- LastModifiedTime: Date | undefined;
6889
- /**
6890
- * <p>The Amazon Resource Name (ARN) of the user who last updated the evaluation form.</p>
6891
- * @public
6892
- */
6893
- LastModifiedBy: string | undefined;
6894
- /**
6895
- * <p>The tags used to organize, track, or control access for this resource. For example, \{ "Tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
6896
- * @public
6897
- */
6898
- Tags?: Record<string, string> | undefined;
6899
- }
6900
- /**
6901
- * <p>Information about an evaluation form used in a contact evaluation.</p>
6902
- * @public
6903
- */
6904
- export interface EvaluationFormContent {
6905
- /**
6906
- * <p>A version of the evaluation form.</p>
6907
- * @public
6908
- */
6909
- EvaluationFormVersion: number | undefined;
6910
- /**
6911
- * <p>The unique identifier for the evaluation form.</p>
6912
- * @public
6913
- */
6914
- EvaluationFormId: string | undefined;
6915
- /**
6916
- * <p>The Amazon Resource Name (ARN) for the evaluation form resource.</p>
6917
- * @public
6918
- */
6919
- EvaluationFormArn: string | undefined;
6920
- /**
6921
- * <p>A title of the evaluation form.</p>
6922
- * @public
6923
- */
6924
- Title: string | undefined;
6925
- /**
6926
- * <p>The description of the evaluation form.</p>
6927
- * @public
6928
- */
6929
- Description?: string | undefined;
6930
- /**
6931
- * <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>
6932
- * @public
6933
- */
6934
- Items: EvaluationFormItem[] | undefined;
6935
- /**
6936
- * <p>A scoring strategy of the evaluation form.</p>
6937
- * @public
6938
- */
6939
- ScoringStrategy?: EvaluationFormScoringStrategy | undefined;
6940
- }
6941
6760
  /**
6942
6761
  * @internal
6943
6762
  */
@@ -7090,7 +6909,3 @@ export declare const UpdateViewContentResponseFilterSensitiveLog: (obj: UpdateVi
7090
6909
  * @internal
7091
6910
  */
7092
6911
  export declare const UpdateViewMetadataRequestFilterSensitiveLog: (obj: UpdateViewMetadataRequest) => any;
7093
- /**
7094
- * @internal
7095
- */
7096
- export declare const CreateContactRequestFilterSensitiveLog: (obj: CreateContactRequest) => any;