AutoCloseable@Generated("software.amazon.awssdk:codegen") public interface ElasticBeanstalkClient extends AutoCloseable
builder() method.
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.
| Modifier and Type | Field | Description |
|---|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method | Description |
|---|---|---|
default AbortEnvironmentUpdateResponse |
abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) |
Cancels in-progress environment configuration update or application version deployment.
|
default ApplyEnvironmentManagedActionResponse |
applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) |
Applies a scheduled managed action immediately.
|
static ElasticBeanstalkClientBuilder |
builder() |
Create a builder that can be used to configure and create a
ElasticBeanstalkClient. |
default CheckDNSAvailabilityResponse |
checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) |
Checks if the specified CNAME is available.
|
default ComposeEnvironmentsResponse |
composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest) |
Create or update a group of environments that each run a separate component of a single application.
|
static ElasticBeanstalkClient |
create() |
Create a
ElasticBeanstalkClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateApplicationResponse |
createApplication(CreateApplicationRequest createApplicationRequest) |
Creates an application that has one configuration template named
default and no application
versions. |
default CreateApplicationVersionResponse |
createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) |
Creates an application version for the specified application.
|
default CreateConfigurationTemplateResponse |
createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) |
Creates a configuration template.
|
default CreateEnvironmentResponse |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) |
Launches an environment for the specified application using the specified configuration.
|
default CreatePlatformVersionResponse |
createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest) |
Create a new version of your custom platform.
|
default CreateStorageLocationResponse |
createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) |
Creates the Amazon S3 storage location for the account.
|
default DeleteApplicationResponse |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest) |
Deletes the specified application along with all associated versions and configurations.
|
default DeleteApplicationVersionResponse |
deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) |
Deletes the specified version from the specified application.
|
default DeleteConfigurationTemplateResponse |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) |
Deletes the specified configuration template.
|
default DeleteEnvironmentConfigurationResponse |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) |
Deletes the draft configuration associated with the running environment.
|
default DeletePlatformVersionResponse |
deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest) |
Deletes the specified version of a custom platform.
|
default DescribeApplicationsResponse |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest) |
Returns the descriptions of existing applications.
|
default DescribeApplicationVersionsResponse |
describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) |
Retrieve a list of application versions.
|
default 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 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 DescribeEnvironmentHealthResponse |
describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) |
Returns information about the overall health of the specified environment.
|
default DescribeEnvironmentManagedActionHistoryResponse |
describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) |
Lists an environment's completed and failed managed actions.
|
default DescribeEnvironmentManagedActionsResponse |
describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) |
Lists an environment's upcoming and in-progress managed actions.
|
default DescribeEnvironmentResourcesResponse |
describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) |
Returns AWS resources for this environment.
|
default DescribeEnvironmentsResponse |
describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) |
Returns descriptions for existing environments.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest) |
Returns list of event descriptions matching criteria up to the last 6 weeks.
|
default DescribeInstancesHealthResponse |
describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest) |
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
|
default DescribePlatformVersionResponse |
describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest) |
Describes the version of the platform.
|
default 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 ListPlatformVersionsResponse |
listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest) |
Lists the available platforms.
|
default 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 RequestEnvironmentInfoResponse |
requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) |
Initiates a request to compile the specified type of information of the deployed environment.
|
default RestartAppServerResponse |
restartAppServer(RestartAppServerRequest restartAppServerRequest) |
Causes the environment to restart the application container server running on each Amazon EC2 instance.
|
default RetrieveEnvironmentInfoResponse |
retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) |
Retrieves the compiled information from a RequestEnvironmentInfo request.
|
static ServiceMetadata |
serviceMetadata() |
|
default SwapEnvironmentCNAMEsResponse |
swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) |
Swaps the CNAMEs of two environments.
|
default TerminateEnvironmentResponse |
terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) |
Terminates the specified environment.
|
default UpdateApplicationResponse |
updateApplication(UpdateApplicationRequest updateApplicationRequest) |
Updates the specified application to have the specified properties.
|
default UpdateApplicationResourceLifecycleResponse |
updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest) |
Modifies lifecycle settings for an application.
|
default UpdateApplicationVersionResponse |
updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) |
Updates the specified application version to have the specified properties.
|
default UpdateConfigurationTemplateResponse |
updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) |
Updates the specified configuration template to have the specified properties or configuration option values.
|
default 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 ValidateConfigurationSettingsResponse |
validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) |
Takes a set of configuration settings and either a configuration template or environment, and determines whether
those values are valid.
|
closestatic final String SERVICE_NAME
static ElasticBeanstalkClient create()
ElasticBeanstalkClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static ElasticBeanstalkClientBuilder builder()
ElasticBeanstalkClient.default AbortEnvironmentUpdateResponse abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) throws InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Cancels in-progress environment configuration update or application version deployment.
abortEnvironmentUpdateRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ApplyEnvironmentManagedActionResponse applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) throws ElasticBeanstalkServiceException, ManagedActionInvalidStateException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
applyEnvironmentManagedActionRequest - Request to execute a scheduled managed action immediately.ElasticBeanstalkServiceException - A generic service exception has occurred.ManagedActionInvalidStateException - Cannot modify the managed action in its current state.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CheckDNSAvailabilityResponse checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Checks if the specified CNAME is available.
checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault ComposeEnvironmentsResponse composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
composeEnvironmentsRequest - Request to create or update a group of environments.TooManyEnvironmentsException - The specified account has reached its limit of environments.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws TooManyApplicationsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Creates an application that has one configuration template named default and no application
versions.
createApplicationRequest - Request to create an application.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateApplicationVersionResponse createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) throws TooManyApplicationsException, TooManyApplicationVersionsException, InsufficientPrivilegesException, S3LocationNotInServiceRegionException, CodeBuildNotInServiceRegionException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
createApplicationVersionRequest - TooManyApplicationsException - The specified account has reached its limit of applications.TooManyApplicationVersionsException - The specified account has reached its limit of application versions.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.S3LocationNotInServiceRegionException - The specified S3 bucket does not belong to the S3 region in which the service is running. The following
regions are supported:
IAD/us-east-1
PDX/us-west-2
DUB/eu-west-1
CodeBuildNotInServiceRegionException - AWS CodeBuild is not available in the specified region.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateConfigurationTemplateResponse createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, TooManyConfigurationTemplatesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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
createConfigurationTemplateRequest - Request to create a configuration template.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.TooManyConfigurationTemplatesException - The specified account has reached its limit of configuration templates.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Launches an environment for the specified application using the specified configuration.
createEnvironmentRequest - TooManyEnvironmentsException - The specified account has reached its limit of environments.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreatePlatformVersionResponse createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, TooManyPlatformsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Create a new version of your custom platform.
createPlatformVersionRequest - Request to create a new platform version.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault CreateStorageLocationResponse createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
createStorageLocationRequest - TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.S3SubscriptionRequiredException - The specified account does not have a subscription to Amazon S3.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws OperationInProgressException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
deleteApplicationRequest - Request to delete an application.OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteApplicationVersionResponse deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) throws SourceBundleDeletionException, InsufficientPrivilegesException, OperationInProgressException, S3LocationNotInServiceRegionException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
deleteApplicationVersionRequest - Request to delete an application version.SourceBundleDeletionException - Unable to delete the Amazon S3 source bundle associated with the application version. The application
version was deleted successfully.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.S3LocationNotInServiceRegionException - The specified S3 bucket does not belong to the S3 region in which the service is running. The following
regions are supported:
IAD/us-east-1
PDX/us-west-2
DUB/eu-west-1
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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteConfigurationTemplateResponse deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) throws OperationInProgressException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
deleteConfigurationTemplateRequest - Request to delete a configuration template.OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DeleteEnvironmentConfigurationResponse deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
deleteEnvironmentConfigurationRequest - Request to delete a draft environment configuration.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault DeletePlatformVersionResponse deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest) throws OperationInProgressException, InsufficientPrivilegesException, ElasticBeanstalkServiceException, PlatformVersionStillReferencedException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Deletes the specified version of a custom platform.
deletePlatformVersionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeApplicationVersionsResponse describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Retrieve a list of application versions.
describeApplicationVersionsRequest - Request to describe application versions.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault DescribeApplicationsResponse describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Returns the descriptions of existing applications.
describeApplicationsRequest - Request to describe one or more applications.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault DescribeConfigurationOptionsResponse describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) throws TooManyBucketsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
describeConfigurationOptionsRequest - Result message containing a list of application version descriptions.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeConfigurationSettingsResponse describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) throws TooManyBucketsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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
describeConfigurationSettingsRequest - Result message containing all of the configuration settings for a specified solution stack or
configuration template.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEnvironmentHealthResponse describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
describeEnvironmentHealthRequest - See the example below to learn how to create a request body.InvalidRequestException - One or more input parameters is not valid. Please correct the input parameters and try the operation
again.ElasticBeanstalkServiceException - A generic service exception has occurred.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEnvironmentManagedActionHistoryResponse describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Lists an environment's completed and failed managed actions.
describeEnvironmentManagedActionHistoryRequest - Request to list completed and failed managed actions.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEnvironmentManagedActionsResponse describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) throws ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Lists an environment's upcoming and in-progress managed actions.
describeEnvironmentManagedActionsRequest - Request to list an environment's upcoming and in-progress managed actions.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEnvironmentResourcesResponse describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) throws InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Returns AWS resources for this environment.
describeEnvironmentResourcesRequest - Request to describe the resources in an environment.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Returns descriptions for existing environments.
describeEnvironmentsRequest - Request to describe one or more environments.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
describeEventsRequest - Request to retrieve a list of events for an environment.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault DescribeInstancesHealthResponse describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
describeInstancesHealthRequest - Parameters for a call to DescribeInstancesHealth.InvalidRequestException - One or more input parameters is not valid. Please correct the input parameters and try the operation
again.ElasticBeanstalkServiceException - A generic service exception has occurred.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault DescribePlatformVersionResponse describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Describes the version of the platform.
describePlatformVersionRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ListAvailableSolutionStacksResponse listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
listAvailableSolutionStacksRequest - SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault ListPlatformVersionsResponse listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Lists the available platforms.
listPlatformVersionsRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RebuildEnvironmentResponse rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest) throws InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
rebuildEnvironmentRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault RequestEnvironmentInfoResponse requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
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
requestEnvironmentInfoRequest - Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault RestartAppServerResponse restartAppServer(RestartAppServerRequest restartAppServerRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServerRequest - SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault RetrieveEnvironmentInfoResponse retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest - Request to download logs retrieved with RequestEnvironmentInfo.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault SwapEnvironmentCNAMEsResponse swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault TerminateEnvironmentResponse terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) throws InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Terminates the specified environment.
terminateEnvironmentRequest - Request to terminate an environment.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
updateApplicationRequest - Request to update an application.SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault UpdateApplicationResourceLifecycleResponse updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest) throws InsufficientPrivilegesException, SdkBaseException, SdkClientException, ElasticBeanstalkException
Modifies lifecycle settings for an application.
updateApplicationResourceLifecycleRequest - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateApplicationVersionResponse updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) throws SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
updateApplicationVersionRequest - SdkBaseExceptionSdkClientExceptionElasticBeanstalkExceptiondefault UpdateConfigurationTemplateResponse updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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
updateConfigurationTemplateRequest - The result message containing the options for the specified solution stack.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws InsufficientPrivilegesException, TooManyBucketsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
updateEnvironmentRequest - Request to update an environment.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typedefault ValidateConfigurationSettingsResponse validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) throws InsufficientPrivilegesException, TooManyBucketsException, SdkBaseException, SdkClientException, ElasticBeanstalkException
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.
validateConfigurationSettingsRequest - A list of validation messages for a specified configuration template.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this typestatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.