aws-sdk-lookoutforvision 1.8.0 → 1.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutforvision/client.rb +399 -59
- data/lib/aws-sdk-lookoutforvision/client_api.rb +156 -1
- data/lib/aws-sdk-lookoutforvision/types.rb +683 -73
- data/lib/aws-sdk-lookoutforvision.rb +1 -1
- metadata +4 -4
@@ -27,6 +27,8 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
30
32
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
31
33
|
require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
32
34
|
|
@@ -73,6 +75,8 @@ module Aws::LookoutforVision
|
|
73
75
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
76
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
77
|
add_plugin(Aws::Plugins::HttpChecksum)
|
78
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
79
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
76
80
|
add_plugin(Aws::Plugins::SignatureV4)
|
77
81
|
add_plugin(Aws::Plugins::Protocols::RestJson)
|
78
82
|
|
@@ -119,7 +123,9 @@ module Aws::LookoutforVision
|
|
119
123
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
124
|
# are very aggressive. Construct and pass an instance of
|
121
125
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
126
|
+
# enable retries and extended timeouts. Instance profile credential
|
127
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
128
|
+
# to true.
|
123
129
|
#
|
124
130
|
# @option options [required, String] :region
|
125
131
|
# The AWS region to connect to. The configured `:region` is
|
@@ -173,6 +179,10 @@ module Aws::LookoutforVision
|
|
173
179
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
174
180
|
# a clock skew correction and retry requests with skewed client clocks.
|
175
181
|
#
|
182
|
+
# @option options [String] :defaults_mode ("legacy")
|
183
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
184
|
+
# accepted modes and the configuration defaults that are included.
|
185
|
+
#
|
176
186
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
177
187
|
# Set to true to disable SDK automatically adding host prefix
|
178
188
|
# to default service endpoint when available.
|
@@ -295,7 +305,7 @@ module Aws::LookoutforVision
|
|
295
305
|
# seconds to wait when opening a HTTP session before raising a
|
296
306
|
# `Timeout::Error`.
|
297
307
|
#
|
298
|
-
# @option options [
|
308
|
+
# @option options [Float] :http_read_timeout (60) The default
|
299
309
|
# number of seconds to wait for response data. This value can
|
300
310
|
# safely be set per-request on the session.
|
301
311
|
#
|
@@ -311,6 +321,9 @@ module Aws::LookoutforVision
|
|
311
321
|
# disables this behaviour. This value can safely be set per
|
312
322
|
# request on the session.
|
313
323
|
#
|
324
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
325
|
+
# in seconds.
|
326
|
+
#
|
314
327
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
315
328
|
# HTTP debug output will be sent to the `:logger`.
|
316
329
|
#
|
@@ -375,11 +388,17 @@ module Aws::LookoutforVision
|
|
375
388
|
# @option params [String] :client_token
|
376
389
|
# ClientToken is an idempotency token that ensures a call to
|
377
390
|
# `CreateDataset` completes only once. You choose the value to pass. For
|
378
|
-
# example, An issue
|
379
|
-
#
|
380
|
-
#
|
381
|
-
#
|
382
|
-
#
|
391
|
+
# example, An issue might prevent you from getting a response from
|
392
|
+
# `CreateDataset`. In this case, safely retry your call to
|
393
|
+
# `CreateDataset` by using the same `ClientToken` parameter value.
|
394
|
+
#
|
395
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
396
|
+
# using inserts a value for you. This prevents retries after a network
|
397
|
+
# error from making multiple dataset creation requests. You'll need to
|
398
|
+
# provide your own value for other use cases.
|
399
|
+
#
|
400
|
+
# An error occurs if the other input parameters are not the same as in
|
401
|
+
# the first request. Using a different value for `ClientToken` is
|
383
402
|
# considered a new call to `CreateDataset`. An idempotency token is
|
384
403
|
# active for 8 hours.
|
385
404
|
#
|
@@ -453,9 +472,15 @@ module Aws::LookoutforVision
|
|
453
472
|
# @option params [String] :client_token
|
454
473
|
# ClientToken is an idempotency token that ensures a call to
|
455
474
|
# `CreateModel` completes only once. You choose the value to pass. For
|
456
|
-
# example, An issue
|
457
|
-
#
|
458
|
-
#
|
475
|
+
# example, An issue might prevent you from getting a response from
|
476
|
+
# `CreateModel`. In this case, safely retry your call to `CreateModel`
|
477
|
+
# by using the same `ClientToken` parameter value.
|
478
|
+
#
|
479
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
480
|
+
# using inserts a value for you. This prevents retries after a network
|
481
|
+
# error from starting multiple training jobs. You'll need to provide
|
482
|
+
# your own value for other use cases.
|
483
|
+
#
|
459
484
|
# An error occurs if the other input parameters are not the same as in
|
460
485
|
# the first request. Using a different value for `ClientToken` is
|
461
486
|
# considered a new call to `CreateModel`. An idempotency token is active
|
@@ -469,11 +494,10 @@ module Aws::LookoutforVision
|
|
469
494
|
# results.
|
470
495
|
#
|
471
496
|
# @option params [String] :kms_key_id
|
472
|
-
# The identifier for your AWS
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
# encrypted by a key that AWS owns and manages.
|
497
|
+
# The identifier for your AWS KMS key. The key is used to encrypt
|
498
|
+
# training and test images copied into the service for model training.
|
499
|
+
# Your source images are unaffected. If this parameter is not specified,
|
500
|
+
# the copied images are encrypted by a key that AWS owns and manages.
|
477
501
|
#
|
478
502
|
# @option params [Array<Types::Tag>] :tags
|
479
503
|
# A set of tags (key-value pairs) that you want to attach to the model.
|
@@ -536,11 +560,17 @@ module Aws::LookoutforVision
|
|
536
560
|
# @option params [String] :client_token
|
537
561
|
# ClientToken is an idempotency token that ensures a call to
|
538
562
|
# `CreateProject` completes only once. You choose the value to pass. For
|
539
|
-
# example, An issue
|
540
|
-
#
|
541
|
-
#
|
542
|
-
#
|
543
|
-
#
|
563
|
+
# example, An issue might prevent you from getting a response from
|
564
|
+
# `CreateProject`. In this case, safely retry your call to
|
565
|
+
# `CreateProject` by using the same `ClientToken` parameter value.
|
566
|
+
#
|
567
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
568
|
+
# using inserts a value for you. This prevents retries after a network
|
569
|
+
# error from making multiple project creation requests. You'll need to
|
570
|
+
# provide your own value for other use cases.
|
571
|
+
#
|
572
|
+
# An error occurs if the other input parameters are not the same as in
|
573
|
+
# the first request. Using a different value for `ClientToken` is
|
544
574
|
# considered a new call to `CreateProject`. An idempotency token is
|
545
575
|
# active for 8 hours.
|
546
576
|
#
|
@@ -604,11 +634,17 @@ module Aws::LookoutforVision
|
|
604
634
|
# @option params [String] :client_token
|
605
635
|
# ClientToken is an idempotency token that ensures a call to
|
606
636
|
# `DeleteDataset` completes only once. You choose the value to pass. For
|
607
|
-
# example, An issue
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
637
|
+
# example, An issue might prevent you from getting a response from
|
638
|
+
# `DeleteDataset`. In this case, safely retry your call to
|
639
|
+
# `DeleteDataset` by using the same `ClientToken` parameter value.
|
640
|
+
#
|
641
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
642
|
+
# using inserts a value for you. This prevents retries after a network
|
643
|
+
# error from making multiple deletetion requests. You'll need to
|
644
|
+
# provide your own value for other use cases.
|
645
|
+
#
|
646
|
+
# An error occurs if the other input parameters are not the same as in
|
647
|
+
# the first request. Using a different value for `ClientToken` is
|
612
648
|
# considered a new call to `DeleteDataset`. An idempotency token is
|
613
649
|
# active for 8 hours.
|
614
650
|
#
|
@@ -638,9 +674,11 @@ module Aws::LookoutforVision
|
|
638
674
|
# running model. To stop a running model, use the StopModel operation.
|
639
675
|
#
|
640
676
|
# It might take a few seconds to delete a model. To determine if a model
|
641
|
-
# has been deleted, call
|
677
|
+
# has been deleted, call ListModels and check if the version of the
|
642
678
|
# model (`ModelVersion`) is in the `Models` array.
|
643
679
|
#
|
680
|
+
#
|
681
|
+
#
|
644
682
|
# This operation requires permissions to perform the
|
645
683
|
# `lookoutvision:DeleteModel` operation.
|
646
684
|
#
|
@@ -654,9 +692,15 @@ module Aws::LookoutforVision
|
|
654
692
|
# @option params [String] :client_token
|
655
693
|
# ClientToken is an idempotency token that ensures a call to
|
656
694
|
# `DeleteModel` completes only once. You choose the value to pass. For
|
657
|
-
# example,
|
658
|
-
#
|
659
|
-
#
|
695
|
+
# example, an issue might prevent you from getting a response from
|
696
|
+
# `DeleteModel`. In this case, safely retry your call to `DeleteModel`
|
697
|
+
# by using the same `ClientToken` parameter value.
|
698
|
+
#
|
699
|
+
# If you don't supply a value for ClientToken, the AWS SDK you are
|
700
|
+
# using inserts a value for you. This prevents retries after a network
|
701
|
+
# error from making multiple model deletion requests. You'll need to
|
702
|
+
# provide your own value for other use cases.
|
703
|
+
#
|
660
704
|
# An error occurs if the other input parameters are not the same as in
|
661
705
|
# the first request. Using a different value for `ClientToken` is
|
662
706
|
# considered a new call to `DeleteModel`. An idempotency token is active
|
@@ -673,7 +717,7 @@ module Aws::LookoutforVision
|
|
673
717
|
#
|
674
718
|
# resp = client.delete_model({
|
675
719
|
# project_name: "ProjectName", # required
|
676
|
-
# model_version: "
|
720
|
+
# model_version: "ModelVersionNoLatest", # required
|
677
721
|
# client_token: "ClientToken",
|
678
722
|
# })
|
679
723
|
#
|
@@ -709,11 +753,17 @@ module Aws::LookoutforVision
|
|
709
753
|
# @option params [String] :client_token
|
710
754
|
# ClientToken is an idempotency token that ensures a call to
|
711
755
|
# `DeleteProject` completes only once. You choose the value to pass. For
|
712
|
-
# example, An issue
|
713
|
-
#
|
714
|
-
#
|
715
|
-
#
|
716
|
-
#
|
756
|
+
# example, An issue might prevent you from getting a response from
|
757
|
+
# `DeleteProject`. In this case, safely retry your call to
|
758
|
+
# `DeleteProject` by using the same `ClientToken` parameter value.
|
759
|
+
#
|
760
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
761
|
+
# using inserts a value for you. This prevents retries after a network
|
762
|
+
# error from making multiple project deletion requests. You'll need to
|
763
|
+
# provide your own value for other use cases.
|
764
|
+
#
|
765
|
+
# An error occurs if the other input parameters are not the same as in
|
766
|
+
# the first request. Using a different value for `ClientToken` is
|
717
767
|
# considered a new call to `DeleteProject`. An idempotency token is
|
718
768
|
# active for 8 hours.
|
719
769
|
#
|
@@ -843,6 +893,69 @@ module Aws::LookoutforVision
|
|
843
893
|
req.send_request(options)
|
844
894
|
end
|
845
895
|
|
896
|
+
# Describes an Amazon Lookout for Vision model packaging job.
|
897
|
+
#
|
898
|
+
# This operation requires permissions to perform the
|
899
|
+
# `lookoutvision:DescribeModelPackagingJob` operation.
|
900
|
+
#
|
901
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
902
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
903
|
+
#
|
904
|
+
# @option params [required, String] :project_name
|
905
|
+
# The name of the project that contains the model packaging job that you
|
906
|
+
# want to describe.
|
907
|
+
#
|
908
|
+
# @option params [required, String] :job_name
|
909
|
+
# The job name for the model packaging job.
|
910
|
+
#
|
911
|
+
# @return [Types::DescribeModelPackagingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
912
|
+
#
|
913
|
+
# * {Types::DescribeModelPackagingJobResponse#model_packaging_description #model_packaging_description} => Types::ModelPackagingDescription
|
914
|
+
#
|
915
|
+
# @example Request syntax with placeholder values
|
916
|
+
#
|
917
|
+
# resp = client.describe_model_packaging_job({
|
918
|
+
# project_name: "ProjectName", # required
|
919
|
+
# job_name: "ModelPackagingJobName", # required
|
920
|
+
# })
|
921
|
+
#
|
922
|
+
# @example Response structure
|
923
|
+
#
|
924
|
+
# resp.model_packaging_description.job_name #=> String
|
925
|
+
# resp.model_packaging_description.project_name #=> String
|
926
|
+
# resp.model_packaging_description.model_version #=> String
|
927
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.compiler_options #=> String
|
928
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_device #=> String, one of "jetson_xavier"
|
929
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.os #=> String, one of "LINUX"
|
930
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.arch #=> String, one of "ARM64", "X86_64"
|
931
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.accelerator #=> String, one of "NVIDIA"
|
932
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.s3_output_location.bucket #=> String
|
933
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.s3_output_location.prefix #=> String
|
934
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_name #=> String
|
935
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_version #=> String
|
936
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_description #=> String
|
937
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags #=> Array
|
938
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags[0].key #=> String
|
939
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags[0].value #=> String
|
940
|
+
# resp.model_packaging_description.model_packaging_job_description #=> String
|
941
|
+
# resp.model_packaging_description.model_packaging_method #=> String
|
942
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_version_arn #=> String
|
943
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_name #=> String
|
944
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_version #=> String
|
945
|
+
# resp.model_packaging_description.status #=> String, one of "CREATED", "RUNNING", "SUCCEEDED", "FAILED"
|
946
|
+
# resp.model_packaging_description.status_message #=> String
|
947
|
+
# resp.model_packaging_description.creation_timestamp #=> Time
|
948
|
+
# resp.model_packaging_description.last_updated_timestamp #=> Time
|
949
|
+
#
|
950
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeModelPackagingJob AWS API Documentation
|
951
|
+
#
|
952
|
+
# @overload describe_model_packaging_job(params = {})
|
953
|
+
# @param [Hash] params ({})
|
954
|
+
def describe_model_packaging_job(params = {}, options = {})
|
955
|
+
req = build_request(:describe_model_packaging_job, params)
|
956
|
+
req.send_request(options)
|
957
|
+
end
|
958
|
+
|
846
959
|
# Describes an Amazon Lookout for Vision project.
|
847
960
|
#
|
848
961
|
# This operation requires permissions to perform the
|
@@ -1026,8 +1139,75 @@ module Aws::LookoutforVision
|
|
1026
1139
|
req.send_request(options)
|
1027
1140
|
end
|
1028
1141
|
|
1142
|
+
# Lists the model packaging jobs created for an Amazon Lookout for
|
1143
|
+
# Vision project.
|
1144
|
+
#
|
1145
|
+
# This operation requires permissions to perform the
|
1146
|
+
# `lookoutvision:ListModelPackagingJobs` operation.
|
1147
|
+
#
|
1148
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
1149
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
1150
|
+
#
|
1151
|
+
# @option params [required, String] :project_name
|
1152
|
+
# The name of the project for which you want to list the model packaging
|
1153
|
+
# jobs.
|
1154
|
+
#
|
1155
|
+
# @option params [String] :next_token
|
1156
|
+
# If the previous response was incomplete (because there is more results
|
1157
|
+
# to retrieve), Amazon Lookout for Vision returns a pagination token in
|
1158
|
+
# the response. You can use this pagination token to retrieve the next
|
1159
|
+
# set of results.
|
1160
|
+
#
|
1161
|
+
# @option params [Integer] :max_results
|
1162
|
+
# The maximum number of results to return per paginated call. The
|
1163
|
+
# largest value you can specify is 100. If you specify a value greater
|
1164
|
+
# than 100, a ValidationException error occurs. The default value is
|
1165
|
+
# 100.
|
1166
|
+
#
|
1167
|
+
# @return [Types::ListModelPackagingJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1168
|
+
#
|
1169
|
+
# * {Types::ListModelPackagingJobsResponse#model_packaging_jobs #model_packaging_jobs} => Array<Types::ModelPackagingJobMetadata>
|
1170
|
+
# * {Types::ListModelPackagingJobsResponse#next_token #next_token} => String
|
1171
|
+
#
|
1172
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1173
|
+
#
|
1174
|
+
# @example Request syntax with placeholder values
|
1175
|
+
#
|
1176
|
+
# resp = client.list_model_packaging_jobs({
|
1177
|
+
# project_name: "ProjectName", # required
|
1178
|
+
# next_token: "PaginationToken",
|
1179
|
+
# max_results: 1,
|
1180
|
+
# })
|
1181
|
+
#
|
1182
|
+
# @example Response structure
|
1183
|
+
#
|
1184
|
+
# resp.model_packaging_jobs #=> Array
|
1185
|
+
# resp.model_packaging_jobs[0].job_name #=> String
|
1186
|
+
# resp.model_packaging_jobs[0].project_name #=> String
|
1187
|
+
# resp.model_packaging_jobs[0].model_version #=> String
|
1188
|
+
# resp.model_packaging_jobs[0].model_packaging_job_description #=> String
|
1189
|
+
# resp.model_packaging_jobs[0].model_packaging_method #=> String
|
1190
|
+
# resp.model_packaging_jobs[0].status #=> String, one of "CREATED", "RUNNING", "SUCCEEDED", "FAILED"
|
1191
|
+
# resp.model_packaging_jobs[0].status_message #=> String
|
1192
|
+
# resp.model_packaging_jobs[0].creation_timestamp #=> Time
|
1193
|
+
# resp.model_packaging_jobs[0].last_updated_timestamp #=> Time
|
1194
|
+
# resp.next_token #=> String
|
1195
|
+
#
|
1196
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListModelPackagingJobs AWS API Documentation
|
1197
|
+
#
|
1198
|
+
# @overload list_model_packaging_jobs(params = {})
|
1199
|
+
# @param [Hash] params ({})
|
1200
|
+
def list_model_packaging_jobs(params = {}, options = {})
|
1201
|
+
req = build_request(:list_model_packaging_jobs, params)
|
1202
|
+
req.send_request(options)
|
1203
|
+
end
|
1204
|
+
|
1029
1205
|
# Lists the versions of a model in an Amazon Lookout for Vision project.
|
1030
1206
|
#
|
1207
|
+
# The `ListModels` operation is eventually consistent. Recent calls to
|
1208
|
+
# `CreateModel` might take a while to appear in the response from
|
1209
|
+
# `ListProjects`.
|
1210
|
+
#
|
1031
1211
|
# This operation requires permissions to perform the
|
1032
1212
|
# `lookoutvision:ListModels` operation.
|
1033
1213
|
#
|
@@ -1087,6 +1267,10 @@ module Aws::LookoutforVision
|
|
1087
1267
|
|
1088
1268
|
# Lists the Amazon Lookout for Vision projects in your AWS account.
|
1089
1269
|
#
|
1270
|
+
# The `ListProjects` operation is eventually consistent. Recent calls to
|
1271
|
+
# `CreateProject` and `DeleteProject` might take a while to appear in
|
1272
|
+
# the response from `ListProjects`.
|
1273
|
+
#
|
1090
1274
|
# This operation requires permissions to perform the
|
1091
1275
|
# `lookoutvision:ListProjects` operation.
|
1092
1276
|
#
|
@@ -1194,17 +1378,22 @@ module Aws::LookoutforVision
|
|
1194
1378
|
#
|
1195
1379
|
# @option params [required, Integer] :min_inference_units
|
1196
1380
|
# The minimum number of inference units to use. A single inference unit
|
1197
|
-
# represents 1 hour of processing
|
1198
|
-
#
|
1199
|
-
#
|
1200
|
-
# you use.
|
1381
|
+
# represents 1 hour of processing. Use a higher number to increase the
|
1382
|
+
# TPS throughput of your model. You are charged for the number of
|
1383
|
+
# inference units that you use.
|
1201
1384
|
#
|
1202
1385
|
# @option params [String] :client_token
|
1203
1386
|
# ClientToken is an idempotency token that ensures a call to
|
1204
1387
|
# `StartModel` completes only once. You choose the value to pass. For
|
1205
|
-
# example, An issue
|
1206
|
-
#
|
1207
|
-
#
|
1388
|
+
# example, An issue might prevent you from getting a response from
|
1389
|
+
# `StartModel`. In this case, safely retry your call to `StartModel` by
|
1390
|
+
# using the same `ClientToken` parameter value.
|
1391
|
+
#
|
1392
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1393
|
+
# using inserts a value for you. This prevents retries after a network
|
1394
|
+
# error from making multiple start requests. You'll need to provide
|
1395
|
+
# your own value for other use cases.
|
1396
|
+
#
|
1208
1397
|
# An error occurs if the other input parameters are not the same as in
|
1209
1398
|
# the first request. Using a different value for `ClientToken` is
|
1210
1399
|
# considered a new call to `StartModel`. An idempotency token is active
|
@@ -1239,6 +1428,130 @@ module Aws::LookoutforVision
|
|
1239
1428
|
req.send_request(options)
|
1240
1429
|
end
|
1241
1430
|
|
1431
|
+
# Starts an Amazon Lookout for Vision model packaging job. A model
|
1432
|
+
# packaging job creates an AWS IoT Greengrass component for a Lookout
|
1433
|
+
# for Vision model. You can use the component to deploy your model to an
|
1434
|
+
# edge device managed by Greengrass.
|
1435
|
+
#
|
1436
|
+
# Use the DescribeModelPackagingJob API to determine the current status
|
1437
|
+
# of the job. The model packaging job is complete if the value of
|
1438
|
+
# `Status` is `SUCCEEDED`.
|
1439
|
+
#
|
1440
|
+
# To deploy the component to the target device, use the component name
|
1441
|
+
# and component version with the AWS IoT Greengrass
|
1442
|
+
# [CreateDeployment][1] API.
|
1443
|
+
#
|
1444
|
+
# This operation requires the following permissions:
|
1445
|
+
#
|
1446
|
+
# * `lookoutvision:StartModelPackagingJobs`
|
1447
|
+
#
|
1448
|
+
# * `s3:PutObject`
|
1449
|
+
#
|
1450
|
+
# * `s3:GetBucketLocation`
|
1451
|
+
#
|
1452
|
+
# * `greengrass:CreateComponentVersion`
|
1453
|
+
#
|
1454
|
+
# * `greengrass:DescribeComponent`
|
1455
|
+
#
|
1456
|
+
# * (Optional) `greengrass:TagResource`. Only required if you want to
|
1457
|
+
# tag the component.
|
1458
|
+
#
|
1459
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
1460
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
1461
|
+
#
|
1462
|
+
#
|
1463
|
+
#
|
1464
|
+
# [1]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html
|
1465
|
+
#
|
1466
|
+
# @option params [required, String] :project_name
|
1467
|
+
# The name of the project which contains the version of the model that
|
1468
|
+
# you want to package.
|
1469
|
+
#
|
1470
|
+
# @option params [required, String] :model_version
|
1471
|
+
# The version of the model within the project that you want to package.
|
1472
|
+
#
|
1473
|
+
# @option params [String] :job_name
|
1474
|
+
# A name for the model packaging job. If you don't supply a value, the
|
1475
|
+
# service creates a job name for you.
|
1476
|
+
#
|
1477
|
+
# @option params [required, Types::ModelPackagingConfiguration] :configuration
|
1478
|
+
# The configuration for the model packaging job.
|
1479
|
+
#
|
1480
|
+
# @option params [String] :description
|
1481
|
+
# A description for the model packaging job.
|
1482
|
+
#
|
1483
|
+
# @option params [String] :client_token
|
1484
|
+
# ClientToken is an idempotency token that ensures a call to
|
1485
|
+
# `StartModelPackagingJob` completes only once. You choose the value to
|
1486
|
+
# pass. For example, An issue might prevent you from getting a response
|
1487
|
+
# from `StartModelPackagingJob`. In this case, safely retry your call to
|
1488
|
+
# `StartModelPackagingJob` by using the same `ClientToken` parameter
|
1489
|
+
# value.
|
1490
|
+
#
|
1491
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1492
|
+
# using inserts a value for you. This prevents retries after a network
|
1493
|
+
# error from making multiple dataset creation requests. You'll need to
|
1494
|
+
# provide your own value for other use cases.
|
1495
|
+
#
|
1496
|
+
# An error occurs if the other input parameters are not the same as in
|
1497
|
+
# the first request. Using a different value for `ClientToken` is
|
1498
|
+
# considered a new call to `StartModelPackagingJob`. An idempotency
|
1499
|
+
# token is active for 8 hours.
|
1500
|
+
#
|
1501
|
+
# **A suitable default value is auto-generated.** You should normally
|
1502
|
+
# not need to pass this option.**
|
1503
|
+
#
|
1504
|
+
# @return [Types::StartModelPackagingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1505
|
+
#
|
1506
|
+
# * {Types::StartModelPackagingJobResponse#job_name #job_name} => String
|
1507
|
+
#
|
1508
|
+
# @example Request syntax with placeholder values
|
1509
|
+
#
|
1510
|
+
# resp = client.start_model_packaging_job({
|
1511
|
+
# project_name: "ProjectName", # required
|
1512
|
+
# model_version: "ModelVersion", # required
|
1513
|
+
# job_name: "ModelPackagingJobName",
|
1514
|
+
# configuration: { # required
|
1515
|
+
# greengrass: { # required
|
1516
|
+
# compiler_options: "CompilerOptions", # required
|
1517
|
+
# target_device: "jetson_xavier", # accepts jetson_xavier
|
1518
|
+
# target_platform: {
|
1519
|
+
# os: "LINUX", # required, accepts LINUX
|
1520
|
+
# arch: "ARM64", # required, accepts ARM64, X86_64
|
1521
|
+
# accelerator: "NVIDIA", # required, accepts NVIDIA
|
1522
|
+
# },
|
1523
|
+
# s3_output_location: { # required
|
1524
|
+
# bucket: "S3BucketName", # required
|
1525
|
+
# prefix: "S3KeyPrefix",
|
1526
|
+
# },
|
1527
|
+
# component_name: "ComponentName", # required
|
1528
|
+
# component_version: "ComponentVersion",
|
1529
|
+
# component_description: "ComponentDescription",
|
1530
|
+
# tags: [
|
1531
|
+
# {
|
1532
|
+
# key: "TagKey", # required
|
1533
|
+
# value: "TagValue", # required
|
1534
|
+
# },
|
1535
|
+
# ],
|
1536
|
+
# },
|
1537
|
+
# },
|
1538
|
+
# description: "ModelPackagingJobDescription",
|
1539
|
+
# client_token: "ClientToken",
|
1540
|
+
# })
|
1541
|
+
#
|
1542
|
+
# @example Response structure
|
1543
|
+
#
|
1544
|
+
# resp.job_name #=> String
|
1545
|
+
#
|
1546
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StartModelPackagingJob AWS API Documentation
|
1547
|
+
#
|
1548
|
+
# @overload start_model_packaging_job(params = {})
|
1549
|
+
# @param [Hash] params ({})
|
1550
|
+
def start_model_packaging_job(params = {}, options = {})
|
1551
|
+
req = build_request(:start_model_packaging_job, params)
|
1552
|
+
req.send_request(options)
|
1553
|
+
end
|
1554
|
+
|
1242
1555
|
# Stops the hosting of a running model. The operation might take a while
|
1243
1556
|
# to complete. To check the current status, call DescribeModel.
|
1244
1557
|
#
|
@@ -1256,12 +1569,19 @@ module Aws::LookoutforVision
|
|
1256
1569
|
# @option params [String] :client_token
|
1257
1570
|
# ClientToken is an idempotency token that ensures a call to `StopModel`
|
1258
1571
|
# completes only once. You choose the value to pass. For example, An
|
1259
|
-
# issue
|
1260
|
-
#
|
1261
|
-
# `
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1572
|
+
# issue might prevent you from getting a response from `StopModel`. In
|
1573
|
+
# this case, safely retry your call to `StopModel` by using the same
|
1574
|
+
# `ClientToken` parameter value.
|
1575
|
+
#
|
1576
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1577
|
+
# using inserts a value for you. This prevents retries after a network
|
1578
|
+
# error from making multiple stop requests. You'll need to provide your
|
1579
|
+
# own value for other use cases.
|
1580
|
+
#
|
1581
|
+
# An error occurs if the other input parameters are not the same as in
|
1582
|
+
# the first request. Using a different value for `ClientToken` is
|
1583
|
+
# considered a new call to `StopModel`. An idempotency token is active
|
1584
|
+
# for 8 hours.
|
1265
1585
|
#
|
1266
1586
|
# **A suitable default value is auto-generated.** You should normally
|
1267
1587
|
# not need to pass this option.**
|
@@ -1359,9 +1679,22 @@ module Aws::LookoutforVision
|
|
1359
1679
|
req.send_request(options)
|
1360
1680
|
end
|
1361
1681
|
|
1362
|
-
# Adds one or more JSON Line entries
|
1363
|
-
# information about an image used for training or testing
|
1364
|
-
# Lookout for Vision model.
|
1682
|
+
# Adds or updates one or more JSON Line entries in a dataset. A JSON
|
1683
|
+
# Line includes information about an image used for training or testing
|
1684
|
+
# an Amazon Lookout for Vision model.
|
1685
|
+
#
|
1686
|
+
# To update an existing JSON Line, use the `source-ref` field to
|
1687
|
+
# identify the JSON Line. The JSON line that you supply replaces the
|
1688
|
+
# existing JSON line. Any existing annotations that are not in the new
|
1689
|
+
# JSON line are removed from the dataset.
|
1690
|
+
#
|
1691
|
+
# For more information, see *Defining JSON lines for anomaly
|
1692
|
+
# classification* in the Amazon Lookout for Vision Developer Guide.
|
1693
|
+
#
|
1694
|
+
# <note markdown="1"> The images you reference in the `source-ref` field of a JSON line,
|
1695
|
+
# must be in the same S3 bucket as the existing images in the dataset.
|
1696
|
+
#
|
1697
|
+
# </note>
|
1365
1698
|
#
|
1366
1699
|
# Updating a dataset might take a while to complete. To check the
|
1367
1700
|
# current status, call DescribeDataset and check the `Status` field in
|
@@ -1385,13 +1718,20 @@ module Aws::LookoutforVision
|
|
1385
1718
|
# @option params [String] :client_token
|
1386
1719
|
# ClientToken is an idempotency token that ensures a call to
|
1387
1720
|
# `UpdateDatasetEntries` completes only once. You choose the value to
|
1388
|
-
# pass. For example, An issue
|
1389
|
-
#
|
1390
|
-
#
|
1391
|
-
#
|
1392
|
-
#
|
1393
|
-
# value for `ClientToken
|
1394
|
-
#
|
1721
|
+
# pass. For example, An issue might prevent you from getting a response
|
1722
|
+
# from `UpdateDatasetEntries`. In this case, safely retry your call to
|
1723
|
+
# `UpdateDatasetEntries` by using the same `ClientToken` parameter
|
1724
|
+
# value.
|
1725
|
+
#
|
1726
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1727
|
+
# using inserts a value for you. This prevents retries after a network
|
1728
|
+
# error from making multiple updates with the same dataset entries.
|
1729
|
+
# You'll need to provide your own value for other use cases.
|
1730
|
+
#
|
1731
|
+
# An error occurs if the other input parameters are not the same as in
|
1732
|
+
# the first request. Using a different value for `ClientToken` is
|
1733
|
+
# considered a new call to `UpdateDatasetEntries`. An idempotency token
|
1734
|
+
# is active for 8 hours.
|
1395
1735
|
#
|
1396
1736
|
# **A suitable default value is auto-generated.** You should normally
|
1397
1737
|
# not need to pass this option.**
|
@@ -1435,7 +1775,7 @@ module Aws::LookoutforVision
|
|
1435
1775
|
params: params,
|
1436
1776
|
config: config)
|
1437
1777
|
context[:gem_name] = 'aws-sdk-lookoutforvision'
|
1438
|
-
context[:gem_version] = '1.
|
1778
|
+
context[:gem_version] = '1.12.0'
|
1439
1779
|
Seahorse::Client::Request.new(handlers, context)
|
1440
1780
|
end
|
1441
1781
|
|