public interface AWSElasticBeanstalk
This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.
AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl .
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary .
| Modifier and Type | Method and Description |
|---|---|
CheckDNSAvailabilityResult |
checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
Checks if the specified CNAME is available.
|
CreateApplicationResult |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application that has one configuration template named
default and no application versions. |
CreateApplicationVersionResult |
createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)
Creates an application version for the specified application.
|
CreateConfigurationTemplateResult |
createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)
Creates a configuration template.
|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Launches an environment for the specified application using the
specified configuration.
|
CreateStorageLocationResult |
createStorageLocation()
Creates the Amazon S3 storage location for the account.
|
CreateStorageLocationResult |
createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
|
void |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the specified application along with all associated versions
and configurations.
|
void |
deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
|
void |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)
Deletes the specified configuration template.
|
void |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)
Deletes the draft configuration associated with the running
environment.
|
DescribeApplicationsResult |
describeApplications()
Returns the descriptions of existing applications.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Returns the descriptions of existing applications.
|
DescribeApplicationVersionsResult |
describeApplicationVersions()
Returns descriptions for existing application versions.
|
DescribeApplicationVersionsResult |
describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
Returns descriptions for existing application versions.
|
DescribeConfigurationOptionsResult |
describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest)
Describes the configuration options that are used in a particular
configuration template or environment, or that a specified solution
stack defines.
|
DescribeConfigurationSettingsResult |
describeConfigurationSettings(DescribeConfigurationSettingsRequest 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.
|
DescribeEnvironmentResourcesResult |
describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
|
DescribeEnvironmentsResult |
describeEnvironments()
Returns descriptions for existing environments.
|
DescribeEnvironmentsResult |
describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
Returns descriptions for existing environments.
|
DescribeEventsResult |
describeEvents()
Returns list of event descriptions matching criteria up to the last 6
weeks.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6
weeks.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for
debugging issues where a service isn't acting as expected.
|
ListAvailableSolutionStacksResult |
listAvailableSolutionStacks()
Returns a list of the available solution stack names.
|
ListAvailableSolutionStacksResult |
listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
Returns a list of the available solution stack names.
|
void |
rebuildEnvironment(RebuildEnvironmentRequest 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.
|
void |
requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)
Initiates a request to compile the specified type of information of
the deployed environment.
|
void |
restartAppServer(RestartAppServerRequest restartAppServerRequest)
Causes the environment to restart the application container server
running on each Amazon EC2 instance.
|
RetrieveEnvironmentInfoResult |
retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
Retrieves the compiled information from a RequestEnvironmentInfo
request.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String), sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
swapEnvironmentCNAMEs()
Swaps the CNAMEs of two environments.
|
void |
swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
Swaps the CNAMEs of two environments.
|
TerminateEnvironmentResult |
terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
Terminates the specified environment.
|
UpdateApplicationResult |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application to have the specified properties.
|
UpdateApplicationVersionResult |
updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)
Updates the specified application version to have the specified
properties.
|
UpdateConfigurationTemplateResult |
updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified
properties or configuration option values.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest 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.
|
ValidateConfigurationSettingsResult |
validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)
Takes a set of configuration settings and either a configuration
template or environment, and determines whether those values are
valid.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full
URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint - The endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException - If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String), sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region.IllegalArgumentException - If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) throws AmazonServiceException, AmazonClientException
Checks if the specified CNAME is available.
checkDNSAvailabilityRequest - Container for the necessary
parameters to execute the CheckDNSAvailability service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) throws AmazonServiceException, AmazonClientException
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.OperationInProgressExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws AmazonServiceException, AmazonClientException
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.TooManyEnvironmentsExceptionInsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionS3SubscriptionRequiredExceptionTooManyBucketsExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) throws AmazonServiceException, AmazonClientException
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. Use RetrieveEnvironmentInfo to access
the compiled information.
Related Topics
requestEnvironmentInfoRequest - Container for the necessary
parameters to execute the RequestEnvironmentInfo service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) throws AmazonServiceException, AmazonClientException
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.TooManyApplicationsExceptionInsufficientPrivilegesExceptionTooManyApplicationVersionsExceptionS3LocationNotInServiceRegionExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) throws AmazonServiceException, AmazonClientException
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.OperationInProgressExceptionInsufficientPrivilegesExceptionSourceBundleDeletionExceptionS3LocationNotInServiceRegionExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns descriptions for existing application versions.
describeApplicationVersionsRequest - Container for the necessary
parameters to execute the DescribeApplicationVersions service method
on AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws AmazonServiceException, AmazonClientException
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.OperationInProgressExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest) throws AmazonServiceException, AmazonClientException
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.TooManyApplicationsExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) throws AmazonServiceException, AmazonClientException
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest - Container for the necessary
parameters to execute the SwapEnvironmentCNAMEs service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) throws AmazonServiceException, AmazonClientException
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest - Container for the necessary
parameters to execute the RetrieveEnvironmentInfo service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available solution stack names.
listAvailableSolutionStacksRequest - Container for the necessary
parameters to execute the ListAvailableSolutionStacks service method
on AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws AmazonServiceException, AmazonClientException
Returns descriptions for existing environments.
describeEnvironmentsRequest - Container for the necessary
parameters to execute the DescribeEnvironments service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) throws AmazonServiceException, AmazonClientException
Returns AWS resources for this environment.
describeEnvironmentResourcesRequest - Container for the necessary
parameters to execute the DescribeEnvironmentResources service method
on AWSElasticBeanstalk.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) throws AmazonServiceException, AmazonClientException
Terminates the specified environment.
terminateEnvironmentRequest - Container for the necessary
parameters to execute the TerminateEnvironment service method on
AWSElasticBeanstalk.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void restartAppServer(RestartAppServerRequest restartAppServerRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionTooManyConfigurationTemplatesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) throws AmazonServiceException, AmazonClientException
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.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws AmazonServiceException, AmazonClientException
Returns the descriptions of existing applications.
describeApplicationsRequest - Container for the necessary
parameters to execute the DescribeApplications service method on
AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest) throws AmazonServiceException, AmazonClientException
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.InsufficientPrivilegesExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest) throws AmazonServiceException, AmazonClientException
Returns list of event descriptions matching criteria up to the last 6 weeks.
NOTE: This action returns the most recent 1,000 events from the specified NextToken.
describeEventsRequest - Container for the necessary parameters to
execute the DescribeEvents service method on AWSElasticBeanstalk.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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.CreateStorageLocationResult createStorageLocation() throws AmazonServiceException, AmazonClientException
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
InsufficientPrivilegesExceptionS3SubscriptionRequiredExceptionTooManyBucketsExceptionAmazonClientException - 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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeApplicationVersionsResult describeApplicationVersions() throws AmazonServiceException, AmazonClientException
Returns descriptions for existing application versions.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void swapEnvironmentCNAMEs()
throws AmazonServiceException,
AmazonClientException
Swaps the CNAMEs of two environments.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.ListAvailableSolutionStacksResult listAvailableSolutionStacks() throws AmazonServiceException, AmazonClientException
Returns a list of the available solution stack names.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeEnvironmentsResult describeEnvironments() throws AmazonServiceException, AmazonClientException
Returns descriptions for existing environments.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeApplicationsResult describeApplications() throws AmazonServiceException, AmazonClientException
Returns the descriptions of existing applications.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.DescribeEventsResult describeEvents() throws AmazonServiceException, AmazonClientException
Returns list of event descriptions matching criteria up to the last 6 weeks.
NOTE: This action returns the most recent 1,000 events from the specified NextToken.
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.AmazonServiceException - If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.Copyright © 2014. All rights reserved.