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