Package software.amazon.awssdk.services.elasticbeanstalk

Interface ElasticBeanstalkAsyncClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ElasticBeanstalkAsyncClient
extends AutoCloseable

Service client for accessing Elastic Beanstalk asynchronously. This can be created using the static builder() method. 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.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AbortEnvironmentUpdateResponse>	abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)	Cancels in-progress environment configuration update or application version deployment.
default CompletableFuture<ApplyEnvironmentManagedActionResponse>	applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest)	Applies a scheduled managed action immediately.
static ElasticBeanstalkAsyncClientBuilder	builder()	Create a builder that can be used to configure and create a ElasticBeanstalkAsyncClient.
default CompletableFuture<CheckDNSAvailabilityResponse>	checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)	Checks if the specified CNAME is available.
default CompletableFuture<ComposeEnvironmentsResponse>	composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest)	Create or update a group of environments that each run a separate component of a single application.
static ElasticBeanstalkAsyncClient	create()	Create a ElasticBeanstalkAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateApplicationResponse>	createApplication(CreateApplicationRequest createApplicationRequest)	Creates an application that has one configuration template named default and no application versions.
default CompletableFuture<CreateApplicationVersionResponse>	createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)	Creates an application version for the specified application.
default CompletableFuture<CreateConfigurationTemplateResponse>	createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)	Creates a configuration template.
default CompletableFuture<CreateEnvironmentResponse>	createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)	Launches an environment for the specified application using the specified configuration.
default CompletableFuture<CreatePlatformVersionResponse>	createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)	Create a new version of your custom platform.
default CompletableFuture<CreateStorageLocationResponse>	createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)	Creates the Amazon S3 storage location for the account.
default CompletableFuture<DeleteApplicationResponse>	deleteApplication(DeleteApplicationRequest deleteApplicationRequest)	Deletes the specified application along with all associated versions and configurations.
default CompletableFuture<DeleteApplicationVersionResponse>	deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)	Deletes the specified version from the specified application.
default CompletableFuture<DeleteConfigurationTemplateResponse>	deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)	Deletes the specified configuration template.
default CompletableFuture<DeleteEnvironmentConfigurationResponse>	deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)	Deletes the draft configuration associated with the running environment.
default CompletableFuture<DeletePlatformVersionResponse>	deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)	Deletes the specified version of a custom platform.
default CompletableFuture<DescribeApplicationsResponse>	describeApplications(DescribeApplicationsRequest describeApplicationsRequest)	Returns the descriptions of existing applications.
default CompletableFuture<DescribeApplicationVersionsResponse>	describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)	Retrieve a list of application versions.
default CompletableFuture<DescribeConfigurationOptionsResponse>	describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest)	Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.
default CompletableFuture<DescribeConfigurationSettingsResponse>	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.
default CompletableFuture<DescribeEnvironmentHealthResponse>	describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)	Returns information about the overall health of the specified environment.
default CompletableFuture<DescribeEnvironmentManagedActionHistoryResponse>	describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)	Lists an environment's completed and failed managed actions.
default CompletableFuture<DescribeEnvironmentManagedActionsResponse>	describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)	Lists an environment's upcoming and in-progress managed actions.
default CompletableFuture<DescribeEnvironmentResourcesResponse>	describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)	Returns AWS resources for this environment.
default CompletableFuture<DescribeEnvironmentsResponse>	describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)	Returns descriptions for existing environments.
default CompletableFuture<DescribeEventsResponse>	describeEvents(DescribeEventsRequest describeEventsRequest)	Returns list of event descriptions matching criteria up to the last 6 weeks.
default CompletableFuture<DescribeInstancesHealthResponse>	describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)	Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
default CompletableFuture<DescribePlatformVersionResponse>	describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)	Describes the version of the platform.
default CompletableFuture<ListAvailableSolutionStacksResponse>	listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)	Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
default CompletableFuture<ListPlatformVersionsResponse>	listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)	Lists the available platforms.
default CompletableFuture<RebuildEnvironmentResponse>	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.
default CompletableFuture<RequestEnvironmentInfoResponse>	requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)	Initiates a request to compile the specified type of information of the deployed environment.
default CompletableFuture<RestartAppServerResponse>	restartAppServer(RestartAppServerRequest restartAppServerRequest)	Causes the environment to restart the application container server running on each Amazon EC2 instance.
default CompletableFuture<RetrieveEnvironmentInfoResponse>	retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)	Retrieves the compiled information from a RequestEnvironmentInfo request.
default CompletableFuture<SwapEnvironmentCNAMEsResponse>	swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)	Swaps the CNAMEs of two environments.
default CompletableFuture<TerminateEnvironmentResponse>	terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)	Terminates the specified environment.
default CompletableFuture<UpdateApplicationResponse>	updateApplication(UpdateApplicationRequest updateApplicationRequest)	Updates the specified application to have the specified properties.
default CompletableFuture<UpdateApplicationResourceLifecycleResponse>	updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)	Modifies lifecycle settings for an application.
default CompletableFuture<UpdateApplicationVersionResponse>	updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)	Updates the specified application version to have the specified properties.
default CompletableFuture<UpdateConfigurationTemplateResponse>	updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)	Updates the specified configuration template to have the specified properties or configuration option values.
default CompletableFuture<UpdateEnvironmentResponse>	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.
default CompletableFuture<ValidateConfigurationSettingsResponse>	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 interface java.lang.AutoCloseable

close

Method Detail

create

static ElasticBeanstalkAsyncClient create()

Create a ElasticBeanstalkAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ElasticBeanstalkAsyncClientBuilder builder()

Create a builder that can be used to configure and create a ElasticBeanstalkAsyncClient.

abortEnvironmentUpdate

default CompletableFuture<AbortEnvironmentUpdateResponse> abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)

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

Parameters:

abortEnvironmentUpdateRequest -

Returns:

A Java Future containing the result of the AbortEnvironmentUpdate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

applyEnvironmentManagedAction

default CompletableFuture<ApplyEnvironmentManagedActionResponse> 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:

A Java Future containing the result of the ApplyEnvironmentManagedAction operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ElasticBeanstalkServiceException A generic service exception has occurred.
• ManagedActionInvalidStateException Cannot modify the managed action in its current state.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

checkDNSAvailability

default CompletableFuture<CheckDNSAvailabilityResponse> checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)

Checks if the specified CNAME is available.

Parameters:

checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.

Returns:

A Java Future containing the result of the CheckDNSAvailability operation returned by the service.

See Also:

AWS API Documentation

composeEnvironments

default CompletableFuture<ComposeEnvironmentsResponse> 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:

A Java Future containing the result of the ComposeEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createApplication

default CompletableFuture<CreateApplicationResponse> 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:

A Java Future containing the result of the CreateApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyApplicationsException The specified account has reached its limit of applications.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createApplicationVersion

default CompletableFuture<CreateApplicationVersionResponse> 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:

A Java Future containing the result of the CreateApplicationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
  • SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
  • ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createConfigurationTemplate

default CompletableFuture<CreateConfigurationTemplateResponse> createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)

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

Related Topics

• DescribeConfigurationOptions

• DescribeConfigurationSettings

• ListAvailableSolutionStacks

Parameters:

createConfigurationTemplateRequest - Request to create a configuration template.

Returns:

A Java Future containing the result of the CreateConfigurationTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createEnvironment

default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

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

Parameters:

createEnvironmentRequest -

Returns:

A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createPlatformVersion

default CompletableFuture<CreatePlatformVersionResponse> createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)

Create a new version of your custom platform.

Parameters:

createPlatformVersionRequest - Request to create a new platform version.

Returns:

A Java Future containing the result of the CreatePlatformVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

createStorageLocation

default CompletableFuture<CreateStorageLocationResponse> createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)

Creates the Amazon S3 storage location for the account.

This location is used to store user log files.

Parameters:

createStorageLocationRequest -

Returns:

A Java Future containing the result of the CreateStorageLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplication

default CompletableFuture<DeleteApplicationResponse> 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:

A Java Future containing the result of the DeleteApplication operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• OperationInProgressException Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteApplicationVersion

default CompletableFuture<DeleteApplicationVersionResponse> 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:

A Java Future containing the result of the DeleteApplicationVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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

  • SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
  • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
  • ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteConfigurationTemplate

default CompletableFuture<DeleteConfigurationTemplateResponse> 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:

A Java Future containing the result of the DeleteConfigurationTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• OperationInProgressException Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

deleteEnvironmentConfiguration

default CompletableFuture<DeleteEnvironmentConfigurationResponse> 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:

A Java Future containing the result of the DeleteEnvironmentConfiguration operation returned by the service.

See Also:

AWS API Documentation

deletePlatformVersion

default CompletableFuture<DeletePlatformVersionResponse> deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)

Deletes the specified version of a custom platform.

Parameters:

deletePlatformVersionRequest -

Returns:

A Java Future containing the result of the DeletePlatformVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeApplicationVersions

default CompletableFuture<DescribeApplicationVersionsResponse> describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)

Retrieve a list of application versions.

Parameters:

describeApplicationVersionsRequest - Request to describe application versions.

Returns:

A Java Future containing the result of the DescribeApplicationVersions operation returned by the service.

See Also:

AWS API Documentation

describeApplications

default CompletableFuture<DescribeApplicationsResponse> describeApplications(DescribeApplicationsRequest describeApplicationsRequest)

Returns the descriptions of existing applications.

Parameters:

describeApplicationsRequest - Request to describe one or more applications.

Returns:

A Java Future containing the result of the DescribeApplications operation returned by the service.

See Also:

AWS API Documentation

describeConfigurationOptions

default CompletableFuture<DescribeConfigurationOptionsResponse> 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:

A Java Future containing the result of the DescribeConfigurationOptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyBucketsException The specified account has reached its limit of Amazon S3 buckets.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeConfigurationSettings

default CompletableFuture<DescribeConfigurationSettingsResponse> 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:

A Java Future containing the result of the DescribeConfigurationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• TooManyBucketsException The specified account has reached its limit of Amazon S3 buckets.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEnvironmentHealth

default CompletableFuture<DescribeEnvironmentHealthResponse> 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:

A Java Future containing the result of the DescribeEnvironmentHealth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEnvironmentManagedActionHistory

default CompletableFuture<DescribeEnvironmentManagedActionHistoryResponse> describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)

Lists an environment's completed and failed managed actions.

Parameters:

describeEnvironmentManagedActionHistoryRequest - Request to list completed and failed managed actions.

Returns:

A Java Future containing the result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ElasticBeanstalkServiceException A generic service exception has occurred.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEnvironmentManagedActions

default CompletableFuture<DescribeEnvironmentManagedActionsResponse> 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:

A Java Future containing the result of the DescribeEnvironmentManagedActions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ElasticBeanstalkServiceException A generic service exception has occurred.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEnvironmentResources

default CompletableFuture<DescribeEnvironmentResourcesResponse> describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)

Returns AWS resources for this environment.

Parameters:

describeEnvironmentResourcesRequest - Request to describe the resources in an environment.

Returns:

A Java Future containing the result of the DescribeEnvironmentResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describeEnvironments

default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)

Returns descriptions for existing environments.

Parameters:

describeEnvironmentsRequest - Request to describe one or more environments.

Returns:

A Java Future containing the result of the DescribeEnvironments operation returned by the service.

See Also:

AWS API Documentation

describeEvents

default CompletableFuture<DescribeEventsResponse> 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:

A Java Future containing the result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeInstancesHealth

default CompletableFuture<DescribeInstancesHealthResponse> 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:

A Java Future containing the result of the DescribeInstancesHealth operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

describePlatformVersion

default CompletableFuture<DescribePlatformVersionResponse> describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)

Describes the version of the platform.

Parameters:

describePlatformVersionRequest -

Returns:

A Java Future containing the result of the DescribePlatformVersion operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• ElasticBeanstalkServiceException A generic service exception has occurred.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

listAvailableSolutionStacks

default CompletableFuture<ListAvailableSolutionStacksResponse> 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:

A Java Future containing the result of the ListAvailableSolutionStacks operation returned by the service.

See Also:

AWS API Documentation

listPlatformVersions

default CompletableFuture<ListPlatformVersionsResponse> listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)

Lists the available platforms.

Parameters:

listPlatformVersionsRequest -

Returns:

A Java Future containing the result of the ListPlatformVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• ElasticBeanstalkServiceException A generic service exception has occurred.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

rebuildEnvironment

default CompletableFuture<RebuildEnvironmentResponse> 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:

A Java Future containing the result of the RebuildEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

requestEnvironmentInfo

default CompletableFuture<RequestEnvironmentInfoResponse> 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:

A Java Future containing the result of the RequestEnvironmentInfo operation returned by the service.

See Also:

AWS API Documentation

restartAppServer

default CompletableFuture<RestartAppServerResponse> restartAppServer(RestartAppServerRequest restartAppServerRequest)

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

Parameters:

restartAppServerRequest -

Returns:

A Java Future containing the result of the RestartAppServer operation returned by the service.

See Also:

AWS API Documentation

retrieveEnvironmentInfo

default CompletableFuture<RetrieveEnvironmentInfoResponse> retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)

Retrieves the compiled information from a RequestEnvironmentInfo request.

Related Topics

• RequestEnvironmentInfo

Parameters:

retrieveEnvironmentInfoRequest - Request to download logs retrieved with RequestEnvironmentInfo.

Returns:

A Java Future containing the result of the RetrieveEnvironmentInfo operation returned by the service.

See Also:

AWS API Documentation

swapEnvironmentCNAMEs

default CompletableFuture<SwapEnvironmentCNAMEsResponse> swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)

Swaps the CNAMEs of two environments.

Parameters:

swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.

Returns:

A Java Future containing the result of the SwapEnvironmentCNAMEs operation returned by the service.

See Also:

AWS API Documentation

terminateEnvironment

default CompletableFuture<TerminateEnvironmentResponse> terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)

Terminates the specified environment.

Parameters:

terminateEnvironmentRequest - Request to terminate an environment.

Returns:

A Java Future containing the result of the TerminateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateApplication

default CompletableFuture<UpdateApplicationResponse> 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:

A Java Future containing the result of the UpdateApplication operation returned by the service.

See Also:

AWS API Documentation

updateApplicationResourceLifecycle

default CompletableFuture<UpdateApplicationResourceLifecycleResponse> updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)

Modifies lifecycle settings for an application.

Parameters:

updateApplicationResourceLifecycleRequest -

Returns:

A Java Future containing the result of the UpdateApplicationResourceLifecycle operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• InsufficientPrivilegesException The specified account does not have sufficient privileges for one of more AWS services.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateApplicationVersion

default CompletableFuture<UpdateApplicationVersionResponse> 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:

A Java Future containing the result of the UpdateApplicationVersion operation returned by the service.

See Also:

AWS API Documentation

updateConfigurationTemplate

default CompletableFuture<UpdateConfigurationTemplateResponse> 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:

A Java Future containing the result of the UpdateConfigurationTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

updateEnvironment

default CompletableFuture<UpdateEnvironmentResponse> 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:

A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation

validateConfigurationSettings

default CompletableFuture<ValidateConfigurationSettingsResponse> 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:

A Java Future containing the result of the ValidateConfigurationSettings operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• 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.
• SdkBaseException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
• SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc
• ElasticBeanstalkException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this

See Also:

AWS API Documentation