Skip to content

LookoutforVisionClient#

Index > LookoutforVision > LookoutforVisionClient

Auto-generated documentation for LookoutforVision type annotations stubs module mypy-boto3-lookoutvision.

LookoutforVisionClient#

Type annotations and code completion for boto3.client("lookoutvision"). boto3 documentation

# LookoutforVisionClient usage example

from boto3.session import Session
from mypy_boto3_lookoutvision.client import LookoutforVisionClient

def get_lookoutvision_client() -> LookoutforVisionClient:
    return Session().client("lookoutvision")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("lookoutvision").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("lookoutvision")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_lookoutvision.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("lookoutvision").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("lookoutvision").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_dataset#

Creates a new dataset in an Amazon Lookout for Vision project.

Type annotations and code completion for boto3.client("lookoutvision").create_dataset method. boto3 documentation

# create_dataset method definition

def create_dataset(
    self,
    *,
    ProjectName: str,
    DatasetType: str,
    DatasetSource: DatasetSourceTypeDef = ...,  # (1)
    ClientToken: str = ...,
) -> CreateDatasetResponseTypeDef:  # (2)
    ...
  1. See DatasetSourceTypeDef
  2. See CreateDatasetResponseTypeDef 
# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "DatasetType": ...,
}

parent.create_dataset(**kwargs)
  1. See CreateDatasetRequestRequestTypeDef

create_model#

Creates a new version of a model within an an Amazon Lookout for Vision project.

Type annotations and code completion for boto3.client("lookoutvision").create_model method. boto3 documentation

# create_model method definition

def create_model(
    self,
    *,
    ProjectName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    Description: str = ...,
    ClientToken: str = ...,
    KmsKeyId: str = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> CreateModelResponseTypeDef:  # (3)
    ...
  1. See OutputConfigTypeDef
  2. See TagTypeDef
  3. See CreateModelResponseTypeDef 
# create_model method usage example with argument unpacking

kwargs: CreateModelRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "OutputConfig": ...,
}

parent.create_model(**kwargs)
  1. See CreateModelRequestRequestTypeDef

create_project#

Creates an empty Amazon Lookout for Vision project.

Type annotations and code completion for boto3.client("lookoutvision").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    ProjectName: str,
    ClientToken: str = ...,
) -> CreateProjectResponseTypeDef:  # (1)
    ...
  1. See CreateProjectResponseTypeDef 
# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.create_project(**kwargs)
  1. See CreateProjectRequestRequestTypeDef

delete_dataset#

Deletes an existing Amazon Lookout for Vision dataset.

Type annotations and code completion for boto3.client("lookoutvision").delete_dataset method. boto3 documentation

# delete_dataset method definition

def delete_dataset(
    self,
    *,
    ProjectName: str,
    DatasetType: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "DatasetType": ...,
}

parent.delete_dataset(**kwargs)
  1. See DeleteDatasetRequestRequestTypeDef

delete_model#

Deletes an Amazon Lookout for Vision model.

Type annotations and code completion for boto3.client("lookoutvision").delete_model method. boto3 documentation

# delete_model method definition

def delete_model(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
    ClientToken: str = ...,
) -> DeleteModelResponseTypeDef:  # (1)
    ...
  1. See DeleteModelResponseTypeDef 
# delete_model method usage example with argument unpacking

kwargs: DeleteModelRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
}

parent.delete_model(**kwargs)
  1. See DeleteModelRequestRequestTypeDef

delete_project#

Deletes an Amazon Lookout for Vision project.

Type annotations and code completion for boto3.client("lookoutvision").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    ProjectName: str,
    ClientToken: str = ...,
) -> DeleteProjectResponseTypeDef:  # (1)
    ...
  1. See DeleteProjectResponseTypeDef 
# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.delete_project(**kwargs)
  1. See DeleteProjectRequestRequestTypeDef

describe_dataset#

Describe an Amazon Lookout for Vision dataset.

Type annotations and code completion for boto3.client("lookoutvision").describe_dataset method. boto3 documentation

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    ProjectName: str,
    DatasetType: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...
  1. See DescribeDatasetResponseTypeDef 
# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "DatasetType": ...,
}

parent.describe_dataset(**kwargs)
  1. See DescribeDatasetRequestRequestTypeDef

describe_model#

Describes a version of an Amazon Lookout for Vision model.

Type annotations and code completion for boto3.client("lookoutvision").describe_model method. boto3 documentation

# describe_model method definition

def describe_model(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
) -> DescribeModelResponseTypeDef:  # (1)
    ...
  1. See DescribeModelResponseTypeDef 
# describe_model method usage example with argument unpacking

kwargs: DescribeModelRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
}

parent.describe_model(**kwargs)
  1. See DescribeModelRequestRequestTypeDef

describe_model_packaging_job#

Describes an Amazon Lookout for Vision model packaging job.

Type annotations and code completion for boto3.client("lookoutvision").describe_model_packaging_job method. boto3 documentation

# describe_model_packaging_job method definition

def describe_model_packaging_job(
    self,
    *,
    ProjectName: str,
    JobName: str,
) -> DescribeModelPackagingJobResponseTypeDef:  # (1)
    ...
  1. See DescribeModelPackagingJobResponseTypeDef 
# describe_model_packaging_job method usage example with argument unpacking

kwargs: DescribeModelPackagingJobRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "JobName": ...,
}

parent.describe_model_packaging_job(**kwargs)
  1. See DescribeModelPackagingJobRequestRequestTypeDef

describe_project#

Describes an Amazon Lookout for Vision project.

Type annotations and code completion for boto3.client("lookoutvision").describe_project method. boto3 documentation

# describe_project method definition

def describe_project(
    self,
    *,
    ProjectName: str,
) -> DescribeProjectResponseTypeDef:  # (1)
    ...
  1. See DescribeProjectResponseTypeDef 
# describe_project method usage example with argument unpacking

kwargs: DescribeProjectRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.describe_project(**kwargs)
  1. See DescribeProjectRequestRequestTypeDef

detect_anomalies#

Detects anomalies in an image that you supply.

Type annotations and code completion for boto3.client("lookoutvision").detect_anomalies method. boto3 documentation

# detect_anomalies method definition

def detect_anomalies(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
    Body: BlobTypeDef,
    ContentType: str,
) -> DetectAnomaliesResponseTypeDef:  # (1)
    ...
  1. See DetectAnomaliesResponseTypeDef 
# detect_anomalies method usage example with argument unpacking

kwargs: DetectAnomaliesRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
    "Body": ...,
    "ContentType": ...,
}

parent.detect_anomalies(**kwargs)
  1. See DetectAnomaliesRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("lookoutvision").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_dataset_entries#

Lists the JSON Lines within a dataset.

Type annotations and code completion for boto3.client("lookoutvision").list_dataset_entries method. boto3 documentation

# list_dataset_entries method definition

def list_dataset_entries(
    self,
    *,
    ProjectName: str,
    DatasetType: str,
    Labeled: bool = ...,
    AnomalyClass: str = ...,
    BeforeCreationDate: TimestampTypeDef = ...,
    AfterCreationDate: TimestampTypeDef = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    SourceRefContains: str = ...,
) -> ListDatasetEntriesResponseTypeDef:  # (1)
    ...
  1. See ListDatasetEntriesResponseTypeDef 
# list_dataset_entries method usage example with argument unpacking

kwargs: ListDatasetEntriesRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "DatasetType": ...,
}

parent.list_dataset_entries(**kwargs)
  1. See ListDatasetEntriesRequestRequestTypeDef

list_model_packaging_jobs#

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

Type annotations and code completion for boto3.client("lookoutvision").list_model_packaging_jobs method. boto3 documentation

# list_model_packaging_jobs method definition

def list_model_packaging_jobs(
    self,
    *,
    ProjectName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelPackagingJobsResponseTypeDef:  # (1)
    ...
  1. See ListModelPackagingJobsResponseTypeDef 
# list_model_packaging_jobs method usage example with argument unpacking

kwargs: ListModelPackagingJobsRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.list_model_packaging_jobs(**kwargs)
  1. See ListModelPackagingJobsRequestRequestTypeDef

list_models#

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

Type annotations and code completion for boto3.client("lookoutvision").list_models method. boto3 documentation

# list_models method definition

def list_models(
    self,
    *,
    ProjectName: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListModelsResponseTypeDef:  # (1)
    ...
  1. See ListModelsResponseTypeDef 
# list_models method usage example with argument unpacking

kwargs: ListModelsRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.list_models(**kwargs)
  1. See ListModelsRequestRequestTypeDef

list_projects#

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

Type annotations and code completion for boto3.client("lookoutvision").list_projects method. boto3 documentation

# list_projects method definition

def list_projects(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProjectsResponseTypeDef:  # (1)
    ...
  1. See ListProjectsResponseTypeDef 
# list_projects method usage example with argument unpacking

kwargs: ListProjectsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_projects(**kwargs)
  1. See ListProjectsRequestRequestTypeDef

list_tags_for_resource#

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

Type annotations and code completion for boto3.client("lookoutvision").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestRequestTypeDef

start_model#

Starts the running of the version of an Amazon Lookout for Vision model.

Type annotations and code completion for boto3.client("lookoutvision").start_model method. boto3 documentation

# start_model method definition

def start_model(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
    MinInferenceUnits: int,
    ClientToken: str = ...,
    MaxInferenceUnits: int = ...,
) -> StartModelResponseTypeDef:  # (1)
    ...
  1. See StartModelResponseTypeDef 
# start_model method usage example with argument unpacking

kwargs: StartModelRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
    "MinInferenceUnits": ...,
}

parent.start_model(**kwargs)
  1. See StartModelRequestRequestTypeDef

start_model_packaging_job#

Starts an Amazon Lookout for Vision model packaging job.

Type annotations and code completion for boto3.client("lookoutvision").start_model_packaging_job method. boto3 documentation

# start_model_packaging_job method definition

def start_model_packaging_job(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
    Configuration: ModelPackagingConfigurationTypeDef,  # (1)
    JobName: str = ...,
    Description: str = ...,
    ClientToken: str = ...,
) -> StartModelPackagingJobResponseTypeDef:  # (2)
    ...
  1. See ModelPackagingConfigurationTypeDef
  2. See StartModelPackagingJobResponseTypeDef 
# start_model_packaging_job method usage example with argument unpacking

kwargs: StartModelPackagingJobRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
    "Configuration": ...,
}

parent.start_model_packaging_job(**kwargs)
  1. See StartModelPackagingJobRequestRequestTypeDef

stop_model#

Stops the hosting of a running model.

Type annotations and code completion for boto3.client("lookoutvision").stop_model method. boto3 documentation

# stop_model method definition

def stop_model(
    self,
    *,
    ProjectName: str,
    ModelVersion: str,
    ClientToken: str = ...,
) -> StopModelResponseTypeDef:  # (1)
    ...
  1. See StopModelResponseTypeDef 
# stop_model method usage example with argument unpacking

kwargs: StopModelRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "ModelVersion": ...,
}

parent.stop_model(**kwargs)
  1. See StopModelRequestRequestTypeDef

tag_resource#

Adds one or more key-value tags to an Amazon Lookout for Vision model.

Type annotations and code completion for boto3.client("lookoutvision").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
) -> Dict[str, Any]:
    ...
  1. See TagTypeDef 
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestRequestTypeDef

untag_resource#

Removes one or more tags from an Amazon Lookout for Vision model.

Type annotations and code completion for boto3.client("lookoutvision").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestRequestTypeDef

update_dataset_entries#

Adds or updates one or more JSON Line entries in a dataset.

Type annotations and code completion for boto3.client("lookoutvision").update_dataset_entries method. boto3 documentation

# update_dataset_entries method definition

def update_dataset_entries(
    self,
    *,
    ProjectName: str,
    DatasetType: str,
    Changes: BlobTypeDef,
    ClientToken: str = ...,
) -> UpdateDatasetEntriesResponseTypeDef:  # (1)
    ...
  1. See UpdateDatasetEntriesResponseTypeDef 
# update_dataset_entries method usage example with argument unpacking

kwargs: UpdateDatasetEntriesRequestRequestTypeDef = {  # (1)
    "ProjectName": ...,
    "DatasetType": ...,
    "Changes": ...,
}

parent.update_dataset_entries(**kwargs)
  1. See UpdateDatasetEntriesRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("lookoutvision").get_paginator method with overloads.