@aws-sdk/client-voice-id 3.35.0 → 3.38.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 (229) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/dist-cjs/VoiceID.js +0 -6
  3. package/dist-cjs/VoiceIDClient.js +0 -11
  4. package/dist-cjs/commands/CreateDomainCommand.js +0 -27
  5. package/dist-cjs/commands/DeleteDomainCommand.js +0 -25
  6. package/dist-cjs/commands/DeleteFraudsterCommand.js +0 -25
  7. package/dist-cjs/commands/DeleteSpeakerCommand.js +0 -25
  8. package/dist-cjs/commands/DescribeDomainCommand.js +0 -25
  9. package/dist-cjs/commands/DescribeFraudsterCommand.js +0 -25
  10. package/dist-cjs/commands/DescribeFraudsterRegistrationJobCommand.js +0 -25
  11. package/dist-cjs/commands/DescribeSpeakerCommand.js +0 -25
  12. package/dist-cjs/commands/DescribeSpeakerEnrollmentJobCommand.js +0 -25
  13. package/dist-cjs/commands/EvaluateSessionCommand.js +0 -26
  14. package/dist-cjs/commands/ListDomainsCommand.js +0 -26
  15. package/dist-cjs/commands/ListFraudsterRegistrationJobsCommand.js +0 -28
  16. package/dist-cjs/commands/ListSpeakerEnrollmentJobsCommand.js +0 -27
  17. package/dist-cjs/commands/ListSpeakersCommand.js +0 -25
  18. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -25
  19. package/dist-cjs/commands/OptOutSpeakerCommand.js +0 -29
  20. package/dist-cjs/commands/StartFraudsterRegistrationJobCommand.js +0 -25
  21. package/dist-cjs/commands/StartSpeakerEnrollmentJobCommand.js +0 -25
  22. package/dist-cjs/commands/TagResourceCommand.js +0 -25
  23. package/dist-cjs/commands/UntagResourceCommand.js +0 -25
  24. package/dist-cjs/commands/UpdateDomainCommand.js +0 -26
  25. package/dist-cjs/commands/index.js +24 -0
  26. package/dist-cjs/endpoints.js +1 -2
  27. package/dist-cjs/index.js +4 -29
  28. package/dist-cjs/models/index.js +0 -1
  29. package/dist-cjs/models/models_0.js +0 -211
  30. package/dist-cjs/pagination/Interfaces.js +0 -1
  31. package/dist-cjs/pagination/ListDomainsPaginator.js +0 -11
  32. package/dist-cjs/pagination/ListFraudsterRegistrationJobsPaginator.js +0 -11
  33. package/dist-cjs/pagination/ListSpeakerEnrollmentJobsPaginator.js +0 -11
  34. package/dist-cjs/pagination/ListSpeakersPaginator.js +0 -11
  35. package/dist-cjs/pagination/index.js +8 -0
  36. package/dist-cjs/protocols/Aws_json1_0.js +0 -6
  37. package/dist-cjs/runtimeConfig.browser.js +1 -6
  38. package/dist-cjs/runtimeConfig.js +2 -7
  39. package/dist-cjs/runtimeConfig.native.js +0 -4
  40. package/dist-cjs/runtimeConfig.shared.js +0 -4
  41. package/dist-es/VoiceID.js +0 -1
  42. package/dist-es/VoiceIDClient.js +0 -1
  43. package/dist-es/commands/CreateDomainCommand.js +0 -1
  44. package/dist-es/commands/DeleteDomainCommand.js +0 -1
  45. package/dist-es/commands/DeleteFraudsterCommand.js +0 -1
  46. package/dist-es/commands/DeleteSpeakerCommand.js +0 -1
  47. package/dist-es/commands/DescribeDomainCommand.js +0 -1
  48. package/dist-es/commands/DescribeFraudsterCommand.js +0 -1
  49. package/dist-es/commands/DescribeFraudsterRegistrationJobCommand.js +0 -1
  50. package/dist-es/commands/DescribeSpeakerCommand.js +0 -1
  51. package/dist-es/commands/DescribeSpeakerEnrollmentJobCommand.js +0 -1
  52. package/dist-es/commands/EvaluateSessionCommand.js +0 -1
  53. package/dist-es/commands/ListDomainsCommand.js +0 -1
  54. package/dist-es/commands/ListFraudsterRegistrationJobsCommand.js +0 -1
  55. package/dist-es/commands/ListSpeakerEnrollmentJobsCommand.js +0 -1
  56. package/dist-es/commands/ListSpeakersCommand.js +0 -1
  57. package/dist-es/commands/ListTagsForResourceCommand.js +0 -1
  58. package/dist-es/commands/OptOutSpeakerCommand.js +0 -1
  59. package/dist-es/commands/StartFraudsterRegistrationJobCommand.js +0 -1
  60. package/dist-es/commands/StartSpeakerEnrollmentJobCommand.js +0 -1
  61. package/dist-es/commands/TagResourceCommand.js +0 -1
  62. package/dist-es/commands/UntagResourceCommand.js +0 -1
  63. package/dist-es/commands/UpdateDomainCommand.js +0 -1
  64. package/dist-es/commands/index.js +21 -0
  65. package/dist-es/endpoints.js +1 -2
  66. package/dist-es/index.js +4 -29
  67. package/dist-es/models/index.js +0 -1
  68. package/dist-es/models/models_0.js +0 -1
  69. package/dist-es/pagination/Interfaces.js +0 -1
  70. package/dist-es/pagination/ListDomainsPaginator.js +0 -1
  71. package/dist-es/pagination/ListFraudsterRegistrationJobsPaginator.js +0 -1
  72. package/dist-es/pagination/ListSpeakerEnrollmentJobsPaginator.js +0 -1
  73. package/dist-es/pagination/ListSpeakersPaginator.js +0 -1
  74. package/dist-es/pagination/index.js +5 -0
  75. package/dist-es/protocols/Aws_json1_0.js +0 -1
  76. package/dist-es/runtimeConfig.browser.js +1 -2
  77. package/dist-es/runtimeConfig.js +2 -3
  78. package/dist-es/runtimeConfig.native.js +0 -1
  79. package/dist-es/runtimeConfig.shared.js +0 -1
  80. package/dist-types/commands/index.d.ts +21 -0
  81. package/dist-types/index.d.ts +4 -28
  82. package/dist-types/pagination/index.d.ts +5 -0
  83. package/dist-types/ts3.4/VoiceID.d.ts +22 -82
  84. package/dist-types/ts3.4/VoiceIDClient.d.ts +24 -91
  85. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +2 -22
  86. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +2 -20
  87. package/dist-types/ts3.4/commands/DeleteFraudsterCommand.d.ts +2 -20
  88. package/dist-types/ts3.4/commands/DeleteSpeakerCommand.d.ts +2 -20
  89. package/dist-types/ts3.4/commands/DescribeDomainCommand.d.ts +2 -20
  90. package/dist-types/ts3.4/commands/DescribeFraudsterCommand.d.ts +2 -20
  91. package/dist-types/ts3.4/commands/DescribeFraudsterRegistrationJobCommand.d.ts +2 -20
  92. package/dist-types/ts3.4/commands/DescribeSpeakerCommand.d.ts +2 -20
  93. package/dist-types/ts3.4/commands/DescribeSpeakerEnrollmentJobCommand.d.ts +2 -20
  94. package/dist-types/ts3.4/commands/EvaluateSessionCommand.d.ts +2 -21
  95. package/dist-types/ts3.4/commands/ListDomainsCommand.d.ts +2 -21
  96. package/dist-types/ts3.4/commands/ListFraudsterRegistrationJobsCommand.d.ts +2 -23
  97. package/dist-types/ts3.4/commands/ListSpeakerEnrollmentJobsCommand.d.ts +2 -22
  98. package/dist-types/ts3.4/commands/ListSpeakersCommand.d.ts +2 -20
  99. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  100. package/dist-types/ts3.4/commands/OptOutSpeakerCommand.d.ts +2 -24
  101. package/dist-types/ts3.4/commands/StartFraudsterRegistrationJobCommand.d.ts +2 -20
  102. package/dist-types/ts3.4/commands/StartSpeakerEnrollmentJobCommand.d.ts +2 -20
  103. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  104. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  105. package/dist-types/ts3.4/commands/UpdateDomainCommand.d.ts +2 -21
  106. package/dist-types/ts3.4/commands/index.d.ts +21 -0
  107. package/dist-types/ts3.4/index.d.ts +4 -28
  108. package/dist-types/ts3.4/models/models_0.d.ts +293 -1041
  109. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  110. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  111. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  112. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  113. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  114. package/package.json +33 -30
  115. package/dist-cjs/VoiceID.js.map +0 -1
  116. package/dist-cjs/VoiceIDClient.js.map +0 -1
  117. package/dist-cjs/commands/CreateDomainCommand.js.map +0 -1
  118. package/dist-cjs/commands/DeleteDomainCommand.js.map +0 -1
  119. package/dist-cjs/commands/DeleteFraudsterCommand.js.map +0 -1
  120. package/dist-cjs/commands/DeleteSpeakerCommand.js.map +0 -1
  121. package/dist-cjs/commands/DescribeDomainCommand.js.map +0 -1
  122. package/dist-cjs/commands/DescribeFraudsterCommand.js.map +0 -1
  123. package/dist-cjs/commands/DescribeFraudsterRegistrationJobCommand.js.map +0 -1
  124. package/dist-cjs/commands/DescribeSpeakerCommand.js.map +0 -1
  125. package/dist-cjs/commands/DescribeSpeakerEnrollmentJobCommand.js.map +0 -1
  126. package/dist-cjs/commands/EvaluateSessionCommand.js.map +0 -1
  127. package/dist-cjs/commands/ListDomainsCommand.js.map +0 -1
  128. package/dist-cjs/commands/ListFraudsterRegistrationJobsCommand.js.map +0 -1
  129. package/dist-cjs/commands/ListSpeakerEnrollmentJobsCommand.js.map +0 -1
  130. package/dist-cjs/commands/ListSpeakersCommand.js.map +0 -1
  131. package/dist-cjs/commands/ListTagsForResourceCommand.js.map +0 -1
  132. package/dist-cjs/commands/OptOutSpeakerCommand.js.map +0 -1
  133. package/dist-cjs/commands/StartFraudsterRegistrationJobCommand.js.map +0 -1
  134. package/dist-cjs/commands/StartSpeakerEnrollmentJobCommand.js.map +0 -1
  135. package/dist-cjs/commands/TagResourceCommand.js.map +0 -1
  136. package/dist-cjs/commands/UntagResourceCommand.js.map +0 -1
  137. package/dist-cjs/commands/UpdateDomainCommand.js.map +0 -1
  138. package/dist-cjs/endpoints.js.map +0 -1
  139. package/dist-cjs/index.js.map +0 -1
  140. package/dist-cjs/models/index.js.map +0 -1
  141. package/dist-cjs/models/models_0.js.map +0 -1
  142. package/dist-cjs/pagination/Interfaces.js.map +0 -1
  143. package/dist-cjs/pagination/ListDomainsPaginator.js.map +0 -1
  144. package/dist-cjs/pagination/ListFraudsterRegistrationJobsPaginator.js.map +0 -1
  145. package/dist-cjs/pagination/ListSpeakerEnrollmentJobsPaginator.js.map +0 -1
  146. package/dist-cjs/pagination/ListSpeakersPaginator.js.map +0 -1
  147. package/dist-cjs/protocols/Aws_json1_0.js.map +0 -1
  148. package/dist-cjs/runtimeConfig.browser.js.map +0 -1
  149. package/dist-cjs/runtimeConfig.js.map +0 -1
  150. package/dist-cjs/runtimeConfig.native.js.map +0 -1
  151. package/dist-cjs/runtimeConfig.shared.js.map +0 -1
  152. package/dist-es/VoiceID.js.map +0 -1
  153. package/dist-es/VoiceIDClient.js.map +0 -1
  154. package/dist-es/commands/CreateDomainCommand.js.map +0 -1
  155. package/dist-es/commands/DeleteDomainCommand.js.map +0 -1
  156. package/dist-es/commands/DeleteFraudsterCommand.js.map +0 -1
  157. package/dist-es/commands/DeleteSpeakerCommand.js.map +0 -1
  158. package/dist-es/commands/DescribeDomainCommand.js.map +0 -1
  159. package/dist-es/commands/DescribeFraudsterCommand.js.map +0 -1
  160. package/dist-es/commands/DescribeFraudsterRegistrationJobCommand.js.map +0 -1
  161. package/dist-es/commands/DescribeSpeakerCommand.js.map +0 -1
  162. package/dist-es/commands/DescribeSpeakerEnrollmentJobCommand.js.map +0 -1
  163. package/dist-es/commands/EvaluateSessionCommand.js.map +0 -1
  164. package/dist-es/commands/ListDomainsCommand.js.map +0 -1
  165. package/dist-es/commands/ListFraudsterRegistrationJobsCommand.js.map +0 -1
  166. package/dist-es/commands/ListSpeakerEnrollmentJobsCommand.js.map +0 -1
  167. package/dist-es/commands/ListSpeakersCommand.js.map +0 -1
  168. package/dist-es/commands/ListTagsForResourceCommand.js.map +0 -1
  169. package/dist-es/commands/OptOutSpeakerCommand.js.map +0 -1
  170. package/dist-es/commands/StartFraudsterRegistrationJobCommand.js.map +0 -1
  171. package/dist-es/commands/StartSpeakerEnrollmentJobCommand.js.map +0 -1
  172. package/dist-es/commands/TagResourceCommand.js.map +0 -1
  173. package/dist-es/commands/UntagResourceCommand.js.map +0 -1
  174. package/dist-es/commands/UpdateDomainCommand.js.map +0 -1
  175. package/dist-es/endpoints.js.map +0 -1
  176. package/dist-es/index.js.map +0 -1
  177. package/dist-es/models/index.js.map +0 -1
  178. package/dist-es/models/models_0.js.map +0 -1
  179. package/dist-es/pagination/Interfaces.js.map +0 -1
  180. package/dist-es/pagination/ListDomainsPaginator.js.map +0 -1
  181. package/dist-es/pagination/ListFraudsterRegistrationJobsPaginator.js.map +0 -1
  182. package/dist-es/pagination/ListSpeakerEnrollmentJobsPaginator.js.map +0 -1
  183. package/dist-es/pagination/ListSpeakersPaginator.js.map +0 -1
  184. package/dist-es/protocols/Aws_json1_0.js.map +0 -1
  185. package/dist-es/runtimeConfig.browser.js.map +0 -1
  186. package/dist-es/runtimeConfig.js.map +0 -1
  187. package/dist-es/runtimeConfig.native.js.map +0 -1
  188. package/dist-es/runtimeConfig.shared.js.map +0 -1
  189. package/jest.config.js +0 -4
  190. package/src/VoiceID.ts +0 -769
  191. package/src/VoiceIDClient.ts +0 -322
  192. package/src/commands/CreateDomainCommand.ts +0 -97
  193. package/src/commands/DeleteDomainCommand.ts +0 -95
  194. package/src/commands/DeleteFraudsterCommand.ts +0 -95
  195. package/src/commands/DeleteSpeakerCommand.ts +0 -95
  196. package/src/commands/DescribeDomainCommand.ts +0 -95
  197. package/src/commands/DescribeFraudsterCommand.ts +0 -95
  198. package/src/commands/DescribeFraudsterRegistrationJobCommand.ts +0 -103
  199. package/src/commands/DescribeSpeakerCommand.ts +0 -95
  200. package/src/commands/DescribeSpeakerEnrollmentJobCommand.ts +0 -100
  201. package/src/commands/EvaluateSessionCommand.ts +0 -96
  202. package/src/commands/ListDomainsCommand.ts +0 -96
  203. package/src/commands/ListFraudsterRegistrationJobsCommand.ts +0 -103
  204. package/src/commands/ListSpeakerEnrollmentJobsCommand.ts +0 -100
  205. package/src/commands/ListSpeakersCommand.ts +0 -95
  206. package/src/commands/ListTagsForResourceCommand.ts +0 -95
  207. package/src/commands/OptOutSpeakerCommand.ts +0 -99
  208. package/src/commands/StartFraudsterRegistrationJobCommand.ts +0 -100
  209. package/src/commands/StartSpeakerEnrollmentJobCommand.ts +0 -98
  210. package/src/commands/TagResourceCommand.ts +0 -95
  211. package/src/commands/UntagResourceCommand.ts +0 -95
  212. package/src/commands/UpdateDomainCommand.ts +0 -96
  213. package/src/endpoints.ts +0 -57
  214. package/src/index.ts +0 -29
  215. package/src/models/index.ts +0 -1
  216. package/src/models/models_0.ts +0 -2153
  217. package/src/pagination/Interfaces.ts +0 -8
  218. package/src/pagination/ListDomainsPaginator.ts +0 -55
  219. package/src/pagination/ListFraudsterRegistrationJobsPaginator.ts +0 -59
  220. package/src/pagination/ListSpeakerEnrollmentJobsPaginator.ts +0 -59
  221. package/src/pagination/ListSpeakersPaginator.ts +0 -59
  222. package/src/protocols/Aws_json1_0.ts +0 -3488
  223. package/src/runtimeConfig.browser.ts +0 -41
  224. package/src/runtimeConfig.native.ts +0 -17
  225. package/src/runtimeConfig.shared.ts +0 -17
  226. package/src/runtimeConfig.ts +0 -46
  227. package/tsconfig.es.json +0 -10
  228. package/tsconfig.json +0 -33
  229. package/tsconfig.types.json +0 -9
@@ -1,2153 +0,0 @@
1
- import { SENSITIVE_STRING } from "@aws-sdk/smithy-client";
2
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
3
-
4
- /**
5
- * <p>You do not have sufficient permissions to perform this action. Check the error message and try
6
- * again.</p>
7
- */
8
- export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
9
- name: "AccessDeniedException";
10
- $fault: "client";
11
- Message?: string;
12
- }
13
-
14
- export namespace AccessDeniedException {
15
- /**
16
- * @internal
17
- */
18
- export const filterSensitiveLog = (obj: AccessDeniedException): any => ({
19
- ...obj,
20
- });
21
- }
22
-
23
- /**
24
- * <p>The configuration used to authenticate a speaker during a session.</p>
25
- */
26
- export interface AuthenticationConfiguration {
27
- /**
28
- * <p>The minimum threshold needed to successfully authenticate a speaker.</p>
29
- */
30
- AcceptanceThreshold: number | undefined;
31
- }
32
-
33
- export namespace AuthenticationConfiguration {
34
- /**
35
- * @internal
36
- */
37
- export const filterSensitiveLog = (obj: AuthenticationConfiguration): any => ({
38
- ...obj,
39
- });
40
- }
41
-
42
- export enum AuthenticationDecision {
43
- ACCEPT = "ACCEPT",
44
- NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH",
45
- REJECT = "REJECT",
46
- SPEAKER_ID_NOT_PROVIDED = "SPEAKER_ID_NOT_PROVIDED",
47
- SPEAKER_NOT_ENROLLED = "SPEAKER_NOT_ENROLLED",
48
- SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT",
49
- }
50
-
51
- /**
52
- * <p>The authentication result produced by Voice ID, processed against the current session state and streamed
53
- * audio of the speaker.</p>
54
- */
55
- export interface AuthenticationResult {
56
- /**
57
- * <p>The unique identifier for this authentication result. Because there can be multiple authentications
58
- * for a given session, this field helps to identify if the returned result is from a previous streaming
59
- * activity or a new result. Note that in absence of any new streaming activity,
60
- * <code>AcceptanceThreshold</code> changes, or <code>SpeakerId</code> changes, Voice ID
61
- * always returns cached Authentication Result for this API.</p>
62
- */
63
- AuthenticationResultId?: string;
64
-
65
- /**
66
- * <p>A timestamp indicating when audio aggregation started for this authentication result.</p>
67
- */
68
- AudioAggregationStartedAt?: Date;
69
-
70
- /**
71
- * <p>A timestamp indicating when audio aggregation ended for this authentication result.</p>
72
- */
73
- AudioAggregationEndedAt?: Date;
74
-
75
- /**
76
- * <p>The client-provided identifier for the speaker whose authentication result is produced. Only present if a
77
- * <code>SpeakerId</code> is provided for the session.</p>
78
- */
79
- CustomerSpeakerId?: string;
80
-
81
- /**
82
- * <p>The service-generated identifier for the speaker whose authentication result is produced.</p>
83
- */
84
- GeneratedSpeakerId?: string;
85
-
86
- /**
87
- * <p>The authentication decision produced by Voice ID, processed against the current session state and streamed
88
- * audio of the speaker.</p>
89
- */
90
- Decision?: AuthenticationDecision | string;
91
-
92
- /**
93
- * <p>The authentication score for the speaker whose authentication result is produced. This value is
94
- * only present if the authentication decision is either <code>ACCEPT</code> or <code>REJECT</code>.</p>
95
- */
96
- Score?: number;
97
-
98
- /**
99
- * <p>The <code>AuthenticationConfiguration</code> used to generate this authentication result.</p>
100
- */
101
- Configuration?: AuthenticationConfiguration;
102
- }
103
-
104
- export namespace AuthenticationResult {
105
- /**
106
- * @internal
107
- */
108
- export const filterSensitiveLog = (obj: AuthenticationResult): any => ({
109
- ...obj,
110
- ...(obj.CustomerSpeakerId && { CustomerSpeakerId: SENSITIVE_STRING }),
111
- });
112
- }
113
-
114
- export enum ConflictType {
115
- ANOTHER_ACTIVE_STREAM = "ANOTHER_ACTIVE_STREAM",
116
- CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT",
117
- CONCURRENT_CHANGES = "CONCURRENT_CHANGES",
118
- DOMAIN_NOT_ACTIVE = "DOMAIN_NOT_ACTIVE",
119
- ENROLLMENT_ALREADY_EXISTS = "ENROLLMENT_ALREADY_EXISTS",
120
- SPEAKER_NOT_SET = "SPEAKER_NOT_SET",
121
- SPEAKER_OPTED_OUT = "SPEAKER_OPTED_OUT",
122
- }
123
-
124
- /**
125
- * <p>The request failed due to a conflict. Check the <code>ConflictType</code> and error message for
126
- * more details.</p>
127
- */
128
- export interface ConflictException extends __SmithyException, $MetadataBearer {
129
- name: "ConflictException";
130
- $fault: "client";
131
- Message?: string;
132
- /**
133
- * <p>The type of conflict which caused a ConflictException. Possible types and the corresponding error messages
134
- * are as follows:</p>
135
- * <ul>
136
- * <li>
137
- * <p>
138
- * <code>DOMAIN_NOT_ACTIVE</code>: The domain is not active.</p>
139
- * </li>
140
- * <li>
141
- * <p>
142
- * <code>CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT</code>: You cannot change the speaker ID after an enrollment has been requested.</p>
143
- * </li>
144
- * <li>
145
- * <p>
146
- * <code>ENROLLMENT_ALREADY_EXISTS</code>: There is already an enrollment for this session.</p>
147
- * </li>
148
- * <li>
149
- * <p>
150
- * <code>SPEAKER_NOT_SET</code>: You must set the speaker ID before requesting an enrollment.</p>
151
- * </li>
152
- * <li>
153
- * <p>
154
- * <code>SPEAKER_OPTED_OUT</code>: You cannot request an enrollment for an opted out speaker.</p>
155
- * </li>
156
- * <li>
157
- * <p>
158
- * <code>CONCURRENT_CHANGES</code>: The request could not be processed as the resource was modified by another request during execution.</p>
159
- * </li>
160
- * </ul>
161
- */
162
- ConflictType?: ConflictType | string;
163
- }
164
-
165
- export namespace ConflictException {
166
- /**
167
- * @internal
168
- */
169
- export const filterSensitiveLog = (obj: ConflictException): any => ({
170
- ...obj,
171
- });
172
- }
173
-
174
- /**
175
- * <p>The configuration containing information about the customer-managed KMS Key used for encrypting
176
- * customer data.</p>
177
- */
178
- export interface ServerSideEncryptionConfiguration {
179
- /**
180
- * <p>The identifier of the KMS Key you want Voice ID to use to encrypt your data.</p>
181
- */
182
- KmsKeyId: string | undefined;
183
- }
184
-
185
- export namespace ServerSideEncryptionConfiguration {
186
- /**
187
- * @internal
188
- */
189
- export const filterSensitiveLog = (obj: ServerSideEncryptionConfiguration): any => ({
190
- ...obj,
191
- });
192
- }
193
-
194
- /**
195
- * <p>A tag that can be assigned to a Voice ID resource.</p>
196
- */
197
- export interface Tag {
198
- /**
199
- * <p>The first part of a key:value pair that forms a tag associated with a given resource. For example,
200
- * in the tag ‘Department’:’Sales’, the key is 'Department'.
201
- * </p>
202
- */
203
- Key: string | undefined;
204
-
205
- /**
206
- * <p>The second part of a key:value pair that forms a tag associated with a given resource. For example,
207
- * in the tag ‘Department’:’Sales’, the value is 'Sales'.
208
- * </p>
209
- */
210
- Value: string | undefined;
211
- }
212
-
213
- export namespace Tag {
214
- /**
215
- * @internal
216
- */
217
- export const filterSensitiveLog = (obj: Tag): any => ({
218
- ...obj,
219
- ...(obj.Key && { Key: SENSITIVE_STRING }),
220
- ...(obj.Value && { Value: SENSITIVE_STRING }),
221
- });
222
- }
223
-
224
- export interface CreateDomainRequest {
225
- /**
226
- * <p>The name of the domain.</p>
227
- */
228
- Name: string | undefined;
229
-
230
- /**
231
- * <p>A brief description of this domain.</p>
232
- */
233
- Description?: string;
234
-
235
- /**
236
- * <p>The configuration, containing the KMS Key Identifier, to be used by Voice ID for
237
- * the server-side encryption of your data. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid">
238
- * Amazon Connect VoiceID encryption at rest</a> for more details on how the KMS Key is used.
239
- * </p>
240
- */
241
- ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
242
-
243
- /**
244
- * <p>The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates
245
- * this field.</p>
246
- */
247
- ClientToken?: string;
248
-
249
- /**
250
- * <p>A list of tags you want added to the domain.</p>
251
- */
252
- Tags?: Tag[];
253
- }
254
-
255
- export namespace CreateDomainRequest {
256
- /**
257
- * @internal
258
- */
259
- export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({
260
- ...obj,
261
- ...(obj.Name && { Name: SENSITIVE_STRING }),
262
- ...(obj.Description && { Description: SENSITIVE_STRING }),
263
- ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }),
264
- });
265
- }
266
-
267
- export enum DomainStatus {
268
- ACTIVE = "ACTIVE",
269
- PENDING = "PENDING",
270
- SUSPENDED = "SUSPENDED",
271
- }
272
-
273
- /**
274
- * <p>Contains all the information about a domain.</p>
275
- */
276
- export interface Domain {
277
- /**
278
- * <p>The service-generated identifier for the domain.</p>
279
- */
280
- DomainId?: string;
281
-
282
- /**
283
- * <p>The Amazon Resource Name (ARN) for the domain.</p>
284
- */
285
- Arn?: string;
286
-
287
- /**
288
- * <p>The client-provided name for the domain.</p>
289
- */
290
- Name?: string;
291
-
292
- /**
293
- * <p>The client-provided description of the domain.</p>
294
- */
295
- Description?: string;
296
-
297
- /**
298
- * <p>The current status of the domain.</p>
299
- */
300
- DomainStatus?: DomainStatus | string;
301
-
302
- /**
303
- * <p>The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use
304
- * to encrypt your data.</p>
305
- */
306
- ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
307
-
308
- /**
309
- * <p>The timestamp at which the domain is created.</p>
310
- */
311
- CreatedAt?: Date;
312
-
313
- /**
314
- * <p>The timestamp showing the domain's last update.</p>
315
- */
316
- UpdatedAt?: Date;
317
- }
318
-
319
- export namespace Domain {
320
- /**
321
- * @internal
322
- */
323
- export const filterSensitiveLog = (obj: Domain): any => ({
324
- ...obj,
325
- ...(obj.Name && { Name: SENSITIVE_STRING }),
326
- ...(obj.Description && { Description: SENSITIVE_STRING }),
327
- });
328
- }
329
-
330
- export interface CreateDomainResponse {
331
- /**
332
- * <p>Information about the newly created domain.</p>
333
- */
334
- Domain?: Domain;
335
- }
336
-
337
- export namespace CreateDomainResponse {
338
- /**
339
- * @internal
340
- */
341
- export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({
342
- ...obj,
343
- ...(obj.Domain && { Domain: Domain.filterSensitiveLog(obj.Domain) }),
344
- });
345
- }
346
-
347
- /**
348
- * <p>The request failed due to an unknown error on the server side.</p>
349
- */
350
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
351
- name: "InternalServerException";
352
- $fault: "server";
353
- Message?: string;
354
- }
355
-
356
- export namespace InternalServerException {
357
- /**
358
- * @internal
359
- */
360
- export const filterSensitiveLog = (obj: InternalServerException): any => ({
361
- ...obj,
362
- });
363
- }
364
-
365
- export enum ResourceType {
366
- BATCH_JOB = "BATCH_JOB",
367
- COMPLIANCE_CONSENT = "COMPLIANCE_CONSENT",
368
- DOMAIN = "DOMAIN",
369
- FRAUDSTER = "FRAUDSTER",
370
- SESSION = "SESSION",
371
- SPEAKER = "SPEAKER",
372
- }
373
-
374
- /**
375
- * <p>The specified resource cannot be found. Check the <code>ResourceType</code> and error message for
376
- * more details.</p>
377
- */
378
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
379
- name: "ResourceNotFoundException";
380
- $fault: "client";
381
- Message?: string;
382
- /**
383
- * <p>The type of resource which cannot not be found. Possible types are <code>BATCH_JOB</code>, <code>COMPLIANCE_CONSENT</code>,
384
- * <code>DOMAIN</code>, <code>FRAUDSTER</code>, <code>SESSION</code> and <code>SPEAKER</code>.</p>
385
- */
386
- ResourceType?: ResourceType | string;
387
- }
388
-
389
- export namespace ResourceNotFoundException {
390
- /**
391
- * @internal
392
- */
393
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
394
- ...obj,
395
- });
396
- }
397
-
398
- /**
399
- * <p>The request exceeded the service quota. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas">Voice ID Service
400
- * Quotas</a> and try your request again.</p>
401
- */
402
- export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
403
- name: "ServiceQuotaExceededException";
404
- $fault: "client";
405
- Message?: string;
406
- }
407
-
408
- export namespace ServiceQuotaExceededException {
409
- /**
410
- * @internal
411
- */
412
- export const filterSensitiveLog = (obj: ServiceQuotaExceededException): any => ({
413
- ...obj,
414
- });
415
- }
416
-
417
- /**
418
- * <p>The request was denied due to request throttling. Please slow down your request rate. Refer to
419
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas">
420
- * Amazon Connect Voice ID Service API throttling quotas
421
- * </a> and try your request again.</p>
422
- */
423
- export interface ThrottlingException extends __SmithyException, $MetadataBearer {
424
- name: "ThrottlingException";
425
- $fault: "client";
426
- Message?: string;
427
- }
428
-
429
- export namespace ThrottlingException {
430
- /**
431
- * @internal
432
- */
433
- export const filterSensitiveLog = (obj: ThrottlingException): any => ({
434
- ...obj,
435
- });
436
- }
437
-
438
- /**
439
- * <p>The request failed one or more validations; check the error message for more details.</p>
440
- */
441
- export interface ValidationException extends __SmithyException, $MetadataBearer {
442
- name: "ValidationException";
443
- $fault: "client";
444
- Message?: string;
445
- }
446
-
447
- export namespace ValidationException {
448
- /**
449
- * @internal
450
- */
451
- export const filterSensitiveLog = (obj: ValidationException): any => ({
452
- ...obj,
453
- });
454
- }
455
-
456
- export interface DeleteDomainRequest {
457
- /**
458
- * <p>The identifier of the domain you want to delete.</p>
459
- */
460
- DomainId: string | undefined;
461
- }
462
-
463
- export namespace DeleteDomainRequest {
464
- /**
465
- * @internal
466
- */
467
- export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({
468
- ...obj,
469
- });
470
- }
471
-
472
- export interface DeleteFraudsterRequest {
473
- /**
474
- * <p>The identifier of the domain containing the fraudster.</p>
475
- */
476
- DomainId: string | undefined;
477
-
478
- /**
479
- * <p>The identifier of the fraudster you want to delete.</p>
480
- */
481
- FraudsterId: string | undefined;
482
- }
483
-
484
- export namespace DeleteFraudsterRequest {
485
- /**
486
- * @internal
487
- */
488
- export const filterSensitiveLog = (obj: DeleteFraudsterRequest): any => ({
489
- ...obj,
490
- ...(obj.FraudsterId && { FraudsterId: SENSITIVE_STRING }),
491
- });
492
- }
493
-
494
- export interface DeleteSpeakerRequest {
495
- /**
496
- * <p>The identifier of the domain containing the speaker.</p>
497
- */
498
- DomainId: string | undefined;
499
-
500
- /**
501
- * <p>The identifier of the speaker you want to delete.</p>
502
- */
503
- SpeakerId: string | undefined;
504
- }
505
-
506
- export namespace DeleteSpeakerRequest {
507
- /**
508
- * @internal
509
- */
510
- export const filterSensitiveLog = (obj: DeleteSpeakerRequest): any => ({
511
- ...obj,
512
- ...(obj.SpeakerId && { SpeakerId: SENSITIVE_STRING }),
513
- });
514
- }
515
-
516
- export interface DescribeDomainRequest {
517
- /**
518
- * <p>The identifier of the domain you are describing.</p>
519
- */
520
- DomainId: string | undefined;
521
- }
522
-
523
- export namespace DescribeDomainRequest {
524
- /**
525
- * @internal
526
- */
527
- export const filterSensitiveLog = (obj: DescribeDomainRequest): any => ({
528
- ...obj,
529
- });
530
- }
531
-
532
- export interface DescribeDomainResponse {
533
- /**
534
- * <p>Information about the specified domain.</p>
535
- */
536
- Domain?: Domain;
537
- }
538
-
539
- export namespace DescribeDomainResponse {
540
- /**
541
- * @internal
542
- */
543
- export const filterSensitiveLog = (obj: DescribeDomainResponse): any => ({
544
- ...obj,
545
- ...(obj.Domain && { Domain: Domain.filterSensitiveLog(obj.Domain) }),
546
- });
547
- }
548
-
549
- export interface DescribeFraudsterRequest {
550
- /**
551
- * <p>The identifier of the domain containing the fraudster.</p>
552
- */
553
- DomainId: string | undefined;
554
-
555
- /**
556
- * <p>The identifier of the fraudster you are describing.</p>
557
- */
558
- FraudsterId: string | undefined;
559
- }
560
-
561
- export namespace DescribeFraudsterRequest {
562
- /**
563
- * @internal
564
- */
565
- export const filterSensitiveLog = (obj: DescribeFraudsterRequest): any => ({
566
- ...obj,
567
- ...(obj.FraudsterId && { FraudsterId: SENSITIVE_STRING }),
568
- });
569
- }
570
-
571
- /**
572
- * <p>Contains all the information about a fraudster.</p>
573
- */
574
- export interface Fraudster {
575
- /**
576
- * <p>The identifier for the domain containing the fraudster.</p>
577
- */
578
- DomainId?: string;
579
-
580
- /**
581
- * <p>The service-generated identifier for the fraudster.</p>
582
- */
583
- GeneratedFraudsterId?: string;
584
-
585
- /**
586
- * <p>The timestamp when Voice ID identified the fraudster.</p>
587
- */
588
- CreatedAt?: Date;
589
- }
590
-
591
- export namespace Fraudster {
592
- /**
593
- * @internal
594
- */
595
- export const filterSensitiveLog = (obj: Fraudster): any => ({
596
- ...obj,
597
- });
598
- }
599
-
600
- export interface DescribeFraudsterResponse {
601
- /**
602
- * <p>Information about the specified fraudster.</p>
603
- */
604
- Fraudster?: Fraudster;
605
- }
606
-
607
- export namespace DescribeFraudsterResponse {
608
- /**
609
- * @internal
610
- */
611
- export const filterSensitiveLog = (obj: DescribeFraudsterResponse): any => ({
612
- ...obj,
613
- });
614
- }
615
-
616
- export interface DescribeFraudsterRegistrationJobRequest {
617
- /**
618
- * <p>The identifier for the domain containing the fraudster registration job.</p>
619
- */
620
- DomainId: string | undefined;
621
-
622
- /**
623
- * <p>The identifier for the fraudster registration job you are describing.</p>
624
- */
625
- JobId: string | undefined;
626
- }
627
-
628
- export namespace DescribeFraudsterRegistrationJobRequest {
629
- /**
630
- * @internal
631
- */
632
- export const filterSensitiveLog = (obj: DescribeFraudsterRegistrationJobRequest): any => ({
633
- ...obj,
634
- });
635
- }
636
-
637
- /**
638
- * <p>Contains error details for a failed batch job.</p>
639
- */
640
- export interface FailureDetails {
641
- /**
642
- * <p>An HTTP status code representing the nature of the error.</p>
643
- */
644
- StatusCode?: number;
645
-
646
- /**
647
- * <p>A description of the error that caused the batch job failure.</p>
648
- */
649
- Message?: string;
650
- }
651
-
652
- export namespace FailureDetails {
653
- /**
654
- * @internal
655
- */
656
- export const filterSensitiveLog = (obj: FailureDetails): any => ({
657
- ...obj,
658
- });
659
- }
660
-
661
- /**
662
- * <p>The configuration containing input file information for a batch job.</p>
663
- */
664
- export interface InputDataConfig {
665
- /**
666
- * <p>The S3 location for the input manifest file that contains the list of individual enrollment or registration
667
- * job requests.</p>
668
- */
669
- S3Uri: string | undefined;
670
- }
671
-
672
- export namespace InputDataConfig {
673
- /**
674
- * @internal
675
- */
676
- export const filterSensitiveLog = (obj: InputDataConfig): any => ({
677
- ...obj,
678
- });
679
- }
680
-
681
- /**
682
- * <p>Indicates the completion progress for a batch job.</p>
683
- */
684
- export interface JobProgress {
685
- /**
686
- * <p>Shows the completed percentage of enrollment or registration requests listed in the input file.</p>
687
- */
688
- PercentComplete?: number;
689
- }
690
-
691
- export namespace JobProgress {
692
- /**
693
- * @internal
694
- */
695
- export const filterSensitiveLog = (obj: JobProgress): any => ({
696
- ...obj,
697
- });
698
- }
699
-
700
- export enum FraudsterRegistrationJobStatus {
701
- COMPLETED = "COMPLETED",
702
- COMPLETED_WITH_ERRORS = "COMPLETED_WITH_ERRORS",
703
- FAILED = "FAILED",
704
- IN_PROGRESS = "IN_PROGRESS",
705
- SUBMITTED = "SUBMITTED",
706
- }
707
-
708
- /**
709
- * <p>The configuration containing output file information for a batch job.</p>
710
- */
711
- export interface OutputDataConfig {
712
- /**
713
- * <p>The S3 path of the folder to which Voice ID writes the job output file, which has a
714
- * <code>*.out</code> extension. For example, if the input file name is <code>input-file.json</code> and
715
- * the output folder path is <code>s3://output-bucket/output-folder</code>, the full output file path is
716
- * <code>s3://output-bucket/output-folder/job-Id/input-file.json.out</code>.</p>
717
- */
718
- S3Uri: string | undefined;
719
-
720
- /**
721
- * <p>the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster
722
- * registration job.</p>
723
- */
724
- KmsKeyId?: string;
725
- }
726
-
727
- export namespace OutputDataConfig {
728
- /**
729
- * @internal
730
- */
731
- export const filterSensitiveLog = (obj: OutputDataConfig): any => ({
732
- ...obj,
733
- });
734
- }
735
-
736
- export enum DuplicateRegistrationAction {
737
- REGISTER_AS_NEW = "REGISTER_AS_NEW",
738
- SKIP = "SKIP",
739
- }
740
-
741
- /**
742
- * <p>The configuration definining the action to take when a duplicate fraudster is detected, and the
743
- * similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.</p>
744
- */
745
- export interface RegistrationConfig {
746
- /**
747
- * <p>The action to take when a fraudster is identified as a duplicate. The default action is
748
- * <code>SKIP</code>, which skips registering the duplicate fraudster. Setting the value to
749
- * <code>REGISTER_AS_NEW</code> always registers a new fraudster into the specified domain.</p>
750
- */
751
- DuplicateRegistrationAction?: DuplicateRegistrationAction | string;
752
-
753
- /**
754
- * <p>The minimum similarity score between the new and old fraudsters in order to consider the new
755
- * fraudster a duplicate.</p>
756
- */
757
- FraudsterSimilarityThreshold?: number;
758
- }
759
-
760
- export namespace RegistrationConfig {
761
- /**
762
- * @internal
763
- */
764
- export const filterSensitiveLog = (obj: RegistrationConfig): any => ({
765
- ...obj,
766
- });
767
- }
768
-
769
- /**
770
- * <p>Contains all the information about a fraudster registration job.</p>
771
- */
772
- export interface FraudsterRegistrationJob {
773
- /**
774
- * <p>The client-provied name for the fraudster registration job.</p>
775
- */
776
- JobName?: string;
777
-
778
- /**
779
- * <p>The service-generated identifier for the fraudster registration job.</p>
780
- */
781
- JobId?: string;
782
-
783
- /**
784
- * <p>The current status of the fraudster registration job.</p>
785
- */
786
- JobStatus?: FraudsterRegistrationJobStatus | string;
787
-
788
- /**
789
- * <p>The identifier of the domain containing the fraudster registration job.</p>
790
- */
791
- DomainId?: string;
792
-
793
- /**
794
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
795
- * to read the input manifest file and write the job output file.</p>
796
- */
797
- DataAccessRoleArn?: string;
798
-
799
- /**
800
- * <p>The registration config containing details such as the action to take when a duplicate fraudster is
801
- * detected, and the similarity threshold to use for detecting a duplicate fraudster.</p>
802
- */
803
- RegistrationConfig?: RegistrationConfig;
804
-
805
- /**
806
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
807
- * of fraudster registration job requests.</p>
808
- */
809
- InputDataConfig?: InputDataConfig;
810
-
811
- /**
812
- * <p>The output data config containing the S3 location where you want Voice ID to write your job output
813
- * file; you must also include a KMS Key ID in order to encrypt the file.</p>
814
- */
815
- OutputDataConfig?: OutputDataConfig;
816
-
817
- /**
818
- * <p>A timestamp showing the creation time of the fraudster registration job.</p>
819
- */
820
- CreatedAt?: Date;
821
-
822
- /**
823
- * <p>A timestamp showing when the fraudster registration job ended.</p>
824
- */
825
- EndedAt?: Date;
826
-
827
- /**
828
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
829
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
830
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
831
- * registration requests that failed.</p>
832
- */
833
- FailureDetails?: FailureDetails;
834
-
835
- /**
836
- * <p>Shows the completed percentage of registration requests listed in the input file.</p>
837
- */
838
- JobProgress?: JobProgress;
839
- }
840
-
841
- export namespace FraudsterRegistrationJob {
842
- /**
843
- * @internal
844
- */
845
- export const filterSensitiveLog = (obj: FraudsterRegistrationJob): any => ({
846
- ...obj,
847
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
848
- });
849
- }
850
-
851
- export interface DescribeFraudsterRegistrationJobResponse {
852
- /**
853
- * <p>Contains details about the specified fraudster registration job.</p>
854
- */
855
- Job?: FraudsterRegistrationJob;
856
- }
857
-
858
- export namespace DescribeFraudsterRegistrationJobResponse {
859
- /**
860
- * @internal
861
- */
862
- export const filterSensitiveLog = (obj: DescribeFraudsterRegistrationJobResponse): any => ({
863
- ...obj,
864
- ...(obj.Job && { Job: FraudsterRegistrationJob.filterSensitiveLog(obj.Job) }),
865
- });
866
- }
867
-
868
- export interface DescribeSpeakerRequest {
869
- /**
870
- * <p>The identifier of the domain that contains the speaker.</p>
871
- */
872
- DomainId: string | undefined;
873
-
874
- /**
875
- * <p>The identifier of the speaker you are describing.</p>
876
- */
877
- SpeakerId: string | undefined;
878
- }
879
-
880
- export namespace DescribeSpeakerRequest {
881
- /**
882
- * @internal
883
- */
884
- export const filterSensitiveLog = (obj: DescribeSpeakerRequest): any => ({
885
- ...obj,
886
- ...(obj.SpeakerId && { SpeakerId: SENSITIVE_STRING }),
887
- });
888
- }
889
-
890
- export enum SpeakerStatus {
891
- ENROLLED = "ENROLLED",
892
- EXPIRED = "EXPIRED",
893
- OPTED_OUT = "OPTED_OUT",
894
- PENDING = "PENDING",
895
- }
896
-
897
- /**
898
- * <p>Contains all the information about a speaker.</p>
899
- */
900
- export interface Speaker {
901
- /**
902
- * <p>The identifier of the domain that contains the speaker.</p>
903
- */
904
- DomainId?: string;
905
-
906
- /**
907
- * <p>The client-provided identifier for the speaker.</p>
908
- */
909
- CustomerSpeakerId?: string;
910
-
911
- /**
912
- * <p>The service-generated identifier for the speaker.</p>
913
- */
914
- GeneratedSpeakerId?: string;
915
-
916
- /**
917
- * <p>The current status of the speaker.</p>
918
- */
919
- Status?: SpeakerStatus | string;
920
-
921
- /**
922
- * <p>A timestamp showing when the speaker is created. </p>
923
- */
924
- CreatedAt?: Date;
925
-
926
- /**
927
- * <p>A timestamp showing the speaker's last update.</p>
928
- */
929
- UpdatedAt?: Date;
930
- }
931
-
932
- export namespace Speaker {
933
- /**
934
- * @internal
935
- */
936
- export const filterSensitiveLog = (obj: Speaker): any => ({
937
- ...obj,
938
- ...(obj.CustomerSpeakerId && { CustomerSpeakerId: SENSITIVE_STRING }),
939
- });
940
- }
941
-
942
- export interface DescribeSpeakerResponse {
943
- /**
944
- * <p>Information about the specified speaker.</p>
945
- */
946
- Speaker?: Speaker;
947
- }
948
-
949
- export namespace DescribeSpeakerResponse {
950
- /**
951
- * @internal
952
- */
953
- export const filterSensitiveLog = (obj: DescribeSpeakerResponse): any => ({
954
- ...obj,
955
- ...(obj.Speaker && { Speaker: Speaker.filterSensitiveLog(obj.Speaker) }),
956
- });
957
- }
958
-
959
- export interface DescribeSpeakerEnrollmentJobRequest {
960
- /**
961
- * <p>The identifier of the domain containing the speaker enrollment job.</p>
962
- */
963
- DomainId: string | undefined;
964
-
965
- /**
966
- * <p>The identifier of the speaker enrollment job you are describing.</p>
967
- */
968
- JobId: string | undefined;
969
- }
970
-
971
- export namespace DescribeSpeakerEnrollmentJobRequest {
972
- /**
973
- * @internal
974
- */
975
- export const filterSensitiveLog = (obj: DescribeSpeakerEnrollmentJobRequest): any => ({
976
- ...obj,
977
- });
978
- }
979
-
980
- export enum ExistingEnrollmentAction {
981
- OVERWRITE = "OVERWRITE",
982
- SKIP = "SKIP",
983
- }
984
-
985
- export enum FraudDetectionAction {
986
- FAIL = "FAIL",
987
- IGNORE = "IGNORE",
988
- }
989
-
990
- /**
991
- * <p>The configuration defining the action to take when a speaker is flagged by the fraud detection system
992
- * during a batch speaker enrollment job, and the risk threshold to use for identification.</p>
993
- */
994
- export interface EnrollmentJobFraudDetectionConfig {
995
- /**
996
- * <p>The action to take when the given speaker is flagged by the fraud detection system. The default value is
997
- * <code>FAIL</code>, which fails the speaker enrollment. Changing this value to <code>IGNORE</code>
998
- * results in the speaker being enrolled even if they are flagged by the fraud detection system.</p>
999
- */
1000
- FraudDetectionAction?: FraudDetectionAction | string;
1001
-
1002
- /**
1003
- * <p>Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk
1004
- * score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.</p>
1005
- */
1006
- RiskThreshold?: number;
1007
- }
1008
-
1009
- export namespace EnrollmentJobFraudDetectionConfig {
1010
- /**
1011
- * @internal
1012
- */
1013
- export const filterSensitiveLog = (obj: EnrollmentJobFraudDetectionConfig): any => ({
1014
- ...obj,
1015
- });
1016
- }
1017
-
1018
- /**
1019
- * <p>Contains configurations defining enrollment behavior for the batch job.</p>
1020
- */
1021
- export interface EnrollmentConfig {
1022
- /**
1023
- * <p> The action to take when the specified speaker is already enrolled in the specified domain. The default
1024
- * value is <code>SKIP</code>, which skips the enrollment for the existing speaker. Setting the value to
1025
- * <code>OVERWRITE</code> replaces the existing voice prints and enrollment audio stored for that speaker
1026
- * with new data generated from the latest audio.</p>
1027
- */
1028
- ExistingEnrollmentAction?: ExistingEnrollmentAction | string;
1029
-
1030
- /**
1031
- * <p>The fraud detection configuration to use for the speaker enrollment job.</p>
1032
- */
1033
- FraudDetectionConfig?: EnrollmentJobFraudDetectionConfig;
1034
- }
1035
-
1036
- export namespace EnrollmentConfig {
1037
- /**
1038
- * @internal
1039
- */
1040
- export const filterSensitiveLog = (obj: EnrollmentConfig): any => ({
1041
- ...obj,
1042
- });
1043
- }
1044
-
1045
- export enum SpeakerEnrollmentJobStatus {
1046
- COMPLETED = "COMPLETED",
1047
- COMPLETED_WITH_ERRORS = "COMPLETED_WITH_ERRORS",
1048
- FAILED = "FAILED",
1049
- IN_PROGRESS = "IN_PROGRESS",
1050
- SUBMITTED = "SUBMITTED",
1051
- }
1052
-
1053
- /**
1054
- * <p>Contains all the information about a speaker enrollment job.</p>
1055
- */
1056
- export interface SpeakerEnrollmentJob {
1057
- /**
1058
- * <p>The client-provided name for the speaker enrollment job.</p>
1059
- */
1060
- JobName?: string;
1061
-
1062
- /**
1063
- * <p>The service-generated identifier for the speaker enrollment job.</p>
1064
- */
1065
- JobId?: string;
1066
-
1067
- /**
1068
- * <p>The current status of the speaker enrollment job.</p>
1069
- */
1070
- JobStatus?: SpeakerEnrollmentJobStatus | string;
1071
-
1072
- /**
1073
- * <p>The identifier of the domain that contains the speaker enrollment job.</p>
1074
- */
1075
- DomainId?: string;
1076
-
1077
- /**
1078
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
1079
- * to read the input manifest file and write the job output file.</p>
1080
- */
1081
- DataAccessRoleArn?: string;
1082
-
1083
- /**
1084
- * <p>The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the
1085
- * <code>FraudDetectionConfig</code> to use.</p>
1086
- */
1087
- EnrollmentConfig?: EnrollmentConfig;
1088
-
1089
- /**
1090
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
1091
- * of speaker enrollment job requests.</p>
1092
- */
1093
- InputDataConfig?: InputDataConfig;
1094
-
1095
- /**
1096
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
1097
- * also include a KMS Key ID to encrypt the file.</p>
1098
- */
1099
- OutputDataConfig?: OutputDataConfig;
1100
-
1101
- /**
1102
- * <p>A timestamp showing the creation of the speaker enrollment job.</p>
1103
- */
1104
- CreatedAt?: Date;
1105
-
1106
- /**
1107
- * <p>A timestamp showing when the speaker enrollment job ended. </p>
1108
- */
1109
- EndedAt?: Date;
1110
-
1111
- /**
1112
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
1113
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
1114
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
1115
- * registration requests that failed.</p>
1116
- */
1117
- FailureDetails?: FailureDetails;
1118
-
1119
- /**
1120
- * <p>Provides details on job progress. This field shows the completed percentage of registration
1121
- * requests listed in the input file.</p>
1122
- */
1123
- JobProgress?: JobProgress;
1124
- }
1125
-
1126
- export namespace SpeakerEnrollmentJob {
1127
- /**
1128
- * @internal
1129
- */
1130
- export const filterSensitiveLog = (obj: SpeakerEnrollmentJob): any => ({
1131
- ...obj,
1132
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
1133
- });
1134
- }
1135
-
1136
- export interface DescribeSpeakerEnrollmentJobResponse {
1137
- /**
1138
- * <p>Contains details about the specified speaker enrollment job.</p>
1139
- */
1140
- Job?: SpeakerEnrollmentJob;
1141
- }
1142
-
1143
- export namespace DescribeSpeakerEnrollmentJobResponse {
1144
- /**
1145
- * @internal
1146
- */
1147
- export const filterSensitiveLog = (obj: DescribeSpeakerEnrollmentJobResponse): any => ({
1148
- ...obj,
1149
- ...(obj.Job && { Job: SpeakerEnrollmentJob.filterSensitiveLog(obj.Job) }),
1150
- });
1151
- }
1152
-
1153
- /**
1154
- * <p>Contains a summary of information about a domain.</p>
1155
- */
1156
- export interface DomainSummary {
1157
- /**
1158
- * <p>The service-generated identifier for the domain.</p>
1159
- */
1160
- DomainId?: string;
1161
-
1162
- /**
1163
- * <p>The Amazon Resource Name (ARN) for the domain.</p>
1164
- */
1165
- Arn?: string;
1166
-
1167
- /**
1168
- * <p>The client-provided name for the domain.</p>
1169
- */
1170
- Name?: string;
1171
-
1172
- /**
1173
- * <p>The client-provided description of the domain.</p>
1174
- */
1175
- Description?: string;
1176
-
1177
- /**
1178
- * <p>The current status of the domain.</p>
1179
- */
1180
- DomainStatus?: DomainStatus | string;
1181
-
1182
- /**
1183
- * <p>The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use
1184
- * to encrypt your data..</p>
1185
- */
1186
- ServerSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1187
-
1188
- /**
1189
- * <p>The timestamp showing when the domain is created.</p>
1190
- */
1191
- CreatedAt?: Date;
1192
-
1193
- /**
1194
- * <p>The timestamp showing the domain's last update.</p>
1195
- */
1196
- UpdatedAt?: Date;
1197
- }
1198
-
1199
- export namespace DomainSummary {
1200
- /**
1201
- * @internal
1202
- */
1203
- export const filterSensitiveLog = (obj: DomainSummary): any => ({
1204
- ...obj,
1205
- ...(obj.Name && { Name: SENSITIVE_STRING }),
1206
- ...(obj.Description && { Description: SENSITIVE_STRING }),
1207
- });
1208
- }
1209
-
1210
- export interface EvaluateSessionRequest {
1211
- /**
1212
- * <p>The identifier of the domain where the session started.</p>
1213
- */
1214
- DomainId: string | undefined;
1215
-
1216
- /**
1217
- * <p>The session identifier, or name of the session, that you want to evaluate. In Voice ID
1218
- * integration, this is the Contact-Id.</p>
1219
- */
1220
- SessionNameOrId: string | undefined;
1221
- }
1222
-
1223
- export namespace EvaluateSessionRequest {
1224
- /**
1225
- * @internal
1226
- */
1227
- export const filterSensitiveLog = (obj: EvaluateSessionRequest): any => ({
1228
- ...obj,
1229
- });
1230
- }
1231
-
1232
- /**
1233
- * <p>The configuration used for performing fraud detection over a speaker during a session.</p>
1234
- */
1235
- export interface FraudDetectionConfiguration {
1236
- /**
1237
- * <p>Threshold value for determining whether the speaker is a fraudster. If the detected risk score
1238
- * calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.</p>
1239
- */
1240
- RiskThreshold: number | undefined;
1241
- }
1242
-
1243
- export namespace FraudDetectionConfiguration {
1244
- /**
1245
- * @internal
1246
- */
1247
- export const filterSensitiveLog = (obj: FraudDetectionConfiguration): any => ({
1248
- ...obj,
1249
- });
1250
- }
1251
-
1252
- export enum FraudDetectionDecision {
1253
- HIGH_RISK = "HIGH_RISK",
1254
- LOW_RISK = "LOW_RISK",
1255
- NOT_ENOUGH_SPEECH = "NOT_ENOUGH_SPEECH",
1256
- }
1257
-
1258
- export enum FraudDetectionReason {
1259
- KNOWN_FRAUDSTER = "KNOWN_FRAUDSTER",
1260
- }
1261
-
1262
- /**
1263
- * <p>Contains details produced as a result of performing known fraudster risk analysis on a speaker.</p>
1264
- */
1265
- export interface KnownFraudsterRisk {
1266
- /**
1267
- * <p>The score indicating the likelihood the speaker is a known fraudster.</p>
1268
- */
1269
- RiskScore: number | undefined;
1270
-
1271
- /**
1272
- * <p>The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters
1273
- * registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is
1274
- * <code>null</code>.</p>
1275
- */
1276
- GeneratedFraudsterId?: string;
1277
- }
1278
-
1279
- export namespace KnownFraudsterRisk {
1280
- /**
1281
- * @internal
1282
- */
1283
- export const filterSensitiveLog = (obj: KnownFraudsterRisk): any => ({
1284
- ...obj,
1285
- });
1286
- }
1287
-
1288
- /**
1289
- * <p>Details regarding various fraud risk analyses performed against the current session state and streamed
1290
- * audio of the speaker.</p>
1291
- */
1292
- export interface FraudRiskDetails {
1293
- /**
1294
- * <p>The details resulting from 'Known Fraudster Risk' analysis of the speaker.</p>
1295
- */
1296
- KnownFraudsterRisk: KnownFraudsterRisk | undefined;
1297
- }
1298
-
1299
- export namespace FraudRiskDetails {
1300
- /**
1301
- * @internal
1302
- */
1303
- export const filterSensitiveLog = (obj: FraudRiskDetails): any => ({
1304
- ...obj,
1305
- });
1306
- }
1307
-
1308
- /**
1309
- * <p>The fraud detection result produced by Voice ID, processed against the current session state and streamed
1310
- * audio of the speaker.</p>
1311
- */
1312
- export interface FraudDetectionResult {
1313
- /**
1314
- * <p>The unique identifier for this fraud detection result. Given there can be multiple fraud detections
1315
- * for a given session, this field helps in identifying if the returned result is from previous streaming
1316
- * activity or a new result. Note that in the absence of any new streaming activity or risk threshold
1317
- * changes, Voice ID always returns cached Fraud Detection result for this API.</p>
1318
- */
1319
- FraudDetectionResultId?: string;
1320
-
1321
- /**
1322
- * <p>A timestamp indicating when audio aggregation started for this fraud detection result.</p>
1323
- */
1324
- AudioAggregationStartedAt?: Date;
1325
-
1326
- /**
1327
- * <p>A timestamp indicating when audio aggregation ended for this fraud detection result.</p>
1328
- */
1329
- AudioAggregationEndedAt?: Date;
1330
-
1331
- /**
1332
- * <p>The <code>FraudDetectionConfiguration</code> used to generate this fraud detection result.</p>
1333
- */
1334
- Configuration?: FraudDetectionConfiguration;
1335
-
1336
- /**
1337
- * <p>The fraud detection decision produced by Voice ID, processed against the current session state and
1338
- * streamed audio of the speaker.</p>
1339
- */
1340
- Decision?: FraudDetectionDecision | string;
1341
-
1342
- /**
1343
- * <p>The reason speaker was flagged by the fraud detection system. This is only be populated if fraud
1344
- * detection Decision is <code>HIGH_RISK</code>, and only has one possible value:
1345
- * <code>KNOWN_FRAUDSTER</code>.</p>
1346
- */
1347
- Reasons?: (FraudDetectionReason | string)[];
1348
-
1349
- /**
1350
- * <p>Details about each risk analyzed for this speaker.</p>
1351
- */
1352
- RiskDetails?: FraudRiskDetails;
1353
- }
1354
-
1355
- export namespace FraudDetectionResult {
1356
- /**
1357
- * @internal
1358
- */
1359
- export const filterSensitiveLog = (obj: FraudDetectionResult): any => ({
1360
- ...obj,
1361
- });
1362
- }
1363
-
1364
- export enum StreamingStatus {
1365
- ENDED = "ENDED",
1366
- ONGOING = "ONGOING",
1367
- PENDING_CONFIGURATION = "PENDING_CONFIGURATION",
1368
- }
1369
-
1370
- export interface EvaluateSessionResponse {
1371
- /**
1372
- * <p>The identifier of the domain containing the session.</p>
1373
- */
1374
- DomainId?: string;
1375
-
1376
- /**
1377
- * <p>The service-generated identifier of the session.</p>
1378
- */
1379
- SessionId?: string;
1380
-
1381
- /**
1382
- * <p>The client-provided name of the session.</p>
1383
- */
1384
- SessionName?: string;
1385
-
1386
- /**
1387
- * <p>The current status of audio streaming for this session. This field is useful to infer next steps when
1388
- * the Authentication or Fraud Detection results are empty or the decision is <code>NOT_ENOUGH_SPEECH</code>.
1389
- * In this situation, if the <code>StreamingStatus</code> is <code>ONGOING/PENDING_CONFIGURATION</code>, it can
1390
- * mean that the client should call the API again later, once Voice ID has enough audio to produce a result.
1391
- * If the decision remains <code>NOT_ENOUGH_SPEECH</code> even after <code>StreamingStatus</code> is <code>ENDED</code>,
1392
- * it means that the previously streamed session did not have enough speech to perform evaluation, and a new
1393
- * streaming session is needed to try again.</p>
1394
- */
1395
- StreamingStatus?: StreamingStatus | string;
1396
-
1397
- /**
1398
- * <p>Details resulting from the authentication process, such as authentication decision and
1399
- * authentication score.</p>
1400
- */
1401
- AuthenticationResult?: AuthenticationResult;
1402
-
1403
- /**
1404
- * <p>Details resulting from the fraud detection process, such as fraud detection decision and risk score.</p>
1405
- */
1406
- FraudDetectionResult?: FraudDetectionResult;
1407
- }
1408
-
1409
- export namespace EvaluateSessionResponse {
1410
- /**
1411
- * @internal
1412
- */
1413
- export const filterSensitiveLog = (obj: EvaluateSessionResponse): any => ({
1414
- ...obj,
1415
- ...(obj.AuthenticationResult && {
1416
- AuthenticationResult: AuthenticationResult.filterSensitiveLog(obj.AuthenticationResult),
1417
- }),
1418
- });
1419
- }
1420
-
1421
- /**
1422
- * <p>Contains a summary of information about a fraudster registration job.</p>
1423
- */
1424
- export interface FraudsterRegistrationJobSummary {
1425
- /**
1426
- * <p>The client-provied name for the fraudster registration job.</p>
1427
- */
1428
- JobName?: string;
1429
-
1430
- /**
1431
- * <p>The service-generated identifier for the fraudster registration job.</p>
1432
- */
1433
- JobId?: string;
1434
-
1435
- /**
1436
- * <p>The current status of the fraudster registration job.</p>
1437
- */
1438
- JobStatus?: FraudsterRegistrationJobStatus | string;
1439
-
1440
- /**
1441
- * <p>The identifier of the domain containing the fraudster registration job.</p>
1442
- */
1443
- DomainId?: string;
1444
-
1445
- /**
1446
- * <p>A timestamp showing when the fraudster registration job is created. </p>
1447
- */
1448
- CreatedAt?: Date;
1449
-
1450
- /**
1451
- * <p>A timestamp showing when the fraudster registration job ended.</p>
1452
- */
1453
- EndedAt?: Date;
1454
-
1455
- /**
1456
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
1457
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
1458
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
1459
- * registration requests that failed.</p>
1460
- */
1461
- FailureDetails?: FailureDetails;
1462
-
1463
- /**
1464
- * <p>Shows the completed percentage of registration requests listed in the input file.</p>
1465
- */
1466
- JobProgress?: JobProgress;
1467
- }
1468
-
1469
- export namespace FraudsterRegistrationJobSummary {
1470
- /**
1471
- * @internal
1472
- */
1473
- export const filterSensitiveLog = (obj: FraudsterRegistrationJobSummary): any => ({
1474
- ...obj,
1475
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
1476
- });
1477
- }
1478
-
1479
- export interface ListDomainsRequest {
1480
- /**
1481
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1482
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1483
- * </p>
1484
- */
1485
- MaxResults?: number;
1486
-
1487
- /**
1488
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1489
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1490
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1491
- * </p>
1492
- */
1493
- NextToken?: string;
1494
- }
1495
-
1496
- export namespace ListDomainsRequest {
1497
- /**
1498
- * @internal
1499
- */
1500
- export const filterSensitiveLog = (obj: ListDomainsRequest): any => ({
1501
- ...obj,
1502
- });
1503
- }
1504
-
1505
- export interface ListDomainsResponse {
1506
- /**
1507
- * <p>A list containing details about each domain in the Amazon Web Services account.</p>
1508
- */
1509
- DomainSummaries?: DomainSummary[];
1510
-
1511
- /**
1512
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1513
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1514
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1515
- * </p>
1516
- */
1517
- NextToken?: string;
1518
- }
1519
-
1520
- export namespace ListDomainsResponse {
1521
- /**
1522
- * @internal
1523
- */
1524
- export const filterSensitiveLog = (obj: ListDomainsResponse): any => ({
1525
- ...obj,
1526
- ...(obj.DomainSummaries && {
1527
- DomainSummaries: obj.DomainSummaries.map((item) => DomainSummary.filterSensitiveLog(item)),
1528
- }),
1529
- });
1530
- }
1531
-
1532
- export interface ListFraudsterRegistrationJobsRequest {
1533
- /**
1534
- * <p>The identifier of the domain containing the fraudster registration Jobs.</p>
1535
- */
1536
- DomainId: string | undefined;
1537
-
1538
- /**
1539
- * <p>Provides the status of your fraudster registration job.</p>
1540
- */
1541
- JobStatus?: FraudsterRegistrationJobStatus | string;
1542
-
1543
- /**
1544
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1545
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1546
- * </p>
1547
- */
1548
- MaxResults?: number;
1549
-
1550
- /**
1551
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1552
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1553
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1554
- * </p>
1555
- */
1556
- NextToken?: string;
1557
- }
1558
-
1559
- export namespace ListFraudsterRegistrationJobsRequest {
1560
- /**
1561
- * @internal
1562
- */
1563
- export const filterSensitiveLog = (obj: ListFraudsterRegistrationJobsRequest): any => ({
1564
- ...obj,
1565
- });
1566
- }
1567
-
1568
- export interface ListFraudsterRegistrationJobsResponse {
1569
- /**
1570
- * <p>A list containing details about each specified fraudster registration job.</p>
1571
- */
1572
- JobSummaries?: FraudsterRegistrationJobSummary[];
1573
-
1574
- /**
1575
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1576
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1577
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1578
- * </p>
1579
- */
1580
- NextToken?: string;
1581
- }
1582
-
1583
- export namespace ListFraudsterRegistrationJobsResponse {
1584
- /**
1585
- * @internal
1586
- */
1587
- export const filterSensitiveLog = (obj: ListFraudsterRegistrationJobsResponse): any => ({
1588
- ...obj,
1589
- ...(obj.JobSummaries && {
1590
- JobSummaries: obj.JobSummaries.map((item) => FraudsterRegistrationJobSummary.filterSensitiveLog(item)),
1591
- }),
1592
- });
1593
- }
1594
-
1595
- export interface ListSpeakerEnrollmentJobsRequest {
1596
- /**
1597
- * <p>The identifier of the domain containing the speaker enrollment jobs.</p>
1598
- */
1599
- DomainId: string | undefined;
1600
-
1601
- /**
1602
- * <p>Provides the status of your speaker enrollment Job.</p>
1603
- */
1604
- JobStatus?: SpeakerEnrollmentJobStatus | string;
1605
-
1606
- /**
1607
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1608
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1609
- * </p>
1610
- */
1611
- MaxResults?: number;
1612
-
1613
- /**
1614
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1615
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1616
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1617
- * </p>
1618
- */
1619
- NextToken?: string;
1620
- }
1621
-
1622
- export namespace ListSpeakerEnrollmentJobsRequest {
1623
- /**
1624
- * @internal
1625
- */
1626
- export const filterSensitiveLog = (obj: ListSpeakerEnrollmentJobsRequest): any => ({
1627
- ...obj,
1628
- });
1629
- }
1630
-
1631
- /**
1632
- * <p>Contains a summary of information about a speaker enrollment job.</p>
1633
- */
1634
- export interface SpeakerEnrollmentJobSummary {
1635
- /**
1636
- * <p>The client-provided name for the speaker enrollment job.</p>
1637
- */
1638
- JobName?: string;
1639
-
1640
- /**
1641
- * <p>The service-generated identifier for the speaker enrollment job.</p>
1642
- */
1643
- JobId?: string;
1644
-
1645
- /**
1646
- * <p>The current status of the speaker enrollment job.</p>
1647
- */
1648
- JobStatus?: SpeakerEnrollmentJobStatus | string;
1649
-
1650
- /**
1651
- * <p>The identifier of the domain that contains the speaker enrollment job.</p>
1652
- */
1653
- DomainId?: string;
1654
-
1655
- /**
1656
- * <p>A timestamp showing the creation time of the speaker enrollment job.</p>
1657
- */
1658
- CreatedAt?: Date;
1659
-
1660
- /**
1661
- * <p>A timestamp showing when the speaker enrollment job ended.</p>
1662
- */
1663
- EndedAt?: Date;
1664
-
1665
- /**
1666
- * <p>Contains details that are populated when an entire batch job fails. In cases of individual registration
1667
- * job failures, the batch job as a whole doesn't fail; it is completed with a <code>JobStatus</code> of
1668
- * <code>COMPLETED_WITH_ERRORS</code>. You can use the job output file to identify the individual
1669
- * registration requests that failed.</p>
1670
- */
1671
- FailureDetails?: FailureDetails;
1672
-
1673
- /**
1674
- * <p>Provides details regarding job progress. This field shows the completed percentage of enrollment
1675
- * requests listed in the input file.</p>
1676
- */
1677
- JobProgress?: JobProgress;
1678
- }
1679
-
1680
- export namespace SpeakerEnrollmentJobSummary {
1681
- /**
1682
- * @internal
1683
- */
1684
- export const filterSensitiveLog = (obj: SpeakerEnrollmentJobSummary): any => ({
1685
- ...obj,
1686
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
1687
- });
1688
- }
1689
-
1690
- export interface ListSpeakerEnrollmentJobsResponse {
1691
- /**
1692
- * <p>A list containing details about each specified speaker enrollment job.</p>
1693
- */
1694
- JobSummaries?: SpeakerEnrollmentJobSummary[];
1695
-
1696
- /**
1697
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1698
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1699
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1700
- * </p>
1701
- */
1702
- NextToken?: string;
1703
- }
1704
-
1705
- export namespace ListSpeakerEnrollmentJobsResponse {
1706
- /**
1707
- * @internal
1708
- */
1709
- export const filterSensitiveLog = (obj: ListSpeakerEnrollmentJobsResponse): any => ({
1710
- ...obj,
1711
- ...(obj.JobSummaries && {
1712
- JobSummaries: obj.JobSummaries.map((item) => SpeakerEnrollmentJobSummary.filterSensitiveLog(item)),
1713
- }),
1714
- });
1715
- }
1716
-
1717
- export interface ListSpeakersRequest {
1718
- /**
1719
- * <p>The identifier of the domain.</p>
1720
- */
1721
- DomainId: string | undefined;
1722
-
1723
- /**
1724
- * <p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain
1725
- * further pages of results. The default is 100; the maximum allowed page size is also 100.
1726
- * </p>
1727
- */
1728
- MaxResults?: number;
1729
-
1730
- /**
1731
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1732
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1733
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1734
- * </p>
1735
- */
1736
- NextToken?: string;
1737
- }
1738
-
1739
- export namespace ListSpeakersRequest {
1740
- /**
1741
- * @internal
1742
- */
1743
- export const filterSensitiveLog = (obj: ListSpeakersRequest): any => ({
1744
- ...obj,
1745
- });
1746
- }
1747
-
1748
- /**
1749
- * <p>Contains a summary of information about a speaker.</p>
1750
- */
1751
- export interface SpeakerSummary {
1752
- /**
1753
- * <p>The identifier of the domain that contains the speaker.</p>
1754
- */
1755
- DomainId?: string;
1756
-
1757
- /**
1758
- * <p>The client-provided identifier for the speaker.</p>
1759
- */
1760
- CustomerSpeakerId?: string;
1761
-
1762
- /**
1763
- * <p>The service-generated identifier for the speaker. </p>
1764
- */
1765
- GeneratedSpeakerId?: string;
1766
-
1767
- /**
1768
- * <p>The current status of the speaker.</p>
1769
- */
1770
- Status?: SpeakerStatus | string;
1771
-
1772
- /**
1773
- * <p>A timestamp showing the speaker's creation time. </p>
1774
- */
1775
- CreatedAt?: Date;
1776
-
1777
- /**
1778
- * <p>A timestamp showing the speaker's last update.</p>
1779
- */
1780
- UpdatedAt?: Date;
1781
- }
1782
-
1783
- export namespace SpeakerSummary {
1784
- /**
1785
- * @internal
1786
- */
1787
- export const filterSensitiveLog = (obj: SpeakerSummary): any => ({
1788
- ...obj,
1789
- ...(obj.CustomerSpeakerId && { CustomerSpeakerId: SENSITIVE_STRING }),
1790
- });
1791
- }
1792
-
1793
- export interface ListSpeakersResponse {
1794
- /**
1795
- * <p>A list containing details about each speaker in the Amazon Web Services account.
1796
- * </p>
1797
- */
1798
- SpeakerSummaries?: SpeakerSummary[];
1799
-
1800
- /**
1801
- * <p>If <code>NextToken</code> is returned, there are more results available. The value of <code>NextToken</code>
1802
- * is a unique pagination token for each page. Make the call again using the returned token to retrieve the
1803
- * next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
1804
- * </p>
1805
- */
1806
- NextToken?: string;
1807
- }
1808
-
1809
- export namespace ListSpeakersResponse {
1810
- /**
1811
- * @internal
1812
- */
1813
- export const filterSensitiveLog = (obj: ListSpeakersResponse): any => ({
1814
- ...obj,
1815
- ...(obj.SpeakerSummaries && {
1816
- SpeakerSummaries: obj.SpeakerSummaries.map((item) => SpeakerSummary.filterSensitiveLog(item)),
1817
- }),
1818
- });
1819
- }
1820
-
1821
- export interface ListTagsForResourceRequest {
1822
- /**
1823
- * <p>The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.</p>
1824
- */
1825
- ResourceArn: string | undefined;
1826
- }
1827
-
1828
- export namespace ListTagsForResourceRequest {
1829
- /**
1830
- * @internal
1831
- */
1832
- export const filterSensitiveLog = (obj: ListTagsForResourceRequest): any => ({
1833
- ...obj,
1834
- });
1835
- }
1836
-
1837
- export interface ListTagsForResourceResponse {
1838
- /**
1839
- * <p>The list of tags associated with the specified resource.</p>
1840
- */
1841
- Tags?: Tag[];
1842
- }
1843
-
1844
- export namespace ListTagsForResourceResponse {
1845
- /**
1846
- * @internal
1847
- */
1848
- export const filterSensitiveLog = (obj: ListTagsForResourceResponse): any => ({
1849
- ...obj,
1850
- ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }),
1851
- });
1852
- }
1853
-
1854
- export interface OptOutSpeakerRequest {
1855
- /**
1856
- * <p>The identifier of the domain containing the speaker.</p>
1857
- */
1858
- DomainId: string | undefined;
1859
-
1860
- /**
1861
- * <p>The identifier of the speaker you want opted-out.</p>
1862
- */
1863
- SpeakerId: string | undefined;
1864
- }
1865
-
1866
- export namespace OptOutSpeakerRequest {
1867
- /**
1868
- * @internal
1869
- */
1870
- export const filterSensitiveLog = (obj: OptOutSpeakerRequest): any => ({
1871
- ...obj,
1872
- ...(obj.SpeakerId && { SpeakerId: SENSITIVE_STRING }),
1873
- });
1874
- }
1875
-
1876
- export interface OptOutSpeakerResponse {
1877
- /**
1878
- * <p>Details about the opted-out speaker.</p>
1879
- */
1880
- Speaker?: Speaker;
1881
- }
1882
-
1883
- export namespace OptOutSpeakerResponse {
1884
- /**
1885
- * @internal
1886
- */
1887
- export const filterSensitiveLog = (obj: OptOutSpeakerResponse): any => ({
1888
- ...obj,
1889
- ...(obj.Speaker && { Speaker: Speaker.filterSensitiveLog(obj.Speaker) }),
1890
- });
1891
- }
1892
-
1893
- export interface StartFraudsterRegistrationJobRequest {
1894
- /**
1895
- * <p>The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services
1896
- * SDK populates this field.</p>
1897
- */
1898
- ClientToken?: string;
1899
-
1900
- /**
1901
- * <p>The name of the new fraudster registration job.</p>
1902
- */
1903
- JobName?: string;
1904
-
1905
- /**
1906
- * <p>The identifier of the domain containing the fraudster registration job and in which the fraudsters are
1907
- * registered.</p>
1908
- */
1909
- DomainId: string | undefined;
1910
-
1911
- /**
1912
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
1913
- * to read the input manifest file and write the Job output file. Refer to the
1914
- * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html">Create and
1915
- * edit a fraudster watchlist</a> documentation for the permissions needed in this role.</p>
1916
- */
1917
- DataAccessRoleArn: string | undefined;
1918
-
1919
- /**
1920
- * <p>The registration config containing details such as the action to take when a duplicate fraudster is
1921
- * detected, and the similarity threshold to use for detecting a duplicate fraudster.</p>
1922
- */
1923
- RegistrationConfig?: RegistrationConfig;
1924
-
1925
- /**
1926
- * <p>The input data config containing an S3 URI for the input manifest file that contains the list
1927
- * of fraudster registration requests.</p>
1928
- */
1929
- InputDataConfig: InputDataConfig | undefined;
1930
-
1931
- /**
1932
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
1933
- * also include a KMS Key ID to encrypt the file.</p>
1934
- */
1935
- OutputDataConfig: OutputDataConfig | undefined;
1936
- }
1937
-
1938
- export namespace StartFraudsterRegistrationJobRequest {
1939
- /**
1940
- * @internal
1941
- */
1942
- export const filterSensitiveLog = (obj: StartFraudsterRegistrationJobRequest): any => ({
1943
- ...obj,
1944
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
1945
- });
1946
- }
1947
-
1948
- export interface StartFraudsterRegistrationJobResponse {
1949
- /**
1950
- * <p>Details about the started fraudster registration job.</p>
1951
- */
1952
- Job?: FraudsterRegistrationJob;
1953
- }
1954
-
1955
- export namespace StartFraudsterRegistrationJobResponse {
1956
- /**
1957
- * @internal
1958
- */
1959
- export const filterSensitiveLog = (obj: StartFraudsterRegistrationJobResponse): any => ({
1960
- ...obj,
1961
- ...(obj.Job && { Job: FraudsterRegistrationJob.filterSensitiveLog(obj.Job) }),
1962
- });
1963
- }
1964
-
1965
- export interface StartSpeakerEnrollmentJobRequest {
1966
- /**
1967
- * <p>The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services
1968
- * SDK populates this field.</p>
1969
- */
1970
- ClientToken?: string;
1971
-
1972
- /**
1973
- * <p>A name for your speaker enrollment job.</p>
1974
- */
1975
- JobName?: string;
1976
-
1977
- /**
1978
- * <p>The identifier of the domain that contains the speaker enrollment job and in which the speakers are
1979
- * enrolled.
1980
- * </p>
1981
- */
1982
- DomainId: string | undefined;
1983
-
1984
- /**
1985
- * <p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets
1986
- * to read the input manifest file and write the job output file. Refer to <a href="https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html">Batch enrollment using audio data from prior
1987
- * calls</a> documentation for the permissions needed in this role.</p>
1988
- */
1989
- DataAccessRoleArn: string | undefined;
1990
-
1991
- /**
1992
- * <p>The enrollment config that contains details such as the action to take when a speaker is already
1993
- * enrolled in the Voice ID system or when a speaker is identified as a fraudster.</p>
1994
- */
1995
- EnrollmentConfig?: EnrollmentConfig;
1996
-
1997
- /**
1998
- * <p>The input data config containing the S3 location for the input manifest file that contains the list of
1999
- * speaker enrollment requests.</p>
2000
- */
2001
- InputDataConfig: InputDataConfig | undefined;
2002
-
2003
- /**
2004
- * <p>The output data config containing the S3 location where Voice ID writes the job output file; you must
2005
- * also include a KMS Key ID to encrypt the file.</p>
2006
- */
2007
- OutputDataConfig: OutputDataConfig | undefined;
2008
- }
2009
-
2010
- export namespace StartSpeakerEnrollmentJobRequest {
2011
- /**
2012
- * @internal
2013
- */
2014
- export const filterSensitiveLog = (obj: StartSpeakerEnrollmentJobRequest): any => ({
2015
- ...obj,
2016
- ...(obj.JobName && { JobName: SENSITIVE_STRING }),
2017
- });
2018
- }
2019
-
2020
- export interface StartSpeakerEnrollmentJobResponse {
2021
- /**
2022
- * <p>Details about the started speaker enrollment job.</p>
2023
- */
2024
- Job?: SpeakerEnrollmentJob;
2025
- }
2026
-
2027
- export namespace StartSpeakerEnrollmentJobResponse {
2028
- /**
2029
- * @internal
2030
- */
2031
- export const filterSensitiveLog = (obj: StartSpeakerEnrollmentJobResponse): any => ({
2032
- ...obj,
2033
- ...(obj.Job && { Job: SpeakerEnrollmentJob.filterSensitiveLog(obj.Job) }),
2034
- });
2035
- }
2036
-
2037
- export interface TagResourceRequest {
2038
- /**
2039
- * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.</p>
2040
- */
2041
- ResourceArn: string | undefined;
2042
-
2043
- /**
2044
- * <p>The list of tags to assign to the specified resource.</p>
2045
- */
2046
- Tags: Tag[] | undefined;
2047
- }
2048
-
2049
- export namespace TagResourceRequest {
2050
- /**
2051
- * @internal
2052
- */
2053
- export const filterSensitiveLog = (obj: TagResourceRequest): any => ({
2054
- ...obj,
2055
- ...(obj.Tags && { Tags: obj.Tags.map((item) => Tag.filterSensitiveLog(item)) }),
2056
- });
2057
- }
2058
-
2059
- export interface TagResourceResponse {}
2060
-
2061
- export namespace TagResourceResponse {
2062
- /**
2063
- * @internal
2064
- */
2065
- export const filterSensitiveLog = (obj: TagResourceResponse): any => ({
2066
- ...obj,
2067
- });
2068
- }
2069
-
2070
- export interface UntagResourceRequest {
2071
- /**
2072
- * <p>The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.</p>
2073
- */
2074
- ResourceArn: string | undefined;
2075
-
2076
- /**
2077
- * <p>The list of tag keys you want to remove from the specified resource.</p>
2078
- */
2079
- TagKeys: string[] | undefined;
2080
- }
2081
-
2082
- export namespace UntagResourceRequest {
2083
- /**
2084
- * @internal
2085
- */
2086
- export const filterSensitiveLog = (obj: UntagResourceRequest): any => ({
2087
- ...obj,
2088
- ...(obj.TagKeys && { TagKeys: SENSITIVE_STRING }),
2089
- });
2090
- }
2091
-
2092
- export interface UntagResourceResponse {}
2093
-
2094
- export namespace UntagResourceResponse {
2095
- /**
2096
- * @internal
2097
- */
2098
- export const filterSensitiveLog = (obj: UntagResourceResponse): any => ({
2099
- ...obj,
2100
- });
2101
- }
2102
-
2103
- export interface UpdateDomainRequest {
2104
- /**
2105
- * <p>The identifier of the domain to be updated.</p>
2106
- */
2107
- DomainId: string | undefined;
2108
-
2109
- /**
2110
- * <p>The name of the domain.</p>
2111
- */
2112
- Name: string | undefined;
2113
-
2114
- /**
2115
- * <p>A brief description about this domain.</p>
2116
- */
2117
- Description?: string;
2118
-
2119
- /**
2120
- * <p>The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side
2121
- * encryption of your data. Note that all the existing data in the domain are still encrypted using the
2122
- * existing key, only the data added to domain after updating the key is encrypted using the new key. </p>
2123
- */
2124
- ServerSideEncryptionConfiguration: ServerSideEncryptionConfiguration | undefined;
2125
- }
2126
-
2127
- export namespace UpdateDomainRequest {
2128
- /**
2129
- * @internal
2130
- */
2131
- export const filterSensitiveLog = (obj: UpdateDomainRequest): any => ({
2132
- ...obj,
2133
- ...(obj.Name && { Name: SENSITIVE_STRING }),
2134
- ...(obj.Description && { Description: SENSITIVE_STRING }),
2135
- });
2136
- }
2137
-
2138
- export interface UpdateDomainResponse {
2139
- /**
2140
- * <p>Details about the updated domain</p>
2141
- */
2142
- Domain?: Domain;
2143
- }
2144
-
2145
- export namespace UpdateDomainResponse {
2146
- /**
2147
- * @internal
2148
- */
2149
- export const filterSensitiveLog = (obj: UpdateDomainResponse): any => ({
2150
- ...obj,
2151
- ...(obj.Domain && { Domain: Domain.filterSensitiveLog(obj.Domain) }),
2152
- });
2153
- }