AWSElasticBeanstalk (AWS SDK for Java

All Known Subinterfaces:

AWSElasticBeanstalkAsync

All Known Implementing Classes:

AbstractAWSElasticBeanstalk, AbstractAWSElasticBeanstalkAsync, AWSElasticBeanstalkAsyncClient, AWSElasticBeanstalkClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSElasticBeanstalk
```
Interface for accessing Elastic Beanstalk.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSElasticBeanstalk instead.

AWS Elastic Beanstalk
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.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.
`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.
`CreatePlatformVersionResult`	`createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)` Create a new version of your custom platform.
`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.
`DeletePlatformVersionResult`	`deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)` Deletes the specified version of a custom platform.
`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.
`DescribePlatformVersionResult`	`describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)` Describes the version of the platform.
`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, with the public version first and then in reverse chronological order.
`ListPlatformVersionsResult`	`listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)` Lists the available platforms.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Returns the tags applied to an AWS Elastic Beanstalk resource.
`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.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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.
`UpdateTagsForResourceResult`	`updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest)` Update the list of tags applied to an AWS Elastic Beanstalk resource.
`ValidateConfigurationSettingsResult`	`validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)` Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    endpoint - The endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - abortEnvironmentUpdate
```
AbortEnvironmentUpdateResult abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
```
    Cancels in-progress environment configuration update or application version deployment.
    Parameters:
    
    abortEnvironmentUpdateRequest -
    
    Returns:
    
    Result of the AbortEnvironmentUpdate operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To abort a deployment
      The following code aborts a running application version deployment for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); AbortEnvironmentUpdateRequest request = new AbortEnvironmentUpdateRequest() .withEnvironmentName("my-env"); AbortEnvironmentUpdateResult response = client .abortEnvironmentUpdate(request);
  - abortEnvironmentUpdate
```
AbortEnvironmentUpdateResult abortEnvironmentUpdate()
```
    Simplified method form for invoking the AbortEnvironmentUpdate operation.
    
    See Also:
    
    abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)
  - applyEnvironmentManagedAction
```
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.
    
    Parameters:
    
    applyEnvironmentManagedActionRequest - Request to execute a scheduled managed action immediately.
    
    Returns:
    
    Result of the ApplyEnvironmentManagedAction operation returned by the service.
    
    Throws:
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    ManagedActionInvalidStateException - Cannot modify the managed action in its current state.
    
    See Also:
    
    AWS API Documentation
  - checkDNSAvailability
```
CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
```
    Checks if the specified CNAME is available.
    Parameters:
    
    checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.
    
    Returns:
    
    Result of the CheckDNSAvailability operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To check the availability of a CNAME
      The following operation checks the availability of the subdomain my-cname:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CheckDNSAvailabilityRequest request = new CheckDNSAvailabilityRequest() .withCNAMEPrefix("my-cname"); CheckDNSAvailabilityResult response = client .checkDNSAvailability(request);
  - composeEnvironments
```
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.
    
    Parameters:
    
    composeEnvironmentsRequest - Request to create or update a group of environments.
    
    Returns:
    
    Result of the ComposeEnvironments operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createApplication
```
CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
```
    Creates an application that has one configuration template named default and no application versions.
    Parameters:
    
    createApplicationRequest - Request to create an application.
    
    Returns:
    
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    TooManyApplicationsException - The specified account has reached its limit of applications.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new application
      The following operation creates a new application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateApplicationRequest request = new CreateApplicationRequest() .withApplicationName("my-app") .withDescription("my application"); CreateApplicationResult response = client.createApplication(request);
  - createApplicationVersion
```
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.
    Parameters:
    
    createApplicationVersionRequest -
    
    Returns:
    
    Result of the CreateApplicationVersion operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new application
      The following operation creates a new version (v1) of an application named my-app:
      
      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);
  - createConfigurationTemplate
```
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
    Parameters:
    
    createConfigurationTemplateRequest - Request to create a configuration template.
    
    Returns:
    
    Result of the CreateConfigurationTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a configuration template
      The following operation creates a configuration template named my-app-v1 from the settings applied to an environment with the id e-rpqsewtp2j:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateConfigurationTemplateRequest request = new CreateConfigurationTemplateRequest() .withApplicationName("my-app") .withEnvironmentId("e-rpqsewtp2j") .withTemplateName("my-app-v1"); CreateConfigurationTemplateResult response = client .createConfigurationTemplate(request);
  - createEnvironment
```
CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
```
    Launches an environment for the specified application using the specified configuration.
    Parameters:
    
    createEnvironmentRequest -
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new environment for an application
      The following operation creates a new environment for version v1 of a java application named my-app:
      
      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);
  - createPlatformVersion
```
CreatePlatformVersionResult createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)
```
    Create a new version of your custom platform.
    
    Parameters:
    
    createPlatformVersionRequest - Request to create a new platform version.
    
    Returns:
    
    Result of the CreatePlatformVersion operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    TooManyPlatformsException - You have exceeded the maximum number of allowed platforms associated with the account.
    
    See Also:
    
    AWS API Documentation
  - createStorageLocation
```
CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
```
    Creates the Amazon S3 storage location for the account.
    
    This location is used to store user log files.
    Parameters:
    
    createStorageLocationRequest -
    
    Returns:
    
    Result of the CreateStorageLocation operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To create a new environment for an application
      The following operation creates a new environment for version v1 of a java application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); CreateStorageLocationRequest request = new CreateStorageLocationRequest(); CreateStorageLocationResult response = client .createStorageLocation(request);
  - createStorageLocation
```
CreateStorageLocationResult createStorageLocation()
```
    Simplified method form for invoking the CreateStorageLocation operation.
    
    See Also:
    
    createStorageLocation(CreateStorageLocationRequest)
  - deleteApplication
```
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.
    Parameters:
    
    deleteApplicationRequest - Request to delete an application.
    
    Returns:
    
    Result of the DeleteApplication operation returned by the service.
    
    Throws:
    
    OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete an application
      The following operation deletes an application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteApplicationRequest request = new DeleteApplicationRequest() .withApplicationName("my-app"); DeleteApplicationResult response = client.deleteApplication(request);
  - deleteApplicationVersion
```
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.
    Parameters:
    
    deleteApplicationVersionRequest - Request to delete an application version.
    
    Returns:
    
    Result of the DeleteApplicationVersion operation returned by the service.
    
    Throws:
    
    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
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete an application version
      The following operation deletes an application version named 22a0-stage-150819_182129 for an application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteApplicationVersionRequest request = new DeleteApplicationVersionRequest() .withApplicationName("my-app").withDeleteSourceBundle(true) .withVersionLabel("22a0-stage-150819_182129"); DeleteApplicationVersionResult response = client .deleteApplicationVersion(request);
  - deleteConfigurationTemplate
```
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.
    Parameters:
    
    deleteConfigurationTemplateRequest - Request to delete a configuration template.
    
    Returns:
    
    Result of the DeleteConfigurationTemplate operation returned by the service.
    
    Throws:
    
    OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a configuration template
      The following operation deletes a configuration template named my-template for an application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteConfigurationTemplateRequest request = new DeleteConfigurationTemplateRequest() .withApplicationName("my-app").withTemplateName("my-template"); DeleteConfigurationTemplateResult response = client .deleteConfigurationTemplate(request);
  - deleteEnvironmentConfiguration
```
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.
    Parameters:
    
    deleteEnvironmentConfigurationRequest - Request to delete a draft environment configuration.
    
    Returns:
    
    Result of the DeleteEnvironmentConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To delete a draft configuration
      The following operation deletes a draft configuration for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DeleteEnvironmentConfigurationRequest request = new DeleteEnvironmentConfigurationRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DeleteEnvironmentConfigurationResult response = client .deleteEnvironmentConfiguration(request);
  - deletePlatformVersion
```
DeletePlatformVersionResult deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)
```
    Deletes the specified version of a custom platform.
    
    Parameters:
    
    deletePlatformVersionRequest -
    
    Returns:
    
    Result of the DeletePlatformVersion operation returned by the service.
    
    Throws:
    
    OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    PlatformVersionStillReferencedException - You cannot delete the platform version because there are still environments running on it.
    
    See Also:
    
    AWS API Documentation
  - describeApplicationVersions
```
DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
```
    Retrieve a list of application versions.
    Parameters:
    
    describeApplicationVersionsRequest - Request to describe application versions.
    
    Returns:
    
    Result of the DescribeApplicationVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view information about an application version
      The following operation retrieves information about an application version labeled v2:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeApplicationVersionsRequest request = new DescribeApplicationVersionsRequest() .withApplicationName("my-app").withVersionLabels("v2"); DescribeApplicationVersionsResult response = client .describeApplicationVersions(request);
  - describeApplicationVersions
```
DescribeApplicationVersionsResult describeApplicationVersions()
```
    Simplified method form for invoking the DescribeApplicationVersions operation.
    
    See Also:
    
    describeApplicationVersions(DescribeApplicationVersionsRequest)
  - describeApplications
```
DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
```
    Returns the descriptions of existing applications.
    Parameters:
    
    describeApplicationsRequest - Request to describe one or more applications.
    
    Returns:
    
    Result of the DescribeApplications operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view a list of applications
      The following operation retrieves information about applications in the current region:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeApplicationsRequest request = new DescribeApplicationsRequest(); DescribeApplicationsResult response = client .describeApplications(request);
  - describeApplications
```
DescribeApplicationsResult describeApplications()
```
    Simplified method form for invoking the DescribeApplications operation.
    
    See Also:
    
    describeApplications(DescribeApplicationsRequest)
  - describeConfigurationOptions
```
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.
    Parameters:
    
    describeConfigurationOptionsRequest - Result message containing a list of application version descriptions.
    
    Returns:
    
    Result of the DescribeConfigurationOptions operation returned by the service.
    
    Throws:
    
    TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view configuration options for an environment
      The following operation retrieves descriptions of all available configuration options for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeConfigurationOptionsRequest request = new DescribeConfigurationOptionsRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DescribeConfigurationOptionsResult response = client .describeConfigurationOptions(request);
  - describeConfigurationSettings
```
DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest)
```
    Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
    
    When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
    
    Related Topics
    - DeleteEnvironmentConfiguration
    Parameters:
    
    describeConfigurationSettingsRequest - Result message containing all of the configuration settings for a specified solution stack or configuration template.
    
    Returns:
    
    Result of the DescribeConfigurationSettings operation returned by the service.
    
    Throws:
    
    TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view configurations settings for an environment
      The following operation retrieves configuration settings for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeConfigurationSettingsRequest request = new DescribeConfigurationSettingsRequest() .withApplicationName("my-app").withEnvironmentName("my-env"); DescribeConfigurationSettingsResult response = client .describeConfigurationSettings(request);
  - describeEnvironmentHealth
```
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.
    Parameters:
    
    describeEnvironmentHealthRequest - See the example below to learn how to create a request body.
    
    Returns:
    
    Result of the DescribeEnvironmentHealth operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view environment health
      The following operation retrieves overall health information for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentHealthRequest request = new DescribeEnvironmentHealthRequest() .withAttributeNames("All").withEnvironmentName("my-env"); DescribeEnvironmentHealthResult response = client .describeEnvironmentHealth(request);
  - describeEnvironmentManagedActionHistory
```
DescribeEnvironmentManagedActionHistoryResult describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)
```
    Lists an environment's completed and failed managed actions.
    
    Parameters:
    
    describeEnvironmentManagedActionHistoryRequest - Request to list completed and failed managed actions.
    
    Returns:
    
    Result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
    
    Throws:
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentManagedActions
```
DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)
```
    Lists an environment's upcoming and in-progress managed actions.
    
    Parameters:
    
    describeEnvironmentManagedActionsRequest - Request to list an environment's upcoming and in-progress managed actions.
    
    Returns:
    
    Result of the DescribeEnvironmentManagedActions operation returned by the service.
    
    Throws:
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    See Also:
    
    AWS API Documentation
  - describeEnvironmentResources
```
DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
```
    Returns AWS resources for this environment.
    Parameters:
    
    describeEnvironmentResourcesRequest - Request to describe the resources in an environment.
    
    Returns:
    
    Result of the DescribeEnvironmentResources operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view information about the AWS resources in your environment
      The following operation retrieves information about resources in an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentResourcesRequest request = new DescribeEnvironmentResourcesRequest() .withEnvironmentName("my-env"); DescribeEnvironmentResourcesResult response = client .describeEnvironmentResources(request);
  - describeEnvironments
```
DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
```
    Returns descriptions for existing environments.
    Parameters:
    
    describeEnvironmentsRequest - Request to describe one or more environments.
    
    Returns:
    
    Result of the DescribeEnvironments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view information about an environment
      The following operation retrieves information about an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEnvironmentsRequest request = new DescribeEnvironmentsRequest() .withEnvironmentNames("my-env"); DescribeEnvironmentsResult response = client .describeEnvironments(request);
  - describeEnvironments
```
DescribeEnvironmentsResult describeEnvironments()
```
    Simplified method form for invoking the DescribeEnvironments operation.
    
    See Also:
    
    describeEnvironments(DescribeEnvironmentsRequest)
  - describeEvents
```
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.
    Parameters:
    
    describeEventsRequest - Request to retrieve a list of events for an environment.
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view events for an environment
      The following operation retrieves events for an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeEventsRequest request = new DescribeEventsRequest() .withEnvironmentName("my-env"); DescribeEventsResult response = client.describeEvents(request);
  - describeEvents
```
DescribeEventsResult describeEvents()
```
    Simplified method form for invoking the DescribeEvents operation.
    
    See Also:
    
    describeEvents(DescribeEventsRequest)
  - describeInstancesHealth
```
DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)
```
    Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
    Parameters:
    
    describeInstancesHealthRequest - Parameters for a call to DescribeInstancesHealth.
    
    Returns:
    
    Result of the DescribeInstancesHealth operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view environment health
      The following operation retrieves health information for instances in an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); DescribeInstancesHealthRequest request = new DescribeInstancesHealthRequest() .withAttributeNames("All").withEnvironmentName("my-env"); DescribeInstancesHealthResult response = client .describeInstancesHealth(request);
  - describePlatformVersion
```
DescribePlatformVersionResult describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)
```
    Describes the version of the platform.
    
    Parameters:
    
    describePlatformVersionRequest -
    
    Returns:
    
    Result of the DescribePlatformVersion operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    See Also:
    
    AWS API Documentation
  - listAvailableSolutionStacks
```
ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
```
    Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
    Parameters:
    
    listAvailableSolutionStacksRequest -
    
    Returns:
    
    Result of the ListAvailableSolutionStacks operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To view solution stacks
      The following operation lists solution stacks for all currently available platform configurations and any that you have used in the past:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); ListAvailableSolutionStacksRequest request = new ListAvailableSolutionStacksRequest(); ListAvailableSolutionStacksResult response = client .listAvailableSolutionStacks(request);
  - listAvailableSolutionStacks
```
ListAvailableSolutionStacksResult listAvailableSolutionStacks()
```
    Simplified method form for invoking the ListAvailableSolutionStacks operation.
    
    See Also:
    
    listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)
  - listPlatformVersions
```
ListPlatformVersionsResult listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)
```
    Lists the available platforms.
    
    Parameters:
    
    listPlatformVersionsRequest -
    
    Returns:
    
    Result of the ListPlatformVersions operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    ElasticBeanstalkServiceException - A generic service exception has occurred.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
    
    Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).
    
    ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.
    
    See Also:
    
    AWS API Documentation
  - rebuildEnvironment
```
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.
    Parameters:
    
    rebuildEnvironmentRequest -
    
    Returns:
    
    Result of the RebuildEnvironment operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To rebuild an environment
      The following operation terminates and recreates the resources in an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RebuildEnvironmentRequest request = new RebuildEnvironmentRequest() .withEnvironmentName("my-env"); RebuildEnvironmentResult response = client.rebuildEnvironment(request);
  - requestEnvironmentInfo
```
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
    - RetrieveEnvironmentInfo
    Parameters:
    
    requestEnvironmentInfoRequest - Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
    
    Returns:
    
    Result of the RequestEnvironmentInfo operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To request tailed logs
      The following operation requests logs from an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RequestEnvironmentInfoRequest request = new RequestEnvironmentInfoRequest() .withEnvironmentName("my-env").withInfoType("tail"); RequestEnvironmentInfoResult response = client .requestEnvironmentInfo(request);
  - restartAppServer
```
RestartAppServerResult restartAppServer(RestartAppServerRequest restartAppServerRequest)
```
    Causes the environment to restart the application container server running on each Amazon EC2 instance.
    Parameters:
    
    restartAppServerRequest -
    
    Returns:
    
    Result of the RestartAppServer operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To restart application servers
      The following operation restarts application servers on all instances in an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RestartAppServerRequest request = new RestartAppServerRequest() .withEnvironmentName("my-env"); RestartAppServerResult response = client.restartAppServer(request);
  - retrieveEnvironmentInfo
```
RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
```
    Retrieves the compiled information from a RequestEnvironmentInfo request.
    
    Related Topics
    - RequestEnvironmentInfo
    Parameters:
    
    retrieveEnvironmentInfoRequest - Request to download logs retrieved with RequestEnvironmentInfo.
    
    Returns:
    
    Result of the RetrieveEnvironmentInfo operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To retrieve tailed logs
      The following operation retrieves a link to logs from an environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); RetrieveEnvironmentInfoRequest request = new RetrieveEnvironmentInfoRequest() .withEnvironmentName("my-env").withInfoType("tail"); RetrieveEnvironmentInfoResult response = client .retrieveEnvironmentInfo(request);
  - swapEnvironmentCNAMEs
```
SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
```
    Swaps the CNAMEs of two environments.
    Parameters:
    
    swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.
    
    Returns:
    
    Result of the SwapEnvironmentCNAMEs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To swap environment CNAMES
      The following operation swaps the assigned subdomains of two environments:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); SwapEnvironmentCNAMEsRequest request = new SwapEnvironmentCNAMEsRequest() .withDestinationEnvironmentName("my-env-green") .withSourceEnvironmentName("my-env-blue"); SwapEnvironmentCNAMEsResult response = client .swapEnvironmentCNAMEs(request);
  - swapEnvironmentCNAMEs
```
SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs()
```
    Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
    
    See Also:
    
    swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)
  - terminateEnvironment
```
TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
```
    Terminates the specified environment.
    Parameters:
    
    terminateEnvironmentRequest - Request to terminate an environment.
    
    Returns:
    
    Result of the TerminateEnvironment operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To terminate an environment
      The following operation terminates an Elastic Beanstalk environment named my-env:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); TerminateEnvironmentRequest request = new TerminateEnvironmentRequest() .withEnvironmentName("my-env"); TerminateEnvironmentResult response = client .terminateEnvironment(request);
  - updateApplication
```
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.
    Parameters:
    
    updateApplicationRequest - Request to update an application.
    
    Returns:
    
    Result of the UpdateApplication operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To change an application's description
      The following operation updates the description of an application named my-app:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateApplicationRequest request = new UpdateApplicationRequest() .withApplicationName("my-app").withDescription( "my Elastic Beanstalk application"); UpdateApplicationResult response = client.updateApplication(request);
  - updateApplicationResourceLifecycle
```
UpdateApplicationResourceLifecycleResult updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)
```
    Modifies lifecycle settings for an application.
    
    Parameters:
    
    updateApplicationResourceLifecycleRequest -
    
    Returns:
    
    Result of the UpdateApplicationResourceLifecycle operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.
    
    See Also:
    
    AWS API Documentation
  - updateApplicationVersion
```
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.
    Parameters:
    
    updateApplicationVersionRequest -
    
    Returns:
    
    Result of the UpdateApplicationVersion operation returned by the service.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To change an application version's description
      The following operation updates the description of an application version named 22a0-stage-150819_185942:
      
      AWSElasticBeanstalk client = new AWSElasticBeanstalkClient(); UpdateApplicationVersionRequest request = new UpdateApplicationVersionRequest() .withApplicationName("my-app") .withDescription("new description") .withVersionLabel("22a0-stage-150819_185942"); UpdateApplicationVersionResult response = client .updateApplicationVersion(request);
  - updateConfigurationTemplate
```
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
    - DescribeConfigurationOptions
    Parameters:
    
    updateConfigurationTemplateRequest - The result message containing the options for the specified solution stack.
    
    Returns:
    
    Result of the UpdateConfigurationTemplate operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To update a configuration template
      The following operation removes the configured CloudWatch custom health metrics configuration ConfigDocument from a saved configuration template named my-template:
      
      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);
  - updateEnvironment
```
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.
    Parameters:
    
    updateEnvironmentRequest - Request to update an environment.
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To configure option settings
      The following operation configures several options in the aws:elb:loadbalancer namespace:
      
      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);
  - updateTagsForResource
```
UpdateTagsForResourceResult updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest)
```
    Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed: TagsToAdd for tags to add or update, and TagsToRemove.
    
    Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.
    
    Parameters:
    
    updateTagsForResourceRequest -
    
    Returns:
    
    Result of the UpdateTagsForResource operation returned by the service.
    
    Throws:
    
    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.
    
    TooManyTagsException - The number of tags in the resource would exceed the number of tags that each resource can have.
    
    To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
    
    ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).
    
    ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.
    
    See Also:
    
    AWS API Documentation
  - validateConfigurationSettings
```
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.
    Parameters:
    
    validateConfigurationSettingsRequest - A list of validation messages for a specified configuration template.
    
    Returns:
    
    Result of the ValidateConfigurationSettings operation returned by the service.
    
    Throws:
    
    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.
    
    See Also:
    
    AWS API Documentation
    
    Samples:
    - To validate configuration settings
      The following operation validates a CloudWatch custom metrics config document:
      
      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);
  - shutdown
```
void shutdown()
```
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
  - getCachedResponseMetadata
```
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Interface AWSElasticBeanstalk

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

abortEnvironmentUpdate

To abort a deployment

abortEnvironmentUpdate

applyEnvironmentManagedAction

checkDNSAvailability

To check the availability of a CNAME

composeEnvironments

createApplication

To create a new application

createApplicationVersion

To create a new application

createConfigurationTemplate

To create a configuration template

createEnvironment

To create a new environment for an application

createPlatformVersion

createStorageLocation

To create a new environment for an application

createStorageLocation

deleteApplication

To delete an application

deleteApplicationVersion

To delete an application version

deleteConfigurationTemplate

To delete a configuration template

deleteEnvironmentConfiguration

To delete a draft configuration

deletePlatformVersion

describeApplicationVersions

To view information about an application version

describeApplicationVersions

describeApplications

To view a list of applications

describeApplications

describeConfigurationOptions

To view configuration options for an environment

describeConfigurationSettings

To view configurations settings for an environment

describeEnvironmentHealth

To view environment health

describeEnvironmentManagedActionHistory

describeEnvironmentManagedActions

describeEnvironmentResources

To view information about the AWS resources in your environment

describeEnvironments

To view information about an environment

describeEnvironments

describeEvents

To view events for an environment

describeEvents

describeInstancesHealth

To view environment health

describePlatformVersion

listAvailableSolutionStacks

To view solution stacks

listAvailableSolutionStacks

listPlatformVersions

listTagsForResource

rebuildEnvironment

To rebuild an environment

requestEnvironmentInfo

To request tailed logs

restartAppServer

To restart application servers

retrieveEnvironmentInfo

To retrieve tailed logs

swapEnvironmentCNAMEs

To swap environment CNAMES

swapEnvironmentCNAMEs

terminateEnvironment

To terminate an environment