com.amazonaws.services.elasticbeanstalk

Class AWSElasticBeanstalkClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient

All Implemented Interfaces:

AWSElasticBeanstalk

Direct Known Subclasses:

AWSElasticBeanstalkAsyncClient

public class AWSElasticBeanstalkClient
extends AmazonWebServiceClient
implements AWSElasticBeanstalk

Client for accessing AWSElasticBeanstalk. All service calls made using this client are blocking, and will not return until the service call completes.

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 .

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all AWSElasticBeanstalk exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AWSElasticBeanstalkClient() Constructs a new client to invoke service methods on AWSElasticBeanstalk.
AWSElasticBeanstalkClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials.
AWSElasticBeanstalkClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials and client configuration options.
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider.
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider and client configuration options.
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider, client configuration options, and request metric collector.
AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AWSElasticBeanstalk.

Method Summary

Methods

Modifier and Type	Method and Description
void	abortEnvironmentUpdate() Cancels in-progress environment configuration update or application version deployment.
void	abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.
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	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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk

setEndpoint, setRegion, shutdown

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AWSElasticBeanstalk exceptions.

Constructor Detail

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient()

Constructs a new client to invoke service methods on AWSElasticBeanstalk. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSElasticBeanstalk. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWSElasticBeanstalk (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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.).

AWSElasticBeanstalkClient

public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration,
                         RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AWSElasticBeanstalk using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

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 collector

Method Detail

checkDNSAvailability

public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)

Checks if the specified CNAME is available.

Specified by:

checkDNSAvailability in interface AWSElasticBeanstalk

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

public 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. 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.

Specified by:

describeConfigurationOptions in interface AWSElasticBeanstalk

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

public void deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)

Deletes the specified configuration template.

NOTE:When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

Specified by:

deleteConfigurationTemplate in interface AWSElasticBeanstalk

Parameters:

deleteConfigurationTemplateRequest - Container for the necessary parameters to execute the DeleteConfigurationTemplate service method on AWSElasticBeanstalk.

Throws:

OperationInProgressException

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

public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

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

Specified by:

createEnvironment in interface AWSElasticBeanstalk

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

InsufficientPrivilegesException

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

public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Specified by:

createStorageLocation in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public void requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)

Initiates a request to compile the specified type of information of the deployed environment.

Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

Use RetrieveEnvironmentInfo to obtain the set of logs.

Related Topics

• RetrieveEnvironmentInfo

Specified by:

requestEnvironmentInfo in interface AWSElasticBeanstalk

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

public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)

Creates an application version for the specified application.

NOTE:Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

Specified by:

createApplicationVersion in interface AWSElasticBeanstalk

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

InsufficientPrivilegesException

TooManyApplicationVersionsException

S3LocationNotInServiceRegionException

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

public void deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)

Deletes the specified version from the specified application.

NOTE:You cannot delete an application version that is associated with a running environment.

Specified by:

deleteApplicationVersion in interface AWSElasticBeanstalk

Parameters:

deleteApplicationVersionRequest - Container for the necessary parameters to execute the DeleteApplicationVersion service method on AWSElasticBeanstalk.

Throws:

OperationInProgressException

InsufficientPrivilegesException

SourceBundleDeletionException

S3LocationNotInServiceRegionException

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

public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)

Returns descriptions for existing application versions.

Specified by:

describeApplicationVersions in interface AWSElasticBeanstalk

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

public void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

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

Specified by:

deleteApplication in interface AWSElasticBeanstalk

Parameters:

deleteApplicationRequest - Container for the necessary parameters to execute the DeleteApplication service method on AWSElasticBeanstalk.

Throws:

OperationInProgressException

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

public UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)

Updates the specified application version to have the specified properties.

NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

Specified by:

updateApplicationVersion in interface AWSElasticBeanstalk

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

public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)

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

Specified by:

createApplication in interface AWSElasticBeanstalk

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

public void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)

Swaps the CNAMEs of two environments.

Specified by:

swapEnvironmentCNAMEs in interface AWSElasticBeanstalk

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

public UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)

Updates the specified configuration template to have the specified properties or configuration option values.

NOTE: If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

Related Topics

• DescribeConfigurationOptions

Specified by:

updateConfigurationTemplate in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

• RequestEnvironmentInfo

Specified by:

retrieveEnvironmentInfo in interface AWSElasticBeanstalk

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

public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)

Returns a list of the available solution stack names.

Specified by:

listAvailableSolutionStacks in interface AWSElasticBeanstalk

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

public UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)

Updates the specified application to have the specified properties.

NOTE: If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

Specified by:

updateApplication in interface AWSElasticBeanstalk

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

public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)

Returns descriptions for existing environments.

Specified by:

describeEnvironments in interface AWSElasticBeanstalk

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

public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)

Returns AWS resources for this environment.

Specified by:

describeEnvironmentResources in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)

Terminates the specified environment.

Specified by:

terminateEnvironment in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)

Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

Specified by:

validateConfigurationSettings in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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.

abortEnvironmentUpdate

public void abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)

Cancels in-progress environment configuration update or application version deployment.

Specified by:

abortEnvironmentUpdate in interface AWSElasticBeanstalk

Parameters:

abortEnvironmentUpdateRequest - Container for the necessary parameters to execute the AbortEnvironmentUpdate service method on AWSElasticBeanstalk.

Throws:

InsufficientPrivilegesException

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

public void restartAppServer(RestartAppServerRequest restartAppServerRequest)

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

Specified by:

restartAppServer in interface AWSElasticBeanstalk

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

public void deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)

Deletes the draft configuration associated with the running environment.

Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

Specified by:

deleteEnvironmentConfiguration in interface AWSElasticBeanstalk

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

public 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.

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.

Specified by:

updateEnvironment in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)

Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.

Related Topics

• DescribeConfigurationOptions
• DescribeConfigurationSettings
• ListAvailableSolutionStacks

Specified by:

createConfigurationTemplate in interface AWSElasticBeanstalk

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:

InsufficientPrivilegesException

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

public 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.

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

Specified by:

describeConfigurationSettings in interface AWSElasticBeanstalk

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

public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)

Returns the descriptions of existing applications.

Specified by:

describeApplications in interface AWSElasticBeanstalk

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

public 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.

Specified by:

rebuildEnvironment in interface AWSElasticBeanstalk

Parameters:

rebuildEnvironmentRequest - Container for the necessary parameters to execute the RebuildEnvironment service method on AWSElasticBeanstalk.

Throws:

InsufficientPrivilegesException

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

public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)

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.

Specified by:

describeEvents in interface AWSElasticBeanstalk

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

public CreateStorageLocationResult createStorageLocation()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Specified by:

createStorageLocation in interface AWSElasticBeanstalk

Returns:

The response from the CreateStorageLocation service method, as returned by AWSElasticBeanstalk.

Throws:

InsufficientPrivilegesException

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

public DescribeApplicationVersionsResult describeApplicationVersions()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns descriptions for existing application versions.

Specified by:

describeApplicationVersions in interface 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.

swapEnvironmentCNAMEs

public void swapEnvironmentCNAMEs()
                           throws AmazonServiceException,
                                  AmazonClientException

Swaps the CNAMEs of two environments.

Specified by:

swapEnvironmentCNAMEs in interface 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

public ListAvailableSolutionStacksResult listAvailableSolutionStacks()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns a list of the available solution stack names.

Specified by:

listAvailableSolutionStacks in interface 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.

describeEnvironments

public DescribeEnvironmentsResult describeEnvironments()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns descriptions for existing environments.

Specified by:

describeEnvironments in interface 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.

abortEnvironmentUpdate

public void abortEnvironmentUpdate()
                            throws AmazonServiceException,
                                   AmazonClientException

Cancels in-progress environment configuration update or application version deployment.

Specified by:

abortEnvironmentUpdate in interface AWSElasticBeanstalk

Throws:

InsufficientPrivilegesException

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

public DescribeApplicationsResult describeApplications()
                                                throws AmazonServiceException,
                                                       AmazonClientException

Returns the descriptions of existing applications.

Specified by:

describeApplications in interface 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.

describeEvents

public 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.

Specified by:

describeEvents in interface 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.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AWSElasticBeanstalk

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.