Class AWSElasticBeanstalkClient
- All Implemented Interfaces:
AWSElasticBeanstalk
- Direct Known Subclasses:
AWSElasticBeanstalkAsyncClient
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is http://elasticbeanstalk.s3.amazonaws.com/doc/2010-12-01/AWSElasticBeanstalk. wsdl. To install the Software Development Kits (SDKs), Integrated Development Environment (IDE) Toolkits, and command line tools that enable you to access the API, go to Tools for Amazon Web Services.
Endpoints
For a list of region-specific endpoints that AWS Elastic Beanstalk supports, go to Regions and Endpoints in the Amazon Web Services Glossary.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final ClientConfigurationFactory
Client configuration factory providing ClientConfigurations tailored to this clientprotected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,
Node>> List of exception unmarshallers for all modeled exceptionsFields inherited from class com.amazonaws.AmazonWebServiceClient
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs a new client to invoke service methods on Elastic Beanstalk.AWSElasticBeanstalkClient
(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials.AWSElasticBeanstalkClient
(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider.AWSElasticBeanstalkClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider and client configuration options.AWSElasticBeanstalkClient
(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider, client configuration options, and request metric collector.AWSElasticBeanstalkClient
(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials and client configuration options.AWSElasticBeanstalkClient
(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Beanstalk. -
Method Summary
Modifier and TypeMethodDescriptionSimplified method form for invoking the AbortEnvironmentUpdate operation.abortEnvironmentUpdate
(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.applyEnvironmentManagedAction
(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) Applies a scheduled managed action immediately.checkDNSAvailability
(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) Checks if the specified CNAME is available.composeEnvironments
(ComposeEnvironmentsRequest composeEnvironmentsRequest) Create or update a group of environments that each run a separate component of a single application.createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application that has one configuration template nameddefault
and no application versions.createApplicationVersion
(CreateApplicationVersionRequest createApplicationVersionRequest) Creates an application version for the specified application.createConfigurationTemplate
(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) Creates a configuration template.createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Launches an environment for the specified application using the specified configuration.Simplified method form for invoking the CreateStorageLocation operation.createStorageLocation
(CreateStorageLocationRequest createStorageLocationRequest) Creates the Amazon S3 storage location for the account.deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes the specified application along with all associated versions and configurations.deleteApplicationVersion
(DeleteApplicationVersionRequest deleteApplicationVersionRequest) Deletes the specified version from the specified application.deleteConfigurationTemplate
(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) Deletes the specified configuration template.deleteEnvironmentConfiguration
(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) Deletes the draft configuration associated with the running environment.Simplified method form for invoking the DescribeApplications operation.describeApplications
(DescribeApplicationsRequest describeApplicationsRequest) Returns the descriptions of existing applications.Simplified method form for invoking the DescribeApplicationVersions operation.describeApplicationVersions
(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.describeConfigurationOptions
(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.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.describeEnvironmentHealth
(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) Returns information about the overall health of the specified environment.describeEnvironmentManagedActionHistory
(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.describeEnvironmentManagedActions
(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) Lists an environment's upcoming and in-progress managed actions.describeEnvironmentResources
(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) Returns AWS resources for this environment.Simplified method form for invoking the DescribeEnvironments operation.describeEnvironments
(DescribeEnvironmentsRequest describeEnvironmentsRequest) Returns descriptions for existing environments.Simplified method form for invoking the DescribeEvents operation.describeEvents
(DescribeEventsRequest describeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks.describeInstancesHealth
(DescribeInstancesHealthRequest describeInstancesHealthRequest) Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes).Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.Simplified method form for invoking the ListAvailableSolutionStacks operation.listAvailableSolutionStacks
(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) Returns a list of the available solution stack names.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.requestEnvironmentInfo
(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) Initiates a request to compile the specified type of information of the deployed environment.restartAppServer
(RestartAppServerRequest restartAppServerRequest) Causes the environment to restart the application container server running on each Amazon EC2 instance.retrieveEnvironmentInfo
(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) Retrieves the compiled information from a RequestEnvironmentInfo request.Simplified method form for invoking the SwapEnvironmentCNAMEs operation.swapEnvironmentCNAMEs
(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) Swaps the CNAMEs of two environments.terminateEnvironment
(TerminateEnvironmentRequest terminateEnvironmentRequest) Terminates the specified environment.updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates the specified application to have the specified properties.updateApplicationVersion
(UpdateApplicationVersionRequest updateApplicationVersionRequest) Updates the specified application version to have the specified properties.updateConfigurationTemplate
(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) Updates the specified configuration template to have the specified properties or configuration option values.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.validateConfigurationSettings
(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeMarshalling, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.amazonaws.services.elasticbeanstalk.AWSElasticBeanstalk
setEndpoint, setRegion, shutdown
-
Field Details
-
configFactory
Client configuration factory providing ClientConfigurations tailored to this client -
exceptionUnmarshallers
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallersList of exception unmarshallers for all modeled exceptions
-
-
Constructor Details
-
AWSElasticBeanstalkClient
public AWSElasticBeanstalkClient()Constructs a new client to invoke service methods on Elastic Beanstalk. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- See Also:
-
AWSElasticBeanstalkClient
Constructs a new client to invoke service methods on Elastic Beanstalk. A credentials provider chain will be used that searches for credentials in this order:- Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
- Java System Properties - aws.accessKeyId and aws.secretKey
- Instance profile credentials delivered through the Amazon EC2 metadata service
All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
clientConfiguration
- The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).- See Also:
-
AWSElasticBeanstalkClient
Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
-
AWSElasticBeanstalkClient
public AWSElasticBeanstalkClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
-
AWSElasticBeanstalkClient
Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
-
AWSElasticBeanstalkClient
public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider and client configuration options.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).
-
AWSElasticBeanstalkClient
public AWSElasticBeanstalkClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on Elastic Beanstalk using the specified AWS account credentials provider, client configuration options, and request metric collector.All service calls made using this new client object are blocking, and will not return until the service call completes.
- Parameters:
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to Elastic Beanstalk (ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collector
-
-
Method Details
-
abortEnvironmentUpdate
public AbortEnvironmentUpdateResult abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.
- Specified by:
abortEnvironmentUpdate
in interfaceAWSElasticBeanstalk
- Parameters:
abortEnvironmentUpdateRequest
-- Returns:
- Result of the AbortEnvironmentUpdate operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
abortEnvironmentUpdate
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the AbortEnvironmentUpdate operation.- Specified by:
abortEnvironmentUpdate
in interfaceAWSElasticBeanstalk
- See Also:
-
applyEnvironmentManagedAction
public ApplyEnvironmentManagedActionResult applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) Applies a scheduled managed action immediately. A managed action can be applied only if its status is
Scheduled
. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.- Specified by:
applyEnvironmentManagedAction
in interfaceAWSElasticBeanstalk
- Parameters:
applyEnvironmentManagedActionRequest
- Request to execute a scheduled managed action immediately.- Returns:
- Result of the ApplyEnvironmentManagedAction operation returned by the service.
- Throws:
ElasticBeanstalkServiceException
- A generic service exception has occurred.ManagedActionInvalidStateException
- Cannot modify the managed action in its current state.
-
checkDNSAvailability
public CheckDNSAvailabilityResult checkDNSAvailability(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest) Checks if the specified CNAME is available.
- Specified by:
checkDNSAvailability
in interfaceAWSElasticBeanstalk
- Parameters:
checkDNSAvailabilityRequest
- Results message indicating whether a CNAME is available.- Returns:
- Result of the CheckDNSAvailability operation returned by the service.
-
composeEnvironments
public ComposeEnvironmentsResult composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest) Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named
env.yaml
. See Compose Environments for details.- Specified by:
composeEnvironments
in interfaceAWSElasticBeanstalk
- Parameters:
composeEnvironmentsRequest
- Request to create or update a group of environments.- Returns:
- Result of the ComposeEnvironments operation returned by the service.
- Throws:
TooManyEnvironmentsException
- The specified account has reached its limit of environments.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
createApplication
Creates an application that has one configuration template named
default
and no application versions.- Specified by:
createApplication
in interfaceAWSElasticBeanstalk
- Parameters:
createApplicationRequest
- Request to create an application.- Returns:
- Result of the CreateApplication operation returned by the service.
- Throws:
TooManyApplicationsException
- The specified account has reached its limit of applications.
-
createApplicationVersion
public CreateApplicationVersionResult createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) Creates an application version for the specified application.
Once you create an application version with a specified Amazon S3 bucket and key location, you cannot change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version. - Specified by:
createApplicationVersion
in interfaceAWSElasticBeanstalk
- Parameters:
createApplicationVersionRequest
-- Returns:
- Result of the CreateApplicationVersion operation returned by the service.
- Throws:
TooManyApplicationsException
- The specified account has reached its limit of applications.TooManyApplicationVersionsException
- The specified account has reached its limit of application versions.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.S3LocationNotInServiceRegionException
- The specified S3 bucket does not belong to the S3 region in which the service is running.
-
createConfigurationTemplate
public CreateConfigurationTemplateResult createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) Creates a configuration template. Templates are associated with a specific application and are used to deploy different versions of the application with the same configuration settings.
Related Topics
- Specified by:
createConfigurationTemplate
in interfaceAWSElasticBeanstalk
- Parameters:
createConfigurationTemplateRequest
- Request to create a configuration template.- Returns:
- Result of the CreateConfigurationTemplate operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.TooManyConfigurationTemplatesException
- The specified account has reached its limit of configuration templates.
-
createEnvironment
Launches an environment for the specified application using the specified configuration.
- Specified by:
createEnvironment
in interfaceAWSElasticBeanstalk
- Parameters:
createEnvironmentRequest
-- Returns:
- Result of the CreateEnvironment operation returned by the service.
- Throws:
TooManyEnvironmentsException
- The specified account has reached its limit of environments.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
createStorageLocation
public CreateStorageLocationResult createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) Creates the Amazon S3 storage location for the account.
This location is used to store user log files.
- Specified by:
createStorageLocation
in interfaceAWSElasticBeanstalk
- Parameters:
createStorageLocationRequest
-- Returns:
- Result of the CreateStorageLocation operation returned by the service.
- Throws:
TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.S3SubscriptionRequiredException
- The specified account does not have a subscription to Amazon S3.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
createStorageLocation
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the CreateStorageLocation operation.- Specified by:
createStorageLocation
in interfaceAWSElasticBeanstalk
- See Also:
-
deleteApplication
Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment. - Specified by:
deleteApplication
in interfaceAWSElasticBeanstalk
- Parameters:
deleteApplicationRequest
- Request to delete an application.- Returns:
- Result of the DeleteApplication operation returned by the service.
- Throws:
OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
-
deleteApplicationVersion
public DeleteApplicationVersionResult deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment. - Specified by:
deleteApplicationVersion
in interfaceAWSElasticBeanstalk
- Parameters:
deleteApplicationVersionRequest
- Request to delete an application version.- Returns:
- Result of the DeleteApplicationVersion operation returned by the service.
- Throws:
SourceBundleDeletionException
- Unable to delete the Amazon S3 source bundle associated with the application version. The application version was deleted successfully.InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.S3LocationNotInServiceRegionException
- The specified S3 bucket does not belong to the S3 region in which the service is running.
-
deleteConfigurationTemplate
public DeleteConfigurationTemplateResult deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) Deletes the specified configuration template.
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment. - Specified by:
deleteConfigurationTemplate
in interfaceAWSElasticBeanstalk
- Parameters:
deleteConfigurationTemplateRequest
- Request to delete a configuration template.- Returns:
- Result of the DeleteConfigurationTemplate operation returned by the service.
- Throws:
OperationInProgressException
- Unable to perform the specified operation because another operation that effects an element in this activity is already in progress.
-
deleteEnvironmentConfiguration
public DeleteEnvironmentConfigurationResult deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The
DeploymentStatus
for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.- Specified by:
deleteEnvironmentConfiguration
in interfaceAWSElasticBeanstalk
- Parameters:
deleteEnvironmentConfigurationRequest
- Request to delete a draft environment configuration.- Returns:
- Result of the DeleteEnvironmentConfiguration operation returned by the service.
-
describeApplicationVersions
public DescribeApplicationVersionsResult describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.
- Specified by:
describeApplicationVersions
in interfaceAWSElasticBeanstalk
- Parameters:
describeApplicationVersionsRequest
- Result message containing a list of configuration descriptions.- Returns:
- Result of the DescribeApplicationVersions operation returned by the service.
-
describeApplicationVersions
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the DescribeApplicationVersions operation.- Specified by:
describeApplicationVersions
in interfaceAWSElasticBeanstalk
- See Also:
-
describeApplications
public DescribeApplicationsResult describeApplications(DescribeApplicationsRequest describeApplicationsRequest) Returns the descriptions of existing applications.
- Specified by:
describeApplications
in interfaceAWSElasticBeanstalk
- Parameters:
describeApplicationsRequest
- Request to describe one or more applications.- Returns:
- Result of the DescribeApplications operation returned by the service.
-
describeApplications
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the DescribeApplications operation.- Specified by:
describeApplications
in interfaceAWSElasticBeanstalk
- See Also:
-
describeConfigurationOptions
public DescribeConfigurationOptionsResult describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
- Specified by:
describeConfigurationOptions
in interfaceAWSElasticBeanstalk
- Parameters:
describeConfigurationOptionsRequest
- Result message containig a list of application version descriptions.- Returns:
- Result of the DescribeConfigurationOptions operation returned by the service.
- Throws:
TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.
-
describeConfigurationSettings
public DescribeConfigurationSettingsResult describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
- Specified by:
describeConfigurationSettings
in interfaceAWSElasticBeanstalk
- Parameters:
describeConfigurationSettingsRequest
- Result message containing all of the configuration settings for a specified solution stack or configuration template.- Returns:
- Result of the DescribeConfigurationSettings operation returned by the service.
- Throws:
TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.
-
describeEnvironmentHealth
public DescribeEnvironmentHealthResult describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
- Specified by:
describeEnvironmentHealth
in interfaceAWSElasticBeanstalk
- Parameters:
describeEnvironmentHealthRequest
- See the example below to learn how to create a request body.- Returns:
- Result of the DescribeEnvironmentHealth operation returned by the service.
- Throws:
InvalidRequestException
- One or more input parameters is not valid. Please correct the input parameters and try the operation again.ElasticBeanstalkServiceException
- A generic service exception has occurred.
-
describeEnvironmentManagedActionHistory
public DescribeEnvironmentManagedActionHistoryResult describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.
- Specified by:
describeEnvironmentManagedActionHistory
in interfaceAWSElasticBeanstalk
- Parameters:
describeEnvironmentManagedActionHistoryRequest
- Request to list completed and failed managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
- Throws:
ElasticBeanstalkServiceException
- A generic service exception has occurred.
-
describeEnvironmentManagedActions
public DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) Lists an environment's upcoming and in-progress managed actions.
- Specified by:
describeEnvironmentManagedActions
in interfaceAWSElasticBeanstalk
- Parameters:
describeEnvironmentManagedActionsRequest
- Request to list an environment's upcoming and in-progress managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActions operation returned by the service.
- Throws:
ElasticBeanstalkServiceException
- A generic service exception has occurred.
-
describeEnvironmentResources
public DescribeEnvironmentResourcesResult describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) Returns AWS resources for this environment.
- Specified by:
describeEnvironmentResources
in interfaceAWSElasticBeanstalk
- Parameters:
describeEnvironmentResourcesRequest
- Request to describe the resources in an environment.- Returns:
- Result of the DescribeEnvironmentResources operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
describeEnvironments
public DescribeEnvironmentsResult describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) Returns descriptions for existing environments.
- Specified by:
describeEnvironments
in interfaceAWSElasticBeanstalk
- Parameters:
describeEnvironmentsRequest
- Request to describe one or more environments.- Returns:
- Result of the DescribeEnvironments operation returned by the service.
-
describeEnvironments
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the DescribeEnvironments operation.- Specified by:
describeEnvironments
in interfaceAWSElasticBeanstalk
- See Also:
-
describeEvents
Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified NextToken
.- Specified by:
describeEvents
in interfaceAWSElasticBeanstalk
- Parameters:
describeEventsRequest
- Request to retrieve a list of events for an environment.- Returns:
- Result of the DescribeEvents operation returned by the service.
-
describeEvents
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the DescribeEvents operation.- Specified by:
describeEvents
in interfaceAWSElasticBeanstalk
- See Also:
-
describeInstancesHealth
public DescribeInstancesHealthResult describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest) Returns more detailed information about the health of the specified instances (for example, CPU utilization, load average, and causes). The DescribeInstancesHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
- Specified by:
describeInstancesHealth
in interfaceAWSElasticBeanstalk
- Parameters:
describeInstancesHealthRequest
- See the example below to learn how to create a request body.- Returns:
- Result of the DescribeInstancesHealth operation returned by the service.
- Throws:
InvalidRequestException
- 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.
-
listAvailableSolutionStacks
public ListAvailableSolutionStacksResult listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) Returns a list of the available solution stack names.
- Specified by:
listAvailableSolutionStacks
in interfaceAWSElasticBeanstalk
- Parameters:
listAvailableSolutionStacksRequest
-- Returns:
- Result of the ListAvailableSolutionStacks operation returned by the service.
-
listAvailableSolutionStacks
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the ListAvailableSolutionStacks operation.- Specified by:
listAvailableSolutionStacks
in interfaceAWSElasticBeanstalk
- See Also:
-
rebuildEnvironment
public RebuildEnvironmentResult rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest) Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
- Specified by:
rebuildEnvironment
in interfaceAWSElasticBeanstalk
- Parameters:
rebuildEnvironmentRequest
-- Returns:
- Result of the RebuildEnvironment operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
requestEnvironmentInfo
public RequestEnvironmentInfoResult requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) Initiates a request to compile the specified type of information of the deployed environment.
Setting the
InfoType
totail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.Setting the
InfoType
tobundle
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
- Specified by:
requestEnvironmentInfo
in interfaceAWSElasticBeanstalk
- Parameters:
requestEnvironmentInfoRequest
- Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.- Returns:
- Result of the RequestEnvironmentInfo operation returned by the service.
-
restartAppServer
Causes the environment to restart the application container server running on each Amazon EC2 instance.
- Specified by:
restartAppServer
in interfaceAWSElasticBeanstalk
- Parameters:
restartAppServerRequest
-- Returns:
- Result of the RestartAppServer operation returned by the service.
-
retrieveEnvironmentInfo
public RetrieveEnvironmentInfoResult retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
- Specified by:
retrieveEnvironmentInfo
in interfaceAWSElasticBeanstalk
- Parameters:
retrieveEnvironmentInfoRequest
- Request to download logs retrieved with RequestEnvironmentInfo.- Returns:
- Result of the RetrieveEnvironmentInfo operation returned by the service.
-
swapEnvironmentCNAMEs
public SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest) Swaps the CNAMEs of two environments.
- Specified by:
swapEnvironmentCNAMEs
in interfaceAWSElasticBeanstalk
- Parameters:
swapEnvironmentCNAMEsRequest
- Swaps the CNAMEs of two environments.- Returns:
- Result of the SwapEnvironmentCNAMEs operation returned by the service.
-
swapEnvironmentCNAMEs
Description copied from interface:AWSElasticBeanstalk
Simplified method form for invoking the SwapEnvironmentCNAMEs operation.- Specified by:
swapEnvironmentCNAMEs
in interfaceAWSElasticBeanstalk
- See Also:
-
terminateEnvironment
public TerminateEnvironmentResult terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) Terminates the specified environment.
- Specified by:
terminateEnvironment
in interfaceAWSElasticBeanstalk
- Parameters:
terminateEnvironmentRequest
- Request to terminate an environment.- Returns:
- Result of the TerminateEnvironment operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.
-
updateApplication
Updates the specified application to have the specified properties.
If a property (for example, description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.- Specified by:
updateApplication
in interfaceAWSElasticBeanstalk
- Parameters:
updateApplicationRequest
- Request to update an application.- Returns:
- Result of the UpdateApplication operation returned by the service.
-
updateApplicationVersion
public UpdateApplicationVersionResult updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) Updates the specified application version to have the specified properties.
If a property (for example, description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.- Specified by:
updateApplicationVersion
in interfaceAWSElasticBeanstalk
- Parameters:
updateApplicationVersionRequest
-- Returns:
- Result of the UpdateApplicationVersion operation returned by the service.
-
updateConfigurationTemplate
public UpdateConfigurationTemplateResult updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) Updates the specified configuration template to have the specified properties or configuration option values.
If a property (for example, ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.Related Topics
- Specified by:
updateConfigurationTemplate
in interfaceAWSElasticBeanstalk
- Parameters:
updateConfigurationTemplateRequest
- The result message containing the options for the specified solution stack.- Returns:
- Result of the UpdateConfigurationTemplate operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.
-
updateEnvironment
Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different
DeploymentStatus
values.- Specified by:
updateEnvironment
in interfaceAWSElasticBeanstalk
- Parameters:
updateEnvironmentRequest
- Request to update an environment.- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.
-
validateConfigurationSettings
public ValidateConfigurationSettingsResult validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
- Specified by:
validateConfigurationSettings
in interfaceAWSElasticBeanstalk
- Parameters:
validateConfigurationSettingsRequest
- A list of validation messages for a specified configuration template.- Returns:
- Result of the ValidateConfigurationSettings operation returned by the service.
- Throws:
InsufficientPrivilegesException
- The specified account does not have sufficient privileges for one of more AWS services.TooManyBucketsException
- The specified account has reached its limit of Amazon S3 buckets.
-
getCachedResponseMetadata
Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSElasticBeanstalk
- Parameters:
request
- The originally executed request- Returns:
- The response metadata for the specified request, or null if none is available.
-