AWS SDK Version 2 for .NET
API Reference

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.

.NET Framework 4.5
 
Interface 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. 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.

Inheritance Hierarchy

Amazon.ElasticBeanstalk.IAmazonElasticBeanstalk

Namespace: Amazon.ElasticBeanstalk
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonElasticBeanstalk
         IDisposable

The IAmazonElasticBeanstalk type exposes the following members

Methods

NameDescription
Public Method AbortEnvironmentUpdate(AbortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.
Public Method AbortEnvironmentUpdateAsync(AbortEnvironmentUpdateRequest, CancellationToken) Initiates the asynchronous execution of the AbortEnvironmentUpdate operation.
Public Method CheckDNSAvailability(CheckDNSAvailabilityRequest) Checks if the specified CNAME is available.
Public Method CheckDNSAvailabilityAsync(CheckDNSAvailabilityRequest, CancellationToken) Initiates the asynchronous execution of the CheckDNSAvailability operation.
Public Method 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.
Public Method ComposeEnvironmentsAsync(ComposeEnvironmentsRequest, CancellationToken) Initiates the asynchronous execution of the ComposeEnvironments operation.
Public Method CreateApplication(CreateApplicationRequest) Creates an application that has one configuration template named default and no application versions.
Public Method CreateApplicationAsync(CreateApplicationRequest, CancellationToken) Initiates the asynchronous execution of the CreateApplication operation.
Public Method CreateApplicationVersion(CreateApplicationVersionRequest) Creates an application version for the specified application. 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.
Public Method CreateApplicationVersionAsync(CreateApplicationVersionRequest, CancellationToken) Initiates the asynchronous execution of the CreateApplicationVersion operation.
Public Method 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

Public Method CreateConfigurationTemplateAsync(CreateConfigurationTemplateRequest, CancellationToken) Initiates the asynchronous execution of the CreateConfigurationTemplate operation.
Public Method CreateEnvironment(CreateEnvironmentRequest) Launches an environment for the specified application using the specified configuration.
Public Method CreateEnvironmentAsync(CreateEnvironmentRequest, CancellationToken) Initiates the asynchronous execution of the CreateEnvironment operation.
Public Method CreateStorageLocation() Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Public Method CreateStorageLocation(CreateStorageLocationRequest) Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Public Method CreateStorageLocationAsync(CreateStorageLocationRequest, CancellationToken) Initiates the asynchronous execution of the CreateStorageLocation operation.
Public Method 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. You cannot delete an application that has a running environment.
Public Method DeleteApplicationAsync(DeleteApplicationRequest, CancellationToken) Initiates the asynchronous execution of the DeleteApplication operation.
Public Method DeleteApplicationVersion(DeleteApplicationVersionRequest) Deletes the specified version from the specified application. You cannot delete an application version that is associated with a running environment.
Public Method DeleteApplicationVersionAsync(DeleteApplicationVersionRequest, CancellationToken) Initiates the asynchronous execution of the DeleteApplicationVersion operation.
Public Method DeleteConfigurationTemplate(DeleteConfigurationTemplateRequest) Deletes the specified configuration template. 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.
Public Method DeleteConfigurationTemplateAsync(DeleteConfigurationTemplateRequest, CancellationToken) Initiates the asynchronous execution of the DeleteConfigurationTemplate operation.
Public Method 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 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.

Public Method DeleteEnvironmentConfigurationAsync(DeleteEnvironmentConfigurationRequest, CancellationToken) Initiates the asynchronous execution of the DeleteEnvironmentConfiguration operation.
Public Method DescribeApplications() Returns the descriptions of existing applications.
Public Method DescribeApplications(DescribeApplicationsRequest) Returns the descriptions of existing applications.
Public Method DescribeApplicationsAsync(DescribeApplicationsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeApplications operation.
Public Method DescribeApplicationVersions() Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
Public Method DescribeApplicationVersions(DescribeApplicationVersionsRequest) Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
Public Method DescribeApplicationVersionsAsync(DescribeApplicationVersionsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeApplicationVersions operation.
Public Method 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.
Public Method 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.
Public Method DescribeConfigurationOptionsAsync(DescribeConfigurationOptionsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeConfigurationOptions operation.
Public Method 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

Public Method DescribeConfigurationSettingsAsync(DescribeConfigurationSettingsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeConfigurationSettings operation.
Public Method DescribeEnvironmentHealth(DescribeEnvironmentHealthRequest) Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
Public Method DescribeEnvironmentHealthAsync(DescribeEnvironmentHealthRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEnvironmentHealth operation.
Public Method DescribeEnvironmentResources(DescribeEnvironmentResourcesRequest) Returns AWS resources for this environment.
Public Method DescribeEnvironmentResourcesAsync(DescribeEnvironmentResourcesRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEnvironmentResources operation.
Public Method DescribeEnvironments() Returns descriptions for existing environments.
Public Method DescribeEnvironments(DescribeEnvironmentsRequest) Returns descriptions for existing environments.
Public Method DescribeEnvironmentsAsync(DescribeEnvironmentsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEnvironments operation.
Public Method DescribeEvents() Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken.
Public Method DescribeEvents(DescribeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks. This action returns the most recent 1,000 events from the specified NextToken.
Public Method DescribeEventsAsync(DescribeEventsRequest, CancellationToken) Initiates the asynchronous execution of the DescribeEvents operation.
Public Method 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.
Public Method DescribeInstancesHealthAsync(DescribeInstancesHealthRequest, CancellationToken) Initiates the asynchronous execution of the DescribeInstancesHealth operation.
Public Method ListAvailableSolutionStacks() Returns a list of the available solution stack names.
Public Method ListAvailableSolutionStacks(ListAvailableSolutionStacksRequest) Returns a list of the available solution stack names.
Public Method ListAvailableSolutionStacksAsync(ListAvailableSolutionStacksRequest, CancellationToken) Initiates the asynchronous execution of the ListAvailableSolutionStacks operation.
Public Method 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.
Public Method RebuildEnvironmentAsync(RebuildEnvironmentRequest, CancellationToken) Initiates the asynchronous execution of the RebuildEnvironment operation.
Public Method RequestEnvironmentInfo(RequestEnvironmentInfoRequest) 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

Public Method RequestEnvironmentInfoAsync(RequestEnvironmentInfoRequest, CancellationToken) Initiates the asynchronous execution of the RequestEnvironmentInfo operation.
Public Method RestartAppServer(RestartAppServerRequest) Causes the environment to restart the application container server running on each Amazon EC2 instance.
Public Method RestartAppServerAsync(RestartAppServerRequest, CancellationToken) Initiates the asynchronous execution of the RestartAppServer operation.
Public Method RetrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest) Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

Public Method RetrieveEnvironmentInfoAsync(RetrieveEnvironmentInfoRequest, CancellationToken) Initiates the asynchronous execution of the RetrieveEnvironmentInfo operation.
Public Method SwapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest) Swaps the CNAMEs of two environments.
Public Method SwapEnvironmentCNAMEsAsync(SwapEnvironmentCNAMEsRequest, CancellationToken) Initiates the asynchronous execution of the SwapEnvironmentCNAMEs operation.
Public Method TerminateEnvironment(TerminateEnvironmentRequest) Terminates the specified environment.
Public Method TerminateEnvironmentAsync(TerminateEnvironmentRequest, CancellationToken) Initiates the asynchronous execution of the TerminateEnvironment operation.
Public Method UpdateApplication(UpdateApplicationRequest) Updates the specified application to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
Public Method UpdateApplicationAsync(UpdateApplicationRequest, CancellationToken) Initiates the asynchronous execution of the UpdateApplication operation.
Public Method UpdateApplicationVersion(UpdateApplicationVersionRequest) Updates the specified application version to have the specified properties. If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
Public Method UpdateApplicationVersionAsync(UpdateApplicationVersionRequest, CancellationToken) Initiates the asynchronous execution of the UpdateApplicationVersion operation.
Public Method UpdateConfigurationTemplate(UpdateConfigurationTemplateRequest) Updates the specified configuration template to have the specified properties or configuration option values. If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

Public Method UpdateConfigurationTemplateAsync(UpdateConfigurationTemplateRequest, CancellationToken) Initiates the asynchronous execution of the UpdateConfigurationTemplate operation.
Public Method 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 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.

Public Method UpdateEnvironmentAsync(UpdateEnvironmentRequest, CancellationToken) Initiates the asynchronous execution of the UpdateEnvironment operation.
Public Method 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.

Public Method ValidateConfigurationSettingsAsync(ValidateConfigurationSettingsRequest, CancellationToken) Initiates the asynchronous execution of the ValidateConfigurationSettings operation.

Version Information

.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