aws-sdk-lookoutforvision 1.0.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.
@@ -0,0 +1,210 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LookoutforVision
11
+
12
+ # When LookoutforVision returns an error response, the Ruby SDK constructs and raises an error.
13
+ # These errors all extend Aws::LookoutforVision::Errors::ServiceError < {Aws::Errors::ServiceError}
14
+ #
15
+ # You can rescue all LookoutforVision errors using ServiceError:
16
+ #
17
+ # begin
18
+ # # do stuff
19
+ # rescue Aws::LookoutforVision::Errors::ServiceError
20
+ # # rescues all LookoutforVision API errors
21
+ # end
22
+ #
23
+ #
24
+ # ## Request Context
25
+ # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
26
+ # information about the request that generated the error.
27
+ # See {Seahorse::Client::RequestContext} for more information.
28
+ #
29
+ # ## Error Classes
30
+ # * {AccessDeniedException}
31
+ # * {ConflictException}
32
+ # * {InternalServerException}
33
+ # * {ResourceNotFoundException}
34
+ # * {ServiceQuotaExceededException}
35
+ # * {ThrottlingException}
36
+ # * {ValidationException}
37
+ #
38
+ # Additionally, error classes are dynamically generated for service errors based on the error code
39
+ # if they are not defined above.
40
+ module Errors
41
+
42
+ extend Aws::Errors::DynamicErrors
43
+
44
+ class AccessDeniedException < ServiceError
45
+
46
+ # @param [Seahorse::Client::RequestContext] context
47
+ # @param [String] message
48
+ # @param [Aws::LookoutforVision::Types::AccessDeniedException] data
49
+ def initialize(context, message, data = Aws::EmptyStructure.new)
50
+ super(context, message, data)
51
+ end
52
+
53
+ # @return [String]
54
+ def message
55
+ @message || @data[:message]
56
+ end
57
+ end
58
+
59
+ class ConflictException < ServiceError
60
+
61
+ # @param [Seahorse::Client::RequestContext] context
62
+ # @param [String] message
63
+ # @param [Aws::LookoutforVision::Types::ConflictException] data
64
+ def initialize(context, message, data = Aws::EmptyStructure.new)
65
+ super(context, message, data)
66
+ end
67
+
68
+ # @return [String]
69
+ def message
70
+ @message || @data[:message]
71
+ end
72
+
73
+ # @return [String]
74
+ def resource_id
75
+ @data[:resource_id]
76
+ end
77
+
78
+ # @return [String]
79
+ def resource_type
80
+ @data[:resource_type]
81
+ end
82
+ end
83
+
84
+ class InternalServerException < ServiceError
85
+
86
+ # @param [Seahorse::Client::RequestContext] context
87
+ # @param [String] message
88
+ # @param [Aws::LookoutforVision::Types::InternalServerException] data
89
+ def initialize(context, message, data = Aws::EmptyStructure.new)
90
+ super(context, message, data)
91
+ end
92
+
93
+ # @return [String]
94
+ def message
95
+ @message || @data[:message]
96
+ end
97
+
98
+ # @return [String]
99
+ def retry_after_seconds
100
+ @data[:retry_after_seconds]
101
+ end
102
+ end
103
+
104
+ class ResourceNotFoundException < ServiceError
105
+
106
+ # @param [Seahorse::Client::RequestContext] context
107
+ # @param [String] message
108
+ # @param [Aws::LookoutforVision::Types::ResourceNotFoundException] data
109
+ def initialize(context, message, data = Aws::EmptyStructure.new)
110
+ super(context, message, data)
111
+ end
112
+
113
+ # @return [String]
114
+ def message
115
+ @message || @data[:message]
116
+ end
117
+
118
+ # @return [String]
119
+ def resource_id
120
+ @data[:resource_id]
121
+ end
122
+
123
+ # @return [String]
124
+ def resource_type
125
+ @data[:resource_type]
126
+ end
127
+ end
128
+
129
+ class ServiceQuotaExceededException < ServiceError
130
+
131
+ # @param [Seahorse::Client::RequestContext] context
132
+ # @param [String] message
133
+ # @param [Aws::LookoutforVision::Types::ServiceQuotaExceededException] data
134
+ def initialize(context, message, data = Aws::EmptyStructure.new)
135
+ super(context, message, data)
136
+ end
137
+
138
+ # @return [String]
139
+ def message
140
+ @message || @data[:message]
141
+ end
142
+
143
+ # @return [String]
144
+ def resource_id
145
+ @data[:resource_id]
146
+ end
147
+
148
+ # @return [String]
149
+ def resource_type
150
+ @data[:resource_type]
151
+ end
152
+
153
+ # @return [String]
154
+ def quota_code
155
+ @data[:quota_code]
156
+ end
157
+
158
+ # @return [String]
159
+ def service_code
160
+ @data[:service_code]
161
+ end
162
+ end
163
+
164
+ class ThrottlingException < ServiceError
165
+
166
+ # @param [Seahorse::Client::RequestContext] context
167
+ # @param [String] message
168
+ # @param [Aws::LookoutforVision::Types::ThrottlingException] data
169
+ def initialize(context, message, data = Aws::EmptyStructure.new)
170
+ super(context, message, data)
171
+ end
172
+
173
+ # @return [String]
174
+ def message
175
+ @message || @data[:message]
176
+ end
177
+
178
+ # @return [String]
179
+ def quota_code
180
+ @data[:quota_code]
181
+ end
182
+
183
+ # @return [String]
184
+ def service_code
185
+ @data[:service_code]
186
+ end
187
+
188
+ # @return [String]
189
+ def retry_after_seconds
190
+ @data[:retry_after_seconds]
191
+ end
192
+ end
193
+
194
+ class ValidationException < ServiceError
195
+
196
+ # @param [Seahorse::Client::RequestContext] context
197
+ # @param [String] message
198
+ # @param [Aws::LookoutforVision::Types::ValidationException] data
199
+ def initialize(context, message, data = Aws::EmptyStructure.new)
200
+ super(context, message, data)
201
+ end
202
+
203
+ # @return [String]
204
+ def message
205
+ @message || @data[:message]
206
+ end
207
+ end
208
+
209
+ end
210
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LookoutforVision
11
+
12
+ class Resource
13
+
14
+ # @param options ({})
15
+ # @option options [Client] :client
16
+ def initialize(options = {})
17
+ @client = options[:client] || Client.new(options)
18
+ end
19
+
20
+ # @return [Client]
21
+ def client
22
+ @client
23
+ end
24
+
25
+ end
26
+ end
@@ -0,0 +1,1660 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::LookoutforVision
11
+ module Types
12
+
13
+ # You are not authorized to perform the action.
14
+ #
15
+ # @!attribute [rw] message
16
+ # @return [String]
17
+ #
18
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/AccessDeniedException AWS API Documentation
19
+ #
20
+ class AccessDeniedException < Struct.new(
21
+ :message)
22
+ SENSITIVE = []
23
+ include Aws::Structure
24
+ end
25
+
26
+ # The update or deletion of a resource caused an inconsistent state.
27
+ #
28
+ # @!attribute [rw] message
29
+ # @return [String]
30
+ #
31
+ # @!attribute [rw] resource_id
32
+ # The ID of the resource.
33
+ # @return [String]
34
+ #
35
+ # @!attribute [rw] resource_type
36
+ # The type of the resource.
37
+ # @return [String]
38
+ #
39
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ConflictException AWS API Documentation
40
+ #
41
+ class ConflictException < Struct.new(
42
+ :message,
43
+ :resource_id,
44
+ :resource_type)
45
+ SENSITIVE = []
46
+ include Aws::Structure
47
+ end
48
+
49
+ # @note When making an API call, you may pass CreateDatasetRequest
50
+ # data as a hash:
51
+ #
52
+ # {
53
+ # project_name: "ProjectName", # required
54
+ # dataset_type: "DatasetType", # required
55
+ # dataset_source: {
56
+ # ground_truth_manifest: {
57
+ # s3_object: {
58
+ # bucket: "S3BucketName", # required
59
+ # key: "S3ObjectKey", # required
60
+ # version_id: "S3ObjectVersion",
61
+ # },
62
+ # },
63
+ # },
64
+ # client_token: "ClientToken",
65
+ # }
66
+ #
67
+ # @!attribute [rw] project_name
68
+ # The name of the project in which you want to create a dataset.
69
+ # @return [String]
70
+ #
71
+ # @!attribute [rw] dataset_type
72
+ # The type of the dataset. Specify `train` for a training dataset.
73
+ # Specify `test` for a test dataset.
74
+ # @return [String]
75
+ #
76
+ # @!attribute [rw] dataset_source
77
+ # The location of the manifest file that Amazon Lookout for Vision
78
+ # uses to create the dataset.
79
+ #
80
+ # If you don't specify `DatasetSource`, an empty dataset is created
81
+ # and the operation synchronously returns. Later, you can add JSON
82
+ # Lines by calling UpdateDatasetEntries.
83
+ #
84
+ # If you specify a value for `DataSource`, the manifest at the S3
85
+ # location is validated and used to create the dataset. The call to
86
+ # `CreateDataset` is asynchronous and might take a while to complete.
87
+ # To find out the current status, Check the value of `Status` returned
88
+ # in a call to DescribeDataset.
89
+ # @return [Types::DatasetSource]
90
+ #
91
+ # @!attribute [rw] client_token
92
+ # ClientToken is an idempotency token that ensures a call to
93
+ # `CreateDataset` completes only once. You choose the value to pass.
94
+ # For example, An issue, such as an network outage, might prevent you
95
+ # from getting a response from `CreateDataset`. In this case, safely
96
+ # retry your call to `CreateDataset` by using the same `ClientToken`
97
+ # parameter value. An error occurs if the other input parameters are
98
+ # not the same as in the first request. Using a different value for
99
+ # `ClientToken` is considered a new call to `CreateDataset`. An
100
+ # idempotency token is active for 8 hours.
101
+ #
102
+ # **A suitable default value is auto-generated.** You should normally
103
+ # not need to pass this option.
104
+ # @return [String]
105
+ #
106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateDatasetRequest AWS API Documentation
107
+ #
108
+ class CreateDatasetRequest < Struct.new(
109
+ :project_name,
110
+ :dataset_type,
111
+ :dataset_source,
112
+ :client_token)
113
+ SENSITIVE = []
114
+ include Aws::Structure
115
+ end
116
+
117
+ # @!attribute [rw] dataset_metadata
118
+ # Information about the dataset.
119
+ # @return [Types::DatasetMetadata]
120
+ #
121
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateDatasetResponse AWS API Documentation
122
+ #
123
+ class CreateDatasetResponse < Struct.new(
124
+ :dataset_metadata)
125
+ SENSITIVE = []
126
+ include Aws::Structure
127
+ end
128
+
129
+ # @note When making an API call, you may pass CreateModelRequest
130
+ # data as a hash:
131
+ #
132
+ # {
133
+ # project_name: "ProjectName", # required
134
+ # description: {
135
+ # model_version: "ModelVersion",
136
+ # model_arn: "ModelArn",
137
+ # creation_timestamp: Time.now,
138
+ # description: "ModelDescriptionMessage",
139
+ # status: "TRAINING", # accepts TRAINING, TRAINED, TRAINING_FAILED, STARTING_HOSTING, HOSTED, HOSTING_FAILED, STOPPING_HOSTING, SYSTEM_UPDATING, DELETING
140
+ # status_message: "ModelStatusMessage",
141
+ # performance: {
142
+ # f1_score: 1.0,
143
+ # recall: 1.0,
144
+ # precision: 1.0,
145
+ # },
146
+ # output_config: {
147
+ # s3_location: { # required
148
+ # bucket: "S3BucketName", # required
149
+ # prefix: "S3KeyPrefix",
150
+ # },
151
+ # },
152
+ # evaluation_manifest: {
153
+ # bucket: "S3BucketName", # required
154
+ # key: "S3ObjectKey", # required
155
+ # },
156
+ # evaluation_result: {
157
+ # bucket: "S3BucketName", # required
158
+ # key: "S3ObjectKey", # required
159
+ # },
160
+ # evaluation_end_timestamp: Time.now,
161
+ # kms_key_id: "KmsKeyId",
162
+ # },
163
+ # client_token: "ClientToken",
164
+ # output_config: { # required
165
+ # s3_location: { # required
166
+ # bucket: "S3BucketName", # required
167
+ # prefix: "S3KeyPrefix",
168
+ # },
169
+ # },
170
+ # kms_key_id: "KmsKeyId",
171
+ # }
172
+ #
173
+ # @!attribute [rw] project_name
174
+ # The name of the project in which you want to create a model version.
175
+ # @return [String]
176
+ #
177
+ # @!attribute [rw] description
178
+ # A description for the version of the model.
179
+ # @return [Types::ModelDescription]
180
+ #
181
+ # @!attribute [rw] client_token
182
+ # ClientToken is an idempotency token that ensures a call to
183
+ # `CreateModel` completes only once. You choose the value to pass. For
184
+ # example, An issue, such as an network outage, might prevent you from
185
+ # getting a response from `CreateModel`. In this case, safely retry
186
+ # your call to `CreateModel` by using the same `ClientToken` parameter
187
+ # value. An error occurs if the other input parameters are not the
188
+ # same as in the first request. Using a different value for
189
+ # `ClientToken` is considered a new call to `CreateModel`. An
190
+ # idempotency token is active for 8 hours.
191
+ #
192
+ # **A suitable default value is auto-generated.** You should normally
193
+ # not need to pass this option.
194
+ # @return [String]
195
+ #
196
+ # @!attribute [rw] output_config
197
+ # The location where Amazon Lookout for Vision saves the training
198
+ # results.
199
+ # @return [Types::OutputConfig]
200
+ #
201
+ # @!attribute [rw] kms_key_id
202
+ # The identifier of the AWS Key Management Service (AWS KMS) customer
203
+ # master key (CMK) to use for encypting the model. If this parameter
204
+ # is not specified, the model is encrypted by a key that AWS owns and
205
+ # manages.
206
+ # @return [String]
207
+ #
208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateModelRequest AWS API Documentation
209
+ #
210
+ class CreateModelRequest < Struct.new(
211
+ :project_name,
212
+ :description,
213
+ :client_token,
214
+ :output_config,
215
+ :kms_key_id)
216
+ SENSITIVE = []
217
+ include Aws::Structure
218
+ end
219
+
220
+ # @!attribute [rw] model_metadata
221
+ # The response from a call to `CreateModel`.
222
+ # @return [Types::ModelMetadata]
223
+ #
224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateModelResponse AWS API Documentation
225
+ #
226
+ class CreateModelResponse < Struct.new(
227
+ :model_metadata)
228
+ SENSITIVE = []
229
+ include Aws::Structure
230
+ end
231
+
232
+ # @note When making an API call, you may pass CreateProjectRequest
233
+ # data as a hash:
234
+ #
235
+ # {
236
+ # project_name: "ProjectName", # required
237
+ # client_token: "ClientToken",
238
+ # }
239
+ #
240
+ # @!attribute [rw] project_name
241
+ # S nsme for the project.
242
+ # @return [String]
243
+ #
244
+ # @!attribute [rw] client_token
245
+ # ClientToken is an idempotency token that ensures a call to
246
+ # `CreateProject` completes only once. You choose the value to pass.
247
+ # For example, An issue, such as an network outage, might prevent you
248
+ # from getting a response from `CreateProject`. In this case, safely
249
+ # retry your call to `CreateProject` by using the same `ClientToken`
250
+ # parameter value. An error occurs if the other input parameters are
251
+ # not the same as in the first request. Using a different value for
252
+ # `ClientToken` is considered a new call to `CreateProject`. An
253
+ # idempotency token is active for 8 hours.
254
+ #
255
+ # **A suitable default value is auto-generated.** You should normally
256
+ # not need to pass this option.
257
+ # @return [String]
258
+ #
259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateProjectRequest AWS API Documentation
260
+ #
261
+ class CreateProjectRequest < Struct.new(
262
+ :project_name,
263
+ :client_token)
264
+ SENSITIVE = []
265
+ include Aws::Structure
266
+ end
267
+
268
+ # @!attribute [rw] project_metadata
269
+ # Information about the project.
270
+ # @return [Types::ProjectMetadata]
271
+ #
272
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateProjectResponse AWS API Documentation
273
+ #
274
+ class CreateProjectResponse < Struct.new(
275
+ :project_metadata)
276
+ SENSITIVE = []
277
+ include Aws::Structure
278
+ end
279
+
280
+ # The description for a dataset. For more information, see
281
+ # DescribeDataset.
282
+ #
283
+ # @!attribute [rw] project_name
284
+ # The name of the project that contains the dataset.
285
+ # @return [String]
286
+ #
287
+ # @!attribute [rw] dataset_type
288
+ # The type of the dataset. The value `train` represents a training
289
+ # dataset or single dataset project. The value `test` represents a
290
+ # test dataset.
291
+ # @return [String]
292
+ #
293
+ # @!attribute [rw] creation_timestamp
294
+ # The Unix timestamp for the time and date that the dataset was
295
+ # created.
296
+ # @return [Time]
297
+ #
298
+ # @!attribute [rw] last_updated_timestamp
299
+ # The Unix timestamp for the date and time that the dataset was last
300
+ # updated.
301
+ # @return [Time]
302
+ #
303
+ # @!attribute [rw] status
304
+ # The status of the dataset.
305
+ # @return [String]
306
+ #
307
+ # @!attribute [rw] status_message
308
+ # The status message for the dataset.
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] image_stats
312
+ # @return [Types::DatasetImageStats]
313
+ #
314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DatasetDescription AWS API Documentation
315
+ #
316
+ class DatasetDescription < Struct.new(
317
+ :project_name,
318
+ :dataset_type,
319
+ :creation_timestamp,
320
+ :last_updated_timestamp,
321
+ :status,
322
+ :status_message,
323
+ :image_stats)
324
+ SENSITIVE = []
325
+ include Aws::Structure
326
+ end
327
+
328
+ # Location information about a manifest file. You can use a manifest
329
+ # file to create a dataset.
330
+ #
331
+ # @note When making an API call, you may pass DatasetGroundTruthManifest
332
+ # data as a hash:
333
+ #
334
+ # {
335
+ # s3_object: {
336
+ # bucket: "S3BucketName", # required
337
+ # key: "S3ObjectKey", # required
338
+ # version_id: "S3ObjectVersion",
339
+ # },
340
+ # }
341
+ #
342
+ # @!attribute [rw] s3_object
343
+ # The S3 bucket location for the manifest file.
344
+ # @return [Types::InputS3Object]
345
+ #
346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DatasetGroundTruthManifest AWS API Documentation
347
+ #
348
+ class DatasetGroundTruthManifest < Struct.new(
349
+ :s3_object)
350
+ SENSITIVE = []
351
+ include Aws::Structure
352
+ end
353
+
354
+ # Statistics about the images in a dataset.
355
+ #
356
+ # @!attribute [rw] total
357
+ # The total number of images in the dataset.
358
+ # @return [Integer]
359
+ #
360
+ # @!attribute [rw] labeled
361
+ # The total number of labeled images.
362
+ # @return [Integer]
363
+ #
364
+ # @!attribute [rw] normal
365
+ # The total number of images labeled as normal.
366
+ # @return [Integer]
367
+ #
368
+ # @!attribute [rw] anomaly
369
+ # the total number of images labeled as an anomaly.
370
+ # @return [Integer]
371
+ #
372
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DatasetImageStats AWS API Documentation
373
+ #
374
+ class DatasetImageStats < Struct.new(
375
+ :total,
376
+ :labeled,
377
+ :normal,
378
+ :anomaly)
379
+ SENSITIVE = []
380
+ include Aws::Structure
381
+ end
382
+
383
+ # Sumary information for an Amazon Lookout for Vision dataset.
384
+ #
385
+ # @!attribute [rw] dataset_type
386
+ # The type of the dataset.
387
+ # @return [String]
388
+ #
389
+ # @!attribute [rw] creation_timestamp
390
+ # The Unix timestamp for the date and time that the dataset was
391
+ # created.
392
+ # @return [Time]
393
+ #
394
+ # @!attribute [rw] status
395
+ # The status for the dataset.
396
+ # @return [String]
397
+ #
398
+ # @!attribute [rw] status_message
399
+ # The status message for the dataset.
400
+ # @return [String]
401
+ #
402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DatasetMetadata AWS API Documentation
403
+ #
404
+ class DatasetMetadata < Struct.new(
405
+ :dataset_type,
406
+ :creation_timestamp,
407
+ :status,
408
+ :status_message)
409
+ SENSITIVE = []
410
+ include Aws::Structure
411
+ end
412
+
413
+ # Information about the location of a manifest file that Amazon Lookout
414
+ # for Vision uses to to create a dataset.
415
+ #
416
+ # @note When making an API call, you may pass DatasetSource
417
+ # data as a hash:
418
+ #
419
+ # {
420
+ # ground_truth_manifest: {
421
+ # s3_object: {
422
+ # bucket: "S3BucketName", # required
423
+ # key: "S3ObjectKey", # required
424
+ # version_id: "S3ObjectVersion",
425
+ # },
426
+ # },
427
+ # }
428
+ #
429
+ # @!attribute [rw] ground_truth_manifest
430
+ # Location information for the manifest file.
431
+ # @return [Types::DatasetGroundTruthManifest]
432
+ #
433
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DatasetSource AWS API Documentation
434
+ #
435
+ class DatasetSource < Struct.new(
436
+ :ground_truth_manifest)
437
+ SENSITIVE = []
438
+ include Aws::Structure
439
+ end
440
+
441
+ # @note When making an API call, you may pass DeleteDatasetRequest
442
+ # data as a hash:
443
+ #
444
+ # {
445
+ # project_name: "ProjectName", # required
446
+ # dataset_type: "DatasetType", # required
447
+ # client_token: "ClientToken",
448
+ # }
449
+ #
450
+ # @!attribute [rw] project_name
451
+ # The name of the project that contains the dataset that you want to
452
+ # delete.
453
+ # @return [String]
454
+ #
455
+ # @!attribute [rw] dataset_type
456
+ # The type of the dataset to delete. Specify `train` to delete the
457
+ # training dataset. Specify `test` to delete the test dataset. To
458
+ # delete the dataset in a single dataset project, specify `train`.
459
+ # @return [String]
460
+ #
461
+ # @!attribute [rw] client_token
462
+ # ClientToken is an idempotency token that ensures a call to
463
+ # `DeleteDataset` completes only once. You choose the value to pass.
464
+ # For example, An issue, such as an network outage, might prevent you
465
+ # from getting a response from `DeleteDataset`. In this case, safely
466
+ # retry your call to `DeleteDataset` by using the same `ClientToken`
467
+ # parameter value. An error occurs if the other input parameters are
468
+ # not the same as in the first request. Using a different value for
469
+ # `ClientToken` is considered a new call to `DeleteDataset`. An
470
+ # idempotency token is active for 8 hours.
471
+ #
472
+ # **A suitable default value is auto-generated.** You should normally
473
+ # not need to pass this option.
474
+ # @return [String]
475
+ #
476
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteDatasetRequest AWS API Documentation
477
+ #
478
+ class DeleteDatasetRequest < Struct.new(
479
+ :project_name,
480
+ :dataset_type,
481
+ :client_token)
482
+ SENSITIVE = []
483
+ include Aws::Structure
484
+ end
485
+
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteDatasetResponse AWS API Documentation
487
+ #
488
+ class DeleteDatasetResponse < Aws::EmptyStructure; end
489
+
490
+ # @note When making an API call, you may pass DeleteModelRequest
491
+ # data as a hash:
492
+ #
493
+ # {
494
+ # project_name: "ProjectName", # required
495
+ # model_version: "ModelVersion", # required
496
+ # client_token: "ClientToken",
497
+ # }
498
+ #
499
+ # @!attribute [rw] project_name
500
+ # The name of the project that contains the model that you want to
501
+ # delete.
502
+ # @return [String]
503
+ #
504
+ # @!attribute [rw] model_version
505
+ # The version of the model that you want to delete.
506
+ # @return [String]
507
+ #
508
+ # @!attribute [rw] client_token
509
+ # ClientToken is an idempotency token that ensures a call to
510
+ # `DeleteModel` completes only once. You choose the value to pass. For
511
+ # example, An issue, such as an network outage, might prevent you from
512
+ # getting a response from `DeleteModel`. In this case, safely retry
513
+ # your call to `DeleteModel` by using the same `ClientToken` parameter
514
+ # value. An error occurs if the other input parameters are not the
515
+ # same as in the first request. Using a different value for
516
+ # `ClientToken` is considered a new call to `DeleteModel`. An
517
+ # idempotency token is active for 8 hours.
518
+ #
519
+ # **A suitable default value is auto-generated.** You should normally
520
+ # not need to pass this option.
521
+ # @return [String]
522
+ #
523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteModelRequest AWS API Documentation
524
+ #
525
+ class DeleteModelRequest < Struct.new(
526
+ :project_name,
527
+ :model_version,
528
+ :client_token)
529
+ SENSITIVE = []
530
+ include Aws::Structure
531
+ end
532
+
533
+ # @!attribute [rw] model_arn
534
+ # The Amazon Resource Name (ARN) of the model that was deleted.
535
+ # @return [String]
536
+ #
537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteModelResponse AWS API Documentation
538
+ #
539
+ class DeleteModelResponse < Struct.new(
540
+ :model_arn)
541
+ SENSITIVE = []
542
+ include Aws::Structure
543
+ end
544
+
545
+ # @note When making an API call, you may pass DeleteProjectRequest
546
+ # data as a hash:
547
+ #
548
+ # {
549
+ # project_name: "ProjectName", # required
550
+ # client_token: "ClientToken",
551
+ # }
552
+ #
553
+ # @!attribute [rw] project_name
554
+ # The name of the project to delete.
555
+ # @return [String]
556
+ #
557
+ # @!attribute [rw] client_token
558
+ # ClientToken is an idempotency token that ensures a call to
559
+ # `DeleteProject` completes only once. You choose the value to pass.
560
+ # For example, An issue, such as an network outage, might prevent you
561
+ # from getting a response from `DeleteProject`. In this case, safely
562
+ # retry your call to `DeleteProject` by using the same `ClientToken`
563
+ # parameter value. An error occurs if the other input parameters are
564
+ # not the same as in the first request. Using a different value for
565
+ # `ClientToken` is considered a new call to `DeleteProject`. An
566
+ # idempotency token is active for 8 hours.
567
+ #
568
+ # **A suitable default value is auto-generated.** You should normally
569
+ # not need to pass this option.
570
+ # @return [String]
571
+ #
572
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteProjectRequest AWS API Documentation
573
+ #
574
+ class DeleteProjectRequest < Struct.new(
575
+ :project_name,
576
+ :client_token)
577
+ SENSITIVE = []
578
+ include Aws::Structure
579
+ end
580
+
581
+ # @!attribute [rw] project_arn
582
+ # The Amazon Resource Name (ARN) of the project that was deleted.
583
+ # @return [String]
584
+ #
585
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteProjectResponse AWS API Documentation
586
+ #
587
+ class DeleteProjectResponse < Struct.new(
588
+ :project_arn)
589
+ SENSITIVE = []
590
+ include Aws::Structure
591
+ end
592
+
593
+ # @note When making an API call, you may pass DescribeDatasetRequest
594
+ # data as a hash:
595
+ #
596
+ # {
597
+ # project_name: "ProjectName", # required
598
+ # dataset_type: "DatasetType", # required
599
+ # }
600
+ #
601
+ # @!attribute [rw] project_name
602
+ # The name of the project that contains the dataset that you want to
603
+ # describe.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] dataset_type
607
+ # The type of the dataset to describe. Specify `train` to describe the
608
+ # training dataset. Specify `test` to describe the test dataset. If
609
+ # you have a single dataset project, specify `train`
610
+ # @return [String]
611
+ #
612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeDatasetRequest AWS API Documentation
613
+ #
614
+ class DescribeDatasetRequest < Struct.new(
615
+ :project_name,
616
+ :dataset_type)
617
+ SENSITIVE = []
618
+ include Aws::Structure
619
+ end
620
+
621
+ # @!attribute [rw] dataset_description
622
+ # The description of the requested dataset.
623
+ # @return [Types::DatasetDescription]
624
+ #
625
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeDatasetResponse AWS API Documentation
626
+ #
627
+ class DescribeDatasetResponse < Struct.new(
628
+ :dataset_description)
629
+ SENSITIVE = []
630
+ include Aws::Structure
631
+ end
632
+
633
+ # @note When making an API call, you may pass DescribeModelRequest
634
+ # data as a hash:
635
+ #
636
+ # {
637
+ # project_name: "ProjectName", # required
638
+ # model_version: "ModelVersion", # required
639
+ # }
640
+ #
641
+ # @!attribute [rw] project_name
642
+ # The project that contains the version of a model that you want to
643
+ # describe.
644
+ # @return [String]
645
+ #
646
+ # @!attribute [rw] model_version
647
+ # The version of the model that you want to describe.
648
+ # @return [String]
649
+ #
650
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeModelRequest AWS API Documentation
651
+ #
652
+ class DescribeModelRequest < Struct.new(
653
+ :project_name,
654
+ :model_version)
655
+ SENSITIVE = []
656
+ include Aws::Structure
657
+ end
658
+
659
+ # @!attribute [rw] model_description
660
+ # Contains the description of the model.
661
+ # @return [Types::ModelDescription]
662
+ #
663
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeModelResponse AWS API Documentation
664
+ #
665
+ class DescribeModelResponse < Struct.new(
666
+ :model_description)
667
+ SENSITIVE = []
668
+ include Aws::Structure
669
+ end
670
+
671
+ # @note When making an API call, you may pass DescribeProjectRequest
672
+ # data as a hash:
673
+ #
674
+ # {
675
+ # project_name: "ProjectName", # required
676
+ # }
677
+ #
678
+ # @!attribute [rw] project_name
679
+ # The name of the project that you want to describe.
680
+ # @return [String]
681
+ #
682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeProjectRequest AWS API Documentation
683
+ #
684
+ class DescribeProjectRequest < Struct.new(
685
+ :project_name)
686
+ SENSITIVE = []
687
+ include Aws::Structure
688
+ end
689
+
690
+ # @!attribute [rw] project_description
691
+ # The description of the project.
692
+ # @return [Types::ProjectDescription]
693
+ #
694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeProjectResponse AWS API Documentation
695
+ #
696
+ class DescribeProjectResponse < Struct.new(
697
+ :project_description)
698
+ SENSITIVE = []
699
+ include Aws::Structure
700
+ end
701
+
702
+ # @note When making an API call, you may pass DetectAnomaliesRequest
703
+ # data as a hash:
704
+ #
705
+ # {
706
+ # project_name: "ProjectName", # required
707
+ # model_version: "ModelVersion", # required
708
+ # body: "data", # required
709
+ # content_type: "ContentType", # required
710
+ # }
711
+ #
712
+ # @!attribute [rw] project_name
713
+ # The name of the project that contains the model version that you
714
+ # want to use.
715
+ # @return [String]
716
+ #
717
+ # @!attribute [rw] model_version
718
+ # The version of the model that you want to use.
719
+ # @return [String]
720
+ #
721
+ # @!attribute [rw] body
722
+ # The unencrypted image bytes that you want to analyze.
723
+ # @return [IO]
724
+ #
725
+ # @!attribute [rw] content_type
726
+ # The type of the image passed in `Body`. Valid values are `image/png`
727
+ # (PNG format images) and `image/jpeg` (JPG format images).
728
+ # @return [String]
729
+ #
730
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DetectAnomaliesRequest AWS API Documentation
731
+ #
732
+ class DetectAnomaliesRequest < Struct.new(
733
+ :project_name,
734
+ :model_version,
735
+ :body,
736
+ :content_type)
737
+ SENSITIVE = []
738
+ include Aws::Structure
739
+ end
740
+
741
+ # @!attribute [rw] detect_anomaly_result
742
+ # The results of the `DetectAnomalies` operation.
743
+ # @return [Types::DetectAnomalyResult]
744
+ #
745
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DetectAnomaliesResponse AWS API Documentation
746
+ #
747
+ class DetectAnomaliesResponse < Struct.new(
748
+ :detect_anomaly_result)
749
+ SENSITIVE = []
750
+ include Aws::Structure
751
+ end
752
+
753
+ # The prediction results from a call to DetectAnomalies.
754
+ #
755
+ # @!attribute [rw] source
756
+ # The source of the image that was analyzed. `direct` means that the
757
+ # images was supplied from the local computer. No other values are
758
+ # supported.
759
+ # @return [Types::ImageSource]
760
+ #
761
+ # @!attribute [rw] is_anomalous
762
+ # True if the image contains an anomaly, otherwise false.
763
+ # @return [Boolean]
764
+ #
765
+ # @!attribute [rw] confidence
766
+ # The confidence that Amazon Lookout for Vision has in the accuracy of
767
+ # the prediction.
768
+ # @return [Float]
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DetectAnomalyResult AWS API Documentation
771
+ #
772
+ class DetectAnomalyResult < Struct.new(
773
+ :source,
774
+ :is_anomalous,
775
+ :confidence)
776
+ SENSITIVE = []
777
+ include Aws::Structure
778
+ end
779
+
780
+ # The source for an image.
781
+ #
782
+ # @!attribute [rw] type
783
+ # The type of the image.
784
+ # @return [String]
785
+ #
786
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ImageSource AWS API Documentation
787
+ #
788
+ class ImageSource < Struct.new(
789
+ :type)
790
+ SENSITIVE = []
791
+ include Aws::Structure
792
+ end
793
+
794
+ # Amazon S3 Location information for an input manifest file.
795
+ #
796
+ # @note When making an API call, you may pass InputS3Object
797
+ # data as a hash:
798
+ #
799
+ # {
800
+ # bucket: "S3BucketName", # required
801
+ # key: "S3ObjectKey", # required
802
+ # version_id: "S3ObjectVersion",
803
+ # }
804
+ #
805
+ # @!attribute [rw] bucket
806
+ # The Amazon S3 bucket that contains the manifest.
807
+ # @return [String]
808
+ #
809
+ # @!attribute [rw] key
810
+ # The name and location of the manifest file withiin the bucket.
811
+ # @return [String]
812
+ #
813
+ # @!attribute [rw] version_id
814
+ # The version ID of the bucket.
815
+ # @return [String]
816
+ #
817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/InputS3Object AWS API Documentation
818
+ #
819
+ class InputS3Object < Struct.new(
820
+ :bucket,
821
+ :key,
822
+ :version_id)
823
+ SENSITIVE = []
824
+ include Aws::Structure
825
+ end
826
+
827
+ # Amazon Lookout for Vision experienced a service issue. Try your call
828
+ # again.
829
+ #
830
+ # @!attribute [rw] message
831
+ # @return [String]
832
+ #
833
+ # @!attribute [rw] retry_after_seconds
834
+ # The period of time, in seconds, before the operation can be retried.
835
+ # @return [Integer]
836
+ #
837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/InternalServerException AWS API Documentation
838
+ #
839
+ class InternalServerException < Struct.new(
840
+ :message,
841
+ :retry_after_seconds)
842
+ SENSITIVE = []
843
+ include Aws::Structure
844
+ end
845
+
846
+ # @note When making an API call, you may pass ListDatasetEntriesRequest
847
+ # data as a hash:
848
+ #
849
+ # {
850
+ # project_name: "ProjectName", # required
851
+ # dataset_type: "DatasetType", # required
852
+ # labeled: false,
853
+ # anomaly_class: "AnomalyClassFilter",
854
+ # before_creation_date: Time.now,
855
+ # after_creation_date: Time.now,
856
+ # next_token: "PaginationToken",
857
+ # max_results: 1,
858
+ # source_ref_contains: "QueryString",
859
+ # }
860
+ #
861
+ # @!attribute [rw] project_name
862
+ # The name of the project that contains the dataset that you want to
863
+ # list.
864
+ # @return [String]
865
+ #
866
+ # @!attribute [rw] dataset_type
867
+ # The type of the dataset that you want to list. Specify `train` to
868
+ # list the training dataset. Specify `test` to list the test dataset.
869
+ # If you have a single dataset project, specify `train`.
870
+ # @return [String]
871
+ #
872
+ # @!attribute [rw] labeled
873
+ # Specify `true` to include labeled entries, otherwise specify
874
+ # `false`. If you don't specify a value, Lookout for Vision returns
875
+ # all entries.
876
+ # @return [Boolean]
877
+ #
878
+ # @!attribute [rw] anomaly_class
879
+ # Specify `normal` to include only normal images. Specify `anomaly` to
880
+ # only include anomalous entries. If you don't specify a value,
881
+ # Amazon Lookout for Vision returns normal and anomalous images.
882
+ # @return [String]
883
+ #
884
+ # @!attribute [rw] before_creation_date
885
+ # Only includes entries before the specified date in the response. For
886
+ # example, `2020-06-23T00:00:00`.
887
+ # @return [Time]
888
+ #
889
+ # @!attribute [rw] after_creation_date
890
+ # Only includes entries after the specified date in the response. For
891
+ # example, `2020-06-23T00:00:00`.
892
+ # @return [Time]
893
+ #
894
+ # @!attribute [rw] next_token
895
+ # If the previous response was incomplete (because there is more data
896
+ # to retrieve), Amazon Lookout for Vision returns a pagination token
897
+ # in the response. You can use this pagination token to retrieve the
898
+ # next set of dataset entries.
899
+ # @return [String]
900
+ #
901
+ # @!attribute [rw] max_results
902
+ # The maximum number of results to return per paginated call. The
903
+ # largest value you can specify is 100. If you specify a value greater
904
+ # than 100, a ValidationException error occurs. The default value is
905
+ # 100.
906
+ # @return [Integer]
907
+ #
908
+ # @!attribute [rw] source_ref_contains
909
+ # Perform a "contains" search on the values of the `source-ref` key
910
+ # within the dataset. For example a value of "IMG\_17" returns all
911
+ # JSON Lines where the `source-ref` key value matches **IMG\_17**.
912
+ # @return [String]
913
+ #
914
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListDatasetEntriesRequest AWS API Documentation
915
+ #
916
+ class ListDatasetEntriesRequest < Struct.new(
917
+ :project_name,
918
+ :dataset_type,
919
+ :labeled,
920
+ :anomaly_class,
921
+ :before_creation_date,
922
+ :after_creation_date,
923
+ :next_token,
924
+ :max_results,
925
+ :source_ref_contains)
926
+ SENSITIVE = []
927
+ include Aws::Structure
928
+ end
929
+
930
+ # @!attribute [rw] dataset_entries
931
+ # A list of the entries (JSON Lines) within the dataset.
932
+ # @return [Array<String>]
933
+ #
934
+ # @!attribute [rw] next_token
935
+ # If the response is truncated, Amazon Lookout for Vision returns this
936
+ # token that you can use in the subsequent request to retrieve the
937
+ # next set ofdataset entries.
938
+ # @return [String]
939
+ #
940
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListDatasetEntriesResponse AWS API Documentation
941
+ #
942
+ class ListDatasetEntriesResponse < Struct.new(
943
+ :dataset_entries,
944
+ :next_token)
945
+ SENSITIVE = []
946
+ include Aws::Structure
947
+ end
948
+
949
+ # @note When making an API call, you may pass ListModelsRequest
950
+ # data as a hash:
951
+ #
952
+ # {
953
+ # project_name: "ProjectName", # required
954
+ # next_token: "PaginationToken",
955
+ # max_results: 1,
956
+ # }
957
+ #
958
+ # @!attribute [rw] project_name
959
+ # The name of the project that contains the model versions that you
960
+ # want to list.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] next_token
964
+ # If the previous response was incomplete (because there is more data
965
+ # to retrieve), Amazon Lookout for Vision returns a pagination token
966
+ # in the response. You can use this pagination token to retrieve the
967
+ # next set of models.
968
+ # @return [String]
969
+ #
970
+ # @!attribute [rw] max_results
971
+ # The maximum number of results to return per paginated call. The
972
+ # largest value you can specify is 100. If you specify a value greater
973
+ # than 100, a ValidationException error occurs. The default value is
974
+ # 100.
975
+ # @return [Integer]
976
+ #
977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListModelsRequest AWS API Documentation
978
+ #
979
+ class ListModelsRequest < Struct.new(
980
+ :project_name,
981
+ :next_token,
982
+ :max_results)
983
+ SENSITIVE = []
984
+ include Aws::Structure
985
+ end
986
+
987
+ # @!attribute [rw] models
988
+ # A list of model versions in the specified project.
989
+ # @return [Array<Types::ModelMetadata>]
990
+ #
991
+ # @!attribute [rw] next_token
992
+ # If the response is truncated, Amazon Lookout for Vision returns this
993
+ # token that you can use in the subsequent request to retrieve the
994
+ # next set of models.
995
+ # @return [String]
996
+ #
997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListModelsResponse AWS API Documentation
998
+ #
999
+ class ListModelsResponse < Struct.new(
1000
+ :models,
1001
+ :next_token)
1002
+ SENSITIVE = []
1003
+ include Aws::Structure
1004
+ end
1005
+
1006
+ # @note When making an API call, you may pass ListProjectsRequest
1007
+ # data as a hash:
1008
+ #
1009
+ # {
1010
+ # next_token: "PaginationToken",
1011
+ # max_results: 1,
1012
+ # }
1013
+ #
1014
+ # @!attribute [rw] next_token
1015
+ # If the previous response was incomplete (because there is more data
1016
+ # to retrieve), Amazon Lookout for Vision returns a pagination token
1017
+ # in the response. You can use this pagination token to retrieve the
1018
+ # next set of projects.
1019
+ # @return [String]
1020
+ #
1021
+ # @!attribute [rw] max_results
1022
+ # The maximum number of results to return per paginated call. The
1023
+ # largest value you can specify is 100. If you specify a value greater
1024
+ # than 100, a ValidationException error occurs. The default value is
1025
+ # 100.
1026
+ # @return [Integer]
1027
+ #
1028
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListProjectsRequest AWS API Documentation
1029
+ #
1030
+ class ListProjectsRequest < Struct.new(
1031
+ :next_token,
1032
+ :max_results)
1033
+ SENSITIVE = []
1034
+ include Aws::Structure
1035
+ end
1036
+
1037
+ # @!attribute [rw] projects
1038
+ # A list of projects in your AWS account.
1039
+ # @return [Array<Types::ProjectMetadata>]
1040
+ #
1041
+ # @!attribute [rw] next_token
1042
+ # If the response is truncated, Amazon Lookout for Vision returns this
1043
+ # token that you can use in the subsequent request to retrieve the
1044
+ # next set of projects.
1045
+ # @return [String]
1046
+ #
1047
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListProjectsResponse AWS API Documentation
1048
+ #
1049
+ class ListProjectsResponse < Struct.new(
1050
+ :projects,
1051
+ :next_token)
1052
+ SENSITIVE = []
1053
+ include Aws::Structure
1054
+ end
1055
+
1056
+ # Describes an Amazon Lookout for Vision model.
1057
+ #
1058
+ # @note When making an API call, you may pass ModelDescription
1059
+ # data as a hash:
1060
+ #
1061
+ # {
1062
+ # model_version: "ModelVersion",
1063
+ # model_arn: "ModelArn",
1064
+ # creation_timestamp: Time.now,
1065
+ # description: "ModelDescriptionMessage",
1066
+ # status: "TRAINING", # accepts TRAINING, TRAINED, TRAINING_FAILED, STARTING_HOSTING, HOSTED, HOSTING_FAILED, STOPPING_HOSTING, SYSTEM_UPDATING, DELETING
1067
+ # status_message: "ModelStatusMessage",
1068
+ # performance: {
1069
+ # f1_score: 1.0,
1070
+ # recall: 1.0,
1071
+ # precision: 1.0,
1072
+ # },
1073
+ # output_config: {
1074
+ # s3_location: { # required
1075
+ # bucket: "S3BucketName", # required
1076
+ # prefix: "S3KeyPrefix",
1077
+ # },
1078
+ # },
1079
+ # evaluation_manifest: {
1080
+ # bucket: "S3BucketName", # required
1081
+ # key: "S3ObjectKey", # required
1082
+ # },
1083
+ # evaluation_result: {
1084
+ # bucket: "S3BucketName", # required
1085
+ # key: "S3ObjectKey", # required
1086
+ # },
1087
+ # evaluation_end_timestamp: Time.now,
1088
+ # kms_key_id: "KmsKeyId",
1089
+ # }
1090
+ #
1091
+ # @!attribute [rw] model_version
1092
+ # The version of the model
1093
+ # @return [String]
1094
+ #
1095
+ # @!attribute [rw] model_arn
1096
+ # The Amazon Resource Name (ARN) of the model.
1097
+ # @return [String]
1098
+ #
1099
+ # @!attribute [rw] creation_timestamp
1100
+ # The unix timestamp for the date and time that the model was created.
1101
+ # @return [Time]
1102
+ #
1103
+ # @!attribute [rw] description
1104
+ # The description for the model.
1105
+ # @return [String]
1106
+ #
1107
+ # @!attribute [rw] status
1108
+ # The status of the model.
1109
+ # @return [String]
1110
+ #
1111
+ # @!attribute [rw] status_message
1112
+ # The status message for the model.
1113
+ # @return [String]
1114
+ #
1115
+ # @!attribute [rw] performance
1116
+ # Performance metrics for the model. Created during training.
1117
+ # @return [Types::ModelPerformance]
1118
+ #
1119
+ # @!attribute [rw] output_config
1120
+ # The S3 location where Amazon Lookout for Vision saves model training
1121
+ # files.
1122
+ # @return [Types::OutputConfig]
1123
+ #
1124
+ # @!attribute [rw] evaluation_manifest
1125
+ # The S3 location where Amazon Lookout for Vision saves the manifest
1126
+ # file that was used to test the trained model and generate the
1127
+ # performance scores.
1128
+ # @return [Types::OutputS3Object]
1129
+ #
1130
+ # @!attribute [rw] evaluation_result
1131
+ # The S3 location where Amazon Lookout for Vision saves the
1132
+ # performance metrics.
1133
+ # @return [Types::OutputS3Object]
1134
+ #
1135
+ # @!attribute [rw] evaluation_end_timestamp
1136
+ # The unix timestamp for the date and time that the evaluation ended.
1137
+ # @return [Time]
1138
+ #
1139
+ # @!attribute [rw] kms_key_id
1140
+ # The identifer for the AWS Key Management Service (AWS KMS) key that
1141
+ # was used to encrypt the model during training.
1142
+ # @return [String]
1143
+ #
1144
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ModelDescription AWS API Documentation
1145
+ #
1146
+ class ModelDescription < Struct.new(
1147
+ :model_version,
1148
+ :model_arn,
1149
+ :creation_timestamp,
1150
+ :description,
1151
+ :status,
1152
+ :status_message,
1153
+ :performance,
1154
+ :output_config,
1155
+ :evaluation_manifest,
1156
+ :evaluation_result,
1157
+ :evaluation_end_timestamp,
1158
+ :kms_key_id)
1159
+ SENSITIVE = []
1160
+ include Aws::Structure
1161
+ end
1162
+
1163
+ # Describes an Amazon Lookout for Vision model.
1164
+ #
1165
+ # @!attribute [rw] creation_timestamp
1166
+ # The unix timestamp for the date and time that the model was created.
1167
+ # @return [Time]
1168
+ #
1169
+ # @!attribute [rw] model_version
1170
+ # The version of the model.
1171
+ # @return [String]
1172
+ #
1173
+ # @!attribute [rw] model_arn
1174
+ # The Amazon Resource Name (ARN) of the model.
1175
+ # @return [String]
1176
+ #
1177
+ # @!attribute [rw] description
1178
+ # The description for the model.
1179
+ # @return [String]
1180
+ #
1181
+ # @!attribute [rw] status
1182
+ # The status of the model.
1183
+ # @return [String]
1184
+ #
1185
+ # @!attribute [rw] status_message
1186
+ # The status message for the model.
1187
+ # @return [String]
1188
+ #
1189
+ # @!attribute [rw] performance
1190
+ # Performance metrics for the model. Created during training.
1191
+ # @return [Types::ModelPerformance]
1192
+ #
1193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ModelMetadata AWS API Documentation
1194
+ #
1195
+ class ModelMetadata < Struct.new(
1196
+ :creation_timestamp,
1197
+ :model_version,
1198
+ :model_arn,
1199
+ :description,
1200
+ :status,
1201
+ :status_message,
1202
+ :performance)
1203
+ SENSITIVE = []
1204
+ include Aws::Structure
1205
+ end
1206
+
1207
+ # Information about the evaluation performance of a trained model.
1208
+ #
1209
+ # @note When making an API call, you may pass ModelPerformance
1210
+ # data as a hash:
1211
+ #
1212
+ # {
1213
+ # f1_score: 1.0,
1214
+ # recall: 1.0,
1215
+ # precision: 1.0,
1216
+ # }
1217
+ #
1218
+ # @!attribute [rw] f1_score
1219
+ # The overall F1 score metric for the trained model.
1220
+ # @return [Float]
1221
+ #
1222
+ # @!attribute [rw] recall
1223
+ # The overall recall metric value for the trained model.
1224
+ # @return [Float]
1225
+ #
1226
+ # @!attribute [rw] precision
1227
+ # The overall precision metric value for the trained model.
1228
+ # @return [Float]
1229
+ #
1230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ModelPerformance AWS API Documentation
1231
+ #
1232
+ class ModelPerformance < Struct.new(
1233
+ :f1_score,
1234
+ :recall,
1235
+ :precision)
1236
+ SENSITIVE = []
1237
+ include Aws::Structure
1238
+ end
1239
+
1240
+ # The S3 location where Amazon Lookout for Vision saves model training
1241
+ # files.
1242
+ #
1243
+ # @note When making an API call, you may pass OutputConfig
1244
+ # data as a hash:
1245
+ #
1246
+ # {
1247
+ # s3_location: { # required
1248
+ # bucket: "S3BucketName", # required
1249
+ # prefix: "S3KeyPrefix",
1250
+ # },
1251
+ # }
1252
+ #
1253
+ # @!attribute [rw] s3_location
1254
+ # The S3 location for the output.
1255
+ # @return [Types::S3Location]
1256
+ #
1257
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/OutputConfig AWS API Documentation
1258
+ #
1259
+ class OutputConfig < Struct.new(
1260
+ :s3_location)
1261
+ SENSITIVE = []
1262
+ include Aws::Structure
1263
+ end
1264
+
1265
+ # The S3 location where Amazon Lookout for Vision saves training output.
1266
+ #
1267
+ # @note When making an API call, you may pass OutputS3Object
1268
+ # data as a hash:
1269
+ #
1270
+ # {
1271
+ # bucket: "S3BucketName", # required
1272
+ # key: "S3ObjectKey", # required
1273
+ # }
1274
+ #
1275
+ # @!attribute [rw] bucket
1276
+ # The bucket that contains the training output.
1277
+ # @return [String]
1278
+ #
1279
+ # @!attribute [rw] key
1280
+ # The location of the training output in the bucket.
1281
+ # @return [String]
1282
+ #
1283
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/OutputS3Object AWS API Documentation
1284
+ #
1285
+ class OutputS3Object < Struct.new(
1286
+ :bucket,
1287
+ :key)
1288
+ SENSITIVE = []
1289
+ include Aws::Structure
1290
+ end
1291
+
1292
+ # Describe an Amazon Lookout for Vision project. For more information,
1293
+ # see DescribeProject.
1294
+ #
1295
+ # @!attribute [rw] project_arn
1296
+ # The Amazon Resource Name (ARN) of the project.
1297
+ # @return [String]
1298
+ #
1299
+ # @!attribute [rw] project_name
1300
+ # The name of the project.
1301
+ # @return [String]
1302
+ #
1303
+ # @!attribute [rw] creation_timestamp
1304
+ # The unix timestamp for the date and time that the project was
1305
+ # created.
1306
+ # @return [Time]
1307
+ #
1308
+ # @!attribute [rw] datasets
1309
+ # A list of datasets in the project.
1310
+ # @return [Array<Types::DatasetMetadata>]
1311
+ #
1312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ProjectDescription AWS API Documentation
1313
+ #
1314
+ class ProjectDescription < Struct.new(
1315
+ :project_arn,
1316
+ :project_name,
1317
+ :creation_timestamp,
1318
+ :datasets)
1319
+ SENSITIVE = []
1320
+ include Aws::Structure
1321
+ end
1322
+
1323
+ # Metadata about an Amazon Lookout for Vision project.
1324
+ #
1325
+ # @!attribute [rw] project_arn
1326
+ # The Amazon Resource Name (ARN) of the project.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] project_name
1330
+ # The name of the project.
1331
+ # @return [String]
1332
+ #
1333
+ # @!attribute [rw] creation_timestamp
1334
+ # The unix timestamp for the date and time that the project was
1335
+ # created.
1336
+ # @return [Time]
1337
+ #
1338
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ProjectMetadata AWS API Documentation
1339
+ #
1340
+ class ProjectMetadata < Struct.new(
1341
+ :project_arn,
1342
+ :project_name,
1343
+ :creation_timestamp)
1344
+ SENSITIVE = []
1345
+ include Aws::Structure
1346
+ end
1347
+
1348
+ # The resource could not be found.
1349
+ #
1350
+ # @!attribute [rw] message
1351
+ # @return [String]
1352
+ #
1353
+ # @!attribute [rw] resource_id
1354
+ # The ID of the resource.
1355
+ # @return [String]
1356
+ #
1357
+ # @!attribute [rw] resource_type
1358
+ # The type of the resource.
1359
+ # @return [String]
1360
+ #
1361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ResourceNotFoundException AWS API Documentation
1362
+ #
1363
+ class ResourceNotFoundException < Struct.new(
1364
+ :message,
1365
+ :resource_id,
1366
+ :resource_type)
1367
+ SENSITIVE = []
1368
+ include Aws::Structure
1369
+ end
1370
+
1371
+ # Information about the location of a manifest file.
1372
+ #
1373
+ # @note When making an API call, you may pass S3Location
1374
+ # data as a hash:
1375
+ #
1376
+ # {
1377
+ # bucket: "S3BucketName", # required
1378
+ # prefix: "S3KeyPrefix",
1379
+ # }
1380
+ #
1381
+ # @!attribute [rw] bucket
1382
+ # The S3 bucket that contain the manifest file.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] prefix
1386
+ # The path and name of the manifest file with the S3 bucket.
1387
+ # @return [String]
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/S3Location AWS API Documentation
1390
+ #
1391
+ class S3Location < Struct.new(
1392
+ :bucket,
1393
+ :prefix)
1394
+ SENSITIVE = []
1395
+ include Aws::Structure
1396
+ end
1397
+
1398
+ # A service quota was exceeded the allowed limit. For more information,
1399
+ # see Limits in Amazon Lookout for Vision in the Amazon Lookout for
1400
+ # Vision Developer Guide.
1401
+ #
1402
+ # @!attribute [rw] message
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] resource_id
1406
+ # The ID of the resource.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] resource_type
1410
+ # The type of the resource.
1411
+ # @return [String]
1412
+ #
1413
+ # @!attribute [rw] quota_code
1414
+ # The quota code.
1415
+ # @return [String]
1416
+ #
1417
+ # @!attribute [rw] service_code
1418
+ # The service code.
1419
+ # @return [String]
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ServiceQuotaExceededException AWS API Documentation
1422
+ #
1423
+ class ServiceQuotaExceededException < Struct.new(
1424
+ :message,
1425
+ :resource_id,
1426
+ :resource_type,
1427
+ :quota_code,
1428
+ :service_code)
1429
+ SENSITIVE = []
1430
+ include Aws::Structure
1431
+ end
1432
+
1433
+ # @note When making an API call, you may pass StartModelRequest
1434
+ # data as a hash:
1435
+ #
1436
+ # {
1437
+ # project_name: "ProjectName", # required
1438
+ # model_version: "ModelVersion", # required
1439
+ # min_inference_units: 1, # required
1440
+ # client_token: "ClientToken",
1441
+ # }
1442
+ #
1443
+ # @!attribute [rw] project_name
1444
+ # The name of the project that contains the model that you want to
1445
+ # start.
1446
+ # @return [String]
1447
+ #
1448
+ # @!attribute [rw] model_version
1449
+ # The version of the model that you want to start.
1450
+ # @return [String]
1451
+ #
1452
+ # @!attribute [rw] min_inference_units
1453
+ # The minimum number of inference units to use. A single inference
1454
+ # unit represents 1 hour of processing and can support up to 5
1455
+ # Transaction Pers Second (TPS). Use a higher number to increase the
1456
+ # TPS throughput of your model. You are charged for the number of
1457
+ # inference units that you use.
1458
+ # @return [Integer]
1459
+ #
1460
+ # @!attribute [rw] client_token
1461
+ # ClientToken is an idempotency token that ensures a call to
1462
+ # `StartModel` completes only once. You choose the value to pass. For
1463
+ # example, An issue, such as an network outage, might prevent you from
1464
+ # getting a response from `StartModel`. In this case, safely retry
1465
+ # your call to `StartModel` by using the same `ClientToken` parameter
1466
+ # value. An error occurs if the other input parameters are not the
1467
+ # same as in the first request. Using a different value for
1468
+ # `ClientToken` is considered a new call to `StartModel`. An
1469
+ # idempotency token is active for 8 hours.
1470
+ #
1471
+ # **A suitable default value is auto-generated.** You should normally
1472
+ # not need to pass this option.
1473
+ # @return [String]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StartModelRequest AWS API Documentation
1476
+ #
1477
+ class StartModelRequest < Struct.new(
1478
+ :project_name,
1479
+ :model_version,
1480
+ :min_inference_units,
1481
+ :client_token)
1482
+ SENSITIVE = []
1483
+ include Aws::Structure
1484
+ end
1485
+
1486
+ # @!attribute [rw] status
1487
+ # The current running status of the model.
1488
+ # @return [String]
1489
+ #
1490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StartModelResponse AWS API Documentation
1491
+ #
1492
+ class StartModelResponse < Struct.new(
1493
+ :status)
1494
+ SENSITIVE = []
1495
+ include Aws::Structure
1496
+ end
1497
+
1498
+ # @note When making an API call, you may pass StopModelRequest
1499
+ # data as a hash:
1500
+ #
1501
+ # {
1502
+ # project_name: "ProjectName", # required
1503
+ # model_version: "ModelVersion", # required
1504
+ # client_token: "ClientToken",
1505
+ # }
1506
+ #
1507
+ # @!attribute [rw] project_name
1508
+ # The name of the project that contains the model that you want to
1509
+ # stop.
1510
+ # @return [String]
1511
+ #
1512
+ # @!attribute [rw] model_version
1513
+ # The version of the model that you want to stop.
1514
+ # @return [String]
1515
+ #
1516
+ # @!attribute [rw] client_token
1517
+ # ClientToken is an idempotency token that ensures a call to
1518
+ # `StopModel` completes only once. You choose the value to pass. For
1519
+ # example, An issue, such as an network outage, might prevent you from
1520
+ # getting a response from `StopModel`. In this case, safely retry your
1521
+ # call to `StopModel` by using the same `ClientToken` parameter value.
1522
+ # An error occurs if the other input parameters are not the same as in
1523
+ # the first request. Using a different value for `ClientToken` is
1524
+ # considered a new call to `StopModel`. An idempotency token is active
1525
+ # for 8 hours.
1526
+ #
1527
+ # **A suitable default value is auto-generated.** You should normally
1528
+ # not need to pass this option.
1529
+ # @return [String]
1530
+ #
1531
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StopModelRequest AWS API Documentation
1532
+ #
1533
+ class StopModelRequest < Struct.new(
1534
+ :project_name,
1535
+ :model_version,
1536
+ :client_token)
1537
+ SENSITIVE = []
1538
+ include Aws::Structure
1539
+ end
1540
+
1541
+ # @!attribute [rw] status
1542
+ # The status of the model.
1543
+ # @return [String]
1544
+ #
1545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StopModelResponse AWS API Documentation
1546
+ #
1547
+ class StopModelResponse < Struct.new(
1548
+ :status)
1549
+ SENSITIVE = []
1550
+ include Aws::Structure
1551
+ end
1552
+
1553
+ # Amazon Lookout for Vision is temporarily unable to process the
1554
+ # request. Try your call again.
1555
+ #
1556
+ # @!attribute [rw] message
1557
+ # @return [String]
1558
+ #
1559
+ # @!attribute [rw] quota_code
1560
+ # The quota code.
1561
+ # @return [String]
1562
+ #
1563
+ # @!attribute [rw] service_code
1564
+ # The service code.
1565
+ # @return [String]
1566
+ #
1567
+ # @!attribute [rw] retry_after_seconds
1568
+ # The period of time, in seconds, before the operation can be retried.
1569
+ # @return [Integer]
1570
+ #
1571
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ThrottlingException AWS API Documentation
1572
+ #
1573
+ class ThrottlingException < Struct.new(
1574
+ :message,
1575
+ :quota_code,
1576
+ :service_code,
1577
+ :retry_after_seconds)
1578
+ SENSITIVE = []
1579
+ include Aws::Structure
1580
+ end
1581
+
1582
+ # @note When making an API call, you may pass UpdateDatasetEntriesRequest
1583
+ # data as a hash:
1584
+ #
1585
+ # {
1586
+ # project_name: "ProjectName", # required
1587
+ # dataset_type: "DatasetType", # required
1588
+ # changes: "data", # required
1589
+ # client_token: "ClientToken",
1590
+ # }
1591
+ #
1592
+ # @!attribute [rw] project_name
1593
+ # The name of the project that contains the dataset that you want to
1594
+ # update.
1595
+ # @return [String]
1596
+ #
1597
+ # @!attribute [rw] dataset_type
1598
+ # The type of the dataset that you want to update. Specify `train` to
1599
+ # update the training dataset. Specify `test` to update the test
1600
+ # dataset. If you have a single dataset project, specify `train`.
1601
+ # @return [String]
1602
+ #
1603
+ # @!attribute [rw] changes
1604
+ # The entries to add to the dataset.
1605
+ # @return [String]
1606
+ #
1607
+ # @!attribute [rw] client_token
1608
+ # ClientToken is an idempotency token that ensures a call to
1609
+ # `UpdateDatasetEntries` completes only once. You choose the value to
1610
+ # pass. For example, An issue, such as an network outage, might
1611
+ # prevent you from getting a response from `UpdateDatasetEntries`. In
1612
+ # this case, safely retry your call to `UpdateDatasetEntries` by using
1613
+ # the same `ClientToken` parameter value. An error occurs if the other
1614
+ # input parameters are not the same as in the first request. Using a
1615
+ # different value for `ClientToken` is considered a new call to
1616
+ # `UpdateDatasetEntries`. An idempotency token is active for 8 hours.
1617
+ #
1618
+ # **A suitable default value is auto-generated.** You should normally
1619
+ # not need to pass this option.
1620
+ # @return [String]
1621
+ #
1622
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/UpdateDatasetEntriesRequest AWS API Documentation
1623
+ #
1624
+ class UpdateDatasetEntriesRequest < Struct.new(
1625
+ :project_name,
1626
+ :dataset_type,
1627
+ :changes,
1628
+ :client_token)
1629
+ SENSITIVE = []
1630
+ include Aws::Structure
1631
+ end
1632
+
1633
+ # @!attribute [rw] status
1634
+ # The status of the dataset update.
1635
+ # @return [String]
1636
+ #
1637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/UpdateDatasetEntriesResponse AWS API Documentation
1638
+ #
1639
+ class UpdateDatasetEntriesResponse < Struct.new(
1640
+ :status)
1641
+ SENSITIVE = []
1642
+ include Aws::Structure
1643
+ end
1644
+
1645
+ # An input validation error occured. For example, invalid characters in
1646
+ # a project name, or if a pagination token is invalid.
1647
+ #
1648
+ # @!attribute [rw] message
1649
+ # @return [String]
1650
+ #
1651
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ValidationException AWS API Documentation
1652
+ #
1653
+ class ValidationException < Struct.new(
1654
+ :message)
1655
+ SENSITIVE = []
1656
+ include Aws::Structure
1657
+ end
1658
+
1659
+ end
1660
+ end