Skip to content

EKS module#

Index > EKS

Auto-generated documentation for EKS type annotations stubs module mypy-boto3-eks.

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 EKS.

From PyPI with pip#

Install boto3-stubs for EKS service.

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


# 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[eks]'


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

EKSClient#

Type annotations and code completion for boto3.client("eks") as EKSClient boto3 documentation

# EKSClient usage example

from boto3.session import Session

from mypy_boto3_eks.client import EKSClient

def get_client() -> EKSClient:
    return Session().client("eks")

Paginators#

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

# DescribeAddonVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_eks.paginator import DescribeAddonVersionsPaginator

def get_describe_addon_versions_paginator() -> DescribeAddonVersionsPaginator:
    return Session().client("eks").get_paginator("describe_addon_versions"))

Waiters#

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

# AddonActiveWaiter usage example

from boto3.session import Session

from mypy_boto3_eks.waiter import AddonActiveWaiter

def get_addon_active_waiter() -> AddonActiveWaiter:
    return Session().client("eks").get_waiter("addon_active")

Literals#

Type annotations for literals used in methods and schemas.

# AMITypesType usage example

from mypy_boto3_eks.literals import AMITypesType

def get_value() -> AMITypesType:
    return "AL2_ARM_64"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AddonIssueTypeDef usage example

from mypy_boto3_eks.type_defs import AddonIssueTypeDef

def get_value() -> AddonIssueTypeDef:
    return {
        "code": ...,
    }