AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.
AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.
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.
Namespace: Amazon.ElasticBeanstalk
Assembly: AWSSDK.dll
Version: (assembly version)
public class AmazonElasticBeanstalkClient : AmazonServiceClient IAmazonElasticBeanstalk, IDisposable
The AmazonElasticBeanstalkClient type exposes the following members
Name | Description | |
---|---|---|
AmazonElasticBeanstalkClient() |
Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonElasticBeanstalkClient(RegionEndpoint) |
Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonElasticBeanstalkClient(AmazonElasticBeanstalkConfig) |
Constructs AmazonElasticBeanstalkClient with the credentials loaded from the application's
default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance.
Example App.config with credentials set.
<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
|
AmazonElasticBeanstalkClient(AWSCredentials) | Constructs AmazonElasticBeanstalkClient with AWS Credentials | |
AmazonElasticBeanstalkClient(AWSCredentials, RegionEndpoint) | Constructs AmazonElasticBeanstalkClient with AWS Credentials | |
AmazonElasticBeanstalkClient(AWSCredentials, AmazonElasticBeanstalkConfig) | Constructs AmazonElasticBeanstalkClient with AWS Credentials and an AmazonElasticBeanstalkClient Configuration object. | |
AmazonElasticBeanstalkClient(string, string) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key | |
AmazonElasticBeanstalkClient(string, string, RegionEndpoint) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key | |
AmazonElasticBeanstalkClient(string, string, AmazonElasticBeanstalkConfig) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object. | |
AmazonElasticBeanstalkClient(string, string, string) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key | |
AmazonElasticBeanstalkClient(string, string, string, RegionEndpoint) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID and AWS Secret Key | |
AmazonElasticBeanstalkClient(string, string, string, AmazonElasticBeanstalkConfig) | Constructs AmazonElasticBeanstalkClient with AWS Access Key ID, AWS Secret Key and an AmazonElasticBeanstalkClient Configuration object. |
Name | Description | |
---|---|---|
AbortEnvironmentUpdate(AbortEnvironmentUpdateRequest) | Cancels in-progress environment configuration update or application version deployment. | |
AbortEnvironmentUpdateAsync(AbortEnvironmentUpdateRequest, CancellationToken) | Initiates the asynchronous execution of the AbortEnvironmentUpdate operation. | |
CheckDNSAvailability(CheckDNSAvailabilityRequest) | Checks if the specified CNAME is available. | |
CheckDNSAvailabilityAsync(CheckDNSAvailabilityRequest, CancellationToken) | Initiates the asynchronous execution of the CheckDNSAvailability operation. | |
ComposeEnvironments(ComposeEnvironmentsRequest) |
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.
|
|
ComposeEnvironmentsAsync(ComposeEnvironmentsRequest, CancellationToken) | Initiates the asynchronous execution of the ComposeEnvironments operation. | |
CreateApplication(CreateApplicationRequest) |
Creates an application that has one configuration template named default
and no application versions.
|
|
CreateApplicationAsync(CreateApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the CreateApplication operation. | |
CreateApplicationVersion(CreateApplicationVersionRequest) |
Creates an application version for the specified application.
|
|
CreateApplicationVersionAsync(CreateApplicationVersionRequest, CancellationToken) | Initiates the asynchronous execution of the CreateApplicationVersion operation. | |
CreateConfigurationTemplate(CreateConfigurationTemplateRequest) |
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 |
|
CreateConfigurationTemplateAsync(CreateConfigurationTemplateRequest, CancellationToken) | Initiates the asynchronous execution of the CreateConfigurationTemplate operation. | |
CreateEnvironment(CreateEnvironmentRequest) | Launches an environment for the specified application using the specified configuration. | |
CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken) | Initiates the asynchronous execution of the CreateEnvironment operation. | |
CreateStorageLocation() |
Creates the Amazon S3 storage location for the account.
This location is used to store user log files. |
|
CreateStorageLocation(CreateStorageLocationRequest) |
Creates the Amazon S3 storage location for the account.
This location is used to store user log files. |
|
CreateStorageLocationAsync(CreateStorageLocationRequest, CancellationToken) | Initiates the asynchronous execution of the CreateStorageLocation operation. | |
DeleteApplication(DeleteApplicationRequest) |
Deletes the specified application along with all associated versions and configurations.
The application versions will not be deleted from your Amazon S3 bucket.
|
|
DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteApplication operation. | |
DeleteApplicationVersion(DeleteApplicationVersionRequest) |
Deletes the specified version from the specified application.
|
|
DeleteApplicationVersionAsync(DeleteApplicationVersionRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteApplicationVersion operation. | |
DeleteConfigurationTemplate(DeleteConfigurationTemplateRequest) |
Deletes the specified configuration template.
|
|
DeleteConfigurationTemplateAsync(DeleteConfigurationTemplateRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteConfigurationTemplate operation. | |
DeleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest) |
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 |
|
DeleteEnvironmentConfigurationAsync(DeleteEnvironmentConfigurationRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation. | |
DescribeApplications() | Returns the descriptions of existing applications. | |
DescribeApplications(DescribeApplicationsRequest) | Returns the descriptions of existing applications. | |
DescribeApplicationsAsync(DescribeApplicationsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeApplications operation. | |
DescribeApplicationVersions() | Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. | |
DescribeApplicationVersions(DescribeApplicationVersionsRequest) | Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket. | |
DescribeApplicationVersionsAsync(DescribeApplicationVersionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeApplicationVersions operation. | |
DescribeConfigurationOptions() | 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. | |
DescribeConfigurationOptions(DescribeConfigurationOptionsRequest) | 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. | |
DescribeConfigurationOptionsAsync(DescribeConfigurationOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigurationOptions operation. | |
DescribeConfigurationSettings(DescribeConfigurationSettingsRequest) |
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 |
|
DescribeConfigurationSettingsAsync(DescribeConfigurationSettingsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeConfigurationSettings operation. | |
DescribeEnvironmentHealth(DescribeEnvironmentHealthRequest) | Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. | |
DescribeEnvironmentHealthAsync(DescribeEnvironmentHealthRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEnvironmentHealth operation. | |
DescribeEnvironmentResources(DescribeEnvironmentResourcesRequest) | Returns AWS resources for this environment. | |
DescribeEnvironmentResourcesAsync(DescribeEnvironmentResourcesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEnvironmentResources operation. | |
DescribeEnvironments() | Returns descriptions for existing environments. | |
DescribeEnvironments(DescribeEnvironmentsRequest) | Returns descriptions for existing environments. | |
DescribeEnvironmentsAsync(DescribeEnvironmentsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEnvironments operation. | |
DescribeEvents() |
Returns list of event descriptions matching criteria up to the last 6 weeks.
NextToken .
|
|
DescribeEvents(DescribeEventsRequest) |
Returns list of event descriptions matching criteria up to the last 6 weeks.
NextToken .
|
|
DescribeEventsAsync(DescribeEventsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeEvents operation. | |
DescribeInstancesHealth(DescribeInstancesHealthRequest) | Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health. | |
DescribeInstancesHealthAsync(DescribeInstancesHealthRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeInstancesHealth operation. | |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ListAvailableSolutionStacks() | Returns a list of the available solution stack names. | |
ListAvailableSolutionStacks(ListAvailableSolutionStacksRequest) | Returns a list of the available solution stack names. | |
ListAvailableSolutionStacksAsync(ListAvailableSolutionStacksRequest, CancellationToken) | Initiates the asynchronous execution of the ListAvailableSolutionStacks operation. | |
RebuildEnvironment(RebuildEnvironmentRequest) | 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. | |
RebuildEnvironmentAsync(RebuildEnvironmentRequest, CancellationToken) | Initiates the asynchronous execution of the RebuildEnvironment operation. | |
RequestEnvironmentInfo(RequestEnvironmentInfoRequest) |
Initiates a request to compile the specified type of information of the deployed
environment.
Setting the
Setting the Use RetrieveEnvironmentInfo to obtain the set of logs. Related Topics |
|
RequestEnvironmentInfoAsync(RequestEnvironmentInfoRequest, CancellationToken) | Initiates the asynchronous execution of the RequestEnvironmentInfo operation. | |
RestartAppServer(RestartAppServerRequest) | Causes the environment to restart the application container server running on each Amazon EC2 instance. | |
RestartAppServerAsync(RestartAppServerRequest, CancellationToken) | Initiates the asynchronous execution of the RestartAppServer operation. | |
RetrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest) |
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics |
|
RetrieveEnvironmentInfoAsync(RetrieveEnvironmentInfoRequest, CancellationToken) | Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation. | |
SwapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest) | Swaps the CNAMEs of two environments. | |
SwapEnvironmentCNAMEsAsync(SwapEnvironmentCNAMEsRequest, CancellationToken) | Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation. | |
TerminateEnvironment(TerminateEnvironmentRequest) | Terminates the specified environment. | |
TerminateEnvironmentAsync(TerminateEnvironmentRequest, CancellationToken) | Initiates the asynchronous execution of the TerminateEnvironment operation. | |
UpdateApplication(UpdateApplicationRequest) |
Updates the specified application to have the specified properties.
description ) is not provided, the
value remains unchanged. To clear these properties, specify an empty string. |
|
UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateApplication operation. | |
UpdateApplicationVersion(UpdateApplicationVersionRequest) |
Updates the specified application version to have the specified properties.
description ) is not provided, the
value remains unchanged. To clear properties, specify an empty string. |
|
UpdateApplicationVersionAsync(UpdateApplicationVersionRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateApplicationVersion operation. | |
UpdateConfigurationTemplate(UpdateConfigurationTemplateRequest) |
Updates the specified configuration template to have the specified properties or
configuration option values.
ApplicationName ) is not provided,
its value remains unchanged. To clear such properties, specify an empty string. Related Topics |
|
UpdateConfigurationTemplateAsync(UpdateConfigurationTemplateRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateConfigurationTemplate operation. | |
UpdateEnvironment(UpdateEnvironmentRequest) |
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
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 |
|
UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateEnvironment operation. | |
ValidateConfigurationSettings(ValidateConfigurationSettingsRequest) |
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. |
|
ValidateConfigurationSettingsAsync(ValidateConfigurationSettingsRequest, CancellationToken) | Initiates the asynchronous execution of the ValidateConfigurationSettings operation. |
Name | Description | |
---|---|---|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. | |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1