Skip to content

ElasticBeanstalkClient#

Index > ElasticBeanstalk > ElasticBeanstalkClient

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

ElasticBeanstalkClient#

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

# ElasticBeanstalkClient usage example

from boto3.session import Session
from mypy_boto3_elasticbeanstalk.client import ElasticBeanstalkClient

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

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("elasticbeanstalk").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("elasticbeanstalk")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.CodeBuildNotInServiceRegionException,
    client.exceptions.ElasticBeanstalkServiceException,
    client.exceptions.InsufficientPrivilegesException,
    client.exceptions.InvalidRequestException,
    client.exceptions.ManagedActionInvalidStateException,
    client.exceptions.OperationInProgressException,
    client.exceptions.PlatformVersionStillReferencedException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceTypeNotSupportedException,
    client.exceptions.S3LocationNotInServiceRegionException,
    client.exceptions.S3SubscriptionRequiredException,
    client.exceptions.SourceBundleDeletionException,
    client.exceptions.TooManyApplicationVersionsException,
    client.exceptions.TooManyApplicationsException,
    client.exceptions.TooManyBucketsException,
    client.exceptions.TooManyConfigurationTemplatesException,
    client.exceptions.TooManyEnvironmentsException,
    client.exceptions.TooManyPlatformsException,
    client.exceptions.TooManyTagsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_elasticbeanstalk.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods#

abort_environment_update#

Cancels in-progress environment configuration update or application version deployment.

Type annotations and code completion for boto3.client("elasticbeanstalk").abort_environment_update method. boto3 documentation

# abort_environment_update method definition

def abort_environment_update(
    self,
    *,
    EnvironmentId: str = ...,
    EnvironmentName: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# abort_environment_update method usage example with argument unpacking

kwargs: AbortEnvironmentUpdateMessageRequestTypeDef = {  # (1)
    "EnvironmentId": ...,
}

parent.abort_environment_update(**kwargs)
  1. See AbortEnvironmentUpdateMessageRequestTypeDef

apply_environment_managed_action#

Applies a scheduled managed action immediately.

Type annotations and code completion for boto3.client("elasticbeanstalk").apply_environment_managed_action method. boto3 documentation

# apply_environment_managed_action method definition

def apply_environment_managed_action(
    self,
    *,
    ActionId: str,
    EnvironmentName: str = ...,
    EnvironmentId: str = ...,
) -> ApplyEnvironmentManagedActionResultTypeDef:  # (1)
    ...
  1. See ApplyEnvironmentManagedActionResultTypeDef
# apply_environment_managed_action method usage example with argument unpacking

kwargs: ApplyEnvironmentManagedActionRequestRequestTypeDef = {  # (1)
    "ActionId": ...,
}

parent.apply_environment_managed_action(**kwargs)
  1. See ApplyEnvironmentManagedActionRequestRequestTypeDef

associate_environment_operations_role#

Add or change the operations role used by an environment.

Type annotations and code completion for boto3.client("elasticbeanstalk").associate_environment_operations_role method. boto3 documentation

# associate_environment_operations_role method definition

def associate_environment_operations_role(
    self,
    *,
    EnvironmentName: str,
    OperationsRole: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# associate_environment_operations_role method usage example with argument unpacking

kwargs: AssociateEnvironmentOperationsRoleMessageRequestTypeDef = {  # (1)
    "EnvironmentName": ...,
    "OperationsRole": ...,
}

parent.associate_environment_operations_role(**kwargs)
  1. See AssociateEnvironmentOperationsRoleMessageRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("elasticbeanstalk").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

check_dns_availability#

Checks if the specified CNAME is available.

Type annotations and code completion for boto3.client("elasticbeanstalk").check_dns_availability method. boto3 documentation

# check_dns_availability method definition

def check_dns_availability(
    self,
    *,
    CNAMEPrefix: str,
) -> CheckDNSAvailabilityResultMessageTypeDef:  # (1)
    ...
  1. See CheckDNSAvailabilityResultMessageTypeDef
# check_dns_availability method usage example with argument unpacking

kwargs: CheckDNSAvailabilityMessageRequestTypeDef = {  # (1)
    "CNAMEPrefix": ...,
}

parent.check_dns_availability(**kwargs)
  1. See CheckDNSAvailabilityMessageRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("elasticbeanstalk").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

compose_environments#

Create or update a group of environments that each run a separate component of a single application.

Type annotations and code completion for boto3.client("elasticbeanstalk").compose_environments method. boto3 documentation

# compose_environments method definition

def compose_environments(
    self,
    *,
    ApplicationName: str = ...,
    GroupName: str = ...,
    VersionLabels: Sequence[str] = ...,
) -> EnvironmentDescriptionsMessageTypeDef:  # (1)
    ...
  1. See EnvironmentDescriptionsMessageTypeDef
# compose_environments method usage example with argument unpacking

kwargs: ComposeEnvironmentsMessageRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.compose_environments(**kwargs)
  1. See ComposeEnvironmentsMessageRequestTypeDef

create_application#

Creates an application that has one configuration template named default and no application versions.

Type annotations and code completion for boto3.client("elasticbeanstalk").create_application method. boto3 documentation

# create_application method definition

def create_application(
    self,
    *,
    ApplicationName: str,
    Description: str = ...,
    ResourceLifecycleConfig: ApplicationResourceLifecycleConfigTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
) -> ApplicationDescriptionMessageTypeDef:  # (3)
    ...
  1. See ApplicationResourceLifecycleConfigTypeDef
  2. See TagTypeDef
  3. See ApplicationDescriptionMessageTypeDef
# create_application method usage example with argument unpacking

kwargs: CreateApplicationMessageRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.create_application(**kwargs)
  1. See CreateApplicationMessageRequestTypeDef

create_application_version#

Creates an application version for the specified application.

Type annotations and code completion for boto3.client("elasticbeanstalk").create_application_version method. boto3 documentation

# create_application_version method definition

def create_application_version(
    self,
    *,
    ApplicationName: str,
    VersionLabel: str,
    Description: str = ...,
    SourceBuildInformation: SourceBuildInformationTypeDef = ...,  # (1)
    SourceBundle: S3LocationTypeDef = ...,  # (2)
    BuildConfiguration: BuildConfigurationTypeDef = ...,  # (3)
    AutoCreateApplication: bool = ...,
    Process: bool = ...,
    Tags: Sequence[TagTypeDef] = ...,  # (4)
) -> ApplicationVersionDescriptionMessageTypeDef:  # (5)
    ...
  1. See SourceBuildInformationTypeDef
  2. See S3LocationTypeDef
  3. See BuildConfigurationTypeDef
  4. See TagTypeDef
  5. See ApplicationVersionDescriptionMessageTypeDef
# create_application_version method usage example with argument unpacking

kwargs: CreateApplicationVersionMessageRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "VersionLabel": ...,
}

parent.create_application_version(**kwargs)
  1. See CreateApplicationVersionMessageRequestTypeDef

create_configuration_template#

Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.

Type annotations and code completion for boto3.client("elasticbeanstalk").create_configuration_template method. boto3 documentation

# create_configuration_template method definition

def create_configuration_template(
    self,
    *,
    ApplicationName: str,
    TemplateName: str,
    SolutionStackName: str = ...,
    PlatformArn: str = ...,
    SourceConfiguration: SourceConfigurationTypeDef = ...,  # (1)
    EnvironmentId: str = ...,
    Description: str = ...,
    OptionSettings: Sequence[ConfigurationOptionSettingTypeDef] = ...,  # (2)
    Tags: Sequence[TagTypeDef] = ...,  # (3)
) -> ConfigurationSettingsDescriptionResponseTypeDef:  # (4)
    ...
  1. See SourceConfigurationTypeDef
  2. See ConfigurationOptionSettingTypeDef
  3. See TagTypeDef
  4. See ConfigurationSettingsDescriptionResponseTypeDef
# create_configuration_template method usage example with argument unpacking

kwargs: CreateConfigurationTemplateMessageRequestTypeDef = {  # (1)
    "ApplicationName": ...,
    "TemplateName": ...,
}

parent.create_configuration_template(**kwargs)
  1. See CreateConfigurationTemplateMessageRequestTypeDef

create_environment#

Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

Type annotations and code completion for boto3.client("elasticbeanstalk").create_environment method. boto3 documentation

# create_environment method definition

def create_environment(
    self,
    *,
    ApplicationName: str,
    EnvironmentName: str = ...,
    GroupName: str = ...,
    Description: str = ...,
    CNAMEPrefix: str = ...,
    Tier: EnvironmentTierTypeDef = ...,  # (1)
    Tags: Sequence[TagTypeDef] = ...,  # (2)
    VersionLabel: str = ...,
    TemplateName: str = ...,
    SolutionStackName: str = ...,
    PlatformArn: str = ...,
    OptionSettings: Sequence[ConfigurationOptionSettingTypeDef] = ...,  # (3)
    OptionsToRemove: Sequence[OptionSpecificationTypeDef] = ...,  # (4)
    OperationsRole: str = ...,
) -> EnvironmentDescriptionResponseTypeDef:  # (5)
    ...
  1. See EnvironmentTierTypeDef
  2. See TagTypeDef
  3. See ConfigurationOptionSettingTypeDef
  4. See OptionSpecificationTypeDef
  5. See EnvironmentDescriptionResponseTypeDef
# create_environment method usage example with argument unpacking

kwargs: CreateEnvironmentMessageRequestTypeDef = {  # (1)
    "ApplicationName": ...,
}

parent.create_environment(**kwargs)
  1. See CreateEnvironmentMessageRequestTypeDef

create_platform_version#

Create a new version of your custom platform.

Type annotations and code completion for boto3.client("elasticbeanstalk").create_platform_version method. boto3 documentation