lookoutvision/aws.sdk.kotlin.services.lookoutvision/LookoutVisionClient

LookoutVisionClient

interface LookoutVisionClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<LookoutVisionClient.Config, LookoutVisionClient.Config.Builder, LookoutVisionClient>

Companion

object Companion : AbstractAwsSdkClientFactory<LookoutVisionClient.Config, LookoutVisionClient.Config.Builder, LookoutVisionClient, LookoutVisionClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: LookoutVisionClient.Config

LookoutVisionClient's configuration

Functions

createDataset

abstract suspend fun createDataset(input: CreateDatasetRequest): 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

abstract suspend fun createModel(input: CreateModelRequest): 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

abstract suspend fun createProject(input: CreateProjectRequest): CreateProjectResponse

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

deleteDataset

abstract suspend fun deleteDataset(input: DeleteDatasetRequest): DeleteDatasetResponse

Deletes an existing Amazon Lookout for Vision dataset.

deleteModel

abstract suspend fun deleteModel(input: DeleteModelRequest): 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

abstract suspend fun deleteProject(input: DeleteProjectRequest): DeleteProjectResponse

Deletes an Amazon Lookout for Vision project.

describeDataset

abstract suspend fun describeDataset(input: DescribeDatasetRequest): DescribeDatasetResponse

Describe an Amazon Lookout for Vision dataset.

describeModel

abstract suspend fun describeModel(input: DescribeModelRequest): DescribeModelResponse

Describes a version of an Amazon Lookout for Vision model.

describeModelPackagingJob

abstract suspend fun describeModelPackagingJob(input: DescribeModelPackagingJobRequest): DescribeModelPackagingJobResponse

Describes an Amazon Lookout for Vision model packaging job.

describeProject

abstract suspend fun describeProject(input: DescribeProjectRequest): DescribeProjectResponse

Describes an Amazon Lookout for Vision project.

detectAnomalies

abstract suspend fun detectAnomalies(input: DetectAnomaliesRequest): DetectAnomaliesResponse

Detects anomalies in an image that you supply.

listDatasetEntries

abstract suspend fun listDatasetEntries(input: ListDatasetEntriesRequest): 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

abstract suspend fun listModelPackagingJobs(input: ListModelPackagingJobsRequest): ListModelPackagingJobsResponse

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

listModels

abstract suspend fun listModels(input: ListModelsRequest): ListModelsResponse

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

listProjects

abstract suspend fun listProjects(input: ListProjectsRequest = ListProjectsRequest { }): ListProjectsResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

startModel

abstract suspend fun startModel(input: StartModelRequest): 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

abstract suspend fun startModelPackagingJob(input: StartModelPackagingJobRequest): 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

abstract suspend fun stopModel(input: StopModelRequest): StopModelResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): 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

abstract suspend fun untagResource(input: UntagResourceRequest): 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

abstract suspend fun updateDatasetEntries(input: UpdateDatasetEntriesRequest): 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.

Inherited functions

expect abstract fun close()

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

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.

listDatasetEntriesPaginated

fun LookoutVisionClient.listDatasetEntriesPaginated(initialRequest: ListDatasetEntriesRequest): Flow<ListDatasetEntriesResponse>

fun LookoutVisionClient.listDatasetEntriesPaginated(block: ListDatasetEntriesRequest.Builder.() -> Unit): Flow<ListDatasetEntriesResponse>

Paginate over ListDatasetEntriesResponse results.

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.

listModelPackagingJobsPaginated

fun LookoutVisionClient.listModelPackagingJobsPaginated(initialRequest: ListModelPackagingJobsRequest): Flow<ListModelPackagingJobsResponse>

fun LookoutVisionClient.listModelPackagingJobsPaginated(block: ListModelPackagingJobsRequest.Builder.() -> Unit): Flow<ListModelPackagingJobsResponse>

Paginate over ListModelPackagingJobsResponse results.

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.

listModelsPaginated

fun LookoutVisionClient.listModelsPaginated(initialRequest: ListModelsRequest): Flow<ListModelsResponse>

fun LookoutVisionClient.listModelsPaginated(block: ListModelsRequest.Builder.() -> Unit): Flow<ListModelsResponse>

Paginate over ListModelsResponse results.

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.

listProjectsPaginated

fun LookoutVisionClient.listProjectsPaginated(initialRequest: ListProjectsRequest = ListProjectsRequest { }): Flow<ListProjectsResponse>

fun LookoutVisionClient.listProjectsPaginated(block: ListProjectsRequest.Builder.() -> Unit): Flow<ListProjectsResponse>

Paginate over ListProjectsResponse results.

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

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.