lookoutvision/aws.sdk.kotlin.services.lookoutvision

Package-level declarations

Types

interface LookoutVisionClient : SdkClient

This is the Amazon Lookout for Vision API Reference. It provides descriptions of actions, data types, common parameters, and common errors.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createDataset

inline suspend fun LookoutVisionClient.createDataset(crossinline block: CreateDatasetRequest.Builder.() -> Unit): 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).

createModel

inline suspend fun LookoutVisionClient.createModel(crossinline block: CreateModelRequest.Builder.() -> Unit): 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.

createProject

inline suspend fun LookoutVisionClient.createProject(crossinline block: CreateProjectRequest.Builder.() -> Unit): CreateProjectResponse

Creates an empty Amazon Lookout for Vision project. After you create the project, add a dataset by calling CreateDataset.

deleteDataset

inline suspend fun LookoutVisionClient.deleteDataset(crossinline block: DeleteDatasetRequest.Builder.() -> Unit): DeleteDatasetResponse

Deletes an existing Amazon Lookout for Vision dataset.

deleteModel

inline suspend fun LookoutVisionClient.deleteModel(crossinline block: DeleteModelRequest.Builder.() -> Unit): DeleteModelResponse

Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the StopModel operation.

deleteProject

inline suspend fun LookoutVisionClient.deleteProject(crossinline block: DeleteProjectRequest.Builder.() -> Unit): DeleteProjectResponse

Deletes an Amazon Lookout for Vision project.

describeDataset

inline suspend fun LookoutVisionClient.describeDataset(crossinline block: DescribeDatasetRequest.Builder.() -> Unit): DescribeDatasetResponse

Describe an Amazon Lookout for Vision dataset.

describeModel

inline suspend fun LookoutVisionClient.describeModel(crossinline block: DescribeModelRequest.Builder.() -> Unit): DescribeModelResponse

Describes a version of an Amazon Lookout for Vision model.

describeModelPackagingJob

inline suspend fun LookoutVisionClient.describeModelPackagingJob(crossinline block: DescribeModelPackagingJobRequest.Builder.() -> Unit): DescribeModelPackagingJobResponse

Describes an Amazon Lookout for Vision model packaging job.

describeProject

inline suspend fun LookoutVisionClient.describeProject(crossinline block: DescribeProjectRequest.Builder.() -> Unit): DescribeProjectResponse

Describes an Amazon Lookout for Vision project.

detectAnomalies

inline suspend fun LookoutVisionClient.detectAnomalies(crossinline block: DetectAnomaliesRequest.Builder.() -> Unit): DetectAnomaliesResponse

Detects anomalies in an image that you supply.

listDatasetEntries

inline suspend fun LookoutVisionClient.listDatasetEntries(crossinline block: ListDatasetEntriesRequest.Builder.() -> Unit): 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.

listModelPackagingJobs

inline suspend fun LookoutVisionClient.listModelPackagingJobs(crossinline block: ListModelPackagingJobsRequest.Builder.() -> Unit): ListModelPackagingJobsResponse

Lists the model packaging jobs created for an Amazon Lookout for Vision project.

listModels

inline suspend fun LookoutVisionClient.listModels(crossinline block: ListModelsRequest.Builder.() -> Unit): ListModelsResponse

Lists the versions of a model in an Amazon Lookout for Vision project.

listProjects

inline suspend fun LookoutVisionClient.listProjects(crossinline block: ListProjectsRequest.Builder.() -> Unit): ListProjectsResponse

Lists the Amazon Lookout for Vision projects in your AWS account that are in the AWS Region in which you call ListProjects.

listTagsForResource

inline suspend fun LookoutVisionClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of tags attached to the specified Amazon Lookout for Vision model.

startModel

inline suspend fun LookoutVisionClient.startModel(crossinline block: StartModelRequest.Builder.() -> Unit): 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.

startModelPackagingJob

inline suspend fun LookoutVisionClient.startModelPackagingJob(crossinline block: StartModelPackagingJobRequest.Builder.() -> Unit): 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.

stopModel

inline suspend fun LookoutVisionClient.stopModel(crossinline block: StopModelRequest.Builder.() -> Unit): StopModelResponse

Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call DescribeModel.

tagResource

inline suspend fun LookoutVisionClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun LookoutVisionClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

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.

updateDatasetEntries

inline suspend fun LookoutVisionClient.updateDatasetEntries(crossinline block: UpdateDatasetEntriesRequest.Builder.() -> Unit): 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.

withConfig

fun LookoutVisionClient.withConfig(block: LookoutVisionClient.Config.Builder.() -> Unit): LookoutVisionClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.