Expand description
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is https://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
If you’re using the service, you’re probably looking for ElasticBeanstalkClient and ElasticBeanstalk.
Structs§
- Abort
Environment Update Message - Application
Description Describes the properties of an application.
- Application
Description Message Result message containing a single description of an application.
- Application
Descriptions Message Result message containing a list of application descriptions.
- Application
Metrics Application request metrics for an AWS Elastic Beanstalk environment.
- Application
Resource Lifecycle Config The resource lifecycle configuration for an application. Defines lifecycle settings for resources that belong to the application, and the service role that AWS Elastic Beanstalk assumes in order to apply lifecycle settings. The version lifecycle configuration defines lifecycle settings for application versions.
- Application
Resource Lifecycle Description Message - Application
Version Description Describes the properties of an application version.
- Application
Version Description Message Result message wrapping a single description of an application version.
- Application
Version Descriptions Message Result message wrapping a list of application version descriptions.
- Application
Version Lifecycle Config The application version lifecycle settings for an application. Defines the rules that Elastic Beanstalk applies to an application's versions in order to avoid hitting the per-region limit for application versions.
When Elastic Beanstalk deletes an application version from its database, you can no longer deploy that version to an environment. The source bundle remains in S3 unless you configure the rule to delete it.
- Apply
Environment Managed Action Request Request to execute a scheduled managed action immediately.
- Apply
Environment Managed Action Result The result message containing information about the managed action.
- Associate
Environment Operations Role Message Request to add or change the operations role used by an environment.
- Auto
Scaling Group Describes an Auto Scaling launch configuration.
- Build
Configuration Settings for an AWS CodeBuild build.
- Builder
The builder used to build the custom platform.
- CPUUtilization
CPU utilization metrics for an instance.
- CheckDNS
Availability Message Results message indicating whether a CNAME is available.
- CheckDNS
Availability Result Message Indicates if the specified CNAME is available.
- Compose
Environments Message Request to create or update a group of environments.
- Configuration
Option Description Describes the possible values for a configuration option.
- Configuration
Option Setting A specification identifying an individual configuration option along with its current value. For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide.
- Configuration
Options Description Describes the settings for a specified configuration set.
- Configuration
Settings Description Describes the settings for a configuration set.
- Configuration
Settings Descriptions The results from a request to change the configuration settings of an environment.
- Configuration
Settings Validation Messages Provides a list of validation messages.
- Create
Application Message Request to create an application.
- Create
Application Version Message - Create
Configuration Template Message Request to create a configuration template.
- Create
Environment Message - Create
Platform Version Request Request to create a new platform version.
- Create
Platform Version Result - Create
Storage Location Result Message Results of a CreateStorageLocationResult call.
- Custom
Ami A custom AMI available to platforms.
- Delete
Application Message Request to delete an application.
- Delete
Application Version Message Request to delete an application version.
- Delete
Configuration Template Message Request to delete a configuration template.
- Delete
Environment Configuration Message Request to delete a draft environment configuration.
- Delete
Platform Version Request - Delete
Platform Version Result - Deployment
Information about an application version deployment.
- Describe
Account Attributes Result - Describe
Application Versions Message Request to describe application versions.
- Describe
Applications Message Request to describe one or more applications.
- Describe
Configuration Options Message Result message containing a list of application version descriptions.
- Describe
Configuration Settings Message Result message containing all of the configuration settings for a specified solution stack or configuration template.
- Describe
Environment Health Request See the example below to learn how to create a request body.
- Describe
Environment Health Result Health details for an AWS Elastic Beanstalk environment.
- Describe
Environment Managed Action History Request Request to list completed and failed managed actions.
- Describe
Environment Managed Action History Result A result message containing a list of completed and failed managed actions.
- Describe
Environment Managed Actions Request Request to list an environment's upcoming and in-progress managed actions.
- Describe
Environment Managed Actions Result The result message containing a list of managed actions.
- Describe
Environment Resources Message Request to describe the resources in an environment.
- Describe
Environments Message Request to describe one or more environments.
- Describe
Events Message Request to retrieve a list of events for an environment.
- Describe
Instances Health Request Parameters for a call to
DescribeInstancesHealth.- Describe
Instances Health Result Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.
- Describe
Platform Version Request - Describe
Platform Version Result - Disassociate
Environment Operations Role Message Request to disassociate the operations role from an environment.
- Elastic
Beanstalk Client - A client for the Elastic Beanstalk API.
- Environment
Description Describes the properties of an environment.
- Environment
Descriptions Message Result message containing a list of environment descriptions.
- Environment
Info Description The information retrieved from the Amazon EC2 instances.
- Environment
Link A link to another environment, defined in the environment's manifest. Links provide connection information in system properties that can be used to connect to another environment in the same group. See Environment Manifest (env.yaml) for details.
- Environment
Resource Description Describes the AWS resources in use by this environment. This data is live.
- Environment
Resource Descriptions Message Result message containing a list of environment resource descriptions.
- Environment
Resources Description Describes the AWS resources in use by this environment. This data is not live data.
- Environment
Tier Describes the properties of an environment tier
- Event
Description Describes an event.
- Event
Descriptions Message Result message wrapping a list of event descriptions.
- Instance
The description of an Amazon EC2 instance.
- Instance
Health Summary Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.
- Latency
Represents the average latency for the slowest X percent of requests over the last 10 seconds.
- Launch
Configuration Describes an Auto Scaling launch configuration.
- Launch
Template Describes an Amazon EC2 launch template.
- List
Available Solution Stacks Result Message A list of available AWS Elastic Beanstalk solution stacks.
- List
Platform Branches Request - List
Platform Branches Result - List
Platform Versions Request - List
Platform Versions Result - List
Tags ForResource Message - Listener
Describes the properties of a Listener for the LoadBalancer.
- Load
Balancer Describes a LoadBalancer.
- Load
Balancer Description Describes the details of a LoadBalancer.
- Managed
Action The record of an upcoming or in-progress managed action.
- Managed
Action History Item The record of a completed or failed managed action.
- MaxAge
Rule A lifecycle rule that deletes application versions after the specified number of days.
- MaxCount
Rule A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.
- Option
Restriction Regex A regular expression representing a restriction on a string configuration option value.
- Option
Specification A specification identifying an individual configuration option.
- Platform
Branch Summary Summary information about a platform branch.
- Platform
Description Detailed information about a platform version.
- Platform
Filter Describes criteria to restrict the results when listing platform versions.
The filter is evaluated as follows:
Type Operator Values[1]- Platform
Framework A framework supported by the platform.
- Platform
Programming Language A programming language supported by the platform.
- Platform
Summary Summary information about a platform version.
- Queue
Describes a queue.
- Rebuild
Environment Message - Request
Environment Info Message Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
- Resource
Quota The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.
- Resource
Quotas A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.
- Resource
Tags Description Message - Restart
AppServer Message - Retrieve
Environment Info Message Request to download logs retrieved with RequestEnvironmentInfo.
- Retrieve
Environment Info Result Message Result message containing a description of the requested environment info.
- S3Location
The bucket and key of an item stored in Amazon S3.
- Search
Filter Describes criteria to restrict a list of results.
For operators that apply a single value to the attribute, the filter is evaluated as follows:
Attribute Operator Values[1]Some operators, e.g.
in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values:(Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...The valid values for attributes of
SearchFilterdepend on the API action. For valid values, see the reference page for the API action you're calling that takes aSearchFilterparameter.- Single
Instance Health Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.
- Solution
Stack Description Describes the solution stack.
- Source
Build Information Location of the source code for an application version.
- Source
Configuration A specification for an environment configuration.
- Status
Codes Represents the percentage of requests over the last 10 seconds that resulted in each type of status code response. For more information, see Status Code Definitions.
- Swap
EnvironmentCNAM EsMessage Swaps the CNAMEs of two environments.
- System
Status CPU utilization and load average metrics for an Amazon EC2 instance.
- Tag
Describes a tag applied to a resource in an environment.
- Terminate
Environment Message Request to terminate an environment.
- Trigger
Describes a trigger.
- Update
Application Message Request to update an application.
- Update
Application Resource Lifecycle Message - Update
Application Version Message - Update
Configuration Template Message The result message containing the options for the specified solution stack.
- Update
Environment Message Request to update an environment.
- Update
Tags ForResource Message - Validate
Configuration Settings Message A list of validation messages for a specified configuration template.
- Validation
Message An error or warning for a desired configuration option value.
Enums§
- Abort
Environment Update Error - Errors returned by AbortEnvironmentUpdate
- Apply
Environment Managed Action Error - Errors returned by ApplyEnvironmentManagedAction
- Associate
Environment Operations Role Error - Errors returned by AssociateEnvironmentOperationsRole
- CheckDNS
Availability Error - Errors returned by CheckDNSAvailability
- Compose
Environments Error - Errors returned by ComposeEnvironments
- Create
Application Error - Errors returned by CreateApplication
- Create
Application Version Error - Errors returned by CreateApplicationVersion
- Create
Configuration Template Error - Errors returned by CreateConfigurationTemplate
- Create
Environment Error - Errors returned by CreateEnvironment
- Create
Platform Version Error - Errors returned by CreatePlatformVersion
- Create
Storage Location Error - Errors returned by CreateStorageLocation
- Delete
Application Error - Errors returned by DeleteApplication
- Delete
Application Version Error - Errors returned by DeleteApplicationVersion
- Delete
Configuration Template Error - Errors returned by DeleteConfigurationTemplate
- Delete
Environment Configuration Error - Errors returned by DeleteEnvironmentConfiguration
- Delete
Platform Version Error - Errors returned by DeletePlatformVersion
- Describe
Account Attributes Error - Errors returned by DescribeAccountAttributes
- Describe
Application Versions Error - Errors returned by DescribeApplicationVersions
- Describe
Applications Error - Errors returned by DescribeApplications
- Describe
Configuration Options Error - Errors returned by DescribeConfigurationOptions
- Describe
Configuration Settings Error - Errors returned by DescribeConfigurationSettings
- Describe
Environment Health Error - Errors returned by DescribeEnvironmentHealth
- Describe
Environment Managed Action History Error - Errors returned by DescribeEnvironmentManagedActionHistory
- Describe
Environment Managed Actions Error - Errors returned by DescribeEnvironmentManagedActions
- Describe
Environment Resources Error - Errors returned by DescribeEnvironmentResources
- Describe
Environments Error - Errors returned by DescribeEnvironments
- Describe
Events Error - Errors returned by DescribeEvents
- Describe
Instances Health Error - Errors returned by DescribeInstancesHealth
- Describe
Platform Version Error - Errors returned by DescribePlatformVersion
- Disassociate
Environment Operations Role Error - Errors returned by DisassociateEnvironmentOperationsRole
- List
Available Solution Stacks Error - Errors returned by ListAvailableSolutionStacks
- List
Platform Branches Error - Errors returned by ListPlatformBranches
- List
Platform Versions Error - Errors returned by ListPlatformVersions
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- Rebuild
Environment Error - Errors returned by RebuildEnvironment
- Request
Environment Info Error - Errors returned by RequestEnvironmentInfo
- Restart
AppServer Error - Errors returned by RestartAppServer
- Retrieve
Environment Info Error - Errors returned by RetrieveEnvironmentInfo
- Swap
EnvironmentCNAM EsError - Errors returned by SwapEnvironmentCNAMEs
- Terminate
Environment Error - Errors returned by TerminateEnvironment
- Update
Application Error - Errors returned by UpdateApplication
- Update
Application Resource Lifecycle Error - Errors returned by UpdateApplicationResourceLifecycle
- Update
Application Version Error - Errors returned by UpdateApplicationVersion
- Update
Configuration Template Error - Errors returned by UpdateConfigurationTemplate
- Update
Environment Error - Errors returned by UpdateEnvironment
- Update
Tags ForResource Error - Errors returned by UpdateTagsForResource
- Validate
Configuration Settings Error - Errors returned by ValidateConfigurationSettings
Traits§
- Elastic
Beanstalk - Trait representing the capabilities of the Elastic Beanstalk API. Elastic Beanstalk clients implement this trait.