@aws-sdk/client-connect 3.99.0 → 3.105.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 (131) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/dist-cjs/Connect.js +105 -0
  3. package/dist-cjs/ConnectClient.js +2 -0
  4. package/dist-cjs/commands/CreateTaskTemplateCommand.js +36 -0
  5. package/dist-cjs/commands/DeleteTaskTemplateCommand.js +36 -0
  6. package/dist-cjs/commands/GetCurrentUserDataCommand.js +36 -0
  7. package/dist-cjs/commands/GetTaskTemplateCommand.js +36 -0
  8. package/dist-cjs/commands/ListQueuesCommand.js +3 -3
  9. package/dist-cjs/commands/ListQuickConnectsCommand.js +3 -3
  10. package/dist-cjs/commands/ListRoutingProfileQueuesCommand.js +3 -3
  11. package/dist-cjs/commands/ListRoutingProfilesCommand.js +3 -3
  12. package/dist-cjs/commands/ListSecurityKeysCommand.js +3 -3
  13. package/dist-cjs/commands/ListSecurityProfilePermissionsCommand.js +3 -3
  14. package/dist-cjs/commands/ListSecurityProfilesCommand.js +3 -3
  15. package/dist-cjs/commands/ListTagsForResourceCommand.js +3 -3
  16. package/dist-cjs/commands/ListTaskTemplatesCommand.js +36 -0
  17. package/dist-cjs/commands/ListUseCasesCommand.js +3 -3
  18. package/dist-cjs/commands/ListUserHierarchyGroupsCommand.js +3 -3
  19. package/dist-cjs/commands/ListUsersCommand.js +3 -3
  20. package/dist-cjs/commands/PutUserStatusCommand.js +3 -3
  21. package/dist-cjs/commands/ReleasePhoneNumberCommand.js +2 -2
  22. package/dist-cjs/commands/ResumeContactRecordingCommand.js +3 -3
  23. package/dist-cjs/commands/TransferContactCommand.js +36 -0
  24. package/dist-cjs/commands/UpdateTaskTemplateCommand.js +36 -0
  25. package/dist-cjs/commands/index.js +7 -0
  26. package/dist-cjs/models/models_0.js +283 -236
  27. package/dist-cjs/models/models_1.js +254 -2
  28. package/dist-cjs/pagination/GetCurrentUserDataPaginator.js +36 -0
  29. package/dist-cjs/pagination/ListTaskTemplatesPaginator.js +36 -0
  30. package/dist-cjs/pagination/index.js +2 -0
  31. package/dist-cjs/protocols/Aws_restJson1.js +1279 -34
  32. package/dist-es/Connect.js +105 -0
  33. package/dist-es/ConnectClient.js +2 -0
  34. package/dist-es/commands/CreateTaskTemplateCommand.js +39 -0
  35. package/dist-es/commands/DeleteTaskTemplateCommand.js +39 -0
  36. package/dist-es/commands/GetCurrentUserDataCommand.js +39 -0
  37. package/dist-es/commands/GetTaskTemplateCommand.js +39 -0
  38. package/dist-es/commands/ListQueuesCommand.js +1 -1
  39. package/dist-es/commands/ListQuickConnectsCommand.js +1 -1
  40. package/dist-es/commands/ListRoutingProfileQueuesCommand.js +1 -1
  41. package/dist-es/commands/ListRoutingProfilesCommand.js +1 -1
  42. package/dist-es/commands/ListSecurityKeysCommand.js +1 -1
  43. package/dist-es/commands/ListSecurityProfilePermissionsCommand.js +1 -1
  44. package/dist-es/commands/ListSecurityProfilesCommand.js +1 -1
  45. package/dist-es/commands/ListTagsForResourceCommand.js +1 -1
  46. package/dist-es/commands/ListTaskTemplatesCommand.js +39 -0
  47. package/dist-es/commands/ListUseCasesCommand.js +1 -1
  48. package/dist-es/commands/ListUserHierarchyGroupsCommand.js +1 -1
  49. package/dist-es/commands/ListUsersCommand.js +1 -1
  50. package/dist-es/commands/PutUserStatusCommand.js +1 -1
  51. package/dist-es/commands/ReleasePhoneNumberCommand.js +1 -1
  52. package/dist-es/commands/ResumeContactRecordingCommand.js +1 -1
  53. package/dist-es/commands/TransferContactCommand.js +39 -0
  54. package/dist-es/commands/UpdateTaskTemplateCommand.js +39 -0
  55. package/dist-es/commands/index.js +7 -0
  56. package/dist-es/models/models_0.js +214 -160
  57. package/dist-es/models/models_1.js +169 -0
  58. package/dist-es/pagination/GetCurrentUserDataPaginator.js +75 -0
  59. package/dist-es/pagination/ListTaskTemplatesPaginator.js +75 -0
  60. package/dist-es/pagination/index.js +2 -0
  61. package/dist-es/protocols/Aws_restJson1.js +1440 -63
  62. package/dist-types/Connect.d.ts +104 -22
  63. package/dist-types/ConnectClient.d.ts +9 -2
  64. package/dist-types/commands/AssociateDefaultVocabularyCommand.d.ts +2 -1
  65. package/dist-types/commands/CreateTaskTemplateCommand.d.ts +35 -0
  66. package/dist-types/commands/DeleteTaskTemplateCommand.d.ts +35 -0
  67. package/dist-types/commands/DisassociatePhoneNumberContactFlowCommand.d.ts +2 -1
  68. package/dist-types/commands/GetCurrentUserDataCommand.d.ts +35 -0
  69. package/dist-types/commands/GetTaskTemplateCommand.d.ts +35 -0
  70. package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +1 -1
  71. package/dist-types/commands/ListQueuesCommand.d.ts +1 -1
  72. package/dist-types/commands/ListQuickConnectsCommand.d.ts +1 -1
  73. package/dist-types/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
  74. package/dist-types/commands/ListRoutingProfilesCommand.d.ts +1 -1
  75. package/dist-types/commands/ListSecurityKeysCommand.d.ts +1 -1
  76. package/dist-types/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -1
  77. package/dist-types/commands/ListSecurityProfilesCommand.d.ts +1 -1
  78. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  79. package/dist-types/commands/ListTaskTemplatesCommand.d.ts +35 -0
  80. package/dist-types/commands/ListUseCasesCommand.d.ts +1 -1
  81. package/dist-types/commands/ListUserHierarchyGroupsCommand.d.ts +1 -1
  82. package/dist-types/commands/ListUsersCommand.d.ts +1 -1
  83. package/dist-types/commands/PutUserStatusCommand.d.ts +5 -6
  84. package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +1 -1
  85. package/dist-types/commands/ResumeContactRecordingCommand.d.ts +1 -1
  86. package/dist-types/commands/SearchVocabulariesCommand.d.ts +2 -1
  87. package/dist-types/commands/StartChatContactCommand.d.ts +3 -3
  88. package/dist-types/commands/StartContactRecordingCommand.d.ts +9 -7
  89. package/dist-types/commands/StopContactCommand.d.ts +3 -1
  90. package/dist-types/commands/TagResourceCommand.d.ts +2 -1
  91. package/dist-types/commands/TransferContactCommand.d.ts +58 -0
  92. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +2 -1
  93. package/dist-types/commands/UpdateTaskTemplateCommand.d.ts +37 -0
  94. package/dist-types/commands/index.d.ts +7 -0
  95. package/dist-types/models/models_0.d.ts +927 -850
  96. package/dist-types/models/models_1.d.ts +979 -50
  97. package/dist-types/pagination/GetCurrentUserDataPaginator.d.ts +4 -0
  98. package/dist-types/pagination/ListTaskTemplatesPaginator.d.ts +4 -0
  99. package/dist-types/pagination/index.d.ts +2 -0
  100. package/dist-types/protocols/Aws_restJson1.d.ts +21 -0
  101. package/dist-types/ts3.4/Connect.d.ts +35 -0
  102. package/dist-types/ts3.4/ConnectClient.d.ts +9 -2
  103. package/dist-types/ts3.4/commands/CreateTaskTemplateCommand.d.ts +17 -0
  104. package/dist-types/ts3.4/commands/DeleteTaskTemplateCommand.d.ts +17 -0
  105. package/dist-types/ts3.4/commands/GetCurrentUserDataCommand.d.ts +17 -0
  106. package/dist-types/ts3.4/commands/GetTaskTemplateCommand.d.ts +17 -0
  107. package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +1 -1
  108. package/dist-types/ts3.4/commands/ListQuickConnectsCommand.d.ts +1 -1
  109. package/dist-types/ts3.4/commands/ListRoutingProfileQueuesCommand.d.ts +1 -1
  110. package/dist-types/ts3.4/commands/ListRoutingProfilesCommand.d.ts +1 -1
  111. package/dist-types/ts3.4/commands/ListSecurityKeysCommand.d.ts +1 -1
  112. package/dist-types/ts3.4/commands/ListSecurityProfilePermissionsCommand.d.ts +1 -1
  113. package/dist-types/ts3.4/commands/ListSecurityProfilesCommand.d.ts +1 -1
  114. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
  115. package/dist-types/ts3.4/commands/ListTaskTemplatesCommand.d.ts +17 -0
  116. package/dist-types/ts3.4/commands/ListUseCasesCommand.d.ts +1 -1
  117. package/dist-types/ts3.4/commands/ListUserHierarchyGroupsCommand.d.ts +1 -1
  118. package/dist-types/ts3.4/commands/ListUsersCommand.d.ts +1 -1
  119. package/dist-types/ts3.4/commands/PutUserStatusCommand.d.ts +1 -1
  120. package/dist-types/ts3.4/commands/ReleasePhoneNumberCommand.d.ts +1 -1
  121. package/dist-types/ts3.4/commands/ResumeContactRecordingCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/TransferContactCommand.d.ts +17 -0
  123. package/dist-types/ts3.4/commands/UpdateTaskTemplateCommand.d.ts +17 -0
  124. package/dist-types/ts3.4/commands/index.d.ts +7 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +555 -517
  126. package/dist-types/ts3.4/models/models_1.d.ts +539 -26
  127. package/dist-types/ts3.4/pagination/GetCurrentUserDataPaginator.d.ts +4 -0
  128. package/dist-types/ts3.4/pagination/ListTaskTemplatesPaginator.d.ts +4 -0
  129. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  130. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +21 -0
  131. package/package.json +4 -3
@@ -12,6 +12,89 @@ export declare class AccessDeniedException extends __BaseException {
12
12
  */
13
13
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
14
  }
15
+ export declare enum ContactState {
16
+ CONNECTED = "CONNECTED",
17
+ CONNECTED_ONHOLD = "CONNECTED_ONHOLD",
18
+ CONNECTING = "CONNECTING",
19
+ ENDED = "ENDED",
20
+ ERROR = "ERROR",
21
+ INCOMING = "INCOMING",
22
+ MISSED = "MISSED",
23
+ PENDING = "PENDING",
24
+ REJECTED = "REJECTED"
25
+ }
26
+ export declare enum Channel {
27
+ CHAT = "CHAT",
28
+ TASK = "TASK",
29
+ VOICE = "VOICE"
30
+ }
31
+ export declare enum ContactInitiationMethod {
32
+ API = "API",
33
+ CALLBACK = "CALLBACK",
34
+ INBOUND = "INBOUND",
35
+ OUTBOUND = "OUTBOUND",
36
+ QUEUE_TRANSFER = "QUEUE_TRANSFER",
37
+ TRANSFER = "TRANSFER"
38
+ }
39
+ /**
40
+ * <p>Contains information about a queue resource for which metrics are returned.</p>
41
+ */
42
+ export interface QueueReference {
43
+ /**
44
+ * <p>The identifier of the queue.</p>
45
+ */
46
+ Id?: string;
47
+ /**
48
+ * <p>The Amazon Resource Name (ARN) of the queue.</p>
49
+ */
50
+ Arn?: string;
51
+ }
52
+ export declare namespace QueueReference {
53
+ /**
54
+ * @internal
55
+ */
56
+ const filterSensitiveLog: (obj: QueueReference) => any;
57
+ }
58
+ /**
59
+ * <p>Information about the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html">contact</a> associated to the
60
+ * user.</p>
61
+ */
62
+ export interface AgentContactReference {
63
+ /**
64
+ * <p>The identifier of the contact in this instance of Amazon Connect. </p>
65
+ */
66
+ ContactId?: string;
67
+ /**
68
+ * <p>The channel of the contact.</p>
69
+ */
70
+ Channel?: Channel | string;
71
+ /**
72
+ * <p>How the contact was initiated.</p>
73
+ */
74
+ InitiationMethod?: ContactInitiationMethod | string;
75
+ /**
76
+ * <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">state of the contact</a>.</p>
77
+ */
78
+ AgentContactState?: ContactState | string;
79
+ /**
80
+ * <p>The epoch timestamp when the contact state started.</p>
81
+ */
82
+ StateStartTimestamp?: Date;
83
+ /**
84
+ * <p>The time at which the contact was connected to an agent.</p>
85
+ */
86
+ ConnectedToAgentTimestamp?: Date;
87
+ /**
88
+ * <p>Contains information about a queue resource for which metrics are returned.</p>
89
+ */
90
+ Queue?: QueueReference;
91
+ }
92
+ export declare namespace AgentContactReference {
93
+ /**
94
+ * @internal
95
+ */
96
+ const filterSensitiveLog: (obj: AgentContactReference) => any;
97
+ }
15
98
  /**
16
99
  * <p>Information about the agent who accepted the contact.</p>
17
100
  */
@@ -75,9 +158,7 @@ export interface AgentStatus {
75
158
  /**
76
159
  * <p>The tags used to organize, track, or control access for this resource.</p>
77
160
  */
78
- Tags?: {
79
- [key: string]: string;
80
- };
161
+ Tags?: Record<string, string>;
81
162
  }
82
163
  export declare namespace AgentStatus {
83
164
  /**
@@ -85,6 +166,25 @@ export declare namespace AgentStatus {
85
166
  */
86
167
  const filterSensitiveLog: (obj: AgentStatus) => any;
87
168
  }
169
+ /**
170
+ * <p>Information about the agent's status.</p>
171
+ */
172
+ export interface AgentStatusReference {
173
+ /**
174
+ * <p>The start timestamp of the agent's status.</p>
175
+ */
176
+ StatusStartTimestamp?: Date;
177
+ /**
178
+ * <p>The Amazon Resource Name (ARN) of the agent's status.</p>
179
+ */
180
+ StatusArn?: string;
181
+ }
182
+ export declare namespace AgentStatusReference {
183
+ /**
184
+ * @internal
185
+ */
186
+ const filterSensitiveLog: (obj: AgentStatusReference) => any;
187
+ }
88
188
  /**
89
189
  * <p>Summary information for an agent status.</p>
90
190
  */
@@ -605,11 +705,6 @@ export declare namespace AssociateQueueQuickConnectsRequest {
605
705
  */
606
706
  const filterSensitiveLog: (obj: AssociateQueueQuickConnectsRequest) => any;
607
707
  }
608
- export declare enum Channel {
609
- CHAT = "CHAT",
610
- TASK = "TASK",
611
- VOICE = "VOICE"
612
- }
613
708
  /**
614
709
  * <p>Contains the channel and queue identifier for a routing profile.</p>
615
710
  */
@@ -712,7 +807,8 @@ export interface ClaimPhoneNumberRequest {
712
807
  */
713
808
  TargetArn: string | undefined;
714
809
  /**
715
- * <p>The phone number you want to claim. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
810
+ * <p>The phone number you want to claim. Phone numbers are formatted <code>[+] [country code]
811
+ * [subscriber number including area code]</code>.</p>
716
812
  */
717
813
  PhoneNumber: string | undefined;
718
814
  /**
@@ -722,9 +818,7 @@ export interface ClaimPhoneNumberRequest {
722
818
  /**
723
819
  * <p>The tags used to organize, track, or control access for this resource.</p>
724
820
  */
725
- Tags?: {
726
- [key: string]: string;
727
- };
821
+ Tags?: Record<string, string>;
728
822
  /**
729
823
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
730
824
  * request.</p>
@@ -789,9 +883,7 @@ export interface CreateAgentStatusRequest {
789
883
  /**
790
884
  * <p>The tags used to organize, track, or control access for this resource.</p>
791
885
  */
792
- Tags?: {
793
- [key: string]: string;
794
- };
886
+ Tags?: Record<string, string>;
795
887
  }
796
888
  export declare namespace CreateAgentStatusRequest {
797
889
  /**
@@ -863,9 +955,7 @@ export interface CreateContactFlowRequest {
863
955
  /**
864
956
  * <p>One or more tags.</p>
865
957
  */
866
- Tags?: {
867
- [key: string]: string;
868
- };
958
+ Tags?: Record<string, string>;
869
959
  }
870
960
  export declare namespace CreateContactFlowRequest {
871
961
  /**
@@ -939,9 +1029,7 @@ export interface CreateContactFlowModuleRequest {
939
1029
  /**
940
1030
  * <p>The tags used to organize, track, or control access for this resource.</p>
941
1031
  */
942
- Tags?: {
943
- [key: string]: string;
944
- };
1032
+ Tags?: Record<string, string>;
945
1033
  /**
946
1034
  * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
947
1035
  * request.</p>
@@ -1057,9 +1145,7 @@ export interface CreateHoursOfOperationRequest {
1057
1145
  /**
1058
1146
  * <p>The tags used to organize, track, or control access for this resource.</p>
1059
1147
  */
1060
- Tags?: {
1061
- [key: string]: string;
1062
- };
1148
+ Tags?: Record<string, string>;
1063
1149
  }
1064
1150
  export declare namespace CreateHoursOfOperationRequest {
1065
1151
  /**
@@ -1175,9 +1261,7 @@ export interface CreateIntegrationAssociationRequest {
1175
1261
  /**
1176
1262
  * <p>The tags used to organize, track, or control access for this resource.</p>
1177
1263
  */
1178
- Tags?: {
1179
- [key: string]: string;
1180
- };
1264
+ Tags?: Record<string, string>;
1181
1265
  }
1182
1266
  export declare namespace CreateIntegrationAssociationRequest {
1183
1267
  /**
@@ -1256,9 +1340,7 @@ export interface CreateQueueRequest {
1256
1340
  /**
1257
1341
  * <p>The tags used to organize, track, or control access for this resource.</p>
1258
1342
  */
1259
- Tags?: {
1260
- [key: string]: string;
1261
- };
1343
+ Tags?: Record<string, string>;
1262
1344
  }
1263
1345
  export declare namespace CreateQueueRequest {
1264
1346
  /**
@@ -1390,9 +1472,7 @@ export interface CreateQuickConnectRequest {
1390
1472
  /**
1391
1473
  * <p>The tags used to organize, track, or control access for this resource.</p>
1392
1474
  */
1393
- Tags?: {
1394
- [key: string]: string;
1395
- };
1475
+ Tags?: Record<string, string>;
1396
1476
  }
1397
1477
  export declare namespace CreateQuickConnectRequest {
1398
1478
  /**
@@ -1469,9 +1549,7 @@ export interface CreateRoutingProfileRequest {
1469
1549
  /**
1470
1550
  * <p>One or more tags.</p>
1471
1551
  */
1472
- Tags?: {
1473
- [key: string]: string;
1474
- };
1552
+ Tags?: Record<string, string>;
1475
1553
  }
1476
1554
  export declare namespace CreateRoutingProfileRequest {
1477
1555
  /**
@@ -1515,9 +1593,7 @@ export interface CreateSecurityProfileRequest {
1515
1593
  /**
1516
1594
  * <p>The tags used to organize, track, or control access for this resource.</p>
1517
1595
  */
1518
- Tags?: {
1519
- [key: string]: string;
1520
- };
1596
+ Tags?: Record<string, string>;
1521
1597
  }
1522
1598
  export declare namespace CreateSecurityProfileRequest {
1523
1599
  /**
@@ -1541,6 +1617,275 @@ export declare namespace CreateSecurityProfileResponse {
1541
1617
  */
1542
1618
  const filterSensitiveLog: (obj: CreateSecurityProfileResponse) => any;
1543
1619
  }
1620
+ /**
1621
+ * <p>The identifier of the task template field.</p>
1622
+ */
1623
+ export interface TaskTemplateFieldIdentifier {
1624
+ /**
1625
+ * <p>The name of the task template field.</p>
1626
+ */
1627
+ Name?: string;
1628
+ }
1629
+ export declare namespace TaskTemplateFieldIdentifier {
1630
+ /**
1631
+ * @internal
1632
+ */
1633
+ const filterSensitiveLog: (obj: TaskTemplateFieldIdentifier) => any;
1634
+ }
1635
+ /**
1636
+ * <p>A field that is invisible to an agent.</p>
1637
+ */
1638
+ export interface InvisibleFieldInfo {
1639
+ /**
1640
+ * <p>Identifier of the invisible field.</p>
1641
+ */
1642
+ Id?: TaskTemplateFieldIdentifier;
1643
+ }
1644
+ export declare namespace InvisibleFieldInfo {
1645
+ /**
1646
+ * @internal
1647
+ */
1648
+ const filterSensitiveLog: (obj: InvisibleFieldInfo) => any;
1649
+ }
1650
+ /**
1651
+ * <p>Indicates a field that is read-only to an agent.</p>
1652
+ */
1653
+ export interface ReadOnlyFieldInfo {
1654
+ /**
1655
+ * <p>Identifier of the read-only field.</p>
1656
+ */
1657
+ Id?: TaskTemplateFieldIdentifier;
1658
+ }
1659
+ export declare namespace ReadOnlyFieldInfo {
1660
+ /**
1661
+ * @internal
1662
+ */
1663
+ const filterSensitiveLog: (obj: ReadOnlyFieldInfo) => any;
1664
+ }
1665
+ /**
1666
+ * <p>Information about a required field.</p>
1667
+ */
1668
+ export interface RequiredFieldInfo {
1669
+ /**
1670
+ * <p>The unique identifier for the field.</p>
1671
+ */
1672
+ Id?: TaskTemplateFieldIdentifier;
1673
+ }
1674
+ export declare namespace RequiredFieldInfo {
1675
+ /**
1676
+ * @internal
1677
+ */
1678
+ const filterSensitiveLog: (obj: RequiredFieldInfo) => any;
1679
+ }
1680
+ /**
1681
+ * <p>Describes constraints that apply to the template fields.</p>
1682
+ */
1683
+ export interface TaskTemplateConstraints {
1684
+ /**
1685
+ * <p>Lists the fields that are required to be filled by agents.</p>
1686
+ */
1687
+ RequiredFields?: RequiredFieldInfo[];
1688
+ /**
1689
+ * <p>Lists the fields that are read-only to agents, and cannot be edited.</p>
1690
+ */
1691
+ ReadOnlyFields?: ReadOnlyFieldInfo[];
1692
+ /**
1693
+ * <p>Lists the fields that are invisible to agents.</p>
1694
+ */
1695
+ InvisibleFields?: InvisibleFieldInfo[];
1696
+ }
1697
+ export declare namespace TaskTemplateConstraints {
1698
+ /**
1699
+ * @internal
1700
+ */
1701
+ const filterSensitiveLog: (obj: TaskTemplateConstraints) => any;
1702
+ }
1703
+ /**
1704
+ * <p>Describes a default field and its corresponding value.</p>
1705
+ */
1706
+ export interface TaskTemplateDefaultFieldValue {
1707
+ /**
1708
+ * <p>Identifier of a field. </p>
1709
+ */
1710
+ Id?: TaskTemplateFieldIdentifier;
1711
+ /**
1712
+ * <p>Default value for the field.</p>
1713
+ */
1714
+ DefaultValue?: string;
1715
+ }
1716
+ export declare namespace TaskTemplateDefaultFieldValue {
1717
+ /**
1718
+ * @internal
1719
+ */
1720
+ const filterSensitiveLog: (obj: TaskTemplateDefaultFieldValue) => any;
1721
+ }
1722
+ /**
1723
+ * <p>Describes default values for fields on a template.</p>
1724
+ */
1725
+ export interface TaskTemplateDefaults {
1726
+ /**
1727
+ * <p>Default value for the field.</p>
1728
+ */
1729
+ DefaultFieldValues?: TaskTemplateDefaultFieldValue[];
1730
+ }
1731
+ export declare namespace TaskTemplateDefaults {
1732
+ /**
1733
+ * @internal
1734
+ */
1735
+ const filterSensitiveLog: (obj: TaskTemplateDefaults) => any;
1736
+ }
1737
+ export declare enum TaskTemplateFieldType {
1738
+ BOOLEAN = "BOOLEAN",
1739
+ DATE_TIME = "DATE_TIME",
1740
+ DESCRIPTION = "DESCRIPTION",
1741
+ EMAIL = "EMAIL",
1742
+ NAME = "NAME",
1743
+ NUMBER = "NUMBER",
1744
+ QUICK_CONNECT = "QUICK_CONNECT",
1745
+ SCHEDULED_TIME = "SCHEDULED_TIME",
1746
+ SINGLE_SELECT = "SINGLE_SELECT",
1747
+ TEXT = "TEXT",
1748
+ TEXT_AREA = "TEXT_AREA",
1749
+ URL = "URL"
1750
+ }
1751
+ /**
1752
+ * <p>Describes a single task template field.</p>
1753
+ */
1754
+ export interface TaskTemplateField {
1755
+ /**
1756
+ * <p>The unique identifier for the field.</p>
1757
+ */
1758
+ Id: TaskTemplateFieldIdentifier | undefined;
1759
+ /**
1760
+ * <p>The description of the field.</p>
1761
+ */
1762
+ Description?: string;
1763
+ /**
1764
+ * <p>Indicates the type of field.</p>
1765
+ */
1766
+ Type?: TaskTemplateFieldType | string;
1767
+ /**
1768
+ * <p>A list of options for a single select field.</p>
1769
+ */
1770
+ SingleSelectOptions?: string[];
1771
+ }
1772
+ export declare namespace TaskTemplateField {
1773
+ /**
1774
+ * @internal
1775
+ */
1776
+ const filterSensitiveLog: (obj: TaskTemplateField) => any;
1777
+ }
1778
+ export declare enum TaskTemplateStatus {
1779
+ ACTIVE = "ACTIVE",
1780
+ INACTIVE = "INACTIVE"
1781
+ }
1782
+ export interface CreateTaskTemplateRequest {
1783
+ /**
1784
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
1785
+ */
1786
+ InstanceId: string | undefined;
1787
+ /**
1788
+ * <p>The name of the task template.</p>
1789
+ */
1790
+ Name: string | undefined;
1791
+ /**
1792
+ * <p>The description of the task template.</p>
1793
+ */
1794
+ Description?: string;
1795
+ /**
1796
+ * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
1797
+ */
1798
+ ContactFlowId?: string;
1799
+ /**
1800
+ * <p>Constraints that are applicable to the fields listed.</p>
1801
+ */
1802
+ Constraints?: TaskTemplateConstraints;
1803
+ /**
1804
+ * <p>The default values for fields when a task is created by referencing this template.</p>
1805
+ */
1806
+ Defaults?: TaskTemplateDefaults;
1807
+ /**
1808
+ * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
1809
+ * Tasks can only be created from <code>ACTIVE</code> templates.
1810
+ * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created. </p>
1811
+ */
1812
+ Status?: TaskTemplateStatus | string;
1813
+ /**
1814
+ * <p>Fields that are part of the template.</p>
1815
+ */
1816
+ Fields: TaskTemplateField[] | undefined;
1817
+ /**
1818
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1819
+ * request.</p>
1820
+ */
1821
+ ClientToken?: string;
1822
+ }
1823
+ export declare namespace CreateTaskTemplateRequest {
1824
+ /**
1825
+ * @internal
1826
+ */
1827
+ const filterSensitiveLog: (obj: CreateTaskTemplateRequest) => any;
1828
+ }
1829
+ export interface CreateTaskTemplateResponse {
1830
+ /**
1831
+ * <p>The identifier of the task template resource.</p>
1832
+ */
1833
+ Id: string | undefined;
1834
+ /**
1835
+ * <p>The Amazon Resource Name (ARN) for the task template resource.</p>
1836
+ */
1837
+ Arn: string | undefined;
1838
+ }
1839
+ export declare namespace CreateTaskTemplateResponse {
1840
+ /**
1841
+ * @internal
1842
+ */
1843
+ const filterSensitiveLog: (obj: CreateTaskTemplateResponse) => any;
1844
+ }
1845
+ export declare enum PropertyValidationExceptionReason {
1846
+ INVALID_FORMAT = "INVALID_FORMAT",
1847
+ NOT_SUPPORTED = "NOT_SUPPORTED",
1848
+ REFERENCED_RESOURCE_NOT_FOUND = "REFERENCED_RESOURCE_NOT_FOUND",
1849
+ REQUIRED_PROPERTY_MISSING = "REQUIRED_PROPERTY_MISSING",
1850
+ RESOURCE_NAME_ALREADY_EXISTS = "RESOURCE_NAME_ALREADY_EXISTS",
1851
+ UNIQUE_CONSTRAINT_VIOLATED = "UNIQUE_CONSTRAINT_VIOLATED"
1852
+ }
1853
+ /**
1854
+ * <p>Contains information about why a property is not valid.</p>
1855
+ */
1856
+ export interface PropertyValidationExceptionProperty {
1857
+ /**
1858
+ * <p>The full property path.</p>
1859
+ */
1860
+ PropertyPath: string | undefined;
1861
+ /**
1862
+ * <p>Why the property is not valid.</p>
1863
+ */
1864
+ Reason: PropertyValidationExceptionReason | string | undefined;
1865
+ /**
1866
+ * <p>A message describing why the property is not valid.</p>
1867
+ */
1868
+ Message: string | undefined;
1869
+ }
1870
+ export declare namespace PropertyValidationExceptionProperty {
1871
+ /**
1872
+ * @internal
1873
+ */
1874
+ const filterSensitiveLog: (obj: PropertyValidationExceptionProperty) => any;
1875
+ }
1876
+ /**
1877
+ * <p></p>
1878
+ */
1879
+ export declare class PropertyValidationException extends __BaseException {
1880
+ readonly name: "PropertyValidationException";
1881
+ readonly $fault: "client";
1882
+ Message: string | undefined;
1883
+ PropertyList?: PropertyValidationExceptionProperty[];
1884
+ /**
1885
+ * @internal
1886
+ */
1887
+ constructor(opts: __ExceptionOptionType<PropertyValidationException, __BaseException>);
1888
+ }
1544
1889
  export declare enum UseCaseType {
1545
1890
  CONNECT_CAMPAIGNS = "CONNECT_CAMPAIGNS",
1546
1891
  RULES_EVALUATION = "RULES_EVALUATION"
@@ -1562,9 +1907,7 @@ export interface CreateUseCaseRequest {
1562
1907
  /**
1563
1908
  * <p>The tags used to organize, track, or control access for this resource.</p>
1564
1909
  */
1565
- Tags?: {
1566
- [key: string]: string;
1567
- };
1910
+ Tags?: Record<string, string>;
1568
1911
  }
1569
1912
  export declare namespace CreateUseCaseRequest {
1570
1913
  /**
@@ -1694,9 +2037,7 @@ export interface CreateUserRequest {
1694
2037
  /**
1695
2038
  * <p>One or more tags.</p>
1696
2039
  */
1697
- Tags?: {
1698
- [key: string]: string;
1699
- };
2040
+ Tags?: Record<string, string>;
1700
2041
  }
1701
2042
  export declare namespace CreateUserRequest {
1702
2043
  /**
@@ -1737,9 +2078,7 @@ export interface CreateUserHierarchyGroupRequest {
1737
2078
  /**
1738
2079
  * <p>The tags used to organize, track, or control access for this resource.</p>
1739
2080
  */
1740
- Tags?: {
1741
- [key: string]: string;
1742
- };
2081
+ Tags?: Record<string, string>;
1743
2082
  }
1744
2083
  export declare namespace CreateUserHierarchyGroupRequest {
1745
2084
  /**
@@ -1787,7 +2126,7 @@ export interface CreateVocabularyRequest {
1787
2126
  /**
1788
2127
  * <p>The content of the custom vocabulary in plain-text format with a table of values. Each row
1789
2128
  * in the table represents a word or a phrase, described with <code>Phrase</code>, <code>IPA</code>,
1790
- * <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
2129
+ * <code>SoundsLike</code>, and <code>DisplayAs</code> fields. Separate the fields with TAB
1791
2130
  * characters. The size limit is 50KB. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom
1792
2131
  * vocabulary using a table</a>.</p>
1793
2132
  */
@@ -1795,9 +2134,7 @@ export interface CreateVocabularyRequest {
1795
2134
  /**
1796
2135
  * <p>The tags used to organize, track, or control access for this resource.</p>
1797
2136
  */
1798
- Tags?: {
1799
- [key: string]: string;
1800
- };
2137
+ Tags?: Record<string, string>;
1801
2138
  }
1802
2139
  export declare namespace CreateVocabularyRequest {
1803
2140
  /**
@@ -1976,6 +2313,30 @@ export declare class ResourceInUseException extends __BaseException {
1976
2313
  */
1977
2314
  constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
1978
2315
  }
2316
+ export interface DeleteTaskTemplateRequest {
2317
+ /**
2318
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
2319
+ */
2320
+ InstanceId: string | undefined;
2321
+ /**
2322
+ * <p>A unique identifier for the task template.</p>
2323
+ */
2324
+ TaskTemplateId: string | undefined;
2325
+ }
2326
+ export declare namespace DeleteTaskTemplateRequest {
2327
+ /**
2328
+ * @internal
2329
+ */
2330
+ const filterSensitiveLog: (obj: DeleteTaskTemplateRequest) => any;
2331
+ }
2332
+ export interface DeleteTaskTemplateResponse {
2333
+ }
2334
+ export declare namespace DeleteTaskTemplateResponse {
2335
+ /**
2336
+ * @internal
2337
+ */
2338
+ const filterSensitiveLog: (obj: DeleteTaskTemplateResponse) => any;
2339
+ }
1979
2340
  export interface DeleteUseCaseRequest {
1980
2341
  /**
1981
2342
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -2108,14 +2469,6 @@ export declare namespace DescribeContactRequest {
2108
2469
  */
2109
2470
  const filterSensitiveLog: (obj: DescribeContactRequest) => any;
2110
2471
  }
2111
- export declare enum ContactInitiationMethod {
2112
- API = "API",
2113
- CALLBACK = "CALLBACK",
2114
- INBOUND = "INBOUND",
2115
- OUTBOUND = "OUTBOUND",
2116
- QUEUE_TRANSFER = "QUEUE_TRANSFER",
2117
- TRANSFER = "TRANSFER"
2118
- }
2119
2472
  /**
2120
2473
  * <p>If this contact was queued, this contains information about the queue. </p>
2121
2474
  */
@@ -2287,9 +2640,7 @@ export interface ContactFlow {
2287
2640
  /**
2288
2641
  * <p>One or more tags.</p>
2289
2642
  */
2290
- Tags?: {
2291
- [key: string]: string;
2292
- };
2643
+ Tags?: Record<string, string>;
2293
2644
  }
2294
2645
  export declare namespace ContactFlow {
2295
2646
  /**
@@ -2368,9 +2719,7 @@ export interface ContactFlowModule {
2368
2719
  /**
2369
2720
  * <p>The tags used to organize, track, or control access for this resource.</p>
2370
2721
  */
2371
- Tags?: {
2372
- [key: string]: string;
2373
- };
2722
+ Tags?: Record<string, string>;
2374
2723
  }
2375
2724
  export declare namespace ContactFlowModule {
2376
2725
  /**
@@ -2437,9 +2786,7 @@ export interface HoursOfOperation {
2437
2786
  /**
2438
2787
  * <p>The tags used to organize, track, or control access for this resource.</p>
2439
2788
  */
2440
- Tags?: {
2441
- [key: string]: string;
2442
- };
2789
+ Tags?: Record<string, string>;
2443
2790
  }
2444
2791
  export declare namespace HoursOfOperation {
2445
2792
  /**
@@ -2961,9 +3308,7 @@ export interface ClaimedPhoneNumberSummary {
2961
3308
  /**
2962
3309
  * <p>The tags used to organize, track, or control access for this resource.</p>
2963
3310
  */
2964
- Tags?: {
2965
- [key: string]: string;
2966
- };
3311
+ Tags?: Record<string, string>;
2967
3312
  /**
2968
3313
  * <p>The status of the phone number.</p>
2969
3314
  */
@@ -3046,9 +3391,7 @@ export interface Queue {
3046
3391
  /**
3047
3392
  * <p>The tags used to organize, track, or control access for this resource.</p>
3048
3393
  */
3049
- Tags?: {
3050
- [key: string]: string;
3051
- };
3394
+ Tags?: Record<string, string>;
3052
3395
  }
3053
3396
  export declare namespace Queue {
3054
3397
  /**
@@ -3111,9 +3454,7 @@ export interface QuickConnect {
3111
3454
  /**
3112
3455
  * <p>The tags used to organize, track, or control access for this resource.</p>
3113
3456
  */
3114
- Tags?: {
3115
- [key: string]: string;
3116
- };
3457
+ Tags?: Record<string, string>;
3117
3458
  }
3118
3459
  export declare namespace QuickConnect {
3119
3460
  /**
@@ -3185,9 +3526,7 @@ export interface RoutingProfile {
3185
3526
  /**
3186
3527
  * <p>One or more tags.</p>
3187
3528
  */
3188
- Tags?: {
3189
- [key: string]: string;
3190
- };
3529
+ Tags?: Record<string, string>;
3191
3530
  }
3192
3531
  export declare namespace RoutingProfile {
3193
3532
  /**
@@ -3250,9 +3589,7 @@ export interface SecurityProfile {
3250
3589
  /**
3251
3590
  * <p>The tags used to organize, track, or control access for this resource.</p>
3252
3591
  */
3253
- Tags?: {
3254
- [key: string]: string;
3255
- };
3592
+ Tags?: Record<string, string>;
3256
3593
  }
3257
3594
  export declare namespace SecurityProfile {
3258
3595
  /**
@@ -3332,9 +3669,7 @@ export interface User {
3332
3669
  * <p>The
3333
3670
  * tags.</p>
3334
3671
  */
3335
- Tags?: {
3336
- [key: string]: string;
3337
- };
3672
+ Tags?: Record<string, string>;
3338
3673
  }
3339
3674
  export declare namespace User {
3340
3675
  /**
@@ -3451,9 +3786,7 @@ export interface HierarchyGroup {
3451
3786
  /**
3452
3787
  * <p>The tags used to organize, track, or control access for this resource.</p>
3453
3788
  */
3454
- Tags?: {
3455
- [key: string]: string;
3456
- };
3789
+ Tags?: Record<string, string>;
3457
3790
  }
3458
3791
  export declare namespace HierarchyGroup {
3459
3792
  /**
@@ -3612,9 +3945,7 @@ export interface Vocabulary {
3612
3945
  /**
3613
3946
  * <p>The tags used to organize, track, or control access for this resource.</p>
3614
3947
  */
3615
- Tags?: {
3616
- [key: string]: string;
3617
- };
3948
+ Tags?: Record<string, string>;
3618
3949
  }
3619
3950
  export declare namespace Vocabulary {
3620
3951
  /**
@@ -3624,9 +3955,9 @@ export declare namespace Vocabulary {
3624
3955
  }
3625
3956
  export interface DescribeVocabularyResponse {
3626
3957
  /**
3627
- * <p>A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They
3628
- * are generally domain-specific words and phrases, words that Contact Lens is not recognizing, or
3629
- * proper nouns.</p>
3958
+ * <p>A list of specific words that you want Contact Lens for Amazon Connect to recognize in your audio input. They are
3959
+ * generally domain-specific words and phrases, words that Contact Lens is not recognizing, or proper
3960
+ * nouns.</p>
3630
3961
  */
3631
3962
  Vocabulary: Vocabulary | undefined;
3632
3963
  }
@@ -3820,9 +4151,7 @@ export interface GetContactAttributesResponse {
3820
4151
  /**
3821
4152
  * <p>Information about the attributes.</p>
3822
4153
  */
3823
- Attributes?: {
3824
- [key: string]: string;
3825
- };
4154
+ Attributes?: Record<string, string>;
3826
4155
  }
3827
4156
  export declare namespace GetContactAttributesResponse {
3828
4157
  /**
@@ -4051,26 +4380,7 @@ export declare namespace CurrentMetricData {
4051
4380
  const filterSensitiveLog: (obj: CurrentMetricData) => any;
4052
4381
  }
4053
4382
  /**
4054
- * <p>Contains information about a queue resource for which metrics are returned.</p>
4055
- */
4056
- export interface QueueReference {
4057
- /**
4058
- * <p>The identifier of the queue.</p>
4059
- */
4060
- Id?: string;
4061
- /**
4062
- * <p>The Amazon Resource Name (ARN) of the queue.</p>
4063
- */
4064
- Arn?: string;
4065
- }
4066
- export declare namespace QueueReference {
4067
- /**
4068
- * @internal
4069
- */
4070
- const filterSensitiveLog: (obj: QueueReference) => any;
4071
- }
4072
- /**
4073
- * <p>Contains information about the dimensions for a set of metrics.</p>
4383
+ * <p>Contains information about the dimensions for a set of metrics.</p>
4074
4384
  */
4075
4385
  export interface Dimensions {
4076
4386
  /**
@@ -4129,6 +4439,220 @@ export declare namespace GetCurrentMetricDataResponse {
4129
4439
  */
4130
4440
  const filterSensitiveLog: (obj: GetCurrentMetricDataResponse) => any;
4131
4441
  }
4442
+ /**
4443
+ * <p>Filters user data based on the contact information that is associated to
4444
+ * the users. It contains a list of <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
4445
+ */
4446
+ export interface ContactFilter {
4447
+ /**
4448
+ * <p>A list of up to 9 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</p>
4449
+ */
4450
+ ContactStates?: (ContactState | string)[];
4451
+ }
4452
+ export declare namespace ContactFilter {
4453
+ /**
4454
+ * @internal
4455
+ */
4456
+ const filterSensitiveLog: (obj: ContactFilter) => any;
4457
+ }
4458
+ /**
4459
+ * <p>A filter for the user data.</p>
4460
+ */
4461
+ export interface UserDataFilters {
4462
+ /**
4463
+ * <p>Contains information about a queue resource for which metrics are returned.</p>
4464
+ */
4465
+ Queues?: string[];
4466
+ /**
4467
+ * <p>A filter for the user data based on the contact information that is associated to the user. It
4468
+ * contains a list of contact states. </p>
4469
+ */
4470
+ ContactFilter?: ContactFilter;
4471
+ }
4472
+ export declare namespace UserDataFilters {
4473
+ /**
4474
+ * @internal
4475
+ */
4476
+ const filterSensitiveLog: (obj: UserDataFilters) => any;
4477
+ }
4478
+ export interface GetCurrentUserDataRequest {
4479
+ /**
4480
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
4481
+ */
4482
+ InstanceId: string | undefined;
4483
+ /**
4484
+ * <p>Filters up to 100 <code>Queues</code>, or up to 9 <code>ContactStates</code>. The user data is retrieved only for those users who are associated with
4485
+ * the queues and have contacts that are in the specified <code>ContactState</code>. </p>
4486
+ */
4487
+ Filters: UserDataFilters | undefined;
4488
+ /**
4489
+ * <p>The token for the next set of results. Use the value returned in the previous
4490
+ * response in the next request to retrieve the next set of results.</p>
4491
+ */
4492
+ NextToken?: string;
4493
+ /**
4494
+ * <p>The maximum number of results to return per page.</p>
4495
+ */
4496
+ MaxResults?: number;
4497
+ }
4498
+ export declare namespace GetCurrentUserDataRequest {
4499
+ /**
4500
+ * @internal
4501
+ */
4502
+ const filterSensitiveLog: (obj: GetCurrentUserDataRequest) => any;
4503
+ }
4504
+ /**
4505
+ * <p>Information about the hierarchy group.</p>
4506
+ */
4507
+ export interface HierarchyGroupSummaryReference {
4508
+ /**
4509
+ * <p>The unique identifier for the hierarchy group.</p>
4510
+ */
4511
+ Id?: string;
4512
+ /**
4513
+ * <p>The Amazon Resource Name (ARN) for the hierarchy group. </p>
4514
+ */
4515
+ Arn?: string;
4516
+ }
4517
+ export declare namespace HierarchyGroupSummaryReference {
4518
+ /**
4519
+ * @internal
4520
+ */
4521
+ const filterSensitiveLog: (obj: HierarchyGroupSummaryReference) => any;
4522
+ }
4523
+ /**
4524
+ * <p>Information about the levels in the hierarchy group.</p>
4525
+ */
4526
+ export interface HierarchyPathReference {
4527
+ /**
4528
+ * <p>Information about level one.</p>
4529
+ */
4530
+ LevelOne?: HierarchyGroupSummaryReference;
4531
+ /**
4532
+ * <p>Information about level two.</p>
4533
+ */
4534
+ LevelTwo?: HierarchyGroupSummaryReference;
4535
+ /**
4536
+ * <p>Information about level three.</p>
4537
+ */
4538
+ LevelThree?: HierarchyGroupSummaryReference;
4539
+ /**
4540
+ * <p>Information about level four.</p>
4541
+ */
4542
+ LevelFour?: HierarchyGroupSummaryReference;
4543
+ /**
4544
+ * <p>Information about level five.</p>
4545
+ */
4546
+ LevelFive?: HierarchyGroupSummaryReference;
4547
+ }
4548
+ export declare namespace HierarchyPathReference {
4549
+ /**
4550
+ * @internal
4551
+ */
4552
+ const filterSensitiveLog: (obj: HierarchyPathReference) => any;
4553
+ }
4554
+ /**
4555
+ * <p>Information about the routing profile assigned to the user.</p>
4556
+ */
4557
+ export interface RoutingProfileReference {
4558
+ /**
4559
+ * <p>The identifier of the routing profile.</p>
4560
+ */
4561
+ Id?: string;
4562
+ /**
4563
+ * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
4564
+ */
4565
+ Arn?: string;
4566
+ }
4567
+ export declare namespace RoutingProfileReference {
4568
+ /**
4569
+ * @internal
4570
+ */
4571
+ const filterSensitiveLog: (obj: RoutingProfileReference) => any;
4572
+ }
4573
+ /**
4574
+ * <p>Information about the user.</p>
4575
+ */
4576
+ export interface UserReference {
4577
+ /**
4578
+ * <p>The unique identifier for the user.</p>
4579
+ */
4580
+ Id?: string;
4581
+ /**
4582
+ * <p>The Amazon Resource Name (ARN) for the user.</p>
4583
+ */
4584
+ Arn?: string;
4585
+ }
4586
+ export declare namespace UserReference {
4587
+ /**
4588
+ * @internal
4589
+ */
4590
+ const filterSensitiveLog: (obj: UserReference) => any;
4591
+ }
4592
+ /**
4593
+ * <p>Data for a user.</p>
4594
+ */
4595
+ export interface UserData {
4596
+ /**
4597
+ * <p>Information about the user for the data that is returned. It contains resourceId and ARN of
4598
+ * the user. </p>
4599
+ */
4600
+ User?: UserReference;
4601
+ /**
4602
+ * <p>Information about the routing profile that is assigned to the user.</p>
4603
+ */
4604
+ RoutingProfile?: RoutingProfileReference;
4605
+ /**
4606
+ * <p>Contains information about the levels of a hierarchy group assigned to a user.</p>
4607
+ */
4608
+ HierarchyPath?: HierarchyPathReference;
4609
+ /**
4610
+ * <p>The status of the agent that they manually set in their Contact Control Panel (CCP), or that
4611
+ * the supervisor manually changes in the real-time metrics report.</p>
4612
+ */
4613
+ Status?: AgentStatusReference;
4614
+ /**
4615
+ * <p>A map of available slots by channel. The key is a channel name. The value is an integer: the
4616
+ * available number of slots. </p>
4617
+ */
4618
+ AvailableSlotsByChannel?: Record<string, number>;
4619
+ /**
4620
+ * <p>A map of maximum slots by channel. The key is a channel name. The value is an integer: the
4621
+ * maximum number of slots. This is calculated from <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html">MediaConcurrency</a> of the RoutingProfile assigned to the agent. </p>
4622
+ */
4623
+ MaxSlotsByChannel?: Record<string, number>;
4624
+ /**
4625
+ * <p> A map of active slots by channel. The key is a channel name. The value is an integer: the
4626
+ * number of active slots. </p>
4627
+ */
4628
+ ActiveSlotsByChannel?: Record<string, number>;
4629
+ /**
4630
+ * <p>A list of contact reference information.</p>
4631
+ */
4632
+ Contacts?: AgentContactReference[];
4633
+ }
4634
+ export declare namespace UserData {
4635
+ /**
4636
+ * @internal
4637
+ */
4638
+ const filterSensitiveLog: (obj: UserData) => any;
4639
+ }
4640
+ export interface GetCurrentUserDataResponse {
4641
+ /**
4642
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4643
+ */
4644
+ NextToken?: string;
4645
+ /**
4646
+ * <p>A list of the user data that is returned.</p>
4647
+ */
4648
+ UserDataList?: UserData[];
4649
+ }
4650
+ export declare namespace GetCurrentUserDataResponse {
4651
+ /**
4652
+ * @internal
4653
+ */
4654
+ const filterSensitiveLog: (obj: GetCurrentUserDataResponse) => any;
4655
+ }
4132
4656
  export interface GetFederationTokenRequest {
4133
4657
  /**
4134
4658
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -4528,6 +5052,89 @@ export declare namespace GetMetricDataResponse {
4528
5052
  */
4529
5053
  const filterSensitiveLog: (obj: GetMetricDataResponse) => any;
4530
5054
  }
5055
+ export interface GetTaskTemplateRequest {
5056
+ /**
5057
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5058
+ */
5059
+ InstanceId: string | undefined;
5060
+ /**
5061
+ * <p>A unique identifier for the task template.</p>
5062
+ */
5063
+ TaskTemplateId: string | undefined;
5064
+ /**
5065
+ * <p>The system generated version of a task template that is associated with a task, when the
5066
+ * task is created.</p>
5067
+ */
5068
+ SnapshotVersion?: string;
5069
+ }
5070
+ export declare namespace GetTaskTemplateRequest {
5071
+ /**
5072
+ * @internal
5073
+ */
5074
+ const filterSensitiveLog: (obj: GetTaskTemplateRequest) => any;
5075
+ }
5076
+ export interface GetTaskTemplateResponse {
5077
+ /**
5078
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5079
+ */
5080
+ InstanceId?: string;
5081
+ /**
5082
+ * <p>A unique identifier for the task template.</p>
5083
+ */
5084
+ Id: string | undefined;
5085
+ /**
5086
+ * <p>The Amazon Resource Name (ARN).</p>
5087
+ */
5088
+ Arn: string | undefined;
5089
+ /**
5090
+ * <p>The name of the task template.</p>
5091
+ */
5092
+ Name: string | undefined;
5093
+ /**
5094
+ * <p>The description of the task template.</p>
5095
+ */
5096
+ Description?: string;
5097
+ /**
5098
+ * <p>The identifier of the flow that runs by default when a task is created by referencing this template.</p>
5099
+ */
5100
+ ContactFlowId?: string;
5101
+ /**
5102
+ * <p>Constraints that are applicable to the fields listed.</p>
5103
+ */
5104
+ Constraints?: TaskTemplateConstraints;
5105
+ /**
5106
+ * <p>The default values for fields when a task is created by referencing this template.</p>
5107
+ */
5108
+ Defaults?: TaskTemplateDefaults;
5109
+ /**
5110
+ * <p>Fields that are part of the template.</p>
5111
+ */
5112
+ Fields?: TaskTemplateField[];
5113
+ /**
5114
+ * <p>Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it.
5115
+ * Tasks can only be created from <code>ACTIVE</code> templates.
5116
+ * If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.</p>
5117
+ */
5118
+ Status?: TaskTemplateStatus | string;
5119
+ /**
5120
+ * <p>The timestamp when the task template was last modified.</p>
5121
+ */
5122
+ LastModifiedTime?: Date;
5123
+ /**
5124
+ * <p>The timestamp when the task template was created.</p>
5125
+ */
5126
+ CreatedTime?: Date;
5127
+ /**
5128
+ * <p>The tags used to organize, track, or control access for this resource.</p>
5129
+ */
5130
+ Tags?: Record<string, string>;
5131
+ }
5132
+ export declare namespace GetTaskTemplateResponse {
5133
+ /**
5134
+ * @internal
5135
+ */
5136
+ const filterSensitiveLog: (obj: GetTaskTemplateResponse) => any;
5137
+ }
4531
5138
  export interface ListAgentStatusRequest {
4532
5139
  /**
4533
5140
  * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
@@ -4815,6 +5422,10 @@ export declare namespace ListContactFlowsResponse {
4815
5422
  }
4816
5423
  export declare enum ReferenceType {
4817
5424
  ATTACHMENT = "ATTACHMENT",
5425
+ DATE = "DATE",
5426
+ EMAIL = "EMAIL",
5427
+ NUMBER = "NUMBER",
5428
+ STRING = "STRING",
4818
5429
  URL = "URL"
4819
5430
  }
4820
5431
  export interface ListContactReferencesRequest {
@@ -4851,8 +5462,8 @@ export declare enum ReferenceStatus {
4851
5462
  REJECTED = "REJECTED"
4852
5463
  }
4853
5464
  /**
4854
- * <p>Information about the attachment reference if the <code>referenceType</code> is
4855
- * <code>ATTACHMENT</code>. Otherwise, null.</p>
5465
+ * <p>Information about a reference when the <code>referenceType</code> is
5466
+ * <code>ATTACHMENT</code>. Otherwise, null.</p>
4856
5467
  */
4857
5468
  export interface AttachmentReference {
4858
5469
  /**
@@ -4860,11 +5471,11 @@ export interface AttachmentReference {
4860
5471
  */
4861
5472
  Name?: string;
4862
5473
  /**
4863
- * <p>Contains the location path of the attachment reference.</p>
5474
+ * <p>The location path of the attachment reference.</p>
4864
5475
  */
4865
5476
  Value?: string;
4866
5477
  /**
4867
- * <p>Status of an attachment reference type.</p>
5478
+ * <p>Status of the attachment reference type.</p>
4868
5479
  */
4869
5480
  Status?: ReferenceStatus | string;
4870
5481
  }
@@ -4875,74 +5486,222 @@ export declare namespace AttachmentReference {
4875
5486
  const filterSensitiveLog: (obj: AttachmentReference) => any;
4876
5487
  }
4877
5488
  /**
4878
- * <p>The URL reference.</p>
5489
+ * <p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>.
5490
+ * Otherwise, null.</p>
4879
5491
  */
4880
- export interface UrlReference {
5492
+ export interface DateReference {
4881
5493
  /**
4882
- * <p>Identifier of the URL reference.</p>
5494
+ * <p>Identifier of the date reference.</p>
4883
5495
  */
4884
5496
  Name?: string;
4885
5497
  /**
4886
- * <p>A valid URL.</p>
5498
+ * <p>A valid date.</p>
4887
5499
  */
4888
5500
  Value?: string;
4889
5501
  }
4890
- export declare namespace UrlReference {
5502
+ export declare namespace DateReference {
4891
5503
  /**
4892
5504
  * @internal
4893
5505
  */
4894
- const filterSensitiveLog: (obj: UrlReference) => any;
5506
+ const filterSensitiveLog: (obj: DateReference) => any;
4895
5507
  }
4896
5508
  /**
4897
- * <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
4898
- * one non null field between the URL and attachment based on the reference type.</p>
5509
+ * <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
5510
+ * Otherwise, null.</p>
4899
5511
  */
4900
- export declare type ReferenceSummary = ReferenceSummary.AttachmentMember | ReferenceSummary.UrlMember | ReferenceSummary.$UnknownMember;
4901
- export declare namespace ReferenceSummary {
5512
+ export interface EmailReference {
4902
5513
  /**
4903
- * <p>Information about the URL reference if the <code>referenceType</code> is <code>URL</code>.
4904
- * Otherwise, null.</p>
5514
+ * <p>Identifier of the email reference.</p>
4905
5515
  */
4906
- interface UrlMember {
4907
- Url: UrlReference;
4908
- Attachment?: never;
4909
- $unknown?: never;
4910
- }
5516
+ Name?: string;
4911
5517
  /**
4912
- * <p>Information about the attachment reference if the <code>referenceType</code> is
4913
- * <code>ATTACHMENT</code>. Otherwise, null.</p>
5518
+ * <p>A valid email address.</p>
4914
5519
  */
4915
- interface AttachmentMember {
4916
- Url?: never;
4917
- Attachment: AttachmentReference;
4918
- $unknown?: never;
4919
- }
4920
- interface $UnknownMember {
4921
- Url?: never;
4922
- Attachment?: never;
4923
- $unknown: [string, any];
4924
- }
4925
- interface Visitor<T> {
4926
- Url: (value: UrlReference) => T;
4927
- Attachment: (value: AttachmentReference) => T;
4928
- _: (name: string, value: any) => T;
4929
- }
4930
- const visit: <T>(value: ReferenceSummary, visitor: Visitor<T>) => T;
5520
+ Value?: string;
5521
+ }
5522
+ export declare namespace EmailReference {
4931
5523
  /**
4932
5524
  * @internal
4933
5525
  */
4934
- const filterSensitiveLog: (obj: ReferenceSummary) => any;
5526
+ const filterSensitiveLog: (obj: EmailReference) => any;
4935
5527
  }
4936
- export interface ListContactReferencesResponse {
5528
+ /**
5529
+ * <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
5530
+ * Otherwise, null.</p>
5531
+ */
5532
+ export interface NumberReference {
4937
5533
  /**
4938
- * <p>Information about the contact flows.</p>
5534
+ * <p>Identifier of the number reference.</p>
4939
5535
  */
4940
- ReferenceSummaryList?: ReferenceSummary[];
5536
+ Name?: string;
4941
5537
  /**
4942
- * <p>If there are additional results, this is the token for the next set of results.</p>
4943
- * <important>
4944
- * <p>This is always returned as null in the response.</p>
4945
- * </important>
5538
+ * <p>A valid number.</p>
5539
+ */
5540
+ Value?: string;
5541
+ }
5542
+ export declare namespace NumberReference {
5543
+ /**
5544
+ * @internal
5545
+ */
5546
+ const filterSensitiveLog: (obj: NumberReference) => any;
5547
+ }
5548
+ /**
5549
+ * <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
5550
+ * Otherwise, null.</p>
5551
+ */
5552
+ export interface StringReference {
5553
+ /**
5554
+ * <p>Identifier of the string reference.</p>
5555
+ */
5556
+ Name?: string;
5557
+ /**
5558
+ * <p>A valid string.</p>
5559
+ */
5560
+ Value?: string;
5561
+ }
5562
+ export declare namespace StringReference {
5563
+ /**
5564
+ * @internal
5565
+ */
5566
+ const filterSensitiveLog: (obj: StringReference) => any;
5567
+ }
5568
+ /**
5569
+ * <p>The URL reference.</p>
5570
+ */
5571
+ export interface UrlReference {
5572
+ /**
5573
+ * <p>Identifier of the URL reference.</p>
5574
+ */
5575
+ Name?: string;
5576
+ /**
5577
+ * <p>A valid URL.</p>
5578
+ */
5579
+ Value?: string;
5580
+ }
5581
+ export declare namespace UrlReference {
5582
+ /**
5583
+ * @internal
5584
+ */
5585
+ const filterSensitiveLog: (obj: UrlReference) => any;
5586
+ }
5587
+ /**
5588
+ * <p>Contains summary information about a reference. <code>ReferenceSummary</code> contains only
5589
+ * one non null field between the URL and attachment based on the reference type.</p>
5590
+ */
5591
+ export declare type ReferenceSummary = ReferenceSummary.AttachmentMember | ReferenceSummary.DateMember | ReferenceSummary.EmailMember | ReferenceSummary.NumberMember | ReferenceSummary.StringMember | ReferenceSummary.UrlMember | ReferenceSummary.$UnknownMember;
5592
+ export declare namespace ReferenceSummary {
5593
+ /**
5594
+ * <p>Information about the reference when the <code>referenceType</code> is <code>URL</code>.
5595
+ * Otherwise, null.</p>
5596
+ */
5597
+ interface UrlMember {
5598
+ Url: UrlReference;
5599
+ Attachment?: never;
5600
+ String?: never;
5601
+ Number?: never;
5602
+ Date?: never;
5603
+ Email?: never;
5604
+ $unknown?: never;
5605
+ }
5606
+ /**
5607
+ * <p>Information about the reference when the <code>referenceType</code> is
5608
+ * <code>ATTACHMENT</code>. Otherwise, null.</p>
5609
+ */
5610
+ interface AttachmentMember {
5611
+ Url?: never;
5612
+ Attachment: AttachmentReference;
5613
+ String?: never;
5614
+ Number?: never;
5615
+ Date?: never;
5616
+ Email?: never;
5617
+ $unknown?: never;
5618
+ }
5619
+ /**
5620
+ * <p>Information about a reference when the <code>referenceType</code> is <code>STRING</code>.
5621
+ * Otherwise, null.</p>
5622
+ */
5623
+ interface StringMember {
5624
+ Url?: never;
5625
+ Attachment?: never;
5626
+ String: StringReference;
5627
+ Number?: never;
5628
+ Date?: never;
5629
+ Email?: never;
5630
+ $unknown?: never;
5631
+ }
5632
+ /**
5633
+ * <p>Information about a reference when the <code>referenceType</code> is <code>NUMBER</code>.
5634
+ * Otherwise, null.</p>
5635
+ */
5636
+ interface NumberMember {
5637
+ Url?: never;
5638
+ Attachment?: never;
5639
+ String?: never;
5640
+ Number: NumberReference;
5641
+ Date?: never;
5642
+ Email?: never;
5643
+ $unknown?: never;
5644
+ }
5645
+ /**
5646
+ * <p>Information about a reference when the <code>referenceType</code> is <code>DATE</code>.
5647
+ * Otherwise, null.</p>
5648
+ */
5649
+ interface DateMember {
5650
+ Url?: never;
5651
+ Attachment?: never;
5652
+ String?: never;
5653
+ Number?: never;
5654
+ Date: DateReference;
5655
+ Email?: never;
5656
+ $unknown?: never;
5657
+ }
5658
+ /**
5659
+ * <p>Information about a reference when the <code>referenceType</code> is <code>EMAIL</code>.
5660
+ * Otherwise, null.</p>
5661
+ */
5662
+ interface EmailMember {
5663
+ Url?: never;
5664
+ Attachment?: never;
5665
+ String?: never;
5666
+ Number?: never;
5667
+ Date?: never;
5668
+ Email: EmailReference;
5669
+ $unknown?: never;
5670
+ }
5671
+ interface $UnknownMember {
5672
+ Url?: never;
5673
+ Attachment?: never;
5674
+ String?: never;
5675
+ Number?: never;
5676
+ Date?: never;
5677
+ Email?: never;
5678
+ $unknown: [string, any];
5679
+ }
5680
+ interface Visitor<T> {
5681
+ Url: (value: UrlReference) => T;
5682
+ Attachment: (value: AttachmentReference) => T;
5683
+ String: (value: StringReference) => T;
5684
+ Number: (value: NumberReference) => T;
5685
+ Date: (value: DateReference) => T;
5686
+ Email: (value: EmailReference) => T;
5687
+ _: (name: string, value: any) => T;
5688
+ }
5689
+ const visit: <T>(value: ReferenceSummary, visitor: Visitor<T>) => T;
5690
+ /**
5691
+ * @internal
5692
+ */
5693
+ const filterSensitiveLog: (obj: ReferenceSummary) => any;
5694
+ }
5695
+ export interface ListContactReferencesResponse {
5696
+ /**
5697
+ * <p>Information about the contact flows.</p>
5698
+ */
5699
+ ReferenceSummaryList?: ReferenceSummary[];
5700
+ /**
5701
+ * <p>If there are additional results, this is the token for the next set of results.</p>
5702
+ * <important>
5703
+ * <p>This is always returned as null in the response.</p>
5704
+ * </important>
4946
5705
  */
4947
5706
  NextToken?: string;
4948
5707
  }
@@ -5479,7 +6238,8 @@ export declare namespace ListPhoneNumbersResponse {
5479
6238
  }
5480
6239
  export interface ListPhoneNumbersV2Request {
5481
6240
  /**
5482
- * <p>The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If <code>TargetArn</code> input is not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account.</p>
6241
+ * <p>The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to. If <code>TargetArn</code> input is not provided, this API lists numbers claimed
6242
+ * to all the Amazon Connect instances belonging to your account.</p>
5483
6243
  */
5484
6244
  TargetArn?: string;
5485
6245
  /**
@@ -5690,686 +6450,3 @@ export declare namespace ListQueueQuickConnectsResponse {
5690
6450
  */
5691
6451
  const filterSensitiveLog: (obj: ListQueueQuickConnectsResponse) => any;
5692
6452
  }
5693
- export declare enum QueueType {
5694
- AGENT = "AGENT",
5695
- STANDARD = "STANDARD"
5696
- }
5697
- export interface ListQueuesRequest {
5698
- /**
5699
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5700
- */
5701
- InstanceId: string | undefined;
5702
- /**
5703
- * <p>The type of queue.</p>
5704
- */
5705
- QueueTypes?: (QueueType | string)[];
5706
- /**
5707
- * <p>The token for the next set of results. Use the value returned in the previous
5708
- * response in the next request to retrieve the next set of results.</p>
5709
- */
5710
- NextToken?: string;
5711
- /**
5712
- * <p>The maximum number of results to return per page.</p>
5713
- */
5714
- MaxResults?: number;
5715
- }
5716
- export declare namespace ListQueuesRequest {
5717
- /**
5718
- * @internal
5719
- */
5720
- const filterSensitiveLog: (obj: ListQueuesRequest) => any;
5721
- }
5722
- /**
5723
- * <p>Contains summary information about a queue.</p>
5724
- */
5725
- export interface QueueSummary {
5726
- /**
5727
- * <p>The identifier of the queue.</p>
5728
- */
5729
- Id?: string;
5730
- /**
5731
- * <p>The Amazon Resource Name (ARN) of the queue.</p>
5732
- */
5733
- Arn?: string;
5734
- /**
5735
- * <p>The name of the queue.</p>
5736
- */
5737
- Name?: string;
5738
- /**
5739
- * <p>The type of queue.</p>
5740
- */
5741
- QueueType?: QueueType | string;
5742
- }
5743
- export declare namespace QueueSummary {
5744
- /**
5745
- * @internal
5746
- */
5747
- const filterSensitiveLog: (obj: QueueSummary) => any;
5748
- }
5749
- export interface ListQueuesResponse {
5750
- /**
5751
- * <p>Information about the queues.</p>
5752
- */
5753
- QueueSummaryList?: QueueSummary[];
5754
- /**
5755
- * <p>If there are additional results, this is the token for the next set of results.</p>
5756
- */
5757
- NextToken?: string;
5758
- }
5759
- export declare namespace ListQueuesResponse {
5760
- /**
5761
- * @internal
5762
- */
5763
- const filterSensitiveLog: (obj: ListQueuesResponse) => any;
5764
- }
5765
- export interface ListQuickConnectsRequest {
5766
- /**
5767
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5768
- */
5769
- InstanceId: string | undefined;
5770
- /**
5771
- * <p>The token for the next set of results. Use the value returned in the previous
5772
- * response in the next request to retrieve the next set of results.</p>
5773
- */
5774
- NextToken?: string;
5775
- /**
5776
- * <p>The maximum number of results to return per page.</p>
5777
- */
5778
- MaxResults?: number;
5779
- /**
5780
- * <p>The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are
5781
- * prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>
5782
- */
5783
- QuickConnectTypes?: (QuickConnectType | string)[];
5784
- }
5785
- export declare namespace ListQuickConnectsRequest {
5786
- /**
5787
- * @internal
5788
- */
5789
- const filterSensitiveLog: (obj: ListQuickConnectsRequest) => any;
5790
- }
5791
- export interface ListQuickConnectsResponse {
5792
- /**
5793
- * <p>Information about the quick connects.</p>
5794
- */
5795
- QuickConnectSummaryList?: QuickConnectSummary[];
5796
- /**
5797
- * <p>If there are additional results, this is the token for the next set of results.</p>
5798
- */
5799
- NextToken?: string;
5800
- }
5801
- export declare namespace ListQuickConnectsResponse {
5802
- /**
5803
- * @internal
5804
- */
5805
- const filterSensitiveLog: (obj: ListQuickConnectsResponse) => any;
5806
- }
5807
- export interface ListRoutingProfileQueuesRequest {
5808
- /**
5809
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5810
- */
5811
- InstanceId: string | undefined;
5812
- /**
5813
- * <p>The identifier of the routing profile.</p>
5814
- */
5815
- RoutingProfileId: string | undefined;
5816
- /**
5817
- * <p>The token for the next set of results. Use the value returned in the previous
5818
- * response in the next request to retrieve the next set of results.</p>
5819
- */
5820
- NextToken?: string;
5821
- /**
5822
- * <p>The maximum number of results to return per page.</p>
5823
- */
5824
- MaxResults?: number;
5825
- }
5826
- export declare namespace ListRoutingProfileQueuesRequest {
5827
- /**
5828
- * @internal
5829
- */
5830
- const filterSensitiveLog: (obj: ListRoutingProfileQueuesRequest) => any;
5831
- }
5832
- /**
5833
- * <p>Contains summary information about a routing profile queue.</p>
5834
- */
5835
- export interface RoutingProfileQueueConfigSummary {
5836
- /**
5837
- * <p>The identifier for the queue.</p>
5838
- */
5839
- QueueId: string | undefined;
5840
- /**
5841
- * <p>The Amazon Resource Name (ARN) of the queue.</p>
5842
- */
5843
- QueueArn: string | undefined;
5844
- /**
5845
- * <p>The name of the queue.</p>
5846
- */
5847
- QueueName: string | undefined;
5848
- /**
5849
- * <p>The order in which contacts are to be handled for the queue. For more information, see
5850
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
5851
- * delay</a>.</p>
5852
- */
5853
- Priority: number | undefined;
5854
- /**
5855
- * <p>The delay, in seconds, that a contact should be in the queue before they are routed to an
5856
- * available agent. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html">Queues: priority and
5857
- * delay</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
5858
- */
5859
- Delay: number | undefined;
5860
- /**
5861
- * <p>The channels this queue supports.</p>
5862
- */
5863
- Channel: Channel | string | undefined;
5864
- }
5865
- export declare namespace RoutingProfileQueueConfigSummary {
5866
- /**
5867
- * @internal
5868
- */
5869
- const filterSensitiveLog: (obj: RoutingProfileQueueConfigSummary) => any;
5870
- }
5871
- export interface ListRoutingProfileQueuesResponse {
5872
- /**
5873
- * <p>If there are additional results, this is the token for the next set of results.</p>
5874
- */
5875
- NextToken?: string;
5876
- /**
5877
- * <p>Information about the routing profiles.</p>
5878
- */
5879
- RoutingProfileQueueConfigSummaryList?: RoutingProfileQueueConfigSummary[];
5880
- }
5881
- export declare namespace ListRoutingProfileQueuesResponse {
5882
- /**
5883
- * @internal
5884
- */
5885
- const filterSensitiveLog: (obj: ListRoutingProfileQueuesResponse) => any;
5886
- }
5887
- export interface ListRoutingProfilesRequest {
5888
- /**
5889
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5890
- */
5891
- InstanceId: string | undefined;
5892
- /**
5893
- * <p>The token for the next set of results. Use the value returned in the previous
5894
- * response in the next request to retrieve the next set of results.</p>
5895
- */
5896
- NextToken?: string;
5897
- /**
5898
- * <p>The maximum number of results to return per page.</p>
5899
- */
5900
- MaxResults?: number;
5901
- }
5902
- export declare namespace ListRoutingProfilesRequest {
5903
- /**
5904
- * @internal
5905
- */
5906
- const filterSensitiveLog: (obj: ListRoutingProfilesRequest) => any;
5907
- }
5908
- /**
5909
- * <p>Contains summary information about a routing profile.</p>
5910
- */
5911
- export interface RoutingProfileSummary {
5912
- /**
5913
- * <p>The identifier of the routing profile.</p>
5914
- */
5915
- Id?: string;
5916
- /**
5917
- * <p>The Amazon Resource Name (ARN) of the routing profile.</p>
5918
- */
5919
- Arn?: string;
5920
- /**
5921
- * <p>The name of the routing profile.</p>
5922
- */
5923
- Name?: string;
5924
- }
5925
- export declare namespace RoutingProfileSummary {
5926
- /**
5927
- * @internal
5928
- */
5929
- const filterSensitiveLog: (obj: RoutingProfileSummary) => any;
5930
- }
5931
- export interface ListRoutingProfilesResponse {
5932
- /**
5933
- * <p>Information about the routing profiles.</p>
5934
- */
5935
- RoutingProfileSummaryList?: RoutingProfileSummary[];
5936
- /**
5937
- * <p>If there are additional results, this is the token for the next set of results.</p>
5938
- */
5939
- NextToken?: string;
5940
- }
5941
- export declare namespace ListRoutingProfilesResponse {
5942
- /**
5943
- * @internal
5944
- */
5945
- const filterSensitiveLog: (obj: ListRoutingProfilesResponse) => any;
5946
- }
5947
- export interface ListSecurityKeysRequest {
5948
- /**
5949
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
5950
- */
5951
- InstanceId: string | undefined;
5952
- /**
5953
- * <p>The token for the next set of results. Use the value returned in the previous
5954
- * response in the next request to retrieve the next set of results.</p>
5955
- */
5956
- NextToken?: string;
5957
- /**
5958
- * <p>The maximum number of results to return per page.</p>
5959
- */
5960
- MaxResults?: number;
5961
- }
5962
- export declare namespace ListSecurityKeysRequest {
5963
- /**
5964
- * @internal
5965
- */
5966
- const filterSensitiveLog: (obj: ListSecurityKeysRequest) => any;
5967
- }
5968
- /**
5969
- * <p>Configuration information of the security key.</p>
5970
- */
5971
- export interface SecurityKey {
5972
- /**
5973
- * <p>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</p>
5974
- */
5975
- AssociationId?: string;
5976
- /**
5977
- * <p>The key of the security key.</p>
5978
- */
5979
- Key?: string;
5980
- /**
5981
- * <p>When the security key was created.</p>
5982
- */
5983
- CreationTime?: Date;
5984
- }
5985
- export declare namespace SecurityKey {
5986
- /**
5987
- * @internal
5988
- */
5989
- const filterSensitiveLog: (obj: SecurityKey) => any;
5990
- }
5991
- export interface ListSecurityKeysResponse {
5992
- /**
5993
- * <p>The security keys.</p>
5994
- */
5995
- SecurityKeys?: SecurityKey[];
5996
- /**
5997
- * <p>If there are additional results, this is the token for the next set of results.</p>
5998
- */
5999
- NextToken?: string;
6000
- }
6001
- export declare namespace ListSecurityKeysResponse {
6002
- /**
6003
- * @internal
6004
- */
6005
- const filterSensitiveLog: (obj: ListSecurityKeysResponse) => any;
6006
- }
6007
- export interface ListSecurityProfilePermissionsRequest {
6008
- /**
6009
- * <p>The identifier for the security profle.</p>
6010
- */
6011
- SecurityProfileId: string | undefined;
6012
- /**
6013
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6014
- */
6015
- InstanceId: string | undefined;
6016
- /**
6017
- * <p>The token for the next set of results. Use the value returned in the previous
6018
- * response in the next request to retrieve the next set of results.</p>
6019
- */
6020
- NextToken?: string;
6021
- /**
6022
- * <p>The maximum number of results to return per page.</p>
6023
- */
6024
- MaxResults?: number;
6025
- }
6026
- export declare namespace ListSecurityProfilePermissionsRequest {
6027
- /**
6028
- * @internal
6029
- */
6030
- const filterSensitiveLog: (obj: ListSecurityProfilePermissionsRequest) => any;
6031
- }
6032
- export interface ListSecurityProfilePermissionsResponse {
6033
- /**
6034
- * <p>The permissions granted to the security profile.</p>
6035
- */
6036
- Permissions?: string[];
6037
- /**
6038
- * <p>If there are additional results, this is the token for the next set of results.</p>
6039
- */
6040
- NextToken?: string;
6041
- }
6042
- export declare namespace ListSecurityProfilePermissionsResponse {
6043
- /**
6044
- * @internal
6045
- */
6046
- const filterSensitiveLog: (obj: ListSecurityProfilePermissionsResponse) => any;
6047
- }
6048
- export interface ListSecurityProfilesRequest {
6049
- /**
6050
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6051
- */
6052
- InstanceId: string | undefined;
6053
- /**
6054
- * <p>The token for the next set of results. Use the value returned in the previous
6055
- * response in the next request to retrieve the next set of results.</p>
6056
- */
6057
- NextToken?: string;
6058
- /**
6059
- * <p>The maximum number of results to return per page.</p>
6060
- */
6061
- MaxResults?: number;
6062
- }
6063
- export declare namespace ListSecurityProfilesRequest {
6064
- /**
6065
- * @internal
6066
- */
6067
- const filterSensitiveLog: (obj: ListSecurityProfilesRequest) => any;
6068
- }
6069
- /**
6070
- * <p>Contains information about a security profile.</p>
6071
- */
6072
- export interface SecurityProfileSummary {
6073
- /**
6074
- * <p>The identifier of the security profile.</p>
6075
- */
6076
- Id?: string;
6077
- /**
6078
- * <p>The Amazon Resource Name (ARN) of the security profile.</p>
6079
- */
6080
- Arn?: string;
6081
- /**
6082
- * <p>The name of the security profile.</p>
6083
- */
6084
- Name?: string;
6085
- }
6086
- export declare namespace SecurityProfileSummary {
6087
- /**
6088
- * @internal
6089
- */
6090
- const filterSensitiveLog: (obj: SecurityProfileSummary) => any;
6091
- }
6092
- export interface ListSecurityProfilesResponse {
6093
- /**
6094
- * <p>Information about the security profiles.</p>
6095
- */
6096
- SecurityProfileSummaryList?: SecurityProfileSummary[];
6097
- /**
6098
- * <p>If there are additional results, this is the token for the next set of results.</p>
6099
- */
6100
- NextToken?: string;
6101
- }
6102
- export declare namespace ListSecurityProfilesResponse {
6103
- /**
6104
- * @internal
6105
- */
6106
- const filterSensitiveLog: (obj: ListSecurityProfilesResponse) => any;
6107
- }
6108
- export interface ListTagsForResourceRequest {
6109
- /**
6110
- * <p>The Amazon Resource Name (ARN) of the resource.</p>
6111
- */
6112
- resourceArn: string | undefined;
6113
- }
6114
- export declare namespace ListTagsForResourceRequest {
6115
- /**
6116
- * @internal
6117
- */
6118
- const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
6119
- }
6120
- export interface ListTagsForResourceResponse {
6121
- /**
6122
- * <p>Information about the tags.</p>
6123
- */
6124
- tags?: {
6125
- [key: string]: string;
6126
- };
6127
- }
6128
- export declare namespace ListTagsForResourceResponse {
6129
- /**
6130
- * @internal
6131
- */
6132
- const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
6133
- }
6134
- /**
6135
- * <p>Provides summary information about the use cases for the specified integration
6136
- * association.</p>
6137
- */
6138
- export interface ListUseCasesRequest {
6139
- /**
6140
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6141
- */
6142
- InstanceId: string | undefined;
6143
- /**
6144
- * <p>The identifier for the integration association.</p>
6145
- */
6146
- IntegrationAssociationId: string | undefined;
6147
- /**
6148
- * <p>The token for the next set of results. Use the value returned in the previous
6149
- * response in the next request to retrieve the next set of results.</p>
6150
- */
6151
- NextToken?: string;
6152
- /**
6153
- * <p>The maximum number of results to return per page.</p>
6154
- */
6155
- MaxResults?: number;
6156
- }
6157
- export declare namespace ListUseCasesRequest {
6158
- /**
6159
- * @internal
6160
- */
6161
- const filterSensitiveLog: (obj: ListUseCasesRequest) => any;
6162
- }
6163
- /**
6164
- * <p>Contains the
6165
- * use
6166
- * case.</p>
6167
- */
6168
- export interface UseCase {
6169
- /**
6170
- * <p>The identifier for the use case.</p>
6171
- */
6172
- UseCaseId?: string;
6173
- /**
6174
- * <p>The Amazon Resource Name (ARN) for the use case.</p>
6175
- */
6176
- UseCaseArn?: string;
6177
- /**
6178
- * <p>The type of use case to associate to the integration association. Each integration
6179
- * association can have only one of each use case type.</p>
6180
- */
6181
- UseCaseType?: UseCaseType | string;
6182
- }
6183
- export declare namespace UseCase {
6184
- /**
6185
- * @internal
6186
- */
6187
- const filterSensitiveLog: (obj: UseCase) => any;
6188
- }
6189
- export interface ListUseCasesResponse {
6190
- /**
6191
- * <p>The use cases.</p>
6192
- */
6193
- UseCaseSummaryList?: UseCase[];
6194
- /**
6195
- * <p>If there are additional results, this is the token for the next set of results.</p>
6196
- */
6197
- NextToken?: string;
6198
- }
6199
- export declare namespace ListUseCasesResponse {
6200
- /**
6201
- * @internal
6202
- */
6203
- const filterSensitiveLog: (obj: ListUseCasesResponse) => any;
6204
- }
6205
- export interface ListUserHierarchyGroupsRequest {
6206
- /**
6207
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6208
- */
6209
- InstanceId: string | undefined;
6210
- /**
6211
- * <p>The token for the next set of results. Use the value returned in the previous
6212
- * response in the next request to retrieve the next set of results.</p>
6213
- */
6214
- NextToken?: string;
6215
- /**
6216
- * <p>The maximum number of results to return per page.</p>
6217
- */
6218
- MaxResults?: number;
6219
- }
6220
- export declare namespace ListUserHierarchyGroupsRequest {
6221
- /**
6222
- * @internal
6223
- */
6224
- const filterSensitiveLog: (obj: ListUserHierarchyGroupsRequest) => any;
6225
- }
6226
- export interface ListUserHierarchyGroupsResponse {
6227
- /**
6228
- * <p>Information about the hierarchy groups.</p>
6229
- */
6230
- UserHierarchyGroupSummaryList?: HierarchyGroupSummary[];
6231
- /**
6232
- * <p>If there are additional results, this is the token for the next set of results.</p>
6233
- */
6234
- NextToken?: string;
6235
- }
6236
- export declare namespace ListUserHierarchyGroupsResponse {
6237
- /**
6238
- * @internal
6239
- */
6240
- const filterSensitiveLog: (obj: ListUserHierarchyGroupsResponse) => any;
6241
- }
6242
- export interface ListUsersRequest {
6243
- /**
6244
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6245
- */
6246
- InstanceId: string | undefined;
6247
- /**
6248
- * <p>The token for the next set of results. Use the value returned in the previous
6249
- * response in the next request to retrieve the next set of results.</p>
6250
- */
6251
- NextToken?: string;
6252
- /**
6253
- * <p>The maximum number of results to return per page.</p>
6254
- */
6255
- MaxResults?: number;
6256
- }
6257
- export declare namespace ListUsersRequest {
6258
- /**
6259
- * @internal
6260
- */
6261
- const filterSensitiveLog: (obj: ListUsersRequest) => any;
6262
- }
6263
- /**
6264
- * <p>Contains summary information about a user.</p>
6265
- */
6266
- export interface UserSummary {
6267
- /**
6268
- * <p>The identifier of the user account.</p>
6269
- */
6270
- Id?: string;
6271
- /**
6272
- * <p>The Amazon Resource Name (ARN) of the user account.</p>
6273
- */
6274
- Arn?: string;
6275
- /**
6276
- * <p>The Amazon Connect user name of the user account.</p>
6277
- */
6278
- Username?: string;
6279
- }
6280
- export declare namespace UserSummary {
6281
- /**
6282
- * @internal
6283
- */
6284
- const filterSensitiveLog: (obj: UserSummary) => any;
6285
- }
6286
- export interface ListUsersResponse {
6287
- /**
6288
- * <p>Information about the users.</p>
6289
- */
6290
- UserSummaryList?: UserSummary[];
6291
- /**
6292
- * <p>If there are additional results, this is the token for the next set of results.</p>
6293
- */
6294
- NextToken?: string;
6295
- }
6296
- export declare namespace ListUsersResponse {
6297
- /**
6298
- * @internal
6299
- */
6300
- const filterSensitiveLog: (obj: ListUsersResponse) => any;
6301
- }
6302
- export interface PutUserStatusRequest {
6303
- /**
6304
- * <p>The identifier of the user.</p>
6305
- */
6306
- UserId: string | undefined;
6307
- /**
6308
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6309
- */
6310
- InstanceId: string | undefined;
6311
- /**
6312
- * <p>The identifier of the agent status.</p>
6313
- */
6314
- AgentStatusId: string | undefined;
6315
- }
6316
- export declare namespace PutUserStatusRequest {
6317
- /**
6318
- * @internal
6319
- */
6320
- const filterSensitiveLog: (obj: PutUserStatusRequest) => any;
6321
- }
6322
- export interface PutUserStatusResponse {
6323
- }
6324
- export declare namespace PutUserStatusResponse {
6325
- /**
6326
- * @internal
6327
- */
6328
- const filterSensitiveLog: (obj: PutUserStatusResponse) => any;
6329
- }
6330
- export interface ReleasePhoneNumberRequest {
6331
- /**
6332
- * <p>A unique identifier for the phone number.</p>
6333
- */
6334
- PhoneNumberId: string | undefined;
6335
- /**
6336
- * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
6337
- * request.</p>
6338
- */
6339
- ClientToken?: string;
6340
- }
6341
- export declare namespace ReleasePhoneNumberRequest {
6342
- /**
6343
- * @internal
6344
- */
6345
- const filterSensitiveLog: (obj: ReleasePhoneNumberRequest) => any;
6346
- }
6347
- export interface ResumeContactRecordingRequest {
6348
- /**
6349
- * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
6350
- */
6351
- InstanceId: string | undefined;
6352
- /**
6353
- * <p>The identifier of the contact.</p>
6354
- */
6355
- ContactId: string | undefined;
6356
- /**
6357
- * <p>The identifier of the contact. This is the identifier of the contact associated with the
6358
- * first interaction with the contact center.</p>
6359
- */
6360
- InitialContactId: string | undefined;
6361
- }
6362
- export declare namespace ResumeContactRecordingRequest {
6363
- /**
6364
- * @internal
6365
- */
6366
- const filterSensitiveLog: (obj: ResumeContactRecordingRequest) => any;
6367
- }
6368
- export interface ResumeContactRecordingResponse {
6369
- }
6370
- export declare namespace ResumeContactRecordingResponse {
6371
- /**
6372
- * @internal
6373
- */
6374
- const filterSensitiveLog: (obj: ResumeContactRecordingResponse) => any;
6375
- }