ElasticBeanstalk module#

Index > ElasticBeanstalk

Auto-generated documentation for ElasticBeanstalk type annotations stubs module mypy-boto3-elasticbeanstalk.

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

From PyPI with pip#

Install boto3-stubs for ElasticBeanstalk service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

ElasticBeanstalkClient#

Type annotations and code completion for boto3.client("elasticbeanstalk") as ElasticBeanstalkClient boto3 documentation

# ElasticBeanstalkClient usage example

from boto3.session import Session

from mypy_boto3_elasticbeanstalk.client import ElasticBeanstalkClient

def get_client() -> ElasticBeanstalkClient:
    return Session().client("elasticbeanstalk")

Paginators#

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

# DescribeApplicationVersionsPaginator usage example

from boto3.session import Session

from mypy_boto3_elasticbeanstalk.paginator import DescribeApplicationVersionsPaginator

def get_describe_application_versions_paginator() -> DescribeApplicationVersionsPaginator:
    return Session().client("elasticbeanstalk").get_paginator("describe_application_versions"))

Waiters#

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

# EnvironmentExistsWaiter usage example

from boto3.session import Session

from mypy_boto3_elasticbeanstalk.waiter import EnvironmentExistsWaiter

def get_environment_exists_waiter() -> EnvironmentExistsWaiter:
    return Session().client("elasticbeanstalk").get_waiter("environment_exists")

Literals#

Type annotations for literals used in methods and schemas.

# ActionHistoryStatusType usage example

from mypy_boto3_elasticbeanstalk.literals import ActionHistoryStatusType

def get_value() -> ActionHistoryStatusType:
    return "Completed"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AbortEnvironmentUpdateMessageRequestTypeDef usage example

from mypy_boto3_elasticbeanstalk.type_defs import AbortEnvironmentUpdateMessageRequestTypeDef

def get_value() -> AbortEnvironmentUpdateMessageRequestTypeDef:
    return {
        "EnvironmentId": ...,
    }