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,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: a0c49923ba352472a17e7536a61240037c3893da3c418af3af51905f1214f6a0
4
+ data.tar.gz: e4239f9cfe4c08afb9c2ff5a6b35af37cc9f08d7181a79b612907cca88b178c9
5
+ SHA512:
6
+ metadata.gz: 1b9cb8f0316f58142a7b90c281065152a88a9f31934d898848de0f216688a422b196bcda0259cc20eb64dc6c262fd68635c829e6f0b0af4863fac361b93265e8
7
+ data.tar.gz: 7beb2389eea0b34befe5862ee765270fc427f0e259f8b2d6317605b80dfac5f0b74a86ff898b714722d78328317f3a8393ff8fec751ecce759777a3193603e62
@@ -0,0 +1,53 @@
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
+
11
+ require 'aws-sdk-core'
12
+ require 'aws-sigv4'
13
+
14
+ require_relative 'aws-sdk-lookoutforvision/types'
15
+ require_relative 'aws-sdk-lookoutforvision/client_api'
16
+ require_relative 'aws-sdk-lookoutforvision/client'
17
+ require_relative 'aws-sdk-lookoutforvision/errors'
18
+ require_relative 'aws-sdk-lookoutforvision/resource'
19
+ require_relative 'aws-sdk-lookoutforvision/customizations'
20
+
21
+ # This module provides support for Amazon Lookout for Vision. This module is available in the
22
+ # `aws-sdk-lookoutforvision` gem.
23
+ #
24
+ # # Client
25
+ #
26
+ # The {Client} class provides one method for each API operation. Operation
27
+ # methods each accept a hash of request parameters and return a response
28
+ # structure.
29
+ #
30
+ # lookoutfor_vision = Aws::LookoutforVision::Client.new
31
+ # resp = lookoutfor_vision.create_dataset(params)
32
+ #
33
+ # See {Client} for more information.
34
+ #
35
+ # # Errors
36
+ #
37
+ # Errors returned from Amazon Lookout for Vision are defined in the
38
+ # {Errors} module and all extend {Errors::ServiceError}.
39
+ #
40
+ # begin
41
+ # # do stuff
42
+ # rescue Aws::LookoutforVision::Errors::ServiceError
43
+ # # rescues all Amazon Lookout for Vision API errors
44
+ # end
45
+ #
46
+ # See {Errors} for more information.
47
+ #
48
+ # @!group service
49
+ module Aws::LookoutforVision
50
+
51
+ GEM_VERSION = '1.0.0'
52
+
53
+ end
@@ -0,0 +1,1311 @@
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
+ require 'seahorse/client/plugins/content_length.rb'
11
+ require 'aws-sdk-core/plugins/credentials_configuration.rb'
12
+ require 'aws-sdk-core/plugins/logging.rb'
13
+ require 'aws-sdk-core/plugins/param_converter.rb'
14
+ require 'aws-sdk-core/plugins/param_validator.rb'
15
+ require 'aws-sdk-core/plugins/user_agent.rb'
16
+ require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
17
+ require 'aws-sdk-core/plugins/retry_errors.rb'
18
+ require 'aws-sdk-core/plugins/global_configuration.rb'
19
+ require 'aws-sdk-core/plugins/regional_endpoint.rb'
20
+ require 'aws-sdk-core/plugins/endpoint_discovery.rb'
21
+ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
+ require 'aws-sdk-core/plugins/response_paging.rb'
23
+ require 'aws-sdk-core/plugins/stub_responses.rb'
24
+ require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
+ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
+ require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
28
+ require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
30
+ require 'aws-sdk-core/plugins/signature_v4.rb'
31
+ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
32
+
33
+ Aws::Plugins::GlobalConfiguration.add_identifier(:lookoutforvision)
34
+
35
+ module Aws::LookoutforVision
36
+ # An API client for LookoutforVision. To construct a client, you need to configure a `:region` and `:credentials`.
37
+ #
38
+ # client = Aws::LookoutforVision::Client.new(
39
+ # region: region_name,
40
+ # credentials: credentials,
41
+ # # ...
42
+ # )
43
+ #
44
+ # For details on configuring region and credentials see
45
+ # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
46
+ #
47
+ # See {#initialize} for a full list of supported configuration options.
48
+ class Client < Seahorse::Client::Base
49
+
50
+ include Aws::ClientStubs
51
+
52
+ @identifier = :lookoutforvision
53
+
54
+ set_api(ClientApi::API)
55
+
56
+ add_plugin(Seahorse::Client::Plugins::ContentLength)
57
+ add_plugin(Aws::Plugins::CredentialsConfiguration)
58
+ add_plugin(Aws::Plugins::Logging)
59
+ add_plugin(Aws::Plugins::ParamConverter)
60
+ add_plugin(Aws::Plugins::ParamValidator)
61
+ add_plugin(Aws::Plugins::UserAgent)
62
+ add_plugin(Aws::Plugins::HelpfulSocketErrors)
63
+ add_plugin(Aws::Plugins::RetryErrors)
64
+ add_plugin(Aws::Plugins::GlobalConfiguration)
65
+ add_plugin(Aws::Plugins::RegionalEndpoint)
66
+ add_plugin(Aws::Plugins::EndpointDiscovery)
67
+ add_plugin(Aws::Plugins::EndpointPattern)
68
+ add_plugin(Aws::Plugins::ResponsePaging)
69
+ add_plugin(Aws::Plugins::StubResponses)
70
+ add_plugin(Aws::Plugins::IdempotencyToken)
71
+ add_plugin(Aws::Plugins::JsonvalueConverter)
72
+ add_plugin(Aws::Plugins::ClientMetricsPlugin)
73
+ add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
74
+ add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
76
+ add_plugin(Aws::Plugins::SignatureV4)
77
+ add_plugin(Aws::Plugins::Protocols::RestJson)
78
+
79
+ # @overload initialize(options)
80
+ # @param [Hash] options
81
+ # @option options [required, Aws::CredentialProvider] :credentials
82
+ # Your AWS credentials. This can be an instance of any one of the
83
+ # following classes:
84
+ #
85
+ # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
+ # credentials.
87
+ #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
102
+ # * `Aws::InstanceProfileCredentials` - Used for loading credentials
103
+ # from an EC2 IMDS on an EC2 instance.
104
+ #
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
107
+ #
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
110
+ #
111
+ # When `:credentials` are not configured directly, the following
112
+ # locations will be searched for credentials:
113
+ #
114
+ # * `Aws.config[:credentials]`
115
+ # * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
116
+ # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
117
+ # * `~/.aws/credentials`
118
+ # * `~/.aws/config`
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
123
+ #
124
+ # @option options [required, String] :region
125
+ # The AWS region to connect to. The configured `:region` is
126
+ # used to determine the service `:endpoint`. When not passed,
127
+ # a default `:region` is searched for in the following locations:
128
+ #
129
+ # * `Aws.config[:region]`
130
+ # * `ENV['AWS_REGION']`
131
+ # * `ENV['AMAZON_REGION']`
132
+ # * `ENV['AWS_DEFAULT_REGION']`
133
+ # * `~/.aws/credentials`
134
+ # * `~/.aws/config`
135
+ #
136
+ # @option options [String] :access_key_id
137
+ #
138
+ # @option options [Boolean] :active_endpoint_cache (false)
139
+ # When set to `true`, a thread polling for endpoints will be running in
140
+ # the background every 60 secs (default). Defaults to `false`.
141
+ #
142
+ # @option options [Boolean] :adaptive_retry_wait_to_fill (true)
143
+ # Used only in `adaptive` retry mode. When true, the request will sleep
144
+ # until there is sufficent client side capacity to retry the request.
145
+ # When false, the request will raise a `RetryCapacityNotAvailableError` and will
146
+ # not retry instead of sleeping.
147
+ #
148
+ # @option options [Boolean] :client_side_monitoring (false)
149
+ # When `true`, client-side metrics will be collected for all API requests from
150
+ # this client.
151
+ #
152
+ # @option options [String] :client_side_monitoring_client_id ("")
153
+ # Allows you to provide an identifier for this client which will be attached to
154
+ # all generated client side metrics. Defaults to an empty string.
155
+ #
156
+ # @option options [String] :client_side_monitoring_host ("127.0.0.1")
157
+ # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client
158
+ # side monitoring agent is running on, where client metrics will be published via UDP.
159
+ #
160
+ # @option options [Integer] :client_side_monitoring_port (31000)
161
+ # Required for publishing client metrics. The port that the client side monitoring
162
+ # agent is running on, where client metrics will be published via UDP.
163
+ #
164
+ # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
165
+ # Allows you to provide a custom client-side monitoring publisher class. By default,
166
+ # will use the Client Side Monitoring Agent Publisher.
167
+ #
168
+ # @option options [Boolean] :convert_params (true)
169
+ # When `true`, an attempt is made to coerce request parameters into
170
+ # the required types.
171
+ #
172
+ # @option options [Boolean] :correct_clock_skew (true)
173
+ # Used only in `standard` and adaptive retry modes. Specifies whether to apply
174
+ # a clock skew correction and retry requests with skewed client clocks.
175
+ #
176
+ # @option options [Boolean] :disable_host_prefix_injection (false)
177
+ # Set to true to disable SDK automatically adding host prefix
178
+ # to default service endpoint when available.
179
+ #
180
+ # @option options [String] :endpoint
181
+ # The client endpoint is normally constructed from the `:region`
182
+ # option. You should only configure an `:endpoint` when connecting
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
184
+ #
185
+ # @option options [Integer] :endpoint_cache_max_entries (1000)
186
+ # Used for the maximum size limit of the LRU cache storing endpoints data
187
+ # for endpoint discovery enabled operations. Defaults to 1000.
188
+ #
189
+ # @option options [Integer] :endpoint_cache_max_threads (10)
190
+ # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.
191
+ #
192
+ # @option options [Integer] :endpoint_cache_poll_interval (60)
193
+ # When :endpoint_discovery and :active_endpoint_cache is enabled,
194
+ # Use this option to config the time interval in seconds for making
195
+ # requests fetching endpoints information. Defaults to 60 sec.
196
+ #
197
+ # @option options [Boolean] :endpoint_discovery (false)
198
+ # When set to `true`, endpoint discovery will be enabled for operations when available.
199
+ #
200
+ # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
201
+ # The log formatter.
202
+ #
203
+ # @option options [Symbol] :log_level (:info)
204
+ # The log level to send messages to the `:logger` at.
205
+ #
206
+ # @option options [Logger] :logger
207
+ # The Logger instance to send log messages to. If this option
208
+ # is not set, logging will be disabled.
209
+ #
210
+ # @option options [Integer] :max_attempts (3)
211
+ # An integer representing the maximum number attempts that will be made for
212
+ # a single request, including the initial attempt. For example,
213
+ # setting this value to 5 will result in a request being retried up to
214
+ # 4 times. Used in `standard` and `adaptive` retry modes.
215
+ #
216
+ # @option options [String] :profile ("default")
217
+ # Used when loading credentials from the shared credentials file
218
+ # at HOME/.aws/credentials. When not specified, 'default' is used.
219
+ #
220
+ # @option options [Proc] :retry_backoff
221
+ # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
222
+ # This option is only used in the `legacy` retry mode.
223
+ #
224
+ # @option options [Float] :retry_base_delay (0.3)
225
+ # The base delay in seconds used by the default backoff function. This option
226
+ # is only used in the `legacy` retry mode.
227
+ #
228
+ # @option options [Symbol] :retry_jitter (:none)
229
+ # A delay randomiser function used by the default backoff function.
230
+ # Some predefined functions can be referenced by name - :none, :equal, :full,
231
+ # otherwise a Proc that takes and returns a number. This option is only used
232
+ # in the `legacy` retry mode.
233
+ #
234
+ # @see https://www.awsarchitectureblog.com/2015/03/backoff.html
235
+ #
236
+ # @option options [Integer] :retry_limit (3)
237
+ # The maximum number of times to retry failed requests. Only
238
+ # ~ 500 level server errors and certain ~ 400 level client errors
239
+ # are retried. Generally, these are throttling errors, data
240
+ # checksum errors, networking errors, timeout errors, auth errors,
241
+ # endpoint discovery, and errors from expired credentials.
242
+ # This option is only used in the `legacy` retry mode.
243
+ #
244
+ # @option options [Integer] :retry_max_delay (0)
245
+ # The maximum number of seconds to delay between retries (0 for no limit)
246
+ # used by the default backoff function. This option is only used in the
247
+ # `legacy` retry mode.
248
+ #
249
+ # @option options [String] :retry_mode ("legacy")
250
+ # Specifies which retry algorithm to use. Values are:
251
+ #
252
+ # * `legacy` - The pre-existing retry behavior. This is default value if
253
+ # no retry mode is provided.
254
+ #
255
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
256
+ # This includes support for retry quotas, which limit the number of
257
+ # unsuccessful retries a client can make.
258
+ #
259
+ # * `adaptive` - An experimental retry mode that includes all the
260
+ # functionality of `standard` mode along with automatic client side
261
+ # throttling. This is a provisional mode that may change behavior
262
+ # in the future.
263
+ #
264
+ #
265
+ # @option options [String] :secret_access_key
266
+ #
267
+ # @option options [String] :session_token
268
+ #
269
+ # @option options [Boolean] :stub_responses (false)
270
+ # Causes the client to return stubbed responses. By default
271
+ # fake responses are generated and returned. You can specify
272
+ # the response data to return or errors to raise by calling
273
+ # {ClientStubs#stub_responses}. See {ClientStubs} for more information.
274
+ #
275
+ # ** Please note ** When response stubbing is enabled, no HTTP
276
+ # requests are made, and retries are disabled.
277
+ #
278
+ # @option options [Boolean] :validate_params (true)
279
+ # When `true`, request parameters are validated before
280
+ # sending the request.
281
+ #
282
+ # @option options [URI::HTTP,String] :http_proxy A proxy to send
283
+ # requests through. Formatted like 'http://proxy.com:123'.
284
+ #
285
+ # @option options [Float] :http_open_timeout (15) The number of
286
+ # seconds to wait when opening a HTTP session before raising a
287
+ # `Timeout::Error`.
288
+ #
289
+ # @option options [Integer] :http_read_timeout (60) The default
290
+ # number of seconds to wait for response data. This value can
291
+ # safely be set per-request on the session.
292
+ #
293
+ # @option options [Float] :http_idle_timeout (5) The number of
294
+ # seconds a connection is allowed to sit idle before it is
295
+ # considered stale. Stale connections are closed and removed
296
+ # from the pool before making a request.
297
+ #
298
+ # @option options [Float] :http_continue_timeout (1) The number of
299
+ # seconds to wait for a 100-continue response before sending the
300
+ # request body. This option has no effect unless the request has
301
+ # "Expect" header set to "100-continue". Defaults to `nil` which
302
+ # disables this behaviour. This value can safely be set per
303
+ # request on the session.
304
+ #
305
+ # @option options [Boolean] :http_wire_trace (false) When `true`,
306
+ # HTTP debug output will be sent to the `:logger`.
307
+ #
308
+ # @option options [Boolean] :ssl_verify_peer (true) When `true`,
309
+ # SSL peer certificates are verified when establishing a
310
+ # connection.
311
+ #
312
+ # @option options [String] :ssl_ca_bundle Full path to the SSL
313
+ # certificate authority bundle file that should be used when
314
+ # verifying peer certificates. If you do not pass
315
+ # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
316
+ # will be used if available.
317
+ #
318
+ # @option options [String] :ssl_ca_directory Full path of the
319
+ # directory that contains the unbundled SSL certificate
320
+ # authority files for verifying peer certificates. If you do
321
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
322
+ # system default will be used if available.
323
+ #
324
+ def initialize(*args)
325
+ super
326
+ end
327
+
328
+ # @!group API Operations
329
+
330
+ # Creates a new dataset in an Amazon Lookout for Vision project.
331
+ # `CreateDataset` can create a training or a test dataset from a valid
332
+ # dataset source (`DatasetSource`).
333
+ #
334
+ # If you want a single dataset project, specify `train` for the value of
335
+ # `DatasetType`.
336
+ #
337
+ # To have a project with separate training and test datasets, call
338
+ # `CreateDataset` twice. On the first call, specify `train` for the
339
+ # value of `DatasetType`. On the second call, specify `test` for the
340
+ # value of `DatasetType`. of dataset with
341
+ #
342
+ # @option params [required, String] :project_name
343
+ # The name of the project in which you want to create a dataset.
344
+ #
345
+ # @option params [required, String] :dataset_type
346
+ # The type of the dataset. Specify `train` for a training dataset.
347
+ # Specify `test` for a test dataset.
348
+ #
349
+ # @option params [Types::DatasetSource] :dataset_source
350
+ # The location of the manifest file that Amazon Lookout for Vision uses
351
+ # to create the dataset.
352
+ #
353
+ # If you don't specify `DatasetSource`, an empty dataset is created and
354
+ # the operation synchronously returns. Later, you can add JSON Lines by
355
+ # calling UpdateDatasetEntries.
356
+ #
357
+ # If you specify a value for `DataSource`, the manifest at the S3
358
+ # location is validated and used to create the dataset. The call to
359
+ # `CreateDataset` is asynchronous and might take a while to complete. To
360
+ # find out the current status, Check the value of `Status` returned in a
361
+ # call to DescribeDataset.
362
+ #
363
+ # @option params [String] :client_token
364
+ # ClientToken is an idempotency token that ensures a call to
365
+ # `CreateDataset` completes only once. You choose the value to pass. For
366
+ # example, An issue, such as an network outage, might prevent you from
367
+ # getting a response from `CreateDataset`. In this case, safely retry
368
+ # your call to `CreateDataset` by using the same `ClientToken` parameter
369
+ # value. An error occurs if the other input parameters are not the same
370
+ # as in the first request. Using a different value for `ClientToken` is
371
+ # considered a new call to `CreateDataset`. An idempotency token is
372
+ # active for 8 hours.
373
+ #
374
+ # **A suitable default value is auto-generated.** You should normally
375
+ # not need to pass this option.**
376
+ #
377
+ # @return [Types::CreateDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
378
+ #
379
+ # * {Types::CreateDatasetResponse#dataset_metadata #dataset_metadata} => Types::DatasetMetadata
380
+ #
381
+ # @example Request syntax with placeholder values
382
+ #
383
+ # resp = client.create_dataset({
384
+ # project_name: "ProjectName", # required
385
+ # dataset_type: "DatasetType", # required
386
+ # dataset_source: {
387
+ # ground_truth_manifest: {
388
+ # s3_object: {
389
+ # bucket: "S3BucketName", # required
390
+ # key: "S3ObjectKey", # required
391
+ # version_id: "S3ObjectVersion",
392
+ # },
393
+ # },
394
+ # },
395
+ # client_token: "ClientToken",
396
+ # })
397
+ #
398
+ # @example Response structure
399
+ #
400
+ # resp.dataset_metadata.dataset_type #=> String
401
+ # resp.dataset_metadata.creation_timestamp #=> Time
402
+ # resp.dataset_metadata.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", "UPDATE_FAILED_ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
403
+ # resp.dataset_metadata.status_message #=> String
404
+ #
405
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateDataset AWS API Documentation
406
+ #
407
+ # @overload create_dataset(params = {})
408
+ # @param [Hash] params ({})
409
+ def create_dataset(params = {}, options = {})
410
+ req = build_request(:create_dataset, params)
411
+ req.send_request(options)
412
+ end
413
+
414
+ # Creates a new version of a model within an an Amazon Lookout for
415
+ # Vision project. `CreateModel` is an asynchronous operation in which
416
+ # Amazon Lookout for Vision trains, tests, and evaluates a new version
417
+ # of a model.
418
+ #
419
+ # To get the current status, check the `Status` field returned in the
420
+ # response from DescribeModel.
421
+ #
422
+ # If the project has a single dataset, Amazon Lookout for Vision
423
+ # internally splits the dataset to create a training and a test dataset.
424
+ # If the project has a training and a test dataset, Lookout for Vision
425
+ # uses the respective datasets to train and test the model.
426
+ #
427
+ # After training completes, the evaluation metrics are stored at the
428
+ # location specified in `OutputConfig`.
429
+ #
430
+ # @option params [required, String] :project_name
431
+ # The name of the project in which you want to create a model version.
432
+ #
433
+ # @option params [Types::ModelDescription] :description
434
+ # A description for the version of the model.
435
+ #
436
+ # @option params [String] :client_token
437
+ # ClientToken is an idempotency token that ensures a call to
438
+ # `CreateModel` completes only once. You choose the value to pass. For
439
+ # example, An issue, such as an network outage, might prevent you from
440
+ # getting a response from `CreateModel`. In this case, safely retry your
441
+ # call to `CreateModel` by using the same `ClientToken` parameter value.
442
+ # An error occurs if the other input parameters are not the same as in
443
+ # the first request. Using a different value for `ClientToken` is
444
+ # considered a new call to `CreateModel`. An idempotency token is active
445
+ # for 8 hours.
446
+ #
447
+ # **A suitable default value is auto-generated.** You should normally
448
+ # not need to pass this option.**
449
+ #
450
+ # @option params [required, Types::OutputConfig] :output_config
451
+ # The location where Amazon Lookout for Vision saves the training
452
+ # results.
453
+ #
454
+ # @option params [String] :kms_key_id
455
+ # The identifier of the AWS Key Management Service (AWS KMS) customer
456
+ # master key (CMK) to use for encypting the model. If this parameter is
457
+ # not specified, the model is encrypted by a key that AWS owns and
458
+ # manages.
459
+ #
460
+ # @return [Types::CreateModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
461
+ #
462
+ # * {Types::CreateModelResponse#model_metadata #model_metadata} => Types::ModelMetadata
463
+ #
464
+ # @example Request syntax with placeholder values
465
+ #
466
+ # resp = client.create_model({
467
+ # project_name: "ProjectName", # required
468
+ # description: {
469
+ # model_version: "ModelVersion",
470
+ # model_arn: "ModelArn",
471
+ # creation_timestamp: Time.now,
472
+ # description: "ModelDescriptionMessage",
473
+ # status: "TRAINING", # accepts TRAINING, TRAINED, TRAINING_FAILED, STARTING_HOSTING, HOSTED, HOSTING_FAILED, STOPPING_HOSTING, SYSTEM_UPDATING, DELETING
474
+ # status_message: "ModelStatusMessage",
475
+ # performance: {
476
+ # f1_score: 1.0,
477
+ # recall: 1.0,
478
+ # precision: 1.0,
479
+ # },
480
+ # output_config: {
481
+ # s3_location: { # required
482
+ # bucket: "S3BucketName", # required
483
+ # prefix: "S3KeyPrefix",
484
+ # },
485
+ # },
486
+ # evaluation_manifest: {
487
+ # bucket: "S3BucketName", # required
488
+ # key: "S3ObjectKey", # required
489
+ # },
490
+ # evaluation_result: {
491
+ # bucket: "S3BucketName", # required
492
+ # key: "S3ObjectKey", # required
493
+ # },
494
+ # evaluation_end_timestamp: Time.now,
495
+ # kms_key_id: "KmsKeyId",
496
+ # },
497
+ # client_token: "ClientToken",
498
+ # output_config: { # required
499
+ # s3_location: { # required
500
+ # bucket: "S3BucketName", # required
501
+ # prefix: "S3KeyPrefix",
502
+ # },
503
+ # },
504
+ # kms_key_id: "KmsKeyId",
505
+ # })
506
+ #
507
+ # @example Response structure
508
+ #
509
+ # resp.model_metadata.creation_timestamp #=> Time
510
+ # resp.model_metadata.model_version #=> String
511
+ # resp.model_metadata.model_arn #=> String
512
+ # resp.model_metadata.description #=> String
513
+ # resp.model_metadata.status #=> String, one of "TRAINING", "TRAINED", "TRAINING_FAILED", "STARTING_HOSTING", "HOSTED", "HOSTING_FAILED", "STOPPING_HOSTING", "SYSTEM_UPDATING", "DELETING"
514
+ # resp.model_metadata.status_message #=> String
515
+ # resp.model_metadata.performance.f1_score #=> Float
516
+ # resp.model_metadata.performance.recall #=> Float
517
+ # resp.model_metadata.performance.precision #=> Float
518
+ #
519
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateModel AWS API Documentation
520
+ #
521
+ # @overload create_model(params = {})
522
+ # @param [Hash] params ({})
523
+ def create_model(params = {}, options = {})
524
+ req = build_request(:create_model, params)
525
+ req.send_request(options)
526
+ end
527
+
528
+ # Creates an empty Amazon Lookout for Vision project. After you create
529
+ # the project, add a dataset by calling CreateDataset.
530
+ #
531
+ # @option params [required, String] :project_name
532
+ # S nsme for the project.
533
+ #
534
+ # @option params [String] :client_token
535
+ # ClientToken is an idempotency token that ensures a call to
536
+ # `CreateProject` completes only once. You choose the value to pass. For
537
+ # example, An issue, such as an network outage, might prevent you from
538
+ # getting a response from `CreateProject`. In this case, safely retry
539
+ # your call to `CreateProject` by using the same `ClientToken` parameter
540
+ # value. An error occurs if the other input parameters are not the same
541
+ # as in the first request. Using a different value for `ClientToken` is
542
+ # considered a new call to `CreateProject`. An idempotency token is
543
+ # active for 8 hours.
544
+ #
545
+ # **A suitable default value is auto-generated.** You should normally
546
+ # not need to pass this option.**
547
+ #
548
+ # @return [Types::CreateProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
549
+ #
550
+ # * {Types::CreateProjectResponse#project_metadata #project_metadata} => Types::ProjectMetadata
551
+ #
552
+ # @example Request syntax with placeholder values
553
+ #
554
+ # resp = client.create_project({
555
+ # project_name: "ProjectName", # required
556
+ # client_token: "ClientToken",
557
+ # })
558
+ #
559
+ # @example Response structure
560
+ #
561
+ # resp.project_metadata.project_arn #=> String
562
+ # resp.project_metadata.project_name #=> String
563
+ # resp.project_metadata.creation_timestamp #=> Time
564
+ #
565
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/CreateProject AWS API Documentation
566
+ #
567
+ # @overload create_project(params = {})
568
+ # @param [Hash] params ({})
569
+ def create_project(params = {}, options = {})
570
+ req = build_request(:create_project, params)
571
+ req.send_request(options)
572
+ end
573
+
574
+ # Deletes an existing Amazon Lookout for Vision `dataset`.
575
+ #
576
+ # If your the project has a single dataset, you must create a new
577
+ # dataset before you can create a model.
578
+ #
579
+ # If you project has a training dataset and a test dataset consider the
580
+ # following.
581
+ #
582
+ # * If you delete the test dataset, your project reverts to a single
583
+ # dataset project. If you then train the model, Amazon Lookout for
584
+ # Vision internally splits the remaining dataset into a training and
585
+ # test dataset.
586
+ #
587
+ # * If you delete the training dataset, you must create a training
588
+ # dataset before you can create a model.
589
+ #
590
+ # It might take a while to delete the dataset. To check the current
591
+ # status, check the `Status` field in the response from a call to
592
+ # DescribeDataset.
593
+ #
594
+ # @option params [required, String] :project_name
595
+ # The name of the project that contains the dataset that you want to
596
+ # delete.
597
+ #
598
+ # @option params [required, String] :dataset_type
599
+ # The type of the dataset to delete. Specify `train` to delete the
600
+ # training dataset. Specify `test` to delete the test dataset. To delete
601
+ # the dataset in a single dataset project, specify `train`.
602
+ #
603
+ # @option params [String] :client_token
604
+ # ClientToken is an idempotency token that ensures a call to
605
+ # `DeleteDataset` completes only once. You choose the value to pass. For
606
+ # example, An issue, such as an network outage, might prevent you from
607
+ # getting a response from `DeleteDataset`. In this case, safely retry
608
+ # your call to `DeleteDataset` by using the same `ClientToken` parameter
609
+ # value. An error occurs if the other input parameters are not the same
610
+ # as in the first request. Using a different value for `ClientToken` is
611
+ # considered a new call to `DeleteDataset`. An idempotency token is
612
+ # active for 8 hours.
613
+ #
614
+ # **A suitable default value is auto-generated.** You should normally
615
+ # not need to pass this option.**
616
+ #
617
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
618
+ #
619
+ # @example Request syntax with placeholder values
620
+ #
621
+ # resp = client.delete_dataset({
622
+ # project_name: "ProjectName", # required
623
+ # dataset_type: "DatasetType", # required
624
+ # client_token: "ClientToken",
625
+ # })
626
+ #
627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteDataset AWS API Documentation
628
+ #
629
+ # @overload delete_dataset(params = {})
630
+ # @param [Hash] params ({})
631
+ def delete_dataset(params = {}, options = {})
632
+ req = build_request(:delete_dataset, params)
633
+ req.send_request(options)
634
+ end
635
+
636
+ # Deletes an Amazon Lookout for Vision model. You can't delete a
637
+ # running model. To stop a running model, use the StopModel operation.
638
+ #
639
+ # @option params [required, String] :project_name
640
+ # The name of the project that contains the model that you want to
641
+ # delete.
642
+ #
643
+ # @option params [required, String] :model_version
644
+ # The version of the model that you want to delete.
645
+ #
646
+ # @option params [String] :client_token
647
+ # ClientToken is an idempotency token that ensures a call to
648
+ # `DeleteModel` completes only once. You choose the value to pass. For
649
+ # example, An issue, such as an network outage, might prevent you from
650
+ # getting a response from `DeleteModel`. In this case, safely retry your
651
+ # call to `DeleteModel` by using the same `ClientToken` parameter value.
652
+ # An error occurs if the other input parameters are not the same as in
653
+ # the first request. Using a different value for `ClientToken` is
654
+ # considered a new call to `DeleteModel`. An idempotency token is active
655
+ # for 8 hours.
656
+ #
657
+ # **A suitable default value is auto-generated.** You should normally
658
+ # not need to pass this option.**
659
+ #
660
+ # @return [Types::DeleteModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
661
+ #
662
+ # * {Types::DeleteModelResponse#model_arn #model_arn} => String
663
+ #
664
+ # @example Request syntax with placeholder values
665
+ #
666
+ # resp = client.delete_model({
667
+ # project_name: "ProjectName", # required
668
+ # model_version: "ModelVersion", # required
669
+ # client_token: "ClientToken",
670
+ # })
671
+ #
672
+ # @example Response structure
673
+ #
674
+ # resp.model_arn #=> String
675
+ #
676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteModel AWS API Documentation
677
+ #
678
+ # @overload delete_model(params = {})
679
+ # @param [Hash] params ({})
680
+ def delete_model(params = {}, options = {})
681
+ req = build_request(:delete_model, params)
682
+ req.send_request(options)
683
+ end
684
+
685
+ # Deletes an Amazon Lookout for Vision project.
686
+ #
687
+ # To delete a project, you must first delete each version of the model
688
+ # associated with the project. To delete a model use the DeleteModel
689
+ # operation.
690
+ #
691
+ # The training and test datasets are deleted automatically for you. The
692
+ # images referenced by the training and test datasets aren't deleted.
693
+ #
694
+ # @option params [required, String] :project_name
695
+ # The name of the project to delete.
696
+ #
697
+ # @option params [String] :client_token
698
+ # ClientToken is an idempotency token that ensures a call to
699
+ # `DeleteProject` completes only once. You choose the value to pass. For
700
+ # example, An issue, such as an network outage, might prevent you from
701
+ # getting a response from `DeleteProject`. In this case, safely retry
702
+ # your call to `DeleteProject` by using the same `ClientToken` parameter
703
+ # value. An error occurs if the other input parameters are not the same
704
+ # as in the first request. Using a different value for `ClientToken` is
705
+ # considered a new call to `DeleteProject`. An idempotency token is
706
+ # active for 8 hours.
707
+ #
708
+ # **A suitable default value is auto-generated.** You should normally
709
+ # not need to pass this option.**
710
+ #
711
+ # @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
712
+ #
713
+ # * {Types::DeleteProjectResponse#project_arn #project_arn} => String
714
+ #
715
+ # @example Request syntax with placeholder values
716
+ #
717
+ # resp = client.delete_project({
718
+ # project_name: "ProjectName", # required
719
+ # client_token: "ClientToken",
720
+ # })
721
+ #
722
+ # @example Response structure
723
+ #
724
+ # resp.project_arn #=> String
725
+ #
726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DeleteProject AWS API Documentation
727
+ #
728
+ # @overload delete_project(params = {})
729
+ # @param [Hash] params ({})
730
+ def delete_project(params = {}, options = {})
731
+ req = build_request(:delete_project, params)
732
+ req.send_request(options)
733
+ end
734
+
735
+ # Describe an Amazon Lookout for Vision dataset.
736
+ #
737
+ # @option params [required, String] :project_name
738
+ # The name of the project that contains the dataset that you want to
739
+ # describe.
740
+ #
741
+ # @option params [required, String] :dataset_type
742
+ # The type of the dataset to describe. Specify `train` to describe the
743
+ # training dataset. Specify `test` to describe the test dataset. If you
744
+ # have a single dataset project, specify `train`
745
+ #
746
+ # @return [Types::DescribeDatasetResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
747
+ #
748
+ # * {Types::DescribeDatasetResponse#dataset_description #dataset_description} => Types::DatasetDescription
749
+ #
750
+ # @example Request syntax with placeholder values
751
+ #
752
+ # resp = client.describe_dataset({
753
+ # project_name: "ProjectName", # required
754
+ # dataset_type: "DatasetType", # required
755
+ # })
756
+ #
757
+ # @example Response structure
758
+ #
759
+ # resp.dataset_description.project_name #=> String
760
+ # resp.dataset_description.dataset_type #=> String
761
+ # resp.dataset_description.creation_timestamp #=> Time
762
+ # resp.dataset_description.last_updated_timestamp #=> Time
763
+ # resp.dataset_description.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", "UPDATE_FAILED_ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
764
+ # resp.dataset_description.status_message #=> String
765
+ # resp.dataset_description.image_stats.total #=> Integer
766
+ # resp.dataset_description.image_stats.labeled #=> Integer
767
+ # resp.dataset_description.image_stats.normal #=> Integer
768
+ # resp.dataset_description.image_stats.anomaly #=> Integer
769
+ #
770
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeDataset AWS API Documentation
771
+ #
772
+ # @overload describe_dataset(params = {})
773
+ # @param [Hash] params ({})
774
+ def describe_dataset(params = {}, options = {})
775
+ req = build_request(:describe_dataset, params)
776
+ req.send_request(options)
777
+ end
778
+
779
+ # Describes a version of an Amazon Lookout for Vision model.
780
+ #
781
+ # @option params [required, String] :project_name
782
+ # The project that contains the version of a model that you want to
783
+ # describe.
784
+ #
785
+ # @option params [required, String] :model_version
786
+ # The version of the model that you want to describe.
787
+ #
788
+ # @return [Types::DescribeModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
789
+ #
790
+ # * {Types::DescribeModelResponse#model_description #model_description} => Types::ModelDescription
791
+ #
792
+ # @example Request syntax with placeholder values
793
+ #
794
+ # resp = client.describe_model({
795
+ # project_name: "ProjectName", # required
796
+ # model_version: "ModelVersion", # required
797
+ # })
798
+ #
799
+ # @example Response structure
800
+ #
801
+ # resp.model_description.model_version #=> String
802
+ # resp.model_description.model_arn #=> String
803
+ # resp.model_description.creation_timestamp #=> Time
804
+ # resp.model_description.description #=> String
805
+ # resp.model_description.status #=> String, one of "TRAINING", "TRAINED", "TRAINING_FAILED", "STARTING_HOSTING", "HOSTED", "HOSTING_FAILED", "STOPPING_HOSTING", "SYSTEM_UPDATING", "DELETING"
806
+ # resp.model_description.status_message #=> String
807
+ # resp.model_description.performance.f1_score #=> Float
808
+ # resp.model_description.performance.recall #=> Float
809
+ # resp.model_description.performance.precision #=> Float
810
+ # resp.model_description.output_config.s3_location.bucket #=> String
811
+ # resp.model_description.output_config.s3_location.prefix #=> String
812
+ # resp.model_description.evaluation_manifest.bucket #=> String
813
+ # resp.model_description.evaluation_manifest.key #=> String
814
+ # resp.model_description.evaluation_result.bucket #=> String
815
+ # resp.model_description.evaluation_result.key #=> String
816
+ # resp.model_description.evaluation_end_timestamp #=> Time
817
+ # resp.model_description.kms_key_id #=> String
818
+ #
819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeModel AWS API Documentation
820
+ #
821
+ # @overload describe_model(params = {})
822
+ # @param [Hash] params ({})
823
+ def describe_model(params = {}, options = {})
824
+ req = build_request(:describe_model, params)
825
+ req.send_request(options)
826
+ end
827
+
828
+ # Describes an Amazon Lookout for Vision project.
829
+ #
830
+ # @option params [required, String] :project_name
831
+ # The name of the project that you want to describe.
832
+ #
833
+ # @return [Types::DescribeProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
834
+ #
835
+ # * {Types::DescribeProjectResponse#project_description #project_description} => Types::ProjectDescription
836
+ #
837
+ # @example Request syntax with placeholder values
838
+ #
839
+ # resp = client.describe_project({
840
+ # project_name: "ProjectName", # required
841
+ # })
842
+ #
843
+ # @example Response structure
844
+ #
845
+ # resp.project_description.project_arn #=> String
846
+ # resp.project_description.project_name #=> String
847
+ # resp.project_description.creation_timestamp #=> Time
848
+ # resp.project_description.datasets #=> Array
849
+ # resp.project_description.datasets[0].dataset_type #=> String
850
+ # resp.project_description.datasets[0].creation_timestamp #=> Time
851
+ # resp.project_description.datasets[0].status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", "UPDATE_FAILED_ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
852
+ # resp.project_description.datasets[0].status_message #=> String
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeProject AWS API Documentation
855
+ #
856
+ # @overload describe_project(params = {})
857
+ # @param [Hash] params ({})
858
+ def describe_project(params = {}, options = {})
859
+ req = build_request(:describe_project, params)
860
+ req.send_request(options)
861
+ end
862
+
863
+ # Detects anomalies in an image that you supply.
864
+ #
865
+ # The response from `DetectAnomalies` includes a boolean prediction that
866
+ # the image contains one or more anomalies and a confidence value for
867
+ # the prediction.
868
+ #
869
+ # <note markdown="1"> Before calling `DetectAnomalies`, you must first start your model with
870
+ # the StartModel operation. You are charged for the amount of time, in
871
+ # minutes, that a model runs and for the number of anomaly detection
872
+ # units that your model uses. If you are not using a model, use the
873
+ # StopModel operation to stop your model.
874
+ #
875
+ # </note>
876
+ #
877
+ # @option params [required, String] :project_name
878
+ # The name of the project that contains the model version that you want
879
+ # to use.
880
+ #
881
+ # @option params [required, String] :model_version
882
+ # The version of the model that you want to use.
883
+ #
884
+ # @option params [required, String, StringIO, File] :body
885
+ # The unencrypted image bytes that you want to analyze.
886
+ #
887
+ # @option params [required, String] :content_type
888
+ # The type of the image passed in `Body`. Valid values are `image/png`
889
+ # (PNG format images) and `image/jpeg` (JPG format images).
890
+ #
891
+ # @return [Types::DetectAnomaliesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
892
+ #
893
+ # * {Types::DetectAnomaliesResponse#detect_anomaly_result #detect_anomaly_result} => Types::DetectAnomalyResult
894
+ #
895
+ # @example Request syntax with placeholder values
896
+ #
897
+ # resp = client.detect_anomalies({
898
+ # project_name: "ProjectName", # required
899
+ # model_version: "ModelVersion", # required
900
+ # body: "data", # required
901
+ # content_type: "ContentType", # required
902
+ # })
903
+ #
904
+ # @example Response structure
905
+ #
906
+ # resp.detect_anomaly_result.source.type #=> String
907
+ # resp.detect_anomaly_result.is_anomalous #=> Boolean
908
+ # resp.detect_anomaly_result.confidence #=> Float
909
+ #
910
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DetectAnomalies AWS API Documentation
911
+ #
912
+ # @overload detect_anomalies(params = {})
913
+ # @param [Hash] params ({})
914
+ def detect_anomalies(params = {}, options = {})
915
+ req = build_request(:detect_anomalies, params)
916
+ req.send_request(options)
917
+ end
918
+
919
+ # Lists the JSON Lines within a dataset. An Amazon Lookout for Vision
920
+ # JSON Line contains the anomaly information for a single image,
921
+ # including the image location and the assigned label.
922
+ #
923
+ # @option params [required, String] :project_name
924
+ # The name of the project that contains the dataset that you want to
925
+ # list.
926
+ #
927
+ # @option params [required, String] :dataset_type
928
+ # The type of the dataset that you want to list. Specify `train` to list
929
+ # the training dataset. Specify `test` to list the test dataset. If you
930
+ # have a single dataset project, specify `train`.
931
+ #
932
+ # @option params [Boolean] :labeled
933
+ # Specify `true` to include labeled entries, otherwise specify `false`.
934
+ # If you don't specify a value, Lookout for Vision returns all entries.
935
+ #
936
+ # @option params [String] :anomaly_class
937
+ # Specify `normal` to include only normal images. Specify `anomaly` to
938
+ # only include anomalous entries. If you don't specify a value, Amazon
939
+ # Lookout for Vision returns normal and anomalous images.
940
+ #
941
+ # @option params [Time,DateTime,Date,Integer,String] :before_creation_date
942
+ # Only includes entries before the specified date in the response. For
943
+ # example, `2020-06-23T00:00:00`.
944
+ #
945
+ # @option params [Time,DateTime,Date,Integer,String] :after_creation_date
946
+ # Only includes entries after the specified date in the response. For
947
+ # example, `2020-06-23T00:00:00`.
948
+ #
949
+ # @option params [String] :next_token
950
+ # If the previous response was incomplete (because there is more data to
951
+ # retrieve), Amazon Lookout for Vision returns a pagination token in the
952
+ # response. You can use this pagination token to retrieve the next set
953
+ # of dataset entries.
954
+ #
955
+ # @option params [Integer] :max_results
956
+ # The maximum number of results to return per paginated call. The
957
+ # largest value you can specify is 100. If you specify a value greater
958
+ # than 100, a ValidationException error occurs. The default value is
959
+ # 100.
960
+ #
961
+ # @option params [String] :source_ref_contains
962
+ # Perform a "contains" search on the values of the `source-ref` key
963
+ # within the dataset. For example a value of "IMG\_17" returns all
964
+ # JSON Lines where the `source-ref` key value matches **IMG\_17**.
965
+ #
966
+ # @return [Types::ListDatasetEntriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
967
+ #
968
+ # * {Types::ListDatasetEntriesResponse#dataset_entries #dataset_entries} => Array&lt;String&gt;
969
+ # * {Types::ListDatasetEntriesResponse#next_token #next_token} => String
970
+ #
971
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
972
+ #
973
+ # @example Request syntax with placeholder values
974
+ #
975
+ # resp = client.list_dataset_entries({
976
+ # project_name: "ProjectName", # required
977
+ # dataset_type: "DatasetType", # required
978
+ # labeled: false,
979
+ # anomaly_class: "AnomalyClassFilter",
980
+ # before_creation_date: Time.now,
981
+ # after_creation_date: Time.now,
982
+ # next_token: "PaginationToken",
983
+ # max_results: 1,
984
+ # source_ref_contains: "QueryString",
985
+ # })
986
+ #
987
+ # @example Response structure
988
+ #
989
+ # resp.dataset_entries #=> Array
990
+ # resp.dataset_entries[0] #=> String
991
+ # resp.next_token #=> String
992
+ #
993
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListDatasetEntries AWS API Documentation
994
+ #
995
+ # @overload list_dataset_entries(params = {})
996
+ # @param [Hash] params ({})
997
+ def list_dataset_entries(params = {}, options = {})
998
+ req = build_request(:list_dataset_entries, params)
999
+ req.send_request(options)
1000
+ end
1001
+
1002
+ # Lists the versions of a model in an Amazon Lookout for Vision project.
1003
+ #
1004
+ # @option params [required, String] :project_name
1005
+ # The name of the project that contains the model versions that you want
1006
+ # to list.
1007
+ #
1008
+ # @option params [String] :next_token
1009
+ # If the previous response was incomplete (because there is more data to
1010
+ # retrieve), Amazon Lookout for Vision returns a pagination token in the
1011
+ # response. You can use this pagination token to retrieve the next set
1012
+ # of models.
1013
+ #
1014
+ # @option params [Integer] :max_results
1015
+ # The maximum number of results to return per paginated call. The
1016
+ # largest value you can specify is 100. If you specify a value greater
1017
+ # than 100, a ValidationException error occurs. The default value is
1018
+ # 100.
1019
+ #
1020
+ # @return [Types::ListModelsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1021
+ #
1022
+ # * {Types::ListModelsResponse#models #models} => Array&lt;Types::ModelMetadata&gt;
1023
+ # * {Types::ListModelsResponse#next_token #next_token} => String
1024
+ #
1025
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1026
+ #
1027
+ # @example Request syntax with placeholder values
1028
+ #
1029
+ # resp = client.list_models({
1030
+ # project_name: "ProjectName", # required
1031
+ # next_token: "PaginationToken",
1032
+ # max_results: 1,
1033
+ # })
1034
+ #
1035
+ # @example Response structure
1036
+ #
1037
+ # resp.models #=> Array
1038
+ # resp.models[0].creation_timestamp #=> Time
1039
+ # resp.models[0].model_version #=> String
1040
+ # resp.models[0].model_arn #=> String
1041
+ # resp.models[0].description #=> String
1042
+ # resp.models[0].status #=> String, one of "TRAINING", "TRAINED", "TRAINING_FAILED", "STARTING_HOSTING", "HOSTED", "HOSTING_FAILED", "STOPPING_HOSTING", "SYSTEM_UPDATING", "DELETING"
1043
+ # resp.models[0].status_message #=> String
1044
+ # resp.models[0].performance.f1_score #=> Float
1045
+ # resp.models[0].performance.recall #=> Float
1046
+ # resp.models[0].performance.precision #=> Float
1047
+ # resp.next_token #=> String
1048
+ #
1049
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListModels AWS API Documentation
1050
+ #
1051
+ # @overload list_models(params = {})
1052
+ # @param [Hash] params ({})
1053
+ def list_models(params = {}, options = {})
1054
+ req = build_request(:list_models, params)
1055
+ req.send_request(options)
1056
+ end
1057
+
1058
+ # Lists the Amazon Lookout for Vision projects in your AWS account.
1059
+ #
1060
+ # @option params [String] :next_token
1061
+ # If the previous response was incomplete (because there is more data to
1062
+ # retrieve), Amazon Lookout for Vision returns a pagination token in the
1063
+ # response. You can use this pagination token to retrieve the next set
1064
+ # of projects.
1065
+ #
1066
+ # @option params [Integer] :max_results
1067
+ # The maximum number of results to return per paginated call. The
1068
+ # largest value you can specify is 100. If you specify a value greater
1069
+ # than 100, a ValidationException error occurs. The default value is
1070
+ # 100.
1071
+ #
1072
+ # @return [Types::ListProjectsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1073
+ #
1074
+ # * {Types::ListProjectsResponse#projects #projects} => Array&lt;Types::ProjectMetadata&gt;
1075
+ # * {Types::ListProjectsResponse#next_token #next_token} => String
1076
+ #
1077
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1078
+ #
1079
+ # @example Request syntax with placeholder values
1080
+ #
1081
+ # resp = client.list_projects({
1082
+ # next_token: "PaginationToken",
1083
+ # max_results: 1,
1084
+ # })
1085
+ #
1086
+ # @example Response structure
1087
+ #
1088
+ # resp.projects #=> Array
1089
+ # resp.projects[0].project_arn #=> String
1090
+ # resp.projects[0].project_name #=> String
1091
+ # resp.projects[0].creation_timestamp #=> Time
1092
+ # resp.next_token #=> String
1093
+ #
1094
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListProjects AWS API Documentation
1095
+ #
1096
+ # @overload list_projects(params = {})
1097
+ # @param [Hash] params ({})
1098
+ def list_projects(params = {}, options = {})
1099
+ req = build_request(:list_projects, params)
1100
+ req.send_request(options)
1101
+ end
1102
+
1103
+ # Starts the running of the version of an Amazon Lookout for Vision
1104
+ # model. Starting a model takes a while to complete. To check the
1105
+ # current state of the model, use DescribeModel.
1106
+ #
1107
+ # Once the model is running, you can detect custom labels in new images
1108
+ # by calling DetectAnomalies.
1109
+ #
1110
+ # <note markdown="1"> You are charged for the amount of time that the model is running. To
1111
+ # stop a running model, call StopModel.
1112
+ #
1113
+ # </note>
1114
+ #
1115
+ # @option params [required, String] :project_name
1116
+ # The name of the project that contains the model that you want to
1117
+ # start.
1118
+ #
1119
+ # @option params [required, String] :model_version
1120
+ # The version of the model that you want to start.
1121
+ #
1122
+ # @option params [required, Integer] :min_inference_units
1123
+ # The minimum number of inference units to use. A single inference unit
1124
+ # represents 1 hour of processing and can support up to 5 Transaction
1125
+ # Pers Second (TPS). Use a higher number to increase the TPS throughput
1126
+ # of your model. You are charged for the number of inference units that
1127
+ # you use.
1128
+ #
1129
+ # @option params [String] :client_token
1130
+ # ClientToken is an idempotency token that ensures a call to
1131
+ # `StartModel` completes only once. You choose the value to pass. For
1132
+ # example, An issue, such as an network outage, might prevent you from
1133
+ # getting a response from `StartModel`. In this case, safely retry your
1134
+ # call to `StartModel` by using the same `ClientToken` parameter value.
1135
+ # An error occurs if the other input parameters are not the same as in
1136
+ # the first request. Using a different value for `ClientToken` is
1137
+ # considered a new call to `StartModel`. An idempotency token is active
1138
+ # for 8 hours.
1139
+ #
1140
+ # **A suitable default value is auto-generated.** You should normally
1141
+ # not need to pass this option.**
1142
+ #
1143
+ # @return [Types::StartModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1144
+ #
1145
+ # * {Types::StartModelResponse#status #status} => String
1146
+ #
1147
+ # @example Request syntax with placeholder values
1148
+ #
1149
+ # resp = client.start_model({
1150
+ # project_name: "ProjectName", # required
1151
+ # model_version: "ModelVersion", # required
1152
+ # min_inference_units: 1, # required
1153
+ # client_token: "ClientToken",
1154
+ # })
1155
+ #
1156
+ # @example Response structure
1157
+ #
1158
+ # resp.status #=> String, one of "RUNNING", "STARTING", "STOPPED", "FAILED"
1159
+ #
1160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StartModel AWS API Documentation
1161
+ #
1162
+ # @overload start_model(params = {})
1163
+ # @param [Hash] params ({})
1164
+ def start_model(params = {}, options = {})
1165
+ req = build_request(:start_model, params)
1166
+ req.send_request(options)
1167
+ end
1168
+
1169
+ # Stops a running model. The operation might take a while to complete.
1170
+ # To check the current status, call DescribeModel.
1171
+ #
1172
+ # @option params [required, String] :project_name
1173
+ # The name of the project that contains the model that you want to stop.
1174
+ #
1175
+ # @option params [required, String] :model_version
1176
+ # The version of the model that you want to stop.
1177
+ #
1178
+ # @option params [String] :client_token
1179
+ # ClientToken is an idempotency token that ensures a call to `StopModel`
1180
+ # completes only once. You choose the value to pass. For example, An
1181
+ # issue, such as an network outage, might prevent you from getting a
1182
+ # response from `StopModel`. In this case, safely retry your call to
1183
+ # `StopModel` by using the same `ClientToken` parameter value. An error
1184
+ # occurs if the other input parameters are not the same as in the first
1185
+ # request. Using a different value for `ClientToken` is considered a new
1186
+ # call to `StopModel`. An idempotency token is active for 8 hours.
1187
+ #
1188
+ # **A suitable default value is auto-generated.** You should normally
1189
+ # not need to pass this option.**
1190
+ #
1191
+ # @return [Types::StopModelResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1192
+ #
1193
+ # * {Types::StopModelResponse#status #status} => String
1194
+ #
1195
+ # @example Request syntax with placeholder values
1196
+ #
1197
+ # resp = client.stop_model({
1198
+ # project_name: "ProjectName", # required
1199
+ # model_version: "ModelVersion", # required
1200
+ # client_token: "ClientToken",
1201
+ # })
1202
+ #
1203
+ # @example Response structure
1204
+ #
1205
+ # resp.status #=> String, one of "RUNNING", "STARTING", "STOPPED", "FAILED"
1206
+ #
1207
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StopModel AWS API Documentation
1208
+ #
1209
+ # @overload stop_model(params = {})
1210
+ # @param [Hash] params ({})
1211
+ def stop_model(params = {}, options = {})
1212
+ req = build_request(:stop_model, params)
1213
+ req.send_request(options)
1214
+ end
1215
+
1216
+ # Adds one or more JSON Line entries to a dataset. A JSON Line includes
1217
+ # information about an image used for training or testing an Amazon
1218
+ # Lookout for Vision model. The following is an example JSON Line.
1219
+ #
1220
+ # Updating a dataset might take a while to complete. To check the
1221
+ # current status, call DescribeDataset and check the `Status` field in
1222
+ # the response.
1223
+ #
1224
+ # @option params [required, String] :project_name
1225
+ # The name of the project that contains the dataset that you want to
1226
+ # update.
1227
+ #
1228
+ # @option params [required, String] :dataset_type
1229
+ # The type of the dataset that you want to update. Specify `train` to
1230
+ # update the training dataset. Specify `test` to update the test
1231
+ # dataset. If you have a single dataset project, specify `train`.
1232
+ #
1233
+ # @option params [required, String, StringIO, File] :changes
1234
+ # The entries to add to the dataset.
1235
+ #
1236
+ # @option params [String] :client_token
1237
+ # ClientToken is an idempotency token that ensures a call to
1238
+ # `UpdateDatasetEntries` completes only once. You choose the value to
1239
+ # pass. For example, An issue, such as an network outage, might prevent
1240
+ # you from getting a response from `UpdateDatasetEntries`. In this case,
1241
+ # safely retry your call to `UpdateDatasetEntries` by using the same
1242
+ # `ClientToken` parameter value. An error occurs if the other input
1243
+ # parameters are not the same as in the first request. Using a different
1244
+ # value for `ClientToken` is considered a new call to
1245
+ # `UpdateDatasetEntries`. An idempotency token is active for 8 hours.
1246
+ #
1247
+ # **A suitable default value is auto-generated.** You should normally
1248
+ # not need to pass this option.**
1249
+ #
1250
+ # @return [Types::UpdateDatasetEntriesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1251
+ #
1252
+ # * {Types::UpdateDatasetEntriesResponse#status #status} => String
1253
+ #
1254
+ # @example Request syntax with placeholder values
1255
+ #
1256
+ # resp = client.update_dataset_entries({
1257
+ # project_name: "ProjectName", # required
1258
+ # dataset_type: "DatasetType", # required
1259
+ # changes: "data", # required
1260
+ # client_token: "ClientToken",
1261
+ # })
1262
+ #
1263
+ # @example Response structure
1264
+ #
1265
+ # resp.status #=> String, one of "CREATE_IN_PROGRESS", "CREATE_COMPLETE", "CREATE_FAILED", "UPDATE_IN_PROGRESS", "UPDATE_COMPLETE", "UPDATE_FAILED_ROLLBACK_IN_PROGRESS", "UPDATE_FAILED_ROLLBACK_COMPLETE", "DELETE_IN_PROGRESS", "DELETE_COMPLETE", "DELETE_FAILED"
1266
+ #
1267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/UpdateDatasetEntries AWS API Documentation
1268
+ #
1269
+ # @overload update_dataset_entries(params = {})
1270
+ # @param [Hash] params ({})
1271
+ def update_dataset_entries(params = {}, options = {})
1272
+ req = build_request(:update_dataset_entries, params)
1273
+ req.send_request(options)
1274
+ end
1275
+
1276
+ # @!endgroup
1277
+
1278
+ # @param params ({})
1279
+ # @api private
1280
+ def build_request(operation_name, params = {})
1281
+ handlers = @handlers.for(operation_name)
1282
+ context = Seahorse::Client::RequestContext.new(
1283
+ operation_name: operation_name,
1284
+ operation: config.api.operation(operation_name),
1285
+ client: self,
1286
+ params: params,
1287
+ config: config)
1288
+ context[:gem_name] = 'aws-sdk-lookoutforvision'
1289
+ context[:gem_version] = '1.0.0'
1290
+ Seahorse::Client::Request.new(handlers, context)
1291
+ end
1292
+
1293
+ # @api private
1294
+ # @deprecated
1295
+ def waiter_names
1296
+ []
1297
+ end
1298
+
1299
+ class << self
1300
+
1301
+ # @api private
1302
+ attr_reader :identifier
1303
+
1304
+ # @api private
1305
+ def errors_module
1306
+ Errors
1307
+ end
1308
+
1309
+ end
1310
+ end
1311
+ end