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 .
All service calls made using this new client object are blocking, and will not return until the service call completes.
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).com.amazonaws.auth.DefaultAWSCredentialsProviderChain
this(new DefaultAWSCredentialsProviderChain(), clientConfiguration, Executors.newFixedThreadPool(clientConfiguration.getMaxConnections()));
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.executorService
The executor service by which all asynchronous requests will
be executed.publicAWSElasticBeanstalkAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) {
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
The executor service by which all asynchronous requests will
be executed.All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.executorService
The executor service by which all asynchronous requests will
be executed.publicAWSElasticBeanstalkAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) {
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
Client configuration options (ex: max retry limit, proxy
settings, etc).this(awsCredentialsProvider, clientConfiguration, Executors.newFixedThreadPool(clientConfiguration.getMaxConnections()));
All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
Client configuration options (ex: max retry limit, proxy
settings, etc).executorService
The executor service by which all asynchronous requests will
be executed.Checks if the specified CNAME is available.
checkDNSAvailabilityRequest
Container for the necessary
parameters to execute the CheckDNSAvailability operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<CheckDNSAvailabilityResult>checkDNSAvailabilityAsync(final CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
Checks if the specified CNAME is available.
checkDNSAvailabilityRequest
Container for the necessary
parameters to execute the CheckDNSAvailability operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
describeConfigurationOptionsRequest
Container for the necessary
parameters to execute the DescribeConfigurationOptions operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeConfigurationOptionsResult>describeConfigurationOptionsAsync(final DescribeConfigurationOptionsRequest 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.
describeConfigurationOptionsRequest
Container for the necessary
parameters to execute the DescribeConfigurationOptions operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribeConfigurationOptionsRequest, DescribeConfigurationOptionsResult> asyncHandler)
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.
deleteConfigurationTemplateRequest
Container for the necessary
parameters to execute the DeleteConfigurationTemplate operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteConfigurationTemplateAsync(final DeleteConfigurationTemplateRequest 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.
deleteConfigurationTemplateRequest
Container for the necessary
parameters to execute the DeleteConfigurationTemplate operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Launches an environment for the specified application using the specified configuration.
createEnvironmentRequest
Container for the necessary parameters
to execute the CreateEnvironment operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<CreateEnvironmentResult>createEnvironmentAsync(final CreateEnvironmentRequest createEnvironmentRequest)
Launches an environment for the specified application using the specified configuration.
createEnvironmentRequest
Container for the necessary parameters
to execute the CreateEnvironment operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocationRequest
Container for the necessary
parameters to execute the CreateStorageLocation operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<CreateStorageLocationResult>createStorageLocationAsync(final CreateStorageLocationRequest createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocationRequest
Container for the necessary
parameters to execute the CreateStorageLocation operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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
requestEnvironmentInfoRequest
Container for the necessary
parameters to execute the RequestEnvironmentInfo operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>requestEnvironmentInfoAsync(final RequestEnvironmentInfoRequest 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
requestEnvironmentInfoRequest
Container for the necessary
parameters to execute the RequestEnvironmentInfo operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
createApplicationVersionRequest
Container for the necessary
parameters to execute the CreateApplicationVersion operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<CreateApplicationVersionResult>createApplicationVersionAsync(final CreateApplicationVersionRequest 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.
createApplicationVersionRequest
Container for the necessary
parameters to execute the CreateApplicationVersion operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<CreateApplicationVersionRequest, CreateApplicationVersionResult> asyncHandler)
Deletes the specified version from the specified application.
NOTE:You cannot delete an application version that is associated with a running environment.
deleteApplicationVersionRequest
Container for the necessary
parameters to execute the DeleteApplicationVersion operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteApplicationVersionAsync(final DeleteApplicationVersionRequest deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
NOTE:You cannot delete an application version that is associated with a running environment.
deleteApplicationVersionRequest
Container for the necessary
parameters to execute the DeleteApplicationVersion operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Returns descriptions for existing application versions.
describeApplicationVersionsRequest
Container for the necessary
parameters to execute the DescribeApplicationVersions operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeApplicationVersionsResult>describeApplicationVersionsAsync(final DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
Returns descriptions for existing application versions.
describeApplicationVersionsRequest
Container for the necessary
parameters to execute the DescribeApplicationVersions operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribeApplicationVersionsRequest, DescribeApplicationVersionsResult> asyncHandler)
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.
deleteApplicationRequest
Container for the necessary parameters
to execute the DeleteApplication operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteApplicationAsync(final DeleteApplicationRequest 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.
deleteApplicationRequest
Container for the necessary parameters
to execute the DeleteApplication operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Updates the specified application version to have the specified properties.
NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
updateApplicationVersionRequest
Container for the necessary
parameters to execute the UpdateApplicationVersion operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateApplicationVersionResult>updateApplicationVersionAsync(final UpdateApplicationVersionRequest updateApplicationVersionRequest)
Updates the specified application version to have the specified properties.
NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.
updateApplicationVersionRequest
Container for the necessary
parameters to execute the UpdateApplicationVersion operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<UpdateApplicationVersionRequest, UpdateApplicationVersionResult> asyncHandler)
Creates an application that has one configuration template named
default
and no application versions.
createApplicationRequest
Container for the necessary parameters
to execute the CreateApplication operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<CreateApplicationResult>createApplicationAsync(final CreateApplicationRequest createApplicationRequest)
Creates an application that has one configuration template named
default
and no application versions.
createApplicationRequest
Container for the necessary parameters
to execute the CreateApplication operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest
Container for the necessary
parameters to execute the SwapEnvironmentCNAMEs operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>swapEnvironmentCNAMEsAsync(final SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest
Container for the necessary
parameters to execute the SwapEnvironmentCNAMEs operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Updates the specified configuration template to have the specified properties or configuration option values.
NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.
Related Topics
updateConfigurationTemplateRequest
Container for the necessary
parameters to execute the UpdateConfigurationTemplate operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateConfigurationTemplateResult>updateConfigurationTemplateAsync(final UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified properties or configuration option values.
NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.
Related Topics
updateConfigurationTemplateRequest
Container for the necessary
parameters to execute the UpdateConfigurationTemplate operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<UpdateConfigurationTemplateRequest, UpdateConfigurationTemplateResult> asyncHandler)
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest
Container for the necessary
parameters to execute the RetrieveEnvironmentInfo operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<RetrieveEnvironmentInfoResult>retrieveEnvironmentInfoAsync(final RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest
Container for the necessary
parameters to execute the RetrieveEnvironmentInfo operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<RetrieveEnvironmentInfoRequest, RetrieveEnvironmentInfoResult> asyncHandler)
Returns a list of the available solution stack names.
listAvailableSolutionStacksRequest
Container for the necessary
parameters to execute the ListAvailableSolutionStacks operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<ListAvailableSolutionStacksResult>listAvailableSolutionStacksAsync(final ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
Returns a list of the available solution stack names.
listAvailableSolutionStacksRequest
Container for the necessary
parameters to execute the ListAvailableSolutionStacks operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<ListAvailableSolutionStacksRequest, ListAvailableSolutionStacksResult> asyncHandler)
Updates the specified application to have the specified properties.
NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
updateApplicationRequest
Container for the necessary parameters
to execute the UpdateApplication operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateApplicationResult>updateApplicationAsync(final UpdateApplicationRequest updateApplicationRequest)
Updates the specified application to have the specified properties.
NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
updateApplicationRequest
Container for the necessary parameters
to execute the UpdateApplication operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Returns descriptions for existing environments.
describeEnvironmentsRequest
Container for the necessary
parameters to execute the DescribeEnvironments operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeEnvironmentsResult>describeEnvironmentsAsync(final DescribeEnvironmentsRequest describeEnvironmentsRequest)
Returns descriptions for existing environments.
describeEnvironmentsRequest
Container for the necessary
parameters to execute the DescribeEnvironments operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Returns AWS resources for this environment.
describeEnvironmentResourcesRequest
Container for the necessary
parameters to execute the DescribeEnvironmentResources operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeEnvironmentResourcesResult>describeEnvironmentResourcesAsync(final DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
describeEnvironmentResourcesRequest
Container for the necessary
parameters to execute the DescribeEnvironmentResources operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribeEnvironmentResourcesRequest, DescribeEnvironmentResourcesResult> asyncHandler)
Terminates the specified environment.
terminateEnvironmentRequest
Container for the necessary
parameters to execute the TerminateEnvironment operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<TerminateEnvironmentResult>terminateEnvironmentAsync(final TerminateEnvironmentRequest terminateEnvironmentRequest)
Terminates the specified environment.
terminateEnvironmentRequest
Container for the necessary
parameters to execute the TerminateEnvironment operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
validateConfigurationSettingsRequest
Container for the
necessary parameters to execute the ValidateConfigurationSettings
operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<ValidateConfigurationSettingsResult>validateConfigurationSettingsAsync(final ValidateConfigurationSettingsRequest 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.
validateConfigurationSettingsRequest
Container for the
necessary parameters to execute the ValidateConfigurationSettings
operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<ValidateConfigurationSettingsRequest, ValidateConfigurationSettingsResult> asyncHandler)
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdateRequest
Container for the necessary
parameters to execute the AbortEnvironmentUpdate operation on
AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>abortEnvironmentUpdateAsync(final AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdateRequest
Container for the necessary
parameters to execute the AbortEnvironmentUpdate operation on
AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServerRequest
Container for the necessary parameters
to execute the RestartAppServer operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>restartAppServerAsync(final RestartAppServerRequest restartAppServerRequest)
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServerRequest
Container for the necessary parameters
to execute the RestartAppServer operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
deleteEnvironmentConfigurationRequest
Container for the
necessary parameters to execute the DeleteEnvironmentConfiguration
operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteEnvironmentConfigurationAsync(final DeleteEnvironmentConfigurationRequest 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.
deleteEnvironmentConfigurationRequest
Container for the
necessary parameters to execute the DeleteEnvironmentConfiguration
operation on AWSElasticBeanstalk.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
updateEnvironmentRequest
Container for the necessary parameters
to execute the UpdateEnvironment operation on AWSElasticBeanstalk.com.amazonaws.AmazonClientException
If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.com.amazonaws.AmazonServiceException
If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public Future<UpdateEnvironmentResult>updateEnvironmentAsync(final UpdateEnvironmentRequest updateEnvironmentRequest)