AWSElasticBeanstalkClient (AWS Java SDK for AWS Elastic Beanstalk 1.10.26 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalkClient

All Implemented Interfaces:

AWSElasticBeanstalk

Direct Known Subclasses:

AWSElasticBeanstalkAsyncClient
```
public class AWSElasticBeanstalkClient
extends AmazonWebServiceClient
implements AWSElasticBeanstalk
```
Client for accessing Elastic Beanstalk. All service calls made using this client are blocking, and will not return until the service call completes.
AWS Elastic Beanstalk
This is the AWS Elastic Beanstalk API Reference. This guide provides detailed information about AWS Elastic Beanstalk actions, data types, parameters, and errors.

AWS Elastic Beanstalk is a tool that makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on Amazon Web Services cloud resources.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk. wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.

Endpoints

For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.

Field Summary

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

Fields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

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

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`abortEnvironmentUpdate()` Simplified method form for invoking the AbortEnvironmentUpdate operation.
`void`	`abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)` Cancels in-progress environment configuration update or application version deployment.
`CheckDNSAvailabilityResult`	`checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)` Checks if the specified CNAME is available.
`CreateApplicationResult`	`createApplication(CreateApplicationRequest createApplicationRequest)` Creates an application that has one configuration template named `default` and no application versions.
`CreateApplicationVersionResult`	`createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)` Creates an application version for the specified application.
`CreateConfigurationTemplateResult`	`createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)` Creates a configuration template.
`CreateEnvironmentResult`	`createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)` Launches an environment for the specified application using the specified configuration.
`CreateStorageLocationResult`	`createStorageLocation()` Simplified method form for invoking the CreateStorageLocation operation.
`CreateStorageLocationResult`	`createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)` Creates the Amazon S3 storage location for the account.
`void`	`deleteApplication(DeleteApplicationRequest deleteApplicationRequest)` Deletes the specified application along with all associated versions and configurations.
`void`	`deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)` Deletes the specified version from the specified application.
`void`	`deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)` Deletes the specified configuration template.
`void`	`deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)` Deletes the draft configuration associated with the running environment.
`DescribeApplicationsResult`	`describeApplications()` 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)` Returns descriptions for existing application versions.
`DescribeConfigurationOptionsResult`	`describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest)` Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
`DescribeConfigurationSettingsResult`	`describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest)` Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
`DescribeEnvironmentHealthResult`	`describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)` Returns information about the overall health of the specified environment.
`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)` Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes).
`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.
`void`	`rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest)` Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
`void`	`requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)` Initiates a request to compile the specified type of information of the deployed environment.
`void`	`restartAppServer(RestartAppServerRequest restartAppServerRequest)` Causes the environment to restart the application container server running on each Amazon EC2 instance.
`RetrieveEnvironmentInfoResult`	`retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)` Retrieves the compiled information from a RequestEnvironmentInfo request.
`void`	`swapEnvironmentCNAMEs()` Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
`void`	`swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)` Swaps the CNAMEs of two environments.
`TerminateEnvironmentResult`	`terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)` Terminates the specified environment.
`UpdateApplicationResult`	`updateApplication(UpdateApplicationRequest updateApplicationRequest)` Updates the specified application to have the specified properties.
`UpdateApplicationVersionResult`	`updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)` Updates the specified application version to have the specified properties.
`UpdateConfigurationTemplateResult`	`updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)` Updates the specified configuration template to have the specified properties or configuration option values.
`UpdateEnvironmentResult`	`updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)` Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
`ValidateConfigurationSettingsResult`	`validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)` Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk
setEndpoint, setRegion, shutdown

- Field Detail
  - exceptionUnmarshallers
```
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
```
    List of exception unmarshallers for all Elastic Beanstalk exceptions.
- Constructor Detail
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient()
```
    Constructs a new client to invoke service methods on Elastic Beanstalk. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    clientConfiguration - The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
    See Also:
    DefaultAWSCredentialsProviderChain
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(AWSCredentials awsCredentials)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(AWSCredentials awsCredentials,
                         ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
  - AWSElasticBeanstalkClient
```
public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider,
                         ClientConfiguration clientConfiguration,
                         RequestMetricCollector requestMetricCollector)
```
    Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    clientConfiguration - The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
    requestMetricCollector - optional request metric collector
- Method Detail
  - abortEnvironmentUpdate
```
public void abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
```
    Cancels in-progress environment configuration update or application version deployment.
    
    Specified by:
    
    abortEnvironmentUpdate in interface AWSElasticBeanstalk
    
    Parameters:
    abortEnvironmentUpdateRequest -
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - abortEnvironmentUpdate
```
public void abortEnvironmentUpdate()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the AbortEnvironmentUpdate operation.
    
    Specified by:
    
    abortEnvironmentUpdate in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.abortEnvironmentUpdate(AbortEnvironmentUpdateRequest)
  - checkDNSAvailability
```
public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)
```
    Checks if the specified CNAME is available.
    
    Specified by:
    
    checkDNSAvailability in interface AWSElasticBeanstalk
    
    Parameters:
    checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.
    
    Returns:
    Result of the CheckDNSAvailability operation returned by the service.
  - createApplication
```
public CreateApplicationResult createApplication(CreateApplicationRequest createApplicationRequest)
```
    Creates an application that has one configuration template named default and no application versions.
    
    Specified by:
    
    createApplication in interface AWSElasticBeanstalk
    
    Parameters:
    createApplicationRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the CreateApplication operation returned by the service.
    
    Throws:
    
    TooManyApplicationsException - The caller has exceeded the limit on the number of applications associated with their account.
  - createApplicationVersion
```
public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)
```
    Creates an application version for the specified 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.
    
    Specified by:
    
    createApplicationVersion in interface AWSElasticBeanstalk
    
    Parameters:
    createApplicationVersionRequest -
    
    Returns:
    Result of the CreateApplicationVersion operation returned by the service.
    
    Throws:
    
    TooManyApplicationsException - The caller has exceeded the limit on the number of applications associated with their account.
    
    TooManyApplicationVersionsException - The caller has exceeded the limit on the number of application versions associated with their account.
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
    
    S3LocationNotInServiceRegionException - The specified S3 bucket does not belong to the S3 region in which the service is running.
  - createConfigurationTemplate
```
public CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)
```
    Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
    
    Related Topics
    Specified by:
    
    createConfigurationTemplate in interface AWSElasticBeanstalk
    
    Parameters:
    createConfigurationTemplateRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the CreateConfigurationTemplate operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
    
    TooManyConfigurationTemplatesException - The caller has exceeded the limit on the number of configuration templates associated with their account.
  - createEnvironment
```
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
```
    Launches an environment for the specified application using the specified configuration.
    
    Specified by:
    
    createEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    createEnvironmentRequest -
    
    Returns:
    Result of the CreateEnvironment operation returned by the service.
    
    Throws:
    
    TooManyEnvironmentsException - The caller has exceeded the limit of allowed environments associated with the account.
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - createStorageLocation
```
public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
```
    Creates the Amazon S3 storage location for the account.
    
    This location is used to store user log files.
    
    Specified by:
    
    createStorageLocation in interface AWSElasticBeanstalk
    
    Parameters:
    createStorageLocationRequest -
    
    Returns:
    Result of the CreateStorageLocation operation returned by the service.
    
    Throws:
    
    TooManyBucketsException - The web service attempted to create a bucket in an Amazon S3 account that already has 100 buckets.
    
    S3SubscriptionRequiredException - The caller does not have a subscription to Amazon S3.
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - createStorageLocation
```
public CreateStorageLocationResult createStorageLocation()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the CreateStorageLocation operation.
    
    Specified by:
    
    createStorageLocation in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.createStorageLocation(CreateStorageLocationRequest)
  - deleteApplication
```
public void deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
```
    Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
    You cannot delete an application that has a running environment.
    
    Specified by:
    
    deleteApplication in interface AWSElasticBeanstalk
    
    Parameters:
    deleteApplicationRequest - This documentation target is not reported in the API reference.
    
    Throws:
    
    OperationInProgressException - Unable to perform the specified operation because another operation is already in progress affecting an element in this activity.
  - deleteApplicationVersion
```
public void deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)
```
    Deletes the specified version from the specified application.
    You cannot delete an application version that is associated with a running environment.
    
    Specified by:
    
    deleteApplicationVersion in interface AWSElasticBeanstalk
    
    Parameters:
    deleteApplicationVersionRequest - This documentation target is not reported in the API reference.
    
    Throws:
    
    SourceBundleDeletionException - Unable to delete the Amazon S3 source bundle associated with the application version, although the application version deleted successfully.
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
    
    OperationInProgressException - Unable to perform the specified operation because another operation is already in progress affecting an element in this activity.
    
    S3LocationNotInServiceRegionException - The specified S3 bucket does not belong to the S3 region in which the service is running.
  - deleteConfigurationTemplate
```
public void 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.
    
    Specified by:
    
    deleteConfigurationTemplate in interface AWSElasticBeanstalk
    
    Parameters:
    deleteConfigurationTemplateRequest - This documentation target is not reported in the API reference.
    
    Throws:
    
    OperationInProgressException - Unable to perform the specified operation because another operation is already in progress affecting an element in this activity.
  - deleteEnvironmentConfiguration
```
public void deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)
```
    Deletes the draft configuration associated with the running environment.
    
    Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
    
    Specified by:
    
    deleteEnvironmentConfiguration in interface AWSElasticBeanstalk
    
    Parameters:
    deleteEnvironmentConfigurationRequest - This documentation target is not reported in the API reference.
  - describeApplicationVersions
```
public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
```
    Returns descriptions for existing application versions.
    
    Specified by:
    
    describeApplicationVersions in interface AWSElasticBeanstalk
    
    Parameters:
    describeApplicationVersionsRequest - Result message containing a list of configuration descriptions.
    
    Returns:
    Result of the DescribeApplicationVersions operation returned by the service.
  - describeApplicationVersions
```
public DescribeApplicationVersionsResult describeApplicationVersions()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeApplicationVersions operation.
    
    Specified by:
    
    describeApplicationVersions in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.describeApplicationVersions(DescribeApplicationVersionsRequest)
  - describeApplications
```
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
```
    Returns the descriptions of existing applications.
    
    Specified by:
    
    describeApplications in interface AWSElasticBeanstalk
    
    Parameters:
    describeApplicationsRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the DescribeApplications operation returned by the service.
  - describeApplications
```
public DescribeApplicationsResult describeApplications()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeApplications operation.
    
    Specified by:
    
    describeApplications in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.describeApplications(DescribeApplicationsRequest)
  - describeConfigurationOptions
```
public DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest)
```
    Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
    
    Specified by:
    
    describeConfigurationOptions in interface AWSElasticBeanstalk
    
    Parameters:
    describeConfigurationOptionsRequest - Result message containig a list of application version descriptions.
    
    Returns:
    Result of the DescribeConfigurationOptions operation returned by the service.
  - describeConfigurationSettings
```
public DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest)
```
    Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
    
    When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
    
    Related Topics
    - DeleteEnvironmentConfiguration
    Specified by:
    
    describeConfigurationSettings in interface AWSElasticBeanstalk
    
    Parameters:
    describeConfigurationSettingsRequest - 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.
  - describeEnvironmentHealth
```
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.
    
    Specified by:
    
    describeEnvironmentHealth in interface AWSElasticBeanstalk
    
    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 - The request is invalid, please check parameters and their values
    
    ElasticBeanstalkServiceException
  - describeEnvironmentResources
```
public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
```
    Returns AWS resources for this environment.
    
    Specified by:
    
    describeEnvironmentResources in interface AWSElasticBeanstalk
    
    Parameters:
    describeEnvironmentResourcesRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the DescribeEnvironmentResources operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - describeEnvironments
```
public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
```
    Returns descriptions for existing environments.
    
    Specified by:
    
    describeEnvironments in interface AWSElasticBeanstalk
    
    Parameters:
    describeEnvironmentsRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the DescribeEnvironments operation returned by the service.
  - describeEnvironments
```
public DescribeEnvironmentsResult describeEnvironments()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeEnvironments operation.
    
    Specified by:
    
    describeEnvironments in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.describeEnvironments(DescribeEnvironmentsRequest)
  - describeEvents
```
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.
    
    Specified by:
    
    describeEvents in interface AWSElasticBeanstalk
    
    Parameters:
    describeEventsRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the DescribeEvents operation returned by the service.
  - describeEvents
```
public DescribeEventsResult describeEvents()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the DescribeEvents operation.
    
    Specified by:
    
    describeEvents in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.describeEvents(DescribeEventsRequest)
  - describeInstancesHealth
```
public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)
```
    Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
    
    Specified by:
    
    describeInstancesHealth in interface AWSElasticBeanstalk
    
    Parameters:
    describeInstancesHealthRequest - See the example below to learn how to create a request body.
    
    Returns:
    Result of the DescribeInstancesHealth operation returned by the service.
    
    Throws:
    
    InvalidRequestException - The request is invalid, please check parameters and their values
    
    ElasticBeanstalkServiceException
  - listAvailableSolutionStacks
```
public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)
```
    Returns a list of the available solution stack names.
    
    Specified by:
    
    listAvailableSolutionStacks in interface AWSElasticBeanstalk
    
    Parameters:
    listAvailableSolutionStacksRequest -
    
    Returns:
    Result of the ListAvailableSolutionStacks operation returned by the service.
  - listAvailableSolutionStacks
```
public ListAvailableSolutionStacksResult listAvailableSolutionStacks()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the ListAvailableSolutionStacks operation.
    
    Specified by:
    
    listAvailableSolutionStacks in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.listAvailableSolutionStacks(ListAvailableSolutionStacksRequest)
  - rebuildEnvironment
```
public void rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest)
```
    Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
    
    Specified by:
    
    rebuildEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    rebuildEnvironmentRequest -
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - requestEnvironmentInfo
```
public void requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)
```
    Initiates a request to compile the specified type of information of the deployed environment.
    
    Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.
    
    Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.
    
    Use RetrieveEnvironmentInfo to obtain the set of logs.
    
    Related Topics
    - RetrieveEnvironmentInfo
    Specified by:
    
    requestEnvironmentInfo in interface AWSElasticBeanstalk
    
    Parameters:
    requestEnvironmentInfoRequest - This documentation target is not reported in the API reference.
  - restartAppServer
```
public void restartAppServer(RestartAppServerRequest restartAppServerRequest)
```
    Causes the environment to restart the application container server running on each Amazon EC2 instance.
    
    Specified by:
    
    restartAppServer in interface AWSElasticBeanstalk
    
    Parameters:
    restartAppServerRequest -
  - retrieveEnvironmentInfo
```
public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
```
    Retrieves the compiled information from a RequestEnvironmentInfo request.
    
    Related Topics
    - RequestEnvironmentInfo
    Specified by:
    
    retrieveEnvironmentInfo in interface AWSElasticBeanstalk
    
    Parameters:
    retrieveEnvironmentInfoRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the RetrieveEnvironmentInfo operation returned by the service.
  - swapEnvironmentCNAMEs
```
public void swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
```
    Swaps the CNAMEs of two environments.
    
    Specified by:
    
    swapEnvironmentCNAMEs in interface AWSElasticBeanstalk
    
    Parameters:
    swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.
  - swapEnvironmentCNAMEs
```
public void swapEnvironmentCNAMEs()
```
    Description copied from interface: AWSElasticBeanstalk
    
    Simplified method form for invoking the SwapEnvironmentCNAMEs operation.
    
    Specified by:
    
    swapEnvironmentCNAMEs in interface AWSElasticBeanstalk
    
    See Also:
    AWSElasticBeanstalk.swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest)
  - terminateEnvironment
```
public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
```
    Terminates the specified environment.
    
    Specified by:
    
    terminateEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    terminateEnvironmentRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the TerminateEnvironment operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - updateApplication
```
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.
    
    Specified by:
    
    updateApplication in interface AWSElasticBeanstalk
    
    Parameters:
    updateApplicationRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the UpdateApplication operation returned by the service.
  - updateApplicationVersion
```
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.
    
    Specified by:
    
    updateApplicationVersion in interface AWSElasticBeanstalk
    
    Parameters:
    updateApplicationVersionRequest -
    
    Returns:
    Result of the UpdateApplicationVersion operation returned by the service.
  - updateConfigurationTemplate
```
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
    - DescribeConfigurationOptions
    Specified by:
    
    updateConfigurationTemplate in interface AWSElasticBeanstalk
    
    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 - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - updateEnvironment
```
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
```
    Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
    
    Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.
    
    When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.
    
    Specified by:
    
    updateEnvironment in interface AWSElasticBeanstalk
    
    Parameters:
    updateEnvironmentRequest - This documentation target is not reported in the API reference.
    
    Returns:
    Result of the UpdateEnvironment operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - validateConfigurationSettings
```
public ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)
```
    Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
    
    This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
    
    Specified by:
    
    validateConfigurationSettings in interface AWSElasticBeanstalk
    
    Parameters:
    validateConfigurationSettingsRequest - A list of validation messages for a specified configuration template.
    
    Returns:
    Result of the ValidateConfigurationSettings operation returned by the service.
    
    Throws:
    
    InsufficientPrivilegesException - Unable to perform the specified operation because the user does not have enough privileges for one of more downstream aws services
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSElasticBeanstalk
    
    Parameters:
    request - The originally executed request
    
    Returns:
    The response metadata for the specified request, or null if none is available.

Class AWSElasticBeanstalkClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

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

Field Detail

exceptionUnmarshallers

Constructor Detail

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

AWSElasticBeanstalkClient

Method Detail

abortEnvironmentUpdate

abortEnvironmentUpdate

checkDNSAvailability

createApplication

createApplicationVersion

createConfigurationTemplate

createEnvironment

createStorageLocation

createStorageLocation

deleteApplication

deleteApplicationVersion

deleteConfigurationTemplate

deleteEnvironmentConfiguration

describeApplicationVersions

describeApplicationVersions

describeApplications

describeApplications

describeConfigurationOptions

describeConfigurationSettings

describeEnvironmentHealth

describeEnvironmentResources

describeEnvironments

describeEnvironments

describeEvents

describeEvents

describeInstancesHealth

listAvailableSolutionStacks

listAvailableSolutionStacks

rebuildEnvironment

requestEnvironmentInfo

restartAppServer

retrieveEnvironmentInfo

swapEnvironmentCNAMEs

swapEnvironmentCNAMEs

terminateEnvironment

updateApplication

updateApplicationVersion

updateConfigurationTemplate

updateEnvironment

validateConfigurationSettings

getCachedResponseMetadata