Package software.amazon.awssdk.services.elasticbeanstalk

Interface ElasticBeanstalkAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface ElasticBeanstalkAsyncClient extends AwsClient
Service client for accessing Elastic Beanstalk asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call. AWS Elastic Beanstalk

AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.

For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is https://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 Details

  • Method Details

    • abortEnvironmentUpdate

      default CompletableFuture<AbortEnvironmentUpdateResponse> abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest)

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

      Parameters:
      abortEnvironmentUpdateRequest -
      Returns:
      A Java Future containing the result of the AbortEnvironmentUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • abortEnvironmentUpdate

      default CompletableFuture<AbortEnvironmentUpdateResponse> abortEnvironmentUpdate(Consumer<AbortEnvironmentUpdateRequest.Builder> abortEnvironmentUpdateRequest)

      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()

      Parameters:
      abortEnvironmentUpdateRequest - A Consumer that will call methods on AbortEnvironmentUpdateRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the AbortEnvironmentUpdate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • applyEnvironmentManagedAction

      default CompletableFuture<ApplyEnvironmentManagedActionResponse> applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest)

      Applies a scheduled managed action immediately. A managed action can be applied only if its status is Scheduled. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.

      Parameters:
      applyEnvironmentManagedActionRequest - Request to execute a scheduled managed action immediately.
      Returns:
      A Java Future containing the result of the ApplyEnvironmentManagedAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • applyEnvironmentManagedAction

      default CompletableFuture<ApplyEnvironmentManagedActionResponse> applyEnvironmentManagedAction(Consumer<ApplyEnvironmentManagedActionRequest.Builder> 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.


      This is a convenience which creates an instance of the ApplyEnvironmentManagedActionRequest.Builder avoiding the need to create one manually via ApplyEnvironmentManagedActionRequest.builder()

      Parameters:
      applyEnvironmentManagedActionRequest - A Consumer that will call methods on ApplyEnvironmentManagedActionRequest.Builder to create a request. Request to execute a scheduled managed action immediately.
      Returns:
      A Java Future containing the result of the ApplyEnvironmentManagedAction operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • associateEnvironmentOperationsRole

      default CompletableFuture<AssociateEnvironmentOperationsRoleResponse> associateEnvironmentOperationsRole(AssociateEnvironmentOperationsRoleRequest associateEnvironmentOperationsRoleRequest)

      Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      Parameters:
      associateEnvironmentOperationsRoleRequest - Request to add or change the operations role used by an environment.
      Returns:
      A Java Future containing the result of the AssociateEnvironmentOperationsRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • associateEnvironmentOperationsRole

      default CompletableFuture<AssociateEnvironmentOperationsRoleResponse> associateEnvironmentOperationsRole(Consumer<AssociateEnvironmentOperationsRoleRequest.Builder> associateEnvironmentOperationsRoleRequest)

      Add or change the operations role used by an environment. After this call is made, Elastic Beanstalk uses the associated operations role for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.


      This is a convenience which creates an instance of the AssociateEnvironmentOperationsRoleRequest.Builder avoiding the need to create one manually via AssociateEnvironmentOperationsRoleRequest.builder()

      Parameters:
      associateEnvironmentOperationsRoleRequest - A Consumer that will call methods on AssociateEnvironmentOperationsRoleRequest.Builder to create a request. Request to add or change the operations role used by an environment.
      Returns:
      A Java Future containing the result of the AssociateEnvironmentOperationsRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • checkDNSAvailability

      default CompletableFuture<CheckDnsAvailabilityResponse> checkDNSAvailability(CheckDnsAvailabilityRequest checkDnsAvailabilityRequest)

      Checks if the specified CNAME is available.

      Parameters:
      checkDnsAvailabilityRequest - Results message indicating whether a CNAME is available.
      Returns:
      A Java Future containing the result of the CheckDNSAvailability operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • checkDNSAvailability

      default CompletableFuture<CheckDnsAvailabilityResponse> checkDNSAvailability(Consumer<CheckDnsAvailabilityRequest.Builder> checkDnsAvailabilityRequest)

      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()

      Parameters:
      checkDnsAvailabilityRequest - A Consumer that will call methods on CheckDnsAvailabilityRequest.Builder to create a request. Results message indicating whether a CNAME is available.
      Returns:
      A Java Future containing the result of the CheckDNSAvailability operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • composeEnvironments

      default CompletableFuture<ComposeEnvironmentsResponse> composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest)

      Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named env.yaml. See Compose Environments for details.

      Parameters:
      composeEnvironmentsRequest - Request to create or update a group of environments.
      Returns:
      A Java Future containing the result of the ComposeEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyEnvironmentsException The specified account has reached its limit of environments.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • composeEnvironments

      default CompletableFuture<ComposeEnvironmentsResponse> composeEnvironments(Consumer<ComposeEnvironmentsRequest.Builder> 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.


      This is a convenience which creates an instance of the ComposeEnvironmentsRequest.Builder avoiding the need to create one manually via ComposeEnvironmentsRequest.builder()

      Parameters:
      composeEnvironmentsRequest - A Consumer that will call methods on ComposeEnvironmentsRequest.Builder to create a request. Request to create or update a group of environments.
      Returns:
      A Java Future containing the result of the ComposeEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyEnvironmentsException The specified account has reached its limit of environments.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(CreateApplicationRequest createApplicationRequest)

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

      Parameters:
      createApplicationRequest - Request to create an application.
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createApplication

      default CompletableFuture<CreateApplicationResponse> createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest)

      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()

      Parameters:
      createApplicationRequest - A Consumer that will call methods on CreateApplicationRequest.Builder to create a request. Request to create an application.
      Returns:
      A Java Future containing the result of the CreateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • createApplicationVersion

      default CompletableFuture<CreateApplicationVersionResponse> createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest)

      Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

      Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

      Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

      Specify a source bundle in S3 with SourceBundle

      Omit both SourceBuildInformation and SourceBundle to use the default sample application.

      After you create an application version with a specified Amazon S3 bucket and key location, you can't change that Amazon S3 location. If you change the Amazon S3 location, you receive an exception when you attempt to launch an environment from the application version.

      Parameters:
      createApplicationVersionRequest -
      Returns:
      A Java Future containing the result of the CreateApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • createApplicationVersion

      default CompletableFuture<CreateApplicationVersionResponse> createApplicationVersion(Consumer<CreateApplicationVersionRequest.Builder> createApplicationVersionRequest)

      Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:

      Specify a commit in an AWS CodeCommit repository with SourceBuildInformation.

      Specify a build in an AWS CodeBuild with SourceBuildInformation and BuildConfiguration.

      Specify a source bundle in S3 with SourceBundle

      Omit both SourceBuildInformation and SourceBundle to use the default sample application.

      After you create an application version with a specified Amazon S3 bucket and key location, you can't 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()

      Parameters:
      createApplicationVersionRequest - A Consumer that will call methods on CreateApplicationVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • createConfigurationTemplate

      default CompletableFuture<CreateConfigurationTemplateResponse> createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest)

      Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

      Templates aren't associated with any environment. The EnvironmentName response element is always null.

      Related Topics

      Parameters:
      createConfigurationTemplateRequest - Request to create a configuration template.
      Returns:
      A Java Future containing the result of the CreateConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createConfigurationTemplate

      default CompletableFuture<CreateConfigurationTemplateResponse> createConfigurationTemplate(Consumer<CreateConfigurationTemplateRequest.Builder> createConfigurationTemplateRequest)

      Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application. You define application configuration settings in a configuration template. You can then use the configuration template to deploy different versions of the application with the same configuration settings.

      Templates aren't associated with any environment. The EnvironmentName response element is always null.

      Related Topics


      This is a convenience which creates an instance of the CreateConfigurationTemplateRequest.Builder avoiding the need to create one manually via CreateConfigurationTemplateRequest.builder()

      Parameters:
      createConfigurationTemplateRequest - A Consumer that will call methods on CreateConfigurationTemplateRequest.Builder to create a request. Request to create a configuration template.
      Returns:
      A Java Future containing the result of the CreateConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createEnvironment

      default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)

      Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.

      Parameters:
      createEnvironmentRequest -
      Returns:
      A Java Future containing the result of the CreateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyEnvironmentsException The specified account has reached its limit of environments.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createEnvironment

      default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)

      Launches an AWS Elastic Beanstalk 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()

      Parameters:
      createEnvironmentRequest - A Consumer that will call methods on CreateEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • TooManyEnvironmentsException The specified account has reached its limit of environments.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createPlatformVersion

      default CompletableFuture<CreatePlatformVersionResponse> createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest)

      Create a new version of your custom platform.

      Parameters:
      createPlatformVersionRequest - Request to create a new platform version.
      Returns:
      A Java Future containing the result of the CreatePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createPlatformVersion

      default CompletableFuture<CreatePlatformVersionResponse> createPlatformVersion(Consumer<CreatePlatformVersionRequest.Builder> createPlatformVersionRequest)

      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()

      Parameters:
      createPlatformVersionRequest - A Consumer that will call methods on CreatePlatformVersionRequest.Builder to create a request. Request to create a new platform version.
      Returns:
      A Java Future containing the result of the CreatePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • createStorageLocation

      default CompletableFuture<CreateStorageLocationResponse> createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest)

      Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

      Parameters:
      createStorageLocationRequest -
      Returns:
      A Java Future containing the result of the CreateStorageLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • createStorageLocation

      default CompletableFuture<CreateStorageLocationResponse> createStorageLocation(Consumer<CreateStorageLocationRequest.Builder> createStorageLocationRequest)

      Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.


      This is a convenience which creates an instance of the CreateStorageLocationRequest.Builder avoiding the need to create one manually via CreateStorageLocationRequest.builder()

      Parameters:
      createStorageLocationRequest - A Consumer that will call methods on CreateStorageLocationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateStorageLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • createStorageLocation

      default CompletableFuture<CreateStorageLocationResponse> createStorageLocation()

      Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments. The Elastic Beanstalk console and EB CLI call this API the first time you create an environment in a region. If the storage location already exists, CreateStorageLocation still returns the bucket name but does not create a new bucket.

      Returns:
      A Java Future containing the result of the CreateStorageLocation operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(DeleteApplicationRequest deleteApplicationRequest)

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

      You cannot delete an application that has a running environment.

      Parameters:
      deleteApplicationRequest - Request to delete an application.
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteApplication

      default CompletableFuture<DeleteApplicationResponse> deleteApplication(Consumer<DeleteApplicationRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteApplicationRequest.Builder avoiding the need to create one manually via DeleteApplicationRequest.builder()

      Parameters:
      deleteApplicationRequest - A Consumer that will call methods on DeleteApplicationRequest.Builder to create a request. Request to delete an application.
      Returns:
      A Java Future containing the result of the DeleteApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteApplicationVersion

      default CompletableFuture<DeleteApplicationVersionResponse> deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest)

      Deletes the specified version from the specified application.

      You cannot delete an application version that is associated with a running environment.

      Parameters:
      deleteApplicationVersionRequest - Request to delete an application version.
      Returns:
      A Java Future containing the result of the DeleteApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • deleteApplicationVersion

      default CompletableFuture<DeleteApplicationVersionResponse> deleteApplicationVersion(Consumer<DeleteApplicationVersionRequest.Builder> deleteApplicationVersionRequest)

      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()

      Parameters:
      deleteApplicationVersionRequest - A Consumer that will call methods on DeleteApplicationVersionRequest.Builder to create a request. Request to delete an application version.
      Returns:
      A Java Future containing the result of the DeleteApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • deleteConfigurationTemplate

      default CompletableFuture<DeleteConfigurationTemplateResponse> deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest)

      Deletes the specified configuration template.

      When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.

      Parameters:
      deleteConfigurationTemplateRequest - Request to delete a configuration template.
      Returns:
      A Java Future containing the result of the DeleteConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteConfigurationTemplate

      default CompletableFuture<DeleteConfigurationTemplateResponse> deleteConfigurationTemplate(Consumer<DeleteConfigurationTemplateRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteConfigurationTemplateRequest.Builder avoiding the need to create one manually via DeleteConfigurationTemplateRequest.builder()

      Parameters:
      deleteConfigurationTemplateRequest - A Consumer that will call methods on DeleteConfigurationTemplateRequest.Builder to create a request. Request to delete a configuration template.
      Returns:
      A Java Future containing the result of the DeleteConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEnvironmentConfiguration

      default CompletableFuture<DeleteEnvironmentConfigurationResponse> deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest)

      Deletes the draft configuration associated with the running environment.

      Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The DeploymentStatus for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.

      Parameters:
      deleteEnvironmentConfigurationRequest - Request to delete a draft environment configuration.
      Returns:
      A Java Future containing the result of the DeleteEnvironmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deleteEnvironmentConfiguration

      default CompletableFuture<DeleteEnvironmentConfigurationResponse> deleteEnvironmentConfiguration(Consumer<DeleteEnvironmentConfigurationRequest.Builder> 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.


      This is a convenience which creates an instance of the DeleteEnvironmentConfigurationRequest.Builder avoiding the need to create one manually via DeleteEnvironmentConfigurationRequest.builder()

      Parameters:
      deleteEnvironmentConfigurationRequest - A Consumer that will call methods on DeleteEnvironmentConfigurationRequest.Builder to create a request. Request to delete a draft environment configuration.
      Returns:
      A Java Future containing the result of the DeleteEnvironmentConfiguration operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • deletePlatformVersion

      default CompletableFuture<DeletePlatformVersionResponse> deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest)

      Deletes the specified version of a custom platform.

      Parameters:
      deletePlatformVersionRequest -
      Returns:
      A Java Future containing the result of the DeletePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • deletePlatformVersion

      default CompletableFuture<DeletePlatformVersionResponse> deletePlatformVersion(Consumer<DeletePlatformVersionRequest.Builder> deletePlatformVersionRequest)

      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()

      Parameters:
      deletePlatformVersionRequest - A Consumer that will call methods on DeletePlatformVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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 or 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.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest)

      Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

      The result currently has one set of attributes—resource quotas.

      Parameters:
      describeAccountAttributesRequest -
      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest)

      Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

      The result currently has one set of attributes—resource quotas.


      This is a convenience which creates an instance of the DescribeAccountAttributesRequest.Builder avoiding the need to create one manually via DescribeAccountAttributesRequest.builder()

      Parameters:
      describeAccountAttributesRequest - A Consumer that will call methods on DescribeAccountAttributesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describeAccountAttributes

      default CompletableFuture<DescribeAccountAttributesResponse> describeAccountAttributes()

      Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.

      The result currently has one set of attributes—resource quotas.

      Returns:
      A Java Future containing the result of the DescribeAccountAttributes operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describeApplicationVersions

      default CompletableFuture<DescribeApplicationVersionsResponse> describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest)

      Retrieve a list of application versions.

      Parameters:
      describeApplicationVersionsRequest - Request to describe application versions.
      Returns:
      A Java Future containing the result of the DescribeApplicationVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeApplicationVersions

      default CompletableFuture<DescribeApplicationVersionsResponse> describeApplicationVersions(Consumer<DescribeApplicationVersionsRequest.Builder> describeApplicationVersionsRequest)

      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()

      Parameters:
      describeApplicationVersionsRequest - A Consumer that will call methods on DescribeApplicationVersionsRequest.Builder to create a request. Request to describe application versions.
      Returns:
      A Java Future containing the result of the DescribeApplicationVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeApplicationVersions

      default CompletableFuture<DescribeApplicationVersionsResponse> describeApplicationVersions()

      Retrieve a list of application versions.

      Returns:
      A Java Future containing the result of the DescribeApplicationVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeApplications

      default CompletableFuture<DescribeApplicationsResponse> describeApplications(DescribeApplicationsRequest describeApplicationsRequest)

      Returns the descriptions of existing applications.

      Parameters:
      describeApplicationsRequest - Request to describe one or more applications.
      Returns:
      A Java Future containing the result of the DescribeApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeApplications

      default CompletableFuture<DescribeApplicationsResponse> describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest)

      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()

      Parameters:
      describeApplicationsRequest - A Consumer that will call methods on DescribeApplicationsRequest.Builder to create a request. Request to describe one or more applications.
      Returns:
      A Java Future containing the result of the DescribeApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeApplications

      default CompletableFuture<DescribeApplicationsResponse> describeApplications()

      Returns the descriptions of existing applications.

      Returns:
      A Java Future containing the result of the DescribeApplications operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeConfigurationOptions

      default CompletableFuture<DescribeConfigurationOptionsResponse> describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest)

      Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

      Parameters:
      describeConfigurationOptionsRequest - Result message containing a list of application version descriptions.
      Returns:
      A Java Future containing the result of the DescribeConfigurationOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeConfigurationOptions

      default CompletableFuture<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. 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()

      Parameters:
      describeConfigurationOptionsRequest - A Consumer that will call methods on DescribeConfigurationOptionsRequest.Builder to create a request. Result message containing a list of application version descriptions.
      Returns:
      A Java Future containing the result of the DescribeConfigurationOptions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeConfigurationSettings

      default CompletableFuture<DescribeConfigurationSettingsResponse> describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest)

      Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

      When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

      Related Topics

      Parameters:
      describeConfigurationSettingsRequest - Result message containing all of the configuration settings for a specified solution stack or configuration template.
      Returns:
      A Java Future containing the result of the DescribeConfigurationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeConfigurationSettings

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

      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()

      Parameters:
      describeConfigurationSettingsRequest - A Consumer that will call methods on DescribeConfigurationSettingsRequest.Builder to create a request. Result message containing all of the configuration settings for a specified solution stack or configuration template.
      Returns:
      A Java Future containing the result of the DescribeConfigurationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentHealth

      default CompletableFuture<DescribeEnvironmentHealthResponse> describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest)

      Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.

      Parameters:
      describeEnvironmentHealthRequest - See the example below to learn how to create a request body.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentHealth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentHealth

      default CompletableFuture<DescribeEnvironmentHealthResponse> describeEnvironmentHealth(Consumer<DescribeEnvironmentHealthRequest.Builder> describeEnvironmentHealthRequest)

      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()

      Parameters:
      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.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentHealth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActionHistory

      default CompletableFuture<DescribeEnvironmentManagedActionHistoryResponse> describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)

      Lists an environment's completed and failed managed actions.

      Parameters:
      describeEnvironmentManagedActionHistoryRequest - Request to list completed and failed managed actions.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActionHistory

      default CompletableFuture<DescribeEnvironmentManagedActionHistoryResponse> describeEnvironmentManagedActionHistory(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest)

      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()

      Parameters:
      describeEnvironmentManagedActionHistoryRequest - A Consumer that will call methods on DescribeEnvironmentManagedActionHistoryRequest.Builder to create a request. Request to list completed and failed managed actions.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActionHistoryPaginator

      default DescribeEnvironmentManagedActionHistoryPublisher describeEnvironmentManagedActionHistoryPaginator(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest)

      This is a variant of describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryPublisher publisher = client.describeEnvironmentManagedActionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryPublisher publisher = client.describeEnvironmentManagedActionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest) operation.

      Parameters:
      describeEnvironmentManagedActionHistoryRequest - Request to list completed and failed managed actions.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActionHistoryPaginator

      default DescribeEnvironmentManagedActionHistoryPublisher describeEnvironmentManagedActionHistoryPaginator(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest)

      This is a variant of describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryPublisher publisher = client.describeEnvironmentManagedActionHistoryPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryPublisher publisher = client.describeEnvironmentManagedActionHistoryPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxItems won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest) operation.


      This is a convenience which creates an instance of the DescribeEnvironmentManagedActionHistoryRequest.Builder avoiding the need to create one manually via DescribeEnvironmentManagedActionHistoryRequest.builder()

      Parameters:
      describeEnvironmentManagedActionHistoryRequest - A Consumer that will call methods on DescribeEnvironmentManagedActionHistoryRequest.Builder to create a request. Request to list completed and failed managed actions.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActions

      default CompletableFuture<DescribeEnvironmentManagedActionsResponse> describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest)

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

      Parameters:
      describeEnvironmentManagedActionsRequest - Request to list an environment's upcoming and in-progress managed actions.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentManagedActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentManagedActions

      default CompletableFuture<DescribeEnvironmentManagedActionsResponse> describeEnvironmentManagedActions(Consumer<DescribeEnvironmentManagedActionsRequest.Builder> describeEnvironmentManagedActionsRequest)

      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()

      Parameters:
      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.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentManagedActions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironmentResources

      default CompletableFuture<DescribeEnvironmentResourcesResponse> describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest)

      Returns AWS resources for this environment.

      Parameters:
      describeEnvironmentResourcesRequest - Request to describe the resources in an environment.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describeEnvironmentResources

      default CompletableFuture<DescribeEnvironmentResourcesResponse> describeEnvironmentResources(Consumer<DescribeEnvironmentResourcesRequest.Builder> describeEnvironmentResourcesRequest)

      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()

      Parameters:
      describeEnvironmentResourcesRequest - A Consumer that will call methods on DescribeEnvironmentResourcesRequest.Builder to create a request. Request to describe the resources in an environment.
      Returns:
      A Java Future containing the result of the DescribeEnvironmentResources operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describeEnvironments

      default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest)

      Returns descriptions for existing environments.

      Parameters:
      describeEnvironmentsRequest - Request to describe one or more environments.
      Returns:
      A Java Future containing the result of the DescribeEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironments

      default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)

      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()

      Parameters:
      describeEnvironmentsRequest - A Consumer that will call methods on DescribeEnvironmentsRequest.Builder to create a request. Request to describe one or more environments.
      Returns:
      A Java Future containing the result of the DescribeEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEnvironments

      default CompletableFuture<DescribeEnvironmentsResponse> describeEnvironments()

      Returns descriptions for existing environments.

      Returns:
      A Java Future containing the result of the DescribeEnvironments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(DescribeEventsRequest describeEventsRequest)

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

      This action returns the most recent 1,000 events from the specified NextToken.

      Parameters:
      describeEventsRequest - Request to retrieve a list of events for an environment.
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

      default CompletableFuture<DescribeEventsResponse> describeEvents(Consumer<DescribeEventsRequest.Builder> 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.


      This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request. Request to retrieve a list of events for an environment.
      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEvents

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

      Returns:
      A Java Future containing the result of the DescribeEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator()

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(DescribeEventsRequest describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation.

      Parameters:
      describeEventsRequest - Request to retrieve a list of events for an environment.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeEventsPaginator

      default DescribeEventsPublisher describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest)

      This is a variant of describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsPublisher publisher = client.describeEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest) operation.


      This is a convenience which creates an instance of the DescribeEventsRequest.Builder avoiding the need to create one manually via DescribeEventsRequest.builder()

      Parameters:
      describeEventsRequest - A Consumer that will call methods on DescribeEventsRequest.Builder to create a request. Request to retrieve a list of events for an environment.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeInstancesHealth

      default CompletableFuture<DescribeInstancesHealthResponse> describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest)

      Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk. This operation requires enhanced health reporting.

      Parameters:
      describeInstancesHealthRequest - Parameters for a call to DescribeInstancesHealth.
      Returns:
      A Java Future containing the result of the DescribeInstancesHealth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describeInstancesHealth

      default CompletableFuture<DescribeInstancesHealthResponse> describeInstancesHealth(Consumer<DescribeInstancesHealthRequest.Builder> describeInstancesHealthRequest)

      Retrieves 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()

      Parameters:
      describeInstancesHealthRequest - A Consumer that will call methods on DescribeInstancesHealthRequest.Builder to create a request. Parameters for a call to DescribeInstancesHealth.
      Returns:
      A Java Future containing the result of the DescribeInstancesHealth operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • describePlatformVersion

      default CompletableFuture<DescribePlatformVersionResponse> describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest)

      Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

      For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

      Parameters:
      describePlatformVersionRequest -
      Returns:
      A Java Future containing the result of the DescribePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • describePlatformVersion

      default CompletableFuture<DescribePlatformVersionResponse> describePlatformVersion(Consumer<DescribePlatformVersionRequest.Builder> describePlatformVersionRequest)

      Describes a platform version. Provides full details. Compare to ListPlatformVersions, which provides summary information about a list of platform versions.

      For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.


      This is a convenience which creates an instance of the DescribePlatformVersionRequest.Builder avoiding the need to create one manually via DescribePlatformVersionRequest.builder()

      Parameters:
      describePlatformVersionRequest - A Consumer that will call methods on DescribePlatformVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribePlatformVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • disassociateEnvironmentOperationsRole

      default CompletableFuture<DisassociateEnvironmentOperationsRoleResponse> disassociateEnvironmentOperationsRole(DisassociateEnvironmentOperationsRoleRequest disassociateEnvironmentOperationsRoleRequest)

      Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.

      Parameters:
      disassociateEnvironmentOperationsRoleRequest - Request to disassociate the operations role from an environment.
      Returns:
      A Java Future containing the result of the DisassociateEnvironmentOperationsRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • disassociateEnvironmentOperationsRole

      default CompletableFuture<DisassociateEnvironmentOperationsRoleResponse> disassociateEnvironmentOperationsRole(Consumer<DisassociateEnvironmentOperationsRoleRequest.Builder> disassociateEnvironmentOperationsRoleRequest)

      Disassociate the operations role from an environment. After this call is made, Elastic Beanstalk uses the caller's permissions for permissions to downstream services during subsequent calls acting on this environment. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide.


      This is a convenience which creates an instance of the DisassociateEnvironmentOperationsRoleRequest.Builder avoiding the need to create one manually via DisassociateEnvironmentOperationsRoleRequest.builder()

      Parameters:
      disassociateEnvironmentOperationsRoleRequest - A Consumer that will call methods on DisassociateEnvironmentOperationsRoleRequest.Builder to create a request. Request to disassociate the operations role from an environment.
      Returns:
      A Java Future containing the result of the DisassociateEnvironmentOperationsRole operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listAvailableSolutionStacks

      default CompletableFuture<ListAvailableSolutionStacksResponse> listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest)

      Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

      Parameters:
      listAvailableSolutionStacksRequest -
      Returns:
      A Java Future containing the result of the ListAvailableSolutionStacks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAvailableSolutionStacks

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


      This is a convenience which creates an instance of the ListAvailableSolutionStacksRequest.Builder avoiding the need to create one manually via ListAvailableSolutionStacksRequest.builder()

      Parameters:
      listAvailableSolutionStacksRequest - A Consumer that will call methods on ListAvailableSolutionStacksRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableSolutionStacks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listAvailableSolutionStacks

      default CompletableFuture<ListAvailableSolutionStacksResponse> listAvailableSolutionStacks()

      Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.

      Returns:
      A Java Future containing the result of the ListAvailableSolutionStacks operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPlatformBranches

      default CompletableFuture<ListPlatformBranchesResponse> listPlatformBranches(ListPlatformBranchesRequest listPlatformBranchesRequest)

      Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

      For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

      Parameters:
      listPlatformBranchesRequest -
      Returns:
      A Java Future containing the result of the ListPlatformBranches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPlatformBranches

      default CompletableFuture<ListPlatformBranchesResponse> listPlatformBranches(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest)

      Lists the platform branches available for your account in an AWS Region. Provides summary information about each platform branch.

      For definitions of platform branch and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.


      This is a convenience which creates an instance of the ListPlatformBranchesRequest.Builder avoiding the need to create one manually via ListPlatformBranchesRequest.builder()

      Parameters:
      listPlatformBranchesRequest - A Consumer that will call methods on ListPlatformBranchesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPlatformBranches operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPlatformBranchesPaginator

      default ListPlatformBranchesPublisher listPlatformBranchesPaginator(ListPlatformBranchesRequest listPlatformBranchesRequest)

      This is a variant of listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesPublisher publisher = client.listPlatformBranchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesPublisher publisher = client.listPlatformBranchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest) operation.

      Parameters:
      listPlatformBranchesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPlatformBranchesPaginator

      default ListPlatformBranchesPublisher listPlatformBranchesPaginator(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest)

      This is a variant of listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesPublisher publisher = client.listPlatformBranchesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesPublisher publisher = client.listPlatformBranchesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest) operation.


      This is a convenience which creates an instance of the ListPlatformBranchesRequest.Builder avoiding the need to create one manually via ListPlatformBranchesRequest.builder()

      Parameters:
      listPlatformBranchesRequest - A Consumer that will call methods on ListPlatformBranchesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • listPlatformVersions

      default CompletableFuture<ListPlatformVersionsResponse> listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest)

      Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

      For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

      Parameters:
      listPlatformVersionsRequest -
      Returns:
      A Java Future containing the result of the ListPlatformVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listPlatformVersions

      default CompletableFuture<ListPlatformVersionsResponse> listPlatformVersions(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest)

      Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

      For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.


      This is a convenience which creates an instance of the ListPlatformVersionsRequest.Builder avoiding the need to create one manually via ListPlatformVersionsRequest.builder()

      Parameters:
      listPlatformVersionsRequest - A Consumer that will call methods on ListPlatformVersionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPlatformVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listPlatformVersions

      default CompletableFuture<ListPlatformVersionsResponse> listPlatformVersions()

      Lists the platform versions available for your account in an AWS Region. Provides summary information about each platform version. Compare to DescribePlatformVersion, which provides full details about a single platform version.

      For definitions of platform version and other platform-related terms, see AWS Elastic Beanstalk Platforms Glossary.

      Returns:
      A Java Future containing the result of the ListPlatformVersions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listPlatformVersionsPaginator

      default ListPlatformVersionsPublisher listPlatformVersionsPaginator()

      This is a variant of listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listPlatformVersionsPaginator

      default ListPlatformVersionsPublisher listPlatformVersionsPaginator(ListPlatformVersionsRequest listPlatformVersionsRequest)

      This is a variant of listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation.

      Parameters:
      listPlatformVersionsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listPlatformVersionsPaginator

      default ListPlatformVersionsPublisher listPlatformVersionsPaginator(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest)

      This is a variant of listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsPublisher publisher = client.listPlatformVersionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxRecords won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest) operation.


      This is a convenience which creates an instance of the ListPlatformVersionsRequest.Builder avoiding the need to create one manually via ListPlatformVersionsRequest.builder()

      Parameters:
      listPlatformVersionsRequest - A Consumer that will call methods on ListPlatformVersionsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

      Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Return the tags applied to an AWS Elastic Beanstalk resource. The response contains a list of tag key-value pairs.

      Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • rebuildEnvironment

      default CompletableFuture<RebuildEnvironmentResponse> rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest)

      Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.

      Parameters:
      rebuildEnvironmentRequest -
      Returns:
      A Java Future containing the result of the RebuildEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • rebuildEnvironment

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


      This is a convenience which creates an instance of the RebuildEnvironmentRequest.Builder avoiding the need to create one manually via RebuildEnvironmentRequest.builder()

      Parameters:
      rebuildEnvironmentRequest - A Consumer that will call methods on RebuildEnvironmentRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RebuildEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • requestEnvironmentInfo

      default CompletableFuture<RequestEnvironmentInfoResponse> requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest)

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

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

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

      Use RetrieveEnvironmentInfo to obtain the set of logs.

      Related Topics

      Parameters:
      requestEnvironmentInfoRequest - Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
      Returns:
      A Java Future containing the result of the RequestEnvironmentInfo operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • requestEnvironmentInfo

      default CompletableFuture<RequestEnvironmentInfoResponse> requestEnvironmentInfo(Consumer<RequestEnvironmentInfoRequest.Builder> 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


      This is a convenience which creates an instance of the RequestEnvironmentInfoRequest.Builder avoiding the need to create one manually via RequestEnvironmentInfoRequest.builder()

      Parameters:
      requestEnvironmentInfoRequest - A Consumer that will call methods on RequestEnvironmentInfoRequest.Builder to create a request. Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.
      Returns:
      A Java Future containing the result of the RequestEnvironmentInfo operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • restartAppServer

      default CompletableFuture<RestartAppServerResponse> restartAppServer(RestartAppServerRequest restartAppServerRequest)

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

      Parameters:
      restartAppServerRequest -
      Returns:
      A Java Future containing the result of the RestartAppServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • restartAppServer

      default CompletableFuture<RestartAppServerResponse> restartAppServer(Consumer<RestartAppServerRequest.Builder> restartAppServerRequest)

      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()

      Parameters:
      restartAppServerRequest - A Consumer that will call methods on RestartAppServerRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the RestartAppServer operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveEnvironmentInfo

      default CompletableFuture<RetrieveEnvironmentInfoResponse> retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest)

      Retrieves the compiled information from a RequestEnvironmentInfo request.

      Related Topics

      Parameters:
      retrieveEnvironmentInfoRequest - Request to download logs retrieved with RequestEnvironmentInfo.
      Returns:
      A Java Future containing the result of the RetrieveEnvironmentInfo operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • retrieveEnvironmentInfo

      default CompletableFuture<RetrieveEnvironmentInfoResponse> retrieveEnvironmentInfo(Consumer<RetrieveEnvironmentInfoRequest.Builder> retrieveEnvironmentInfoRequest)

      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()

      Parameters:
      retrieveEnvironmentInfoRequest - A Consumer that will call methods on RetrieveEnvironmentInfoRequest.Builder to create a request. Request to download logs retrieved with RequestEnvironmentInfo.
      Returns:
      A Java Future containing the result of the RetrieveEnvironmentInfo operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • swapEnvironmentCNAMEs

      default CompletableFuture<SwapEnvironmentCnamEsResponse> swapEnvironmentCNAMEs(SwapEnvironmentCnamEsRequest swapEnvironmentCnamEsRequest)

      Swaps the CNAMEs of two environments.

      Parameters:
      swapEnvironmentCnamEsRequest - Swaps the CNAMEs of two environments.
      Returns:
      A Java Future containing the result of the SwapEnvironmentCNAMEs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • swapEnvironmentCNAMEs

      default CompletableFuture<SwapEnvironmentCnamEsResponse> swapEnvironmentCNAMEs(Consumer<SwapEnvironmentCnamEsRequest.Builder> swapEnvironmentCnamEsRequest)

      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()

      Parameters:
      swapEnvironmentCnamEsRequest - A Consumer that will call methods on SwapEnvironmentCnamEsRequest.Builder to create a request. Swaps the CNAMEs of two environments.
      Returns:
      A Java Future containing the result of the SwapEnvironmentCNAMEs operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • terminateEnvironment

      default CompletableFuture<TerminateEnvironmentResponse> terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest)

      Terminates the specified environment.

      Parameters:
      terminateEnvironmentRequest - Request to terminate an environment.
      Returns:
      A Java Future containing the result of the TerminateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • terminateEnvironment

      default CompletableFuture<TerminateEnvironmentResponse> terminateEnvironment(Consumer<TerminateEnvironmentRequest.Builder> terminateEnvironmentRequest)

      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()

      Parameters:
      terminateEnvironmentRequest - A Consumer that will call methods on TerminateEnvironmentRequest.Builder to create a request. Request to terminate an environment.
      Returns:
      A Java Future containing the result of the TerminateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(UpdateApplicationRequest updateApplicationRequest)

      Updates the specified application to have the specified properties.

      If a property (for example, description) is not provided, the value remains unchanged. To clear these properties, specify an empty string.

      Parameters:
      updateApplicationRequest - Request to update an application.
      Returns:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateApplication

      default CompletableFuture<UpdateApplicationResponse> updateApplication(Consumer<UpdateApplicationRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdateApplicationRequest.Builder avoiding the need to create one manually via UpdateApplicationRequest.builder()

      Parameters:
      updateApplicationRequest - A Consumer that will call methods on UpdateApplicationRequest.Builder to create a request. Request to update an application.
      Returns:
      A Java Future containing the result of the UpdateApplication operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateApplicationResourceLifecycle

      default CompletableFuture<UpdateApplicationResourceLifecycleResponse> updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest)

      Modifies lifecycle settings for an application.

      Parameters:
      updateApplicationResourceLifecycleRequest -
      Returns:
      A Java Future containing the result of the UpdateApplicationResourceLifecycle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateApplicationResourceLifecycle

      default CompletableFuture<UpdateApplicationResourceLifecycleResponse> updateApplicationResourceLifecycle(Consumer<UpdateApplicationResourceLifecycleRequest.Builder> updateApplicationResourceLifecycleRequest)

      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()

      Parameters:
      updateApplicationResourceLifecycleRequest - A Consumer that will call methods on UpdateApplicationResourceLifecycleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApplicationResourceLifecycle operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateApplicationVersion

      default CompletableFuture<UpdateApplicationVersionResponse> updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest)

      Updates the specified application version to have the specified properties.

      If a property (for example, description) is not provided, the value remains unchanged. To clear properties, specify an empty string.

      Parameters:
      updateApplicationVersionRequest -
      Returns:
      A Java Future containing the result of the UpdateApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateApplicationVersion

      default CompletableFuture<UpdateApplicationVersionResponse> updateApplicationVersion(Consumer<UpdateApplicationVersionRequest.Builder> 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.


      This is a convenience which creates an instance of the UpdateApplicationVersionRequest.Builder avoiding the need to create one manually via UpdateApplicationVersionRequest.builder()

      Parameters:
      updateApplicationVersionRequest - A Consumer that will call methods on UpdateApplicationVersionRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateApplicationVersion operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      See Also:

    • updateConfigurationTemplate

      default CompletableFuture<UpdateConfigurationTemplateResponse> updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest)

      Updates the specified configuration template to have the specified properties or configuration option values.

      If a property (for example, ApplicationName) is not provided, its value remains unchanged. To clear such properties, specify an empty string.

      Related Topics

      Parameters:
      updateConfigurationTemplateRequest - The result message containing the options for the specified solution stack.
      Returns:
      A Java Future containing the result of the UpdateConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateConfigurationTemplate

      default CompletableFuture<UpdateConfigurationTemplateResponse> updateConfigurationTemplate(Consumer<UpdateConfigurationTemplateRequest.Builder> 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


      This is a convenience which creates an instance of the UpdateConfigurationTemplateRequest.Builder avoiding the need to create one manually via UpdateConfigurationTemplateRequest.builder()

      Parameters:
      updateConfigurationTemplateRequest - A Consumer that will call methods on UpdateConfigurationTemplateRequest.Builder to create a request. The result message containing the options for the specified solution stack.
      Returns:
      A Java Future containing the result of the UpdateConfigurationTemplate operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateEnvironment

      default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)

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

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

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

      Parameters:
      updateEnvironmentRequest - Request to update an environment.
      Returns:
      A Java Future containing the result of the UpdateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateEnvironment

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

      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()

      Parameters:
      updateEnvironmentRequest - A Consumer that will call methods on UpdateEnvironmentRequest.Builder to create a request. Request to update an environment.
      Returns:
      A Java Future containing the result of the UpdateEnvironment operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateTagsForResource

      default CompletableFuture<UpdateTagsForResourceResponse> updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest)

      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.

      Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

      If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

      elasticbeanstalk:AddTags

      Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

      elasticbeanstalk:RemoveTags

      Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

      For details about creating a custom user policy, see Creating a Custom User Policy.

      Parameters:
      updateTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the UpdateTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • updateTagsForResource

      default CompletableFuture<UpdateTagsForResourceResponse> updateTagsForResource(Consumer<UpdateTagsForResourceRequest.Builder> updateTagsForResourceRequest)

      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.

      Elastic Beanstalk supports tagging of all of its resources. For details about resource tagging, see Tagging Application Resources.

      If you create a custom IAM user policy to control permission to this operation, specify one of the following two virtual actions (or both) instead of the API operation name:

      elasticbeanstalk:AddTags

      Controls permission to call UpdateTagsForResource and pass a list of tags to add in the TagsToAdd parameter.

      elasticbeanstalk:RemoveTags

      Controls permission to call UpdateTagsForResource and pass a list of tag keys to remove in the TagsToRemove parameter.

      For details about creating a custom user policy, see Creating a Custom User Policy.


      This is a convenience which creates an instance of the UpdateTagsForResourceRequest.Builder avoiding the need to create one manually via UpdateTagsForResourceRequest.builder()

      Parameters:
      updateTagsForResourceRequest - A Consumer that will call methods on UpdateTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • validateConfigurationSettings

      default CompletableFuture<ValidateConfigurationSettingsResponse> validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest)

      Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.

      This action returns a list of messages indicating any errors or warnings associated with the selection of option values.

      Parameters:
      validateConfigurationSettingsRequest - A list of validation messages for a specified configuration template.
      Returns:
      A Java Future containing the result of the ValidateConfigurationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • validateConfigurationSettings

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

      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()

      Parameters:
      validateConfigurationSettingsRequest - A Consumer that will call methods on ValidateConfigurationSettingsRequest.Builder to create a request. A list of validation messages for a specified configuration template.
      Returns:
      A Java Future containing the result of the ValidateConfigurationSettings operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InsufficientPrivilegesException The specified account does not have sufficient privileges for one or 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.
      See Also:

    • waiter

      default ElasticBeanstalkAsyncWaiter waiter()
      Create an instance of ElasticBeanstalkAsyncWaiter using this client.

      Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.

      Returns:
      an instance of ElasticBeanstalkAsyncWaiter

    • serviceClientConfiguration

      default ElasticBeanstalkServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static ElasticBeanstalkAsyncClient create()
      Create a ElasticBeanstalkAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static ElasticBeanstalkAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a ElasticBeanstalkAsyncClient.