Interface AWSElasticBeanstalk

    • Method Detail

      • setEndpoint

        void setEndpoint​(String endpoint)
        Overrides the default endpoint for this client ("https://elasticbeanstalk.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

        Callers can pass in just the endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

        For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912

        This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

        Parameters:
        endpoint - The endpoint (ex: "elasticbeanstalk.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://elasticbeanstalk.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
      • abortEnvironmentUpdate

        AbortEnvironmentUpdateResult abortEnvironmentUpdate​(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)

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

        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.
      • checkDNSAvailability

        CheckDNSAvailabilityResult checkDNSAvailability​(CheckDNSAvailabilityRequest checkDNSAvailabilityRequest)

        Checks if the specified CNAME is available.

        Parameters:
        checkDNSAvailabilityRequest - Results message indicating whether a CNAME is available.
        Returns:
        Result of the CheckDNSAvailability operation returned by the service.
      • composeEnvironments

        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.

        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

        CreateApplicationResult createApplication​(CreateApplicationRequest createApplicationRequest)

        Creates an application that has one configuration template named default and no application versions.

        Parameters:
        createApplicationRequest - Request to create an application.
        Returns:
        Result of the CreateApplication operation returned by the service.
        Throws:
        TooManyApplicationsException - The specified account has reached its limit of applications.
      • createApplicationVersion

        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.
        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.
      • createEnvironment

        CreateEnvironmentResult createEnvironment​(CreateEnvironmentRequest createEnvironmentRequest)

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

        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.
      • deleteApplication

        DeleteApplicationResult deleteApplication​(DeleteApplicationRequest deleteApplicationRequest)

        Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.

        You cannot delete an application that has a running environment.
        Parameters:
        deleteApplicationRequest - Request to delete an application.
        Returns:
        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

        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.
        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

        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.
        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

        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.

        Parameters:
        deleteEnvironmentConfigurationRequest - Request to delete a draft environment configuration.
        Returns:
        Result of the DeleteEnvironmentConfiguration operation returned by the service.
      • describeApplicationVersions

        DescribeApplicationVersionsResult describeApplicationVersions​(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)

        Retrieve a list of application versions stored in your AWS Elastic Beanstalk storage bucket.

        Parameters:
        describeApplicationVersionsRequest - Result message containing a list of configuration descriptions.
        Returns:
        Result of the DescribeApplicationVersions operation returned by the service.
      • describeApplications

        DescribeApplicationsResult describeApplications​(DescribeApplicationsRequest describeApplicationsRequest)

        Returns the descriptions of existing applications.

        Parameters:
        describeApplicationsRequest - Request to describe one or more applications.
        Returns:
        Result of the DescribeApplications operation returned by the service.
      • describeConfigurationOptions

        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.

        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

        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

        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

        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.

        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.
      • describeEnvironmentManagedActions

        DescribeEnvironmentManagedActionsResult describeEnvironmentManagedActions​(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)

        Lists an environment's upcoming and in-progress managed actions.

        Parameters:
        describeEnvironmentManagedActionsRequest - Request to list an environment's upcoming and in-progress managed actions.
        Returns:
        Result of the DescribeEnvironmentManagedActions operation returned by the service.
        Throws:
        ElasticBeanstalkServiceException - A generic service exception has occurred.
      • describeEnvironmentResources

        DescribeEnvironmentResourcesResult describeEnvironmentResources​(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)

        Returns AWS resources for this environment.

        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

        DescribeEnvironmentsResult describeEnvironments​(DescribeEnvironmentsRequest describeEnvironmentsRequest)

        Returns descriptions for existing environments.

        Parameters:
        describeEnvironmentsRequest - Request to describe one or more environments.
        Returns:
        Result of the DescribeEnvironments operation returned by the service.
      • describeEvents

        DescribeEventsResult describeEvents​(DescribeEventsRequest describeEventsRequest)

        Returns list of event descriptions matching criteria up to the last 6 weeks.

        This action returns the most recent 1,000 events from the specified NextToken.
        Parameters:
        describeEventsRequest - Request to retrieve a list of events for an environment.
        Returns:
        Result of the DescribeEvents operation returned by the service.
      • describeInstancesHealth

        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.

        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

        ListAvailableSolutionStacksResult listAvailableSolutionStacks​(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)

        Returns a list of the available solution stack names.

        Parameters:
        listAvailableSolutionStacksRequest -
        Returns:
        Result of the ListAvailableSolutionStacks operation returned by the service.
      • rebuildEnvironment

        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.

        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

        RequestEnvironmentInfoResult requestEnvironmentInfo​(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)

        Initiates a request to compile the specified type of information of the deployed environment.

        Setting the InfoType to tail compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.

        Setting the InfoType to bundle compresses the application server log files for every Amazon EC2 instance into a .zip file. Legacy and .NET containers do not support bundle logs.

        Use RetrieveEnvironmentInfo to obtain the set of logs.

        Related Topics

        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

        RestartAppServerResult restartAppServer​(RestartAppServerRequest restartAppServerRequest)

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

        Parameters:
        restartAppServerRequest -
        Returns:
        Result of the RestartAppServer operation returned by the service.
      • swapEnvironmentCNAMEs

        SwapEnvironmentCNAMEsResult swapEnvironmentCNAMEs​(SwapEnvironmentCNAMEsRequest swapEnvironmentCNAMEsRequest)

        Swaps the CNAMEs of two environments.

        Parameters:
        swapEnvironmentCNAMEsRequest - Swaps the CNAMEs of two environments.
        Returns:
        Result of the SwapEnvironmentCNAMEs operation returned by the service.
      • terminateEnvironment

        TerminateEnvironmentResult terminateEnvironment​(TerminateEnvironmentRequest terminateEnvironmentRequest)

        Terminates the specified environment.

        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

        UpdateApplicationResult updateApplication​(UpdateApplicationRequest updateApplicationRequest)

        Updates the specified application to have the specified properties.

        If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
        Parameters:
        updateApplicationRequest - Request to update an application.
        Returns:
        Result of the UpdateApplication operation returned by the service.
      • updateApplicationVersion

        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.
        Parameters:
        updateApplicationVersionRequest -
        Returns:
        Result of the UpdateApplicationVersion operation returned by the service.
      • updateConfigurationTemplate

        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

        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

        UpdateEnvironmentResult updateEnvironment​(UpdateEnvironmentRequest updateEnvironmentRequest)

        Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.

        Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an InvalidParameterCombination error.

        When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different DeploymentStatus values.

        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

        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.

        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.
      • shutdown

        void shutdown()
        Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
      • getCachedResponseMetadata

        ResponseMetadata getCachedResponseMetadata​(AmazonWebServiceRequest request)
        Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

        Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

        Parameters:
        request - The originally executed request.
        Returns:
        The response metadata for the specified request, or null if none is available.