Skip to content

ElasticLoadBalancingv2 module#

Index > ElasticLoadBalancingv2

Auto-generated documentation for ElasticLoadBalancingv2 type annotations stubs module mypy-boto3-elbv2.

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

From PyPI with pip#

Install boto3-stubs for ElasticLoadBalancingv2 service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ElasticLoadBalancingv2Client#

Type annotations and code completion for boto3.client("elbv2") as ElasticLoadBalancingv2Client boto3 documentation

# ElasticLoadBalancingv2Client usage example

from boto3.session import Session

from mypy_boto3_elbv2.client import ElasticLoadBalancingv2Client

def get_client() -> ElasticLoadBalancingv2Client:
    return Session().client("elbv2")

Paginators#

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

# DescribeAccountLimitsPaginator usage example

from boto3.session import Session

from mypy_boto3_elbv2.paginator import DescribeAccountLimitsPaginator

def get_describe_account_limits_paginator() -> DescribeAccountLimitsPaginator:
    return Session().client("elbv2").get_paginator("describe_account_limits"))

Waiters#

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

# LoadBalancerAvailableWaiter usage example

from boto3.session import Session

from mypy_boto3_elbv2.waiter import LoadBalancerAvailableWaiter

def get_load_balancer_available_waiter() -> LoadBalancerAvailableWaiter:
    return Session().client("elbv2").get_waiter("load_balancer_available")

Literals#

Type annotations for literals used in methods and schemas.

# ActionTypeEnumType usage example

from mypy_boto3_elbv2.literals import ActionTypeEnumType

def get_value() -> ActionTypeEnumType:
    return "authenticate-cognito"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AuthenticateCognitoActionConfigTypeDef usage example

from mypy_boto3_elbv2.type_defs import AuthenticateCognitoActionConfigTypeDef

def get_value() -> AuthenticateCognitoActionConfigTypeDef:
    return {
        "UserPoolArn": ...,
        "UserPoolClientId": ...,
        "UserPoolDomain": ...,
    }