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 .
public classAWSElasticBeanstalkClient extends AmazonWebServiceClient implements AWSElasticBeanstalk {
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
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).publicAWSElasticBeanstalkClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) {
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).publicAWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) {
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).requestMetricCollector
optional request metric collectorChecks if the specified CNAME is available.
checkDNSAvailabilityRequest
Container for the necessary
parameters to execute the CheckDNSAvailability service method 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 CheckDNSAvailabilityResultcheckDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) {
request = new CheckDNSAvailabilityRequestMarshaller().marshall(super.beforeMarshalling(checkDNSAvailabilityRequest));
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 service method
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 DescribeConfigurationOptionsResultdescribeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) {
ExecutionContext executionContext = createExecutionContext(describeConfigurationOptionsRequest);
request = new DescribeConfigurationOptionsRequestMarshaller().marshall(super.beforeMarshalling(describeConfigurationOptionsRequest));
response = invoke(request, new DescribeConfigurationOptionsResultStaxUnmarshaller(), executionContext);
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 service method
on AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException
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 voiddeleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) {
request = new DeleteConfigurationTemplateRequestMarshaller().marshall(super.beforeMarshalling(deleteConfigurationTemplateRequest));
Launches an environment for the specified application using the specified configuration.
createEnvironmentRequest
Container for the necessary parameters
to execute the CreateEnvironment service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.TooManyEnvironmentsException
com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 CreateEnvironmentResultcreateEnvironment(CreateEnvironmentRequest createEnvironmentRequest) {
request = new CreateEnvironmentRequestMarshaller().marshall(super.beforeMarshalling(createEnvironmentRequest));
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 service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
com.amazonaws.services.elasticbeanstalk.model.S3SubscriptionRequiredException
com.amazonaws.services.elasticbeanstalk.model.TooManyBucketsException
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 CreateStorageLocationResultcreateStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) {
request = new CreateStorageLocationRequestMarshaller().marshall(super.beforeMarshalling(createStorageLocationRequest));
response = invoke(request, new CreateStorageLocationResultStaxUnmarshaller(), executionContext);
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 service method 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 voidrequestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) {
request = new RequestEnvironmentInfoRequestMarshaller().marshall(super.beforeMarshalling(requestEnvironmentInfoRequest));
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 service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException
com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationVersionsException
com.amazonaws.services.elasticbeanstalk.model.S3LocationNotInServiceRegionException
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 CreateApplicationVersionResultcreateApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) {
request = new CreateApplicationVersionRequestMarshaller().marshall(super.beforeMarshalling(createApplicationVersionRequest));
response = invoke(request, new CreateApplicationVersionResultStaxUnmarshaller(), executionContext);
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 service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException
com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
com.amazonaws.services.elasticbeanstalk.model.SourceBundleDeletionException
com.amazonaws.services.elasticbeanstalk.model.S3LocationNotInServiceRegionException
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 voiddeleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) {
request = new DeleteApplicationVersionRequestMarshaller().marshall(super.beforeMarshalling(deleteApplicationVersionRequest));
Returns descriptions for existing application versions.
describeApplicationVersionsRequest
Container for the necessary
parameters to execute the DescribeApplicationVersions service method
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 DescribeApplicationVersionsResultdescribeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) {
request = new DescribeApplicationVersionsRequestMarshaller().marshall(super.beforeMarshalling(describeApplicationVersionsRequest));
response = invoke(request, new DescribeApplicationVersionsResultStaxUnmarshaller(), executionContext);
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 service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.OperationInProgressException
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.request = new DeleteApplicationRequestMarshaller().marshall(super.beforeMarshalling(deleteApplicationRequest));
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 service method 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 UpdateApplicationVersionResultupdateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) {
request = new UpdateApplicationVersionRequestMarshaller().marshall(super.beforeMarshalling(updateApplicationVersionRequest));
response = invoke(request, new UpdateApplicationVersionResultStaxUnmarshaller(), executionContext);
Creates an application that has one configuration template named
default
and no application versions.
createApplicationRequest
Container for the necessary parameters
to execute the CreateApplication service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.TooManyApplicationsException
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 CreateApplicationResultcreateApplication(CreateApplicationRequest createApplicationRequest) {
request = new CreateApplicationRequestMarshaller().marshall(super.beforeMarshalling(createApplicationRequest));
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest
Container for the necessary
parameters to execute the SwapEnvironmentCNAMEs service method 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.request = new SwapEnvironmentCNAMEsRequestMarshaller().marshall(super.beforeMarshalling(swapEnvironmentCNAMEsRequest));
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 service method
on AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 UpdateConfigurationTemplateResultupdateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) {
request = new UpdateConfigurationTemplateRequestMarshaller().marshall(super.beforeMarshalling(updateConfigurationTemplateRequest));
response = invoke(request, new UpdateConfigurationTemplateResultStaxUnmarshaller(), executionContext);
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest
Container for the necessary
parameters to execute the RetrieveEnvironmentInfo service method 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 RetrieveEnvironmentInfoResultretrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) {
request = new RetrieveEnvironmentInfoRequestMarshaller().marshall(super.beforeMarshalling(retrieveEnvironmentInfoRequest));
response = invoke(request, new RetrieveEnvironmentInfoResultStaxUnmarshaller(), executionContext);
Returns a list of the available solution stack names.
listAvailableSolutionStacksRequest
Container for the necessary
parameters to execute the ListAvailableSolutionStacks service method
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 ListAvailableSolutionStacksResultlistAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) {
ExecutionContext executionContext = createExecutionContext(listAvailableSolutionStacksRequest);
request = new ListAvailableSolutionStacksRequestMarshaller().marshall(super.beforeMarshalling(listAvailableSolutionStacksRequest));
response = invoke(request, new ListAvailableSolutionStacksResultStaxUnmarshaller(), executionContext);
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 service method 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 UpdateApplicationResultupdateApplication(UpdateApplicationRequest updateApplicationRequest) {
request = new UpdateApplicationRequestMarshaller().marshall(super.beforeMarshalling(updateApplicationRequest));
Returns descriptions for existing environments.
describeEnvironmentsRequest
Container for the necessary
parameters to execute the DescribeEnvironments service method 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 DescribeEnvironmentsResultdescribeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) {
request = new DescribeEnvironmentsRequestMarshaller().marshall(super.beforeMarshalling(describeEnvironmentsRequest));
response = invoke(request, new DescribeEnvironmentsResultStaxUnmarshaller(), executionContext);
Returns AWS resources for this environment.
describeEnvironmentResourcesRequest
Container for the necessary
parameters to execute the DescribeEnvironmentResources service method
on AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 DescribeEnvironmentResourcesResultdescribeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) {
ExecutionContext executionContext = createExecutionContext(describeEnvironmentResourcesRequest);
request = new DescribeEnvironmentResourcesRequestMarshaller().marshall(super.beforeMarshalling(describeEnvironmentResourcesRequest));
response = invoke(request, new DescribeEnvironmentResourcesResultStaxUnmarshaller(), executionContext);
Terminates the specified environment.
terminateEnvironmentRequest
Container for the necessary
parameters to execute the TerminateEnvironment service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 TerminateEnvironmentResultterminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) {
request = new TerminateEnvironmentRequestMarshaller().marshall(super.beforeMarshalling(terminateEnvironmentRequest));
response = invoke(request, new TerminateEnvironmentResultStaxUnmarshaller(), executionContext);
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
service method on AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 ValidateConfigurationSettingsResultvalidateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) {
ExecutionContext executionContext = createExecutionContext(validateConfigurationSettingsRequest);
request = new ValidateConfigurationSettingsRequestMarshaller().marshall(super.beforeMarshalling(validateConfigurationSettingsRequest));
response = invoke(request, new ValidateConfigurationSettingsResultStaxUnmarshaller(), executionContext);
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdateRequest
Container for the necessary
parameters to execute the AbortEnvironmentUpdate service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 voidabortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) {
request = new AbortEnvironmentUpdateRequestMarshaller().marshall(super.beforeMarshalling(abortEnvironmentUpdateRequest));
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 service method 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.request = new RestartAppServerRequestMarshaller().marshall(super.beforeMarshalling(restartAppServerRequest));
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
service method 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 voiddeleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) {
ExecutionContext executionContext = createExecutionContext(deleteEnvironmentConfigurationRequest);
request = new DeleteEnvironmentConfigurationRequestMarshaller().marshall(super.beforeMarshalling(deleteEnvironmentConfigurationRequest));
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 service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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 UpdateEnvironmentResultupdateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) {
request = new UpdateEnvironmentRequestMarshaller().marshall(super.beforeMarshalling(updateEnvironmentRequest));
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
createConfigurationTemplateRequest
Container for the necessary
parameters to execute the CreateConfigurationTemplate service method
on AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
com.amazonaws.services.elasticbeanstalk.model.TooManyConfigurationTemplatesException
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 CreateConfigurationTemplateResultcreateConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) {
ExecutionContext executionContext = createExecutionContext(createConfigurationTemplateRequest);
request = new CreateConfigurationTemplateRequestMarshaller().marshall(super.beforeMarshalling(createConfigurationTemplateRequest));
response = invoke(request, new CreateConfigurationTemplateResultStaxUnmarshaller(), executionContext);
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
describeConfigurationSettingsRequest
Container for the
necessary parameters to execute the DescribeConfigurationSettings
service method 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 DescribeConfigurationSettingsResultdescribeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) {
ExecutionContext executionContext = createExecutionContext(describeConfigurationSettingsRequest);
request = new DescribeConfigurationSettingsRequestMarshaller().marshall(super.beforeMarshalling(describeConfigurationSettingsRequest));
response = invoke(request, new DescribeConfigurationSettingsResultStaxUnmarshaller(), executionContext);
Returns the descriptions of existing applications.
describeApplicationsRequest
Container for the necessary
parameters to execute the DescribeApplications service method 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 DescribeApplicationsResultdescribeApplications(DescribeApplicationsRequest describeApplicationsRequest) {
request = new DescribeApplicationsRequestMarshaller().marshall(super.beforeMarshalling(describeApplicationsRequest));
response = invoke(request, new DescribeApplicationsResultStaxUnmarshaller(), executionContext);
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.
rebuildEnvironmentRequest
Container for the necessary
parameters to execute the RebuildEnvironment service method on
AWSElasticBeanstalk.com.amazonaws.services.elasticbeanstalk.model.InsufficientPrivilegesException
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.request = new RebuildEnvironmentRequestMarshaller().marshall(super.beforeMarshalling(rebuildEnvironmentRequest));