Class: Aws::LookoutforVision::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::LookoutforVision::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb
Overview
An API client for LookoutforVision. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::LookoutforVision::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new dataset in an Amazon Lookout for Vision project.
-
#create_model(params = {}) ⇒ Types::CreateModelResponse
Creates a new version of a model within an an Amazon Lookout for Vision project.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates an empty Amazon Lookout for Vision project.
-
#delete_dataset(params = {}) ⇒ Struct
Deletes an existing Amazon Lookout for Vision
dataset
. -
#delete_model(params = {}) ⇒ Types::DeleteModelResponse
Deletes an Amazon Lookout for Vision model.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an Amazon Lookout for Vision project.
-
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describe an Amazon Lookout for Vision dataset.
-
#describe_model(params = {}) ⇒ Types::DescribeModelResponse
Describes a version of an Amazon Lookout for Vision model.
-
#describe_model_packaging_job(params = {}) ⇒ Types::DescribeModelPackagingJobResponse
Describes an Amazon Lookout for Vision model packaging job.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Describes an Amazon Lookout for Vision project.
-
#detect_anomalies(params = {}) ⇒ Types::DetectAnomaliesResponse
Detects anomalies in an image that you supply.
-
#list_dataset_entries(params = {}) ⇒ Types::ListDatasetEntriesResponse
Lists the JSON Lines within a dataset.
-
#list_model_packaging_jobs(params = {}) ⇒ Types::ListModelPackagingJobsResponse
Lists the model packaging jobs created for an Amazon Lookout for Vision project.
-
#list_models(params = {}) ⇒ Types::ListModelsResponse
Lists the versions of a model in an Amazon Lookout for Vision project.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call
ListProjects
. -
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags attached to the specified Amazon Lookout for Vision model.
-
#start_model(params = {}) ⇒ Types::StartModelResponse
Starts the running of the version of an Amazon Lookout for Vision model.
-
#start_model_packaging_job(params = {}) ⇒ Types::StartModelPackagingJobResponse
Starts an Amazon Lookout for Vision model packaging job.
-
#stop_model(params = {}) ⇒ Types::StopModelResponse
Stops the hosting of a running model.
-
#tag_resource(params = {}) ⇒ Struct
Adds one or more key-value tags to an Amazon Lookout for Vision model.
-
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Amazon Lookout for Vision model.
-
#update_dataset_entries(params = {}) ⇒ Types::UpdateDatasetEntriesResponse
Adds or updates one or more JSON Line entries in a dataset.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
422 423 424 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 422 def initialize(*args) super end |
Instance Method Details
#create_dataset(params = {}) ⇒ Types::CreateDatasetResponse
Creates a new dataset in an Amazon Lookout for Vision project.
CreateDataset
can create a training or a test dataset from a valid
dataset source (DatasetSource
).
If you want a single dataset project, specify train
for the value of
DatasetType
.
To have a project with separate training and test datasets, call
CreateDataset
twice. On the first call, specify train
for the
value of DatasetType
. On the second call, specify test
for the
value of DatasetType
.
This operation requires permissions to perform the
lookoutvision:CreateDataset
operation.
516 517 518 519 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 516 def create_dataset(params = {}, = {}) req = build_request(:create_dataset, params) req.send_request() end |
#create_model(params = {}) ⇒ Types::CreateModelResponse
Creates a new version of a model within an an Amazon Lookout for
Vision project. CreateModel
is an asynchronous operation in which
Amazon Lookout for Vision trains, tests, and evaluates a new version
of a model.
To get the current status, check the Status
field returned in the
response from DescribeModel.
If the project has a single dataset, Amazon Lookout for Vision internally splits the dataset to create a training and a test dataset. If the project has a training and a test dataset, Lookout for Vision uses the respective datasets to train and test the model.
After training completes, the evaluation metrics are stored at the
location specified in OutputConfig
.
This operation requires permissions to perform the
lookoutvision:CreateModel
operation. If you want to tag your model,
you also require permission to the lookoutvision:TagResource
operation.
622 623 624 625 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 622 def create_model(params = {}, = {}) req = build_request(:create_model, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.
This operation requires permissions to perform the
lookoutvision:CreateProject
operation.
677 678 679 680 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 677 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#delete_dataset(params = {}) ⇒ Struct
Deletes an existing Amazon Lookout for Vision dataset
.
If your the project has a single dataset, you must create a new dataset before you can create a model.
If you project has a training dataset and a test dataset consider the following.
If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.
If you delete the training dataset, you must create a training dataset before you can create a model.
This operation requires permissions to perform the
lookoutvision:DeleteDataset
operation.
744 745 746 747 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 744 def delete_dataset(params = {}, = {}) req = build_request(:delete_dataset, params) req.send_request() end |
#delete_model(params = {}) ⇒ Types::DeleteModelResponse
Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.
It might take a few seconds to delete a model. To determine if a model
has been deleted, call ListModels and check if the version of the
model (ModelVersion
) is in the Models
array.
This operation requires permissions to perform the
lookoutvision:DeleteModel
operation.
808 809 810 811 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 808 def delete_model(params = {}, = {}) req = build_request(:delete_model, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes an Amazon Lookout for Vision project.
To delete a project, you must first delete each version of the model associated with the project. To delete a model use the DeleteModel operation.
You also have to delete the dataset(s) associated with the model. For more information, see DeleteDataset. The images referenced by the training and test datasets aren't deleted.
This operation requires permissions to perform the
lookoutvision:DeleteProject
operation.
868 869 870 871 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 868 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#describe_dataset(params = {}) ⇒ Types::DescribeDatasetResponse
Describe an Amazon Lookout for Vision dataset.
This operation requires permissions to perform the
lookoutvision:DescribeDataset
operation.
915 916 917 918 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 915 def describe_dataset(params = {}, = {}) req = build_request(:describe_dataset, params) req.send_request() end |
#describe_model(params = {}) ⇒ Types::DescribeModelResponse
Describes a version of an Amazon Lookout for Vision model.
This operation requires permissions to perform the
lookoutvision:DescribeModel
operation.
969 970 971 972 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 969 def describe_model(params = {}, = {}) req = build_request(:describe_model, params) req.send_request() end |
#describe_model_packaging_job(params = {}) ⇒ Types::DescribeModelPackagingJobResponse
Describes an Amazon Lookout for Vision model packaging job.
This operation requires permissions to perform the
lookoutvision:DescribeModelPackagingJob
operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
1032 1033 1034 1035 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1032 def describe_model_packaging_job(params = {}, = {}) req = build_request(:describe_model_packaging_job, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResponse
Describes an Amazon Lookout for Vision project.
This operation requires permissions to perform the
lookoutvision:DescribeProject
operation.
1070 1071 1072 1073 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1070 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#detect_anomalies(params = {}) ⇒ Types::DetectAnomaliesResponse
Detects anomalies in an image that you supply.
The response from DetectAnomalies
includes a boolean prediction that
the image contains one or more anomalies and a confidence value for
the prediction. If the model is an image segmentation model, the
response also includes segmentation information for each type of
anomaly found in the image.
DetectAnomalies
, you must first start your model with
the StartModel operation. You are charged for the amount of time, in
minutes, that a model runs and for the number of anomaly detection
units that your model uses. If you are not using a model, use the
StopModel operation to stop your model.
For more information, see Detecting anomalies in an image in the Amazon Lookout for Vision developer guide.
This operation requires permissions to perform the
lookoutvision:DetectAnomalies
operation.
1139 1140 1141 1142 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1139 def detect_anomalies(params = {}, = {}) req = build_request(:detect_anomalies, params) req.send_request() end |
#list_dataset_entries(params = {}) ⇒ Types::ListDatasetEntriesResponse
Lists the JSON Lines within a dataset. An Amazon Lookout for Vision JSON Line contains the anomaly information for a single image, including the image location and the assigned label.
This operation requires permissions to perform the
lookoutvision:ListDatasetEntries
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1225 1226 1227 1228 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1225 def list_dataset_entries(params = {}, = {}) req = build_request(:list_dataset_entries, params) req.send_request() end |
#list_model_packaging_jobs(params = {}) ⇒ Types::ListModelPackagingJobsResponse
Lists the model packaging jobs created for an Amazon Lookout for Vision project.
This operation requires permissions to perform the
lookoutvision:ListModelPackagingJobs
operation.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1288 1289 1290 1291 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1288 def list_model_packaging_jobs(params = {}, = {}) req = build_request(:list_model_packaging_jobs, params) req.send_request() end |
#list_models(params = {}) ⇒ Types::ListModelsResponse
Lists the versions of a model in an Amazon Lookout for Vision project.
The ListModels
operation is eventually consistent. Recent calls to
CreateModel
might take a while to appear in the response from
ListProjects
.
This operation requires permissions to perform the
lookoutvision:ListModels
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1351 1352 1353 1354 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1351 def list_models(params = {}, = {}) req = build_request(:list_models, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Lists the Amazon Lookout for Vision projects in your AWS account that
are in the AWS Region in which you call ListProjects
.
The ListProjects
operation is eventually consistent. Recent calls to
CreateProject
and DeleteProject
might take a while to appear in
the response from ListProjects
.
This operation requires permissions to perform the
lookoutvision:ListProjects
operation.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1404 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Returns a list of tags attached to the specified Amazon Lookout for Vision model.
This operation requires permissions to perform the
lookoutvision:ListTagsForResource
operation.
1439 1440 1441 1442 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1439 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_model(params = {}) ⇒ Types::StartModelResponse
Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use DescribeModel.
A model is ready to use when its status is HOSTED
.
Once the model is running, you can detect custom labels in new images by calling DetectAnomalies.
This operation requires permissions to perform the
lookoutvision:StartModel
operation.
1521 1522 1523 1524 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1521 def start_model(params = {}, = {}) req = build_request(:start_model, params) req.send_request() end |
#start_model_packaging_job(params = {}) ⇒ Types::StartModelPackagingJobResponse
Starts an Amazon Lookout for Vision model packaging job. A model packaging job creates an AWS IoT Greengrass component for a Lookout for Vision model. You can use the component to deploy your model to an edge device managed by Greengrass.
Use the DescribeModelPackagingJob API to determine the current status
of the job. The model packaging job is complete if the value of
Status
is SUCCEEDED
.
To deploy the component to the target device, use the component name and component version with the AWS IoT Greengrass CreateDeployment API.
This operation requires the following permissions:
lookoutvision:StartModelPackagingJob
s3:PutObject
s3:GetBucketLocation
kms:GenerateDataKey
greengrass:CreateComponentVersion
greengrass:DescribeComponent
(Optional)
greengrass:TagResource
. Only required if you want to tag the component.
For more information, see Using your Amazon Lookout for Vision model on an edge device in the Amazon Lookout for Vision Developer Guide.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1647 def start_model_packaging_job(params = {}, = {}) req = build_request(:start_model_packaging_job, params) req.send_request() end |
#stop_model(params = {}) ⇒ Types::StopModelResponse
Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.
After the model hosting stops, the Status
of the model is TRAINED
.
This operation requires permissions to perform the
lookoutvision:StopModel
operation.
1706 1707 1708 1709 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1706 def stop_model(params = {}, = {}) req = build_request(:stop_model, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds one or more key-value tags to an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.
This operation requires permissions to perform the
lookoutvision:TagResource
operation.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1742 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes one or more tags from an Amazon Lookout for Vision model. For more information, see Tagging a model in the Amazon Lookout for Vision Developer Guide.
This operation requires permissions to perform the
lookoutvision:UntagResource
operation.
1774 1775 1776 1777 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1774 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_dataset_entries(params = {}) ⇒ Types::UpdateDatasetEntriesResponse
Adds or updates one or more JSON Line entries in a dataset. A JSON Line includes information about an image used for training or testing an Amazon Lookout for Vision model.
To update an existing JSON Line, use the source-ref
field to
identify the JSON Line. The JSON line that you supply replaces the
existing JSON line. Any existing annotations that are not in the new
JSON line are removed from the dataset.
For more information, see Defining JSON lines for anomaly classification in the Amazon Lookout for Vision Developer Guide.
source-ref
field of a JSON line,
must be in the same S3 bucket as the existing images in the dataset.
Updating a dataset might take a while to complete. To check the
current status, call DescribeDataset and check the Status
field in
the response.
This operation requires permissions to perform the
lookoutvision:UpdateDatasetEntries
operation.
1857 1858 1859 1860 |
# File 'gems/aws-sdk-lookoutforvision/lib/aws-sdk-lookoutforvision/client.rb', line 1857 def update_dataset_entries(params = {}, = {}) req = build_request(:update_dataset_entries, params) req.send_request() end |