@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSElasticBeanstalkClient extends AmazonWebServiceClient implements AWSElasticBeanstalk
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSElasticBeanstalkClient()
Deprecated.
|
AWSElasticBeanstalkClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSElasticBeanstalkClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSElasticBeanstalkClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
AbortEnvironmentUpdateResult |
abortEnvironmentUpdate()
Simplified method form for invoking the AbortEnvironmentUpdate operation.
|
AbortEnvironmentUpdateResult |
abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
Cancels in-progress environment configuration update or application version deployment.
|
ApplyEnvironmentManagedActionResult |
applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest)
Applies a scheduled managed action immediately.
|
static AWSElasticBeanstalkClientBuilder |
builder() |
CheckDNSAvailabilityResult |
checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
Checks if the specified CNAME is available.
|
ComposeEnvironmentsResult |
composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest)
Create or update a group of environments that each run a separate component of a single application.
|
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()
Simplified method form for invoking the CreateStorageLocation operation.
|
CreateStorageLocationResult |
createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
|
DeleteApplicationResult |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the specified application along with all associated versions and configurations.
|
DeleteApplicationVersionResult |
deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
|
DeleteConfigurationTemplateResult |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)
Deletes the specified configuration template.
|
DeleteEnvironmentConfigurationResult |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)
Deletes the draft configuration associated with the running environment.
|
DescribeApplicationsResult |
describeApplications()
Simplified method form for invoking the DescribeApplications operation.
|
DescribeApplicationsResult |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Returns the descriptions of existing applications.
|
DescribeApplicationVersionsResult |
describeApplicationVersions()
Simplified method form for invoking the DescribeApplicationVersions operation.
|
DescribeApplicationVersionsResult |
describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
Retrieve a list of 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.
|
DescribeEnvironmentHealthResult |
describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)
Returns information about the overall health of the specified environment.
|
DescribeEnvironmentManagedActionHistoryResult |
describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)
Lists an environment's completed and failed managed actions.
|
DescribeEnvironmentManagedActionsResult |
describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)
Lists an environment's upcoming and in-progress managed actions.
|
DescribeEnvironmentResourcesResult |
describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
|
DescribeEnvironmentsResult |
describeEnvironments()
Simplified method form for invoking the DescribeEnvironments operation.
|
DescribeEnvironmentsResult |
describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
Returns descriptions for existing environments.
|
DescribeEventsResult |
describeEvents()
Simplified method form for invoking the DescribeEvents operation.
|
DescribeEventsResult |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6 weeks.
|
DescribeInstancesHealthResult |
describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
|
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()
Simplified method form for invoking the ListAvailableSolutionStacks operation.
|
ListAvailableSolutionStacksResult |
listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
Returns a list of the available solution stack names.
|
RebuildEnvironmentResult |
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.
|
RequestEnvironmentInfoResult |
requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)
Initiates a request to compile the specified type of information of the deployed environment.
|
RestartAppServerResult |
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.
|
SwapEnvironmentCNAMEsResult |
swapEnvironmentCNAMEs()
Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
|
SwapEnvironmentCNAMEsResult |
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.
|
UpdateApplicationResourceLifecycleResult |
updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)
Modifies lifecycle settings for an application.
|
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.
|
addRequestHandler, addRequestHandler, configureRegion, getEndpointPrefix, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AWSElasticBeanstalkClient()
AWSElasticBeanstalkClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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 Elastic Beanstalk (ex: proxy
settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
@Deprecated public AWSElasticBeanstalkClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AWSElasticBeanstalkClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AWSElasticBeanstalkClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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 Elastic Beanstalk (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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 Elastic Beanstalk (ex: proxy
settings, retry counts, etc.).@Deprecated public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
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 Elastic Beanstalk (ex: proxy
settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic static AWSElasticBeanstalkClientBuilder builder()
public AbortEnvironmentUpdateResult abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdate
in interface AWSElasticBeanstalk
abortEnvironmentUpdateRequest
- InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); AbortEnvironmentUpdateRequest request = new AbortEnvironmentUpdateRequest() .withEnvironmentName("my-env"); AbortEnvironmentUpdateResult response = client .abortEnvironmentUpdate(request);
public AbortEnvironmentUpdateResult abortEnvironmentUpdate()
AWSElasticBeanstalk
abortEnvironmentUpdate
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)
public ApplyEnvironmentManagedActionResult applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest)
Applies a scheduled managed action immediately. A managed action can be applied only if its status is
Scheduled
. Get the status and action ID of a managed action with
DescribeEnvironmentManagedActions.
applyEnvironmentManagedAction
in interface AWSElasticBeanstalk
applyEnvironmentManagedActionRequest
- Request to execute a scheduled managed action immediately.ElasticBeanstalkServiceException
- A generic service exception has occurred.ManagedActionInvalidStateException
- Cannot modify the managed action in its current state.public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
Checks if the specified CNAME is available.
checkDNSAvailability
in interface AWSElasticBeanstalk
checkDNSAvailabilityRequest
- Results message indicating whether a CNAME is available.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CheckDNSAvailabilityRequest request = new CheckDNSAvailabilityRequest() .withCNAMEPrefix("my-cname"); CheckDNSAvailabilityResult response = client .checkDNSAvailability(request);
public ComposeEnvironmentsResult composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest)
Create or update a group of environments that each run a separate component of a single application. Takes a list
of version labels that specify application source bundles for each of the environments to create or update. The
name of each environment and other required information must be included in the source bundles in an environment
manifest named env.yaml
. See Compose
Environments for details.
composeEnvironments
in interface AWSElasticBeanstalk
composeEnvironmentsRequest
- Request to create or update a group of environments.TooManyEnvironmentsException
- The specified account has reached its limit of environments.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application that has one configuration template named default
and no application
versions.
createApplication
in interface AWSElasticBeanstalk
createApplicationRequest
- Request to create an application.TooManyApplicationsException
- The specified account has reached its limit of applications.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateApplicationRequest request = new CreateApplicationRequest() .withApplicationName("my-app") .withDescription("my application"); CreateApplicationResult response = client.createApplication(request);
public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)
Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with SourceBuildInformation
.
Specify a build in an AWS CodeBuild with SourceBuildInformation
and BuildConfiguration
.
Specify a source bundle in S3 with SourceBundle
Omit both SourceBuildInformation
and SourceBundle
to use the default sample
application.
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
- TooManyApplicationsException
- The specified account has reached its limit of applications.TooManyApplicationVersionsException
- The specified account has reached its limit of application versions.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.S3LocationNotInServiceRegionException
- The specified S3 bucket does not belong to the S3 region in which the service is running. The following
regions are supported:
IAD/us-east-1
PDX/us-west-2
DUB/eu-west-1
CodeBuildNotInServiceRegionException
- AWS CodeBuild is not available in the specified region.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateApplicationVersionRequest request = new CreateApplicationVersionRequest() .withApplicationName("my-app") .withAutoCreateApplication(true) .withDescription("my-app-v1") .withProcess(true) .withSourceBundle( new S3Location().withS3Bucket("my-bucket").withS3Key( "sample.war")).withVersionLabel("v1"); CreateApplicationVersionResult response = client .createApplicationVersion(request);
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
createConfigurationTemplate
in interface AWSElasticBeanstalk
createConfigurationTemplateRequest
- Request to create a configuration template.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.TooManyConfigurationTemplatesException
- The specified account has reached its limit of configuration templates.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateConfigurationTemplateRequest request = new CreateConfigurationTemplateRequest() .withApplicationName("my-app") .withEnvironmentId("e-rpqsewtp2j") .withTemplateName("my-app-v1"); CreateConfigurationTemplateResult response = client .createConfigurationTemplate(request);
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Launches an environment for the specified application using the specified configuration.
createEnvironment
in interface AWSElasticBeanstalk
createEnvironmentRequest
- TooManyEnvironmentsException
- The specified account has reached its limit of environments.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateEnvironmentRequest request = new CreateEnvironmentRequest() .withApplicationName("my-app") .withCNAMEPrefix("my-app") .withEnvironmentName("my-env") .withSolutionStackName( "64bit Amazon Linux 2015.03 v2.0.0 running Tomcat 8 Java 8") .withVersionLabel("v1"); CreateEnvironmentResult response = client.createEnvironment(request);
public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocation
in interface AWSElasticBeanstalk
createStorageLocationRequest
- TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.S3SubscriptionRequiredException
- The specified account does not have a subscription to Amazon S3.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateStorageLocationRequest request = new CreateStorageLocationRequest(); CreateStorageLocationResult response = client .createStorageLocation(request);
public CreateStorageLocationResult createStorageLocation()
AWSElasticBeanstalk
createStorageLocation
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.createStorageLocation(CreateStorageLocationRequest)
public DeleteApplicationResult 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.
You cannot delete an application that has a running environment.
deleteApplication
in interface AWSElasticBeanstalk
deleteApplicationRequest
- Request to delete an application.OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteApplicationRequest request = new DeleteApplicationRequest() .withApplicationName("my-app"); DeleteApplicationResult response = client.deleteApplication(request);
public DeleteApplicationVersionResult deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
deleteApplicationVersion
in interface AWSElasticBeanstalk
deleteApplicationVersionRequest
- Request to delete an application version.SourceBundleDeletionException
- Unable to delete the Amazon S3 source bundle associated with the application version. The application
version was deleted successfully.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.S3LocationNotInServiceRegionException
- The specified S3 bucket does not belong to the S3 region in which the service is running. The following
regions are supported:
IAD/us-east-1
PDX/us-west-2
DUB/eu-west-1
AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteApplicationVersionRequest request = new DeleteApplicationVersionRequest() .withApplicationName("my-app").withDeleteSourceBundle(true) .withVersionLabel("22a0-stage-150819_182129"); DeleteApplicationVersionResult response = client .deleteApplicationVersion(request);
public DeleteConfigurationTemplateResult deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)
Deletes the specified configuration template.
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
- Request to delete a configuration template.OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteConfigurationTemplateRequest request = new DeleteConfigurationTemplateRequest() .withApplicationName("my-app").withTemplateName("my-template"); DeleteConfigurationTemplateResult response = client .deleteConfigurationTemplate(request);
public DeleteEnvironmentConfigurationResult 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.
deleteEnvironmentConfiguration
in interface AWSElasticBeanstalk
deleteEnvironmentConfigurationRequest
- Request to delete a draft environment configuration.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteEnvironmentConfigurationRequest request = new DeleteEnvironmentConfigurationRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DeleteEnvironmentConfigurationResult response = client .deleteEnvironmentConfiguration(request);
public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
Retrieve a list of application versions.
describeApplicationVersions
in interface AWSElasticBeanstalk
describeApplicationVersionsRequest
- Request to describe application versions.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeApplicationVersionsRequest request = new DescribeApplicationVersionsRequest() .withApplicationName("my-app").withVersionLabels("v2"); DescribeApplicationVersionsResult response = client .describeApplicationVersions(request);
public DescribeApplicationVersionsResult describeApplicationVersions()
AWSElasticBeanstalk
describeApplicationVersions
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeApplicationVersions(DescribeApplicationVersionsRequest)
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Returns the descriptions of existing applications.
describeApplications
in interface AWSElasticBeanstalk
describeApplicationsRequest
- Request to describe one or more applications.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeApplicationsRequest request = new DescribeApplicationsRequest(); DescribeApplicationsResult response = client .describeApplications(request);
public DescribeApplicationsResult describeApplications()
AWSElasticBeanstalk
describeApplications
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeApplications(DescribeApplicationsRequest)
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.
describeConfigurationOptions
in interface AWSElasticBeanstalk
describeConfigurationOptionsRequest
- Result message containig a list of application version descriptions.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeConfigurationOptionsRequest request = new DescribeConfigurationOptionsRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DescribeConfigurationOptionsResult response = client .describeConfigurationOptions(request);
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
describeConfigurationSettings
in interface AWSElasticBeanstalk
describeConfigurationSettingsRequest
- Result message containing all of the configuration settings for a specified solution stack or
configuration template.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeConfigurationSettingsRequest request = new DescribeConfigurationSettingsRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DescribeConfigurationSettingsResult response = client .describeConfigurationSettings(request);
public DescribeEnvironmentHealthResult describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeEnvironmentHealth
in interface AWSElasticBeanstalk
describeEnvironmentHealthRequest
- See the example below to learn how to create a request body.InvalidRequestException
- One or more input parameters is not valid. Please correct the input parameters and try the operation
again.ElasticBeanstalkServiceException
- A generic service exception has occurred.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentHealthRequest request = new DescribeEnvironmentHealthRequest() .withAttributeNames("All").withEnvironmentName("my-env"); DescribeEnvironmentHealthResult response = client .describeEnvironmentHealth(request);
public DescribeEnvironmentManagedActionHistoryResult describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)
Lists an environment's completed and failed managed actions.
describeEnvironmentManagedActionHistory
in interface AWSElasticBeanstalk
describeEnvironmentManagedActionHistoryRequest
- Request to list completed and failed managed actions.ElasticBeanstalkServiceException
- A generic service exception has occurred.public DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)
Lists an environment's upcoming and in-progress managed actions.
describeEnvironmentManagedActions
in interface AWSElasticBeanstalk
describeEnvironmentManagedActionsRequest
- Request to list an environment's upcoming and in-progress managed actions.ElasticBeanstalkServiceException
- A generic service exception has occurred.public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
describeEnvironmentResources
in interface AWSElasticBeanstalk
describeEnvironmentResourcesRequest
- Request to describe the resources in an environment.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentResourcesRequest request = new DescribeEnvironmentResourcesRequest() .withEnvironmentName("my-env"); DescribeEnvironmentResourcesResult response = client .describeEnvironmentResources(request);
public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
Returns descriptions for existing environments.
describeEnvironments
in interface AWSElasticBeanstalk
describeEnvironmentsRequest
- Request to describe one or more environments.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentsRequest request = new DescribeEnvironmentsRequest() .withEnvironmentNames("my-env"); DescribeEnvironmentsResult response = client .describeEnvironments(request);
public DescribeEnvironmentsResult describeEnvironments()
AWSElasticBeanstalk
describeEnvironments
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)
public DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified NextToken
.
describeEvents
in interface AWSElasticBeanstalk
describeEventsRequest
- Request to retrieve a list of events for an environment.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEventsRequest request = new DescribeEventsRequest() .withEnvironmentName("my-env"); DescribeEventsResult response = client.describeEvents(request);
public DescribeEventsResult describeEvents()
AWSElasticBeanstalk
describeEvents
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.describeEvents(DescribeEventsRequest)
public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
describeInstancesHealth
in interface AWSElasticBeanstalk
describeInstancesHealthRequest
- Parameters for a call to DescribeInstancesHealth
.InvalidRequestException
- One or more input parameters is not valid. Please correct the input parameters and try the operation
again.ElasticBeanstalkServiceException
- A generic service exception has occurred.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeInstancesHealthRequest request = new DescribeInstancesHealthRequest() .withAttributeNames("All").withEnvironmentName("my-env"); DescribeInstancesHealthResult response = client .describeInstancesHealth(request);
public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
Returns a list of the available solution stack names.
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
listAvailableSolutionStacksRequest
- AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); ListAvailableSolutionStacksRequest request = new ListAvailableSolutionStacksRequest(); ListAvailableSolutionStacksResult response = client .listAvailableSolutionStacks(request);
public ListAvailableSolutionStacksResult listAvailableSolutionStacks()
AWSElasticBeanstalk
listAvailableSolutionStacks
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)
public RebuildEnvironmentResult 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.
rebuildEnvironment
in interface AWSElasticBeanstalk
rebuildEnvironmentRequest
- InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RebuildEnvironmentRequest request = new RebuildEnvironmentRequest() .withEnvironmentName("my-env"); RebuildEnvironmentResult response = client.rebuildEnvironment(request);
public RequestEnvironmentInfoResult 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
requestEnvironmentInfo
in interface AWSElasticBeanstalk
requestEnvironmentInfoRequest
- Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RequestEnvironmentInfoRequest request = new RequestEnvironmentInfoRequest() .withEnvironmentName("my-env").withInfoType("tail"); RequestEnvironmentInfoResult response = client .requestEnvironmentInfo(request);
public RestartAppServerResult restartAppServer(RestartAppServerRequest restartAppServerRequest)
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServer
in interface AWSElasticBeanstalk
restartAppServerRequest
- AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RestartAppServerRequest request = new RestartAppServerRequest() .withEnvironmentName("my-env"); RestartAppServerResult response = client.restartAppServer(request);
public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfo
in interface AWSElasticBeanstalk
retrieveEnvironmentInfoRequest
- Request to download logs retrieved with RequestEnvironmentInfo.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RetrieveEnvironmentInfoRequest request = new RetrieveEnvironmentInfoRequest() .withEnvironmentName("my-env").withInfoType("tail"); RetrieveEnvironmentInfoResult response = client .retrieveEnvironmentInfo(request);
public SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
swapEnvironmentCNAMEsRequest
- Swaps the CNAMEs of two environments.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); SwapEnvironmentCNAMEsRequest request = new SwapEnvironmentCNAMEsRequest() .withDestinationEnvironmentName("my-env-green") .withSourceEnvironmentName("my-env-blue"); SwapEnvironmentCNAMEsResult response = client .swapEnvironmentCNAMEs(request);
public SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs()
AWSElasticBeanstalk
swapEnvironmentCNAMEs
in interface AWSElasticBeanstalk
AWSElasticBeanstalk.swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)
public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
Terminates the specified environment.
terminateEnvironment
in interface AWSElasticBeanstalk
terminateEnvironmentRequest
- Request to terminate an environment.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); TerminateEnvironmentRequest request = new TerminateEnvironmentRequest() .withEnvironmentName("my-env"); TerminateEnvironmentResult response = client .terminateEnvironment(request);
public UpdateApplicationResult updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application to have the specified properties.
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
- Request to update an application.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateApplicationRequest request = new UpdateApplicationRequest() .withApplicationName("my-app").withDescription( "my Elastic Beanstalk application"); UpdateApplicationResult response = client.updateApplication(request);
public UpdateApplicationResourceLifecycleResult updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)
Modifies lifecycle settings for an application.
updateApplicationResourceLifecycle
in interface AWSElasticBeanstalk
updateApplicationResourceLifecycleRequest
- InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.public UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)
Updates the specified application version to have the specified properties.
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
- AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateApplicationVersionRequest request = new UpdateApplicationVersionRequest() .withApplicationName("my-app") .withDescription("new description") .withVersionLabel("22a0-stage-150819_185942"); UpdateApplicationVersionResult response = client .updateApplicationVersion(request);
public UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified properties or configuration option values.
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
- The result message containing the options for the specified solution stack.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateConfigurationTemplateRequest request = new UpdateConfigurationTemplateRequest() .withApplicationName("my-app") .withOptionsToRemove( new OptionSpecification().withNamespace( "aws:elasticbeanstalk:healthreporting:system") .withOptionName("ConfigDocument")) .withTemplateName("my-template"); UpdateConfigurationTemplateResult response = client .updateConfigurationTemplate(request);
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.
updateEnvironment
in interface AWSElasticBeanstalk
updateEnvironmentRequest
- Request to update an environment.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateEnvironmentRequest request = new UpdateEnvironmentRequest() .withEnvironmentName("my-env").withVersionLabel("v2"); UpdateEnvironmentResult response = client.updateEnvironment(request);AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateEnvironmentRequest request = new UpdateEnvironmentRequest() .withEnvironmentName("my-env").withOptionSettings( new ConfigurationOptionSetting() .withNamespace("aws:elb:healthcheck") .withOptionName("Interval").withValue("15"), new ConfigurationOptionSetting() .withNamespace("aws:elb:healthcheck") .withOptionName("Timeout").withValue("8"), new ConfigurationOptionSetting() .withNamespace("aws:elb:healthcheck") .withOptionName("HealthyThreshold") .withValue("2"), new ConfigurationOptionSetting() .withNamespace("aws:elb:healthcheck") .withOptionName("UnhealthyThreshold") .withValue("3")); UpdateEnvironmentResult response = client.updateEnvironment(request);
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.
validateConfigurationSettings
in interface AWSElasticBeanstalk
validateConfigurationSettingsRequest
- A list of validation messages for a specified configuration template.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); ValidateConfigurationSettingsRequest request = new ValidateConfigurationSettingsRequest() .withApplicationName("my-app") .withEnvironmentName("my-env") .withOptionSettings( new ConfigurationOptionSetting() .withNamespace( "aws:elasticbeanstalk:healthreporting:system") .withOptionName("ConfigDocument") .withValue( "{\"CloudWatchMetrics\": {\"Environment\": {\"ApplicationLatencyP99.9\": null,\"InstancesSevere\": 60,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": 60,\"InstancesUnknown\": 60,\"ApplicationLatencyP85\": 60,\"InstancesInfo\": null,\"ApplicationRequests2xx\": null,\"InstancesDegraded\": null,\"InstancesWarning\": 60,\"ApplicationLatencyP50\": 60,\"ApplicationRequestsTotal\": null,\"InstancesNoData\": null,\"InstancesPending\": 60,\"ApplicationLatencyP10\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": null,\"InstancesOk\": 60,\"ApplicationRequests3xx\": null,\"ApplicationRequests4xx\": null},\"Instance\": {\"ApplicationLatencyP99.9\": null,\"ApplicationLatencyP90\": 60,\"ApplicationLatencyP99\": null,\"ApplicationLatencyP95\": null,\"ApplicationLatencyP85\": null,\"CPUUser\": 60,\"ApplicationRequests2xx\": null,\"CPUIdle\": null,\"ApplicationLatencyP50\": null,\"ApplicationRequestsTotal\": 60,\"RootFilesystemUtil\": null,\"LoadAverage1min\": null,\"CPUIrq\": null,\"CPUNice\": 60,\"CPUIowait\": 60,\"ApplicationLatencyP10\": null,\"LoadAverage5min\": null,\"ApplicationRequests5xx\": null,\"ApplicationLatencyP75\": 60,\"CPUSystem\": 60,\"ApplicationRequests3xx\": 60,\"ApplicationRequests4xx\": null,\"InstanceHealth\": null,\"CPUSoftirq\": 60}},\"Version\": 1}")); ValidateConfigurationSettingsResult response = client .validateConfigurationSettings(request);
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 requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.