AWSElasticBeanstalk (AWS SDK for Java

Overview

Package

Class

Index

Help

Did this page help you?
Yes No Tell us about it...

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.elasticbeanstalk
Interface AWSElasticBeanstalk

All Known Subinterfaces:: AWSElasticBeanstalkAsync

All Known Implementing Classes:: AWSElasticBeanstalkAsyncClient, AWSElasticBeanstalkClient

public interface AWSElasticBeanstalk

Interface for accessing AWSElasticBeanstalk. 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 lastest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk.wsdl .

Endpoints

AWS Elastic Beanstalk supports the following region-specific endpoint:

https://elasticbeanstalk.us-east-1.amazonaws.com

Method Summary
`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.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

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.

Parameters:: 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.
Throws:: IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

An alternative to 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.

Parameters:: region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.
Throws:: IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)
See Also:: Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

checkDNSAvailability

CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Checks if the specified CNAME is available.

Parameters:: checkDNSAvailabilityRequest - Container for the necessary parameters to execute the CheckDNSAvailability service method on AWSElasticBeanstalk.
Returns:: The response from the CheckDNSAvailability service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeConfigurationOptions

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.

Parameters:: describeConfigurationOptionsRequest - Container for the necessary parameters to execute the DescribeConfigurationOptions service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeConfigurationOptions service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

deleteConfigurationTemplate

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.

Parameters:: deleteConfigurationTemplateRequest - Container for the necessary parameters to execute the DeleteConfigurationTemplate service method on AWSElasticBeanstalk.
Throws:: 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.

createEnvironment

CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Launches an environment for the specified application using the specified configuration.

Parameters:: createEnvironmentRequest - Container for the necessary parameters to execute the CreateEnvironment service method on AWSElasticBeanstalk.
Returns:: The response from the CreateEnvironment service method, as returned by AWSElasticBeanstalk.
Throws:: TooManyEnvironmentsException; 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.

createStorageLocation

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.

Parameters:: createStorageLocationRequest - Container for the necessary parameters to execute the CreateStorageLocation service method on AWSElasticBeanstalk.
Returns:: The response from the CreateStorageLocation service method, as returned by AWSElasticBeanstalk.
Throws:: S3SubscriptionRequiredException; TooManyBucketsException; 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.

requestEnvironmentInfo

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

RetrieveEnvironmentInfo

Parameters:: requestEnvironmentInfoRequest - Container for the necessary parameters to execute the RequestEnvironmentInfo service method on AWSElasticBeanstalk.
Throws:: 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.

createApplicationVersion

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.

Parameters:: createApplicationVersionRequest - Container for the necessary parameters to execute the CreateApplicationVersion service method on AWSElasticBeanstalk.
Returns:: The response from the CreateApplicationVersion service method, as returned by AWSElasticBeanstalk.
Throws:: TooManyApplicationsException; TooManyApplicationVersionsException; 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.

deleteApplicationVersion

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.

Parameters:: deleteApplicationVersionRequest - Container for the necessary parameters to execute the DeleteApplicationVersion service method on AWSElasticBeanstalk.
Throws:: SourceBundleDeletionException; 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.

describeApplicationVersions

DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns descriptions for existing application versions.

Parameters:: describeApplicationVersionsRequest - Container for the necessary parameters to execute the DescribeApplicationVersions service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeApplicationVersions service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

deleteApplication

void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Deletes the specified application along with all associated versions and configurations.

NOTE:You cannot delete an application that has a running environment.

Parameters:: deleteApplicationRequest - Container for the necessary parameters to execute the DeleteApplication service method on AWSElasticBeanstalk.
Throws:: 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.

updateApplicationVersion

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.

Parameters:: updateApplicationVersionRequest - Container for the necessary parameters to execute the UpdateApplicationVersion service method on AWSElasticBeanstalk.
Returns:: The response from the UpdateApplicationVersion service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

createApplication

CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
                                          throws AmazonServiceException,
                                                 AmazonClientException

Creates an application that has one configuration template named default and no application versions.

NOTE: The default configuration template is for a 32-bit version of the Amazon Linux operating system running the Tomcat 6 application container.

Parameters:: createApplicationRequest - Container for the necessary parameters to execute the CreateApplication service method on AWSElasticBeanstalk.
Returns:: The response from the CreateApplication service method, as returned by AWSElasticBeanstalk.
Throws:: TooManyApplicationsException; 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.

swapEnvironmentCNAMEs

void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Swaps the CNAMEs of two environments.

Parameters:: swapEnvironmentCNAMEsRequest - Container for the necessary parameters to execute the SwapEnvironmentCNAMEs service method on AWSElasticBeanstalk.
Throws:: 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.

updateConfigurationTemplate

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

DescribeConfigurationOptions

Parameters:: updateConfigurationTemplateRequest - Container for the necessary parameters to execute the UpdateConfigurationTemplate service method on AWSElasticBeanstalk.
Returns:: The response from the UpdateConfigurationTemplate service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

retrieveEnvironmentInfo

RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

RequestEnvironmentInfo

Parameters:: retrieveEnvironmentInfoRequest - Container for the necessary parameters to execute the RetrieveEnvironmentInfo service method on AWSElasticBeanstalk.
Returns:: The response from the RetrieveEnvironmentInfo service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

listAvailableSolutionStacks

ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns a list of the available solution stack names.

Parameters:: listAvailableSolutionStacksRequest - Container for the necessary parameters to execute the ListAvailableSolutionStacks service method on AWSElasticBeanstalk.
Returns:: The response from the ListAvailableSolutionStacks service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

updateApplication

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.

Parameters:: updateApplicationRequest - Container for the necessary parameters to execute the UpdateApplication service method on AWSElasticBeanstalk.
Returns:: The response from the UpdateApplication service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeEnvironments

DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns descriptions for existing environments.

Parameters:: describeEnvironmentsRequest - Container for the necessary parameters to execute the DescribeEnvironments service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeEnvironments service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeEnvironmentResources

DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns AWS resources for this environment.

Parameters:: describeEnvironmentResourcesRequest - Container for the necessary parameters to execute the DescribeEnvironmentResources service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeEnvironmentResources service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

terminateEnvironment

TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Terminates the specified environment.

Parameters:: terminateEnvironmentRequest - Container for the necessary parameters to execute the TerminateEnvironment service method on AWSElasticBeanstalk.
Returns:: The response from the TerminateEnvironment service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

validateConfigurationSettings

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.

Parameters:: validateConfigurationSettingsRequest - Container for the necessary parameters to execute the ValidateConfigurationSettings service method on AWSElasticBeanstalk.
Returns:: The response from the ValidateConfigurationSettings service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

restartAppServer

void restartAppServer(RestartAppServerRequest restartAppServerRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Causes the environment to restart the application container server running on each Amazon EC2 instance.

Parameters:: restartAppServerRequest - Container for the necessary parameters to execute the RestartAppServer service method on AWSElasticBeanstalk.
Throws:: 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.

deleteEnvironmentConfiguration

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.

Parameters:: deleteEnvironmentConfigurationRequest - Container for the necessary parameters to execute the DeleteEnvironmentConfiguration service method on AWSElasticBeanstalk.
Throws:: 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.

updateEnvironment

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.

Parameters:: updateEnvironmentRequest - Container for the necessary parameters to execute the UpdateEnvironment service method on AWSElasticBeanstalk.
Returns:: The response from the UpdateEnvironment service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

createConfigurationTemplate

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

DescribeConfigurationOptions
DescribeConfigurationSettings
ListAvailableSolutionStacks

Parameters:: createConfigurationTemplateRequest - Container for the necessary parameters to execute the CreateConfigurationTemplate service method on AWSElasticBeanstalk.
Returns:: The response from the CreateConfigurationTemplate service method, as returned by AWSElasticBeanstalk.
Throws:: TooManyConfigurationTemplatesException; 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.

describeConfigurationSettings

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

DeleteEnvironmentConfiguration

Parameters:: describeConfigurationSettingsRequest - Container for the necessary parameters to execute the DescribeConfigurationSettings service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeConfigurationSettings service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeApplications

DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the descriptions of existing applications.

Parameters:: describeApplicationsRequest - Container for the necessary parameters to execute the DescribeApplications service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeApplications service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

rebuildEnvironment

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.

Parameters:: rebuildEnvironmentRequest - Container for the necessary parameters to execute the RebuildEnvironment service method on AWSElasticBeanstalk.
Throws:: 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.

describeEvents

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.

Parameters:: describeEventsRequest - Container for the necessary parameters to execute the DescribeEvents service method on AWSElasticBeanstalk.
Returns:: The response from the DescribeEvents service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

createStorageLocation

CreateStorageLocationResult createStorageLocation()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Returns:: The response from the CreateStorageLocation service method, as returned by AWSElasticBeanstalk.
Throws:: S3SubscriptionRequiredException; TooManyBucketsException; 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.

describeApplicationVersions

DescribeApplicationVersionsResult describeApplicationVersions()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns descriptions for existing application versions.

Returns:: The response from the DescribeApplicationVersions service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

swapEnvironmentCNAMEs

void swapEnvironmentCNAMEs()
                           throws AmazonServiceException,
                                  AmazonClientException

Swaps the CNAMEs of two environments.

Throws:: 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.

listAvailableSolutionStacks

ListAvailableSolutionStacksResult listAvailableSolutionStacks()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns a list of the available solution stack names.

Returns:: The response from the ListAvailableSolutionStacks service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeEnvironments

DescribeEnvironmentsResult describeEnvironments()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns descriptions for existing environments.

Returns:: The response from the DescribeEnvironments service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeApplications

DescribeApplicationsResult describeApplications()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the descriptions of existing applications.

Returns:: The response from the DescribeApplications service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

describeEvents

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.

Returns:: The response from the DescribeEvents service method, as returned by AWSElasticBeanstalk.
Throws:: 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.

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:: request - The originally executed request.
Returns:: The response metadata for the specified request, or null if none is available.

Overview

Package

Class

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Did this page help you?

com.amazonaws.services.elasticbeanstalk Interface AWSElasticBeanstalk

setEndpoint

setRegion

checkDNSAvailability

describeConfigurationOptions

deleteConfigurationTemplate

createEnvironment

createStorageLocation

requestEnvironmentInfo

createApplicationVersion

deleteApplicationVersion

describeApplicationVersions

deleteApplication

updateApplicationVersion

createApplication

swapEnvironmentCNAMEs

updateConfigurationTemplate

retrieveEnvironmentInfo

listAvailableSolutionStacks

updateApplication

describeEnvironments

describeEnvironmentResources

terminateEnvironment

validateConfigurationSettings

restartAppServer

deleteEnvironmentConfiguration

updateEnvironment

createConfigurationTemplate

describeConfigurationSettings

describeApplications

rebuildEnvironment

describeEvents

createStorageLocation

describeApplicationVersions

swapEnvironmentCNAMEs

listAvailableSolutionStacks

describeEnvironments

describeApplications

describeEvents

shutdown

getCachedResponseMetadata

com.amazonaws.services.elasticbeanstalk
Interface AWSElasticBeanstalk