baiji v0.6.7 Baiji.ElasticBeanstalk
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 http://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.
Link to this section Summary
Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Cancels in-progress environment configuration update or application version deployment
Applies a scheduled managed action immediately. A managed action can be
applied only if its status is Scheduled
. Get the status and action ID of
a managed action with DescribeEnvironmentManagedActions
Checks if the specified CNAME is available
Create or update a group of environments that each run a separate component
of a single application. Takes a list of version labels that specify
application source bundles for each of the environments to create or
update. The name of each environment and other required information must be
included in the source bundles in an environment manifest named env.yaml
.
See Compose
Environments
for details
Creates an application that has one configuration template named default
and no application versions
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings
Launches an environment for the specified application using the specified configuration
Create a new version of your custom platform
Creates the Amazon S3 storage location for the account
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket
Deletes the specified version from the specified application
Deletes the specified configuration template
Deletes the draft configuration associated with the running environment
Deletes the specified version of a custom platform
Retrieve a list of application versions
Returns the descriptions of existing applications
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health
Lists an environment’s completed and failed managed actions
Lists an environment’s upcoming and in-progress managed actions
Returns AWS resources for this environment
Returns descriptions for existing environments
Returns list of event descriptions matching criteria up to the last 6 weeks
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting
Describes the version of the platform
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order
Lists the available platforms
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart
Initiates a request to compile the specified type of information of the deployed environment
Causes the environment to restart the application container server running on each Amazon EC2 instance
Retrieves the compiled information from a RequestEnvironmentInfo
request
Swaps the CNAMEs of two environments
Terminates the specified environment
Updates the specified application to have the specified properties
Modifies lifecycle settings for an application
Updates the specified application version to have the specified properties
Updates the specified configuration template to have the specified properties or configuration option values
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid
Link to this section Functions
Returns a map containing the input/output shapes for this endpoint
Outputs values common to all actions
Cancels in-progress environment configuration update or application version deployment.
Applies a scheduled managed action immediately. A managed action can be
applied only if its status is Scheduled
. Get the status and action ID of
a managed action with DescribeEnvironmentManagedActions
.
Checks if the specified CNAME is available.
Create or update a group of environments that each run a separate component
of a single application. Takes a list of version labels that specify
application source bundles for each of the environments to create or
update. The name of each environment and other required information must be
included in the source bundles in an environment manifest named env.yaml
.
See Compose
Environments
for details.
Creates an application that has one configuration template named default
and no application versions.
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with
SourceBuildInformation
.
Specify a build in an AWS CodeBuild with SourceBuildInformation
and
BuildConfiguration
.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation
and SourceBundle
to use the default
sample application.
Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
- `DescribeConfigurationOptions`
- `DescribeConfigurationSettings`
- `ListAvailableSolutionStacks`
Launches an environment for the specified application using the specified configuration.
Create a new version of your custom platform.
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
Deletes the specified version from the specified application.
Deletes the specified configuration template.
Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a
draft configuration set. You can get the draft configuration using
DescribeConfigurationSettings
while the update is in progress or if the
update fails. The DeploymentStatus
for the draft configuration indicates
whether the deployment is in process or has failed. The draft configuration
remains in existence until it is deleted with this action.
Deletes the specified version of a custom platform.
Retrieve a list of application versions.
Returns the descriptions of existing applications.
Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
- `DeleteEnvironmentConfiguration`
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Lists an environment’s completed and failed managed actions.
Lists an environment’s upcoming and in-progress managed actions.
Returns AWS resources for this environment.
Returns descriptions for existing environments.
Returns list of event descriptions matching criteria up to the last 6 weeks.
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
Describes the version of the platform.
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
Lists the available platforms.
Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
Initiates a request to compile the specified type of information of the deployed environment.
Setting the InfoType
to tail
compiles the last lines from the
application server log files of every Amazon EC2 instance in your
environment.
Setting the InfoType
to bundle
compresses the application server log
files for every Amazon EC2 instance into a .zip
file. Legacy and .NET
containers do not support bundle logs.
Use RetrieveEnvironmentInfo
to obtain the set of logs.
Related Topics
- `RetrieveEnvironmentInfo`
Causes the environment to restart the application container server running on each Amazon EC2 instance.
Retrieves the compiled information from a RequestEnvironmentInfo
request.
Related Topics
- `RequestEnvironmentInfo`
Swaps the CNAMEs of two environments.
Terminates the specified environment.
Updates the specified application to have the specified properties.
Modifies lifecycle settings for an application.
Updates the specified application version to have the specified properties.
Updates the specified configuration template to have the specified properties or configuration option values.
- `DescribeConfigurationOptions`
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and
AWS Elastic Beanstalk returns an InvalidParameterCombination
error.
When updating the configuration settings to a new template or individual
settings, a draft configuration is created and
DescribeConfigurationSettings
for this environment returns two setting
descriptions with different DeploymentStatus
values.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.