@Generated(value="software.amazon.awssdk:codegen") public interface ElasticBeanstalkClient extends SdkClient, SdkAutoCloseable
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 and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AbortEnvironmentUpdateResponse |
abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)
Cancels in-progress environment configuration update or application version deployment.
|
default AbortEnvironmentUpdateResponse |
abortEnvironmentUpdate(Consumer<AbortEnvironmentUpdateRequest.Builder> abortEnvironmentUpdateRequest)
Cancels in-progress environment configuration update or application version deployment.
|
default ApplyEnvironmentManagedActionResponse |
applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest)
Applies a scheduled managed action immediately.
|
default ApplyEnvironmentManagedActionResponse |
applyEnvironmentManagedAction(Consumer<ApplyEnvironmentManagedActionRequest.Builder> 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 CheckDNSAvailabilityResponse |
checkDNSAvailability(Consumer<CheckDNSAvailabilityRequest.Builder> 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.
|
default ComposeEnvironmentsResponse |
composeEnvironments(Consumer<ComposeEnvironmentsRequest.Builder> 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(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)
Creates an application that has one configuration template named
default and no application
versions. |
default CreateApplicationResponse |
createApplication(CreateApplicationRequest createApplicationRequest)
Creates an application that has one configuration template named
default and no application
versions. |
default CreateApplicationVersionResponse |
createApplicationVersion(Consumer<CreateApplicationVersionRequest.Builder> createApplicationVersionRequest)
Creates an application version for the specified application.
|
default CreateApplicationVersionResponse |
createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)
Creates an application version for the specified application.
|
default CreateConfigurationTemplateResponse |
createConfigurationTemplate(Consumer<CreateConfigurationTemplateRequest.Builder> createConfigurationTemplateRequest)
Creates a configuration template.
|
default CreateConfigurationTemplateResponse |
createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)
Creates a configuration template.
|
default CreateEnvironmentResponse |
createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
Launches an environment for the specified application using the specified configuration.
|
default CreateEnvironmentResponse |
createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Launches an environment for the specified application using the specified configuration.
|
default CreatePlatformVersionResponse |
createPlatformVersion(Consumer<CreatePlatformVersionRequest.Builder> createPlatformVersionRequest)
Create a new version of your custom platform.
|
default CreatePlatformVersionResponse |
createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)
Create a new version of your custom platform.
|
default CreateStorageLocationResponse |
createStorageLocation()
Creates the Amazon S3 storage location for the account.
|
default CreateStorageLocationResponse |
createStorageLocation(Consumer<CreateStorageLocationRequest.Builder> createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
|
default CreateStorageLocationResponse |
createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)
Creates the Amazon S3 storage location for the account.
|
default DeleteApplicationResponse |
deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest)
Deletes the specified application along with all associated versions and configurations.
|
default DeleteApplicationResponse |
deleteApplication(DeleteApplicationRequest deleteApplicationRequest)
Deletes the specified application along with all associated versions and configurations.
|
default DeleteApplicationVersionResponse |
deleteApplicationVersion(Consumer<DeleteApplicationVersionRequest.Builder> deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
|
default DeleteApplicationVersionResponse |
deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)
Deletes the specified version from the specified application.
|
default DeleteConfigurationTemplateResponse |
deleteConfigurationTemplate(Consumer<DeleteConfigurationTemplateRequest.Builder> deleteConfigurationTemplateRequest)
Deletes the specified configuration template.
|
default DeleteConfigurationTemplateResponse |
deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)
Deletes the specified configuration template.
|
default DeleteEnvironmentConfigurationResponse |
deleteEnvironmentConfiguration(Consumer<DeleteEnvironmentConfigurationRequest.Builder> deleteEnvironmentConfigurationRequest)
Deletes the draft configuration associated with the running environment.
|
default DeleteEnvironmentConfigurationResponse |
deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)
Deletes the draft configuration associated with the running environment.
|
default DeletePlatformVersionResponse |
deletePlatformVersion(Consumer<DeletePlatformVersionRequest.Builder> deletePlatformVersionRequest)
Deletes the specified version of a custom platform.
|
default DeletePlatformVersionResponse |
deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)
Deletes the specified version of a custom platform.
|
default DescribeApplicationsResponse |
describeApplications()
Returns the descriptions of existing applications.
|
default DescribeApplicationsResponse |
describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest)
Returns the descriptions of existing applications.
|
default DescribeApplicationsResponse |
describeApplications(DescribeApplicationsRequest describeApplicationsRequest)
Returns the descriptions of existing applications.
|
default DescribeApplicationVersionsResponse |
describeApplicationVersions()
Retrieve a list of application versions.
|
default DescribeApplicationVersionsResponse |
describeApplicationVersions(Consumer<DescribeApplicationVersionsRequest.Builder> describeApplicationVersionsRequest)
Retrieve a list of application versions.
|
default DescribeApplicationVersionsResponse |
describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)
Retrieve a list of application versions.
|
default DescribeConfigurationOptionsResponse |
describeConfigurationOptions(Consumer<DescribeConfigurationOptionsRequest.Builder> describeConfigurationOptionsRequest)
Describes the configuration options that are used in a particular configuration template or environment, or that
a specified solution stack defines.
|
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(Consumer<DescribeConfigurationSettingsRequest.Builder> 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 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(Consumer<DescribeEnvironmentHealthRequest.Builder> describeEnvironmentHealthRequest)
Returns information about the overall health of the specified environment.
|
default DescribeEnvironmentHealthResponse |
describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)
Returns information about the overall health of the specified environment.
|
default DescribeEnvironmentManagedActionHistoryResponse |
describeEnvironmentManagedActionHistory(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest)
Lists an environment's completed and failed managed actions.
|
default DescribeEnvironmentManagedActionHistoryResponse |
describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)
Lists an environment's completed and failed managed actions.
|
default DescribeEnvironmentManagedActionsResponse |
describeEnvironmentManagedActions(Consumer<DescribeEnvironmentManagedActionsRequest.Builder> describeEnvironmentManagedActionsRequest)
Lists an environment's upcoming and in-progress managed actions.
|
default DescribeEnvironmentManagedActionsResponse |
describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)
Lists an environment's upcoming and in-progress managed actions.
|
default DescribeEnvironmentResourcesResponse |
describeEnvironmentResources(Consumer<DescribeEnvironmentResourcesRequest.Builder> describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
|
default DescribeEnvironmentResourcesResponse |
describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)
Returns AWS resources for this environment.
|
default DescribeEnvironmentsResponse |
describeEnvironments()
Returns descriptions for existing environments.
|
default DescribeEnvironmentsResponse |
describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)
Returns descriptions for existing environments.
|
default DescribeEnvironmentsResponse |
describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)
Returns descriptions for existing environments.
|
default DescribeEventsResponse |
describeEvents()
Returns list of event descriptions matching criteria up to the last 6 weeks.
|
default DescribeEventsResponse |
describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6 weeks.
|
default DescribeEventsResponse |
describeEvents(DescribeEventsRequest describeEventsRequest)
Returns list of event descriptions matching criteria up to the last 6 weeks.
|
default DescribeInstancesHealthResponse |
describeInstancesHealth(Consumer<DescribeInstancesHealthRequest.Builder> describeInstancesHealthRequest)
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
|
default DescribeInstancesHealthResponse |
describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk.
|
default DescribePlatformVersionResponse |
describePlatformVersion(Consumer<DescribePlatformVersionRequest.Builder> describePlatformVersionRequest)
Describes the version of the platform.
|
default DescribePlatformVersionResponse |
describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)
Describes the version of the platform.
|
default ListAvailableSolutionStacksResponse |
listAvailableSolutionStacks()
Returns a list of the available solution stack names, with the public version first and then in reverse
chronological order.
|
default ListAvailableSolutionStacksResponse |
listAvailableSolutionStacks(Consumer<ListAvailableSolutionStacksRequest.Builder> listAvailableSolutionStacksRequest)
Returns a list of the available solution stack names, with the public version first and then in reverse
chronological order.
|
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()
Lists the available platforms.
|
default ListPlatformVersionsResponse |
listPlatformVersions(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest)
Lists the available platforms.
|
default ListPlatformVersionsResponse |
listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)
Lists the available platforms.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns the tags applied to an AWS Elastic Beanstalk resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns the tags applied to an AWS Elastic Beanstalk resource.
|
default RebuildEnvironmentResponse |
rebuildEnvironment(Consumer<RebuildEnvironmentRequest.Builder> 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 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(Consumer<RequestEnvironmentInfoRequest.Builder> requestEnvironmentInfoRequest)
Initiates a request to compile the specified type of information of the deployed environment.
|
default RequestEnvironmentInfoResponse |
requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)
Initiates a request to compile the specified type of information of the deployed environment.
|
default RestartAppServerResponse |
restartAppServer(Consumer<RestartAppServerRequest.Builder> restartAppServerRequest)
Causes the environment to restart the application container server running on each Amazon EC2 instance.
|
default RestartAppServerResponse |
restartAppServer(RestartAppServerRequest restartAppServerRequest)
Causes the environment to restart the application container server running on each Amazon EC2 instance.
|
default RetrieveEnvironmentInfoResponse |
retrieveEnvironmentInfo(Consumer<RetrieveEnvironmentInfoRequest.Builder> retrieveEnvironmentInfoRequest)
Retrieves the compiled information from a RequestEnvironmentInfo request.
|
default RetrieveEnvironmentInfoResponse |
retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)
Retrieves the compiled information from a RequestEnvironmentInfo request.
|
static ServiceMetadata |
serviceMetadata() |
default SwapEnvironmentCNAMEsResponse |
swapEnvironmentCNAMEs(Consumer<SwapEnvironmentCNAMEsRequest.Builder> swapEnvironmentCNAMEsRequest)
Swaps the CNAMEs of two environments.
|
default SwapEnvironmentCNAMEsResponse |
swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)
Swaps the CNAMEs of two environments.
|
default TerminateEnvironmentResponse |
terminateEnvironment(Consumer<TerminateEnvironmentRequest.Builder> terminateEnvironmentRequest)
Terminates the specified environment.
|
default TerminateEnvironmentResponse |
terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)
Terminates the specified environment.
|
default UpdateApplicationResponse |
updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest)
Updates the specified application to have the specified properties.
|
default UpdateApplicationResponse |
updateApplication(UpdateApplicationRequest updateApplicationRequest)
Updates the specified application to have the specified properties.
|
default UpdateApplicationResourceLifecycleResponse |
updateApplicationResourceLifecycle(Consumer<UpdateApplicationResourceLifecycleRequest.Builder> updateApplicationResourceLifecycleRequest)
Modifies lifecycle settings for an application.
|
default UpdateApplicationResourceLifecycleResponse |
updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)
Modifies lifecycle settings for an application.
|
default UpdateApplicationVersionResponse |
updateApplicationVersion(Consumer<UpdateApplicationVersionRequest.Builder> updateApplicationVersionRequest)
Updates the specified application version to have the specified properties.
|
default UpdateApplicationVersionResponse |
updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)
Updates the specified application version to have the specified properties.
|
default UpdateConfigurationTemplateResponse |
updateConfigurationTemplate(Consumer<UpdateConfigurationTemplateRequest.Builder> updateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified properties or configuration option values.
|
default UpdateConfigurationTemplateResponse |
updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)
Updates the specified configuration template to have the specified properties or configuration option values.
|
default UpdateEnvironmentResponse |
updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> 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 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 UpdateTagsForResourceResponse |
updateTagsForResource(Consumer<UpdateTagsForResourceRequest.Builder> updateTagsForResourceRequest)
Update the list of tags applied to an AWS Elastic Beanstalk resource.
|
default UpdateTagsForResourceResponse |
updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest)
Update the list of tags applied to an AWS Elastic Beanstalk resource.
|
default ValidateConfigurationSettingsResponse |
validateConfigurationSettings(Consumer<ValidateConfigurationSettingsRequest.Builder> validateConfigurationSettingsRequest)
Takes a set of configuration settings and either a configuration template or environment, and determines whether
those values are valid.
|
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.
|
serviceNameclosestatic 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, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault AbortEnvironmentUpdateResponse abortEnvironmentUpdate(Consumer<AbortEnvironmentUpdateRequest.Builder> abortEnvironmentUpdateRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Cancels in-progress environment configuration update or application version deployment.
This is a convenience which creates an instance of the AbortEnvironmentUpdateRequest.Builder avoiding the
need to create one manually via AbortEnvironmentUpdateRequest.builder()
abortEnvironmentUpdateRequest - A Consumer that will call methods on AbortEnvironmentUpdateMessage.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault ApplyEnvironmentManagedActionResponse applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) throws ElasticBeanstalkServiceException, ManagedActionInvalidStateException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault ApplyEnvironmentManagedActionResponse applyEnvironmentManagedAction(Consumer<ApplyEnvironmentManagedActionRequest.Builder> applyEnvironmentManagedActionRequest) throws ElasticBeanstalkServiceException, ManagedActionInvalidStateException, AwsServiceException, 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.
This is a convenience which creates an instance of the ApplyEnvironmentManagedActionRequest.Builder
avoiding the need to create one manually via ApplyEnvironmentManagedActionRequest.builder()
applyEnvironmentManagedActionRequest - A Consumer that will call methods on ApplyEnvironmentManagedActionRequest.Builder to
create a request. 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.SdkException - 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 type.AwsServiceExceptiondefault CheckDNSAvailabilityResponse checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Checks if the specified CNAME is available.
checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.SdkException - 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 type.AwsServiceExceptiondefault CheckDNSAvailabilityResponse checkDNSAvailability(Consumer<CheckDNSAvailabilityRequest.Builder> checkDNSAvailabilityRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Checks if the specified CNAME is available.
This is a convenience which creates an instance of the CheckDNSAvailabilityRequest.Builder avoiding the
need to create one manually via CheckDNSAvailabilityRequest.builder()
checkDNSAvailabilityRequest - A Consumer that will call methods on CheckDNSAvailabilityMessage.Builder to create a
request. Results message indicating whether a CNAME is available.SdkException - 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 type.AwsServiceExceptiondefault ComposeEnvironmentsResponse composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault ComposeEnvironmentsResponse composeEnvironments(Consumer<ComposeEnvironmentsRequest.Builder> composeEnvironmentsRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, 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.
This is a convenience which creates an instance of the ComposeEnvironmentsRequest.Builder avoiding the
need to create one manually via ComposeEnvironmentsRequest.builder()
composeEnvironmentsRequest - A Consumer that will call methods on ComposeEnvironmentsMessage.Builder to create a
request. 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.SdkException - 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 type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws TooManyApplicationsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws TooManyApplicationsException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Creates an application that has one configuration template named default and no application
versions.
This is a convenience which creates an instance of the CreateApplicationRequest.Builder avoiding the need
to create one manually via CreateApplicationRequest.builder()
createApplicationRequest - A Consumer that will call methods on CreateApplicationMessage.Builder to create a request.
Request to create an application.TooManyApplicationsException - The specified account has reached its limit of applications.SdkException - 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 type.AwsServiceExceptiondefault CreateApplicationVersionResponse createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) throws TooManyApplicationsException, TooManyApplicationVersionsException, InsufficientPrivilegesException, S3LocationNotInServiceRegionException, CodeBuildNotInServiceRegionException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreateApplicationVersionResponse createApplicationVersion(Consumer<CreateApplicationVersionRequest.Builder> createApplicationVersionRequest) throws TooManyApplicationsException, TooManyApplicationVersionsException, InsufficientPrivilegesException, S3LocationNotInServiceRegionException, CodeBuildNotInServiceRegionException, AwsServiceException, 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.
This is a convenience which creates an instance of the CreateApplicationVersionRequest.Builder avoiding
the need to create one manually via CreateApplicationVersionRequest.builder()
createApplicationVersionRequest - A Consumer that will call methods on CreateApplicationVersionMessage.Builder to create a
request.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.SdkException - 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 type.AwsServiceExceptiondefault CreateConfigurationTemplateResponse createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, TooManyConfigurationTemplatesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreateConfigurationTemplateResponse createConfigurationTemplate(Consumer<CreateConfigurationTemplateRequest.Builder> createConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, TooManyConfigurationTemplatesException, AwsServiceException, 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
This is a convenience which creates an instance of the CreateConfigurationTemplateRequest.Builder
avoiding the need to create one manually via CreateConfigurationTemplateRequest.builder()
createConfigurationTemplateRequest - A Consumer that will call methods on CreateConfigurationTemplateMessage.Builder to create
a request. 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.SdkException - 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 type.AwsServiceExceptiondefault CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Launches an environment for the specified application using the specified configuration.
This is a convenience which creates an instance of the CreateEnvironmentRequest.Builder avoiding the need
to create one manually via CreateEnvironmentRequest.builder()
createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentMessage.Builder to create a request.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.SdkException - 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 type.AwsServiceExceptiondefault CreatePlatformVersionResponse createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, TooManyPlatformsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreatePlatformVersionResponse createPlatformVersion(Consumer<CreatePlatformVersionRequest.Builder> createPlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, TooManyPlatformsException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Create a new version of your custom platform.
This is a convenience which creates an instance of the CreatePlatformVersionRequest.Builder avoiding the
need to create one manually via CreatePlatformVersionRequest.builder()
createPlatformVersionRequest - A Consumer that will call methods on CreatePlatformVersionRequest.Builder to create a
request. 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.SdkException - 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 type.AwsServiceExceptiondefault CreateStorageLocationResponse createStorageLocation() throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
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.SdkException - 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 type.AwsServiceExceptioncreateStorageLocation(CreateStorageLocationRequest),
AWS API Documentationdefault CreateStorageLocationResponse createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault CreateStorageLocationResponse createStorageLocation(Consumer<CreateStorageLocationRequest.Builder> createStorageLocationRequest) throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
This is a convenience which creates an instance of the CreateStorageLocationRequest.Builder avoiding the
need to create one manually via CreateStorageLocationRequest.builder()
createStorageLocationRequest - A Consumer that will call methods on CreateStorageLocationRequest.Builder to create a
request.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.SdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws OperationInProgressException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws OperationInProgressException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need
to create one manually via DeleteApplicationRequest.builder()
deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationMessage.Builder to create a request.
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.SdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationVersionResponse deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) throws SourceBundleDeletionException, InsufficientPrivilegesException, OperationInProgressException, S3LocationNotInServiceRegionException, AwsServiceException, 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
SdkException - 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 type.AwsServiceExceptiondefault DeleteApplicationVersionResponse deleteApplicationVersion(Consumer<DeleteApplicationVersionRequest.Builder> deleteApplicationVersionRequest) throws SourceBundleDeletionException, InsufficientPrivilegesException, OperationInProgressException, S3LocationNotInServiceRegionException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
This is a convenience which creates an instance of the DeleteApplicationVersionRequest.Builder avoiding
the need to create one manually via DeleteApplicationVersionRequest.builder()
deleteApplicationVersionRequest - A Consumer that will call methods on DeleteApplicationVersionMessage.Builder to create a
request. 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
SdkException - 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 type.AwsServiceExceptiondefault DeleteConfigurationTemplateResponse deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) throws OperationInProgressException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DeleteConfigurationTemplateResponse deleteConfigurationTemplate(Consumer<DeleteConfigurationTemplateRequest.Builder> deleteConfigurationTemplateRequest) throws OperationInProgressException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteConfigurationTemplateRequest.Builder
avoiding the need to create one manually via DeleteConfigurationTemplateRequest.builder()
deleteConfigurationTemplateRequest - A Consumer that will call methods on DeleteConfigurationTemplateMessage.Builder to create
a request. 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.SdkException - 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 type.AwsServiceExceptiondefault DeleteEnvironmentConfigurationResponse deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) throws AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DeleteEnvironmentConfigurationResponse deleteEnvironmentConfiguration(Consumer<DeleteEnvironmentConfigurationRequest.Builder> deleteEnvironmentConfigurationRequest) throws AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteEnvironmentConfigurationRequest.Builder
avoiding the need to create one manually via DeleteEnvironmentConfigurationRequest.builder()
deleteEnvironmentConfigurationRequest - A Consumer that will call methods on DeleteEnvironmentConfigurationMessage.Builder to
create a request. Request to delete a draft environment configuration.SdkException - 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 type.AwsServiceExceptiondefault DeletePlatformVersionResponse deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest) throws OperationInProgressException, InsufficientPrivilegesException, ElasticBeanstalkServiceException, PlatformVersionStillReferencedException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DeletePlatformVersionResponse deletePlatformVersion(Consumer<DeletePlatformVersionRequest.Builder> deletePlatformVersionRequest) throws OperationInProgressException, InsufficientPrivilegesException, ElasticBeanstalkServiceException, PlatformVersionStillReferencedException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Deletes the specified version of a custom platform.
This is a convenience which creates an instance of the DeletePlatformVersionRequest.Builder avoiding the
need to create one manually via DeletePlatformVersionRequest.builder()
deletePlatformVersionRequest - A Consumer that will call methods on DeletePlatformVersionRequest.Builder to create a
request.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.SdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationVersionsResponse describeApplicationVersions() throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrieve a list of application versions.
SdkException - 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 type.AwsServiceExceptiondescribeApplicationVersions(DescribeApplicationVersionsRequest),
AWS API Documentationdefault DescribeApplicationVersionsResponse describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrieve a list of application versions.
describeApplicationVersionsRequest - Request to describe application versions.SdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationVersionsResponse describeApplicationVersions(Consumer<DescribeApplicationVersionsRequest.Builder> describeApplicationVersionsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrieve a list of application versions.
This is a convenience which creates an instance of the DescribeApplicationVersionsRequest.Builder
avoiding the need to create one manually via DescribeApplicationVersionsRequest.builder()
describeApplicationVersionsRequest - A Consumer that will call methods on DescribeApplicationVersionsMessage.Builder to create
a request. Request to describe application versions.SdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationsResponse describeApplications() throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns the descriptions of existing applications.
SdkException - 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 type.AwsServiceExceptiondescribeApplications(DescribeApplicationsRequest),
AWS API Documentationdefault DescribeApplicationsResponse describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns the descriptions of existing applications.
describeApplicationsRequest - Request to describe one or more applications.SdkException - 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 type.AwsServiceExceptiondefault DescribeApplicationsResponse describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns the descriptions of existing applications.
This is a convenience which creates an instance of the DescribeApplicationsRequest.Builder avoiding the
need to create one manually via DescribeApplicationsRequest.builder()
describeApplicationsRequest - A Consumer that will call methods on DescribeApplicationsMessage.Builder to create a
request. Request to describe one or more applications.SdkException - 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 type.AwsServiceExceptiondefault DescribeConfigurationOptionsResponse describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) throws TooManyBucketsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeConfigurationOptionsResponse describeConfigurationOptions(Consumer<DescribeConfigurationOptionsRequest.Builder> describeConfigurationOptionsRequest) throws TooManyBucketsException, AwsServiceException, 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.
This is a convenience which creates an instance of the DescribeConfigurationOptionsRequest.Builder
avoiding the need to create one manually via DescribeConfigurationOptionsRequest.builder()
describeConfigurationOptionsRequest - A Consumer that will call methods on DescribeConfigurationOptionsMessage.Builder to create
a request. Result message containing a list of application version descriptions.TooManyBucketsException - The specified account has reached its limit of Amazon S3 buckets.SdkException - 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 type.AwsServiceExceptiondefault DescribeConfigurationSettingsResponse describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) throws TooManyBucketsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeConfigurationSettingsResponse describeConfigurationSettings(Consumer<DescribeConfigurationSettingsRequest.Builder> describeConfigurationSettingsRequest) throws TooManyBucketsException, AwsServiceException, 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
This is a convenience which creates an instance of the DescribeConfigurationSettingsRequest.Builder
avoiding the need to create one manually via DescribeConfigurationSettingsRequest.builder()
describeConfigurationSettingsRequest - A Consumer that will call methods on DescribeConfigurationSettingsMessage.Builder to
create a request. 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentHealthResponse describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentHealthResponse describeEnvironmentHealth(Consumer<DescribeEnvironmentHealthRequest.Builder> describeEnvironmentHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
This is a convenience which creates an instance of the DescribeEnvironmentHealthRequest.Builder avoiding
the need to create one manually via DescribeEnvironmentHealthRequest.builder()
describeEnvironmentHealthRequest - A Consumer that will call methods on DescribeEnvironmentHealthRequest.Builder to create a
request. 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentManagedActionHistoryResponse describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentManagedActionHistoryResponse describeEnvironmentManagedActionHistory(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Lists an environment's completed and failed managed actions.
This is a convenience which creates an instance of the
DescribeEnvironmentManagedActionHistoryRequest.Builder avoiding the need to create one manually via
DescribeEnvironmentManagedActionHistoryRequest.builder()
describeEnvironmentManagedActionHistoryRequest - A Consumer that will call methods on
DescribeEnvironmentManagedActionHistoryRequest.Builder to create a request. Request to list
completed and failed managed actions.ElasticBeanstalkServiceException - A generic service exception has occurred.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentManagedActionsResponse describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) throws ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentManagedActionsResponse describeEnvironmentManagedActions(Consumer<DescribeEnvironmentManagedActionsRequest.Builder> describeEnvironmentManagedActionsRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Lists an environment's upcoming and in-progress managed actions.
This is a convenience which creates an instance of the DescribeEnvironmentManagedActionsRequest.Builder
avoiding the need to create one manually via DescribeEnvironmentManagedActionsRequest.builder()
describeEnvironmentManagedActionsRequest - A Consumer that will call methods on DescribeEnvironmentManagedActionsRequest.Builder to
create a request. Request to list an environment's upcoming and in-progress managed actions.ElasticBeanstalkServiceException - A generic service exception has occurred.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentResourcesResponse describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) throws InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentResourcesResponse describeEnvironmentResources(Consumer<DescribeEnvironmentResourcesRequest.Builder> describeEnvironmentResourcesRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns AWS resources for this environment.
This is a convenience which creates an instance of the DescribeEnvironmentResourcesRequest.Builder
avoiding the need to create one manually via DescribeEnvironmentResourcesRequest.builder()
describeEnvironmentResourcesRequest - A Consumer that will call methods on DescribeEnvironmentResourcesMessage.Builder to create
a request. Request to describe the resources in an environment.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentsResponse describeEnvironments() throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns descriptions for existing environments.
SdkException - 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 type.AwsServiceExceptiondescribeEnvironments(DescribeEnvironmentsRequest),
AWS API Documentationdefault DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns descriptions for existing environments.
describeEnvironmentsRequest - Request to describe one or more environments.SdkException - 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 type.AwsServiceExceptiondefault DescribeEnvironmentsResponse describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns descriptions for existing environments.
This is a convenience which creates an instance of the DescribeEnvironmentsRequest.Builder avoiding the
need to create one manually via DescribeEnvironmentsRequest.builder()
describeEnvironmentsRequest - A Consumer that will call methods on DescribeEnvironmentsMessage.Builder to create a
request. Request to describe one or more environments.SdkException - 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 type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents() throws AwsServiceException, 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.
SdkException - 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 type.AwsServiceExceptiondescribeEvents(DescribeEventsRequest),
AWS API Documentationdefault DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, 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.
This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to
create one manually via DescribeEventsRequest.builder()
describeEventsRequest - A Consumer that will call methods on DescribeEventsMessage.Builder to create a request.
Request to retrieve a list of events for an environment.SdkException - 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 type.AwsServiceExceptiondefault DescribeInstancesHealthResponse describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribeInstancesHealthResponse describeInstancesHealth(Consumer<DescribeInstancesHealthRequest.Builder> describeInstancesHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrives detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.
This is a convenience which creates an instance of the DescribeInstancesHealthRequest.Builder avoiding
the need to create one manually via DescribeInstancesHealthRequest.builder()
describeInstancesHealthRequest - A Consumer that will call methods on DescribeInstancesHealthRequest.Builder to create a
request. 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.SdkException - 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 type.AwsServiceExceptiondefault DescribePlatformVersionResponse describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault DescribePlatformVersionResponse describePlatformVersion(Consumer<DescribePlatformVersionRequest.Builder> describePlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Describes the version of the platform.
This is a convenience which creates an instance of the DescribePlatformVersionRequest.Builder avoiding
the need to create one manually via DescribePlatformVersionRequest.builder()
describePlatformVersionRequest - A Consumer that will call methods on DescribePlatformVersionRequest.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.ElasticBeanstalkServiceException - A generic service exception has occurred.SdkException - 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 type.AwsServiceExceptiondefault ListAvailableSolutionStacksResponse listAvailableSolutionStacks() throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
SdkException - 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 type.AwsServiceExceptionlistAvailableSolutionStacks(ListAvailableSolutionStacksRequest),
AWS API Documentationdefault ListAvailableSolutionStacksResponse listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
listAvailableSolutionStacksRequest - SdkException - 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 type.AwsServiceExceptiondefault ListAvailableSolutionStacksResponse listAvailableSolutionStacks(Consumer<ListAvailableSolutionStacksRequest.Builder> listAvailableSolutionStacksRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
This is a convenience which creates an instance of the ListAvailableSolutionStacksRequest.Builder
avoiding the need to create one manually via ListAvailableSolutionStacksRequest.builder()
listAvailableSolutionStacksRequest - A Consumer that will call methods on ListAvailableSolutionStacksRequest.Builder to create
a request.SdkException - 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 type.AwsServiceExceptiondefault ListPlatformVersionsResponse listPlatformVersions() throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Lists the available platforms.
InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.ElasticBeanstalkServiceException - A generic service exception has occurred.SdkException - 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 type.AwsServiceExceptionlistPlatformVersions(ListPlatformVersionsRequest),
AWS API Documentationdefault ListPlatformVersionsResponse listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault ListPlatformVersionsResponse listPlatformVersions(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Lists the available platforms.
This is a convenience which creates an instance of the ListPlatformVersionsRequest.Builder avoiding the
need to create one manually via ListPlatformVersionsRequest.builder()
listPlatformVersionsRequest - A Consumer that will call methods on ListPlatformVersionsRequest.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.ElasticBeanstalkServiceException - A generic service exception has occurred.SdkException - 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 type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InsufficientPrivilegesException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.
listTagsForResourceRequest - InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.SdkException - 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 type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InsufficientPrivilegesException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Returns the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.
Currently, Elastic Beanstalk only supports tagging Elastic Beanstalk environments.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceMessage.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.SdkException - 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 type.AwsServiceExceptiondefault RebuildEnvironmentResponse rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault RebuildEnvironmentResponse rebuildEnvironment(Consumer<RebuildEnvironmentRequest.Builder> rebuildEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, 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.
This is a convenience which creates an instance of the RebuildEnvironmentRequest.Builder avoiding the
need to create one manually via RebuildEnvironmentRequest.builder()
rebuildEnvironmentRequest - A Consumer that will call methods on RebuildEnvironmentMessage.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault RequestEnvironmentInfoResponse requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) throws AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault RequestEnvironmentInfoResponse requestEnvironmentInfo(Consumer<RequestEnvironmentInfoRequest.Builder> requestEnvironmentInfoRequest) throws AwsServiceException, 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
This is a convenience which creates an instance of the RequestEnvironmentInfoRequest.Builder avoiding the
need to create one manually via RequestEnvironmentInfoRequest.builder()
requestEnvironmentInfoRequest - A Consumer that will call methods on RequestEnvironmentInfoMessage.Builder to create a
request. Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage
bucket.SdkException - 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 type.AwsServiceExceptiondefault RestartAppServerResponse restartAppServer(RestartAppServerRequest restartAppServerRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Causes the environment to restart the application container server running on each Amazon EC2 instance.
restartAppServerRequest - SdkException - 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 type.AwsServiceExceptiondefault RestartAppServerResponse restartAppServer(Consumer<RestartAppServerRequest.Builder> restartAppServerRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Causes the environment to restart the application container server running on each Amazon EC2 instance.
This is a convenience which creates an instance of the RestartAppServerRequest.Builder avoiding the need
to create one manually via RestartAppServerRequest.builder()
restartAppServerRequest - A Consumer that will call methods on RestartAppServerMessage.Builder to create a request.SdkException - 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 type.AwsServiceExceptiondefault RetrieveEnvironmentInfoResponse retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
retrieveEnvironmentInfoRequest - Request to download logs retrieved with RequestEnvironmentInfo.SdkException - 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 type.AwsServiceExceptiondefault RetrieveEnvironmentInfoResponse retrieveEnvironmentInfo(Consumer<RetrieveEnvironmentInfoRequest.Builder> retrieveEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
This is a convenience which creates an instance of the RetrieveEnvironmentInfoRequest.Builder avoiding
the need to create one manually via RetrieveEnvironmentInfoRequest.builder()
retrieveEnvironmentInfoRequest - A Consumer that will call methods on RetrieveEnvironmentInfoMessage.Builder to create a
request. Request to download logs retrieved with RequestEnvironmentInfo.SdkException - 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 type.AwsServiceExceptiondefault SwapEnvironmentCNAMEsResponse swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Swaps the CNAMEs of two environments.
swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.SdkException - 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 type.AwsServiceExceptiondefault SwapEnvironmentCNAMEsResponse swapEnvironmentCNAMEs(Consumer<SwapEnvironmentCNAMEsRequest.Builder> swapEnvironmentCNAMEsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException
Swaps the CNAMEs of two environments.
This is a convenience which creates an instance of the SwapEnvironmentCNAMEsRequest.Builder avoiding the
need to create one manually via SwapEnvironmentCNAMEsRequest.builder()
swapEnvironmentCNAMEsRequest - A Consumer that will call methods on SwapEnvironmentCNAMEsMessage.Builder to create a
request. Swaps the CNAMEs of two environments.SdkException - 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 type.AwsServiceExceptiondefault TerminateEnvironmentResponse terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault TerminateEnvironmentResponse terminateEnvironment(Consumer<TerminateEnvironmentRequest.Builder> terminateEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Terminates the specified environment.
This is a convenience which creates an instance of the TerminateEnvironmentRequest.Builder avoiding the
need to create one manually via TerminateEnvironmentRequest.builder()
terminateEnvironmentRequest - A Consumer that will call methods on TerminateEnvironmentMessage.Builder to create a
request. Request to terminate an environment.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws AwsServiceException, 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.
This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need
to create one manually via UpdateApplicationRequest.builder()
updateApplicationRequest - A Consumer that will call methods on UpdateApplicationMessage.Builder to create a request.
Request to update an application.SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResourceLifecycleResponse updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Modifies lifecycle settings for an application.
updateApplicationResourceLifecycleRequest - InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationResourceLifecycleResponse updateApplicationResourceLifecycle(Consumer<UpdateApplicationResourceLifecycleRequest.Builder> updateApplicationResourceLifecycleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Modifies lifecycle settings for an application.
This is a convenience which creates an instance of the UpdateApplicationResourceLifecycleRequest.Builder
avoiding the need to create one manually via UpdateApplicationResourceLifecycleRequest.builder()
updateApplicationResourceLifecycleRequest - A Consumer that will call methods on UpdateApplicationResourceLifecycleMessage.Builder to
create a request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationVersionResponse updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) throws AwsServiceException, 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 - SdkException - 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 type.AwsServiceExceptiondefault UpdateApplicationVersionResponse updateApplicationVersion(Consumer<UpdateApplicationVersionRequest.Builder> updateApplicationVersionRequest) throws AwsServiceException, 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.
This is a convenience which creates an instance of the UpdateApplicationVersionRequest.Builder avoiding
the need to create one manually via UpdateApplicationVersionRequest.builder()
updateApplicationVersionRequest - A Consumer that will call methods on UpdateApplicationVersionMessage.Builder to create a
request.SdkException - 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 type.AwsServiceExceptiondefault UpdateConfigurationTemplateResponse updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault UpdateConfigurationTemplateResponse updateConfigurationTemplate(Consumer<UpdateConfigurationTemplateRequest.Builder> updateConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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
This is a convenience which creates an instance of the UpdateConfigurationTemplateRequest.Builder
avoiding the need to create one manually via UpdateConfigurationTemplateRequest.builder()
updateConfigurationTemplateRequest - A Consumer that will call methods on UpdateConfigurationTemplateMessage.Builder to create
a request. 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.SdkException - 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 type.AwsServiceExceptiondefault UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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.
This is a convenience which creates an instance of the UpdateEnvironmentRequest.Builder avoiding the need
to create one manually via UpdateEnvironmentRequest.builder()
updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentMessage.Builder to create a request.
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.SdkException - 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 type.AwsServiceExceptiondefault UpdateTagsForResourceResponse updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest) throws InsufficientPrivilegesException, OperationInProgressException, TooManyTagsException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed:
TagsToAdd for tags to add or update, and TagsToRemove.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.
updateTagsForResourceRequest - InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.TooManyTagsException - The number of tags in the resource would exceed the number of tags that each resource can have.
To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.SdkException - 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 type.AwsServiceExceptiondefault UpdateTagsForResourceResponse updateTagsForResource(Consumer<UpdateTagsForResourceRequest.Builder> updateTagsForResourceRequest) throws InsufficientPrivilegesException, OperationInProgressException, TooManyTagsException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException
Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed:
TagsToAdd for tags to add or update, and TagsToRemove.
Currently, Elastic Beanstalk only supports tagging of Elastic Beanstalk environments.
This is a convenience which creates an instance of the UpdateTagsForResourceRequest.Builder avoiding the
need to create one manually via UpdateTagsForResourceRequest.builder()
updateTagsForResourceRequest - A Consumer that will call methods on UpdateTagsForResourceMessage.Builder to create a
request.InsufficientPrivilegesException - The specified account does not have sufficient privileges for one of more AWS services.OperationInProgressException - Unable to perform the specified operation because another operation that effects an element in this
activity is already in progress.TooManyTagsException - The number of tags in the resource would exceed the number of tags that each resource can have.
To calculate this, the operation considers both the number of tags the resource already has and the tags this operation would add if it succeeded.
ResourceNotFoundException - A resource doesn't exist for the specified Amazon Resource Name (ARN).ResourceTypeNotSupportedException - The type of the specified Amazon Resource Name (ARN) isn't supported for this operation.SdkException - 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 type.AwsServiceExceptiondefault ValidateConfigurationSettingsResponse validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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.SdkException - 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 type.AwsServiceExceptiondefault ValidateConfigurationSettingsResponse validateConfigurationSettings(Consumer<ValidateConfigurationSettingsRequest.Builder> validateConfigurationSettingsRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, 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.
This is a convenience which creates an instance of the ValidateConfigurationSettingsRequest.Builder
avoiding the need to create one manually via ValidateConfigurationSettingsRequest.builder()
validateConfigurationSettingsRequest - A Consumer that will call methods on ValidateConfigurationSettingsMessage.Builder to
create a request. 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.SdkException - 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 type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.