@aws-sdk/client-cleanroomsml 3.462.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 (199) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +405 -0
  3. package/dist-cjs/CleanRoomsML.js +61 -0
  4. package/dist-cjs/CleanRoomsMLClient.js +43 -0
  5. package/dist-cjs/commands/CreateAudienceModelCommand.js +51 -0
  6. package/dist-cjs/commands/CreateConfiguredAudienceModelCommand.js +51 -0
  7. package/dist-cjs/commands/CreateTrainingDatasetCommand.js +51 -0
  8. package/dist-cjs/commands/DeleteAudienceGenerationJobCommand.js +51 -0
  9. package/dist-cjs/commands/DeleteAudienceModelCommand.js +51 -0
  10. package/dist-cjs/commands/DeleteConfiguredAudienceModelCommand.js +51 -0
  11. package/dist-cjs/commands/DeleteConfiguredAudienceModelPolicyCommand.js +51 -0
  12. package/dist-cjs/commands/DeleteTrainingDatasetCommand.js +51 -0
  13. package/dist-cjs/commands/GetAudienceGenerationJobCommand.js +51 -0
  14. package/dist-cjs/commands/GetAudienceModelCommand.js +51 -0
  15. package/dist-cjs/commands/GetConfiguredAudienceModelCommand.js +51 -0
  16. package/dist-cjs/commands/GetConfiguredAudienceModelPolicyCommand.js +51 -0
  17. package/dist-cjs/commands/GetTrainingDatasetCommand.js +51 -0
  18. package/dist-cjs/commands/ListAudienceExportJobsCommand.js +51 -0
  19. package/dist-cjs/commands/ListAudienceGenerationJobsCommand.js +51 -0
  20. package/dist-cjs/commands/ListAudienceModelsCommand.js +51 -0
  21. package/dist-cjs/commands/ListConfiguredAudienceModelsCommand.js +51 -0
  22. package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
  23. package/dist-cjs/commands/ListTrainingDatasetsCommand.js +51 -0
  24. package/dist-cjs/commands/PutConfiguredAudienceModelPolicyCommand.js +51 -0
  25. package/dist-cjs/commands/StartAudienceExportJobCommand.js +51 -0
  26. package/dist-cjs/commands/StartAudienceGenerationJobCommand.js +51 -0
  27. package/dist-cjs/commands/TagResourceCommand.js +51 -0
  28. package/dist-cjs/commands/UntagResourceCommand.js +51 -0
  29. package/dist-cjs/commands/UpdateConfiguredAudienceModelCommand.js +51 -0
  30. package/dist-cjs/commands/index.js +28 -0
  31. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  32. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  33. package/dist-cjs/endpoint/ruleset.js +7 -0
  34. package/dist-cjs/extensionConfiguration.js +2 -0
  35. package/dist-cjs/index.js +12 -0
  36. package/dist-cjs/models/CleanRoomsMLServiceException.js +12 -0
  37. package/dist-cjs/models/index.js +4 -0
  38. package/dist-cjs/models/models_0.js +131 -0
  39. package/dist-cjs/pagination/Interfaces.js +2 -0
  40. package/dist-cjs/pagination/ListAudienceExportJobsPaginator.js +29 -0
  41. package/dist-cjs/pagination/ListAudienceGenerationJobsPaginator.js +29 -0
  42. package/dist-cjs/pagination/ListAudienceModelsPaginator.js +29 -0
  43. package/dist-cjs/pagination/ListConfiguredAudienceModelsPaginator.js +29 -0
  44. package/dist-cjs/pagination/ListTrainingDatasetsPaginator.js +29 -0
  45. package/dist-cjs/pagination/index.js +9 -0
  46. package/dist-cjs/protocols/Aws_restJson1.js +1835 -0
  47. package/dist-cjs/runtimeConfig.browser.js +39 -0
  48. package/dist-cjs/runtimeConfig.js +50 -0
  49. package/dist-cjs/runtimeConfig.native.js +15 -0
  50. package/dist-cjs/runtimeConfig.shared.js +24 -0
  51. package/dist-cjs/runtimeExtensions.js +22 -0
  52. package/dist-es/CleanRoomsML.js +57 -0
  53. package/dist-es/CleanRoomsMLClient.js +39 -0
  54. package/dist-es/commands/CreateAudienceModelCommand.js +47 -0
  55. package/dist-es/commands/CreateConfiguredAudienceModelCommand.js +47 -0
  56. package/dist-es/commands/CreateTrainingDatasetCommand.js +47 -0
  57. package/dist-es/commands/DeleteAudienceGenerationJobCommand.js +47 -0
  58. package/dist-es/commands/DeleteAudienceModelCommand.js +47 -0
  59. package/dist-es/commands/DeleteConfiguredAudienceModelCommand.js +47 -0
  60. package/dist-es/commands/DeleteConfiguredAudienceModelPolicyCommand.js +47 -0
  61. package/dist-es/commands/DeleteTrainingDatasetCommand.js +47 -0
  62. package/dist-es/commands/GetAudienceGenerationJobCommand.js +47 -0
  63. package/dist-es/commands/GetAudienceModelCommand.js +47 -0
  64. package/dist-es/commands/GetConfiguredAudienceModelCommand.js +47 -0
  65. package/dist-es/commands/GetConfiguredAudienceModelPolicyCommand.js +47 -0
  66. package/dist-es/commands/GetTrainingDatasetCommand.js +47 -0
  67. package/dist-es/commands/ListAudienceExportJobsCommand.js +47 -0
  68. package/dist-es/commands/ListAudienceGenerationJobsCommand.js +47 -0
  69. package/dist-es/commands/ListAudienceModelsCommand.js +47 -0
  70. package/dist-es/commands/ListConfiguredAudienceModelsCommand.js +47 -0
  71. package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
  72. package/dist-es/commands/ListTrainingDatasetsCommand.js +47 -0
  73. package/dist-es/commands/PutConfiguredAudienceModelPolicyCommand.js +47 -0
  74. package/dist-es/commands/StartAudienceExportJobCommand.js +47 -0
  75. package/dist-es/commands/StartAudienceGenerationJobCommand.js +47 -0
  76. package/dist-es/commands/TagResourceCommand.js +47 -0
  77. package/dist-es/commands/UntagResourceCommand.js +47 -0
  78. package/dist-es/commands/UpdateConfiguredAudienceModelCommand.js +47 -0
  79. package/dist-es/commands/index.js +25 -0
  80. package/dist-es/endpoint/EndpointParameters.js +8 -0
  81. package/dist-es/endpoint/endpointResolver.js +8 -0
  82. package/dist-es/endpoint/ruleset.js +4 -0
  83. package/dist-es/extensionConfiguration.js +1 -0
  84. package/dist-es/index.js +7 -0
  85. package/dist-es/models/CleanRoomsMLServiceException.js +8 -0
  86. package/dist-es/models/index.js +1 -0
  87. package/dist-es/models/models_0.js +123 -0
  88. package/dist-es/pagination/Interfaces.js +1 -0
  89. package/dist-es/pagination/ListAudienceExportJobsPaginator.js +25 -0
  90. package/dist-es/pagination/ListAudienceGenerationJobsPaginator.js +25 -0
  91. package/dist-es/pagination/ListAudienceModelsPaginator.js +25 -0
  92. package/dist-es/pagination/ListConfiguredAudienceModelsPaginator.js +25 -0
  93. package/dist-es/pagination/ListTrainingDatasetsPaginator.js +25 -0
  94. package/dist-es/pagination/index.js +6 -0
  95. package/dist-es/protocols/Aws_restJson1.js +1782 -0
  96. package/dist-es/runtimeConfig.browser.js +34 -0
  97. package/dist-es/runtimeConfig.js +45 -0
  98. package/dist-es/runtimeConfig.native.js +11 -0
  99. package/dist-es/runtimeConfig.shared.js +20 -0
  100. package/dist-es/runtimeExtensions.js +18 -0
  101. package/dist-types/CleanRoomsML.d.ts +185 -0
  102. package/dist-types/CleanRoomsMLClient.d.ts +194 -0
  103. package/dist-types/commands/CreateAudienceModelCommand.d.ts +96 -0
  104. package/dist-types/commands/CreateConfiguredAudienceModelCommand.d.ts +112 -0
  105. package/dist-types/commands/CreateTrainingDatasetCommand.d.ts +109 -0
  106. package/dist-types/commands/DeleteAudienceGenerationJobCommand.d.ts +83 -0
  107. package/dist-types/commands/DeleteAudienceModelCommand.d.ts +83 -0
  108. package/dist-types/commands/DeleteConfiguredAudienceModelCommand.d.ts +83 -0
  109. package/dist-types/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +80 -0
  110. package/dist-types/commands/DeleteTrainingDatasetCommand.d.ts +83 -0
  111. package/dist-types/commands/GetAudienceGenerationJobCommand.d.ts +115 -0
  112. package/dist-types/commands/GetAudienceModelCommand.d.ts +105 -0
  113. package/dist-types/commands/GetConfiguredAudienceModelCommand.d.ts +110 -0
  114. package/dist-types/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +84 -0
  115. package/dist-types/commands/GetTrainingDatasetCommand.d.ts +113 -0
  116. package/dist-types/commands/ListAudienceExportJobsCommand.d.ts +100 -0
  117. package/dist-types/commands/ListAudienceGenerationJobsCommand.d.ts +95 -0
  118. package/dist-types/commands/ListAudienceModelsCommand.d.ts +91 -0
  119. package/dist-types/commands/ListConfiguredAudienceModelsCommand.d.ts +99 -0
  120. package/dist-types/commands/ListTagsForResourceCommand.d.ts +84 -0
  121. package/dist-types/commands/ListTrainingDatasetsCommand.d.ts +90 -0
  122. package/dist-types/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +86 -0
  123. package/dist-types/commands/StartAudienceExportJobCommand.d.ts +92 -0
  124. package/dist-types/commands/StartAudienceGenerationJobCommand.d.ts +101 -0
  125. package/dist-types/commands/TagResourceCommand.d.ts +83 -0
  126. package/dist-types/commands/UntagResourceCommand.d.ts +83 -0
  127. package/dist-types/commands/UpdateConfiguredAudienceModelCommand.d.ts +105 -0
  128. package/dist-types/commands/index.d.ts +25 -0
  129. package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
  130. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  131. package/dist-types/endpoint/ruleset.d.ts +2 -0
  132. package/dist-types/extensionConfiguration.d.ts +8 -0
  133. package/dist-types/index.d.ts +15 -0
  134. package/dist-types/models/CleanRoomsMLServiceException.d.ts +13 -0
  135. package/dist-types/models/index.d.ts +1 -0
  136. package/dist-types/models/models_0.d.ts +1729 -0
  137. package/dist-types/pagination/Interfaces.d.ts +8 -0
  138. package/dist-types/pagination/ListAudienceExportJobsPaginator.d.ts +7 -0
  139. package/dist-types/pagination/ListAudienceGenerationJobsPaginator.d.ts +7 -0
  140. package/dist-types/pagination/ListAudienceModelsPaginator.d.ts +7 -0
  141. package/dist-types/pagination/ListConfiguredAudienceModelsPaginator.d.ts +7 -0
  142. package/dist-types/pagination/ListTrainingDatasetsPaginator.d.ts +7 -0
  143. package/dist-types/pagination/index.d.ts +6 -0
  144. package/dist-types/protocols/Aws_restJson1.d.ts +227 -0
  145. package/dist-types/runtimeConfig.browser.d.ts +46 -0
  146. package/dist-types/runtimeConfig.d.ts +46 -0
  147. package/dist-types/runtimeConfig.native.d.ts +45 -0
  148. package/dist-types/runtimeConfig.shared.d.ts +19 -0
  149. package/dist-types/runtimeExtensions.d.ts +17 -0
  150. package/dist-types/ts3.4/CleanRoomsML.d.ts +438 -0
  151. package/dist-types/ts3.4/CleanRoomsMLClient.d.ts +269 -0
  152. package/dist-types/ts3.4/commands/CreateAudienceModelCommand.d.ts +39 -0
  153. package/dist-types/ts3.4/commands/CreateConfiguredAudienceModelCommand.d.ts +42 -0
  154. package/dist-types/ts3.4/commands/CreateTrainingDatasetCommand.d.ts +42 -0
  155. package/dist-types/ts3.4/commands/DeleteAudienceGenerationJobCommand.d.ts +38 -0
  156. package/dist-types/ts3.4/commands/DeleteAudienceModelCommand.d.ts +34 -0
  157. package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelCommand.d.ts +38 -0
  158. package/dist-types/ts3.4/commands/DeleteConfiguredAudienceModelPolicyCommand.d.ts +38 -0
  159. package/dist-types/ts3.4/commands/DeleteTrainingDatasetCommand.d.ts +37 -0
  160. package/dist-types/ts3.4/commands/GetAudienceGenerationJobCommand.d.ts +42 -0
  161. package/dist-types/ts3.4/commands/GetAudienceModelCommand.d.ts +38 -0
  162. package/dist-types/ts3.4/commands/GetConfiguredAudienceModelCommand.d.ts +42 -0
  163. package/dist-types/ts3.4/commands/GetConfiguredAudienceModelPolicyCommand.d.ts +42 -0
  164. package/dist-types/ts3.4/commands/GetTrainingDatasetCommand.d.ts +39 -0
  165. package/dist-types/ts3.4/commands/ListAudienceExportJobsCommand.d.ts +42 -0
  166. package/dist-types/ts3.4/commands/ListAudienceGenerationJobsCommand.d.ts +42 -0
  167. package/dist-types/ts3.4/commands/ListAudienceModelsCommand.d.ts +39 -0
  168. package/dist-types/ts3.4/commands/ListConfiguredAudienceModelsCommand.d.ts +42 -0
  169. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  170. package/dist-types/ts3.4/commands/ListTrainingDatasetsCommand.d.ts +42 -0
  171. package/dist-types/ts3.4/commands/PutConfiguredAudienceModelPolicyCommand.d.ts +42 -0
  172. package/dist-types/ts3.4/commands/StartAudienceExportJobCommand.d.ts +37 -0
  173. package/dist-types/ts3.4/commands/StartAudienceGenerationJobCommand.d.ts +42 -0
  174. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
  175. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
  176. package/dist-types/ts3.4/commands/UpdateConfiguredAudienceModelCommand.d.ts +42 -0
  177. package/dist-types/ts3.4/commands/index.d.ts +25 -0
  178. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
  179. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  180. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  181. package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
  182. package/dist-types/ts3.4/index.d.ts +10 -0
  183. package/dist-types/ts3.4/models/CleanRoomsMLServiceException.d.ts +8 -0
  184. package/dist-types/ts3.4/models/index.d.ts +1 -0
  185. package/dist-types/ts3.4/models/models_0.d.ts +453 -0
  186. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  187. package/dist-types/ts3.4/pagination/ListAudienceExportJobsPaginator.d.ts +11 -0
  188. package/dist-types/ts3.4/pagination/ListAudienceGenerationJobsPaginator.d.ts +11 -0
  189. package/dist-types/ts3.4/pagination/ListAudienceModelsPaginator.d.ts +11 -0
  190. package/dist-types/ts3.4/pagination/ListConfiguredAudienceModelsPaginator.d.ts +11 -0
  191. package/dist-types/ts3.4/pagination/ListTrainingDatasetsPaginator.d.ts +11 -0
  192. package/dist-types/ts3.4/pagination/index.d.ts +6 -0
  193. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +305 -0
  194. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
  195. package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
  196. package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
  197. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
  198. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  199. package/package.json +102 -0
@@ -0,0 +1,1729 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { CleanRoomsMLServiceException as __BaseException } from "./CleanRoomsMLServiceException";
3
+ /**
4
+ * @public
5
+ * <p>You do not have sufficient access to perform this action.</p>
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
15
+ /**
16
+ * @public
17
+ * <p>Provides information about an Amazon S3 bucket and path.</p>
18
+ */
19
+ export interface S3ConfigMap {
20
+ /**
21
+ * @public
22
+ * <p>The Amazon S3 location URI.</p>
23
+ */
24
+ s3Uri: string | undefined;
25
+ }
26
+ /**
27
+ * @public
28
+ * <p>Defines the Amazon S3 bucket where the configured audience is stored.</p>
29
+ */
30
+ export interface AudienceDestination {
31
+ /**
32
+ * @public
33
+ * <p>The Amazon S3 bucket and path for the configured audience.</p>
34
+ */
35
+ s3Destination: S3ConfigMap | undefined;
36
+ }
37
+ /**
38
+ * @public
39
+ */
40
+ export interface ListAudienceExportJobsRequest {
41
+ /**
42
+ * @public
43
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
44
+ */
45
+ nextToken?: string;
46
+ /**
47
+ * @public
48
+ * <p>The maximum size of the results that is returned per call.</p>
49
+ */
50
+ maxResults?: number;
51
+ /**
52
+ * @public
53
+ * <p>The Amazon Resource Name (ARN) of the audience generation job that you are interested in.</p>
54
+ */
55
+ audienceGenerationJobArn?: string;
56
+ }
57
+ /**
58
+ * @public
59
+ * @enum
60
+ */
61
+ export declare const AudienceSizeType: {
62
+ readonly ABSOLUTE: "ABSOLUTE";
63
+ readonly PERCENTAGE: "PERCENTAGE";
64
+ };
65
+ /**
66
+ * @public
67
+ */
68
+ export type AudienceSizeType = (typeof AudienceSizeType)[keyof typeof AudienceSizeType];
69
+ /**
70
+ * @public
71
+ * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
72
+ */
73
+ export interface AudienceSize {
74
+ /**
75
+ * @public
76
+ * <p>Whether the audience size is defined in absolute terms or as a percentage. You can use the <code>ABSOLUTE</code>
77
+ * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
78
+ * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
79
+ */
80
+ type: AudienceSizeType | undefined;
81
+ /**
82
+ * @public
83
+ * <p>Specify an audience size value.</p>
84
+ */
85
+ value: number | undefined;
86
+ }
87
+ /**
88
+ * @public
89
+ * @enum
90
+ */
91
+ export declare const AudienceExportJobStatus: {
92
+ readonly ACTIVE: "ACTIVE";
93
+ readonly CREATE_FAILED: "CREATE_FAILED";
94
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
95
+ readonly CREATE_PENDING: "CREATE_PENDING";
96
+ };
97
+ /**
98
+ * @public
99
+ */
100
+ export type AudienceExportJobStatus = (typeof AudienceExportJobStatus)[keyof typeof AudienceExportJobStatus];
101
+ /**
102
+ * @public
103
+ * <p>Details about the status of a resource.</p>
104
+ */
105
+ export interface StatusDetails {
106
+ /**
107
+ * @public
108
+ * <p>The status code that was returned. The status code is intended for programmatic error handling. Clean Rooms ML will not change the status code for existing error conditions.</p>
109
+ */
110
+ statusCode?: string;
111
+ /**
112
+ * @public
113
+ * <p>The error message that was returned. The message is intended for human consumption and can change at any time. Use the <code>statusCode</code> for programmatic error handling.</p>
114
+ */
115
+ message?: string;
116
+ }
117
+ /**
118
+ * @public
119
+ * <p>Provides information about the audience export job.</p>
120
+ */
121
+ export interface AudienceExportJobSummary {
122
+ /**
123
+ * @public
124
+ * <p>The time at which the audience export job was created.</p>
125
+ */
126
+ createTime: Date | undefined;
127
+ /**
128
+ * @public
129
+ * <p>The most recent time at which the audience export job was updated.</p>
130
+ */
131
+ updateTime: Date | undefined;
132
+ /**
133
+ * @public
134
+ * <p>The name of the audience export job.</p>
135
+ */
136
+ name: string | undefined;
137
+ /**
138
+ * @public
139
+ * <p>The Amazon Resource Name (ARN) of the audience generation job that was exported.</p>
140
+ */
141
+ audienceGenerationJobArn: string | undefined;
142
+ /**
143
+ * @public
144
+ * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
145
+ */
146
+ audienceSize: AudienceSize | undefined;
147
+ /**
148
+ * @public
149
+ * <p>The description of the audience export job.</p>
150
+ */
151
+ description?: string;
152
+ /**
153
+ * @public
154
+ * <p>The status of the audience export job.</p>
155
+ */
156
+ status: AudienceExportJobStatus | undefined;
157
+ /**
158
+ * @public
159
+ * <p>Details about the status of a resource.</p>
160
+ */
161
+ statusDetails?: StatusDetails;
162
+ /**
163
+ * @public
164
+ * <p>The Amazon S3 bucket where the audience export is stored.</p>
165
+ */
166
+ outputLocation?: string;
167
+ }
168
+ /**
169
+ * @public
170
+ */
171
+ export interface ListAudienceExportJobsResponse {
172
+ /**
173
+ * @public
174
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
175
+ */
176
+ nextToken?: string;
177
+ /**
178
+ * @public
179
+ * <p>The audience export jobs that match the request.</p>
180
+ */
181
+ audienceExportJobs: AudienceExportJobSummary[] | undefined;
182
+ }
183
+ /**
184
+ * @public
185
+ * <p>The request parameters for this request are incorrect.</p>
186
+ */
187
+ export declare class ValidationException extends __BaseException {
188
+ readonly name: "ValidationException";
189
+ readonly $fault: "client";
190
+ /**
191
+ * @internal
192
+ */
193
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
194
+ }
195
+ /**
196
+ * @public
197
+ * <p>A resource with that name already exists in this region.</p>
198
+ */
199
+ export declare class ConflictException extends __BaseException {
200
+ readonly name: "ConflictException";
201
+ readonly $fault: "client";
202
+ /**
203
+ * @internal
204
+ */
205
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
206
+ }
207
+ /**
208
+ * @public
209
+ * <p>The resource you are requesting does not exist.</p>
210
+ */
211
+ export declare class ResourceNotFoundException extends __BaseException {
212
+ readonly name: "ResourceNotFoundException";
213
+ readonly $fault: "client";
214
+ /**
215
+ * @internal
216
+ */
217
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
218
+ }
219
+ /**
220
+ * @public
221
+ * <p>You have exceeded your service quota.</p>
222
+ */
223
+ export declare class ServiceQuotaExceededException extends __BaseException {
224
+ readonly name: "ServiceQuotaExceededException";
225
+ readonly $fault: "client";
226
+ /**
227
+ * @internal
228
+ */
229
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
230
+ }
231
+ /**
232
+ * @public
233
+ */
234
+ export interface StartAudienceExportJobRequest {
235
+ /**
236
+ * @public
237
+ * <p>The name of the audience export job.</p>
238
+ */
239
+ name: string | undefined;
240
+ /**
241
+ * @public
242
+ * <p>The Amazon Resource Name (ARN) of the audience generation job that you want to export.</p>
243
+ */
244
+ audienceGenerationJobArn: string | undefined;
245
+ /**
246
+ * @public
247
+ * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
248
+ */
249
+ audienceSize: AudienceSize | undefined;
250
+ /**
251
+ * @public
252
+ * <p>The description of the audience export job.</p>
253
+ */
254
+ description?: string;
255
+ }
256
+ /**
257
+ * @public
258
+ */
259
+ export interface DeleteAudienceGenerationJobRequest {
260
+ /**
261
+ * @public
262
+ * <p>The Amazon Resource Name (ARN) of the audience generation job that you want to delete.</p>
263
+ */
264
+ audienceGenerationJobArn: string | undefined;
265
+ }
266
+ /**
267
+ * @public
268
+ */
269
+ export interface GetAudienceGenerationJobRequest {
270
+ /**
271
+ * @public
272
+ * <p>The Amazon Resource Name (ARN) of the audience generation job that you are interested in.</p>
273
+ */
274
+ audienceGenerationJobArn: string | undefined;
275
+ }
276
+ /**
277
+ * @public
278
+ * <p>The relevance score of a generated audience.</p>
279
+ */
280
+ export interface RelevanceMetric {
281
+ /**
282
+ * @public
283
+ * <p>The size of the generated audience. Must match one of the sizes in the configured audience model.</p>
284
+ */
285
+ audienceSize: AudienceSize | undefined;
286
+ /**
287
+ * @public
288
+ * <p>The relevance score of the generated audience.</p>
289
+ */
290
+ score?: number;
291
+ }
292
+ /**
293
+ * @public
294
+ * <p>Metrics that describe the quality of the generated audience.</p>
295
+ */
296
+ export interface AudienceQualityMetrics {
297
+ /**
298
+ * @public
299
+ * <p>The relevance scores of the generated audience.</p>
300
+ */
301
+ relevanceMetrics: RelevanceMetric[] | undefined;
302
+ }
303
+ /**
304
+ * @public
305
+ * <p>Defines the Amazon S3 bucket where the training data for the configured audience is stored.</p>
306
+ */
307
+ export interface AudienceGenerationJobDataSource {
308
+ /**
309
+ * @public
310
+ * <p>The Amazon S3 bucket where the training data for the configured audience is stored.</p>
311
+ */
312
+ dataSource: S3ConfigMap | undefined;
313
+ /**
314
+ * @public
315
+ * <p>The ARN of the IAM role that can read the Amazon S3 bucket where the training data is stored.</p>
316
+ */
317
+ roleArn: string | undefined;
318
+ }
319
+ /**
320
+ * @public
321
+ * @enum
322
+ */
323
+ export declare const AudienceGenerationJobStatus: {
324
+ readonly ACTIVE: "ACTIVE";
325
+ readonly CREATE_FAILED: "CREATE_FAILED";
326
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
327
+ readonly CREATE_PENDING: "CREATE_PENDING";
328
+ readonly DELETE_FAILED: "DELETE_FAILED";
329
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
330
+ readonly DELETE_PENDING: "DELETE_PENDING";
331
+ };
332
+ /**
333
+ * @public
334
+ */
335
+ export type AudienceGenerationJobStatus = (typeof AudienceGenerationJobStatus)[keyof typeof AudienceGenerationJobStatus];
336
+ /**
337
+ * @public
338
+ */
339
+ export interface GetAudienceGenerationJobResponse {
340
+ /**
341
+ * @public
342
+ * <p>The time at which the audience generation job was created.</p>
343
+ */
344
+ createTime: Date | undefined;
345
+ /**
346
+ * @public
347
+ * <p>The most recent time at which the audience generation job was updated.</p>
348
+ */
349
+ updateTime: Date | undefined;
350
+ /**
351
+ * @public
352
+ * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
353
+ */
354
+ audienceGenerationJobArn: string | undefined;
355
+ /**
356
+ * @public
357
+ * <p>The name of the audience generation job.</p>
358
+ */
359
+ name: string | undefined;
360
+ /**
361
+ * @public
362
+ * <p>The description of the audience generation job.</p>
363
+ */
364
+ description?: string;
365
+ /**
366
+ * @public
367
+ * <p>The status of the audience generation job.</p>
368
+ */
369
+ status: AudienceGenerationJobStatus | undefined;
370
+ /**
371
+ * @public
372
+ * <p>Details about the status of the audience generation job.</p>
373
+ */
374
+ statusDetails?: StatusDetails;
375
+ /**
376
+ * @public
377
+ * <p>The Amazon Resource Name (ARN) of the configured audience model used for this audience generation job.</p>
378
+ */
379
+ configuredAudienceModelArn: string | undefined;
380
+ /**
381
+ * @public
382
+ * <p>The seed audience that was used for this audience generation job. This field will be null if the account calling the API is the account that started this audience generation job. </p>
383
+ */
384
+ seedAudience?: AudienceGenerationJobDataSource;
385
+ /**
386
+ * @public
387
+ * <p>Configure whether the seed users are included in the output audience. By default, Clean Rooms ML removes seed users from the output audience. If you specify <code>TRUE</code>, the seed users will appear first in the output. Clean Rooms ML does not explicitly reveal whether a user was in the seed, but the recipient of the audience will know that the first <code>minimumSeedSize</code> count of users are from the seed.</p>
388
+ */
389
+ includeSeedInOutput?: boolean;
390
+ /**
391
+ * @public
392
+ * <p>The identifier of the collaboration that this audience generation job is associated with.</p>
393
+ */
394
+ collaborationId?: string;
395
+ /**
396
+ * @public
397
+ * <p>The relevance scores for different audience sizes. </p>
398
+ */
399
+ metrics?: AudienceQualityMetrics;
400
+ /**
401
+ * @public
402
+ * <p>The AWS account that started this audience generation job.</p>
403
+ */
404
+ startedBy?: string;
405
+ /**
406
+ * @public
407
+ * <p>The tags that are associated to this audience generation job.</p>
408
+ */
409
+ tags?: Record<string, string>;
410
+ }
411
+ /**
412
+ * @public
413
+ */
414
+ export interface ListAudienceGenerationJobsRequest {
415
+ /**
416
+ * @public
417
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
418
+ */
419
+ nextToken?: string;
420
+ /**
421
+ * @public
422
+ * <p>The maximum size of the results that is returned per call.</p>
423
+ */
424
+ maxResults?: number;
425
+ /**
426
+ * @public
427
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that was used for the audience generation jobs that you are interested in.</p>
428
+ */
429
+ configuredAudienceModelArn?: string;
430
+ /**
431
+ * @public
432
+ * <p>The identifier of the collaboration that contains the audience generation jobs that you are interested in.</p>
433
+ */
434
+ collaborationId?: string;
435
+ }
436
+ /**
437
+ * @public
438
+ * <p>Provides information about the configured audience generation job.</p>
439
+ */
440
+ export interface AudienceGenerationJobSummary {
441
+ /**
442
+ * @public
443
+ * <p>The time at which the audience generation job was created.</p>
444
+ */
445
+ createTime: Date | undefined;
446
+ /**
447
+ * @public
448
+ * <p>The most recent time at which the audience generation job was updated.</p>
449
+ */
450
+ updateTime: Date | undefined;
451
+ /**
452
+ * @public
453
+ * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
454
+ */
455
+ audienceGenerationJobArn: string | undefined;
456
+ /**
457
+ * @public
458
+ * <p>The name of the audience generation job.</p>
459
+ */
460
+ name: string | undefined;
461
+ /**
462
+ * @public
463
+ * <p>The description of the audience generation job.</p>
464
+ */
465
+ description?: string;
466
+ /**
467
+ * @public
468
+ * <p>The status of the audience generation job.</p>
469
+ */
470
+ status: AudienceGenerationJobStatus | undefined;
471
+ /**
472
+ * @public
473
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that was used for this audience generation job.</p>
474
+ */
475
+ configuredAudienceModelArn: string | undefined;
476
+ /**
477
+ * @public
478
+ * <p>The identifier of the collaboration that contains this audience generation job.</p>
479
+ */
480
+ collaborationId?: string;
481
+ /**
482
+ * @public
483
+ * <p>The AWS Account that submitted the job.</p>
484
+ */
485
+ startedBy?: string;
486
+ }
487
+ /**
488
+ * @public
489
+ */
490
+ export interface ListAudienceGenerationJobsResponse {
491
+ /**
492
+ * @public
493
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
494
+ */
495
+ nextToken?: string;
496
+ /**
497
+ * @public
498
+ * <p>The audience generation jobs that match the request.</p>
499
+ */
500
+ audienceGenerationJobs: AudienceGenerationJobSummary[] | undefined;
501
+ }
502
+ /**
503
+ * @public
504
+ */
505
+ export interface StartAudienceGenerationJobRequest {
506
+ /**
507
+ * @public
508
+ * <p>The name of the audience generation job.</p>
509
+ */
510
+ name: string | undefined;
511
+ /**
512
+ * @public
513
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.</p>
514
+ */
515
+ configuredAudienceModelArn: string | undefined;
516
+ /**
517
+ * @public
518
+ * <p>The seed audience that is used to generate the audience.</p>
519
+ */
520
+ seedAudience: AudienceGenerationJobDataSource | undefined;
521
+ /**
522
+ * @public
523
+ * <p>Whether the seed audience is included in the audience generation output.</p>
524
+ */
525
+ includeSeedInOutput?: boolean;
526
+ /**
527
+ * @public
528
+ * <p>The identifier of the collaboration that contains the audience generation job.</p>
529
+ */
530
+ collaborationId?: string;
531
+ /**
532
+ * @public
533
+ * <p>The description of the audience generation job.</p>
534
+ */
535
+ description?: string;
536
+ /**
537
+ * @public
538
+ * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
539
+ * <p>The following basic restrictions apply to tags:</p>
540
+ * <ul>
541
+ * <li>
542
+ * <p>Maximum number of tags per resource - 50.</p>
543
+ * </li>
544
+ * <li>
545
+ * <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
546
+ * </li>
547
+ * <li>
548
+ * <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
549
+ * </li>
550
+ * <li>
551
+ * <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
552
+ * </li>
553
+ * <li>
554
+ * <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p>
555
+ * </li>
556
+ * <li>
557
+ * <p>Tag keys and values are case sensitive.</p>
558
+ * </li>
559
+ * <li>
560
+ * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
561
+ * </li>
562
+ * </ul>
563
+ */
564
+ tags?: Record<string, string>;
565
+ }
566
+ /**
567
+ * @public
568
+ */
569
+ export interface StartAudienceGenerationJobResponse {
570
+ /**
571
+ * @public
572
+ * <p>The Amazon Resource Name (ARN) of the audience generation job.</p>
573
+ */
574
+ audienceGenerationJobArn: string | undefined;
575
+ }
576
+ /**
577
+ * @public
578
+ */
579
+ export interface CreateAudienceModelRequest {
580
+ /**
581
+ * @public
582
+ * <p>The start date and time of the training window.</p>
583
+ */
584
+ trainingDataStartTime?: Date;
585
+ /**
586
+ * @public
587
+ * <p>The end date and time of the training window.</p>
588
+ */
589
+ trainingDataEndTime?: Date;
590
+ /**
591
+ * @public
592
+ * <p>The name of the audience model resource.</p>
593
+ */
594
+ name: string | undefined;
595
+ /**
596
+ * @public
597
+ * <p>The Amazon Resource Name (ARN) of the training dataset for this audience model.</p>
598
+ */
599
+ trainingDatasetArn: string | undefined;
600
+ /**
601
+ * @public
602
+ * <p>The Amazon Resource Name (ARN) of the KMS key. This key is used to encrypt and decrypt customer-owned data in the trained ML model and the associated data.</p>
603
+ */
604
+ kmsKeyArn?: string;
605
+ /**
606
+ * @public
607
+ * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
608
+ * <p>The following basic restrictions apply to tags:</p>
609
+ * <ul>
610
+ * <li>
611
+ * <p>Maximum number of tags per resource - 50.</p>
612
+ * </li>
613
+ * <li>
614
+ * <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
615
+ * </li>
616
+ * <li>
617
+ * <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
618
+ * </li>
619
+ * <li>
620
+ * <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
621
+ * </li>
622
+ * <li>
623
+ * <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p>
624
+ * </li>
625
+ * <li>
626
+ * <p>Tag keys and values are case sensitive.</p>
627
+ * </li>
628
+ * <li>
629
+ * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
630
+ * </li>
631
+ * </ul>
632
+ */
633
+ tags?: Record<string, string>;
634
+ /**
635
+ * @public
636
+ * <p>The description of the audience model.</p>
637
+ */
638
+ description?: string;
639
+ }
640
+ /**
641
+ * @public
642
+ */
643
+ export interface CreateAudienceModelResponse {
644
+ /**
645
+ * @public
646
+ * <p>The Amazon Resource Name (ARN) of the audience model.</p>
647
+ */
648
+ audienceModelArn: string | undefined;
649
+ }
650
+ /**
651
+ * @public
652
+ */
653
+ export interface DeleteAudienceModelRequest {
654
+ /**
655
+ * @public
656
+ * <p>The Amazon Resource Name (ARN) of the audience model that you want to delete.</p>
657
+ */
658
+ audienceModelArn: string | undefined;
659
+ }
660
+ /**
661
+ * @public
662
+ */
663
+ export interface GetAudienceModelRequest {
664
+ /**
665
+ * @public
666
+ * <p>The Amazon Resource Name (ARN) of the audience model that you are interested in.</p>
667
+ */
668
+ audienceModelArn: string | undefined;
669
+ }
670
+ /**
671
+ * @public
672
+ * @enum
673
+ */
674
+ export declare const AudienceModelMetricType: {
675
+ readonly MEAN_RECIPROCAL_RANK: "MEAN_RECIPROCAL_RANK";
676
+ readonly NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN: "NORMALIZED_DISCOUNTED_CUMULATIVE_GAIN";
677
+ readonly PRECISION: "PRECISION";
678
+ readonly RECALL: "RECALL";
679
+ };
680
+ /**
681
+ * @public
682
+ */
683
+ export type AudienceModelMetricType = (typeof AudienceModelMetricType)[keyof typeof AudienceModelMetricType];
684
+ /**
685
+ * @public
686
+ * <p>The audience model metrics.</p>
687
+ */
688
+ export interface AudienceModelMetric {
689
+ /**
690
+ * @public
691
+ * <p>The audience model metric.</p>
692
+ */
693
+ type: AudienceModelMetricType | undefined;
694
+ /**
695
+ * @public
696
+ * <p>The number of users that were used to generate these model metrics.</p>
697
+ */
698
+ forTopKItemPredictions: number | undefined;
699
+ /**
700
+ * @public
701
+ * <p>The value of the audience model metric</p>
702
+ */
703
+ value: number | undefined;
704
+ }
705
+ /**
706
+ * @public
707
+ * @enum
708
+ */
709
+ export declare const AudienceModelStatus: {
710
+ readonly ACTIVE: "ACTIVE";
711
+ readonly CREATE_FAILED: "CREATE_FAILED";
712
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
713
+ readonly CREATE_PENDING: "CREATE_PENDING";
714
+ readonly DELETE_FAILED: "DELETE_FAILED";
715
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
716
+ readonly DELETE_PENDING: "DELETE_PENDING";
717
+ };
718
+ /**
719
+ * @public
720
+ */
721
+ export type AudienceModelStatus = (typeof AudienceModelStatus)[keyof typeof AudienceModelStatus];
722
+ /**
723
+ * @public
724
+ */
725
+ export interface GetAudienceModelResponse {
726
+ /**
727
+ * @public
728
+ * <p>The time at which the audience model was created.</p>
729
+ */
730
+ createTime: Date | undefined;
731
+ /**
732
+ * @public
733
+ * <p>The most recent time at which the audience model was updated.</p>
734
+ */
735
+ updateTime: Date | undefined;
736
+ /**
737
+ * @public
738
+ * <p>The start date specified for the training window.</p>
739
+ */
740
+ trainingDataStartTime?: Date;
741
+ /**
742
+ * @public
743
+ * <p>The end date specified for the training window.</p>
744
+ */
745
+ trainingDataEndTime?: Date;
746
+ /**
747
+ * @public
748
+ * <p>The Amazon Resource Name (ARN) of the audience model.</p>
749
+ */
750
+ audienceModelArn: string | undefined;
751
+ /**
752
+ * @public
753
+ * <p>The name of the audience model.</p>
754
+ */
755
+ name: string | undefined;
756
+ /**
757
+ * @public
758
+ * <p>The Amazon Resource Name (ARN) of the training dataset that was used for this audience model.</p>
759
+ */
760
+ trainingDatasetArn: string | undefined;
761
+ /**
762
+ * @public
763
+ * <p>The status of the audience model.</p>
764
+ */
765
+ status: AudienceModelStatus | undefined;
766
+ /**
767
+ * @public
768
+ * <p>Details about the status of the audience model.</p>
769
+ */
770
+ statusDetails?: StatusDetails;
771
+ /**
772
+ * @public
773
+ * <p>Accuracy metrics for the model.</p>
774
+ */
775
+ metrics?: AudienceModelMetric[];
776
+ /**
777
+ * @public
778
+ * <p>The KMS key ARN used for the audience model.</p>
779
+ */
780
+ kmsKeyArn?: string;
781
+ /**
782
+ * @public
783
+ * <p>The tags that are assigned to the audience model.</p>
784
+ */
785
+ tags?: Record<string, string>;
786
+ /**
787
+ * @public
788
+ * <p>The description of the audience model.</p>
789
+ */
790
+ description?: string;
791
+ }
792
+ /**
793
+ * @public
794
+ */
795
+ export interface ListAudienceModelsRequest {
796
+ /**
797
+ * @public
798
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
799
+ */
800
+ nextToken?: string;
801
+ /**
802
+ * @public
803
+ * <p>The maximum size of the results that is returned per call.</p>
804
+ */
805
+ maxResults?: number;
806
+ }
807
+ /**
808
+ * @public
809
+ * <p>Information about the audience model.</p>
810
+ */
811
+ export interface AudienceModelSummary {
812
+ /**
813
+ * @public
814
+ * <p>The time at which the audience model was created.</p>
815
+ */
816
+ createTime: Date | undefined;
817
+ /**
818
+ * @public
819
+ * <p>The most recent time at which the audience model was updated.</p>
820
+ */
821
+ updateTime: Date | undefined;
822
+ /**
823
+ * @public
824
+ * <p>The Amazon Resource Name (ARN) of the audience model.</p>
825
+ */
826
+ audienceModelArn: string | undefined;
827
+ /**
828
+ * @public
829
+ * <p>The name of the audience model.</p>
830
+ */
831
+ name: string | undefined;
832
+ /**
833
+ * @public
834
+ * <p>The Amazon Resource Name (ARN) of the training dataset that was used for the audience model.</p>
835
+ */
836
+ trainingDatasetArn: string | undefined;
837
+ /**
838
+ * @public
839
+ * <p>The status of the audience model.</p>
840
+ */
841
+ status: AudienceModelStatus | undefined;
842
+ /**
843
+ * @public
844
+ * <p>The description of the audience model.</p>
845
+ */
846
+ description?: string;
847
+ }
848
+ /**
849
+ * @public
850
+ */
851
+ export interface ListAudienceModelsResponse {
852
+ /**
853
+ * @public
854
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
855
+ */
856
+ nextToken?: string;
857
+ /**
858
+ * @public
859
+ * <p>The audience models that match the request.</p>
860
+ */
861
+ audienceModels: AudienceModelSummary[] | undefined;
862
+ }
863
+ /**
864
+ * @public
865
+ * <p>Configure the list of audience output sizes that can be created. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
866
+ * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
867
+ * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
868
+ */
869
+ export interface AudienceSizeConfig {
870
+ /**
871
+ * @public
872
+ * <p>Whether the audience output sizes are defined as an absolute number or a percentage.</p>
873
+ */
874
+ audienceSizeType: AudienceSizeType | undefined;
875
+ /**
876
+ * @public
877
+ * <p>An array of the different audience output sizes.</p>
878
+ */
879
+ audienceSizeBins: number[] | undefined;
880
+ }
881
+ /**
882
+ * @public
883
+ * @enum
884
+ */
885
+ export declare const TagOnCreatePolicy: {
886
+ readonly FROM_PARENT_RESOURCE: "FROM_PARENT_RESOURCE";
887
+ readonly NONE: "NONE";
888
+ };
889
+ /**
890
+ * @public
891
+ */
892
+ export type TagOnCreatePolicy = (typeof TagOnCreatePolicy)[keyof typeof TagOnCreatePolicy];
893
+ /**
894
+ * @public
895
+ * <p>Configuration information necessary for the configure audience model output.</p>
896
+ */
897
+ export interface ConfiguredAudienceModelOutputConfig {
898
+ /**
899
+ * @public
900
+ * <p>Defines the Amazon S3 bucket where the configured audience is stored.</p>
901
+ */
902
+ destination: AudienceDestination | undefined;
903
+ /**
904
+ * @public
905
+ * <p>The ARN of the IAM role that can write the Amazon S3 bucket.</p>
906
+ */
907
+ roleArn: string | undefined;
908
+ }
909
+ /**
910
+ * @public
911
+ * @enum
912
+ */
913
+ export declare const SharedAudienceMetrics: {
914
+ readonly ALL: "ALL";
915
+ readonly NONE: "NONE";
916
+ };
917
+ /**
918
+ * @public
919
+ */
920
+ export type SharedAudienceMetrics = (typeof SharedAudienceMetrics)[keyof typeof SharedAudienceMetrics];
921
+ /**
922
+ * @public
923
+ */
924
+ export interface CreateConfiguredAudienceModelRequest {
925
+ /**
926
+ * @public
927
+ * <p>The name of the configured audience model.</p>
928
+ */
929
+ name: string | undefined;
930
+ /**
931
+ * @public
932
+ * <p>The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.</p>
933
+ */
934
+ audienceModelArn: string | undefined;
935
+ /**
936
+ * @public
937
+ * <p>Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have <code>s3:PutObject</code> permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.</p>
938
+ */
939
+ outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
940
+ /**
941
+ * @public
942
+ * <p>The description of the configured audience model.</p>
943
+ */
944
+ description?: string;
945
+ /**
946
+ * @public
947
+ * <p>Whether audience metrics are shared.</p>
948
+ */
949
+ sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
950
+ /**
951
+ * @public
952
+ * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
953
+ */
954
+ minMatchingSeedSize?: number;
955
+ /**
956
+ * @public
957
+ * <p>Configure the list of output sizes of audiences that can be created using this configured audience model. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
958
+ * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
959
+ * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
960
+ */
961
+ audienceSizeConfig?: AudienceSizeConfig;
962
+ /**
963
+ * @public
964
+ * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
965
+ * <p>The following basic restrictions apply to tags:</p>
966
+ * <ul>
967
+ * <li>
968
+ * <p>Maximum number of tags per resource - 50.</p>
969
+ * </li>
970
+ * <li>
971
+ * <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
972
+ * </li>
973
+ * <li>
974
+ * <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
975
+ * </li>
976
+ * <li>
977
+ * <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
978
+ * </li>
979
+ * <li>
980
+ * <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p>
981
+ * </li>
982
+ * <li>
983
+ * <p>Tag keys and values are case sensitive.</p>
984
+ * </li>
985
+ * <li>
986
+ * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
987
+ * </li>
988
+ * </ul>
989
+ */
990
+ tags?: Record<string, string>;
991
+ /**
992
+ * @public
993
+ * <p>Configure how the service tags audience generation jobs created using this configured audience model. If you specify <code>NONE</code>, the tags from the <a>StartAudienceGenerationJob</a> request determine the tags of the audience generation job. If you specify <code>FROM_PARENT_RESOURCE</code>, the audience generation job inherits the tags from the configured audience model, by default. Tags in the <a>StartAudienceGenerationJob</a> will override the default.</p>
994
+ */
995
+ childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
996
+ }
997
+ /**
998
+ * @public
999
+ */
1000
+ export interface CreateConfiguredAudienceModelResponse {
1001
+ /**
1002
+ * @public
1003
+ * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1004
+ */
1005
+ configuredAudienceModelArn: string | undefined;
1006
+ }
1007
+ /**
1008
+ * @public
1009
+ */
1010
+ export interface DeleteConfiguredAudienceModelRequest {
1011
+ /**
1012
+ * @public
1013
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that you want to delete.</p>
1014
+ */
1015
+ configuredAudienceModelArn: string | undefined;
1016
+ }
1017
+ /**
1018
+ * @public
1019
+ */
1020
+ export interface GetConfiguredAudienceModelRequest {
1021
+ /**
1022
+ * @public
1023
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1024
+ */
1025
+ configuredAudienceModelArn: string | undefined;
1026
+ }
1027
+ /**
1028
+ * @public
1029
+ * @enum
1030
+ */
1031
+ export declare const ConfiguredAudienceModelStatus: {
1032
+ readonly ACTIVE: "ACTIVE";
1033
+ };
1034
+ /**
1035
+ * @public
1036
+ */
1037
+ export type ConfiguredAudienceModelStatus = (typeof ConfiguredAudienceModelStatus)[keyof typeof ConfiguredAudienceModelStatus];
1038
+ /**
1039
+ * @public
1040
+ */
1041
+ export interface GetConfiguredAudienceModelResponse {
1042
+ /**
1043
+ * @public
1044
+ * <p>The time at which the configured audience model was created.</p>
1045
+ */
1046
+ createTime: Date | undefined;
1047
+ /**
1048
+ * @public
1049
+ * <p>The most recent time at which the configured audience model was updated.</p>
1050
+ */
1051
+ updateTime: Date | undefined;
1052
+ /**
1053
+ * @public
1054
+ * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1055
+ */
1056
+ configuredAudienceModelArn: string | undefined;
1057
+ /**
1058
+ * @public
1059
+ * <p>The name of the configured audience model.</p>
1060
+ */
1061
+ name: string | undefined;
1062
+ /**
1063
+ * @public
1064
+ * <p>The Amazon Resource Name (ARN) of the audience model used for this configured audience model.</p>
1065
+ */
1066
+ audienceModelArn: string | undefined;
1067
+ /**
1068
+ * @public
1069
+ * <p>The output configuration of the configured audience model</p>
1070
+ */
1071
+ outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
1072
+ /**
1073
+ * @public
1074
+ * <p>The description of the configured audience model.</p>
1075
+ */
1076
+ description?: string;
1077
+ /**
1078
+ * @public
1079
+ * <p>The status of the configured audience model.</p>
1080
+ */
1081
+ status: ConfiguredAudienceModelStatus | undefined;
1082
+ /**
1083
+ * @public
1084
+ * <p>Whether audience metrics are shared.</p>
1085
+ */
1086
+ sharedAudienceMetrics: SharedAudienceMetrics[] | undefined;
1087
+ /**
1088
+ * @public
1089
+ * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
1090
+ */
1091
+ minMatchingSeedSize?: number;
1092
+ /**
1093
+ * @public
1094
+ * <p>The list of output sizes of audiences that can be created using this configured audience model. A request to <a>StartAudienceGenerationJob</a> that uses this configured audience model must have an <code>audienceSize</code> selected from this list. You can use the <code>ABSOLUTE</code>
1095
+ * <a>AudienceSize</a> to configure out audience sizes using the count of identifiers in the output. You can use the <code>Percentage</code>
1096
+ * <a>AudienceSize</a> to configure sizes in the range 1-100 percent.</p>
1097
+ */
1098
+ audienceSizeConfig?: AudienceSizeConfig;
1099
+ /**
1100
+ * @public
1101
+ * <p>The tags that are associated to this configured audience model.</p>
1102
+ */
1103
+ tags?: Record<string, string>;
1104
+ /**
1105
+ * @public
1106
+ * <p>Provides the <code>childResourceTagOnCreatePolicy</code> that was used for this configured audience model.</p>
1107
+ */
1108
+ childResourceTagOnCreatePolicy?: TagOnCreatePolicy;
1109
+ }
1110
+ /**
1111
+ * @public
1112
+ */
1113
+ export interface ListConfiguredAudienceModelsRequest {
1114
+ /**
1115
+ * @public
1116
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1117
+ */
1118
+ nextToken?: string;
1119
+ /**
1120
+ * @public
1121
+ * <p>The maximum size of the results that is returned per call.</p>
1122
+ */
1123
+ maxResults?: number;
1124
+ }
1125
+ /**
1126
+ * @public
1127
+ * <p>Information about the configured audience model.</p>
1128
+ */
1129
+ export interface ConfiguredAudienceModelSummary {
1130
+ /**
1131
+ * @public
1132
+ * <p>The time at which the configured audience model was created.</p>
1133
+ */
1134
+ createTime: Date | undefined;
1135
+ /**
1136
+ * @public
1137
+ * <p>The most recent time at which the configured audience model was updated.</p>
1138
+ */
1139
+ updateTime: Date | undefined;
1140
+ /**
1141
+ * @public
1142
+ * <p>The name of the configured audience model.</p>
1143
+ */
1144
+ name: string | undefined;
1145
+ /**
1146
+ * @public
1147
+ * <p>The Amazon Resource Name (ARN) of the audience model that was used to create the configured audience model.</p>
1148
+ */
1149
+ audienceModelArn: string | undefined;
1150
+ /**
1151
+ * @public
1152
+ * <p>The output configuration of the configured audience model.</p>
1153
+ */
1154
+ outputConfig: ConfiguredAudienceModelOutputConfig | undefined;
1155
+ /**
1156
+ * @public
1157
+ * <p>The description of the configured audience model.</p>
1158
+ */
1159
+ description?: string;
1160
+ /**
1161
+ * @public
1162
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1163
+ */
1164
+ configuredAudienceModelArn: string | undefined;
1165
+ /**
1166
+ * @public
1167
+ * <p>The status of the configured audience model.</p>
1168
+ */
1169
+ status: ConfiguredAudienceModelStatus | undefined;
1170
+ }
1171
+ /**
1172
+ * @public
1173
+ */
1174
+ export interface ListConfiguredAudienceModelsResponse {
1175
+ /**
1176
+ * @public
1177
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1178
+ */
1179
+ nextToken?: string;
1180
+ /**
1181
+ * @public
1182
+ * <p>The configured audience models.</p>
1183
+ */
1184
+ configuredAudienceModels: ConfiguredAudienceModelSummary[] | undefined;
1185
+ }
1186
+ /**
1187
+ * @public
1188
+ */
1189
+ export interface UpdateConfiguredAudienceModelRequest {
1190
+ /**
1191
+ * @public
1192
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that you want to update.</p>
1193
+ */
1194
+ configuredAudienceModelArn: string | undefined;
1195
+ /**
1196
+ * @public
1197
+ * <p>The new output configuration.</p>
1198
+ */
1199
+ outputConfig?: ConfiguredAudienceModelOutputConfig;
1200
+ /**
1201
+ * @public
1202
+ * <p>The Amazon Resource Name (ARN) of the new audience model that you want to use.</p>
1203
+ */
1204
+ audienceModelArn?: string;
1205
+ /**
1206
+ * @public
1207
+ * <p>The new value for whether to share audience metrics.</p>
1208
+ */
1209
+ sharedAudienceMetrics?: SharedAudienceMetrics[];
1210
+ /**
1211
+ * @public
1212
+ * <p>The minimum number of users from the seed audience that must match with users in the training data of the audience model.</p>
1213
+ */
1214
+ minMatchingSeedSize?: number;
1215
+ /**
1216
+ * @public
1217
+ * <p>The new audience size configuration.</p>
1218
+ */
1219
+ audienceSizeConfig?: AudienceSizeConfig;
1220
+ /**
1221
+ * @public
1222
+ * <p>The new description of the configured audience model.</p>
1223
+ */
1224
+ description?: string;
1225
+ }
1226
+ /**
1227
+ * @public
1228
+ */
1229
+ export interface UpdateConfiguredAudienceModelResponse {
1230
+ /**
1231
+ * @public
1232
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that was updated.</p>
1233
+ */
1234
+ configuredAudienceModelArn: string | undefined;
1235
+ }
1236
+ /**
1237
+ * @public
1238
+ */
1239
+ export interface DeleteConfiguredAudienceModelPolicyRequest {
1240
+ /**
1241
+ * @public
1242
+ * <p>The Amazon Resource Name (ARN) of the configured audience model policy that you want to delete.</p>
1243
+ */
1244
+ configuredAudienceModelArn: string | undefined;
1245
+ }
1246
+ /**
1247
+ * @public
1248
+ */
1249
+ export interface GetConfiguredAudienceModelPolicyRequest {
1250
+ /**
1251
+ * @public
1252
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that you are interested in.</p>
1253
+ */
1254
+ configuredAudienceModelArn: string | undefined;
1255
+ }
1256
+ /**
1257
+ * @public
1258
+ */
1259
+ export interface GetConfiguredAudienceModelPolicyResponse {
1260
+ /**
1261
+ * @public
1262
+ * <p>The Amazon Resource Name (ARN) of the configured audience model.</p>
1263
+ */
1264
+ configuredAudienceModelArn: string | undefined;
1265
+ /**
1266
+ * @public
1267
+ * <p>The configured audience model policy. This is a JSON IAM resource policy.</p>
1268
+ */
1269
+ configuredAudienceModelPolicy: string | undefined;
1270
+ /**
1271
+ * @public
1272
+ * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1273
+ */
1274
+ policyHash: string | undefined;
1275
+ }
1276
+ /**
1277
+ * @public
1278
+ * @enum
1279
+ */
1280
+ export declare const PolicyExistenceCondition: {
1281
+ readonly POLICY_MUST_EXIST: "POLICY_MUST_EXIST";
1282
+ readonly POLICY_MUST_NOT_EXIST: "POLICY_MUST_NOT_EXIST";
1283
+ };
1284
+ /**
1285
+ * @public
1286
+ */
1287
+ export type PolicyExistenceCondition = (typeof PolicyExistenceCondition)[keyof typeof PolicyExistenceCondition];
1288
+ /**
1289
+ * @public
1290
+ */
1291
+ export interface PutConfiguredAudienceModelPolicyRequest {
1292
+ /**
1293
+ * @public
1294
+ * <p>The Amazon Resource Name (ARN) of the configured audience model that the resource policy will govern.</p>
1295
+ */
1296
+ configuredAudienceModelArn: string | undefined;
1297
+ /**
1298
+ * @public
1299
+ * <p>The IAM resource policy.</p>
1300
+ */
1301
+ configuredAudienceModelPolicy: string | undefined;
1302
+ /**
1303
+ * @public
1304
+ * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1305
+ */
1306
+ previousPolicyHash?: string;
1307
+ /**
1308
+ * @public
1309
+ * <p>Use this to prevent unexpected concurrent modification of the policy.</p>
1310
+ */
1311
+ policyExistenceCondition?: PolicyExistenceCondition;
1312
+ }
1313
+ /**
1314
+ * @public
1315
+ */
1316
+ export interface PutConfiguredAudienceModelPolicyResponse {
1317
+ /**
1318
+ * @public
1319
+ * <p>The IAM resource policy.</p>
1320
+ */
1321
+ configuredAudienceModelPolicy: string | undefined;
1322
+ /**
1323
+ * @public
1324
+ * <p>A cryptographic hash of the contents of the policy used to prevent unexpected concurrent modification of the policy.</p>
1325
+ */
1326
+ policyHash: string | undefined;
1327
+ }
1328
+ /**
1329
+ * @public
1330
+ */
1331
+ export interface ListTagsForResourceRequest {
1332
+ /**
1333
+ * @public
1334
+ * <p>The Amazon Resource Name (ARN) of the resource that you are interested in.</p>
1335
+ */
1336
+ resourceArn: string | undefined;
1337
+ }
1338
+ /**
1339
+ * @public
1340
+ */
1341
+ export interface ListTagsForResourceResponse {
1342
+ /**
1343
+ * @public
1344
+ * <p>The tags that are associated with the resource.</p>
1345
+ */
1346
+ tags: Record<string, string> | undefined;
1347
+ }
1348
+ /**
1349
+ * @public
1350
+ */
1351
+ export interface TagResourceRequest {
1352
+ /**
1353
+ * @public
1354
+ * <p>The Amazon Resource Name (ARN) of the resource that you want to assign tags.</p>
1355
+ */
1356
+ resourceArn: string | undefined;
1357
+ /**
1358
+ * @public
1359
+ * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
1360
+ * <p>The following basic restrictions apply to tags:</p>
1361
+ * <ul>
1362
+ * <li>
1363
+ * <p>Maximum number of tags per resource - 50.</p>
1364
+ * </li>
1365
+ * <li>
1366
+ * <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
1367
+ * </li>
1368
+ * <li>
1369
+ * <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
1370
+ * </li>
1371
+ * <li>
1372
+ * <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
1373
+ * </li>
1374
+ * <li>
1375
+ * <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p>
1376
+ * </li>
1377
+ * <li>
1378
+ * <p>Tag keys and values are case sensitive.</p>
1379
+ * </li>
1380
+ * <li>
1381
+ * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
1382
+ * </li>
1383
+ * </ul>
1384
+ */
1385
+ tags: Record<string, string> | undefined;
1386
+ }
1387
+ /**
1388
+ * @public
1389
+ */
1390
+ export interface TagResourceResponse {
1391
+ }
1392
+ /**
1393
+ * @public
1394
+ * <p>Defines the Glue data source that contains the training data.</p>
1395
+ */
1396
+ export interface GlueDataSource {
1397
+ /**
1398
+ * @public
1399
+ * <p>The Glue table that contains the training data.</p>
1400
+ */
1401
+ tableName: string | undefined;
1402
+ /**
1403
+ * @public
1404
+ * <p>The Glue database that contains the training data.</p>
1405
+ */
1406
+ databaseName: string | undefined;
1407
+ /**
1408
+ * @public
1409
+ * <p>The Glue catalog that contains the training data.</p>
1410
+ */
1411
+ catalogId?: string;
1412
+ }
1413
+ /**
1414
+ * @public
1415
+ * <p>Defines information about the Glue data source that contains the training data.</p>
1416
+ */
1417
+ export interface DataSource {
1418
+ /**
1419
+ * @public
1420
+ * <p>A GlueDataSource object that defines the catalog ID, database name, and table name for the training data.</p>
1421
+ */
1422
+ glueDataSource: GlueDataSource | undefined;
1423
+ }
1424
+ /**
1425
+ * @public
1426
+ * @enum
1427
+ */
1428
+ export declare const ColumnType: {
1429
+ readonly CATEGORICAL_FEATURE: "CATEGORICAL_FEATURE";
1430
+ readonly ITEM_ID: "ITEM_ID";
1431
+ readonly NUMERICAL_FEATURE: "NUMERICAL_FEATURE";
1432
+ readonly TIMESTAMP: "TIMESTAMP";
1433
+ readonly USER_ID: "USER_ID";
1434
+ };
1435
+ /**
1436
+ * @public
1437
+ */
1438
+ export type ColumnType = (typeof ColumnType)[keyof typeof ColumnType];
1439
+ /**
1440
+ * @public
1441
+ * <p>Metadata for a column.</p>
1442
+ */
1443
+ export interface ColumnSchema {
1444
+ /**
1445
+ * @public
1446
+ * <p>The name of a column.</p>
1447
+ */
1448
+ columnName: string | undefined;
1449
+ /**
1450
+ * @public
1451
+ * <p>The data type of column.</p>
1452
+ */
1453
+ columnTypes: ColumnType[] | undefined;
1454
+ }
1455
+ /**
1456
+ * @public
1457
+ * <p>Defines the Glue data source and schema mapping information.</p>
1458
+ */
1459
+ export interface DatasetInputConfig {
1460
+ /**
1461
+ * @public
1462
+ * <p>The schema information for the training data.</p>
1463
+ */
1464
+ schema: ColumnSchema[] | undefined;
1465
+ /**
1466
+ * @public
1467
+ * <p>A DataSource object that specifies the Glue data source for the training data.</p>
1468
+ */
1469
+ dataSource: DataSource | undefined;
1470
+ }
1471
+ /**
1472
+ * @public
1473
+ * @enum
1474
+ */
1475
+ export declare const DatasetType: {
1476
+ readonly INTERACTIONS: "INTERACTIONS";
1477
+ };
1478
+ /**
1479
+ * @public
1480
+ */
1481
+ export type DatasetType = (typeof DatasetType)[keyof typeof DatasetType];
1482
+ /**
1483
+ * @public
1484
+ * <p>Defines where the training dataset is located, what type of data it contains, and how to access the data.</p>
1485
+ */
1486
+ export interface Dataset {
1487
+ /**
1488
+ * @public
1489
+ * <p>What type of information is found in the dataset.</p>
1490
+ */
1491
+ type: DatasetType | undefined;
1492
+ /**
1493
+ * @public
1494
+ * <p>A DatasetInputConfig object that defines the data source and schema mapping.</p>
1495
+ */
1496
+ inputConfig: DatasetInputConfig | undefined;
1497
+ }
1498
+ /**
1499
+ * @public
1500
+ */
1501
+ export interface CreateTrainingDatasetRequest {
1502
+ /**
1503
+ * @public
1504
+ * <p>The name of the training dataset. This name must be unique in your account and region.</p>
1505
+ */
1506
+ name: string | undefined;
1507
+ /**
1508
+ * @public
1509
+ * <p>The ARN of the IAM role that Clean Rooms ML can assume to read the data referred to in the <code>dataSource</code> field of each dataset.</p>
1510
+ * <p>Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your account, you get an <code>AccessDeniedException</code> error.</p>
1511
+ */
1512
+ roleArn: string | undefined;
1513
+ /**
1514
+ * @public
1515
+ * <p>An array of information that lists the Dataset objects, which specifies the dataset type and details on its location and schema. You must provide a role that has read access to these tables.</p>
1516
+ */
1517
+ trainingData: Dataset[] | undefined;
1518
+ /**
1519
+ * @public
1520
+ * <p>The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.</p>
1521
+ * <p>The following basic restrictions apply to tags:</p>
1522
+ * <ul>
1523
+ * <li>
1524
+ * <p>Maximum number of tags per resource - 50.</p>
1525
+ * </li>
1526
+ * <li>
1527
+ * <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p>
1528
+ * </li>
1529
+ * <li>
1530
+ * <p>Maximum key length - 128 Unicode characters in UTF-8.</p>
1531
+ * </li>
1532
+ * <li>
1533
+ * <p>Maximum value length - 256 Unicode characters in UTF-8.</p>
1534
+ * </li>
1535
+ * <li>
1536
+ * <p>If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.</p>
1537
+ * </li>
1538
+ * <li>
1539
+ * <p>Tag keys and values are case sensitive.</p>
1540
+ * </li>
1541
+ * <li>
1542
+ * <p>Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.</p>
1543
+ * </li>
1544
+ * </ul>
1545
+ */
1546
+ tags?: Record<string, string>;
1547
+ /**
1548
+ * @public
1549
+ * <p>The description of the training dataset.</p>
1550
+ */
1551
+ description?: string;
1552
+ }
1553
+ /**
1554
+ * @public
1555
+ */
1556
+ export interface CreateTrainingDatasetResponse {
1557
+ /**
1558
+ * @public
1559
+ * <p>The Amazon Resource Name (ARN) of the training dataset resource.</p>
1560
+ */
1561
+ trainingDatasetArn: string | undefined;
1562
+ }
1563
+ /**
1564
+ * @public
1565
+ */
1566
+ export interface DeleteTrainingDatasetRequest {
1567
+ /**
1568
+ * @public
1569
+ * <p>The Amazon Resource Name (ARN) of the training dataset that you want to delete.</p>
1570
+ */
1571
+ trainingDatasetArn: string | undefined;
1572
+ }
1573
+ /**
1574
+ * @public
1575
+ */
1576
+ export interface GetTrainingDatasetRequest {
1577
+ /**
1578
+ * @public
1579
+ * <p>The Amazon Resource Name (ARN) of the training dataset that you are interested in.</p>
1580
+ */
1581
+ trainingDatasetArn: string | undefined;
1582
+ }
1583
+ /**
1584
+ * @public
1585
+ * @enum
1586
+ */
1587
+ export declare const TrainingDatasetStatus: {
1588
+ readonly ACTIVE: "ACTIVE";
1589
+ };
1590
+ /**
1591
+ * @public
1592
+ */
1593
+ export type TrainingDatasetStatus = (typeof TrainingDatasetStatus)[keyof typeof TrainingDatasetStatus];
1594
+ /**
1595
+ * @public
1596
+ */
1597
+ export interface GetTrainingDatasetResponse {
1598
+ /**
1599
+ * @public
1600
+ * <p>The time at which the training dataset was created.</p>
1601
+ */
1602
+ createTime: Date | undefined;
1603
+ /**
1604
+ * @public
1605
+ * <p>The most recent time at which the training dataset was updated.</p>
1606
+ */
1607
+ updateTime: Date | undefined;
1608
+ /**
1609
+ * @public
1610
+ * <p>The Amazon Resource Name (ARN) of the training dataset.</p>
1611
+ */
1612
+ trainingDatasetArn: string | undefined;
1613
+ /**
1614
+ * @public
1615
+ * <p>The name of the training dataset.</p>
1616
+ */
1617
+ name: string | undefined;
1618
+ /**
1619
+ * @public
1620
+ * <p>Metadata about the requested training data. </p>
1621
+ */
1622
+ trainingData: Dataset[] | undefined;
1623
+ /**
1624
+ * @public
1625
+ * <p>The status of the training dataset.</p>
1626
+ */
1627
+ status: TrainingDatasetStatus | undefined;
1628
+ /**
1629
+ * @public
1630
+ * <p>The IAM role used to read the training data.</p>
1631
+ */
1632
+ roleArn: string | undefined;
1633
+ /**
1634
+ * @public
1635
+ * <p>The tags that are assigned to this training dataset.</p>
1636
+ */
1637
+ tags?: Record<string, string>;
1638
+ /**
1639
+ * @public
1640
+ * <p>The description of the training dataset.</p>
1641
+ */
1642
+ description?: string;
1643
+ }
1644
+ /**
1645
+ * @public
1646
+ */
1647
+ export interface ListTrainingDatasetsRequest {
1648
+ /**
1649
+ * @public
1650
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1651
+ */
1652
+ nextToken?: string;
1653
+ /**
1654
+ * @public
1655
+ * <p>The maximum size of the results that is returned per call.</p>
1656
+ */
1657
+ maxResults?: number;
1658
+ }
1659
+ /**
1660
+ * @public
1661
+ * <p>Provides information about the training dataset.</p>
1662
+ */
1663
+ export interface TrainingDatasetSummary {
1664
+ /**
1665
+ * @public
1666
+ * <p>The time at which the training dataset was created.</p>
1667
+ */
1668
+ createTime: Date | undefined;
1669
+ /**
1670
+ * @public
1671
+ * <p>The most recent time at which the training dataset was updated.</p>
1672
+ */
1673
+ updateTime: Date | undefined;
1674
+ /**
1675
+ * @public
1676
+ * <p>The Amazon Resource Name (ARN) of the training dataset.</p>
1677
+ */
1678
+ trainingDatasetArn: string | undefined;
1679
+ /**
1680
+ * @public
1681
+ * <p>The name of the training dataset.</p>
1682
+ */
1683
+ name: string | undefined;
1684
+ /**
1685
+ * @public
1686
+ * <p>The status of the training dataset.</p>
1687
+ */
1688
+ status: TrainingDatasetStatus | undefined;
1689
+ /**
1690
+ * @public
1691
+ * <p>The description of the training dataset.</p>
1692
+ */
1693
+ description?: string;
1694
+ }
1695
+ /**
1696
+ * @public
1697
+ */
1698
+ export interface ListTrainingDatasetsResponse {
1699
+ /**
1700
+ * @public
1701
+ * <p>The token value retrieved from a previous call to access the next page of results.</p>
1702
+ */
1703
+ nextToken?: string;
1704
+ /**
1705
+ * @public
1706
+ * <p>The training datasets that match the request.</p>
1707
+ */
1708
+ trainingDatasets: TrainingDatasetSummary[] | undefined;
1709
+ }
1710
+ /**
1711
+ * @public
1712
+ */
1713
+ export interface UntagResourceRequest {
1714
+ /**
1715
+ * @public
1716
+ * <p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>
1717
+ */
1718
+ resourceArn: string | undefined;
1719
+ /**
1720
+ * @public
1721
+ * <p>The key values of tags that you want to remove.</p>
1722
+ */
1723
+ tagKeys: string[] | undefined;
1724
+ }
1725
+ /**
1726
+ * @public
1727
+ */
1728
+ export interface UntagResourceResponse {
1729
+ }