logo
Expand description

AWS Elastic Beanstalk

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

Describes the properties of an application.

Result message containing a single description of an application.

Result message containing a list of application descriptions.

Application request metrics for an AWS Elastic Beanstalk environment.

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.

Describes the properties of an application version.

Result message wrapping a single description of an application version.

Result message wrapping a list of application version descriptions.

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.

Request to execute a scheduled managed action immediately.

The result message containing information about the managed action.

Request to add or change the operations role used by an environment.

Describes an Auto Scaling launch configuration.

Settings for an AWS CodeBuild build.

The builder used to build the custom platform.

CPU utilization metrics for an instance.

Results message indicating whether a CNAME is available.

Indicates if the specified CNAME is available.

Request to create or update a group of environments.

Describes the possible values for a configuration option.

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.

Describes the settings for a specified configuration set.

Describes the settings for a configuration set.

The results from a request to change the configuration settings of an environment.

Provides a list of validation messages.

Request to create an application.

Request to create a configuration template.

Request to create a new platform version.

A custom AMI available to platforms.

Request to delete an application.

Request to delete an application version.

Request to delete a configuration template.

Request to delete a draft environment configuration.

Information about an application version deployment.

Request to describe application versions.

Request to describe one or more applications.

Result message containing a list of application version descriptions.

Result message containing all of the configuration settings for a specified solution stack or configuration template.

See the example below to learn how to create a request body.

Health details for an AWS Elastic Beanstalk environment.

Request to list completed and failed managed actions.

A result message containing a list of completed and failed managed actions.

Request to list an environment's upcoming and in-progress managed actions.

The result message containing a list of managed actions.

Request to describe the resources in an environment.

Request to describe one or more environments.

Request to retrieve a list of events for an environment.

Parameters for a call to DescribeInstancesHealth.

Detailed health information about the Amazon EC2 instances in an AWS Elastic Beanstalk environment.

Request to disassociate the operations role from an environment.

A client for the Elastic Beanstalk API.

Describes the properties of an environment.

Result message containing a list of environment descriptions.

The information retrieved from the Amazon EC2 instances.

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.

Describes the AWS resources in use by this environment. This data is live.

Result message containing a list of environment resource descriptions.

Describes the AWS resources in use by this environment. This data is not live data.

Describes the properties of an environment tier

Describes an event.

Result message wrapping a list of event descriptions.

The description of an Amazon EC2 instance.

Represents summary information about the health of an instance. For more information, see Health Colors and Statuses.

Represents the average latency for the slowest X percent of requests over the last 10 seconds.

Describes an Auto Scaling launch configuration.

Describes an Amazon EC2 launch template.

A list of available AWS Elastic Beanstalk solution stacks.

Describes the properties of a Listener for the LoadBalancer.

Describes a LoadBalancer.

Describes the details of a LoadBalancer.

The record of an upcoming or in-progress managed action.

The record of a completed or failed managed action.

A lifecycle rule that deletes application versions after the specified number of days.

A lifecycle rule that deletes the oldest application version when the maximum count is exceeded.

A regular expression representing a restriction on a string configuration option value.

A specification identifying an individual configuration option.

Summary information about a platform branch.

Detailed information about a platform version.

Describes criteria to restrict the results when listing platform versions.

The filter is evaluated as follows: Type Operator Values[1]

A framework supported by the platform.

A programming language supported by the platform.

Summary information about a platform version.

Describes a queue.

Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.

The AWS Elastic Beanstalk quota information for a single resource type in an AWS account. It reflects the resource's limits for this account.

A set of per-resource AWS Elastic Beanstalk quotas associated with an AWS account. They reflect Elastic Beanstalk resource limits for this account.

Request to download logs retrieved with RequestEnvironmentInfo.

Result message containing a description of the requested environment info.

The bucket and key of an item stored in Amazon S3.

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 SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

Detailed health information about an Amazon EC2 instance in your Elastic Beanstalk environment.

Describes the solution stack.

Location of the source code for an application version.

A specification for an environment configuration.

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.

Swaps the CNAMEs of two environments.

CPU utilization and load average metrics for an Amazon EC2 instance.

Describes a tag applied to a resource in an environment.

Request to terminate an environment.

Describes a trigger.

Request to update an application.

The result message containing the options for the specified solution stack.

Request to update an environment.

A list of validation messages for a specified configuration template.

An error or warning for a desired configuration option value.

Enums

Errors returned by AbortEnvironmentUpdate

Errors returned by ApplyEnvironmentManagedAction

Errors returned by AssociateEnvironmentOperationsRole

Errors returned by CheckDNSAvailability

Errors returned by ComposeEnvironments

Errors returned by CreateApplication

Errors returned by CreateApplicationVersion

Errors returned by CreateConfigurationTemplate

Errors returned by CreateEnvironment

Errors returned by CreatePlatformVersion

Errors returned by CreateStorageLocation

Errors returned by DeleteApplication

Errors returned by DeleteApplicationVersion

Errors returned by DeleteConfigurationTemplate

Errors returned by DeleteEnvironmentConfiguration

Errors returned by DeletePlatformVersion

Errors returned by DescribeAccountAttributes

Errors returned by DescribeApplicationVersions

Errors returned by DescribeApplications

Errors returned by DescribeConfigurationOptions

Errors returned by DescribeConfigurationSettings

Errors returned by DescribeEnvironmentHealth

Errors returned by DescribeEnvironmentManagedActionHistory

Errors returned by DescribeEnvironmentManagedActions

Errors returned by DescribeEnvironmentResources

Errors returned by DescribeEnvironments

Errors returned by DescribeEvents

Errors returned by DescribeInstancesHealth

Errors returned by DescribePlatformVersion

Errors returned by DisassociateEnvironmentOperationsRole

Errors returned by ListAvailableSolutionStacks

Errors returned by ListPlatformBranches

Errors returned by ListPlatformVersions

Errors returned by ListTagsForResource

Errors returned by RebuildEnvironment

Errors returned by RequestEnvironmentInfo

Errors returned by RestartAppServer

Errors returned by RetrieveEnvironmentInfo

Errors returned by SwapEnvironmentCNAMEs

Errors returned by TerminateEnvironment

Errors returned by UpdateApplication

Errors returned by UpdateApplicationResourceLifecycle

Errors returned by UpdateApplicationVersion

Errors returned by UpdateConfigurationTemplate

Errors returned by UpdateEnvironment

Errors returned by UpdateTagsForResource

Errors returned by ValidateConfigurationSettings

Traits

Trait representing the capabilities of the Elastic Beanstalk API. Elastic Beanstalk clients implement this trait.