Skip to content

ECR module

Index > ECR

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

How to install

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 boto3-stubs for ECR service.

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


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


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

How to uninstall

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

Usage

Code samples can be found in Examples.

ECRClient

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

Usage example
from boto3.session import Session

from mypy_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("...").

Usage example
from boto3.session import Session

from mypy_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("...").

Usage example
from boto3.session import Session

from mypy_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 schemas.

Usage example
from mypy_boto3_ecr.literals import DescribeImageScanFindingsPaginatorName

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

Usage example
from mypy_boto3_ecr.type_defs import AttributeTypeDef

def get_value() -> AttributeTypeDef:
    return {
        "key": ...,
    }