Skip to content

Type definitions#

Index > LookoutforVision > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

PixelAnomalyTypeDef#

# PixelAnomalyTypeDef definition

class PixelAnomalyTypeDef(TypedDict):
    TotalPercentageArea: NotRequired[float],
    Color: NotRequired[str],

DatasetMetadataTypeDef#

# DatasetMetadataTypeDef definition

class DatasetMetadataTypeDef(TypedDict):
    DatasetType: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    Status: NotRequired[DatasetStatusType],  # (1)
    StatusMessage: NotRequired[str],
  1. See DatasetStatusType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CreateProjectRequestRequestTypeDef#

# CreateProjectRequestRequestTypeDef definition

class CreateProjectRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ClientToken: NotRequired[str],

ProjectMetadataTypeDef#

# ProjectMetadataTypeDef definition

class ProjectMetadataTypeDef(TypedDict):
    ProjectArn: NotRequired[str],
    ProjectName: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],

DatasetImageStatsTypeDef#

# DatasetImageStatsTypeDef definition

class DatasetImageStatsTypeDef(TypedDict):
    Total: NotRequired[int],
    Labeled: NotRequired[int],
    Normal: NotRequired[int],
    Anomaly: NotRequired[int],

InputS3ObjectTypeDef#

# InputS3ObjectTypeDef definition

class InputS3ObjectTypeDef(TypedDict):
    Bucket: str,
    Key: str,
    VersionId: NotRequired[str],

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    DatasetType: str,
    ClientToken: NotRequired[str],

DeleteModelRequestRequestTypeDef#

# DeleteModelRequestRequestTypeDef definition

class DeleteModelRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ModelVersion: str,
    ClientToken: NotRequired[str],

DeleteProjectRequestRequestTypeDef#

# DeleteProjectRequestRequestTypeDef definition

class DeleteProjectRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ClientToken: NotRequired[str],

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    DatasetType: str,

DescribeModelPackagingJobRequestRequestTypeDef#

# DescribeModelPackagingJobRequestRequestTypeDef definition

class DescribeModelPackagingJobRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    JobName: str,

DescribeModelRequestRequestTypeDef#

# DescribeModelRequestRequestTypeDef definition

class DescribeModelRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ModelVersion: str,

DescribeProjectRequestRequestTypeDef#

# DescribeProjectRequestRequestTypeDef definition

class DescribeProjectRequestRequestTypeDef(TypedDict):
    ProjectName: str,

ImageSourceTypeDef#

# ImageSourceTypeDef definition

class ImageSourceTypeDef(TypedDict):
    Type: NotRequired[str],

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    Bucket: str,
    Prefix: NotRequired[str],

TargetPlatformTypeDef#

# TargetPlatformTypeDef definition

class TargetPlatformTypeDef(TypedDict):
    Os: TargetPlatformOsType,  # (1)
    Arch: TargetPlatformArchType,  # (2)
    Accelerator: NotRequired[TargetPlatformAcceleratorType],  # (3)
  1. See TargetPlatformOsType
  2. See TargetPlatformArchType
  3. See TargetPlatformAcceleratorType

GreengrassOutputDetailsTypeDef#

# GreengrassOutputDetailsTypeDef definition

class GreengrassOutputDetailsTypeDef(TypedDict):
    ComponentVersionArn: NotRequired[str],
    ComponentName: NotRequired[str],
    ComponentVersion: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListModelPackagingJobsRequestRequestTypeDef#

# ListModelPackagingJobsRequestRequestTypeDef definition

class ListModelPackagingJobsRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ModelPackagingJobMetadataTypeDef#

# ModelPackagingJobMetadataTypeDef definition

class ModelPackagingJobMetadataTypeDef(TypedDict):
    JobName: NotRequired[str],
    ProjectName: NotRequired[str],
    ModelVersion: NotRequired[str],
    ModelPackagingJobDescription: NotRequired[str],
    ModelPackagingMethod: NotRequired[str],
    Status: NotRequired[ModelPackagingJobStatusType],  # (1)
    StatusMessage: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
  1. See ModelPackagingJobStatusType

ListModelsRequestRequestTypeDef#

# ListModelsRequestRequestTypeDef definition

class ListModelsRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListProjectsRequestRequestTypeDef#

# ListProjectsRequestRequestTypeDef definition

class ListProjectsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,

ModelPerformanceTypeDef#

# ModelPerformanceTypeDef definition

class ModelPerformanceTypeDef(TypedDict):
    F1Score: NotRequired[float],
    Recall: NotRequired[float],
    Precision: NotRequired[float],

OutputS3ObjectTypeDef#

# OutputS3ObjectTypeDef definition

class OutputS3ObjectTypeDef(TypedDict):
    Bucket: str,
    Key: str,

StartModelRequestRequestTypeDef#

# StartModelRequestRequestTypeDef definition

class StartModelRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ModelVersion: str,
    MinInferenceUnits: int,
    ClientToken: NotRequired[str],
    MaxInferenceUnits: NotRequired[int],

StopModelRequestRequestTypeDef#

# StopModelRequestRequestTypeDef definition

class StopModelRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ModelVersion: str,
    ClientToken: NotRequired[str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    TagKeys: Sequence[str],

AnomalyTypeDef#

# AnomalyTypeDef definition

class AnomalyTypeDef(TypedDict):
    Name: NotRequired[str],
    PixelAnomaly: NotRequired[PixelAnomalyTypeDef],  # (1)
  1. See PixelAnomalyTypeDef

DetectAnomaliesRequestRequestTypeDef#

# DetectAnomaliesRequestRequestTypeDef definition

class DetectAnomaliesRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    ModelVersion: str,
    Body: Union[str, bytes, IO[Any], StreamingBody],
    ContentType: str,

UpdateDatasetEntriesRequestRequestTypeDef#

# UpdateDatasetEntriesRequestRequestTypeDef definition

class UpdateDatasetEntriesRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    DatasetType: str,
    Changes: Union[str, bytes, IO[Any], StreamingBody],
    ClientToken: NotRequired[str],

ProjectDescriptionTypeDef#

# ProjectDescriptionTypeDef definition

class ProjectDescriptionTypeDef(TypedDict):
    ProjectArn: NotRequired[str],
    ProjectName: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    Datasets: NotRequired[List[DatasetMetadataTypeDef]],  # (1)
  1. See DatasetMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    DatasetMetadata: DatasetMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetMetadataTypeDef
  2. See ResponseMetadataTypeDef

DeleteModelResponseTypeDef#

# DeleteModelResponseTypeDef definition

class DeleteModelResponseTypeDef(TypedDict):
    ModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteProjectResponseTypeDef#

# DeleteProjectResponseTypeDef definition

class DeleteProjectResponseTypeDef(TypedDict):
    ProjectArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDatasetEntriesResponseTypeDef#

# ListDatasetEntriesResponseTypeDef definition

class ListDatasetEntriesResponseTypeDef(TypedDict):
    DatasetEntries: List[str],
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartModelPackagingJobResponseTypeDef#

# StartModelPackagingJobResponseTypeDef definition

class StartModelPackagingJobResponseTypeDef(TypedDict):
    JobName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartModelResponseTypeDef#

# StartModelResponseTypeDef definition

class StartModelResponseTypeDef(TypedDict):
    Status: ModelHostingStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelHostingStatusType
  2. See ResponseMetadataTypeDef

StopModelResponseTypeDef#

# StopModelResponseTypeDef definition

class StopModelResponseTypeDef(TypedDict):
    Status: ModelHostingStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelHostingStatusType
  2. See ResponseMetadataTypeDef

UpdateDatasetEntriesResponseTypeDef#

# UpdateDatasetEntriesResponseTypeDef definition

class UpdateDatasetEntriesResponseTypeDef(TypedDict):
    Status: DatasetStatusType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetStatusType
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceArn: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateProjectResponseTypeDef#

# CreateProjectResponseTypeDef definition

class CreateProjectResponseTypeDef(TypedDict):
    ProjectMetadata: ProjectMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectMetadataTypeDef
  2. See ResponseMetadataTypeDef

ListProjectsResponseTypeDef#

# ListProjectsResponseTypeDef definition

class ListProjectsResponseTypeDef(TypedDict):
    Projects: List[ProjectMetadataTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectMetadataTypeDef
  2. See ResponseMetadataTypeDef

DatasetDescriptionTypeDef#

# DatasetDescriptionTypeDef definition

class DatasetDescriptionTypeDef(TypedDict):
    ProjectName: NotRequired[str],
    DatasetType: NotRequired[str],
    CreationTimestamp: NotRequired[datetime],
    LastUpdatedTimestamp: NotRequired[datetime],
    Status: NotRequired[DatasetStatusType],  # (1)
    StatusMessage: NotRequired[str],
    ImageStats: NotRequired[DatasetImageStatsTypeDef],  # (2)
  1. See DatasetStatusType
  2. See DatasetImageStatsTypeDef

DatasetGroundTruthManifestTypeDef#

# DatasetGroundTruthManifestTypeDef definition

class DatasetGroundTruthManifestTypeDef(TypedDict):
    S3Object: NotRequired[InputS3ObjectTypeDef],  # (1)
  1. See InputS3ObjectTypeDef

OutputConfigTypeDef#

# OutputConfigTypeDef definition

class OutputConfigTypeDef(TypedDict):
    S3Location: S3LocationTypeDef,  # (1)
  1. See S3LocationTypeDef

GreengrassConfigurationTypeDef#

# GreengrassConfigurationTypeDef definition

class GreengrassConfigurationTypeDef(TypedDict):
    S3OutputLocation: S3LocationTypeDef,  # (3)
    ComponentName: str,
    CompilerOptions: NotRequired[str],
    TargetDevice: NotRequired[TargetDeviceType],  # (1)
    TargetPlatform: NotRequired[TargetPlatformTypeDef],  # (2)
    ComponentVersion: NotRequired[str],
    ComponentDescription: NotRequired[str],
    Tags: NotRequired[List[TagTypeDef]],  # (4)
  1. See TargetDeviceType
  2. See TargetPlatformTypeDef
  3. See S3LocationTypeDef
  4. See TagTypeDef

ModelPackagingOutputDetailsTypeDef#

# ModelPackagingOutputDetailsTypeDef definition

class ModelPackagingOutputDetailsTypeDef(TypedDict):
    Greengrass: NotRequired[GreengrassOutputDetailsTypeDef],  # (1)
  1. See GreengrassOutputDetailsTypeDef

ListModelPackagingJobsRequestListModelPackagingJobsPaginateTypeDef#

# ListModelPackagingJobsRequestListModelPackagingJobsPaginateTypeDef definition

class ListModelPackagingJobsRequestListModelPackagingJobsPaginateTypeDef(TypedDict):
    ProjectName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListModelsRequestListModelsPaginateTypeDef#

# ListModelsRequestListModelsPaginateTypeDef definition

class ListModelsRequestListModelsPaginateTypeDef(TypedDict):
    ProjectName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListProjectsRequestListProjectsPaginateTypeDef#

# ListProjectsRequestListProjectsPaginateTypeDef definition

class ListProjectsRequestListProjectsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef#

# ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef definition

class ListDatasetEntriesRequestListDatasetEntriesPaginateTypeDef(TypedDict):
    ProjectName: str,
    DatasetType: str,
    Labeled: NotRequired[bool],
    AnomalyClass: NotRequired[str],
    BeforeCreationDate: NotRequired[Union[datetime, str]],
    AfterCreationDate: NotRequired[Union[datetime, str]],
    SourceRefContains: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListDatasetEntriesRequestRequestTypeDef#

# ListDatasetEntriesRequestRequestTypeDef definition

class ListDatasetEntriesRequestRequestTypeDef(TypedDict):
    ProjectName: str,
    DatasetType: str,
    Labeled: NotRequired[bool],
    AnomalyClass: NotRequired[str],
    BeforeCreationDate: NotRequired[Union[datetime, str]],
    AfterCreationDate: NotRequired[Union[datetime, str]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    SourceRefContains: NotRequired[str],

ListModelPackagingJobsResponseTypeDef#

# ListModelPackagingJobsResponseTypeDef definition

class ListModelPackagingJobsResponseTypeDef(TypedDict):
    ModelPackagingJobs: List[ModelPackagingJobMetadataTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ModelPackagingJobMetadataTypeDef
  2. See ResponseMetadataTypeDef

ModelMetadataTypeDef#

# ModelMetadataTypeDef definition

class ModelMetadataTypeDef(TypedDict):
    CreationTimestamp: NotRequired[datetime],
    ModelVersion: NotRequired[str],
    ModelArn: NotRequired[str],
    Description: NotRequired[str],
    Status: NotRequired[ModelStatusType],  # (1)
    StatusMessage: NotRequired[str],
    Performance: NotRequired[ModelPerformanceTypeDef],  # (2)
  1. See ModelStatusType
  2. See ModelPerformanceTypeDef

DetectAnomalyResultTypeDef#

# DetectAnomalyResultTypeDef definition

class DetectAnomalyResultTypeDef(TypedDict):
    Source: NotRequired[ImageSourceTypeDef],  # (1)
    IsAnomalous: NotRequired[bool],
    Confidence: NotRequired[float],
    Anomalies: NotRequired[List[AnomalyTypeDef]],  # (2)
    AnomalyMask: NotRequired[bytes],
  1. See ImageSourceTypeDef
  2. See AnomalyTypeDef

DescribeProjectResponseTypeDef#

# DescribeProjectResponseTypeDef definition

class DescribeProjectResponseTypeDef(TypedDict):
    ProjectDescription: ProjectDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProjectDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    DatasetDescription: DatasetDescriptionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetDescriptionTypeDef
  2. See ResponseMetadataTypeDef

DatasetSourceTypeDef#

# DatasetSourceTypeDef definition

class DatasetSourceTypeDef(TypedDict):
    GroundTruthManifest: NotRequired[DatasetGroundTruthManifestTypeDef],  # (1)
  1. See DatasetGroundTruthManifestTypeDef

CreateModelRequestRequestTypeDef#

# CreateModelRequestRequestTypeDef definition

clas