|
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 |
java.lang.Objectcom.amazonaws.AmazonWebServiceClient
com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient
public class AWSElasticBeanstalkClient
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 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:
Constructor Summary | |
---|---|
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(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWSElasticBeanstalk. |
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,
String serviceName,
String regionId)
Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. |
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, getTimeOffset, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, shutdown, withTimeOffset |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk |
---|
setEndpoint, setRegion, shutdown |
Constructor Detail |
---|
public AWSElasticBeanstalkClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProvider
public AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProvider
public AWSElasticBeanstalkClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AWSElasticBeanstalkClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AWSElasticBeanstalk
(ex: proxy settings, retry counts, etc.).Method Detail |
---|
public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) throws AmazonServiceException, AmazonClientException
Checks if the specified CNAME is available.
checkDNSAvailability
in interface AWSElasticBeanstalk
checkDNSAvailabilityRequest
- Container for the necessary
parameters to execute the CheckDNSAvailability service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
describeConfigurationOptions
in interface AWSElasticBeanstalk
describeConfigurationOptionsRequest
- Container for the necessary
parameters to execute the DescribeConfigurationOptions service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
deleteConfigurationTemplate
in interface AWSElasticBeanstalk
deleteConfigurationTemplateRequest
- Container for the necessary
parameters to execute the DeleteConfigurationTemplate service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws AmazonServiceException, AmazonClientException
Launches an environment for the specified application using the specified configuration.
createEnvironment
in interface AWSElasticBeanstalk
createEnvironmentRequest
- Container for the necessary parameters
to execute the CreateEnvironment service method on
AWSElasticBeanstalk.
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.public 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.
createStorageLocation
in interface AWSElasticBeanstalk
createStorageLocationRequest
- Container for the necessary
parameters to execute the CreateStorageLocation service method on
AWSElasticBeanstalk.
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.public 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
requestEnvironmentInfo
in interface AWSElasticBeanstalk
requestEnvironmentInfoRequest
- Container for the necessary
parameters to execute the RequestEnvironmentInfo service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
createApplicationVersion
in interface AWSElasticBeanstalk
createApplicationVersionRequest
- Container for the necessary
parameters to execute the CreateApplicationVersion service method on
AWSElasticBeanstalk.
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.public 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.
deleteApplicationVersion
in interface AWSElasticBeanstalk
deleteApplicationVersionRequest
- Container for the necessary
parameters to execute the DeleteApplicationVersion service method on
AWSElasticBeanstalk.
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.public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns descriptions for existing application versions.
describeApplicationVersions
in interface AWSElasticBeanstalk
describeApplicationVersionsRequest
- Container for the necessary
parameters to execute the DescribeApplicationVersions service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
deleteApplication
in interface AWSElasticBeanstalk
deleteApplicationRequest
- Container for the necessary parameters
to execute the DeleteApplication service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
updateApplicationVersion
in interface AWSElasticBeanstalk
updateApplicationVersionRequest
- Container for the necessary
parameters to execute the UpdateApplicationVersion service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
createApplication
in interface AWSElasticBeanstalk
createApplicationRequest
- Container for the necessary parameters
to execute the CreateApplication service method on
AWSElasticBeanstalk.
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.public void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) throws AmazonServiceException, AmazonClientException
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
swapEnvironmentCNAMEsRequest
- Container for the necessary
parameters to execute the SwapEnvironmentCNAMEs service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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
updateConfigurationTemplate
in interface AWSElasticBeanstalk
updateConfigurationTemplateRequest
- Container for the necessary
parameters to execute the UpdateConfigurationTemplate service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) throws AmazonServiceException, AmazonClientException
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfo
in interface AWSElasticBeanstalk
retrieveEnvironmentInfoRequest
- Container for the necessary
parameters to execute the RetrieveEnvironmentInfo service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available solution stack names.
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
listAvailableSolutionStacksRequest
- Container for the necessary
parameters to execute the ListAvailableSolutionStacks service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
updateApplication
in interface AWSElasticBeanstalk
updateApplicationRequest
- Container for the necessary parameters
to execute the UpdateApplication service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws AmazonServiceException, AmazonClientException
Returns descriptions for existing environments.
describeEnvironments
in interface AWSElasticBeanstalk
describeEnvironmentsRequest
- Container for the necessary
parameters to execute the DescribeEnvironments service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) throws AmazonServiceException, AmazonClientException
Returns AWS resources for this environment.
describeEnvironmentResources
in interface AWSElasticBeanstalk
describeEnvironmentResourcesRequest
- Container for the necessary
parameters to execute the DescribeEnvironmentResources service method
on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) throws AmazonServiceException, AmazonClientException
Terminates the specified environment.
terminateEnvironment
in interface AWSElasticBeanstalk
terminateEnvironmentRequest
- Container for the necessary
parameters to execute the TerminateEnvironment service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
validateConfigurationSettings
in interface AWSElasticBeanstalk
validateConfigurationSettingsRequest
- Container for the
necessary parameters to execute the ValidateConfigurationSettings
service method on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public void restartAppServer(RestartAppServerRequest restartAppServerRequest) throws AmazonServiceException, AmazonClientException
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServer
in interface AWSElasticBeanstalk
restartAppServerRequest
- Container for the necessary parameters
to execute the RestartAppServer service method on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
deleteEnvironmentConfiguration
in interface AWSElasticBeanstalk
deleteEnvironmentConfigurationRequest
- Container for the
necessary parameters to execute the DeleteEnvironmentConfiguration
service method on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
updateEnvironment
in interface AWSElasticBeanstalk
updateEnvironmentRequest
- Container for the necessary parameters
to execute the UpdateEnvironment service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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
createConfigurationTemplate
in interface AWSElasticBeanstalk
createConfigurationTemplateRequest
- Container for the necessary
parameters to execute the CreateConfigurationTemplate service method
on AWSElasticBeanstalk.
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.public 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
describeConfigurationSettings
in interface AWSElasticBeanstalk
describeConfigurationSettingsRequest
- Container for the
necessary parameters to execute the DescribeConfigurationSettings
service method on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws AmazonServiceException, AmazonClientException
Returns the descriptions of existing applications.
describeApplications
in interface AWSElasticBeanstalk
describeApplicationsRequest
- Container for the necessary
parameters to execute the DescribeApplications service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
rebuildEnvironment
in interface AWSElasticBeanstalk
rebuildEnvironmentRequest
- Container for the necessary
parameters to execute the RebuildEnvironment service method on
AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public 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.
describeEvents
in interface AWSElasticBeanstalk
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents service method on AWSElasticBeanstalk.
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public CreateStorageLocationResult createStorageLocation() throws AmazonServiceException, AmazonClientException
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocation
in interface AWSElasticBeanstalk
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.public DescribeApplicationVersionsResult describeApplicationVersions() throws AmazonServiceException, AmazonClientException
Returns descriptions for existing application versions.
describeApplicationVersions
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public void swapEnvironmentCNAMEs() throws AmazonServiceException, AmazonClientException
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public ListAvailableSolutionStacksResult listAvailableSolutionStacks() throws AmazonServiceException, AmazonClientException
Returns a list of the available solution stack names.
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public DescribeEnvironmentsResult describeEnvironments() throws AmazonServiceException, AmazonClientException
Returns descriptions for existing environments.
describeEnvironments
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public DescribeApplicationsResult describeApplications() throws AmazonServiceException, AmazonClientException
Returns the descriptions of existing applications.
describeApplications
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.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.
describeEvents
in interface AWSElasticBeanstalk
AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.
AmazonServiceException
- If an error response is returned by AWSElasticBeanstalk indicating
either a problem with the data in the request, or a server side issue.public void setEndpoint(String endpoint, String serviceName, String regionId) throws IllegalArgumentException
This method is not threadsafe. Endpoints 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.
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
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.serviceName
- The name of the AWS service to use when signing requests.regionId
- The ID of the region in which this service resides.
IllegalArgumentException
- If any problems are detected with the specified endpoint.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AWSElasticBeanstalk
request
- The originally executed request
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |