@aws-sdk/client-machine-learning 3.533.0 → 3.535.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.
- package/dist-types/MachineLearning.d.ts +5 -1
- package/dist-types/MachineLearningClient.d.ts +1 -1
- package/dist-types/commands/AddTagsCommand.d.ts +2 -1
- package/dist-types/commands/CreateBatchPredictionCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataSourceFromRDSCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataSourceFromRedshiftCommand.d.ts +2 -1
- package/dist-types/commands/CreateDataSourceFromS3Command.d.ts +2 -1
- package/dist-types/commands/CreateEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/CreateMLModelCommand.d.ts +2 -1
- package/dist-types/commands/CreateRealtimeEndpointCommand.d.ts +2 -1
- package/dist-types/commands/DeleteBatchPredictionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/DeleteEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteMLModelCommand.d.ts +2 -1
- package/dist-types/commands/DeleteRealtimeEndpointCommand.d.ts +2 -1
- package/dist-types/commands/DeleteTagsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeBatchPredictionsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeDataSourcesCommand.d.ts +2 -1
- package/dist-types/commands/DescribeEvaluationsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeMLModelsCommand.d.ts +2 -1
- package/dist-types/commands/DescribeTagsCommand.d.ts +2 -1
- package/dist-types/commands/GetBatchPredictionCommand.d.ts +2 -1
- package/dist-types/commands/GetDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/GetEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/GetMLModelCommand.d.ts +2 -1
- package/dist-types/commands/PredictCommand.d.ts +2 -1
- package/dist-types/commands/UpdateBatchPredictionCommand.d.ts +2 -1
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateEvaluationCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMLModelCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +377 -377
- package/dist-types/ts3.4/MachineLearning.d.ts +4 -0
- package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/CreateBatchPredictionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataSourceFromRDSCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataSourceFromRedshiftCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateDataSourceFromS3Command.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateMLModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateRealtimeEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteBatchPredictionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteMLModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteRealtimeEndpointCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeBatchPredictionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeDataSourcesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeEvaluationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeMLModelsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DescribeTagsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetBatchPredictionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetDataSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetMLModelCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PredictCommand.d.ts +7 -0
- package/dist-types/ts3.4/commands/UpdateBatchPredictionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateEvaluationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateMLModelCommand.d.ts +9 -0
- package/package.json +42 -42
|
@@ -15,18 +15,18 @@ export declare const TaggableResourceType: {
|
|
|
15
15
|
*/
|
|
16
16
|
export type TaggableResourceType = (typeof TaggableResourceType)[keyof typeof TaggableResourceType];
|
|
17
17
|
/**
|
|
18
|
-
* @public
|
|
19
18
|
* <p>A custom key-value pair associated with an ML object, such as an ML model.</p>
|
|
19
|
+
* @public
|
|
20
20
|
*/
|
|
21
21
|
export interface Tag {
|
|
22
22
|
/**
|
|
23
|
-
* @public
|
|
24
23
|
* <p>A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
|
|
24
|
+
* @public
|
|
25
25
|
*/
|
|
26
26
|
Key?: string;
|
|
27
27
|
/**
|
|
28
|
-
* @public
|
|
29
28
|
* <p>An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
|
|
29
|
+
* @public
|
|
30
30
|
*/
|
|
31
31
|
Value?: string;
|
|
32
32
|
}
|
|
@@ -35,40 +35,40 @@ export interface Tag {
|
|
|
35
35
|
*/
|
|
36
36
|
export interface AddTagsInput {
|
|
37
37
|
/**
|
|
38
|
-
* @public
|
|
39
38
|
* <p>The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.</p>
|
|
39
|
+
* @public
|
|
40
40
|
*/
|
|
41
41
|
Tags: Tag[] | undefined;
|
|
42
42
|
/**
|
|
43
|
-
* @public
|
|
44
43
|
* <p>The ID of the ML object to tag. For example, <code>exampleModelId</code>.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
ResourceId: string | undefined;
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The type of the ML object to tag.</p>
|
|
49
|
+
* @public
|
|
50
50
|
*/
|
|
51
51
|
ResourceType: TaggableResourceType | undefined;
|
|
52
52
|
}
|
|
53
53
|
/**
|
|
54
|
-
* @public
|
|
55
54
|
* <p>Amazon ML returns the following elements.</p>
|
|
55
|
+
* @public
|
|
56
56
|
*/
|
|
57
57
|
export interface AddTagsOutput {
|
|
58
58
|
/**
|
|
59
|
-
* @public
|
|
60
59
|
* <p>The ID of the ML object that was tagged.</p>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
ResourceId?: string;
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The type of the ML object that was tagged.</p>
|
|
65
|
+
* @public
|
|
66
66
|
*/
|
|
67
67
|
ResourceType?: TaggableResourceType;
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
70
|
-
* @public
|
|
71
70
|
* <p>An error on the server occurred when trying to process a request.</p>
|
|
71
|
+
* @public
|
|
72
72
|
*/
|
|
73
73
|
export declare class InternalServerException extends __BaseException {
|
|
74
74
|
readonly name: "InternalServerException";
|
|
@@ -80,8 +80,8 @@ export declare class InternalServerException extends __BaseException {
|
|
|
80
80
|
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
|
-
* @public
|
|
84
83
|
* <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
|
|
84
|
+
* @public
|
|
85
85
|
*/
|
|
86
86
|
export declare class InvalidInputException extends __BaseException {
|
|
87
87
|
readonly name: "InvalidInputException";
|
|
@@ -104,8 +104,8 @@ export declare class InvalidTagException extends __BaseException {
|
|
|
104
104
|
constructor(opts: __ExceptionOptionType<InvalidTagException, __BaseException>);
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
|
-
* @public
|
|
108
107
|
* <p>A specified resource cannot be located.</p>
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
111
111
|
readonly name: "ResourceNotFoundException";
|
|
@@ -143,51 +143,51 @@ export type Algorithm = (typeof Algorithm)[keyof typeof Algorithm];
|
|
|
143
143
|
*/
|
|
144
144
|
export interface CreateBatchPredictionInput {
|
|
145
145
|
/**
|
|
146
|
-
* @public
|
|
147
146
|
* <p>A user-supplied ID that uniquely identifies the
|
|
148
147
|
* <code>BatchPrediction</code>.</p>
|
|
148
|
+
* @public
|
|
149
149
|
*/
|
|
150
150
|
BatchPredictionId: string | undefined;
|
|
151
151
|
/**
|
|
152
|
-
* @public
|
|
153
152
|
* <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
|
|
153
|
+
* @public
|
|
154
154
|
*/
|
|
155
155
|
BatchPredictionName?: string;
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
MLModelId: string | undefined;
|
|
161
161
|
/**
|
|
162
|
-
* @public
|
|
163
162
|
* <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
|
|
163
|
+
* @public
|
|
164
164
|
*/
|
|
165
165
|
BatchPredictionDataSourceId: string | undefined;
|
|
166
166
|
/**
|
|
167
|
-
* @public
|
|
168
167
|
* <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
|
|
169
168
|
* <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
OutputUri: string | undefined;
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p> Represents the output of a <code>CreateBatchPrediction</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
176
175
|
* <p>The <code>CreateBatchPrediction</code> operation is asynchronous. You can poll for status updates by using the <code>>GetBatchPrediction</code>
|
|
177
176
|
* operation and checking the <code>Status</code> parameter of the result.
|
|
178
177
|
* </p>
|
|
178
|
+
* @public
|
|
179
179
|
*/
|
|
180
180
|
export interface CreateBatchPredictionOutput {
|
|
181
181
|
/**
|
|
182
|
-
* @public
|
|
183
182
|
* <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value is identical to the value of the
|
|
184
183
|
* <code>BatchPredictionId</code> in the request.</p>
|
|
184
|
+
* @public
|
|
185
185
|
*/
|
|
186
186
|
BatchPredictionId?: string;
|
|
187
187
|
}
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
export declare class IdempotentParameterMismatchException extends __BaseException {
|
|
193
193
|
readonly name: "IdempotentParameterMismatchException";
|
|
@@ -199,66 +199,65 @@ export declare class IdempotentParameterMismatchException extends __BaseExceptio
|
|
|
199
199
|
constructor(opts: __ExceptionOptionType<IdempotentParameterMismatchException, __BaseException>);
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
|
-
* @public
|
|
203
202
|
* <p>The database credentials to connect to a database on an RDS DB instance.</p>
|
|
203
|
+
* @public
|
|
204
204
|
*/
|
|
205
205
|
export interface RDSDatabaseCredentials {
|
|
206
206
|
/**
|
|
207
|
-
* @public
|
|
208
207
|
* <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
|
|
209
208
|
* The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
|
|
209
|
+
* @public
|
|
210
210
|
*/
|
|
211
211
|
Username: string | undefined;
|
|
212
212
|
/**
|
|
213
|
-
* @public
|
|
214
213
|
* <p>The password to be used by Amazon ML to connect to a database on an RDS DB instance.
|
|
215
214
|
* The password should have sufficient permissions to execute the <code>RDSSelectQuery</code> query.</p>
|
|
215
|
+
* @public
|
|
216
216
|
*/
|
|
217
217
|
Password: string | undefined;
|
|
218
218
|
}
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
220
|
* <p>The database details of an Amazon RDS database.</p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
export interface RDSDatabase {
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>The ID of an RDS DB instance.</p>
|
|
226
|
+
* @public
|
|
227
227
|
*/
|
|
228
228
|
InstanceIdentifier: string | undefined;
|
|
229
229
|
/**
|
|
230
|
-
* @public
|
|
231
230
|
* <p>The name of a database hosted on an RDS DB instance.</p>
|
|
231
|
+
* @public
|
|
232
232
|
*/
|
|
233
233
|
DatabaseName: string | undefined;
|
|
234
234
|
}
|
|
235
235
|
/**
|
|
236
|
-
* @public
|
|
237
236
|
* <p>The data specification of an Amazon Relational Database Service (Amazon RDS) <code>DataSource</code>.</p>
|
|
237
|
+
* @public
|
|
238
238
|
*/
|
|
239
239
|
export interface RDSDataSpec {
|
|
240
240
|
/**
|
|
241
|
-
* @public
|
|
242
241
|
* <p>Describes the <code>DatabaseName</code> and <code>InstanceIdentifier</code> of an Amazon RDS database.</p>
|
|
242
|
+
* @public
|
|
243
243
|
*/
|
|
244
244
|
DatabaseInformation: RDSDatabase | undefined;
|
|
245
245
|
/**
|
|
246
|
-
* @public
|
|
247
246
|
* <p>The query that is used to retrieve the observation data for the <code>DataSource</code>.</p>
|
|
247
|
+
* @public
|
|
248
248
|
*/
|
|
249
249
|
SelectSqlQuery: string | undefined;
|
|
250
250
|
/**
|
|
251
|
-
* @public
|
|
252
251
|
* <p>The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.</p>
|
|
252
|
+
* @public
|
|
253
253
|
*/
|
|
254
254
|
DatabaseCredentials: RDSDatabaseCredentials | undefined;
|
|
255
255
|
/**
|
|
256
|
-
* @public
|
|
257
256
|
* <p>The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
S3StagingLocation: string | undefined;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>A JSON string that represents the splitting and rearrangement
|
|
263
262
|
* processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
|
|
264
263
|
* parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
|
|
@@ -345,10 +344,10 @@ export interface RDSDataSpec {
|
|
|
345
344
|
* </p>
|
|
346
345
|
* </li>
|
|
347
346
|
* </ul>
|
|
347
|
+
* @public
|
|
348
348
|
*/
|
|
349
349
|
DataRearrangement?: string;
|
|
350
350
|
/**
|
|
351
|
-
* @public
|
|
352
351
|
* <p>A JSON string that represents the schema for an Amazon RDS
|
|
353
352
|
* <code>DataSource</code>. The <code>DataSchema</code>
|
|
354
353
|
* defines the structure of the observation data in the data file(s)
|
|
@@ -368,31 +367,32 @@ export interface RDSDataSpec {
|
|
|
368
367
|
* <p>"attributes": [</p>
|
|
369
368
|
* <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
|
|
370
369
|
* <p>"excludedVariableNames": [ "F6" ] \}</p>
|
|
370
|
+
* @public
|
|
371
371
|
*/
|
|
372
372
|
DataSchema?: string;
|
|
373
373
|
/**
|
|
374
|
-
* @public
|
|
375
374
|
* <p>The Amazon S3 location of the <code>DataSchema</code>. </p>
|
|
375
|
+
* @public
|
|
376
376
|
*/
|
|
377
377
|
DataSchemaUri?: string;
|
|
378
378
|
/**
|
|
379
|
-
* @public
|
|
380
379
|
* <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
|
|
380
|
+
* @public
|
|
381
381
|
*/
|
|
382
382
|
ResourceRole: string | undefined;
|
|
383
383
|
/**
|
|
384
|
-
* @public
|
|
385
384
|
* <p>The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
|
|
385
|
+
* @public
|
|
386
386
|
*/
|
|
387
387
|
ServiceRole: string | undefined;
|
|
388
388
|
/**
|
|
389
|
-
* @public
|
|
390
389
|
* <p>The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.</p>
|
|
390
|
+
* @public
|
|
391
391
|
*/
|
|
392
392
|
SubnetId: string | undefined;
|
|
393
393
|
/**
|
|
394
|
-
* @public
|
|
395
394
|
* <p>The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.</p>
|
|
395
|
+
* @public
|
|
396
396
|
*/
|
|
397
397
|
SecurityGroupIds: string[] | undefined;
|
|
398
398
|
}
|
|
@@ -401,18 +401,17 @@ export interface RDSDataSpec {
|
|
|
401
401
|
*/
|
|
402
402
|
export interface CreateDataSourceFromRDSInput {
|
|
403
403
|
/**
|
|
404
|
-
* @public
|
|
405
404
|
* <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN)
|
|
406
405
|
* becomes the ID for a <code>DataSource</code>.</p>
|
|
406
|
+
* @public
|
|
407
407
|
*/
|
|
408
408
|
DataSourceId: string | undefined;
|
|
409
409
|
/**
|
|
410
|
-
* @public
|
|
411
410
|
* <p>A user-supplied name or description of the <code>DataSource</code>.</p>
|
|
411
|
+
* @public
|
|
412
412
|
*/
|
|
413
413
|
DataSourceName?: string;
|
|
414
414
|
/**
|
|
415
|
-
* @public
|
|
416
415
|
* <p>The data specification of an Amazon RDS <code>DataSource</code>:</p>
|
|
417
416
|
* <ul>
|
|
418
417
|
* <li>
|
|
@@ -461,103 +460,103 @@ export interface CreateDataSourceFromRDSInput {
|
|
|
461
460
|
* </p>
|
|
462
461
|
* </li>
|
|
463
462
|
* </ul>
|
|
463
|
+
* @public
|
|
464
464
|
*/
|
|
465
465
|
RDSData: RDSDataSpec | undefined;
|
|
466
466
|
/**
|
|
467
|
-
* @public
|
|
468
467
|
* <p>The role that Amazon ML assumes on behalf of the user to create and activate a data
|
|
469
468
|
* pipeline in the user's account and copy data using the <code>SelectSqlQuery</code> query from Amazon RDS to Amazon S3.</p>
|
|
470
469
|
* <p></p>
|
|
470
|
+
* @public
|
|
471
471
|
*/
|
|
472
472
|
RoleARN: string | undefined;
|
|
473
473
|
/**
|
|
474
|
-
* @public
|
|
475
474
|
* <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
|
|
476
475
|
* a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
|
|
477
476
|
* This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.
|
|
478
477
|
* </p>
|
|
478
|
+
* @public
|
|
479
479
|
*/
|
|
480
480
|
ComputeStatistics?: boolean;
|
|
481
481
|
}
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p> Represents the output of a <code>CreateDataSourceFromRDS</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
485
484
|
* <p>The <code>CreateDataSourceFromRDS</code>> operation is asynchronous. You can poll for updates by using
|
|
486
485
|
* the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. You can
|
|
487
486
|
* inspect the <code>Message</code> when <code>Status</code> shows up as <code>FAILED</code>. You can
|
|
488
487
|
* also check the progress of the copy operation by going to the <code>DataPipeline</code> console and looking up
|
|
489
488
|
* the pipeline using the <code>pipelineId </code> from the describe call.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
export interface CreateDataSourceFromRDSOutput {
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
|
|
495
494
|
* <code>DataSourceID</code> in the request.
|
|
496
495
|
* </p>
|
|
496
|
+
* @public
|
|
497
497
|
*/
|
|
498
498
|
DataSourceId?: string;
|
|
499
499
|
}
|
|
500
500
|
/**
|
|
501
|
-
* @public
|
|
502
501
|
* <p>Describes the database credentials for connecting to a database on an Amazon Redshift cluster.</p>
|
|
502
|
+
* @public
|
|
503
503
|
*/
|
|
504
504
|
export interface RedshiftDatabaseCredentials {
|
|
505
505
|
/**
|
|
506
|
-
* @public
|
|
507
506
|
* <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
|
|
508
507
|
* The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
Username: string | undefined;
|
|
511
511
|
/**
|
|
512
|
-
* @public
|
|
513
512
|
* <p>A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster.
|
|
514
513
|
* The password should have sufficient permissions to execute a <code>RedshiftSelectSqlQuery</code> query. The password should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
|
|
514
|
+
* @public
|
|
515
515
|
*/
|
|
516
516
|
Password: string | undefined;
|
|
517
517
|
}
|
|
518
518
|
/**
|
|
519
|
-
* @public
|
|
520
519
|
* <p>Describes the database details required to connect to an Amazon Redshift database.</p>
|
|
520
|
+
* @public
|
|
521
521
|
*/
|
|
522
522
|
export interface RedshiftDatabase {
|
|
523
523
|
/**
|
|
524
|
-
* @public
|
|
525
524
|
* <p>The name of a database hosted on an Amazon Redshift cluster.</p>
|
|
525
|
+
* @public
|
|
526
526
|
*/
|
|
527
527
|
DatabaseName: string | undefined;
|
|
528
528
|
/**
|
|
529
|
-
* @public
|
|
530
529
|
* <p>The ID of an Amazon Redshift cluster.</p>
|
|
530
|
+
* @public
|
|
531
531
|
*/
|
|
532
532
|
ClusterIdentifier: string | undefined;
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
535
|
-
* @public
|
|
536
535
|
* <p>Describes the data specification of an Amazon Redshift <code>DataSource</code>.</p>
|
|
536
|
+
* @public
|
|
537
537
|
*/
|
|
538
538
|
export interface RedshiftDataSpec {
|
|
539
539
|
/**
|
|
540
|
-
* @public
|
|
541
540
|
* <p>Describes the <code>DatabaseName</code> and <code>ClusterIdentifier</code> for an Amazon Redshift <code>DataSource</code>.</p>
|
|
541
|
+
* @public
|
|
542
542
|
*/
|
|
543
543
|
DatabaseInformation: RedshiftDatabase | undefined;
|
|
544
544
|
/**
|
|
545
|
-
* @public
|
|
546
545
|
* <p>Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift <code>DataSource</code>.</p>
|
|
546
|
+
* @public
|
|
547
547
|
*/
|
|
548
548
|
SelectSqlQuery: string | undefined;
|
|
549
549
|
/**
|
|
550
|
-
* @public
|
|
551
550
|
* <p>Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.</p>
|
|
551
|
+
* @public
|
|
552
552
|
*/
|
|
553
553
|
DatabaseCredentials: RedshiftDatabaseCredentials | undefined;
|
|
554
554
|
/**
|
|
555
|
-
* @public
|
|
556
555
|
* <p>Describes an Amazon S3 location to store the result set of the <code>SelectSqlQuery</code> query.</p>
|
|
556
|
+
* @public
|
|
557
557
|
*/
|
|
558
558
|
S3StagingLocation: string | undefined;
|
|
559
559
|
/**
|
|
560
|
-
* @public
|
|
561
560
|
* <p>A JSON string that represents the splitting and rearrangement
|
|
562
561
|
* processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
|
|
563
562
|
* parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
|
|
@@ -644,10 +643,10 @@ export interface RedshiftDataSpec {
|
|
|
644
643
|
* </p>
|
|
645
644
|
* </li>
|
|
646
645
|
* </ul>
|
|
646
|
+
* @public
|
|
647
647
|
*/
|
|
648
648
|
DataRearrangement?: string;
|
|
649
649
|
/**
|
|
650
|
-
* @public
|
|
651
650
|
* <p>A JSON string that represents the schema for an Amazon Redshift
|
|
652
651
|
* <code>DataSource</code>. The <code>DataSchema</code>
|
|
653
652
|
* defines the structure of the observation data in the data file(s)
|
|
@@ -666,11 +665,12 @@ export interface RedshiftDataSpec {
|
|
|
666
665
|
* <p>"attributes": [</p>
|
|
667
666
|
* <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
|
|
668
667
|
* <p>"excludedVariableNames": [ "F6" ] \}</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
DataSchema?: string;
|
|
671
671
|
/**
|
|
672
|
-
* @public
|
|
673
672
|
* <p>Describes the schema location for an Amazon Redshift <code>DataSource</code>.</p>
|
|
673
|
+
* @public
|
|
674
674
|
*/
|
|
675
675
|
DataSchemaUri?: string;
|
|
676
676
|
}
|
|
@@ -679,17 +679,16 @@ export interface RedshiftDataSpec {
|
|
|
679
679
|
*/
|
|
680
680
|
export interface CreateDataSourceFromRedshiftInput {
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
DataSourceId: string | undefined;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>A user-supplied name or description of the <code>DataSource</code>. </p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
DataSourceName?: string;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The data specification of an Amazon Redshift <code>DataSource</code>:</p>
|
|
694
693
|
* <ul>
|
|
695
694
|
* <li>
|
|
@@ -730,10 +729,10 @@ export interface CreateDataSourceFromRedshiftInput {
|
|
|
730
729
|
* </p>
|
|
731
730
|
* </li>
|
|
732
731
|
* </ul>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
DataSpec: RedshiftDataSpec | undefined;
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:</p>
|
|
738
737
|
*
|
|
739
738
|
* <ul>
|
|
@@ -745,45 +744,45 @@ export interface CreateDataSourceFromRedshiftInput {
|
|
|
745
744
|
* </p>
|
|
746
745
|
* </li>
|
|
747
746
|
* </ul>
|
|
747
|
+
* @public
|
|
748
748
|
*/
|
|
749
749
|
RoleARN: string | undefined;
|
|
750
750
|
/**
|
|
751
|
-
* @public
|
|
752
751
|
* <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
|
|
753
752
|
* a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
|
|
754
753
|
* This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to
|
|
755
754
|
* be used for <code>MLModel</code> training.</p>
|
|
755
|
+
* @public
|
|
756
756
|
*/
|
|
757
757
|
ComputeStatistics?: boolean;
|
|
758
758
|
}
|
|
759
759
|
/**
|
|
760
|
-
* @public
|
|
761
760
|
* <p> Represents the output of a <code>CreateDataSourceFromRedshift</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
762
761
|
* <p>The <code>CreateDataSourceFromRedshift</code> operation is asynchronous. You can poll for updates by using
|
|
763
762
|
* the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
|
|
763
|
+
* @public
|
|
764
764
|
*/
|
|
765
765
|
export interface CreateDataSourceFromRedshiftOutput {
|
|
766
766
|
/**
|
|
767
|
-
* @public
|
|
768
767
|
* <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
|
|
769
768
|
* <code>DataSourceID</code> in the request.
|
|
770
769
|
* </p>
|
|
770
|
+
* @public
|
|
771
771
|
*/
|
|
772
772
|
DataSourceId?: string;
|
|
773
773
|
}
|
|
774
774
|
/**
|
|
775
|
-
* @public
|
|
776
775
|
* <p> Describes the data specification of a <code>DataSource</code>.</p>
|
|
776
|
+
* @public
|
|
777
777
|
*/
|
|
778
778
|
export interface S3DataSpec {
|
|
779
779
|
/**
|
|
780
|
-
* @public
|
|
781
780
|
* <p>The location of the data file(s) used by a <code>DataSource</code>. The URI specifies a data file or
|
|
782
781
|
* an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.</p>
|
|
782
|
+
* @public
|
|
783
783
|
*/
|
|
784
784
|
DataLocationS3: string | undefined;
|
|
785
785
|
/**
|
|
786
|
-
* @public
|
|
787
786
|
* <p>A JSON string that represents the splitting and rearrangement
|
|
788
787
|
* processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
|
|
789
788
|
* parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
|
|
@@ -870,10 +869,10 @@ export interface S3DataSpec {
|
|
|
870
869
|
* </p>
|
|
871
870
|
* </li>
|
|
872
871
|
* </ul>
|
|
872
|
+
* @public
|
|
873
873
|
*/
|
|
874
874
|
DataRearrangement?: string;
|
|
875
875
|
/**
|
|
876
|
-
* @public
|
|
877
876
|
* <p> A JSON string that represents the schema for an Amazon S3
|
|
878
877
|
* <code>DataSource</code>. The <code>DataSchema</code>
|
|
879
878
|
* defines the structure of the observation data in the data file(s)
|
|
@@ -891,12 +890,13 @@ export interface S3DataSpec {
|
|
|
891
890
|
* <p>"attributes": [</p>
|
|
892
891
|
* <p>\{ "fieldName": "F1", "fieldType": "TEXT" \}, \{ "fieldName": "F2", "fieldType": "NUMERIC" \}, \{ "fieldName": "F3", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F4", "fieldType": "NUMERIC" \}, \{ "fieldName": "F5", "fieldType": "CATEGORICAL" \}, \{ "fieldName": "F6", "fieldType": "TEXT" \}, \{ "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" \}, \{ "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" \} ],</p>
|
|
893
892
|
* <p>"excludedVariableNames": [ "F6" ] \}</p>
|
|
893
|
+
* @public
|
|
894
894
|
*/
|
|
895
895
|
DataSchema?: string;
|
|
896
896
|
/**
|
|
897
|
-
* @public
|
|
898
897
|
* <p>Describes the schema location in Amazon S3. You must provide either the
|
|
899
898
|
* <code>DataSchema</code> or the <code>DataSchemaLocationS3</code>.</p>
|
|
899
|
+
* @public
|
|
900
900
|
*/
|
|
901
901
|
DataSchemaLocationS3?: string;
|
|
902
902
|
}
|
|
@@ -905,17 +905,16 @@ export interface S3DataSpec {
|
|
|
905
905
|
*/
|
|
906
906
|
export interface CreateDataSourceFromS3Input {
|
|
907
907
|
/**
|
|
908
|
-
* @public
|
|
909
908
|
* <p>A user-supplied identifier that uniquely identifies the <code>DataSource</code>. </p>
|
|
909
|
+
* @public
|
|
910
910
|
*/
|
|
911
911
|
DataSourceId: string | undefined;
|
|
912
912
|
/**
|
|
913
|
-
* @public
|
|
914
913
|
* <p>A user-supplied name or description of the <code>DataSource</code>. </p>
|
|
914
|
+
* @public
|
|
915
915
|
*/
|
|
916
916
|
DataSourceName?: string;
|
|
917
917
|
/**
|
|
918
|
-
* @public
|
|
919
918
|
* <p>The data specification of a <code>DataSource</code>:</p>
|
|
920
919
|
* <ul>
|
|
921
920
|
* <li>
|
|
@@ -934,28 +933,29 @@ export interface CreateDataSourceFromS3Input {
|
|
|
934
933
|
* </p>
|
|
935
934
|
* </li>
|
|
936
935
|
* </ul>
|
|
936
|
+
* @public
|
|
937
937
|
*/
|
|
938
938
|
DataSpec: S3DataSpec | undefined;
|
|
939
939
|
/**
|
|
940
|
-
* @public
|
|
941
940
|
* <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
|
|
942
941
|
* a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
|
|
943
942
|
* This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.</p>
|
|
943
|
+
* @public
|
|
944
944
|
*/
|
|
945
945
|
ComputeStatistics?: boolean;
|
|
946
946
|
}
|
|
947
947
|
/**
|
|
948
|
-
* @public
|
|
949
948
|
* <p> Represents the output of a <code>CreateDataSourceFromS3</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
950
949
|
* <p>The <code>CreateDataSourceFromS3</code> operation is asynchronous. You can poll for updates by using
|
|
951
950
|
* the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
|
|
951
|
+
* @public
|
|
952
952
|
*/
|
|
953
953
|
export interface CreateDataSourceFromS3Output {
|
|
954
954
|
/**
|
|
955
|
-
* @public
|
|
956
955
|
* <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the
|
|
957
956
|
* <code>DataSourceID</code> in the request.
|
|
958
957
|
* </p>
|
|
958
|
+
* @public
|
|
959
959
|
*/
|
|
960
960
|
DataSourceId?: string;
|
|
961
961
|
}
|
|
@@ -964,42 +964,42 @@ export interface CreateDataSourceFromS3Output {
|
|
|
964
964
|
*/
|
|
965
965
|
export interface CreateEvaluationInput {
|
|
966
966
|
/**
|
|
967
|
-
* @public
|
|
968
967
|
* <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>.</p>
|
|
968
|
+
* @public
|
|
969
969
|
*/
|
|
970
970
|
EvaluationId: string | undefined;
|
|
971
971
|
/**
|
|
972
|
-
* @public
|
|
973
972
|
* <p>A user-supplied name or description of the <code>Evaluation</code>.</p>
|
|
973
|
+
* @public
|
|
974
974
|
*/
|
|
975
975
|
EvaluationName?: string;
|
|
976
976
|
/**
|
|
977
|
-
* @public
|
|
978
977
|
* <p>The ID of the <code>MLModel</code> to evaluate.</p>
|
|
979
978
|
* <p>The schema used in creating the <code>MLModel</code> must match the schema of the <code>DataSource</code> used in the <code>Evaluation</code>.</p>
|
|
979
|
+
* @public
|
|
980
980
|
*/
|
|
981
981
|
MLModelId: string | undefined;
|
|
982
982
|
/**
|
|
983
|
-
* @public
|
|
984
983
|
* <p>The ID of the <code>DataSource</code> for the evaluation. The schema of the <code>DataSource</code>
|
|
985
984
|
* must match the schema used to create the <code>MLModel</code>.</p>
|
|
985
|
+
* @public
|
|
986
986
|
*/
|
|
987
987
|
EvaluationDataSourceId: string | undefined;
|
|
988
988
|
}
|
|
989
989
|
/**
|
|
990
|
-
* @public
|
|
991
990
|
* <p> Represents the output of a <code>CreateEvaluation</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
992
991
|
* <p>
|
|
993
992
|
* <code>CreateEvaluation</code> operation is asynchronous. You can poll for status updates
|
|
994
993
|
* by using the <code>GetEvcaluation</code> operation
|
|
995
994
|
* and checking the <code>Status</code> parameter.
|
|
996
995
|
* </p>
|
|
996
|
+
* @public
|
|
997
997
|
*/
|
|
998
998
|
export interface CreateEvaluationOutput {
|
|
999
999
|
/**
|
|
1000
|
-
* @public
|
|
1001
1000
|
* <p>The user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the
|
|
1002
1001
|
* <code>EvaluationId</code> in the request.</p>
|
|
1002
|
+
* @public
|
|
1003
1003
|
*/
|
|
1004
1004
|
EvaluationId?: string;
|
|
1005
1005
|
}
|
|
@@ -1021,17 +1021,16 @@ export type MLModelType = (typeof MLModelType)[keyof typeof MLModelType];
|
|
|
1021
1021
|
*/
|
|
1022
1022
|
export interface CreateMLModelInput {
|
|
1023
1023
|
/**
|
|
1024
|
-
* @public
|
|
1025
1024
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
|
|
1025
|
+
* @public
|
|
1026
1026
|
*/
|
|
1027
1027
|
MLModelId: string | undefined;
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>A user-supplied name or description of the <code>MLModel</code>.</p>
|
|
1030
|
+
* @public
|
|
1031
1031
|
*/
|
|
1032
1032
|
MLModelName?: string;
|
|
1033
1033
|
/**
|
|
1034
|
-
* @public
|
|
1035
1034
|
* <p>The category of supervised learning that this <code>MLModel</code> will address. Choose from the following types:</p>
|
|
1036
1035
|
* <ul>
|
|
1037
1036
|
* <li>
|
|
@@ -1045,10 +1044,10 @@ export interface CreateMLModelInput {
|
|
|
1045
1044
|
* </li>
|
|
1046
1045
|
* </ul>
|
|
1047
1046
|
* <p> For more information, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
|
|
1047
|
+
* @public
|
|
1048
1048
|
*/
|
|
1049
1049
|
MLModelType: MLModelType | undefined;
|
|
1050
1050
|
/**
|
|
1051
|
-
* @public
|
|
1052
1051
|
* <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
|
|
1053
1052
|
* a map of key-value pairs.</p>
|
|
1054
1053
|
* <p>The following is the current set of training parameters:</p>
|
|
@@ -1094,38 +1093,39 @@ export interface CreateMLModelInput {
|
|
|
1094
1093
|
* <code>L1</code> is specified. Use this parameter sparingly.</p>
|
|
1095
1094
|
* </li>
|
|
1096
1095
|
* </ul>
|
|
1096
|
+
* @public
|
|
1097
1097
|
*/
|
|
1098
1098
|
Parameters?: Record<string, string>;
|
|
1099
1099
|
/**
|
|
1100
|
-
* @public
|
|
1101
1100
|
* <p>The <code>DataSource</code> that points to the training data.</p>
|
|
1101
|
+
* @public
|
|
1102
1102
|
*/
|
|
1103
1103
|
TrainingDataSourceId: string | undefined;
|
|
1104
1104
|
/**
|
|
1105
|
-
* @public
|
|
1106
1105
|
* <p>The data recipe for creating the <code>MLModel</code>. You must specify either the recipe
|
|
1107
1106
|
* or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
Recipe?: string;
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The Amazon Simple Storage Service (Amazon S3) location and file name that contains the <code>MLModel</code> recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
RecipeUri?: string;
|
|
1115
1115
|
}
|
|
1116
1116
|
/**
|
|
1117
|
-
* @public
|
|
1118
1117
|
* <p> Represents the output of a <code>CreateMLModel</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
|
|
1119
1118
|
* <p>The <code>CreateMLModel</code> operation is asynchronous. You can poll for status updates by using the
|
|
1120
1119
|
* <code>GetMLModel</code> operation and checking the <code>Status</code> parameter.
|
|
1121
1120
|
* </p>
|
|
1121
|
+
* @public
|
|
1122
1122
|
*/
|
|
1123
1123
|
export interface CreateMLModelOutput {
|
|
1124
1124
|
/**
|
|
1125
|
-
* @public
|
|
1126
1125
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
|
|
1127
1126
|
* <code>MLModelId</code> in the request.
|
|
1128
1127
|
* </p>
|
|
1128
|
+
* @public
|
|
1129
1129
|
*/
|
|
1130
1130
|
MLModelId?: string;
|
|
1131
1131
|
}
|
|
@@ -1134,8 +1134,8 @@ export interface CreateMLModelOutput {
|
|
|
1134
1134
|
*/
|
|
1135
1135
|
export interface CreateRealtimeEndpointInput {
|
|
1136
1136
|
/**
|
|
1137
|
-
* @public
|
|
1138
1137
|
* <p>The ID assigned to the <code>MLModel</code> during creation.</p>
|
|
1138
|
+
* @public
|
|
1139
1139
|
*/
|
|
1140
1140
|
MLModelId: string | undefined;
|
|
1141
1141
|
}
|
|
@@ -1154,29 +1154,28 @@ export declare const RealtimeEndpointStatus: {
|
|
|
1154
1154
|
*/
|
|
1155
1155
|
export type RealtimeEndpointStatus = (typeof RealtimeEndpointStatus)[keyof typeof RealtimeEndpointStatus];
|
|
1156
1156
|
/**
|
|
1157
|
-
* @public
|
|
1158
1157
|
* <p> Describes the real-time endpoint information for an <code>MLModel</code>.</p>
|
|
1158
|
+
* @public
|
|
1159
1159
|
*/
|
|
1160
1160
|
export interface RealtimeEndpointInfo {
|
|
1161
1161
|
/**
|
|
1162
|
-
* @public
|
|
1163
1162
|
* <p> The maximum processing rate for the real-time endpoint for <code>MLModel</code>, measured in incoming requests per second.</p>
|
|
1163
|
+
* @public
|
|
1164
1164
|
*/
|
|
1165
1165
|
PeakRequestsPerSecond?: number;
|
|
1166
1166
|
/**
|
|
1167
|
-
* @public
|
|
1168
1167
|
* <p>The time that the request to create the real-time endpoint for the <code>MLModel</code> was received. The time is expressed in epoch time.</p>
|
|
1168
|
+
* @public
|
|
1169
1169
|
*/
|
|
1170
1170
|
CreatedAt?: Date;
|
|
1171
1171
|
/**
|
|
1172
|
-
* @public
|
|
1173
1172
|
* <p>The URI that specifies where to send real-time prediction requests for the <code>MLModel</code>.</p>
|
|
1174
1173
|
* <p>
|
|
1175
1174
|
* <b>Note:</b> The application must wait until the real-time endpoint is ready before using this URI.</p>
|
|
1175
|
+
* @public
|
|
1176
1176
|
*/
|
|
1177
1177
|
EndpointUrl?: string;
|
|
1178
1178
|
/**
|
|
1179
|
-
* @public
|
|
1180
1179
|
* <p> The current status of the real-time endpoint for the <code>MLModel</code>. This element can have one of the following values: </p>
|
|
1181
1180
|
* <ul>
|
|
1182
1181
|
* <li>
|
|
@@ -1192,27 +1191,28 @@ export interface RealtimeEndpointInfo {
|
|
|
1192
1191
|
* <code>UPDATING</code> - Updating/creating the endpoint. </p>
|
|
1193
1192
|
* </li>
|
|
1194
1193
|
* </ul>
|
|
1194
|
+
* @public
|
|
1195
1195
|
*/
|
|
1196
1196
|
EndpointStatus?: RealtimeEndpointStatus;
|
|
1197
1197
|
}
|
|
1198
1198
|
/**
|
|
1199
|
-
* @public
|
|
1200
1199
|
* <p>Represents the output of an <code>CreateRealtimeEndpoint</code> operation.</p>
|
|
1201
1200
|
* <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>.</p>
|
|
1202
1201
|
* <p>
|
|
1203
1202
|
* <b>Note:</b> The endpoint information includes the URI of the <code>MLModel</code>; that is, the location to send online prediction requests for the specified <code>MLModel</code>.</p>
|
|
1203
|
+
* @public
|
|
1204
1204
|
*/
|
|
1205
1205
|
export interface CreateRealtimeEndpointOutput {
|
|
1206
1206
|
/**
|
|
1207
|
-
* @public
|
|
1208
1207
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
|
|
1209
1208
|
* <code>MLModelId</code> in the request.</p>
|
|
1209
|
+
* @public
|
|
1210
1210
|
*/
|
|
1211
1211
|
MLModelId?: string;
|
|
1212
1212
|
/**
|
|
1213
|
-
* @public
|
|
1214
1213
|
* <p>The endpoint information of the <code>MLModel</code>
|
|
1215
1214
|
* </p>
|
|
1215
|
+
* @public
|
|
1216
1216
|
*/
|
|
1217
1217
|
RealtimeEndpointInfo?: RealtimeEndpointInfo;
|
|
1218
1218
|
}
|
|
@@ -1221,21 +1221,21 @@ export interface CreateRealtimeEndpointOutput {
|
|
|
1221
1221
|
*/
|
|
1222
1222
|
export interface DeleteBatchPredictionInput {
|
|
1223
1223
|
/**
|
|
1224
|
-
* @public
|
|
1225
1224
|
* <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
|
|
1225
|
+
* @public
|
|
1226
1226
|
*/
|
|
1227
1227
|
BatchPredictionId: string | undefined;
|
|
1228
1228
|
}
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p> Represents the output of a <code>DeleteBatchPrediction</code> operation.</p>
|
|
1232
1231
|
* <p>You can use the <code>GetBatchPrediction</code> operation and check the value of the <code>Status</code> parameter to see whether a
|
|
1233
1232
|
* <code>BatchPrediction</code> is marked as <code>DELETED</code>.</p>
|
|
1233
|
+
* @public
|
|
1234
1234
|
*/
|
|
1235
1235
|
export interface DeleteBatchPredictionOutput {
|
|
1236
1236
|
/**
|
|
1237
|
-
* @public
|
|
1238
1237
|
* <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
|
|
1238
|
+
* @public
|
|
1239
1239
|
*/
|
|
1240
1240
|
BatchPredictionId?: string;
|
|
1241
1241
|
}
|
|
@@ -1244,19 +1244,19 @@ export interface DeleteBatchPredictionOutput {
|
|
|
1244
1244
|
*/
|
|
1245
1245
|
export interface DeleteDataSourceInput {
|
|
1246
1246
|
/**
|
|
1247
|
-
* @public
|
|
1248
1247
|
* <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
|
|
1248
|
+
* @public
|
|
1249
1249
|
*/
|
|
1250
1250
|
DataSourceId: string | undefined;
|
|
1251
1251
|
}
|
|
1252
1252
|
/**
|
|
1253
|
-
* @public
|
|
1254
1253
|
* <p> Represents the output of a <code>DeleteDataSource</code> operation.</p>
|
|
1254
|
+
* @public
|
|
1255
1255
|
*/
|
|
1256
1256
|
export interface DeleteDataSourceOutput {
|
|
1257
1257
|
/**
|
|
1258
|
-
* @public
|
|
1259
1258
|
* <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the <code>DataSourceID</code> in the request.</p>
|
|
1259
|
+
* @public
|
|
1260
1260
|
*/
|
|
1261
1261
|
DataSourceId?: string;
|
|
1262
1262
|
}
|
|
@@ -1265,21 +1265,21 @@ export interface DeleteDataSourceOutput {
|
|
|
1265
1265
|
*/
|
|
1266
1266
|
export interface DeleteEvaluationInput {
|
|
1267
1267
|
/**
|
|
1268
|
-
* @public
|
|
1269
1268
|
* <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</p>
|
|
1269
|
+
* @public
|
|
1270
1270
|
*/
|
|
1271
1271
|
EvaluationId: string | undefined;
|
|
1272
1272
|
}
|
|
1273
1273
|
/**
|
|
1274
|
-
* @public
|
|
1275
1274
|
* <p> Represents the output of a <code>DeleteEvaluation</code> operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.</p>
|
|
1276
1275
|
* <p>You can use the <code>GetEvaluation</code> operation and check the value of the <code>Status</code> parameter to see whether an
|
|
1277
1276
|
* <code>Evaluation</code> is marked as <code>DELETED</code>.</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
export interface DeleteEvaluationOutput {
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the <code>EvaluationId</code> in the request.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
EvaluationId?: string;
|
|
1285
1285
|
}
|
|
@@ -1288,21 +1288,21 @@ export interface DeleteEvaluationOutput {
|
|
|
1288
1288
|
*/
|
|
1289
1289
|
export interface DeleteMLModelInput {
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
|
|
1292
|
+
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
MLModelId: string | undefined;
|
|
1295
1295
|
}
|
|
1296
1296
|
/**
|
|
1297
|
-
* @public
|
|
1298
1297
|
* <p>Represents the output of a <code>DeleteMLModel</code> operation.</p>
|
|
1299
1298
|
* <p>You can use the <code>GetMLModel</code> operation and check the value of the <code>Status</code> parameter to see whether an
|
|
1300
1299
|
* <code>MLModel</code> is marked as <code>DELETED</code>.</p>
|
|
1300
|
+
* @public
|
|
1301
1301
|
*/
|
|
1302
1302
|
export interface DeleteMLModelOutput {
|
|
1303
1303
|
/**
|
|
1304
|
-
* @public
|
|
1305
1304
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the <code>MLModelID</code> in the request.</p>
|
|
1305
|
+
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
MLModelId?: string;
|
|
1308
1308
|
}
|
|
@@ -1311,27 +1311,27 @@ export interface DeleteMLModelOutput {
|
|
|
1311
1311
|
*/
|
|
1312
1312
|
export interface DeleteRealtimeEndpointInput {
|
|
1313
1313
|
/**
|
|
1314
|
-
* @public
|
|
1315
1314
|
* <p>The ID assigned to the <code>MLModel</code> during creation.</p>
|
|
1315
|
+
* @public
|
|
1316
1316
|
*/
|
|
1317
1317
|
MLModelId: string | undefined;
|
|
1318
1318
|
}
|
|
1319
1319
|
/**
|
|
1320
|
-
* @public
|
|
1321
1320
|
* <p>Represents the output of an <code>DeleteRealtimeEndpoint</code> operation.</p>
|
|
1322
1321
|
* <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>. </p>
|
|
1322
|
+
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
export interface DeleteRealtimeEndpointOutput {
|
|
1325
1325
|
/**
|
|
1326
|
-
* @public
|
|
1327
1326
|
* <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
|
|
1328
1327
|
* <code>MLModelId</code> in the request.</p>
|
|
1328
|
+
* @public
|
|
1329
1329
|
*/
|
|
1330
1330
|
MLModelId?: string;
|
|
1331
1331
|
/**
|
|
1332
|
-
* @public
|
|
1333
1332
|
* <p>The endpoint information of the <code>MLModel</code>
|
|
1334
1333
|
* </p>
|
|
1334
|
+
* @public
|
|
1335
1335
|
*/
|
|
1336
1336
|
RealtimeEndpointInfo?: RealtimeEndpointInfo;
|
|
1337
1337
|
}
|
|
@@ -1340,34 +1340,34 @@ export interface DeleteRealtimeEndpointOutput {
|
|
|
1340
1340
|
*/
|
|
1341
1341
|
export interface DeleteTagsInput {
|
|
1342
1342
|
/**
|
|
1343
|
-
* @public
|
|
1344
1343
|
* <p>One or more tags to delete.</p>
|
|
1344
|
+
* @public
|
|
1345
1345
|
*/
|
|
1346
1346
|
TagKeys: string[] | undefined;
|
|
1347
1347
|
/**
|
|
1348
|
-
* @public
|
|
1349
1348
|
* <p>The ID of the tagged ML object. For example, <code>exampleModelId</code>.</p>
|
|
1349
|
+
* @public
|
|
1350
1350
|
*/
|
|
1351
1351
|
ResourceId: string | undefined;
|
|
1352
1352
|
/**
|
|
1353
|
-
* @public
|
|
1354
1353
|
* <p>The type of the tagged ML object.</p>
|
|
1354
|
+
* @public
|
|
1355
1355
|
*/
|
|
1356
1356
|
ResourceType: TaggableResourceType | undefined;
|
|
1357
1357
|
}
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>Amazon ML returns the following elements.</p>
|
|
1360
|
+
* @public
|
|
1361
1361
|
*/
|
|
1362
1362
|
export interface DeleteTagsOutput {
|
|
1363
1363
|
/**
|
|
1364
|
-
* @public
|
|
1365
1364
|
* <p>The ID of the ML object from which tags were deleted.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
ResourceId?: string;
|
|
1368
1368
|
/**
|
|
1369
|
-
* @public
|
|
1370
1369
|
* <p>The type of the ML object from which tags were deleted.</p>
|
|
1370
|
+
* @public
|
|
1371
1371
|
*/
|
|
1372
1372
|
ResourceType?: TaggableResourceType;
|
|
1373
1373
|
}
|
|
@@ -1406,7 +1406,6 @@ export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
|
1406
1406
|
*/
|
|
1407
1407
|
export interface DescribeBatchPredictionsInput {
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
|
|
1411
1410
|
* <ul>
|
|
1412
1411
|
* <li>
|
|
@@ -1440,44 +1439,44 @@ export interface DescribeBatchPredictionsInput {
|
|
|
1440
1439
|
* <code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p>
|
|
1441
1440
|
* </li>
|
|
1442
1441
|
* </ul>
|
|
1442
|
+
* @public
|
|
1443
1443
|
*/
|
|
1444
1444
|
FilterVariable?: BatchPredictionFilterVariable;
|
|
1445
1445
|
/**
|
|
1446
|
-
* @public
|
|
1447
1446
|
* <p>The equal to operator. The <code>BatchPrediction</code> results will have
|
|
1448
1447
|
* <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
|
|
1448
|
+
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
EQ?: string;
|
|
1451
1451
|
/**
|
|
1452
|
-
* @public
|
|
1453
1452
|
* <p>The greater than operator. The <code>BatchPrediction</code> results will
|
|
1454
1453
|
* have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
|
|
1454
|
+
* @public
|
|
1455
1455
|
*/
|
|
1456
1456
|
GT?: string;
|
|
1457
1457
|
/**
|
|
1458
|
-
* @public
|
|
1459
1458
|
* <p>The less than operator. The <code>BatchPrediction</code> results will
|
|
1460
1459
|
* have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
|
|
1460
|
+
* @public
|
|
1461
1461
|
*/
|
|
1462
1462
|
LT?: string;
|
|
1463
1463
|
/**
|
|
1464
|
-
* @public
|
|
1465
1464
|
* <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
|
|
1466
1465
|
* </p>
|
|
1466
|
+
* @public
|
|
1467
1467
|
*/
|
|
1468
1468
|
GE?: string;
|
|
1469
1469
|
/**
|
|
1470
|
-
* @public
|
|
1471
1470
|
* <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
|
|
1471
|
+
* @public
|
|
1472
1472
|
*/
|
|
1473
1473
|
LE?: string;
|
|
1474
1474
|
/**
|
|
1475
|
-
* @public
|
|
1476
1475
|
* <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
|
|
1476
|
+
* @public
|
|
1477
1477
|
*/
|
|
1478
1478
|
NE?: string;
|
|
1479
1479
|
/**
|
|
1480
|
-
* @public
|
|
1481
1480
|
* <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
|
|
1482
1481
|
* <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code>
|
|
1483
1482
|
* <code>2014-09-09-HolidayGiftMailer</code>. To search for
|
|
@@ -1496,10 +1495,10 @@ export interface DescribeBatchPredictionsInput {
|
|
|
1496
1495
|
* <p>2014-09-09-Holiday</p>
|
|
1497
1496
|
* </li>
|
|
1498
1497
|
* </ul>
|
|
1498
|
+
* @public
|
|
1499
1499
|
*/
|
|
1500
1500
|
Prefix?: string;
|
|
1501
1501
|
/**
|
|
1502
|
-
* @public
|
|
1503
1502
|
* <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
|
|
1504
1503
|
* <ul>
|
|
1505
1504
|
* <li>
|
|
@@ -1512,16 +1511,17 @@ export interface DescribeBatchPredictionsInput {
|
|
|
1512
1511
|
* </li>
|
|
1513
1512
|
* </ul>
|
|
1514
1513
|
* <p>Results are sorted by <code>FilterVariable</code>.</p>
|
|
1514
|
+
* @public
|
|
1515
1515
|
*/
|
|
1516
1516
|
SortOrder?: SortOrder;
|
|
1517
1517
|
/**
|
|
1518
|
-
* @public
|
|
1519
1518
|
* <p>An ID of the page in the paginated results.</p>
|
|
1519
|
+
* @public
|
|
1520
1520
|
*/
|
|
1521
1521
|
NextToken?: string;
|
|
1522
1522
|
/**
|
|
1523
|
-
* @public
|
|
1524
1523
|
* <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
Limit?: number;
|
|
1527
1527
|
}
|
|
@@ -1541,56 +1541,55 @@ export declare const EntityStatus: {
|
|
|
1541
1541
|
*/
|
|
1542
1542
|
export type EntityStatus = (typeof EntityStatus)[keyof typeof EntityStatus];
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p> Represents the output of a <code>GetBatchPrediction</code> operation.</p>
|
|
1546
1545
|
* <p> The content consists of the detailed metadata, the status, and the data file information of a
|
|
1547
1546
|
* <code>Batch Prediction</code>.</p>
|
|
1547
|
+
* @public
|
|
1548
1548
|
*/
|
|
1549
1549
|
export interface BatchPrediction {
|
|
1550
1550
|
/**
|
|
1551
|
-
* @public
|
|
1552
1551
|
* <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
|
|
1553
1552
|
* in the request.
|
|
1554
1553
|
* </p>
|
|
1554
|
+
* @public
|
|
1555
1555
|
*/
|
|
1556
1556
|
BatchPredictionId?: string;
|
|
1557
1557
|
/**
|
|
1558
|
-
* @public
|
|
1559
1558
|
* <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
|
|
1559
|
+
* @public
|
|
1560
1560
|
*/
|
|
1561
1561
|
MLModelId?: string;
|
|
1562
1562
|
/**
|
|
1563
|
-
* @public
|
|
1564
1563
|
* <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
|
|
1564
|
+
* @public
|
|
1565
1565
|
*/
|
|
1566
1566
|
BatchPredictionDataSourceId?: string;
|
|
1567
1567
|
/**
|
|
1568
|
-
* @public
|
|
1569
1568
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
1569
|
+
* @public
|
|
1570
1570
|
*/
|
|
1571
1571
|
InputDataLocationS3?: string;
|
|
1572
1572
|
/**
|
|
1573
|
-
* @public
|
|
1574
1573
|
* <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
1574
|
+
* @public
|
|
1575
1575
|
*/
|
|
1576
1576
|
CreatedByIamUser?: string;
|
|
1577
1577
|
/**
|
|
1578
|
-
* @public
|
|
1579
1578
|
* <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
|
|
1579
|
+
* @public
|
|
1580
1580
|
*/
|
|
1581
1581
|
CreatedAt?: Date;
|
|
1582
1582
|
/**
|
|
1583
|
-
* @public
|
|
1584
1583
|
* <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
|
|
1584
|
+
* @public
|
|
1585
1585
|
*/
|
|
1586
1586
|
LastUpdatedAt?: Date;
|
|
1587
1587
|
/**
|
|
1588
|
-
* @public
|
|
1589
1588
|
* <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
|
|
1589
|
+
* @public
|
|
1590
1590
|
*/
|
|
1591
1591
|
Name?: string;
|
|
1592
1592
|
/**
|
|
1593
|
-
* @public
|
|
1594
1593
|
* <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
|
|
1595
1594
|
* <ul>
|
|
1596
1595
|
* <li>
|
|
@@ -1614,58 +1613,59 @@ export interface BatchPrediction {
|
|
|
1614
1613
|
* <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p>
|
|
1615
1614
|
* </li>
|
|
1616
1615
|
* </ul>
|
|
1616
|
+
* @public
|
|
1617
1617
|
*/
|
|
1618
1618
|
Status?: EntityStatus;
|
|
1619
1619
|
/**
|
|
1620
|
-
* @public
|
|
1621
1620
|
* <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
|
|
1621
|
+
* @public
|
|
1622
1622
|
*/
|
|
1623
1623
|
OutputUri?: string;
|
|
1624
1624
|
/**
|
|
1625
|
-
* @public
|
|
1626
1625
|
* <p>A description of the most recent details about processing the batch prediction request.</p>
|
|
1626
|
+
* @public
|
|
1627
1627
|
*/
|
|
1628
1628
|
Message?: string;
|
|
1629
1629
|
/**
|
|
1630
|
-
* @public
|
|
1631
1630
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
1631
|
+
* @public
|
|
1632
1632
|
*/
|
|
1633
1633
|
ComputeTime?: number;
|
|
1634
1634
|
/**
|
|
1635
|
-
* @public
|
|
1636
1635
|
* <p>A timestamp represented in epoch time.</p>
|
|
1636
|
+
* @public
|
|
1637
1637
|
*/
|
|
1638
1638
|
FinishedAt?: Date;
|
|
1639
1639
|
/**
|
|
1640
|
-
* @public
|
|
1641
1640
|
* <p>A timestamp represented in epoch time.</p>
|
|
1641
|
+
* @public
|
|
1642
1642
|
*/
|
|
1643
1643
|
StartedAt?: Date;
|
|
1644
1644
|
/**
|
|
1645
|
-
* @public
|
|
1646
1645
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
1646
|
+
* @public
|
|
1647
1647
|
*/
|
|
1648
1648
|
TotalRecordCount?: number;
|
|
1649
1649
|
/**
|
|
1650
|
-
* @public
|
|
1651
1650
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
1651
|
+
* @public
|
|
1652
1652
|
*/
|
|
1653
1653
|
InvalidRecordCount?: number;
|
|
1654
1654
|
}
|
|
1655
1655
|
/**
|
|
1656
|
-
* @public
|
|
1657
1656
|
* <p>Represents the output of a <code>DescribeBatchPredictions</code> operation. The content is essentially a list of <code>BatchPrediction</code>s.</p>
|
|
1657
|
+
* @public
|
|
1658
1658
|
*/
|
|
1659
1659
|
export interface DescribeBatchPredictionsOutput {
|
|
1660
1660
|
/**
|
|
1661
|
-
* @public
|
|
1662
1661
|
* <p>A list of <code>BatchPrediction</code> objects that meet the search criteria.
|
|
1663
1662
|
* </p>
|
|
1663
|
+
* @public
|
|
1664
1664
|
*/
|
|
1665
1665
|
Results?: BatchPrediction[];
|
|
1666
1666
|
/**
|
|
1667
|
-
* @public
|
|
1668
1667
|
* <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
|
|
1668
|
+
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
NextToken?: string;
|
|
1671
1671
|
}
|
|
@@ -1690,7 +1690,6 @@ export type DataSourceFilterVariable = (typeof DataSourceFilterVariable)[keyof t
|
|
|
1690
1690
|
*/
|
|
1691
1691
|
export interface DescribeDataSourcesInput {
|
|
1692
1692
|
/**
|
|
1693
|
-
* @public
|
|
1694
1693
|
* <p>Use one of the following variables to filter a list of <code>DataSource</code>:</p>
|
|
1695
1694
|
* <ul>
|
|
1696
1695
|
* <li>
|
|
@@ -1715,44 +1714,44 @@ export interface DescribeDataSourcesInput {
|
|
|
1715
1714
|
* <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>DataSource</code> creation.</p>
|
|
1716
1715
|
* </li>
|
|
1717
1716
|
* </ul>
|
|
1717
|
+
* @public
|
|
1718
1718
|
*/
|
|
1719
1719
|
FilterVariable?: DataSourceFilterVariable;
|
|
1720
1720
|
/**
|
|
1721
|
-
* @public
|
|
1722
1721
|
* <p>The equal to operator. The <code>DataSource</code> results will have
|
|
1723
1722
|
* <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
|
|
1723
|
+
* @public
|
|
1724
1724
|
*/
|
|
1725
1725
|
EQ?: string;
|
|
1726
1726
|
/**
|
|
1727
|
-
* @public
|
|
1728
1727
|
* <p>The greater than operator. The <code>DataSource</code> results will
|
|
1729
1728
|
* have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
|
|
1729
|
+
* @public
|
|
1730
1730
|
*/
|
|
1731
1731
|
GT?: string;
|
|
1732
1732
|
/**
|
|
1733
|
-
* @public
|
|
1734
1733
|
* <p>The less than operator. The <code>DataSource</code> results will
|
|
1735
1734
|
* have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
|
|
1735
|
+
* @public
|
|
1736
1736
|
*/
|
|
1737
1737
|
LT?: string;
|
|
1738
1738
|
/**
|
|
1739
|
-
* @public
|
|
1740
1739
|
* <p>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
|
|
1741
1740
|
* </p>
|
|
1741
|
+
* @public
|
|
1742
1742
|
*/
|
|
1743
1743
|
GE?: string;
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
|
|
1746
|
+
* @public
|
|
1747
1747
|
*/
|
|
1748
1748
|
LE?: string;
|
|
1749
1749
|
/**
|
|
1750
|
-
* @public
|
|
1751
1750
|
* <p>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
|
|
1751
|
+
* @public
|
|
1752
1752
|
*/
|
|
1753
1753
|
NE?: string;
|
|
1754
1754
|
/**
|
|
1755
|
-
* @public
|
|
1756
1755
|
* <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
|
|
1757
1756
|
* <p>For example, a <code>DataSource</code> could have the <code>Name</code>
|
|
1758
1757
|
* <code>2014-09-09-HolidayGiftMailer</code>. To search for
|
|
@@ -1771,10 +1770,10 @@ export interface DescribeDataSourcesInput {
|
|
|
1771
1770
|
* <p>2014-09-09-Holiday</p>
|
|
1772
1771
|
* </li>
|
|
1773
1772
|
* </ul>
|
|
1773
|
+
* @public
|
|
1774
1774
|
*/
|
|
1775
1775
|
Prefix?: string;
|
|
1776
1776
|
/**
|
|
1777
|
-
* @public
|
|
1778
1777
|
* <p>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>.</p>
|
|
1779
1778
|
* <ul>
|
|
1780
1779
|
* <li>
|
|
@@ -1787,133 +1786,133 @@ export interface DescribeDataSourcesInput {
|
|
|
1787
1786
|
* </li>
|
|
1788
1787
|
* </ul>
|
|
1789
1788
|
* <p>Results are sorted by <code>FilterVariable</code>.</p>
|
|
1789
|
+
* @public
|
|
1790
1790
|
*/
|
|
1791
1791
|
SortOrder?: SortOrder;
|
|
1792
1792
|
/**
|
|
1793
|
-
* @public
|
|
1794
1793
|
* <p>The ID of the page in the paginated results.</p>
|
|
1794
|
+
* @public
|
|
1795
1795
|
*/
|
|
1796
1796
|
NextToken?: string;
|
|
1797
1797
|
/**
|
|
1798
|
-
* @public
|
|
1799
1798
|
* <p> The maximum number of <code>DataSource</code> to include in the result.</p>
|
|
1799
|
+
* @public
|
|
1800
1800
|
*/
|
|
1801
1801
|
Limit?: number;
|
|
1802
1802
|
}
|
|
1803
1803
|
/**
|
|
1804
|
-
* @public
|
|
1805
1804
|
* <p>The datasource details that are specific to Amazon RDS.</p>
|
|
1805
|
+
* @public
|
|
1806
1806
|
*/
|
|
1807
1807
|
export interface RDSMetadata {
|
|
1808
1808
|
/**
|
|
1809
|
-
* @public
|
|
1810
1809
|
* <p>The database details required to connect to an Amazon RDS.</p>
|
|
1810
|
+
* @public
|
|
1811
1811
|
*/
|
|
1812
1812
|
Database?: RDSDatabase;
|
|
1813
1813
|
/**
|
|
1814
|
-
* @public
|
|
1815
1814
|
* <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
|
|
1816
1815
|
* The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
|
|
1816
|
+
* @public
|
|
1817
1817
|
*/
|
|
1818
1818
|
DatabaseUserName?: string;
|
|
1819
1819
|
/**
|
|
1820
|
-
* @public
|
|
1821
1820
|
* <p>The SQL query that is supplied during <a>CreateDataSourceFromRDS</a>. Returns only if <code>Verbose</code> is true in <code>GetDataSourceInput</code>. </p>
|
|
1821
|
+
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
SelectSqlQuery?: string;
|
|
1824
1824
|
/**
|
|
1825
|
-
* @public
|
|
1826
1825
|
* <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
|
|
1826
|
+
* @public
|
|
1827
1827
|
*/
|
|
1828
1828
|
ResourceRole?: string;
|
|
1829
1829
|
/**
|
|
1830
|
-
* @public
|
|
1831
1830
|
* <p>The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
|
|
1831
|
+
* @public
|
|
1832
1832
|
*/
|
|
1833
1833
|
ServiceRole?: string;
|
|
1834
1834
|
/**
|
|
1835
|
-
* @public
|
|
1836
1835
|
* <p>The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.</p>
|
|
1836
|
+
* @public
|
|
1837
1837
|
*/
|
|
1838
1838
|
DataPipelineId?: string;
|
|
1839
1839
|
}
|
|
1840
1840
|
/**
|
|
1841
|
-
* @public
|
|
1842
1841
|
* <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
|
|
1842
|
+
* @public
|
|
1843
1843
|
*/
|
|
1844
1844
|
export interface RedshiftMetadata {
|
|
1845
1845
|
/**
|
|
1846
|
-
* @public
|
|
1847
1846
|
* <p>Describes the database details required to connect to an Amazon Redshift database.</p>
|
|
1847
|
+
* @public
|
|
1848
1848
|
*/
|
|
1849
1849
|
RedshiftDatabase?: RedshiftDatabase;
|
|
1850
1850
|
/**
|
|
1851
|
-
* @public
|
|
1852
1851
|
* <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
|
|
1853
1852
|
* The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
DatabaseUserName?: string;
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <p> The SQL query that is specified during <a>CreateDataSourceFromRedshift</a>. Returns only if <code>Verbose</code> is true in GetDataSourceInput. </p>
|
|
1858
|
+
* @public
|
|
1859
1859
|
*/
|
|
1860
1860
|
SelectSqlQuery?: string;
|
|
1861
1861
|
}
|
|
1862
1862
|
/**
|
|
1863
|
-
* @public
|
|
1864
1863
|
* <p> Represents the output of the <code>GetDataSource</code> operation. </p>
|
|
1865
1864
|
* <p> The content consists of the detailed metadata and data file information and the current status of the <code>DataSource</code>. </p>
|
|
1865
|
+
* @public
|
|
1866
1866
|
*/
|
|
1867
1867
|
export interface DataSource {
|
|
1868
1868
|
/**
|
|
1869
|
-
* @public
|
|
1870
1869
|
* <p>The ID that is assigned to the <code>DataSource</code> during creation.</p>
|
|
1870
|
+
* @public
|
|
1871
1871
|
*/
|
|
1872
1872
|
DataSourceId?: string;
|
|
1873
1873
|
/**
|
|
1874
|
-
* @public
|
|
1875
1874
|
* <p>The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a <code>DataSource</code>.</p>
|
|
1875
|
+
* @public
|
|
1876
1876
|
*/
|
|
1877
1877
|
DataLocationS3?: string;
|
|
1878
1878
|
/**
|
|
1879
|
-
* @public
|
|
1880
1879
|
* <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
|
|
1881
1880
|
* was created.</p>
|
|
1881
|
+
* @public
|
|
1882
1882
|
*/
|
|
1883
1883
|
DataRearrangement?: string;
|
|
1884
1884
|
/**
|
|
1885
|
-
* @public
|
|
1886
1885
|
* <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
1886
|
+
* @public
|
|
1887
1887
|
*/
|
|
1888
1888
|
CreatedByIamUser?: string;
|
|
1889
1889
|
/**
|
|
1890
|
-
* @public
|
|
1891
1890
|
* <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
|
|
1891
|
+
* @public
|
|
1892
1892
|
*/
|
|
1893
1893
|
CreatedAt?: Date;
|
|
1894
1894
|
/**
|
|
1895
|
-
* @public
|
|
1896
1895
|
* <p>The time of the most recent edit to the
|
|
1897
1896
|
* <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
|
|
1897
|
+
* @public
|
|
1898
1898
|
*/
|
|
1899
1899
|
LastUpdatedAt?: Date;
|
|
1900
1900
|
/**
|
|
1901
|
-
* @public
|
|
1902
1901
|
* <p>The total number of observations contained in the data files that the <code>DataSource</code> references.</p>
|
|
1902
|
+
* @public
|
|
1903
1903
|
*/
|
|
1904
1904
|
DataSizeInBytes?: number;
|
|
1905
1905
|
/**
|
|
1906
|
-
* @public
|
|
1907
1906
|
* <p>The number of data files referenced by the <code>DataSource</code>.</p>
|
|
1907
|
+
* @public
|
|
1908
1908
|
*/
|
|
1909
1909
|
NumberOfFiles?: number;
|
|
1910
1910
|
/**
|
|
1911
|
-
* @public
|
|
1912
1911
|
* <p>A user-supplied name or description of the <code>DataSource</code>.</p>
|
|
1912
|
+
* @public
|
|
1913
1913
|
*/
|
|
1914
1914
|
Name?: string;
|
|
1915
1915
|
/**
|
|
1916
|
-
* @public
|
|
1917
1916
|
* <p>The current status of the <code>DataSource</code>. This element can have one of the following values: </p>
|
|
1918
1917
|
* <ul>
|
|
1919
1918
|
* <li>
|
|
@@ -1932,65 +1931,66 @@ export interface DataSource {
|
|
|
1932
1931
|
* <p>DELETED - The <code>DataSource</code> is marked as deleted. It is not usable.</p>
|
|
1933
1932
|
* </li>
|
|
1934
1933
|
* </ul>
|
|
1934
|
+
* @public
|
|
1935
1935
|
*/
|
|
1936
1936
|
Status?: EntityStatus;
|
|
1937
1937
|
/**
|
|
1938
|
-
* @public
|
|
1939
1938
|
* <p>A description of the most recent details about creating the <code>DataSource</code>.</p>
|
|
1939
|
+
* @public
|
|
1940
1940
|
*/
|
|
1941
1941
|
Message?: string;
|
|
1942
1942
|
/**
|
|
1943
|
-
* @public
|
|
1944
1943
|
* <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
|
|
1944
|
+
* @public
|
|
1945
1945
|
*/
|
|
1946
1946
|
RedshiftMetadata?: RedshiftMetadata;
|
|
1947
1947
|
/**
|
|
1948
|
-
* @public
|
|
1949
1948
|
* <p>The datasource details that are specific to Amazon RDS.</p>
|
|
1949
|
+
* @public
|
|
1950
1950
|
*/
|
|
1951
1951
|
RDSMetadata?: RDSMetadata;
|
|
1952
1952
|
/**
|
|
1953
|
-
* @public
|
|
1954
1953
|
* <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
|
|
1954
|
+
* @public
|
|
1955
1955
|
*/
|
|
1956
1956
|
RoleARN?: string;
|
|
1957
1957
|
/**
|
|
1958
|
-
* @public
|
|
1959
1958
|
* <p>
|
|
1960
1959
|
* The parameter is <code>true</code> if statistics need to be generated from the observation data.
|
|
1961
1960
|
* </p>
|
|
1961
|
+
* @public
|
|
1962
1962
|
*/
|
|
1963
1963
|
ComputeStatistics?: boolean;
|
|
1964
1964
|
/**
|
|
1965
|
-
* @public
|
|
1966
1965
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
1966
|
+
* @public
|
|
1967
1967
|
*/
|
|
1968
1968
|
ComputeTime?: number;
|
|
1969
1969
|
/**
|
|
1970
|
-
* @public
|
|
1971
1970
|
* <p>A timestamp represented in epoch time.</p>
|
|
1971
|
+
* @public
|
|
1972
1972
|
*/
|
|
1973
1973
|
FinishedAt?: Date;
|
|
1974
1974
|
/**
|
|
1975
|
-
* @public
|
|
1976
1975
|
* <p>A timestamp represented in epoch time.</p>
|
|
1976
|
+
* @public
|
|
1977
1977
|
*/
|
|
1978
1978
|
StartedAt?: Date;
|
|
1979
1979
|
}
|
|
1980
1980
|
/**
|
|
1981
|
-
* @public
|
|
1982
1981
|
* <p>Represents the query results from a <a>DescribeDataSources</a> operation. The content is essentially a list of <code>DataSource</code>.</p>
|
|
1982
|
+
* @public
|
|
1983
1983
|
*/
|
|
1984
1984
|
export interface DescribeDataSourcesOutput {
|
|
1985
1985
|
/**
|
|
1986
|
-
* @public
|
|
1987
1986
|
* <p>A list of <code>DataSource</code> that meet the search criteria.
|
|
1988
1987
|
* </p>
|
|
1988
|
+
* @public
|
|
1989
1989
|
*/
|
|
1990
1990
|
Results?: DataSource[];
|
|
1991
1991
|
/**
|
|
1992
|
-
* @public
|
|
1993
1992
|
* <p>An ID of the next page in the paginated results that indicates at least one more page follows.</p>
|
|
1993
|
+
* @public
|
|
1994
1994
|
*/
|
|
1995
1995
|
NextToken?: string;
|
|
1996
1996
|
}
|
|
@@ -2017,7 +2017,6 @@ export type EvaluationFilterVariable = (typeof EvaluationFilterVariable)[keyof t
|
|
|
2017
2017
|
*/
|
|
2018
2018
|
export interface DescribeEvaluationsInput {
|
|
2019
2019
|
/**
|
|
2020
|
-
* @public
|
|
2021
2020
|
* <p>Use one of the following variable to filter a list of <code>Evaluation</code> objects:</p>
|
|
2022
2021
|
* <ul>
|
|
2023
2022
|
* <li>
|
|
@@ -2051,44 +2050,44 @@ export interface DescribeEvaluationsInput {
|
|
|
2051
2050
|
* <code>DataUri</code> - Sets the search criteria to the data file(s) used in <code>Evaluation</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p>
|
|
2052
2051
|
* </li>
|
|
2053
2052
|
* </ul>
|
|
2053
|
+
* @public
|
|
2054
2054
|
*/
|
|
2055
2055
|
FilterVariable?: EvaluationFilterVariable;
|
|
2056
2056
|
/**
|
|
2057
|
-
* @public
|
|
2058
2057
|
* <p>The equal to operator. The <code>Evaluation</code> results will have
|
|
2059
2058
|
* <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
|
|
2059
|
+
* @public
|
|
2060
2060
|
*/
|
|
2061
2061
|
EQ?: string;
|
|
2062
2062
|
/**
|
|
2063
|
-
* @public
|
|
2064
2063
|
* <p>The greater than operator. The <code>Evaluation</code> results will
|
|
2065
2064
|
* have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
|
|
2065
|
+
* @public
|
|
2066
2066
|
*/
|
|
2067
2067
|
GT?: string;
|
|
2068
2068
|
/**
|
|
2069
|
-
* @public
|
|
2070
2069
|
* <p>The less than operator. The <code>Evaluation</code> results will
|
|
2071
2070
|
* have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
|
|
2071
|
+
* @public
|
|
2072
2072
|
*/
|
|
2073
2073
|
LT?: string;
|
|
2074
2074
|
/**
|
|
2075
|
-
* @public
|
|
2076
2075
|
* <p>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
|
|
2077
2076
|
* </p>
|
|
2077
|
+
* @public
|
|
2078
2078
|
*/
|
|
2079
2079
|
GE?: string;
|
|
2080
2080
|
/**
|
|
2081
|
-
* @public
|
|
2082
2081
|
* <p>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
|
|
2082
|
+
* @public
|
|
2083
2083
|
*/
|
|
2084
2084
|
LE?: string;
|
|
2085
2085
|
/**
|
|
2086
|
-
* @public
|
|
2087
2086
|
* <p>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
|
|
2087
|
+
* @public
|
|
2088
2088
|
*/
|
|
2089
2089
|
NE?: string;
|
|
2090
2090
|
/**
|
|
2091
|
-
* @public
|
|
2092
2091
|
* <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
|
|
2093
2092
|
* <p>For example, an <code>Evaluation</code> could have the <code>Name</code>
|
|
2094
2093
|
* <code>2014-09-09-HolidayGiftMailer</code>. To search for
|
|
@@ -2107,10 +2106,10 @@ export interface DescribeEvaluationsInput {
|
|
|
2107
2106
|
* <p>2014-09-09-Holiday</p>
|
|
2108
2107
|
* </li>
|
|
2109
2108
|
* </ul>
|
|
2109
|
+
* @public
|
|
2110
2110
|
*/
|
|
2111
2111
|
Prefix?: string;
|
|
2112
2112
|
/**
|
|
2113
|
-
* @public
|
|
2114
2113
|
* <p>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>.</p>
|
|
2115
2114
|
* <ul>
|
|
2116
2115
|
* <li>
|
|
@@ -2123,21 +2122,21 @@ export interface DescribeEvaluationsInput {
|
|
|
2123
2122
|
* </li>
|
|
2124
2123
|
* </ul>
|
|
2125
2124
|
* <p>Results are sorted by <code>FilterVariable</code>.</p>
|
|
2125
|
+
* @public
|
|
2126
2126
|
*/
|
|
2127
2127
|
SortOrder?: SortOrder;
|
|
2128
2128
|
/**
|
|
2129
|
-
* @public
|
|
2130
2129
|
* <p>The ID of the page in the paginated results.</p>
|
|
2130
|
+
* @public
|
|
2131
2131
|
*/
|
|
2132
2132
|
NextToken?: string;
|
|
2133
2133
|
/**
|
|
2134
|
-
* @public
|
|
2135
2134
|
* <p> The maximum number of <code>Evaluation</code> to include in the result.</p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
Limit?: number;
|
|
2138
2138
|
}
|
|
2139
2139
|
/**
|
|
2140
|
-
* @public
|
|
2141
2140
|
* <p>Measurements of how well the <code>MLModel</code> performed on known observations. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
|
|
2142
2141
|
* </p>
|
|
2143
2142
|
* <ul>
|
|
@@ -2154,59 +2153,59 @@ export interface DescribeEvaluationsInput {
|
|
|
2154
2153
|
* <p>
|
|
2155
2154
|
* For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
|
|
2156
2155
|
* </p>
|
|
2156
|
+
* @public
|
|
2157
2157
|
*/
|
|
2158
2158
|
export interface PerformanceMetrics {
|
|
2159
2159
|
Properties?: Record<string, string>;
|
|
2160
2160
|
}
|
|
2161
2161
|
/**
|
|
2162
|
-
* @public
|
|
2163
2162
|
* <p> Represents the output of <code>GetEvaluation</code> operation. </p>
|
|
2164
2163
|
* <p>The content consists of the detailed metadata and data file information and the current status of the
|
|
2165
2164
|
* <code>Evaluation</code>.</p>
|
|
2165
|
+
* @public
|
|
2166
2166
|
*/
|
|
2167
2167
|
export interface Evaluation {
|
|
2168
2168
|
/**
|
|
2169
|
-
* @public
|
|
2170
2169
|
* <p>The ID that is assigned to the <code>Evaluation</code> at creation.</p>
|
|
2170
|
+
* @public
|
|
2171
2171
|
*/
|
|
2172
2172
|
EvaluationId?: string;
|
|
2173
2173
|
/**
|
|
2174
|
-
* @public
|
|
2175
2174
|
* <p>The ID of the <code>MLModel</code> that is the focus of the evaluation.</p>
|
|
2175
|
+
* @public
|
|
2176
2176
|
*/
|
|
2177
2177
|
MLModelId?: string;
|
|
2178
2178
|
/**
|
|
2179
|
-
* @public
|
|
2180
2179
|
* <p>The ID of the <code>DataSource</code> that is used to evaluate the <code>MLModel</code>.</p>
|
|
2180
|
+
* @public
|
|
2181
2181
|
*/
|
|
2182
2182
|
EvaluationDataSourceId?: string;
|
|
2183
2183
|
/**
|
|
2184
|
-
* @public
|
|
2185
2184
|
* <p>The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.</p>
|
|
2185
|
+
* @public
|
|
2186
2186
|
*/
|
|
2187
2187
|
InputDataLocationS3?: string;
|
|
2188
2188
|
/**
|
|
2189
|
-
* @public
|
|
2190
2189
|
* <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
2190
|
+
* @public
|
|
2191
2191
|
*/
|
|
2192
2192
|
CreatedByIamUser?: string;
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
|
|
2195
|
+
* @public
|
|
2196
2196
|
*/
|
|
2197
2197
|
CreatedAt?: Date;
|
|
2198
2198
|
/**
|
|
2199
|
-
* @public
|
|
2200
2199
|
* <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
|
|
2200
|
+
* @public
|
|
2201
2201
|
*/
|
|
2202
2202
|
LastUpdatedAt?: Date;
|
|
2203
2203
|
/**
|
|
2204
|
-
* @public
|
|
2205
2204
|
* <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
|
|
2205
|
+
* @public
|
|
2206
2206
|
*/
|
|
2207
2207
|
Name?: string;
|
|
2208
2208
|
/**
|
|
2209
|
-
* @public
|
|
2210
2209
|
* <p>The status of the evaluation. This element can have one of the following values:</p>
|
|
2211
2210
|
* <ul>
|
|
2212
2211
|
* <li>
|
|
@@ -2230,10 +2229,10 @@ export interface Evaluation {
|
|
|
2230
2229
|
* <code>DELETED</code> - The <code>Evaluation</code> is marked as deleted. It is not usable.</p>
|
|
2231
2230
|
* </li>
|
|
2232
2231
|
* </ul>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
Status?: EntityStatus;
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>Measurements of how well the <code>MLModel</code> performed, using observations referenced
|
|
2238
2237
|
* by the <code>DataSource</code>. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
|
|
2239
2238
|
* </p>
|
|
@@ -2251,43 +2250,44 @@ export interface Evaluation {
|
|
|
2251
2250
|
* <p>
|
|
2252
2251
|
* For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
|
|
2253
2252
|
* </p>
|
|
2253
|
+
* @public
|
|
2254
2254
|
*/
|
|
2255
2255
|
PerformanceMetrics?: PerformanceMetrics;
|
|
2256
2256
|
/**
|
|
2257
|
-
* @public
|
|
2258
2257
|
* <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
|
|
2258
|
+
* @public
|
|
2259
2259
|
*/
|
|
2260
2260
|
Message?: string;
|
|
2261
2261
|
/**
|
|
2262
|
-
* @public
|
|
2263
2262
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
2263
|
+
* @public
|
|
2264
2264
|
*/
|
|
2265
2265
|
ComputeTime?: number;
|
|
2266
2266
|
/**
|
|
2267
|
-
* @public
|
|
2268
2267
|
* <p>A timestamp represented in epoch time.</p>
|
|
2268
|
+
* @public
|
|
2269
2269
|
*/
|
|
2270
2270
|
FinishedAt?: Date;
|
|
2271
2271
|
/**
|
|
2272
|
-
* @public
|
|
2273
2272
|
* <p>A timestamp represented in epoch time.</p>
|
|
2273
|
+
* @public
|
|
2274
2274
|
*/
|
|
2275
2275
|
StartedAt?: Date;
|
|
2276
2276
|
}
|
|
2277
2277
|
/**
|
|
2278
|
-
* @public
|
|
2279
2278
|
* <p>Represents the query results from a <code>DescribeEvaluations</code> operation. The content is essentially a list of <code>Evaluation</code>.</p>
|
|
2279
|
+
* @public
|
|
2280
2280
|
*/
|
|
2281
2281
|
export interface DescribeEvaluationsOutput {
|
|
2282
2282
|
/**
|
|
2283
|
-
* @public
|
|
2284
2283
|
* <p>A list of <code>Evaluation</code> that meet the search criteria.
|
|
2285
2284
|
* </p>
|
|
2285
|
+
* @public
|
|
2286
2286
|
*/
|
|
2287
2287
|
Results?: Evaluation[];
|
|
2288
2288
|
/**
|
|
2289
|
-
* @public
|
|
2290
2289
|
* <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
|
|
2290
|
+
* @public
|
|
2291
2291
|
*/
|
|
2292
2292
|
NextToken?: string;
|
|
2293
2293
|
}
|
|
@@ -2316,7 +2316,6 @@ export type MLModelFilterVariable = (typeof MLModelFilterVariable)[keyof typeof
|
|
|
2316
2316
|
*/
|
|
2317
2317
|
export interface DescribeMLModelsInput {
|
|
2318
2318
|
/**
|
|
2319
|
-
* @public
|
|
2320
2319
|
* <p>Use one of the following variables to filter a list of <code>MLModel</code>:</p>
|
|
2321
2320
|
* <ul>
|
|
2322
2321
|
* <li>
|
|
@@ -2358,44 +2357,44 @@ export interface DescribeMLModelsInput {
|
|
|
2358
2357
|
* <code>TrainingDataURI</code> - Sets the search criteria to the data file(s) used in training a <code>MLModel</code>. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.</p>
|
|
2359
2358
|
* </li>
|
|
2360
2359
|
* </ul>
|
|
2360
|
+
* @public
|
|
2361
2361
|
*/
|
|
2362
2362
|
FilterVariable?: MLModelFilterVariable;
|
|
2363
2363
|
/**
|
|
2364
|
-
* @public
|
|
2365
2364
|
* <p>The equal to operator. The <code>MLModel</code> results will have
|
|
2366
2365
|
* <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
|
|
2366
|
+
* @public
|
|
2367
2367
|
*/
|
|
2368
2368
|
EQ?: string;
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>The greater than operator. The <code>MLModel</code> results will
|
|
2372
2371
|
* have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
|
|
2372
|
+
* @public
|
|
2373
2373
|
*/
|
|
2374
2374
|
GT?: string;
|
|
2375
2375
|
/**
|
|
2376
|
-
* @public
|
|
2377
2376
|
* <p>The less than operator. The <code>MLModel</code> results will
|
|
2378
2377
|
* have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
|
|
2378
|
+
* @public
|
|
2379
2379
|
*/
|
|
2380
2380
|
LT?: string;
|
|
2381
2381
|
/**
|
|
2382
|
-
* @public
|
|
2383
2382
|
* <p>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
|
|
2384
2383
|
* </p>
|
|
2384
|
+
* @public
|
|
2385
2385
|
*/
|
|
2386
2386
|
GE?: string;
|
|
2387
2387
|
/**
|
|
2388
|
-
* @public
|
|
2389
2388
|
* <p>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
|
|
2389
|
+
* @public
|
|
2390
2390
|
*/
|
|
2391
2391
|
LE?: string;
|
|
2392
2392
|
/**
|
|
2393
|
-
* @public
|
|
2394
2393
|
* <p>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
|
|
2394
|
+
* @public
|
|
2395
2395
|
*/
|
|
2396
2396
|
NE?: string;
|
|
2397
2397
|
/**
|
|
2398
|
-
* @public
|
|
2399
2398
|
* <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
|
|
2400
2399
|
* <p>For example, an <code>MLModel</code> could have the <code>Name</code>
|
|
2401
2400
|
* <code>2014-09-09-HolidayGiftMailer</code>. To search for
|
|
@@ -2414,10 +2413,10 @@ export interface DescribeMLModelsInput {
|
|
|
2414
2413
|
* <p>2014-09-09-Holiday</p>
|
|
2415
2414
|
* </li>
|
|
2416
2415
|
* </ul>
|
|
2416
|
+
* @public
|
|
2417
2417
|
*/
|
|
2418
2418
|
Prefix?: string;
|
|
2419
2419
|
/**
|
|
2420
|
-
* @public
|
|
2421
2420
|
* <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>.</p>
|
|
2422
2421
|
* <ul>
|
|
2423
2422
|
* <li>
|
|
@@ -2430,57 +2429,57 @@ export interface DescribeMLModelsInput {
|
|
|
2430
2429
|
* </li>
|
|
2431
2430
|
* </ul>
|
|
2432
2431
|
* <p>Results are sorted by <code>FilterVariable</code>.</p>
|
|
2432
|
+
* @public
|
|
2433
2433
|
*/
|
|
2434
2434
|
SortOrder?: SortOrder;
|
|
2435
2435
|
/**
|
|
2436
|
-
* @public
|
|
2437
2436
|
* <p>The ID of the page in the paginated results.</p>
|
|
2437
|
+
* @public
|
|
2438
2438
|
*/
|
|
2439
2439
|
NextToken?: string;
|
|
2440
2440
|
/**
|
|
2441
|
-
* @public
|
|
2442
2441
|
* <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
Limit?: number;
|
|
2445
2445
|
}
|
|
2446
2446
|
/**
|
|
2447
|
-
* @public
|
|
2448
2447
|
* <p> Represents the output of a <code>GetMLModel</code> operation. </p>
|
|
2449
2448
|
* <p>The content consists of the detailed metadata and the current status of the <code>MLModel</code>.</p>
|
|
2449
|
+
* @public
|
|
2450
2450
|
*/
|
|
2451
2451
|
export interface MLModel {
|
|
2452
2452
|
/**
|
|
2453
|
-
* @public
|
|
2454
2453
|
* <p>The ID assigned to the <code>MLModel</code> at creation.</p>
|
|
2454
|
+
* @public
|
|
2455
2455
|
*/
|
|
2456
2456
|
MLModelId?: string;
|
|
2457
2457
|
/**
|
|
2458
|
-
* @public
|
|
2459
2458
|
* <p>The ID of the training <code>DataSource</code>. The <code>CreateMLModel</code> operation uses the <code>TrainingDataSourceId</code>.</p>
|
|
2459
|
+
* @public
|
|
2460
2460
|
*/
|
|
2461
2461
|
TrainingDataSourceId?: string;
|
|
2462
2462
|
/**
|
|
2463
|
-
* @public
|
|
2464
2463
|
* <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
2464
|
+
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
CreatedByIamUser?: string;
|
|
2467
2467
|
/**
|
|
2468
|
-
* @public
|
|
2469
2468
|
* <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
|
|
2469
|
+
* @public
|
|
2470
2470
|
*/
|
|
2471
2471
|
CreatedAt?: Date;
|
|
2472
2472
|
/**
|
|
2473
|
-
* @public
|
|
2474
2473
|
* <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
|
|
2474
|
+
* @public
|
|
2475
2475
|
*/
|
|
2476
2476
|
LastUpdatedAt?: Date;
|
|
2477
2477
|
/**
|
|
2478
|
-
* @public
|
|
2479
2478
|
* <p>A user-supplied name or description of the <code>MLModel</code>.</p>
|
|
2479
|
+
* @public
|
|
2480
2480
|
*/
|
|
2481
2481
|
Name?: string;
|
|
2482
2482
|
/**
|
|
2483
|
-
* @public
|
|
2484
2483
|
* <p>The current status of an <code>MLModel</code>. This element can have one of the following values: </p>
|
|
2485
2484
|
* <ul>
|
|
2486
2485
|
* <li>
|
|
@@ -2506,20 +2505,20 @@ export interface MLModel {
|
|
|
2506
2505
|
* usable.</p>
|
|
2507
2506
|
* </li>
|
|
2508
2507
|
* </ul>
|
|
2508
|
+
* @public
|
|
2509
2509
|
*/
|
|
2510
2510
|
Status?: EntityStatus;
|
|
2511
2511
|
/**
|
|
2512
|
-
* @public
|
|
2513
2512
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
2513
|
+
* @public
|
|
2514
2514
|
*/
|
|
2515
2515
|
SizeInBytes?: number;
|
|
2516
2516
|
/**
|
|
2517
|
-
* @public
|
|
2518
2517
|
* <p>The current endpoint of the <code>MLModel</code>.</p>
|
|
2518
|
+
* @public
|
|
2519
2519
|
*/
|
|
2520
2520
|
EndpointInfo?: RealtimeEndpointInfo;
|
|
2521
2521
|
/**
|
|
2522
|
-
* @public
|
|
2523
2522
|
* <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
|
|
2524
2523
|
* a map of key-value pairs.</p>
|
|
2525
2524
|
* <p>The following is the current set of training parameters:</p>
|
|
@@ -2565,15 +2564,15 @@ export interface MLModel {
|
|
|
2565
2564
|
* <code>L1</code> is specified. Use this parameter sparingly.</p>
|
|
2566
2565
|
* </li>
|
|
2567
2566
|
* </ul>
|
|
2567
|
+
* @public
|
|
2568
2568
|
*/
|
|
2569
2569
|
TrainingParameters?: Record<string, string>;
|
|
2570
2570
|
/**
|
|
2571
|
-
* @public
|
|
2572
2571
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
2572
|
+
* @public
|
|
2573
2573
|
*/
|
|
2574
2574
|
InputDataLocationS3?: string;
|
|
2575
2575
|
/**
|
|
2576
|
-
* @public
|
|
2577
2576
|
* <p>The algorithm used to train the <code>MLModel</code>. The following algorithm is supported:</p>
|
|
2578
2577
|
* <ul>
|
|
2579
2578
|
* <li>
|
|
@@ -2581,10 +2580,10 @@ export interface MLModel {
|
|
|
2581
2580
|
* <code>SGD</code> -- Stochastic gradient descent. The goal of <code>SGD</code> is to minimize the gradient of the loss function. </p>
|
|
2582
2581
|
* </li>
|
|
2583
2582
|
* </ul>
|
|
2583
|
+
* @public
|
|
2584
2584
|
*/
|
|
2585
2585
|
Algorithm?: Algorithm;
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>Identifies the <code>MLModel</code> category. The following are the available types:</p>
|
|
2589
2588
|
* <ul>
|
|
2590
2589
|
* <li>
|
|
@@ -2603,48 +2602,49 @@ export interface MLModel {
|
|
|
2603
2602
|
* this a HIGH-, LOW-, or MEDIUM-risk trade?".</p>
|
|
2604
2603
|
* </li>
|
|
2605
2604
|
* </ul>
|
|
2605
|
+
* @public
|
|
2606
2606
|
*/
|
|
2607
2607
|
MLModelType?: MLModelType;
|
|
2608
2608
|
ScoreThreshold?: number;
|
|
2609
2609
|
/**
|
|
2610
|
-
* @public
|
|
2611
2610
|
* <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
|
|
2611
|
+
* @public
|
|
2612
2612
|
*/
|
|
2613
2613
|
ScoreThresholdLastUpdatedAt?: Date;
|
|
2614
2614
|
/**
|
|
2615
|
-
* @public
|
|
2616
2615
|
* <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
|
|
2616
|
+
* @public
|
|
2617
2617
|
*/
|
|
2618
2618
|
Message?: string;
|
|
2619
2619
|
/**
|
|
2620
|
-
* @public
|
|
2621
2620
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
2621
|
+
* @public
|
|
2622
2622
|
*/
|
|
2623
2623
|
ComputeTime?: number;
|
|
2624
2624
|
/**
|
|
2625
|
-
* @public
|
|
2626
2625
|
* <p>A timestamp represented in epoch time.</p>
|
|
2626
|
+
* @public
|
|
2627
2627
|
*/
|
|
2628
2628
|
FinishedAt?: Date;
|
|
2629
2629
|
/**
|
|
2630
|
-
* @public
|
|
2631
2630
|
* <p>A timestamp represented in epoch time.</p>
|
|
2631
|
+
* @public
|
|
2632
2632
|
*/
|
|
2633
2633
|
StartedAt?: Date;
|
|
2634
2634
|
}
|
|
2635
2635
|
/**
|
|
2636
|
-
* @public
|
|
2637
2636
|
* <p>Represents the output of a <code>DescribeMLModels</code> operation. The content is essentially a list of <code>MLModel</code>.</p>
|
|
2637
|
+
* @public
|
|
2638
2638
|
*/
|
|
2639
2639
|
export interface DescribeMLModelsOutput {
|
|
2640
2640
|
/**
|
|
2641
|
-
* @public
|
|
2642
2641
|
* <p>A list of <code>MLModel</code> that meet the search criteria.</p>
|
|
2642
|
+
* @public
|
|
2643
2643
|
*/
|
|
2644
2644
|
Results?: MLModel[];
|
|
2645
2645
|
/**
|
|
2646
|
-
* @public
|
|
2647
2646
|
* <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
|
|
2647
|
+
* @public
|
|
2648
2648
|
*/
|
|
2649
2649
|
NextToken?: string;
|
|
2650
2650
|
}
|
|
@@ -2653,34 +2653,34 @@ export interface DescribeMLModelsOutput {
|
|
|
2653
2653
|
*/
|
|
2654
2654
|
export interface DescribeTagsInput {
|
|
2655
2655
|
/**
|
|
2656
|
-
* @public
|
|
2657
2656
|
* <p>The ID of the ML object. For example, <code>exampleModelId</code>. </p>
|
|
2657
|
+
* @public
|
|
2658
2658
|
*/
|
|
2659
2659
|
ResourceId: string | undefined;
|
|
2660
2660
|
/**
|
|
2661
|
-
* @public
|
|
2662
2661
|
* <p>The type of the ML object.</p>
|
|
2662
|
+
* @public
|
|
2663
2663
|
*/
|
|
2664
2664
|
ResourceType: TaggableResourceType | undefined;
|
|
2665
2665
|
}
|
|
2666
2666
|
/**
|
|
2667
|
-
* @public
|
|
2668
2667
|
* <p>Amazon ML returns the following elements.</p>
|
|
2668
|
+
* @public
|
|
2669
2669
|
*/
|
|
2670
2670
|
export interface DescribeTagsOutput {
|
|
2671
2671
|
/**
|
|
2672
|
-
* @public
|
|
2673
2672
|
* <p>The ID of the tagged ML object.</p>
|
|
2673
|
+
* @public
|
|
2674
2674
|
*/
|
|
2675
2675
|
ResourceId?: string;
|
|
2676
2676
|
/**
|
|
2677
|
-
* @public
|
|
2678
2677
|
* <p>The type of the tagged ML object.</p>
|
|
2678
|
+
* @public
|
|
2679
2679
|
*/
|
|
2680
2680
|
ResourceType?: TaggableResourceType;
|
|
2681
2681
|
/**
|
|
2682
|
-
* @public
|
|
2683
2682
|
* <p>A list of tags associated with the ML object.</p>
|
|
2683
|
+
* @public
|
|
2684
2684
|
*/
|
|
2685
2685
|
Tags?: Tag[];
|
|
2686
2686
|
}
|
|
@@ -2689,60 +2689,59 @@ export interface DescribeTagsOutput {
|
|
|
2689
2689
|
*/
|
|
2690
2690
|
export interface GetBatchPredictionInput {
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>An ID assigned to the <code>BatchPrediction</code> at creation.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
BatchPredictionId: string | undefined;
|
|
2696
2696
|
}
|
|
2697
2697
|
/**
|
|
2698
|
-
* @public
|
|
2699
2698
|
* <p>Represents the output of a <code>GetBatchPrediction</code> operation and describes a <code>BatchPrediction</code>.</p>
|
|
2699
|
+
* @public
|
|
2700
2700
|
*/
|
|
2701
2701
|
export interface GetBatchPredictionOutput {
|
|
2702
2702
|
/**
|
|
2703
|
-
* @public
|
|
2704
2703
|
* <p>An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
|
|
2705
2704
|
* in the request.</p>
|
|
2705
|
+
* @public
|
|
2706
2706
|
*/
|
|
2707
2707
|
BatchPredictionId?: string;
|
|
2708
2708
|
/**
|
|
2709
|
-
* @public
|
|
2710
2709
|
* <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
|
|
2710
|
+
* @public
|
|
2711
2711
|
*/
|
|
2712
2712
|
MLModelId?: string;
|
|
2713
2713
|
/**
|
|
2714
|
-
* @public
|
|
2715
2714
|
* <p>The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>.
|
|
2716
2715
|
* </p>
|
|
2716
|
+
* @public
|
|
2717
2717
|
*/
|
|
2718
2718
|
BatchPredictionDataSourceId?: string;
|
|
2719
2719
|
/**
|
|
2720
|
-
* @public
|
|
2721
2720
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
2721
|
+
* @public
|
|
2722
2722
|
*/
|
|
2723
2723
|
InputDataLocationS3?: string;
|
|
2724
2724
|
/**
|
|
2725
|
-
* @public
|
|
2726
2725
|
* <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
2726
|
+
* @public
|
|
2727
2727
|
*/
|
|
2728
2728
|
CreatedByIamUser?: string;
|
|
2729
2729
|
/**
|
|
2730
|
-
* @public
|
|
2731
2730
|
* <p>The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
|
|
2731
|
+
* @public
|
|
2732
2732
|
*/
|
|
2733
2733
|
CreatedAt?: Date;
|
|
2734
2734
|
/**
|
|
2735
|
-
* @public
|
|
2736
2735
|
* <p>The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
|
|
2736
|
+
* @public
|
|
2737
2737
|
*/
|
|
2738
2738
|
LastUpdatedAt?: Date;
|
|
2739
2739
|
/**
|
|
2740
|
-
* @public
|
|
2741
2740
|
* <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
|
|
2741
|
+
* @public
|
|
2742
2742
|
*/
|
|
2743
2743
|
Name?: string;
|
|
2744
2744
|
/**
|
|
2745
|
-
* @public
|
|
2746
2745
|
* <p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p>
|
|
2747
2746
|
* <ul>
|
|
2748
2747
|
* <li>
|
|
@@ -2766,46 +2765,47 @@ export interface GetBatchPredictionOutput {
|
|
|
2766
2765
|
* <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p>
|
|
2767
2766
|
* </li>
|
|
2768
2767
|
* </ul>
|
|
2768
|
+
* @public
|
|
2769
2769
|
*/
|
|
2770
2770
|
Status?: EntityStatus;
|
|
2771
2771
|
/**
|
|
2772
|
-
* @public
|
|
2773
2772
|
* <p>The location of an Amazon S3 bucket or directory to receive the operation results.</p>
|
|
2773
|
+
* @public
|
|
2774
2774
|
*/
|
|
2775
2775
|
OutputUri?: string;
|
|
2776
2776
|
/**
|
|
2777
|
-
* @public
|
|
2778
2777
|
* <p>A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.</p>
|
|
2778
|
+
* @public
|
|
2779
2779
|
*/
|
|
2780
2780
|
LogUri?: string;
|
|
2781
2781
|
/**
|
|
2782
|
-
* @public
|
|
2783
2782
|
* <p>A description of the most recent details about processing the batch prediction request.</p>
|
|
2783
|
+
* @public
|
|
2784
2784
|
*/
|
|
2785
2785
|
Message?: string;
|
|
2786
2786
|
/**
|
|
2787
|
-
* @public
|
|
2788
2787
|
* <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.</p>
|
|
2788
|
+
* @public
|
|
2789
2789
|
*/
|
|
2790
2790
|
ComputeTime?: number;
|
|
2791
2791
|
/**
|
|
2792
|
-
* @public
|
|
2793
2792
|
* <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
|
|
2793
|
+
* @public
|
|
2794
2794
|
*/
|
|
2795
2795
|
FinishedAt?: Date;
|
|
2796
2796
|
/**
|
|
2797
|
-
* @public
|
|
2798
2797
|
* <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.</p>
|
|
2798
|
+
* @public
|
|
2799
2799
|
*/
|
|
2800
2800
|
StartedAt?: Date;
|
|
2801
2801
|
/**
|
|
2802
|
-
* @public
|
|
2803
2802
|
* <p>The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
|
|
2803
|
+
* @public
|
|
2804
2804
|
*/
|
|
2805
2805
|
TotalRecordCount?: number;
|
|
2806
2806
|
/**
|
|
2807
|
-
* @public
|
|
2808
2807
|
* <p>The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
|
|
2808
|
+
* @public
|
|
2809
2809
|
*/
|
|
2810
2810
|
InvalidRecordCount?: number;
|
|
2811
2811
|
}
|
|
@@ -2814,71 +2814,70 @@ export interface GetBatchPredictionOutput {
|
|
|
2814
2814
|
*/
|
|
2815
2815
|
export interface GetDataSourceInput {
|
|
2816
2816
|
/**
|
|
2817
|
-
* @public
|
|
2818
2817
|
* <p>The ID assigned to the <code>DataSource</code> at creation.</p>
|
|
2818
|
+
* @public
|
|
2819
2819
|
*/
|
|
2820
2820
|
DataSourceId: string | undefined;
|
|
2821
2821
|
/**
|
|
2822
|
-
* @public
|
|
2823
2822
|
* <p>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>.</p>
|
|
2824
2823
|
* <p>If true, <code>DataSourceSchema</code> is returned.</p>
|
|
2825
2824
|
* <p>If false, <code>DataSourceSchema</code> is not returned.</p>
|
|
2825
|
+
* @public
|
|
2826
2826
|
*/
|
|
2827
2827
|
Verbose?: boolean;
|
|
2828
2828
|
}
|
|
2829
2829
|
/**
|
|
2830
|
-
* @public
|
|
2831
2830
|
* <p>Represents the output of a <code>GetDataSource</code> operation and describes a <code>DataSource</code>.</p>
|
|
2831
|
+
* @public
|
|
2832
2832
|
*/
|
|
2833
2833
|
export interface GetDataSourceOutput {
|
|
2834
2834
|
/**
|
|
2835
|
-
* @public
|
|
2836
2835
|
* <p>The ID assigned to the <code>DataSource</code> at creation. This value should be identical to the value of the <code>DataSourceId</code> in the request.</p>
|
|
2836
|
+
* @public
|
|
2837
2837
|
*/
|
|
2838
2838
|
DataSourceId?: string;
|
|
2839
2839
|
/**
|
|
2840
|
-
* @public
|
|
2841
2840
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
2841
|
+
* @public
|
|
2842
2842
|
*/
|
|
2843
2843
|
DataLocationS3?: string;
|
|
2844
2844
|
/**
|
|
2845
|
-
* @public
|
|
2846
2845
|
* <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
|
|
2847
2846
|
* was created.</p>
|
|
2847
|
+
* @public
|
|
2848
2848
|
*/
|
|
2849
2849
|
DataRearrangement?: string;
|
|
2850
2850
|
/**
|
|
2851
|
-
* @public
|
|
2852
2851
|
* <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
2852
|
+
* @public
|
|
2853
2853
|
*/
|
|
2854
2854
|
CreatedByIamUser?: string;
|
|
2855
2855
|
/**
|
|
2856
|
-
* @public
|
|
2857
2856
|
* <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
|
|
2857
|
+
* @public
|
|
2858
2858
|
*/
|
|
2859
2859
|
CreatedAt?: Date;
|
|
2860
2860
|
/**
|
|
2861
|
-
* @public
|
|
2862
2861
|
* <p>The time of the most recent edit to the <code>DataSource</code>. The time is expressed in epoch time.</p>
|
|
2862
|
+
* @public
|
|
2863
2863
|
*/
|
|
2864
2864
|
LastUpdatedAt?: Date;
|
|
2865
2865
|
/**
|
|
2866
|
-
* @public
|
|
2867
2866
|
* <p>The total size of observations in the data files.</p>
|
|
2867
|
+
* @public
|
|
2868
2868
|
*/
|
|
2869
2869
|
DataSizeInBytes?: number;
|
|
2870
2870
|
/**
|
|
2871
|
-
* @public
|
|
2872
2871
|
* <p>The number of data files referenced by the <code>DataSource</code>.</p>
|
|
2872
|
+
* @public
|
|
2873
2873
|
*/
|
|
2874
2874
|
NumberOfFiles?: number;
|
|
2875
2875
|
/**
|
|
2876
|
-
* @public
|
|
2877
2876
|
* <p>A user-supplied name or description of the <code>DataSource</code>.</p>
|
|
2877
|
+
* @public
|
|
2878
2878
|
*/
|
|
2879
2879
|
Name?: string;
|
|
2880
2880
|
/**
|
|
2881
|
-
* @public
|
|
2882
2881
|
* <p>The current status of the <code>DataSource</code>. This element can have one of the following values:</p>
|
|
2883
2882
|
* <ul>
|
|
2884
2883
|
* <li>
|
|
@@ -2902,60 +2901,61 @@ export interface GetDataSourceOutput {
|
|
|
2902
2901
|
* <code>DELETED</code> - The <code>DataSource</code> is marked as deleted. It is not usable.</p>
|
|
2903
2902
|
* </li>
|
|
2904
2903
|
* </ul>
|
|
2904
|
+
* @public
|
|
2905
2905
|
*/
|
|
2906
2906
|
Status?: EntityStatus;
|
|
2907
2907
|
/**
|
|
2908
|
-
* @public
|
|
2909
2908
|
* <p>A link to the file containing logs of <code>CreateDataSourceFrom*</code> operations.</p>
|
|
2909
|
+
* @public
|
|
2910
2910
|
*/
|
|
2911
2911
|
LogUri?: string;
|
|
2912
2912
|
/**
|
|
2913
|
-
* @public
|
|
2914
2913
|
* <p>The user-supplied description of the most recent details about creating the <code>DataSource</code>.</p>
|
|
2914
|
+
* @public
|
|
2915
2915
|
*/
|
|
2916
2916
|
Message?: string;
|
|
2917
2917
|
/**
|
|
2918
|
-
* @public
|
|
2919
2918
|
* <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
|
|
2919
|
+
* @public
|
|
2920
2920
|
*/
|
|
2921
2921
|
RedshiftMetadata?: RedshiftMetadata;
|
|
2922
2922
|
/**
|
|
2923
|
-
* @public
|
|
2924
2923
|
* <p>The datasource details that are specific to Amazon RDS.</p>
|
|
2924
|
+
* @public
|
|
2925
2925
|
*/
|
|
2926
2926
|
RDSMetadata?: RDSMetadata;
|
|
2927
2927
|
/**
|
|
2928
|
-
* @public
|
|
2929
2928
|
* <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
|
|
2929
|
+
* @public
|
|
2930
2930
|
*/
|
|
2931
2931
|
RoleARN?: string;
|
|
2932
2932
|
/**
|
|
2933
|
-
* @public
|
|
2934
2933
|
* <p>
|
|
2935
2934
|
* The parameter is <code>true</code> if statistics need to be generated from the observation data.
|
|
2936
2935
|
* </p>
|
|
2936
|
+
* @public
|
|
2937
2937
|
*/
|
|
2938
2938
|
ComputeStatistics?: boolean;
|
|
2939
2939
|
/**
|
|
2940
|
-
* @public
|
|
2941
2940
|
* <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>DataSource</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>DataSource</code> is in the <code>COMPLETED</code> state and the <code>ComputeStatistics</code> is set to true.</p>
|
|
2941
|
+
* @public
|
|
2942
2942
|
*/
|
|
2943
2943
|
ComputeTime?: number;
|
|
2944
2944
|
/**
|
|
2945
|
-
* @public
|
|
2946
2945
|
* <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>DataSource</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
|
|
2946
|
+
* @public
|
|
2947
2947
|
*/
|
|
2948
2948
|
FinishedAt?: Date;
|
|
2949
2949
|
/**
|
|
2950
|
-
* @public
|
|
2951
2950
|
* <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>DataSource</code> is in the <code>PENDING</code> state.</p>
|
|
2951
|
+
* @public
|
|
2952
2952
|
*/
|
|
2953
2953
|
StartedAt?: Date;
|
|
2954
2954
|
/**
|
|
2955
|
-
* @public
|
|
2956
2955
|
* <p>The schema used by all of the data files of this <code>DataSource</code>.</p>
|
|
2957
2956
|
* <p>
|
|
2958
2957
|
* <b>Note:</b> This parameter is provided as part of the verbose format.</p>
|
|
2958
|
+
* @public
|
|
2959
2959
|
*/
|
|
2960
2960
|
DataSourceSchema?: string;
|
|
2961
2961
|
}
|
|
@@ -2964,58 +2964,57 @@ export interface GetDataSourceOutput {
|
|
|
2964
2964
|
*/
|
|
2965
2965
|
export interface GetEvaluationInput {
|
|
2966
2966
|
/**
|
|
2967
|
-
* @public
|
|
2968
2967
|
* <p>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </p>
|
|
2968
|
+
* @public
|
|
2969
2969
|
*/
|
|
2970
2970
|
EvaluationId: string | undefined;
|
|
2971
2971
|
}
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <p>Represents the output of a <code>GetEvaluation</code> operation and describes an <code>Evaluation</code>.</p>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
export interface GetEvaluationOutput {
|
|
2977
2977
|
/**
|
|
2978
|
-
* @public
|
|
2979
2978
|
* <p>The evaluation ID which is same as the <code>EvaluationId</code> in the request.</p>
|
|
2979
|
+
* @public
|
|
2980
2980
|
*/
|
|
2981
2981
|
EvaluationId?: string;
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* <p>The ID of the <code>MLModel</code> that was the focus of the evaluation.</p>
|
|
2984
|
+
* @public
|
|
2985
2985
|
*/
|
|
2986
2986
|
MLModelId?: string;
|
|
2987
2987
|
/**
|
|
2988
|
-
* @public
|
|
2989
2988
|
* <p>The <code>DataSource</code> used for this evaluation.</p>
|
|
2989
|
+
* @public
|
|
2990
2990
|
*/
|
|
2991
2991
|
EvaluationDataSourceId?: string;
|
|
2992
2992
|
/**
|
|
2993
|
-
* @public
|
|
2994
2993
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
2994
|
+
* @public
|
|
2995
2995
|
*/
|
|
2996
2996
|
InputDataLocationS3?: string;
|
|
2997
2997
|
/**
|
|
2998
|
-
* @public
|
|
2999
2998
|
* <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
2999
|
+
* @public
|
|
3000
3000
|
*/
|
|
3001
3001
|
CreatedByIamUser?: string;
|
|
3002
3002
|
/**
|
|
3003
|
-
* @public
|
|
3004
3003
|
* <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
|
|
3004
|
+
* @public
|
|
3005
3005
|
*/
|
|
3006
3006
|
CreatedAt?: Date;
|
|
3007
3007
|
/**
|
|
3008
|
-
* @public
|
|
3009
3008
|
* <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
|
|
3009
|
+
* @public
|
|
3010
3010
|
*/
|
|
3011
3011
|
LastUpdatedAt?: Date;
|
|
3012
3012
|
/**
|
|
3013
|
-
* @public
|
|
3014
3013
|
* <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
|
|
3014
|
+
* @public
|
|
3015
3015
|
*/
|
|
3016
3016
|
Name?: string;
|
|
3017
3017
|
/**
|
|
3018
|
-
* @public
|
|
3019
3018
|
* <p>The status of the evaluation. This element can have one of the following values:</p>
|
|
3020
3019
|
* <ul>
|
|
3021
3020
|
* <li>
|
|
@@ -3039,10 +3038,10 @@ export interface GetEvaluationOutput {
|
|
|
3039
3038
|
* <code>DELETED</code> - The <code>Evaluation</code> is marked as deleted. It is not usable.</p>
|
|
3040
3039
|
* </li>
|
|
3041
3040
|
* </ul>
|
|
3041
|
+
* @public
|
|
3042
3042
|
*/
|
|
3043
3043
|
Status?: EntityStatus;
|
|
3044
3044
|
/**
|
|
3045
|
-
* @public
|
|
3046
3045
|
* <p>Measurements of how well the <code>MLModel</code> performed using observations referenced by the <code>DataSource</code>. One of the following metric is returned based on the type of the <code>MLModel</code>:
|
|
3047
3046
|
* </p>
|
|
3048
3047
|
* <ul>
|
|
@@ -3059,31 +3058,32 @@ export interface GetEvaluationOutput {
|
|
|
3059
3058
|
* <p>
|
|
3060
3059
|
* For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
|
|
3061
3060
|
* </p>
|
|
3061
|
+
* @public
|
|
3062
3062
|
*/
|
|
3063
3063
|
PerformanceMetrics?: PerformanceMetrics;
|
|
3064
3064
|
/**
|
|
3065
|
-
* @public
|
|
3066
3065
|
* <p>A link to the file that contains logs of the <code>CreateEvaluation</code> operation.</p>
|
|
3066
|
+
* @public
|
|
3067
3067
|
*/
|
|
3068
3068
|
LogUri?: string;
|
|
3069
3069
|
/**
|
|
3070
|
-
* @public
|
|
3071
3070
|
* <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
|
|
3071
|
+
* @public
|
|
3072
3072
|
*/
|
|
3073
3073
|
Message?: string;
|
|
3074
3074
|
/**
|
|
3075
|
-
* @public
|
|
3076
3075
|
* <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>Evaluation</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>Evaluation</code> is in the <code>COMPLETED</code> state.</p>
|
|
3076
|
+
* @public
|
|
3077
3077
|
*/
|
|
3078
3078
|
ComputeTime?: number;
|
|
3079
3079
|
/**
|
|
3080
|
-
* @public
|
|
3081
3080
|
* <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>Evaluation</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
|
|
3081
|
+
* @public
|
|
3082
3082
|
*/
|
|
3083
3083
|
FinishedAt?: Date;
|
|
3084
3084
|
/**
|
|
3085
|
-
* @public
|
|
3086
3085
|
* <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>Evaluation</code> is in the <code>PENDING</code> state.</p>
|
|
3086
|
+
* @public
|
|
3087
3087
|
*/
|
|
3088
3088
|
StartedAt?: Date;
|
|
3089
3089
|
}
|
|
@@ -3092,56 +3092,55 @@ export interface GetEvaluationOutput {
|
|
|
3092
3092
|
*/
|
|
3093
3093
|
export interface GetMLModelInput {
|
|
3094
3094
|
/**
|
|
3095
|
-
* @public
|
|
3096
3095
|
* <p>The ID assigned to the <code>MLModel</code> at creation.</p>
|
|
3096
|
+
* @public
|
|
3097
3097
|
*/
|
|
3098
3098
|
MLModelId: string | undefined;
|
|
3099
3099
|
/**
|
|
3100
|
-
* @public
|
|
3101
3100
|
* <p>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>.</p>
|
|
3102
3101
|
* <p>If true, <code>Recipe</code> is returned.</p>
|
|
3103
3102
|
* <p>If false, <code>Recipe</code> is not returned.</p>
|
|
3103
|
+
* @public
|
|
3104
3104
|
*/
|
|
3105
3105
|
Verbose?: boolean;
|
|
3106
3106
|
}
|
|
3107
3107
|
/**
|
|
3108
|
-
* @public
|
|
3109
3108
|
* <p>Represents the output of a <code>GetMLModel</code> operation, and provides detailed information about a <code>MLModel</code>.</p>
|
|
3109
|
+
* @public
|
|
3110
3110
|
*/
|
|
3111
3111
|
export interface GetMLModelOutput {
|
|
3112
3112
|
/**
|
|
3113
|
-
* @public
|
|
3114
3113
|
* <p>The MLModel ID,
|
|
3115
3114
|
* which is same as the <code>MLModelId</code> in the request.</p>
|
|
3115
|
+
* @public
|
|
3116
3116
|
*/
|
|
3117
3117
|
MLModelId?: string;
|
|
3118
3118
|
/**
|
|
3119
|
-
* @public
|
|
3120
3119
|
* <p>The ID of the training <code>DataSource</code>.</p>
|
|
3120
|
+
* @public
|
|
3121
3121
|
*/
|
|
3122
3122
|
TrainingDataSourceId?: string;
|
|
3123
3123
|
/**
|
|
3124
|
-
* @public
|
|
3125
3124
|
* <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
|
|
3125
|
+
* @public
|
|
3126
3126
|
*/
|
|
3127
3127
|
CreatedByIamUser?: string;
|
|
3128
3128
|
/**
|
|
3129
|
-
* @public
|
|
3130
3129
|
* <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
|
|
3130
|
+
* @public
|
|
3131
3131
|
*/
|
|
3132
3132
|
CreatedAt?: Date;
|
|
3133
3133
|
/**
|
|
3134
|
-
* @public
|
|
3135
3134
|
* <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
|
|
3135
|
+
* @public
|
|
3136
3136
|
*/
|
|
3137
3137
|
LastUpdatedAt?: Date;
|
|
3138
3138
|
/**
|
|
3139
|
-
* @public
|
|
3140
3139
|
* <p>A user-supplied name or description of the <code>MLModel</code>.</p>
|
|
3140
|
+
* @public
|
|
3141
3141
|
*/
|
|
3142
3142
|
Name?: string;
|
|
3143
3143
|
/**
|
|
3144
|
-
* @public
|
|
3145
3144
|
* <p>The current status of the <code>MLModel</code>. This element can have one of the following values:</p>
|
|
3146
3145
|
* <ul>
|
|
3147
3146
|
* <li>
|
|
@@ -3167,21 +3166,21 @@ export interface GetMLModelOutput {
|
|
|
3167
3166
|
* usable.</p>
|
|
3168
3167
|
* </li>
|
|
3169
3168
|
* </ul>
|
|
3169
|
+
* @public
|
|
3170
3170
|
*/
|
|
3171
3171
|
Status?: EntityStatus;
|
|
3172
3172
|
/**
|
|
3173
|
-
* @public
|
|
3174
3173
|
* <p>Long integer type that is a 64-bit signed number.</p>
|
|
3174
|
+
* @public
|
|
3175
3175
|
*/
|
|
3176
3176
|
SizeInBytes?: number;
|
|
3177
3177
|
/**
|
|
3178
|
-
* @public
|
|
3179
3178
|
* <p>The current endpoint of the <code>MLModel</code>
|
|
3180
3179
|
* </p>
|
|
3180
|
+
* @public
|
|
3181
3181
|
*/
|
|
3182
3182
|
EndpointInfo?: RealtimeEndpointInfo;
|
|
3183
3183
|
/**
|
|
3184
|
-
* @public
|
|
3185
3184
|
* <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
|
|
3186
3185
|
* a map of key-value pairs.</p>
|
|
3187
3186
|
* <p>The following is the current set of training parameters:</p>
|
|
@@ -3227,15 +3226,15 @@ export interface GetMLModelOutput {
|
|
|
3227
3226
|
* <code>L1</code> is specified. Use this parameter sparingly.</p>
|
|
3228
3227
|
* </li>
|
|
3229
3228
|
* </ul>
|
|
3229
|
+
* @public
|
|
3230
3230
|
*/
|
|
3231
3231
|
TrainingParameters?: Record<string, string>;
|
|
3232
3232
|
/**
|
|
3233
|
-
* @public
|
|
3234
3233
|
* <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
|
|
3234
|
+
* @public
|
|
3235
3235
|
*/
|
|
3236
3236
|
InputDataLocationS3?: string;
|
|
3237
3237
|
/**
|
|
3238
|
-
* @public
|
|
3239
3238
|
* <p>Identifies the <code>MLModel</code> category. The following are the available types: </p>
|
|
3240
3239
|
* <ul>
|
|
3241
3240
|
* <li>
|
|
@@ -3248,68 +3247,69 @@ export interface GetMLModelOutput {
|
|
|
3248
3247
|
* <p>MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"</p>
|
|
3249
3248
|
* </li>
|
|
3250
3249
|
* </ul>
|
|
3250
|
+
* @public
|
|
3251
3251
|
*/
|
|
3252
3252
|
MLModelType?: MLModelType;
|
|
3253
3253
|
/**
|
|
3254
|
-
* @public
|
|
3255
3254
|
* <p>The scoring threshold is used in binary classification <code>MLModel</code>
|
|
3256
3255
|
* models. It marks the boundary between a positive prediction and a
|
|
3257
3256
|
* negative prediction.</p>
|
|
3258
3257
|
* <p>Output values greater than or equal to the threshold receive a positive result from the MLModel, such as
|
|
3259
3258
|
* <code>true</code>. Output values less than the threshold receive a negative response from the MLModel,
|
|
3260
3259
|
* such as <code>false</code>.</p>
|
|
3260
|
+
* @public
|
|
3261
3261
|
*/
|
|
3262
3262
|
ScoreThreshold?: number;
|
|
3263
3263
|
/**
|
|
3264
|
-
* @public
|
|
3265
3264
|
* <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
|
|
3265
|
+
* @public
|
|
3266
3266
|
*/
|
|
3267
3267
|
ScoreThresholdLastUpdatedAt?: Date;
|
|
3268
3268
|
/**
|
|
3269
|
-
* @public
|
|
3270
3269
|
* <p>A link to the file that contains logs of the <code>CreateMLModel</code> operation.</p>
|
|
3270
|
+
* @public
|
|
3271
3271
|
*/
|
|
3272
3272
|
LogUri?: string;
|
|
3273
3273
|
/**
|
|
3274
|
-
* @public
|
|
3275
3274
|
* <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
|
|
3275
|
+
* @public
|
|
3276
3276
|
*/
|
|
3277
3277
|
Message?: string;
|
|
3278
3278
|
/**
|
|
3279
|
-
* @public
|
|
3280
3279
|
* <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>MLModel</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>MLModel</code> is in the <code>COMPLETED</code> state.</p>
|
|
3280
|
+
* @public
|
|
3281
3281
|
*/
|
|
3282
3282
|
ComputeTime?: number;
|
|
3283
3283
|
/**
|
|
3284
|
-
* @public
|
|
3285
3284
|
* <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>MLModel</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
|
|
3285
|
+
* @public
|
|
3286
3286
|
*/
|
|
3287
3287
|
FinishedAt?: Date;
|
|
3288
3288
|
/**
|
|
3289
|
-
* @public
|
|
3290
3289
|
* <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>MLModel</code> is in the <code>PENDING</code> state.</p>
|
|
3290
|
+
* @public
|
|
3291
3291
|
*/
|
|
3292
3292
|
StartedAt?: Date;
|
|
3293
3293
|
/**
|
|
3294
|
-
* @public
|
|
3295
3294
|
* <p>The recipe to use when training the <code>MLModel</code>. The <code>Recipe</code>
|
|
3296
3295
|
* provides detailed information about the observation data to use during training, and
|
|
3297
3296
|
* manipulations to perform on the observation data during training.</p>
|
|
3298
3297
|
* <p>
|
|
3299
3298
|
* <b>Note:</b> This parameter is provided as part of the verbose format.</p>
|
|
3299
|
+
* @public
|
|
3300
3300
|
*/
|
|
3301
3301
|
Recipe?: string;
|
|
3302
3302
|
/**
|
|
3303
|
-
* @public
|
|
3304
3303
|
* <p>The schema used by all of the data files referenced by the <code>DataSource</code>.</p>
|
|
3305
3304
|
* <p>
|
|
3306
3305
|
* <b>Note:</b> This parameter is provided as part of the verbose format.</p>
|
|
3306
|
+
* @public
|
|
3307
3307
|
*/
|
|
3308
3308
|
Schema?: string;
|
|
3309
3309
|
}
|
|
3310
3310
|
/**
|
|
3311
|
-
* @public
|
|
3312
3311
|
* <p>The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>.</p>
|
|
3312
|
+
* @public
|
|
3313
3313
|
*/
|
|
3314
3314
|
export declare class LimitExceededException extends __BaseException {
|
|
3315
3315
|
readonly name: "LimitExceededException";
|
|
@@ -3325,20 +3325,20 @@ export declare class LimitExceededException extends __BaseException {
|
|
|
3325
3325
|
*/
|
|
3326
3326
|
export interface PredictInput {
|
|
3327
3327
|
/**
|
|
3328
|
-
* @public
|
|
3329
3328
|
* <p>A unique identifier of the <code>MLModel</code>.</p>
|
|
3329
|
+
* @public
|
|
3330
3330
|
*/
|
|
3331
3331
|
MLModelId: string | undefined;
|
|
3332
3332
|
/**
|
|
3333
|
-
* @public
|
|
3334
3333
|
* <p>A map of variable name-value pairs that represent an observation.</p>
|
|
3334
|
+
* @public
|
|
3335
3335
|
*/
|
|
3336
3336
|
Record: Record<string, string> | undefined;
|
|
3337
3337
|
PredictEndpoint: string | undefined;
|
|
3338
3338
|
}
|
|
3339
3339
|
/**
|
|
3340
|
-
* @public
|
|
3341
3340
|
* <p>The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>.</p>
|
|
3341
|
+
* @public
|
|
3342
3342
|
*/
|
|
3343
3343
|
export declare class PredictorNotMountedException extends __BaseException {
|
|
3344
3344
|
readonly name: "PredictorNotMountedException";
|
|
@@ -3361,7 +3361,6 @@ export declare const DetailsAttributes: {
|
|
|
3361
3361
|
*/
|
|
3362
3362
|
export type DetailsAttributes = (typeof DetailsAttributes)[keyof typeof DetailsAttributes];
|
|
3363
3363
|
/**
|
|
3364
|
-
* @public
|
|
3365
3364
|
* <p>The output from a <code>Predict</code> operation: </p>
|
|
3366
3365
|
*
|
|
3367
3366
|
* <ul>
|
|
@@ -3390,28 +3389,29 @@ export type DetailsAttributes = (typeof DetailsAttributes)[keyof typeof DetailsA
|
|
|
3390
3389
|
* </p>
|
|
3391
3390
|
* </li>
|
|
3392
3391
|
* </ul>
|
|
3392
|
+
* @public
|
|
3393
3393
|
*/
|
|
3394
3394
|
export interface Prediction {
|
|
3395
3395
|
/**
|
|
3396
|
-
* @public
|
|
3397
3396
|
* <p>The prediction label for either a <code>BINARY</code> or <code>MULTICLASS</code>
|
|
3398
3397
|
* <code>MLModel</code>.</p>
|
|
3398
|
+
* @public
|
|
3399
3399
|
*/
|
|
3400
3400
|
predictedLabel?: string;
|
|
3401
3401
|
/**
|
|
3402
|
-
* @public
|
|
3403
3402
|
* <p>The prediction value for <code>REGRESSION</code>
|
|
3404
3403
|
* <code>MLModel</code>.</p>
|
|
3404
|
+
* @public
|
|
3405
3405
|
*/
|
|
3406
3406
|
predictedValue?: number;
|
|
3407
3407
|
/**
|
|
3408
|
-
* @public
|
|
3409
3408
|
* <p>Provides the raw classification score corresponding to each label.</p>
|
|
3409
|
+
* @public
|
|
3410
3410
|
*/
|
|
3411
3411
|
predictedScores?: Record<string, number>;
|
|
3412
3412
|
/**
|
|
3413
|
-
* @public
|
|
3414
3413
|
* <p>Provides any additional details regarding the prediction.</p>
|
|
3414
|
+
* @public
|
|
3415
3415
|
*/
|
|
3416
3416
|
details?: Partial<Record<DetailsAttributes, string>>;
|
|
3417
3417
|
}
|
|
@@ -3420,7 +3420,6 @@ export interface Prediction {
|
|
|
3420
3420
|
*/
|
|
3421
3421
|
export interface PredictOutput {
|
|
3422
3422
|
/**
|
|
3423
|
-
* @public
|
|
3424
3423
|
* <p>The output from a <code>Predict</code> operation: </p>
|
|
3425
3424
|
*
|
|
3426
3425
|
* <ul>
|
|
@@ -3449,6 +3448,7 @@ export interface PredictOutput {
|
|
|
3449
3448
|
* </p>
|
|
3450
3449
|
* </li>
|
|
3451
3450
|
* </ul>
|
|
3451
|
+
* @public
|
|
3452
3452
|
*/
|
|
3453
3453
|
Prediction?: Prediction;
|
|
3454
3454
|
}
|
|
@@ -3457,26 +3457,26 @@ export interface PredictOutput {
|
|
|
3457
3457
|
*/
|
|
3458
3458
|
export interface UpdateBatchPredictionInput {
|
|
3459
3459
|
/**
|
|
3460
|
-
* @public
|
|
3461
3460
|
* <p>The ID assigned to the <code>BatchPrediction</code> during creation.</p>
|
|
3461
|
+
* @public
|
|
3462
3462
|
*/
|
|
3463
3463
|
BatchPredictionId: string | undefined;
|
|
3464
3464
|
/**
|
|
3465
|
-
* @public
|
|
3466
3465
|
* <p>A new user-supplied name or description of the <code>BatchPrediction</code>.</p>
|
|
3466
|
+
* @public
|
|
3467
3467
|
*/
|
|
3468
3468
|
BatchPredictionName: string | undefined;
|
|
3469
3469
|
}
|
|
3470
3470
|
/**
|
|
3471
|
-
* @public
|
|
3472
3471
|
* <p>Represents the output of an <code>UpdateBatchPrediction</code> operation.</p>
|
|
3473
3472
|
* <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
|
|
3473
|
+
* @public
|
|
3474
3474
|
*/
|
|
3475
3475
|
export interface UpdateBatchPredictionOutput {
|
|
3476
3476
|
/**
|
|
3477
|
-
* @public
|
|
3478
3477
|
* <p>The ID assigned to the <code>BatchPrediction</code> during creation. This value should be identical to the value
|
|
3479
3478
|
* of the <code>BatchPredictionId</code> in the request.</p>
|
|
3479
|
+
* @public
|
|
3480
3480
|
*/
|
|
3481
3481
|
BatchPredictionId?: string;
|
|
3482
3482
|
}
|
|
@@ -3485,26 +3485,26 @@ export interface UpdateBatchPredictionOutput {
|
|
|
3485
3485
|
*/
|
|
3486
3486
|
export interface UpdateDataSourceInput {
|
|
3487
3487
|
/**
|
|
3488
|
-
* @public
|
|
3489
3488
|
* <p>The ID assigned to the <code>DataSource</code> during creation.</p>
|
|
3489
|
+
* @public
|
|
3490
3490
|
*/
|
|
3491
3491
|
DataSourceId: string | undefined;
|
|
3492
3492
|
/**
|
|
3493
|
-
* @public
|
|
3494
3493
|
* <p>A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </p>
|
|
3494
|
+
* @public
|
|
3495
3495
|
*/
|
|
3496
3496
|
DataSourceName: string | undefined;
|
|
3497
3497
|
}
|
|
3498
3498
|
/**
|
|
3499
|
-
* @public
|
|
3500
3499
|
* <p>Represents the output of an <code>UpdateDataSource</code> operation.</p>
|
|
3501
3500
|
* <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
|
|
3501
|
+
* @public
|
|
3502
3502
|
*/
|
|
3503
3503
|
export interface UpdateDataSourceOutput {
|
|
3504
3504
|
/**
|
|
3505
|
-
* @public
|
|
3506
3505
|
* <p>The ID assigned to the <code>DataSource</code> during creation. This value should be identical to the value
|
|
3507
3506
|
* of the <code>DataSourceID</code> in the request.</p>
|
|
3507
|
+
* @public
|
|
3508
3508
|
*/
|
|
3509
3509
|
DataSourceId?: string;
|
|
3510
3510
|
}
|
|
@@ -3513,26 +3513,26 @@ export interface UpdateDataSourceOutput {
|
|
|
3513
3513
|
*/
|
|
3514
3514
|
export interface UpdateEvaluationInput {
|
|
3515
3515
|
/**
|
|
3516
|
-
* @public
|
|
3517
3516
|
* <p>The ID assigned to the <code>Evaluation</code> during creation.</p>
|
|
3517
|
+
* @public
|
|
3518
3518
|
*/
|
|
3519
3519
|
EvaluationId: string | undefined;
|
|
3520
3520
|
/**
|
|
3521
|
-
* @public
|
|
3522
3521
|
* <p>A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </p>
|
|
3522
|
+
* @public
|
|
3523
3523
|
*/
|
|
3524
3524
|
EvaluationName: string | undefined;
|
|
3525
3525
|
}
|
|
3526
3526
|
/**
|
|
3527
|
-
* @public
|
|
3528
3527
|
* <p>Represents the output of an <code>UpdateEvaluation</code> operation.</p>
|
|
3529
3528
|
* <p>You can see the updated content by using the <code>GetEvaluation</code> operation.</p>
|
|
3529
|
+
* @public
|
|
3530
3530
|
*/
|
|
3531
3531
|
export interface UpdateEvaluationOutput {
|
|
3532
3532
|
/**
|
|
3533
|
-
* @public
|
|
3534
3533
|
* <p>The ID assigned to the <code>Evaluation</code> during creation. This value should be identical to the value
|
|
3535
3534
|
* of the <code>Evaluation</code> in the request.</p>
|
|
3535
|
+
* @public
|
|
3536
3536
|
*/
|
|
3537
3537
|
EvaluationId?: string;
|
|
3538
3538
|
}
|
|
@@ -3541,32 +3541,32 @@ export interface UpdateEvaluationOutput {
|
|
|
3541
3541
|
*/
|
|
3542
3542
|
export interface UpdateMLModelInput {
|
|
3543
3543
|
/**
|
|
3544
|
-
* @public
|
|
3545
3544
|
* <p>The ID assigned to the <code>MLModel</code> during creation.</p>
|
|
3545
|
+
* @public
|
|
3546
3546
|
*/
|
|
3547
3547
|
MLModelId: string | undefined;
|
|
3548
3548
|
/**
|
|
3549
|
-
* @public
|
|
3550
3549
|
* <p>A user-supplied name or description of the <code>MLModel</code>.</p>
|
|
3550
|
+
* @public
|
|
3551
3551
|
*/
|
|
3552
3552
|
MLModelName?: string;
|
|
3553
3553
|
/**
|
|
3554
|
-
* @public
|
|
3555
3554
|
* <p>The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction.</p>
|
|
3556
3555
|
* <p>Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</p>
|
|
3556
|
+
* @public
|
|
3557
3557
|
*/
|
|
3558
3558
|
ScoreThreshold?: number;
|
|
3559
3559
|
}
|
|
3560
3560
|
/**
|
|
3561
|
-
* @public
|
|
3562
3561
|
* <p>Represents the output of an <code>UpdateMLModel</code> operation.</p>
|
|
3563
3562
|
* <p>You can see the updated content by using the <code>GetMLModel</code> operation.</p>
|
|
3563
|
+
* @public
|
|
3564
3564
|
*/
|
|
3565
3565
|
export interface UpdateMLModelOutput {
|
|
3566
3566
|
/**
|
|
3567
|
-
* @public
|
|
3568
3567
|
* <p>The ID assigned to the <code>MLModel</code> during creation. This value should be identical to the value
|
|
3569
3568
|
* of the <code>MLModelID</code> in the request.</p>
|
|
3569
|
+
* @public
|
|
3570
3570
|
*/
|
|
3571
3571
|
MLModelId?: string;
|
|
3572
3572
|
}
|