Type annotations for boto3.ElasticLoadBalancingv2 1.14.4 service, generated by mypy-boto3-buider 2.2.0
Project description
mypy-boto3-elbv2
Type annotations for boto3.ElasticLoadBalancingv2 1.14.4 service compatible with mypy, VSCode, PyCharm and other tools.
Generated by mypy-boto3-buider 2.2.0.
More information can be found on boto3-stubs page.
How to install
Make sure you have mypy installed and activated in your IDE.
Install boto3-stubs
for ElasticLoadBalancingv2
service.
python -m pip install boto3-stubs[elbv2]
How to use
Client annotations
ElasticLoadBalancingv2Client
provides annotations for boto3.client("elbv2")
.
import boto3
from mypy_boto3_elbv2 import ElasticLoadBalancingv2Client
from mypy_boto3_elbv2.paginator import (
DescribeAccountLimitsPaginator,
DescribeListenerCertificatesPaginator,
DescribeListenersPaginator,
DescribeLoadBalancersPaginator,
DescribeRulesPaginator,
DescribeSSLPoliciesPaginator,
DescribeTargetGroupsPaginator,
)
from mypy_boto3_elbv2.type_defs import ActionTypeDef, ...
from mypy_boto3_elbv2.waiter import (
LoadBalancerAvailableWaiter,
LoadBalancerExistsWaiter,
LoadBalancersDeletedWaiter,
TargetDeregisteredWaiter,
TargetInServiceWaiter,
)
client: ElasticLoadBalancingv2Client = boto3.client("elbv2")
# now client usage is checked by mypy and IDE should provide code auto-complete
# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: ElasticLoadBalancingv2Client = session.client("elbv2")
Paginators annotations
mypy_boto3_elbv2.paginator
module contains type annotations for all paginators.
client: ElasticLoadBalancingv2Client = boto3.client("elbv2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
describe_account_limits_paginator: DescribeAccountLimitsPaginator = client.get_paginator("describe_account_limits")
describe_listener_certificates_paginator: DescribeListenerCertificatesPaginator = client.get_paginator("describe_listener_certificates")
describe_listeners_paginator: DescribeListenersPaginator = client.get_paginator("describe_listeners")
describe_load_balancers_paginator: DescribeLoadBalancersPaginator = client.get_paginator("describe_load_balancers")
describe_rules_paginator: DescribeRulesPaginator = client.get_paginator("describe_rules")
describe_ssl_policies_paginator: DescribeSSLPoliciesPaginator = client.get_paginator("describe_ssl_policies")
describe_target_groups_paginator: DescribeTargetGroupsPaginator = client.get_paginator("describe_target_groups")
Waiters annotations
mypy_boto3_elbv2.waiter
module contains type annotations for all waiters.
client: ElasticLoadBalancingv2Client = boto3.client("elbv2")
# Explicit type annotations are optional here
# Type should be correctly discovered by mypy and IDEs
# VSCode requires explicit type annotations
load_balancer_available_waiter: LoadBalancerAvailableWaiter = client.get_waiter("load_balancer_available")
load_balancer_exists_waiter: LoadBalancerExistsWaiter = client.get_waiter("load_balancer_exists")
load_balancers_deleted_waiter: LoadBalancersDeletedWaiter = client.get_waiter("load_balancers_deleted")
target_deregistered_waiter: TargetDeregisteredWaiter = client.get_waiter("target_deregistered")
target_in_service_waiter: TargetInServiceWaiter = client.get_waiter("target_in_service")
Typed dictionations
mypy_boto3_elbv2.type_defs
module contains structures and shapes assembled
to typed dictionaries for additional type checking.
def get_structure() -> ActionTypeDef:
return {
...
}
Dynamic type annotations
mypy_boto3
command generates boto3.client/resource
type annotations for
mypy_boto3_elbv2
and other installed services.
# Run this command after you add or remove service packages
python -m mypy_boto3
Generated type annotations provide overloads for boto3.client
and boto3.resource
,
boto3.Session.client
and boto3.Session.resource
functions,
so explicit type annotations are not needed.
mypy
supports function overloads as expectedPyCharm
also supports function overloads, but consumes a lot of RAM, use carefully if you have many services installedVSCode
does not currently support function overloads, use explicit type annotations
# Type is discovered correctly by mypy and PyCharm
# VSCode still needs explicit type annotations
client = boto3.client("elbv2")
session_client = boto3.Session().client("elbv2")
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mypy-boto3-elbv2-1.14.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3d855a04915187343d85c61b542ca14fa3b9b49f14a0368798420fb0bee1bc0 |
|
MD5 | cdf5c65e5cad94c968f491e8a9407214 |
|
BLAKE2b-256 | a260d27503b8dd41d6e0dca2fe979cdb22157eca4b5d9043f3892fc1e69a65c9 |
Hashes for mypy_boto3_elbv2-1.14.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8ef3f43799999db65fbba7434b331b0814f269dc9b55ab0031f1c019e3a06de |
|
MD5 | 8c3137ce4a6b780d7065a00341dc752d |
|
BLAKE2b-256 | ef9009a98063965296c5bf9b625cb30c3e5b46a484a999a3218edbc8a419b72a |