aws-sdk-lookoutforvision 1.6.0 → 1.10.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-lookoutforvision/client.rb +396 -58
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 446189a83782c64c61bc282c7cd7cba09bc694ee79df5b99a6d4b6500a4c2325
|
4
|
+
data.tar.gz: cc99773d20c2a7a7a32c64fcfbbb5b81361b1384e2aacce9de342cc46c3b6898
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d7ec743495dc40168153e391b6478e1501adc8d88b750aa69b82939a231138aa16575e950e84cc9ae6040b1743ee94af4e3a542dffbc425334c414728b4a99dd
|
7
|
+
data.tar.gz: b8294bc7a5bad2473dda6c64a71ce47cdd830bd74d233d37157efb208b480f4b22a0198cf132d938f880b43500630986f76076cfaa68cb206eb90798935b5c95
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.10.0 (2021-12-08)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds new APIs for packaging an Amazon Lookout for Vision model as an AWS IoT Greengrass component.
|
8
|
+
|
9
|
+
1.9.0 (2021-11-30)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.8.0 (2021-11-04)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.7.0 (2021-10-18)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.6.0 (2021-09-01)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.10.0
|
@@ -119,7 +119,9 @@ module Aws::LookoutforVision
|
|
119
119
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
120
|
# are very aggressive. Construct and pass an instance of
|
121
121
|
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
-
# enable retries and extended timeouts.
|
122
|
+
# enable retries and extended timeouts. Instance profile credential
|
123
|
+
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
124
|
+
# to true.
|
123
125
|
#
|
124
126
|
# @option options [required, String] :region
|
125
127
|
# The AWS region to connect to. The configured `:region` is
|
@@ -275,6 +277,15 @@ module Aws::LookoutforVision
|
|
275
277
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
276
278
|
# requests are made, and retries are disabled.
|
277
279
|
#
|
280
|
+
# @option options [Boolean] :use_dualstack_endpoint
|
281
|
+
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
282
|
+
# will be used if available.
|
283
|
+
#
|
284
|
+
# @option options [Boolean] :use_fips_endpoint
|
285
|
+
# When set to `true`, fips compatible endpoints will be used if available.
|
286
|
+
# When a `fips` region is used, the region is normalized and this config
|
287
|
+
# is set to `true`.
|
288
|
+
#
|
278
289
|
# @option options [Boolean] :validate_params (true)
|
279
290
|
# When `true`, request parameters are validated before
|
280
291
|
# sending the request.
|
@@ -366,11 +377,17 @@ module Aws::LookoutforVision
|
|
366
377
|
# @option params [String] :client_token
|
367
378
|
# ClientToken is an idempotency token that ensures a call to
|
368
379
|
# `CreateDataset` completes only once. You choose the value to pass. For
|
369
|
-
# example, An issue
|
370
|
-
#
|
371
|
-
#
|
372
|
-
#
|
373
|
-
#
|
380
|
+
# example, An issue might prevent you from getting a response from
|
381
|
+
# `CreateDataset`. In this case, safely retry your call to
|
382
|
+
# `CreateDataset` by using the same `ClientToken` parameter value.
|
383
|
+
#
|
384
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
385
|
+
# using inserts a value for you. This prevents retries after a network
|
386
|
+
# error from making multiple dataset creation requests. You'll need to
|
387
|
+
# provide your own value for other use cases.
|
388
|
+
#
|
389
|
+
# An error occurs if the other input parameters are not the same as in
|
390
|
+
# the first request. Using a different value for `ClientToken` is
|
374
391
|
# considered a new call to `CreateDataset`. An idempotency token is
|
375
392
|
# active for 8 hours.
|
376
393
|
#
|
@@ -444,9 +461,15 @@ module Aws::LookoutforVision
|
|
444
461
|
# @option params [String] :client_token
|
445
462
|
# ClientToken is an idempotency token that ensures a call to
|
446
463
|
# `CreateModel` completes only once. You choose the value to pass. For
|
447
|
-
# example, An issue
|
448
|
-
#
|
449
|
-
#
|
464
|
+
# example, An issue might prevent you from getting a response from
|
465
|
+
# `CreateModel`. In this case, safely retry your call to `CreateModel`
|
466
|
+
# by using the same `ClientToken` parameter value.
|
467
|
+
#
|
468
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
469
|
+
# using inserts a value for you. This prevents retries after a network
|
470
|
+
# error from starting multiple training jobs. You'll need to provide
|
471
|
+
# your own value for other use cases.
|
472
|
+
#
|
450
473
|
# An error occurs if the other input parameters are not the same as in
|
451
474
|
# the first request. Using a different value for `ClientToken` is
|
452
475
|
# considered a new call to `CreateModel`. An idempotency token is active
|
@@ -460,11 +483,10 @@ module Aws::LookoutforVision
|
|
460
483
|
# results.
|
461
484
|
#
|
462
485
|
# @option params [String] :kms_key_id
|
463
|
-
# The identifier for your AWS
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
# encrypted by a key that AWS owns and manages.
|
486
|
+
# The identifier for your AWS KMS key. The key is used to encrypt
|
487
|
+
# training and test images copied into the service for model training.
|
488
|
+
# Your source images are unaffected. If this parameter is not specified,
|
489
|
+
# the copied images are encrypted by a key that AWS owns and manages.
|
468
490
|
#
|
469
491
|
# @option params [Array<Types::Tag>] :tags
|
470
492
|
# A set of tags (key-value pairs) that you want to attach to the model.
|
@@ -527,11 +549,17 @@ module Aws::LookoutforVision
|
|
527
549
|
# @option params [String] :client_token
|
528
550
|
# ClientToken is an idempotency token that ensures a call to
|
529
551
|
# `CreateProject` completes only once. You choose the value to pass. For
|
530
|
-
# example, An issue
|
531
|
-
#
|
532
|
-
#
|
533
|
-
#
|
534
|
-
#
|
552
|
+
# example, An issue might prevent you from getting a response from
|
553
|
+
# `CreateProject`. In this case, safely retry your call to
|
554
|
+
# `CreateProject` by using the same `ClientToken` parameter value.
|
555
|
+
#
|
556
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
557
|
+
# using inserts a value for you. This prevents retries after a network
|
558
|
+
# error from making multiple project creation requests. You'll need to
|
559
|
+
# provide your own value for other use cases.
|
560
|
+
#
|
561
|
+
# An error occurs if the other input parameters are not the same as in
|
562
|
+
# the first request. Using a different value for `ClientToken` is
|
535
563
|
# considered a new call to `CreateProject`. An idempotency token is
|
536
564
|
# active for 8 hours.
|
537
565
|
#
|
@@ -595,11 +623,17 @@ module Aws::LookoutforVision
|
|
595
623
|
# @option params [String] :client_token
|
596
624
|
# ClientToken is an idempotency token that ensures a call to
|
597
625
|
# `DeleteDataset` completes only once. You choose the value to pass. For
|
598
|
-
# example, An issue
|
599
|
-
#
|
600
|
-
#
|
601
|
-
#
|
602
|
-
#
|
626
|
+
# example, An issue might prevent you from getting a response from
|
627
|
+
# `DeleteDataset`. In this case, safely retry your call to
|
628
|
+
# `DeleteDataset` by using the same `ClientToken` parameter value.
|
629
|
+
#
|
630
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
631
|
+
# using inserts a value for you. This prevents retries after a network
|
632
|
+
# error from making multiple deletetion requests. You'll need to
|
633
|
+
# provide your own value for other use cases.
|
634
|
+
#
|
635
|
+
# An error occurs if the other input parameters are not the same as in
|
636
|
+
# the first request. Using a different value for `ClientToken` is
|
603
637
|
# considered a new call to `DeleteDataset`. An idempotency token is
|
604
638
|
# active for 8 hours.
|
605
639
|
#
|
@@ -629,9 +663,11 @@ module Aws::LookoutforVision
|
|
629
663
|
# running model. To stop a running model, use the StopModel operation.
|
630
664
|
#
|
631
665
|
# It might take a few seconds to delete a model. To determine if a model
|
632
|
-
# has been deleted, call
|
666
|
+
# has been deleted, call ListModels and check if the version of the
|
633
667
|
# model (`ModelVersion`) is in the `Models` array.
|
634
668
|
#
|
669
|
+
#
|
670
|
+
#
|
635
671
|
# This operation requires permissions to perform the
|
636
672
|
# `lookoutvision:DeleteModel` operation.
|
637
673
|
#
|
@@ -645,9 +681,15 @@ module Aws::LookoutforVision
|
|
645
681
|
# @option params [String] :client_token
|
646
682
|
# ClientToken is an idempotency token that ensures a call to
|
647
683
|
# `DeleteModel` completes only once. You choose the value to pass. For
|
648
|
-
# example,
|
649
|
-
#
|
650
|
-
#
|
684
|
+
# example, an issue might prevent you from getting a response from
|
685
|
+
# `DeleteModel`. In this case, safely retry your call to `DeleteModel`
|
686
|
+
# by using the same `ClientToken` parameter value.
|
687
|
+
#
|
688
|
+
# If you don't supply a value for ClientToken, the AWS SDK you are
|
689
|
+
# using inserts a value for you. This prevents retries after a network
|
690
|
+
# error from making multiple model deletion requests. You'll need to
|
691
|
+
# provide your own value for other use cases.
|
692
|
+
#
|
651
693
|
# An error occurs if the other input parameters are not the same as in
|
652
694
|
# the first request. Using a different value for `ClientToken` is
|
653
695
|
# considered a new call to `DeleteModel`. An idempotency token is active
|
@@ -664,7 +706,7 @@ module Aws::LookoutforVision
|
|
664
706
|
#
|
665
707
|
# resp = client.delete_model({
|
666
708
|
# project_name: "ProjectName", # required
|
667
|
-
# model_version: "
|
709
|
+
# model_version: "ModelVersionNoLatest", # required
|
668
710
|
# client_token: "ClientToken",
|
669
711
|
# })
|
670
712
|
#
|
@@ -700,11 +742,17 @@ module Aws::LookoutforVision
|
|
700
742
|
# @option params [String] :client_token
|
701
743
|
# ClientToken is an idempotency token that ensures a call to
|
702
744
|
# `DeleteProject` completes only once. You choose the value to pass. For
|
703
|
-
# example, An issue
|
704
|
-
#
|
705
|
-
#
|
706
|
-
#
|
707
|
-
#
|
745
|
+
# example, An issue might prevent you from getting a response from
|
746
|
+
# `DeleteProject`. In this case, safely retry your call to
|
747
|
+
# `DeleteProject` by using the same `ClientToken` parameter value.
|
748
|
+
#
|
749
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
750
|
+
# using inserts a value for you. This prevents retries after a network
|
751
|
+
# error from making multiple project deletion requests. You'll need to
|
752
|
+
# provide your own value for other use cases.
|
753
|
+
#
|
754
|
+
# An error occurs if the other input parameters are not the same as in
|
755
|
+
# the first request. Using a different value for `ClientToken` is
|
708
756
|
# considered a new call to `DeleteProject`. An idempotency token is
|
709
757
|
# active for 8 hours.
|
710
758
|
#
|
@@ -834,6 +882,69 @@ module Aws::LookoutforVision
|
|
834
882
|
req.send_request(options)
|
835
883
|
end
|
836
884
|
|
885
|
+
# Describes an Amazon Lookout for Vision model packaging job.
|
886
|
+
#
|
887
|
+
# This operation requires permissions to perform the
|
888
|
+
# `lookoutvision:DescribeModelPackagingJob` operation.
|
889
|
+
#
|
890
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
891
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
892
|
+
#
|
893
|
+
# @option params [required, String] :project_name
|
894
|
+
# The name of the project that contains the model packaging job that you
|
895
|
+
# want to describe.
|
896
|
+
#
|
897
|
+
# @option params [required, String] :job_name
|
898
|
+
# The job name for the model packaging job.
|
899
|
+
#
|
900
|
+
# @return [Types::DescribeModelPackagingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
901
|
+
#
|
902
|
+
# * {Types::DescribeModelPackagingJobResponse#model_packaging_description #model_packaging_description} => Types::ModelPackagingDescription
|
903
|
+
#
|
904
|
+
# @example Request syntax with placeholder values
|
905
|
+
#
|
906
|
+
# resp = client.describe_model_packaging_job({
|
907
|
+
# project_name: "ProjectName", # required
|
908
|
+
# job_name: "ModelPackagingJobName", # required
|
909
|
+
# })
|
910
|
+
#
|
911
|
+
# @example Response structure
|
912
|
+
#
|
913
|
+
# resp.model_packaging_description.job_name #=> String
|
914
|
+
# resp.model_packaging_description.project_name #=> String
|
915
|
+
# resp.model_packaging_description.model_version #=> String
|
916
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.compiler_options #=> String
|
917
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_device #=> String, one of "jetson_xavier"
|
918
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.os #=> String, one of "LINUX"
|
919
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.arch #=> String, one of "ARM64", "X86_64"
|
920
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.target_platform.accelerator #=> String, one of "NVIDIA"
|
921
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.s3_output_location.bucket #=> String
|
922
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.s3_output_location.prefix #=> String
|
923
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_name #=> String
|
924
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_version #=> String
|
925
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.component_description #=> String
|
926
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags #=> Array
|
927
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags[0].key #=> String
|
928
|
+
# resp.model_packaging_description.model_packaging_configuration.greengrass.tags[0].value #=> String
|
929
|
+
# resp.model_packaging_description.model_packaging_job_description #=> String
|
930
|
+
# resp.model_packaging_description.model_packaging_method #=> String
|
931
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_version_arn #=> String
|
932
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_name #=> String
|
933
|
+
# resp.model_packaging_description.model_packaging_output_details.greengrass.component_version #=> String
|
934
|
+
# resp.model_packaging_description.status #=> String, one of "CREATED", "RUNNING", "SUCCEEDED", "FAILED"
|
935
|
+
# resp.model_packaging_description.status_message #=> String
|
936
|
+
# resp.model_packaging_description.creation_timestamp #=> Time
|
937
|
+
# resp.model_packaging_description.last_updated_timestamp #=> Time
|
938
|
+
#
|
939
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/DescribeModelPackagingJob AWS API Documentation
|
940
|
+
#
|
941
|
+
# @overload describe_model_packaging_job(params = {})
|
942
|
+
# @param [Hash] params ({})
|
943
|
+
def describe_model_packaging_job(params = {}, options = {})
|
944
|
+
req = build_request(:describe_model_packaging_job, params)
|
945
|
+
req.send_request(options)
|
946
|
+
end
|
947
|
+
|
837
948
|
# Describes an Amazon Lookout for Vision project.
|
838
949
|
#
|
839
950
|
# This operation requires permissions to perform the
|
@@ -1017,8 +1128,75 @@ module Aws::LookoutforVision
|
|
1017
1128
|
req.send_request(options)
|
1018
1129
|
end
|
1019
1130
|
|
1131
|
+
# Lists the model packaging jobs created for an Amazon Lookout for
|
1132
|
+
# Vision project.
|
1133
|
+
#
|
1134
|
+
# This operation requires permissions to perform the
|
1135
|
+
# `lookoutvision:ListModelPackagingJobs` operation.
|
1136
|
+
#
|
1137
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
1138
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
1139
|
+
#
|
1140
|
+
# @option params [required, String] :project_name
|
1141
|
+
# The name of the project for which you want to list the model packaging
|
1142
|
+
# jobs.
|
1143
|
+
#
|
1144
|
+
# @option params [String] :next_token
|
1145
|
+
# If the previous response was incomplete (because there is more results
|
1146
|
+
# to retrieve), Amazon Lookout for Vision returns a pagination token in
|
1147
|
+
# the response. You can use this pagination token to retrieve the next
|
1148
|
+
# set of results.
|
1149
|
+
#
|
1150
|
+
# @option params [Integer] :max_results
|
1151
|
+
# The maximum number of results to return per paginated call. The
|
1152
|
+
# largest value you can specify is 100. If you specify a value greater
|
1153
|
+
# than 100, a ValidationException error occurs. The default value is
|
1154
|
+
# 100.
|
1155
|
+
#
|
1156
|
+
# @return [Types::ListModelPackagingJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1157
|
+
#
|
1158
|
+
# * {Types::ListModelPackagingJobsResponse#model_packaging_jobs #model_packaging_jobs} => Array<Types::ModelPackagingJobMetadata>
|
1159
|
+
# * {Types::ListModelPackagingJobsResponse#next_token #next_token} => String
|
1160
|
+
#
|
1161
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1162
|
+
#
|
1163
|
+
# @example Request syntax with placeholder values
|
1164
|
+
#
|
1165
|
+
# resp = client.list_model_packaging_jobs({
|
1166
|
+
# project_name: "ProjectName", # required
|
1167
|
+
# next_token: "PaginationToken",
|
1168
|
+
# max_results: 1,
|
1169
|
+
# })
|
1170
|
+
#
|
1171
|
+
# @example Response structure
|
1172
|
+
#
|
1173
|
+
# resp.model_packaging_jobs #=> Array
|
1174
|
+
# resp.model_packaging_jobs[0].job_name #=> String
|
1175
|
+
# resp.model_packaging_jobs[0].project_name #=> String
|
1176
|
+
# resp.model_packaging_jobs[0].model_version #=> String
|
1177
|
+
# resp.model_packaging_jobs[0].model_packaging_job_description #=> String
|
1178
|
+
# resp.model_packaging_jobs[0].model_packaging_method #=> String
|
1179
|
+
# resp.model_packaging_jobs[0].status #=> String, one of "CREATED", "RUNNING", "SUCCEEDED", "FAILED"
|
1180
|
+
# resp.model_packaging_jobs[0].status_message #=> String
|
1181
|
+
# resp.model_packaging_jobs[0].creation_timestamp #=> Time
|
1182
|
+
# resp.model_packaging_jobs[0].last_updated_timestamp #=> Time
|
1183
|
+
# resp.next_token #=> String
|
1184
|
+
#
|
1185
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/ListModelPackagingJobs AWS API Documentation
|
1186
|
+
#
|
1187
|
+
# @overload list_model_packaging_jobs(params = {})
|
1188
|
+
# @param [Hash] params ({})
|
1189
|
+
def list_model_packaging_jobs(params = {}, options = {})
|
1190
|
+
req = build_request(:list_model_packaging_jobs, params)
|
1191
|
+
req.send_request(options)
|
1192
|
+
end
|
1193
|
+
|
1020
1194
|
# Lists the versions of a model in an Amazon Lookout for Vision project.
|
1021
1195
|
#
|
1196
|
+
# The `ListModels` operation is eventually consistent. Recent calls to
|
1197
|
+
# `CreateModel` might take a while to appear in the response from
|
1198
|
+
# `ListProjects`.
|
1199
|
+
#
|
1022
1200
|
# This operation requires permissions to perform the
|
1023
1201
|
# `lookoutvision:ListModels` operation.
|
1024
1202
|
#
|
@@ -1078,6 +1256,10 @@ module Aws::LookoutforVision
|
|
1078
1256
|
|
1079
1257
|
# Lists the Amazon Lookout for Vision projects in your AWS account.
|
1080
1258
|
#
|
1259
|
+
# The `ListProjects` operation is eventually consistent. Recent calls to
|
1260
|
+
# `CreateProject` and `DeleteProject` might take a while to appear in
|
1261
|
+
# the response from `ListProjects`.
|
1262
|
+
#
|
1081
1263
|
# This operation requires permissions to perform the
|
1082
1264
|
# `lookoutvision:ListProjects` operation.
|
1083
1265
|
#
|
@@ -1185,17 +1367,22 @@ module Aws::LookoutforVision
|
|
1185
1367
|
#
|
1186
1368
|
# @option params [required, Integer] :min_inference_units
|
1187
1369
|
# The minimum number of inference units to use. A single inference unit
|
1188
|
-
# represents 1 hour of processing
|
1189
|
-
#
|
1190
|
-
#
|
1191
|
-
# you use.
|
1370
|
+
# represents 1 hour of processing. Use a higher number to increase the
|
1371
|
+
# TPS throughput of your model. You are charged for the number of
|
1372
|
+
# inference units that you use.
|
1192
1373
|
#
|
1193
1374
|
# @option params [String] :client_token
|
1194
1375
|
# ClientToken is an idempotency token that ensures a call to
|
1195
1376
|
# `StartModel` completes only once. You choose the value to pass. For
|
1196
|
-
# example, An issue
|
1197
|
-
#
|
1198
|
-
#
|
1377
|
+
# example, An issue might prevent you from getting a response from
|
1378
|
+
# `StartModel`. In this case, safely retry your call to `StartModel` by
|
1379
|
+
# using the same `ClientToken` parameter value.
|
1380
|
+
#
|
1381
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1382
|
+
# using inserts a value for you. This prevents retries after a network
|
1383
|
+
# error from making multiple start requests. You'll need to provide
|
1384
|
+
# your own value for other use cases.
|
1385
|
+
#
|
1199
1386
|
# An error occurs if the other input parameters are not the same as in
|
1200
1387
|
# the first request. Using a different value for `ClientToken` is
|
1201
1388
|
# considered a new call to `StartModel`. An idempotency token is active
|
@@ -1230,6 +1417,130 @@ module Aws::LookoutforVision
|
|
1230
1417
|
req.send_request(options)
|
1231
1418
|
end
|
1232
1419
|
|
1420
|
+
# Starts an Amazon Lookout for Vision model packaging job. A model
|
1421
|
+
# packaging job creates an AWS IoT Greengrass component for a Lookout
|
1422
|
+
# for Vision model. You can use the component to deploy your model to an
|
1423
|
+
# edge device managed by Greengrass.
|
1424
|
+
#
|
1425
|
+
# Use the DescribeModelPackagingJob API to determine the current status
|
1426
|
+
# of the job. The model packaging job is complete if the value of
|
1427
|
+
# `Status` is `SUCCEEDED`.
|
1428
|
+
#
|
1429
|
+
# To deploy the component to the target device, use the component name
|
1430
|
+
# and component version with the AWS IoT Greengrass
|
1431
|
+
# [CreateDeployment][1] API.
|
1432
|
+
#
|
1433
|
+
# This operation requires the following permissions:
|
1434
|
+
#
|
1435
|
+
# * `lookoutvision:StartModelPackagingJobs`
|
1436
|
+
#
|
1437
|
+
# * `s3:PutObject`
|
1438
|
+
#
|
1439
|
+
# * `s3:GetBucketLocation`
|
1440
|
+
#
|
1441
|
+
# * `greengrass:CreateComponentVersion`
|
1442
|
+
#
|
1443
|
+
# * `greengrass:DescribeComponent`
|
1444
|
+
#
|
1445
|
+
# * (Optional) `greengrass:TagResource`. Only required if you want to
|
1446
|
+
# tag the component.
|
1447
|
+
#
|
1448
|
+
# For more information, see *Using your Amazon Lookout for Vision model
|
1449
|
+
# on an edge device* in the Amazon Lookout for Vision Developer Guide.
|
1450
|
+
#
|
1451
|
+
#
|
1452
|
+
#
|
1453
|
+
# [1]: https://docs.aws.amazon.com/greengrass/v2/APIReference/API_CreateDeployment.html
|
1454
|
+
#
|
1455
|
+
# @option params [required, String] :project_name
|
1456
|
+
# The name of the project which contains the version of the model that
|
1457
|
+
# you want to package.
|
1458
|
+
#
|
1459
|
+
# @option params [required, String] :model_version
|
1460
|
+
# The version of the model within the project that you want to package.
|
1461
|
+
#
|
1462
|
+
# @option params [String] :job_name
|
1463
|
+
# A name for the model packaging job. If you don't supply a value, the
|
1464
|
+
# service creates a job name for you.
|
1465
|
+
#
|
1466
|
+
# @option params [required, Types::ModelPackagingConfiguration] :configuration
|
1467
|
+
# The configuration for the model packaging job.
|
1468
|
+
#
|
1469
|
+
# @option params [String] :description
|
1470
|
+
# A description for the model packaging job.
|
1471
|
+
#
|
1472
|
+
# @option params [String] :client_token
|
1473
|
+
# ClientToken is an idempotency token that ensures a call to
|
1474
|
+
# `StartModelPackagingJob` completes only once. You choose the value to
|
1475
|
+
# pass. For example, An issue might prevent you from getting a response
|
1476
|
+
# from `StartModelPackagingJob`. In this case, safely retry your call to
|
1477
|
+
# `StartModelPackagingJob` by using the same `ClientToken` parameter
|
1478
|
+
# value.
|
1479
|
+
#
|
1480
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1481
|
+
# using inserts a value for you. This prevents retries after a network
|
1482
|
+
# error from making multiple dataset creation requests. You'll need to
|
1483
|
+
# provide your own value for other use cases.
|
1484
|
+
#
|
1485
|
+
# An error occurs if the other input parameters are not the same as in
|
1486
|
+
# the first request. Using a different value for `ClientToken` is
|
1487
|
+
# considered a new call to `StartModelPackagingJob`. An idempotency
|
1488
|
+
# token is active for 8 hours.
|
1489
|
+
#
|
1490
|
+
# **A suitable default value is auto-generated.** You should normally
|
1491
|
+
# not need to pass this option.**
|
1492
|
+
#
|
1493
|
+
# @return [Types::StartModelPackagingJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1494
|
+
#
|
1495
|
+
# * {Types::StartModelPackagingJobResponse#job_name #job_name} => String
|
1496
|
+
#
|
1497
|
+
# @example Request syntax with placeholder values
|
1498
|
+
#
|
1499
|
+
# resp = client.start_model_packaging_job({
|
1500
|
+
# project_name: "ProjectName", # required
|
1501
|
+
# model_version: "ModelVersion", # required
|
1502
|
+
# job_name: "ModelPackagingJobName",
|
1503
|
+
# configuration: { # required
|
1504
|
+
# greengrass: { # required
|
1505
|
+
# compiler_options: "CompilerOptions", # required
|
1506
|
+
# target_device: "jetson_xavier", # accepts jetson_xavier
|
1507
|
+
# target_platform: {
|
1508
|
+
# os: "LINUX", # required, accepts LINUX
|
1509
|
+
# arch: "ARM64", # required, accepts ARM64, X86_64
|
1510
|
+
# accelerator: "NVIDIA", # required, accepts NVIDIA
|
1511
|
+
# },
|
1512
|
+
# s3_output_location: { # required
|
1513
|
+
# bucket: "S3BucketName", # required
|
1514
|
+
# prefix: "S3KeyPrefix",
|
1515
|
+
# },
|
1516
|
+
# component_name: "ComponentName", # required
|
1517
|
+
# component_version: "ComponentVersion",
|
1518
|
+
# component_description: "ComponentDescription",
|
1519
|
+
# tags: [
|
1520
|
+
# {
|
1521
|
+
# key: "TagKey", # required
|
1522
|
+
# value: "TagValue", # required
|
1523
|
+
# },
|
1524
|
+
# ],
|
1525
|
+
# },
|
1526
|
+
# },
|
1527
|
+
# description: "ModelPackagingJobDescription",
|
1528
|
+
# client_token: "ClientToken",
|
1529
|
+
# })
|
1530
|
+
#
|
1531
|
+
# @example Response structure
|
1532
|
+
#
|
1533
|
+
# resp.job_name #=> String
|
1534
|
+
#
|
1535
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/lookoutvision-2020-11-20/StartModelPackagingJob AWS API Documentation
|
1536
|
+
#
|
1537
|
+
# @overload start_model_packaging_job(params = {})
|
1538
|
+
# @param [Hash] params ({})
|
1539
|
+
def start_model_packaging_job(params = {}, options = {})
|
1540
|
+
req = build_request(:start_model_packaging_job, params)
|
1541
|
+
req.send_request(options)
|
1542
|
+
end
|
1543
|
+
|
1233
1544
|
# Stops the hosting of a running model. The operation might take a while
|
1234
1545
|
# to complete. To check the current status, call DescribeModel.
|
1235
1546
|
#
|
@@ -1247,12 +1558,19 @@ module Aws::LookoutforVision
|
|
1247
1558
|
# @option params [String] :client_token
|
1248
1559
|
# ClientToken is an idempotency token that ensures a call to `StopModel`
|
1249
1560
|
# completes only once. You choose the value to pass. For example, An
|
1250
|
-
# issue
|
1251
|
-
#
|
1252
|
-
# `
|
1253
|
-
#
|
1254
|
-
#
|
1255
|
-
#
|
1561
|
+
# issue might prevent you from getting a response from `StopModel`. In
|
1562
|
+
# this case, safely retry your call to `StopModel` by using the same
|
1563
|
+
# `ClientToken` parameter value.
|
1564
|
+
#
|
1565
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1566
|
+
# using inserts a value for you. This prevents retries after a network
|
1567
|
+
# error from making multiple stop requests. You'll need to provide your
|
1568
|
+
# own value for other use cases.
|
1569
|
+
#
|
1570
|
+
# An error occurs if the other input parameters are not the same as in
|
1571
|
+
# the first request. Using a different value for `ClientToken` is
|
1572
|
+
# considered a new call to `StopModel`. An idempotency token is active
|
1573
|
+
# for 8 hours.
|
1256
1574
|
#
|
1257
1575
|
# **A suitable default value is auto-generated.** You should normally
|
1258
1576
|
# not need to pass this option.**
|
@@ -1350,9 +1668,22 @@ module Aws::LookoutforVision
|
|
1350
1668
|
req.send_request(options)
|
1351
1669
|
end
|
1352
1670
|
|
1353
|
-
# Adds one or more JSON Line entries
|
1354
|
-
# information about an image used for training or testing
|
1355
|
-
# Lookout for Vision model.
|
1671
|
+
# Adds or updates one or more JSON Line entries in a dataset. A JSON
|
1672
|
+
# Line includes information about an image used for training or testing
|
1673
|
+
# an Amazon Lookout for Vision model.
|
1674
|
+
#
|
1675
|
+
# To update an existing JSON Line, use the `source-ref` field to
|
1676
|
+
# identify the JSON Line. The JSON line that you supply replaces the
|
1677
|
+
# existing JSON line. Any existing annotations that are not in the new
|
1678
|
+
# JSON line are removed from the dataset.
|
1679
|
+
#
|
1680
|
+
# For more information, see *Defining JSON lines for anomaly
|
1681
|
+
# classification* in the Amazon Lookout for Vision Developer Guide.
|
1682
|
+
#
|
1683
|
+
# <note markdown="1"> The images you reference in the `source-ref` field of a JSON line,
|
1684
|
+
# must be in the same S3 bucket as the existing images in the dataset.
|
1685
|
+
#
|
1686
|
+
# </note>
|
1356
1687
|
#
|
1357
1688
|
# Updating a dataset might take a while to complete. To check the
|
1358
1689
|
# current status, call DescribeDataset and check the `Status` field in
|
@@ -1376,13 +1707,20 @@ module Aws::LookoutforVision
|
|
1376
1707
|
# @option params [String] :client_token
|
1377
1708
|
# ClientToken is an idempotency token that ensures a call to
|
1378
1709
|
# `UpdateDatasetEntries` completes only once. You choose the value to
|
1379
|
-
# pass. For example, An issue
|
1380
|
-
#
|
1381
|
-
#
|
1382
|
-
#
|
1383
|
-
#
|
1384
|
-
# value for `ClientToken
|
1385
|
-
#
|
1710
|
+
# pass. For example, An issue might prevent you from getting a response
|
1711
|
+
# from `UpdateDatasetEntries`. In this case, safely retry your call to
|
1712
|
+
# `UpdateDatasetEntries` by using the same `ClientToken` parameter
|
1713
|
+
# value.
|
1714
|
+
#
|
1715
|
+
# If you don't supply a value for `ClientToken`, the AWS SDK you are
|
1716
|
+
# using inserts a value for you. This prevents retries after a network
|
1717
|
+
# error from making multiple updates with the same dataset entries.
|
1718
|
+
# You'll need to provide your own value for other use cases.
|
1719
|
+
#
|
1720
|
+
# An error occurs if the other input parameters are not the same as in
|
1721
|
+
# the first request. Using a different value for `ClientToken` is
|
1722
|
+
# considered a new call to `UpdateDatasetEntries`. An idempotency token
|
1723
|
+
# is active for 8 hours.
|
1386
1724
|
#
|
1387
1725
|
# **A suitable default value is auto-generated.** You should normally
|
1388
1726
|
# not need to pass this option.**
|
@@ -1426,7 +1764,7 @@ module Aws::LookoutforVision
|
|
1426
1764
|
params: params,
|
1427
1765
|
config: config)
|
1428
1766
|
context[:gem_name] = 'aws-sdk-lookoutforvision'
|
1429
|
-
context[:gem_version] = '1.
|
1767
|
+
context[:gem_version] = '1.10.0'
|
1430
1768
|
Seahorse::Client::Request.new(handlers, context)
|
1431
1769
|
end
|
1432
1770
|
|