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.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
C# |
public interface AmazonElasticBeanstalk : IDisposable
All Members | Methods | ||||
Icon | Member | Description | ||
---|---|---|---|---|
BeginCheckDNSAvailability(CheckDNSAvailabilityRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CheckDNSAvailability operation.
| |||
BeginCreateApplication(CreateApplicationRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateApplication operation.
| |||
BeginCreateApplicationVersion(CreateApplicationVersionRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateApplicationVersion operation.
| |||
BeginCreateConfigurationTemplate(CreateConfigurationTemplateRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateConfigurationTemplate operation.
| |||
BeginCreateEnvironment(CreateEnvironmentRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateEnvironment operation.
| |||
BeginCreateStorageLocation(CreateStorageLocationRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateStorageLocation operation.
| |||
BeginDeleteApplication(DeleteApplicationRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteApplication operation.
| |||
BeginDeleteApplicationVersion(DeleteApplicationVersionRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteApplicationVersion operation.
| |||
BeginDeleteConfigurationTemplate(DeleteConfigurationTemplateRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteConfigurationTemplate operation.
| |||
BeginDeleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation.
| |||
BeginDescribeApplications(DescribeApplicationsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeApplications operation.
| |||
BeginDescribeApplicationVersions(DescribeApplicationVersionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeApplicationVersions operation.
| |||
BeginDescribeConfigurationOptions(DescribeConfigurationOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeConfigurationOptions operation.
| |||
BeginDescribeConfigurationSettings(DescribeConfigurationSettingsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeConfigurationSettings operation.
| |||
BeginDescribeEnvironmentResources(DescribeEnvironmentResourcesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEnvironmentResources operation.
| |||
BeginDescribeEnvironments(DescribeEnvironmentsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEnvironments operation.
| |||
BeginDescribeEvents(DescribeEventsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEvents operation.
| |||
BeginListAvailableSolutionStacks(ListAvailableSolutionStacksRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ListAvailableSolutionStacks operation.
| |||
BeginRebuildEnvironment(RebuildEnvironmentRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RebuildEnvironment operation.
| |||
BeginRequestEnvironmentInfo(RequestEnvironmentInfoRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RequestEnvironmentInfo operation.
| |||
BeginRestartAppServer(RestartAppServerRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RestartAppServer operation.
| |||
BeginRetrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation.
| |||
BeginSwapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation.
| |||
BeginTerminateEnvironment(TerminateEnvironmentRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the TerminateEnvironment operation.
| |||
BeginUpdateApplication(UpdateApplicationRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateApplication operation.
| |||
BeginUpdateApplicationVersion(UpdateApplicationVersionRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateApplicationVersion operation.
| |||
BeginUpdateConfigurationTemplate(UpdateConfigurationTemplateRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateConfigurationTemplate operation.
| |||
BeginUpdateEnvironment(UpdateEnvironmentRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateEnvironment operation.
| |||
BeginValidateConfigurationSettings(ValidateConfigurationSettingsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ValidateConfigurationSettings operation.
| |||
CheckDNSAvailability(CheckDNSAvailabilityRequest) |
Checks if the specified CNAME is available.
| |||
CreateApplication(CreateApplicationRequest) |
Creates an application that has one configuration template named
CopyC# default | |||
CreateApplicationVersion(CreateApplicationVersionRequest) |
Creates an application version for the specified application.
| |||
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 | |||
CreateEnvironment(CreateEnvironmentRequest) |
Launches an environment for the specified application using the specified
configuration.
| |||
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. | |||
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.
| |||
DeleteApplicationVersion(DeleteApplicationVersionRequest) |
Deletes the specified version from the specified application.
| |||
DeleteConfigurationTemplate(DeleteConfigurationTemplateRequest) |
Deletes the specified configuration template.
| |||
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 | |||
DescribeApplications()()()() |
Returns the descriptions of existing applications.
| |||
DescribeApplications(DescribeApplicationsRequest) |
Returns the descriptions of existing applications.
| |||
DescribeApplicationVersions()()()() |
Returns descriptions for existing application versions.
| |||
DescribeApplicationVersions(DescribeApplicationVersionsRequest) |
Returns descriptions for existing application versions.
| |||
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.
| |||
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 | |||
DescribeEnvironmentResources(DescribeEnvironmentResourcesRequest) |
Returns AWS resources for this environment.
| |||
DescribeEnvironments()()()() |
Returns descriptions for existing environments.
| |||
DescribeEnvironments(DescribeEnvironmentsRequest) |
Returns descriptions for existing environments.
| |||
DescribeEvents()()()() |
Returns list of event descriptions matching criteria up to the last 6 weeks.
| |||
DescribeEvents(DescribeEventsRequest) |
Returns list of event descriptions matching criteria up to the last 6 weeks.
| |||
Dispose()()()() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.) | |||
EndCheckDNSAvailability(IAsyncResult) |
Finishes the asynchronous execution of the CheckDNSAvailability operation.
| |||
EndCreateApplication(IAsyncResult) |
Finishes the asynchronous execution of the CreateApplication operation.
| |||
EndCreateApplicationVersion(IAsyncResult) |
Finishes the asynchronous execution of the CreateApplicationVersion operation.
| |||
EndCreateConfigurationTemplate(IAsyncResult) |
Finishes the asynchronous execution of the CreateConfigurationTemplate operation.
| |||
EndCreateEnvironment(IAsyncResult) |
Finishes the asynchronous execution of the CreateEnvironment operation.
| |||
EndCreateStorageLocation(IAsyncResult) |
Finishes the asynchronous execution of the CreateStorageLocation operation.
| |||
EndDeleteApplication(IAsyncResult) |
Finishes the asynchronous execution of the DeleteApplication operation.
| |||
EndDeleteApplicationVersion(IAsyncResult) |
Finishes the asynchronous execution of the DeleteApplicationVersion operation.
| |||
EndDeleteConfigurationTemplate(IAsyncResult) |
Finishes the asynchronous execution of the DeleteConfigurationTemplate operation.
| |||
EndDeleteEnvironmentConfiguration(IAsyncResult) |
Finishes the asynchronous execution of the DeleteEnvironmentConfiguration operation.
| |||
EndDescribeApplications(IAsyncResult) |
Finishes the asynchronous execution of the DescribeApplications operation.
| |||
EndDescribeApplicationVersions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeApplicationVersions operation.
| |||
EndDescribeConfigurationOptions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeConfigurationOptions operation.
| |||
EndDescribeConfigurationSettings(IAsyncResult) |
Finishes the asynchronous execution of the DescribeConfigurationSettings operation.
| |||
EndDescribeEnvironmentResources(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEnvironmentResources operation.
| |||
EndDescribeEnvironments(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEnvironments operation.
| |||
EndDescribeEvents(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEvents operation.
| |||
EndListAvailableSolutionStacks(IAsyncResult) |
Finishes the asynchronous execution of the ListAvailableSolutionStacks operation.
| |||
EndRebuildEnvironment(IAsyncResult) |
Finishes the asynchronous execution of the RebuildEnvironment operation.
| |||
EndRequestEnvironmentInfo(IAsyncResult) |
Finishes the asynchronous execution of the RequestEnvironmentInfo operation.
| |||
EndRestartAppServer(IAsyncResult) |
Finishes the asynchronous execution of the RestartAppServer operation.
| |||
EndRetrieveEnvironmentInfo(IAsyncResult) |
Finishes the asynchronous execution of the RetrieveEnvironmentInfo operation.
| |||
EndSwapEnvironmentCNAMEs(IAsyncResult) |
Finishes the asynchronous execution of the SwapEnvironmentCNAMEs operation.
| |||
EndTerminateEnvironment(IAsyncResult) |
Finishes the asynchronous execution of the TerminateEnvironment operation.
| |||
EndUpdateApplication(IAsyncResult) |
Finishes the asynchronous execution of the UpdateApplication operation.
| |||
EndUpdateApplicationVersion(IAsyncResult) |
Finishes the asynchronous execution of the UpdateApplicationVersion operation.
| |||
EndUpdateConfigurationTemplate(IAsyncResult) |
Finishes the asynchronous execution of the UpdateConfigurationTemplate operation.
| |||
EndUpdateEnvironment(IAsyncResult) |
Finishes the asynchronous execution of the UpdateEnvironment operation.
| |||
EndValidateConfigurationSettings(IAsyncResult) |
Finishes the asynchronous execution of the ValidateConfigurationSettings operation.
| |||
ListAvailableSolutionStacks()()()() |
Returns a list of the available solution stack names.
| |||
ListAvailableSolutionStacks(ListAvailableSolutionStacksRequest) |
Returns a list of the available solution stack names.
| |||
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.
| |||
RequestEnvironmentInfo(RequestEnvironmentInfoRequest) |
Initiates a request to compile the specified type of information
of the deployed environment.
Setting the Related Topics | |||
RestartAppServer(RestartAppServerRequest) |
Causes the environment to restart the application container server
running on each Amazon EC2 instance.
| |||
RetrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest) |
Retrieves the compiled information from a RequestEnvironmentInfo
request.
Related Topics | |||
SwapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest) |
Swaps the CNAMEs of two environments.
| |||
TerminateEnvironment(TerminateEnvironmentRequest) |
Terminates the specified environment.
| |||
UpdateApplication(UpdateApplicationRequest) |
Updates the specified application to have the specified properties.
| |||
UpdateApplicationVersion(UpdateApplicationVersionRequest) |
Updates the specified application version to have the specified properties.
| |||
UpdateConfigurationTemplate(UpdateConfigurationTemplateRequest) |
Updates the specified configuration template to have the specified
properties or configuration option values.
Related Topics | |||
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
| |||
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. |