AWS SDK for .NET Documentation
AmazonElasticBeanstalkClient Class
Amazon ► Amazon.ElasticBeanstalk ► AmazonElasticBeanstalkClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing ElasticBeanstalk AWS Elastic Beanstalk

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.

Declaration Syntax
C#
public class AmazonElasticBeanstalkClient : AmazonWebServiceClient, 
	AmazonElasticBeanstalk, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </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.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </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.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
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
 and no application versions. The <code>default</code> configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container.

CreateApplicationVersion(CreateApplicationVersionRequest)
Creates an application version for the specified application.
Note:
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

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.
Note:
You cannot delete an application that has a running environment.

DeleteApplicationVersion(DeleteApplicationVersionRequest)
Deletes the specified version from the specified application.
Note:
You cannot delete an application version that is associated with a running environment.

DeleteConfigurationTemplate(DeleteConfigurationTemplateRequest)
Deletes the specified configuration template.
Note:
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

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

CopyC#
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.


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.
Note:
This action returns the most recent 1,000 events from the specified
CopyC#
NextToken
.

DescribeEvents(DescribeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6 weeks.
Note:
This action returns the most recent 1,000 events from the specified
CopyC#
NextToken
.

Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
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.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
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

CopyC#
InfoType
to
CopyC#
tail
 compiles the last lines from the application server log files of every Amazon EC2 instance in your environment. Use RetrieveEnvironmentInfo to access the compiled information.

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.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UpdateApplication(UpdateApplicationRequest)
Updates the specified application to have the specified properties.
Note:
If a property (for example,
CopyC#
description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

UpdateApplicationVersion(UpdateApplicationVersionRequest)
Updates the specified application version to have the specified properties.
Note:
If a property (for example,
CopyC#
description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.

UpdateConfigurationTemplate(UpdateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified properties or configuration option values.
Note:
If a property (for example,
CopyC#
ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

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

CopyC#
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

CopyC#
DeploymentStatus
values.


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.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonElasticBeanstalkClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)