/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include
#include
#include
#include
#include
#include
namespace Aws
{
namespace LookoutforVision
{
/**
* This is the Amazon Lookout for Vision API Reference. It provides descriptions
* of actions, data types, common parameters, and common errors.
Amazon
* Lookout for Vision enables you to find visual defects in industrial products,
* accurately and at scale. It uses computer vision to identify missing components
* in an industrial product, damage to vehicles or structures, irregularities in
* production lines, and even minuscule defects in silicon wafers — or any other
* physical item where quality is important such as a missing capacitor on printed
* circuit boards.
*/
class AWS_LOOKOUTFORVISION_API LookoutforVisionClient : public Aws::Client::AWSJsonClient, public Aws::Client::ClientWithAsyncTemplateMethods
{
public:
typedef Aws::Client::AWSJsonClient BASECLASS;
static const char* SERVICE_NAME;
static const char* ALLOCATION_TAG;
typedef LookoutforVisionClientConfiguration ClientConfigurationType;
typedef LookoutforVisionEndpointProvider EndpointProviderType;
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
LookoutforVisionClient(const Aws::LookoutforVision::LookoutforVisionClientConfiguration& clientConfiguration = Aws::LookoutforVision::LookoutforVisionClientConfiguration(),
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG));
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
LookoutforVisionClient(const Aws::Auth::AWSCredentials& credentials,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::LookoutforVision::LookoutforVisionClientConfiguration& clientConfiguration = Aws::LookoutforVision::LookoutforVisionClientConfiguration());
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
LookoutforVisionClient(const std::shared_ptr& credentialsProvider,
std::shared_ptr endpointProvider = Aws::MakeShared(ALLOCATION_TAG),
const Aws::LookoutforVision::LookoutforVisionClientConfiguration& clientConfiguration = Aws::LookoutforVision::LookoutforVisionClientConfiguration());
/* Legacy constructors due deprecation */
/**
* Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
LookoutforVisionClient(const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config
* is not specified, it will be initialized to default values.
*/
LookoutforVisionClient(const Aws::Auth::AWSCredentials& credentials,
const Aws::Client::ClientConfiguration& clientConfiguration);
/**
* Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied,
* the default http client factory will be used
*/
LookoutforVisionClient(const std::shared_ptr& credentialsProvider,
const Aws::Client::ClientConfiguration& clientConfiguration);
/* End of legacy constructors due deprecation */
virtual ~LookoutforVisionClient();
/**
* 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.
See Also:
* AWS
* API Reference
*/
virtual Model::CreateDatasetOutcome CreateDataset(const Model::CreateDatasetRequest& request) const;
/**
* A Callable wrapper for CreateDataset that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateDatasetOutcomeCallable CreateDatasetCallable(const CreateDatasetRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::CreateDataset, request);
}
/**
* An Async wrapper for CreateDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateDatasetAsync(const CreateDatasetRequestT& request, const CreateDatasetResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::CreateDataset, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::CreateModelOutcome CreateModel(const Model::CreateModelRequest& request) const;
/**
* A Callable wrapper for CreateModel that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateModelOutcomeCallable CreateModelCallable(const CreateModelRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::CreateModel, request);
}
/**
* An Async wrapper for CreateModel that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateModelAsync(const CreateModelRequestT& request, const CreateModelResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::CreateModel, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::CreateProjectOutcome CreateProject(const Model::CreateProjectRequest& request) const;
/**
* A Callable wrapper for CreateProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::CreateProjectOutcomeCallable CreateProjectCallable(const CreateProjectRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::CreateProject, request);
}
/**
* An Async wrapper for CreateProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void CreateProjectAsync(const CreateProjectRequestT& request, const CreateProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::CreateProject, request, handler, context);
}
/**
* 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.
See Also:
* AWS
* API Reference
*/
virtual Model::DeleteDatasetOutcome DeleteDataset(const Model::DeleteDatasetRequest& request) const;
/**
* A Callable wrapper for DeleteDataset that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteDatasetOutcomeCallable DeleteDatasetCallable(const DeleteDatasetRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DeleteDataset, request);
}
/**
* An Async wrapper for DeleteDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteDatasetAsync(const DeleteDatasetRequestT& request, const DeleteDatasetResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DeleteDataset, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::DeleteModelOutcome DeleteModel(const Model::DeleteModelRequest& request) const;
/**
* A Callable wrapper for DeleteModel that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteModelOutcomeCallable DeleteModelCallable(const DeleteModelRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DeleteModel, request);
}
/**
* An Async wrapper for DeleteModel that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteModelAsync(const DeleteModelRequestT& request, const DeleteModelResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DeleteModel, request, handler, context);
}
/**
* 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.
See Also:
* AWS
* API Reference
*/
virtual Model::DeleteProjectOutcome DeleteProject(const Model::DeleteProjectRequest& request) const;
/**
* A Callable wrapper for DeleteProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DeleteProjectOutcomeCallable DeleteProjectCallable(const DeleteProjectRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DeleteProject, request);
}
/**
* An Async wrapper for DeleteProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DeleteProjectAsync(const DeleteProjectRequestT& request, const DeleteProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DeleteProject, request, handler, context);
}
/**
* Describe an Amazon Lookout for Vision dataset.
This operation requires
* permissions to perform the lookoutvision:DescribeDataset
* operation.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeDatasetOutcome DescribeDataset(const Model::DescribeDatasetRequest& request) const;
/**
* A Callable wrapper for DescribeDataset that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeDatasetOutcomeCallable DescribeDatasetCallable(const DescribeDatasetRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DescribeDataset, request);
}
/**
* An Async wrapper for DescribeDataset that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeDatasetAsync(const DescribeDatasetRequestT& request, const DescribeDatasetResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DescribeDataset, request, handler, context);
}
/**
* Describes a version of an Amazon Lookout for Vision model.
This
* operation requires permissions to perform the
* lookoutvision:DescribeModel
operation.
See Also:
* AWS
* API Reference
*/
virtual Model::DescribeModelOutcome DescribeModel(const Model::DescribeModelRequest& request) const;
/**
* A Callable wrapper for DescribeModel that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeModelOutcomeCallable DescribeModelCallable(const DescribeModelRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DescribeModel, request);
}
/**
* An Async wrapper for DescribeModel that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeModelAsync(const DescribeModelRequestT& request, const DescribeModelResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DescribeModel, request, handler, context);
}
/**
* 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.
See
* Also:
AWS
* API Reference
*/
virtual Model::DescribeModelPackagingJobOutcome DescribeModelPackagingJob(const Model::DescribeModelPackagingJobRequest& request) const;
/**
* A Callable wrapper for DescribeModelPackagingJob that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeModelPackagingJobOutcomeCallable DescribeModelPackagingJobCallable(const DescribeModelPackagingJobRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DescribeModelPackagingJob, request);
}
/**
* An Async wrapper for DescribeModelPackagingJob that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeModelPackagingJobAsync(const DescribeModelPackagingJobRequestT& request, const DescribeModelPackagingJobResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DescribeModelPackagingJob, request, handler, context);
}
/**
* Describes an Amazon Lookout for Vision project.
This operation
* requires permissions to perform the lookoutvision:DescribeProject
* operation.
See Also:
AWS
* API Reference
*/
virtual Model::DescribeProjectOutcome DescribeProject(const Model::DescribeProjectRequest& request) const;
/**
* A Callable wrapper for DescribeProject that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DescribeProjectOutcomeCallable DescribeProjectCallable(const DescribeProjectRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DescribeProject, request);
}
/**
* An Async wrapper for DescribeProject that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DescribeProjectAsync(const DescribeProjectRequestT& request, const DescribeProjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DescribeProject, request, handler, context);
}
/**
* 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.
Before
* calling 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.
See Also:
* AWS
* API Reference
*/
virtual Model::DetectAnomaliesOutcome DetectAnomalies(const Model::DetectAnomaliesRequest& request) const;
/**
* A Callable wrapper for DetectAnomalies that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::DetectAnomaliesOutcomeCallable DetectAnomaliesCallable(const DetectAnomaliesRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::DetectAnomalies, request);
}
/**
* An Async wrapper for DetectAnomalies that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void DetectAnomaliesAsync(const DetectAnomaliesRequestT& request, const DetectAnomaliesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::DetectAnomalies, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::ListDatasetEntriesOutcome ListDatasetEntries(const Model::ListDatasetEntriesRequest& request) const;
/**
* A Callable wrapper for ListDatasetEntries that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListDatasetEntriesOutcomeCallable ListDatasetEntriesCallable(const ListDatasetEntriesRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::ListDatasetEntries, request);
}
/**
* An Async wrapper for ListDatasetEntries that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListDatasetEntriesAsync(const ListDatasetEntriesRequestT& request, const ListDatasetEntriesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::ListDatasetEntries, request, handler, context);
}
/**
* 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.
See
* Also:
AWS
* API Reference
*/
virtual Model::ListModelPackagingJobsOutcome ListModelPackagingJobs(const Model::ListModelPackagingJobsRequest& request) const;
/**
* A Callable wrapper for ListModelPackagingJobs that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListModelPackagingJobsOutcomeCallable ListModelPackagingJobsCallable(const ListModelPackagingJobsRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::ListModelPackagingJobs, request);
}
/**
* An Async wrapper for ListModelPackagingJobs that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListModelPackagingJobsAsync(const ListModelPackagingJobsRequestT& request, const ListModelPackagingJobsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::ListModelPackagingJobs, request, handler, context);
}
/**
* 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.
See Also:
* AWS
* API Reference
*/
virtual Model::ListModelsOutcome ListModels(const Model::ListModelsRequest& request) const;
/**
* A Callable wrapper for ListModels that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListModelsOutcomeCallable ListModelsCallable(const ListModelsRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::ListModels, request);
}
/**
* An Async wrapper for ListModels that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListModelsAsync(const ListModelsRequestT& request, const ListModelsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::ListModels, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::ListProjectsOutcome ListProjects(const Model::ListProjectsRequest& request) const;
/**
* A Callable wrapper for ListProjects that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListProjectsOutcomeCallable ListProjectsCallable(const ListProjectsRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::ListProjects, request);
}
/**
* An Async wrapper for ListProjects that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListProjectsAsync(const ListProjectsRequestT& request, const ListProjectsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::ListProjects, request, handler, context);
}
/**
* Returns a list of tags attached to the specified Amazon Lookout for Vision
* model.
This operation requires permissions to perform the
* lookoutvision:ListTagsForResource
operation.
See
* Also:
AWS
* API Reference
*/
virtual Model::ListTagsForResourceOutcome ListTagsForResource(const Model::ListTagsForResourceRequest& request) const;
/**
* A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::ListTagsForResourceOutcomeCallable ListTagsForResourceCallable(const ListTagsForResourceRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::ListTagsForResource, request);
}
/**
* An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void ListTagsForResourceAsync(const ListTagsForResourceRequestT& request, const ListTagsForResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::ListTagsForResource, request, handler, context);
}
/**
* 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.
You are
* charged for the amount of time that the model is running. To stop a running
* model, call StopModel.
This operation requires permissions
* to perform the lookoutvision:StartModel
operation.
See
* Also:
AWS
* API Reference
*/
virtual Model::StartModelOutcome StartModel(const Model::StartModelRequest& request) const;
/**
* A Callable wrapper for StartModel that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::StartModelOutcomeCallable StartModelCallable(const StartModelRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::StartModel, request);
}
/**
* An Async wrapper for StartModel that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void StartModelAsync(const StartModelRequestT& request, const StartModelResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::StartModel, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::StartModelPackagingJobOutcome StartModelPackagingJob(const Model::StartModelPackagingJobRequest& request) const;
/**
* A Callable wrapper for StartModelPackagingJob that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::StartModelPackagingJobOutcomeCallable StartModelPackagingJobCallable(const StartModelPackagingJobRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::StartModelPackagingJob, request);
}
/**
* An Async wrapper for StartModelPackagingJob that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void StartModelPackagingJobAsync(const StartModelPackagingJobRequestT& request, const StartModelPackagingJobResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::StartModelPackagingJob, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::StopModelOutcome StopModel(const Model::StopModelRequest& request) const;
/**
* A Callable wrapper for StopModel that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::StopModelOutcomeCallable StopModelCallable(const StopModelRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::StopModel, request);
}
/**
* An Async wrapper for StopModel that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void StopModelAsync(const StopModelRequestT& request, const StopModelResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::StopModel, request, handler, context);
}
/**
* 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.
See Also:
AWS
* API Reference
*/
virtual Model::TagResourceOutcome TagResource(const Model::TagResourceRequest& request) const;
/**
* A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::TagResourceOutcomeCallable TagResourceCallable(const TagResourceRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::TagResource, request);
}
/**
* An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void TagResourceAsync(const TagResourceRequestT& request, const TagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::TagResource, request, handler, context);
}
/**
* 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.
See Also:
* AWS
* API Reference
*/
virtual Model::UntagResourceOutcome UntagResource(const Model::UntagResourceRequest& request) const;
/**
* A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UntagResourceOutcomeCallable UntagResourceCallable(const UntagResourceRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::UntagResource, request);
}
/**
* An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UntagResourceAsync(const UntagResourceRequestT& request, const UntagResourceResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::UntagResource, request, handler, context);
}
/**
* 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.
The images you reference in the
* 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.
See
* Also:
AWS
* API Reference
*/
virtual Model::UpdateDatasetEntriesOutcome UpdateDatasetEntries(const Model::UpdateDatasetEntriesRequest& request) const;
/**
* A Callable wrapper for UpdateDatasetEntries that returns a future to the operation so that it can be executed in parallel to other requests.
*/
template
Model::UpdateDatasetEntriesOutcomeCallable UpdateDatasetEntriesCallable(const UpdateDatasetEntriesRequestT& request) const
{
return SubmitCallable(&LookoutforVisionClient::UpdateDatasetEntries, request);
}
/**
* An Async wrapper for UpdateDatasetEntries that queues the request into a thread executor and triggers associated callback when operation has finished.
*/
template
void UpdateDatasetEntriesAsync(const UpdateDatasetEntriesRequestT& request, const UpdateDatasetEntriesResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const
{
return SubmitAsync(&LookoutforVisionClient::UpdateDatasetEntries, request, handler, context);
}
void OverrideEndpoint(const Aws::String& endpoint);
std::shared_ptr& accessEndpointProvider();
private:
friend class Aws::Client::ClientWithAsyncTemplateMethods;
void init(const LookoutforVisionClientConfiguration& clientConfiguration);
LookoutforVisionClientConfiguration m_clientConfiguration;
std::shared_ptr m_executor;
std::shared_ptr m_endpointProvider;
};
} // namespace LookoutforVision
} // namespace Aws