ElasticBeanstalk module#
Index > ElasticBeanstalk
Auto-generated documentation for ElasticBeanstalk type annotations stubs module mypy-boto3-elasticbeanstalk.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy_boto3_builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.35.86' mypy_boto3_builder
- Select
boto3-stubs
AWS SDK. - Add
ElasticBeanstalk
service. - Use provided commands to install generated packages.
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"))
- DescribeApplicationVersionsPaginator
- DescribeEnvironmentManagedActionHistoryPaginator
- DescribeEnvironmentsPaginator
- DescribeEventsPaginator
- ListPlatformVersionsPaginator
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 schema.
# ActionHistoryStatusType usage example
from mypy_boto3_elasticbeanstalk.literals import ActionHistoryStatusType
def get_value() -> ActionHistoryStatusType:
return "Completed"
- ActionHistoryStatusType
- ActionStatusType
- ActionTypeType
- ApplicationVersionStatusType
- ComputeTypeType
- ConfigurationDeploymentStatusType
- ConfigurationOptionValueTypeType
- DescribeApplicationVersionsPaginatorName
- DescribeEnvironmentManagedActionHistoryPaginatorName
- DescribeEnvironmentsPaginatorName
- DescribeEventsPaginatorName
- EnvironmentExistsWaiterName
- EnvironmentHealthAttributeType
- EnvironmentHealthStatusType
- EnvironmentHealthType
- EnvironmentInfoTypeType
- EnvironmentStatusType
- EnvironmentTerminatedWaiterName
- EnvironmentUpdatedWaiterName
- EventSeverityType
- FailureTypeType
- InstancesHealthAttributeType
- ListPlatformVersionsPaginatorName
- PlatformStatusType
- SourceRepositoryType
- SourceTypeType
- ValidationSeverityType
- ElasticBeanstalkServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- WaiterName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AbortEnvironmentUpdateMessageRequestTypeDef
- ResponseMetadataTypeDef
- LatencyTypeDef
- StatusCodesTypeDef
- S3LocationTypeDef
- SourceBuildInformationTypeDef
- MaxAgeRuleTypeDef
- MaxCountRuleTypeDef
- ApplyEnvironmentManagedActionRequestRequestTypeDef
- AssociateEnvironmentOperationsRoleMessageRequestTypeDef
- AutoScalingGroupTypeDef
- BuildConfigurationTypeDef
- BuilderTypeDef
- CPUUtilizationTypeDef
- CheckDNSAvailabilityMessageRequestTypeDef
- ComposeEnvironmentsMessageRequestTypeDef
- OptionRestrictionRegexTypeDef
- ConfigurationOptionSettingTypeDef
- ValidationMessageTypeDef
- TagTypeDef
- SourceConfigurationTypeDef
- EnvironmentTierTypeDef
- OptionSpecificationTypeDef
- PlatformSummaryTypeDef
- CustomAmiTypeDef
- DeleteApplicationMessageRequestTypeDef
- DeleteApplicationVersionMessageRequestTypeDef
- DeleteConfigurationTemplateMessageRequestTypeDef
- DeleteEnvironmentConfigurationMessageRequestTypeDef
- DeletePlatformVersionRequestRequestTypeDef
- DeploymentTypeDef
- PaginatorConfigTypeDef
- DescribeApplicationVersionsMessageRequestTypeDef
- DescribeApplicationsMessageRequestTypeDef
- DescribeConfigurationSettingsMessageRequestTypeDef
- DescribeEnvironmentHealthRequestRequestTypeDef
- InstanceHealthSummaryTypeDef
- DescribeEnvironmentManagedActionHistoryRequestRequestTypeDef
- ManagedActionHistoryItemTypeDef
- DescribeEnvironmentManagedActionsRequestRequestTypeDef
- ManagedActionTypeDef
- DescribeEnvironmentResourcesMessageRequestTypeDef
- TimestampTypeDef
- WaiterConfigTypeDef
- DescribeInstancesHealthRequestRequestTypeDef
- DescribePlatformVersionRequestRequestTypeDef
- DisassociateEnvironmentOperationsRoleMessageRequestTypeDef
- EnvironmentLinkTypeDef
- EnvironmentInfoDescriptionTypeDef
- InstanceTypeDef
- LaunchConfigurationTypeDef
- LaunchTemplateTypeDef
- LoadBalancerTypeDef
- QueueTypeDef
- TriggerTypeDef
- EventDescriptionTypeDef
- SolutionStackDescriptionTypeDef
- SearchFilterTypeDef
- PlatformBranchSummaryTypeDef
- PlatformFilterTypeDef
- ListTagsForResourceMessageRequestTypeDef
- ListenerTypeDef
- PlatformFrameworkTypeDef
- PlatformProgrammingLanguageTypeDef
- RebuildEnvironmentMessageRequestTypeDef
- RequestEnvironmentInfoMessageRequestTypeDef
- ResourceQuotaTypeDef
- RestartAppServerMessageRequestTypeDef
- RetrieveEnvironmentInfoMessageRequestTypeDef
- SwapEnvironmentCNAMEsMessageRequestTypeDef
- TerminateEnvironmentMessageRequestTypeDef
- UpdateApplicationMessageRequestTypeDef
- UpdateApplicationVersionMessageRequestTypeDef
- ApplyEnvironmentManagedActionResultTypeDef
- CheckDNSAvailabilityResultMessageTypeDef
- CreateStorageLocationResultMessageTypeDef
- EmptyResponseMetadataTypeDef
- ApplicationMetricsTypeDef
- ApplicationVersionDescriptionTypeDef
- ApplicationVersionLifecycleConfigTypeDef
- SystemStatusTypeDef
- ConfigurationOptionDescriptionTypeDef
- ConfigurationSettingsDescriptionResponseTypeDef
- ConfigurationSettingsDescriptionTypeDef
- ValidateConfigurationSettingsMessageRequestTypeDef
- ConfigurationSettingsValidationMessagesTypeDef
- CreateApplicationVersionMessageRequestTypeDef
- CreatePlatformVersionRequestRequestTypeDef
- ResourceTagsDescriptionMessageTypeDef
- UpdateTagsForResourceMessageRequestTypeDef
- CreateConfigurationTemplateMessageRequestTypeDef
- CreateEnvironmentMessageRequestTypeDef
- DescribeConfigurationOptionsMessageRequestTypeDef
- UpdateConfigurationTemplateMessageRequestTypeDef
- UpdateEnvironmentMessageRequestTypeDef
- CreatePlatformVersionResultTypeDef
- DeletePlatformVersionResultTypeDef
- ListPlatformVersionsResultTypeDef
- DescribeApplicationVersionsMessagePaginateTypeDef
- DescribeEnvironmentManagedActionHistoryRequestPaginateTypeDef
- DescribeEnvironmentManagedActionHistoryResultTypeDef
- DescribeEnvironmentManagedActionsResultTypeDef
- DescribeEnvironmentsMessagePaginateTypeDef
- DescribeEnvironmentsMessageRequestTypeDef
- DescribeEventsMessagePaginateTypeDef
- DescribeEventsMessageRequestTypeDef
- DescribeEnvironmentsMessageWaitTypeDef
- RetrieveEnvironmentInfoResultMessageTypeDef
- EnvironmentResourceDescriptionTypeDef
- EventDescriptionsMessageTypeDef
- ListAvailableSolutionStacksResultMessageTypeDef
- ListPlatformBranchesRequestRequestTypeDef
- ListPlatformBranchesResultTypeDef
- ListPlatformVersionsRequestPaginateTypeDef
- ListPlatformVersionsRequestRequestTypeDef
- LoadBalancerDescriptionTypeDef
- PlatformDescriptionTypeDef
- ResourceQuotasTypeDef
- DescribeEnvironmentHealthResultTypeDef
- ApplicationVersionDescriptionMessageTypeDef
- ApplicationVersionDescriptionsMessageTypeDef
- ApplicationResourceLifecycleConfigTypeDef
- SingleInstanceHealthTypeDef
- ConfigurationOptionsDescriptionTypeDef
- ConfigurationSettingsDescriptionsTypeDef
- EnvironmentResourceDescriptionsMessageTypeDef
- EnvironmentResourcesDescriptionTypeDef
- DescribePlatformVersionResultTypeDef
- DescribeAccountAttributesResultTypeDef
- ApplicationDescriptionTypeDef
- ApplicationResourceLifecycleDescriptionMessageTypeDef
- CreateApplicationMessageRequestTypeDef
- UpdateApplicationResourceLifecycleMessageRequestTypeDef
- DescribeInstancesHealthResultTypeDef
- EnvironmentDescriptionResponseTypeDef
- EnvironmentDescriptionTypeDef
- ApplicationDescriptionMessageTypeDef
- ApplicationDescriptionsMessageTypeDef
- EnvironmentDescriptionsMessageTypeDef