ElasticBeanstalkClient
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.
Functions
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.
Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
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 an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
Create a new version of your custom platform.
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.
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.
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
Returns the descriptions of existing applications.
Retrieve a list of application versions.
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.
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.
Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.
Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.
Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
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.
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
Inherited functions
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.
Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
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 an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.
Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
Create a new version of your custom platform.
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.
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.
Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.
Returns the descriptions of existing applications.
Retrieve a list of application versions.
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.
Paginate over DescribeEnvironmentManagedActionHistoryResponse results.
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.
Paginate over DescribeEventsResponse results.
Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.
Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.
Paginate over ListPlatformBranchesResponse results.
Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.
Paginate over ListPlatformVersionsResponse results.
Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
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.
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.
Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.