Skip to content

ECR module#

Index > ECR

Auto-generated documentation for ECR type annotations stubs module types-boto3-ecr.

How to install#

You can generate type annotations for boto3 package locally with mypy_boto3_builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.35.86' mypy_boto3_builder
  2. Select boto3 AWS SDK.
  3. Add ECR service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and ECR.

From PyPI with pip#

Install types-boto3 for ECR service.

# install with boto3 type annotations
python -m pip install 'types-boto3[ecr]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[ecr]'

# standalone installation
python -m pip install types-boto3-ecr

How to uninstall#

python -m pip uninstall -y types-boto3-ecr

Usage#

Code samples can be found in Examples.

ECRClient#

Type annotations and code completion for boto3.client("ecr") as ECRClient boto3 documentation

# ECRClient usage example

from boto3.session import Session

from types_boto3_ecr.client import ECRClient

def get_client() -> ECRClient:
    return Session().client("ecr")

Paginators#

Type annotations and code completion for paginators from boto3.client("ecr").get_paginator("...").

# DescribeImageScanFindingsPaginator usage example

from boto3.session import Session

from types_boto3_ecr.paginator import DescribeImageScanFindingsPaginator

def get_describe_image_scan_findings_paginator() -> DescribeImageScanFindingsPaginator:
    return Session().client("ecr").get_paginator("describe_image_scan_findings"))

Waiters#

Type annotations and code completion for waiters from boto3.client("ecr").get_waiter("...").

# ImageScanCompleteWaiter usage example

from boto3.session import Session

from types_boto3_ecr.waiter import ImageScanCompleteWaiter

def get_image_scan_complete_waiter() -> ImageScanCompleteWaiter:
    return Session().client("ecr").get_waiter("image_scan_complete")

Literals#

Type annotations for literals used in methods and schema.

# DescribeImageScanFindingsPaginatorName usage example

from types_boto3_ecr.literals import DescribeImageScanFindingsPaginatorName

def get_value() -> DescribeImageScanFindingsPaginatorName:
    return "describe_image_scan_findings"

Type definitions#

Type annotations for type definitions used in methods and schema.