Interface ElasticBeanstalkClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
AWS Elastic Beanstalk makes it easy for you to create, deploy, and manage scalable, fault-tolerant applications running on the Amazon Web Services cloud.
For more information about this product, go to the AWS Elastic Beanstalk details page. The location of the latest AWS Elastic Beanstalk WSDL is 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 Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AbortEnvironmentUpdateResponse
abortEnvironmentUpdate
(Consumer<AbortEnvironmentUpdateRequest.Builder> abortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.default AbortEnvironmentUpdateResponse
abortEnvironmentUpdate
(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) Cancels in-progress environment configuration update or application version deployment.applyEnvironmentManagedAction
(Consumer<ApplyEnvironmentManagedActionRequest.Builder> applyEnvironmentManagedActionRequest) Applies a scheduled managed action immediately.applyEnvironmentManagedAction
(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) Applies a scheduled managed action immediately.associateEnvironmentOperationsRole
(Consumer<AssociateEnvironmentOperationsRoleRequest.Builder> associateEnvironmentOperationsRoleRequest) Add or change the operations role used by an environment.associateEnvironmentOperationsRole
(AssociateEnvironmentOperationsRoleRequest associateEnvironmentOperationsRoleRequest) Add or change the operations role used by an environment.builder()
Create a builder that can be used to configure and create aElasticBeanstalkClient
.default CheckDnsAvailabilityResponse
checkDNSAvailability
(Consumer<CheckDnsAvailabilityRequest.Builder> checkDnsAvailabilityRequest) Checks if the specified CNAME is available.default CheckDnsAvailabilityResponse
checkDNSAvailability
(CheckDnsAvailabilityRequest checkDnsAvailabilityRequest) Checks if the specified CNAME is available.default ComposeEnvironmentsResponse
composeEnvironments
(Consumer<ComposeEnvironmentsRequest.Builder> composeEnvironmentsRequest) Create or update a group of environments that each run a separate component of a single application.default ComposeEnvironmentsResponse
composeEnvironments
(ComposeEnvironmentsRequest composeEnvironmentsRequest) Create or update a group of environments that each run a separate component of a single application.static ElasticBeanstalkClient
create()
Create aElasticBeanstalkClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApplicationResponse
createApplication
(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) Creates an application that has one configuration template nameddefault
and no application versions.default CreateApplicationResponse
createApplication
(CreateApplicationRequest createApplicationRequest) Creates an application that has one configuration template nameddefault
and no application versions.default CreateApplicationVersionResponse
createApplicationVersion
(Consumer<CreateApplicationVersionRequest.Builder> createApplicationVersionRequest) Creates an application version for the specified application.default CreateApplicationVersionResponse
createApplicationVersion
(CreateApplicationVersionRequest createApplicationVersionRequest) Creates an application version for the specified application.createConfigurationTemplate
(Consumer<CreateConfigurationTemplateRequest.Builder> createConfigurationTemplateRequest) Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.createConfigurationTemplate
(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) Creates an AWS Elastic Beanstalk configuration template, associated with a specific Elastic Beanstalk application.default CreateEnvironmentResponse
createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.default CreateEnvironmentResponse
createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.default CreatePlatformVersionResponse
createPlatformVersion
(Consumer<CreatePlatformVersionRequest.Builder> createPlatformVersionRequest) Create a new version of your custom platform.default CreatePlatformVersionResponse
createPlatformVersion
(CreatePlatformVersionRequest createPlatformVersionRequest) Create a new version of your custom platform.default CreateStorageLocationResponse
Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.default 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.default CreateStorageLocationResponse
createStorageLocation
(CreateStorageLocationRequest createStorageLocationRequest) Creates a bucket in Amazon S3 to store application versions, logs, and other files used by Elastic Beanstalk environments.default DeleteApplicationResponse
deleteApplication
(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) Deletes the specified application along with all associated versions and configurations.default DeleteApplicationResponse
deleteApplication
(DeleteApplicationRequest deleteApplicationRequest) Deletes the specified application along with all associated versions and configurations.default DeleteApplicationVersionResponse
deleteApplicationVersion
(Consumer<DeleteApplicationVersionRequest.Builder> deleteApplicationVersionRequest) Deletes the specified version from the specified application.default DeleteApplicationVersionResponse
deleteApplicationVersion
(DeleteApplicationVersionRequest deleteApplicationVersionRequest) Deletes the specified version from the specified application.deleteConfigurationTemplate
(Consumer<DeleteConfigurationTemplateRequest.Builder> deleteConfigurationTemplateRequest) Deletes the specified configuration template.deleteConfigurationTemplate
(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) Deletes the specified configuration template.deleteEnvironmentConfiguration
(Consumer<DeleteEnvironmentConfigurationRequest.Builder> deleteEnvironmentConfigurationRequest) Deletes the draft configuration associated with the running environment.deleteEnvironmentConfiguration
(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) Deletes the draft configuration associated with the running environment.default DeletePlatformVersionResponse
deletePlatformVersion
(Consumer<DeletePlatformVersionRequest.Builder> deletePlatformVersionRequest) Deletes the specified version of a custom platform.default DeletePlatformVersionResponse
deletePlatformVersion
(DeletePlatformVersionRequest deletePlatformVersionRequest) Deletes the specified version of a custom platform.Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.describeAccountAttributes
(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.describeAccountAttributes
(DescribeAccountAttributesRequest describeAccountAttributesRequest) Returns attributes related to AWS Elastic Beanstalk that are associated with the calling AWS account.default DescribeApplicationsResponse
Returns the descriptions of existing applications.default DescribeApplicationsResponse
describeApplications
(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) Returns the descriptions of existing applications.default DescribeApplicationsResponse
describeApplications
(DescribeApplicationsRequest describeApplicationsRequest) Returns the descriptions of existing applications.Retrieve a list of application versions.describeApplicationVersions
(Consumer<DescribeApplicationVersionsRequest.Builder> describeApplicationVersionsRequest) Retrieve a list of application versions.describeApplicationVersions
(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) Retrieve a list of application versions.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.describeConfigurationOptions
(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines.describeConfigurationSettings
(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.describeConfigurationSettings
(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.describeEnvironmentHealth
(Consumer<DescribeEnvironmentHealthRequest.Builder> describeEnvironmentHealthRequest) Returns information about the overall health of the specified environment.describeEnvironmentHealth
(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) Returns information about the overall health of the specified environment.describeEnvironmentManagedActionHistory
(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.describeEnvironmentManagedActionHistory
(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.describeEnvironmentManagedActionHistoryPaginator
(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.describeEnvironmentManagedActionHistoryPaginator
(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) Lists an environment's completed and failed managed actions.describeEnvironmentManagedActions
(Consumer<DescribeEnvironmentManagedActionsRequest.Builder> describeEnvironmentManagedActionsRequest) Lists an environment's upcoming and in-progress managed actions.describeEnvironmentManagedActions
(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) Lists an environment's upcoming and in-progress managed actions.describeEnvironmentResources
(Consumer<DescribeEnvironmentResourcesRequest.Builder> describeEnvironmentResourcesRequest) Returns AWS resources for this environment.describeEnvironmentResources
(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) Returns AWS resources for this environment.default DescribeEnvironmentsResponse
Returns descriptions for existing environments.default DescribeEnvironmentsResponse
describeEnvironments
(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Returns descriptions for existing environments.default DescribeEnvironmentsResponse
describeEnvironments
(DescribeEnvironmentsRequest describeEnvironmentsRequest) Returns descriptions for existing environments.default DescribeEventsResponse
Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeEventsResponse
describeEvents
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeEventsResponse
describeEvents
(DescribeEventsRequest describeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeEventsIterable
Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeEventsIterable
describeEventsPaginator
(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeEventsIterable
describeEventsPaginator
(DescribeEventsRequest describeEventsRequest) Returns list of event descriptions matching criteria up to the last 6 weeks.default DescribeInstancesHealthResponse
describeInstancesHealth
(Consumer<DescribeInstancesHealthRequest.Builder> describeInstancesHealthRequest) Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.default DescribeInstancesHealthResponse
describeInstancesHealth
(DescribeInstancesHealthRequest describeInstancesHealthRequest) Retrieves detailed information about the health of instances in your AWS Elastic Beanstalk.default DescribePlatformVersionResponse
describePlatformVersion
(Consumer<DescribePlatformVersionRequest.Builder> describePlatformVersionRequest) Describes a platform version.default DescribePlatformVersionResponse
describePlatformVersion
(DescribePlatformVersionRequest describePlatformVersionRequest) Describes a platform version.disassociateEnvironmentOperationsRole
(Consumer<DisassociateEnvironmentOperationsRoleRequest.Builder> disassociateEnvironmentOperationsRoleRequest) Disassociate the operations role from an environment.disassociateEnvironmentOperationsRole
(DisassociateEnvironmentOperationsRoleRequest disassociateEnvironmentOperationsRoleRequest) Disassociate the operations role from an environment.Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.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.listAvailableSolutionStacks
(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.default ListPlatformBranchesResponse
listPlatformBranches
(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest) Lists the platform branches available for your account in an AWS Region.default ListPlatformBranchesResponse
listPlatformBranches
(ListPlatformBranchesRequest listPlatformBranchesRequest) Lists the platform branches available for your account in an AWS Region.default ListPlatformBranchesIterable
listPlatformBranchesPaginator
(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest) Lists the platform branches available for your account in an AWS Region.default ListPlatformBranchesIterable
listPlatformBranchesPaginator
(ListPlatformBranchesRequest listPlatformBranchesRequest) Lists the platform branches available for your account in an AWS Region.default ListPlatformVersionsResponse
Lists the platform versions available for your account in an AWS Region.default ListPlatformVersionsResponse
listPlatformVersions
(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest) Lists the platform versions available for your account in an AWS Region.default ListPlatformVersionsResponse
listPlatformVersions
(ListPlatformVersionsRequest listPlatformVersionsRequest) Lists the platform versions available for your account in an AWS Region.default ListPlatformVersionsIterable
Lists the platform versions available for your account in an AWS Region.default ListPlatformVersionsIterable
listPlatformVersionsPaginator
(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest) Lists the platform versions available for your account in an AWS Region.default ListPlatformVersionsIterable
listPlatformVersionsPaginator
(ListPlatformVersionsRequest listPlatformVersionsRequest) Lists the platform versions available for your account in an AWS Region.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Return the tags applied to an AWS Elastic Beanstalk resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Return the tags applied to an AWS Elastic Beanstalk resource.default RebuildEnvironmentResponse
rebuildEnvironment
(Consumer<RebuildEnvironmentRequest.Builder> rebuildEnvironmentRequest) Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.default RebuildEnvironmentResponse
rebuildEnvironment
(RebuildEnvironmentRequest rebuildEnvironmentRequest) Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.default RequestEnvironmentInfoResponse
requestEnvironmentInfo
(Consumer<RequestEnvironmentInfoRequest.Builder> requestEnvironmentInfoRequest) Initiates a request to compile the specified type of information of the deployed environment.default RequestEnvironmentInfoResponse
requestEnvironmentInfo
(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) Initiates a request to compile the specified type of information of the deployed environment.default RestartAppServerResponse
restartAppServer
(Consumer<RestartAppServerRequest.Builder> restartAppServerRequest) Causes the environment to restart the application container server running on each Amazon EC2 instance.default RestartAppServerResponse
restartAppServer
(RestartAppServerRequest restartAppServerRequest) Causes the environment to restart the application container server running on each Amazon EC2 instance.default RetrieveEnvironmentInfoResponse
retrieveEnvironmentInfo
(Consumer<RetrieveEnvironmentInfoRequest.Builder> retrieveEnvironmentInfoRequest) Retrieves the compiled information from a RequestEnvironmentInfo request.default RetrieveEnvironmentInfoResponse
retrieveEnvironmentInfo
(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) Retrieves the compiled information from a RequestEnvironmentInfo request.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default SwapEnvironmentCnamEsResponse
swapEnvironmentCNAMEs
(Consumer<SwapEnvironmentCnamEsRequest.Builder> swapEnvironmentCnamEsRequest) Swaps the CNAMEs of two environments.default SwapEnvironmentCnamEsResponse
swapEnvironmentCNAMEs
(SwapEnvironmentCnamEsRequest swapEnvironmentCnamEsRequest) Swaps the CNAMEs of two environments.default TerminateEnvironmentResponse
terminateEnvironment
(Consumer<TerminateEnvironmentRequest.Builder> terminateEnvironmentRequest) Terminates the specified environment.default TerminateEnvironmentResponse
terminateEnvironment
(TerminateEnvironmentRequest terminateEnvironmentRequest) Terminates the specified environment.default UpdateApplicationResponse
updateApplication
(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) Updates the specified application to have the specified properties.default UpdateApplicationResponse
updateApplication
(UpdateApplicationRequest updateApplicationRequest) Updates the specified application to have the specified properties.updateApplicationResourceLifecycle
(Consumer<UpdateApplicationResourceLifecycleRequest.Builder> updateApplicationResourceLifecycleRequest) Modifies lifecycle settings for an application.updateApplicationResourceLifecycle
(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest) Modifies lifecycle settings for an application.default UpdateApplicationVersionResponse
updateApplicationVersion
(Consumer<UpdateApplicationVersionRequest.Builder> updateApplicationVersionRequest) Updates the specified application version to have the specified properties.default UpdateApplicationVersionResponse
updateApplicationVersion
(UpdateApplicationVersionRequest updateApplicationVersionRequest) Updates the specified application version to have the specified properties.updateConfigurationTemplate
(Consumer<UpdateConfigurationTemplateRequest.Builder> updateConfigurationTemplateRequest) Updates the specified configuration template to have the specified properties or configuration option values.updateConfigurationTemplate
(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) Updates the specified configuration template to have the specified properties or configuration option values.default UpdateEnvironmentResponse
updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.default UpdateEnvironmentResponse
updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.default UpdateTagsForResourceResponse
updateTagsForResource
(Consumer<UpdateTagsForResourceRequest.Builder> updateTagsForResourceRequest) Update the list of tags applied to an AWS Elastic Beanstalk resource.default UpdateTagsForResourceResponse
updateTagsForResource
(UpdateTagsForResourceRequest updateTagsForResourceRequest) Update the list of tags applied to an AWS Elastic Beanstalk resource.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.validateConfigurationSettings
(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.default ElasticBeanstalkWaiter
waiter()
Create an instance ofElasticBeanstalkWaiter
using this client.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
abortEnvironmentUpdate
default AbortEnvironmentUpdateResponse abortEnvironmentUpdate(AbortEnvironmentUpdateRequest abortEnvironmentUpdateRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Cancels in-progress environment configuration update or application version deployment.
- Parameters:
abortEnvironmentUpdateRequest
-- Returns:
- Result of the AbortEnvironmentUpdate operation returned by the service.
- See Also:
-
abortEnvironmentUpdate
default AbortEnvironmentUpdateResponse abortEnvironmentUpdate(Consumer<AbortEnvironmentUpdateRequest.Builder> abortEnvironmentUpdateRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Cancels in-progress environment configuration update or application version deployment.
This is a convenience which creates an instance of the
AbortEnvironmentUpdateRequest.Builder
avoiding the need to create one manually viaAbortEnvironmentUpdateRequest.builder()
- Parameters:
abortEnvironmentUpdateRequest
- AConsumer
that will call methods onAbortEnvironmentUpdateRequest.Builder
to create a request.- Returns:
- Result of the AbortEnvironmentUpdate operation returned by the service.
- See Also:
-
applyEnvironmentManagedAction
default ApplyEnvironmentManagedActionResponse applyEnvironmentManagedAction(ApplyEnvironmentManagedActionRequest applyEnvironmentManagedActionRequest) throws ElasticBeanstalkServiceException, ManagedActionInvalidStateException, AwsServiceException, SdkClientException, ElasticBeanstalkException Applies a scheduled managed action immediately. A managed action can be applied only if its status is
Scheduled
. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.- Parameters:
applyEnvironmentManagedActionRequest
- Request to execute a scheduled managed action immediately.- Returns:
- Result of the ApplyEnvironmentManagedAction operation returned by the service.
- See Also:
-
applyEnvironmentManagedAction
default ApplyEnvironmentManagedActionResponse applyEnvironmentManagedAction(Consumer<ApplyEnvironmentManagedActionRequest.Builder> applyEnvironmentManagedActionRequest) throws ElasticBeanstalkServiceException, ManagedActionInvalidStateException, AwsServiceException, SdkClientException, ElasticBeanstalkException Applies a scheduled managed action immediately. A managed action can be applied only if its status is
Scheduled
. Get the status and action ID of a managed action with DescribeEnvironmentManagedActions.
This is a convenience which creates an instance of the
ApplyEnvironmentManagedActionRequest.Builder
avoiding the need to create one manually viaApplyEnvironmentManagedActionRequest.builder()
- Parameters:
applyEnvironmentManagedActionRequest
- AConsumer
that will call methods onApplyEnvironmentManagedActionRequest.Builder
to create a request. Request to execute a scheduled managed action immediately.- Returns:
- Result of the ApplyEnvironmentManagedAction operation returned by the service.
- See Also:
-
associateEnvironmentOperationsRole
default AssociateEnvironmentOperationsRoleResponse associateEnvironmentOperationsRole(AssociateEnvironmentOperationsRoleRequest associateEnvironmentOperationsRoleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the AssociateEnvironmentOperationsRole operation returned by the service.
- See Also:
-
associateEnvironmentOperationsRole
default AssociateEnvironmentOperationsRoleResponse associateEnvironmentOperationsRole(Consumer<AssociateEnvironmentOperationsRoleRequest.Builder> associateEnvironmentOperationsRoleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaAssociateEnvironmentOperationsRoleRequest.builder()
- Parameters:
associateEnvironmentOperationsRoleRequest
- AConsumer
that will call methods onAssociateEnvironmentOperationsRoleRequest.Builder
to create a request. Request to add or change the operations role used by an environment.- Returns:
- Result of the AssociateEnvironmentOperationsRole operation returned by the service.
- See Also:
-
checkDNSAvailability
default CheckDnsAvailabilityResponse checkDNSAvailability(CheckDnsAvailabilityRequest checkDnsAvailabilityRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Checks if the specified CNAME is available.
- Parameters:
checkDnsAvailabilityRequest
- Results message indicating whether a CNAME is available.- Returns:
- Result of the CheckDNSAvailability operation returned by the service.
- See Also:
-
checkDNSAvailability
default CheckDnsAvailabilityResponse checkDNSAvailability(Consumer<CheckDnsAvailabilityRequest.Builder> checkDnsAvailabilityRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Checks if the specified CNAME is available.
This is a convenience which creates an instance of the
CheckDnsAvailabilityRequest.Builder
avoiding the need to create one manually viaCheckDnsAvailabilityRequest.builder()
- Parameters:
checkDnsAvailabilityRequest
- AConsumer
that will call methods onCheckDnsAvailabilityRequest.Builder
to create a request. Results message indicating whether a CNAME is available.- Returns:
- Result of the CheckDNSAvailability operation returned by the service.
- See Also:
-
composeEnvironments
default ComposeEnvironmentsResponse composeEnvironments(ComposeEnvironmentsRequest composeEnvironmentsRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named
env.yaml
. See Compose Environments for details.- Parameters:
composeEnvironmentsRequest
- Request to create or update a group of environments.- Returns:
- Result of the ComposeEnvironments operation returned by the service.
- See Also:
-
composeEnvironments
default ComposeEnvironmentsResponse composeEnvironments(Consumer<ComposeEnvironmentsRequest.Builder> composeEnvironmentsRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Create or update a group of environments that each run a separate component of a single application. Takes a list of version labels that specify application source bundles for each of the environments to create or update. The name of each environment and other required information must be included in the source bundles in an environment manifest named
env.yaml
. See Compose Environments for details.
This is a convenience which creates an instance of the
ComposeEnvironmentsRequest.Builder
avoiding the need to create one manually viaComposeEnvironmentsRequest.builder()
- Parameters:
composeEnvironmentsRequest
- AConsumer
that will call methods onComposeEnvironmentsRequest.Builder
to create a request. Request to create or update a group of environments.- Returns:
- Result of the ComposeEnvironments operation returned by the service.
- See Also:
-
createApplication
default CreateApplicationResponse createApplication(CreateApplicationRequest createApplicationRequest) throws TooManyApplicationsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Creates an application that has one configuration template named
default
and no application versions.- Parameters:
createApplicationRequest
- Request to create an application.- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createApplication
default CreateApplicationResponse createApplication(Consumer<CreateApplicationRequest.Builder> createApplicationRequest) throws TooManyApplicationsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Creates an application that has one configuration template named
default
and no application versions.
This is a convenience which creates an instance of the
CreateApplicationRequest.Builder
avoiding the need to create one manually viaCreateApplicationRequest.builder()
- Parameters:
createApplicationRequest
- AConsumer
that will call methods onCreateApplicationRequest.Builder
to create a request. Request to create an application.- Returns:
- Result of the CreateApplication operation returned by the service.
- See Also:
-
createApplicationVersion
default CreateApplicationVersionResponse createApplicationVersion(CreateApplicationVersionRequest createApplicationVersionRequest) throws TooManyApplicationsException, TooManyApplicationVersionsException, InsufficientPrivilegesException, S3LocationNotInServiceRegionException, CodeBuildNotInServiceRegionException, AwsServiceException, SdkClientException, ElasticBeanstalkException Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with
SourceBuildInformation
.Specify a build in an AWS CodeBuild with
SourceBuildInformation
andBuildConfiguration
.Specify a source bundle in S3 with
SourceBundle
Omit both
SourceBuildInformation
andSourceBundle
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:
- Result of the CreateApplicationVersion operation returned by the service.
- See Also:
-
createApplicationVersion
default CreateApplicationVersionResponse createApplicationVersion(Consumer<CreateApplicationVersionRequest.Builder> createApplicationVersionRequest) throws TooManyApplicationsException, TooManyApplicationVersionsException, InsufficientPrivilegesException, S3LocationNotInServiceRegionException, CodeBuildNotInServiceRegionException, AwsServiceException, SdkClientException, ElasticBeanstalkException Creates an application version for the specified application. You can create an application version from a source bundle in Amazon S3, a commit in AWS CodeCommit, or the output of an AWS CodeBuild build as follows:
Specify a commit in an AWS CodeCommit repository with
SourceBuildInformation
.Specify a build in an AWS CodeBuild with
SourceBuildInformation
andBuildConfiguration
.Specify a source bundle in S3 with
SourceBundle
Omit both
SourceBuildInformation
andSourceBundle
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 viaCreateApplicationVersionRequest.builder()
- Parameters:
createApplicationVersionRequest
- AConsumer
that will call methods onCreateApplicationVersionRequest.Builder
to create a request.- Returns:
- Result of the CreateApplicationVersion operation returned by the service.
- See Also:
-
createConfigurationTemplate
default CreateConfigurationTemplateResponse createConfigurationTemplate(CreateConfigurationTemplateRequest createConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, TooManyConfigurationTemplatesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 alwaysnull
.Related Topics
- Parameters:
createConfigurationTemplateRequest
- Request to create a configuration template.- Returns:
- Result of the CreateConfigurationTemplate operation returned by the service.
- See Also:
-
createConfigurationTemplate
default CreateConfigurationTemplateResponse createConfigurationTemplate(Consumer<CreateConfigurationTemplateRequest.Builder> createConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, TooManyConfigurationTemplatesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 alwaysnull
.Related Topics
This is a convenience which creates an instance of the
CreateConfigurationTemplateRequest.Builder
avoiding the need to create one manually viaCreateConfigurationTemplateRequest.builder()
- Parameters:
createConfigurationTemplateRequest
- AConsumer
that will call methods onCreateConfigurationTemplateRequest.Builder
to create a request. Request to create a configuration template.- Returns:
- Result of the CreateConfigurationTemplate operation returned by the service.
- See Also:
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Launches an AWS Elastic Beanstalk environment for the specified application using the specified configuration.
- Parameters:
createEnvironmentRequest
-- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
createEnvironment
default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) throws TooManyEnvironmentsException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaCreateEnvironmentRequest.builder()
- Parameters:
createEnvironmentRequest
- AConsumer
that will call methods onCreateEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
createPlatformVersion
default CreatePlatformVersionResponse createPlatformVersion(CreatePlatformVersionRequest createPlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, TooManyPlatformsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Create a new version of your custom platform.
- Parameters:
createPlatformVersionRequest
- Request to create a new platform version.- Returns:
- Result of the CreatePlatformVersion operation returned by the service.
- See Also:
-
createPlatformVersion
default CreatePlatformVersionResponse createPlatformVersion(Consumer<CreatePlatformVersionRequest.Builder> createPlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, TooManyPlatformsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Create a new version of your custom platform.
This is a convenience which creates an instance of the
CreatePlatformVersionRequest.Builder
avoiding the need to create one manually viaCreatePlatformVersionRequest.builder()
- Parameters:
createPlatformVersionRequest
- AConsumer
that will call methods onCreatePlatformVersionRequest.Builder
to create a request. Request to create a new platform version.- Returns:
- Result of the CreatePlatformVersion operation returned by the service.
- See Also:
-
createStorageLocation
default CreateStorageLocationResponse createStorageLocation(CreateStorageLocationRequest createStorageLocationRequest) throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the CreateStorageLocation operation returned by the service.
- See Also:
-
createStorageLocation
default CreateStorageLocationResponse createStorageLocation(Consumer<CreateStorageLocationRequest.Builder> createStorageLocationRequest) throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaCreateStorageLocationRequest.builder()
- Parameters:
createStorageLocationRequest
- AConsumer
that will call methods onCreateStorageLocationRequest.Builder
to create a request.- Returns:
- Result of the CreateStorageLocation operation returned by the service.
- See Also:
-
createStorageLocation
default CreateStorageLocationResponse createStorageLocation() throws TooManyBucketsException, S3SubscriptionRequiredException, InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkExceptionCreates 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:
- Result of the CreateStorageLocation operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(DeleteApplicationRequest deleteApplicationRequest) throws OperationInProgressException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment.
- Parameters:
deleteApplicationRequest
- Request to delete an application.- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteApplication
default DeleteApplicationResponse deleteApplication(Consumer<DeleteApplicationRequest.Builder> deleteApplicationRequest) throws OperationInProgressException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified application along with all associated versions and configurations. The application versions will not be deleted from your Amazon S3 bucket.
You cannot delete an application that has a running environment.
This is a convenience which creates an instance of the
DeleteApplicationRequest.Builder
avoiding the need to create one manually viaDeleteApplicationRequest.builder()
- Parameters:
deleteApplicationRequest
- AConsumer
that will call methods onDeleteApplicationRequest.Builder
to create a request. Request to delete an application.- Returns:
- Result of the DeleteApplication operation returned by the service.
- See Also:
-
deleteApplicationVersion
default DeleteApplicationVersionResponse deleteApplicationVersion(DeleteApplicationVersionRequest deleteApplicationVersionRequest) throws SourceBundleDeletionException, InsufficientPrivilegesException, OperationInProgressException, S3LocationNotInServiceRegionException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
- Parameters:
deleteApplicationVersionRequest
- Request to delete an application version.- Returns:
- Result of the DeleteApplicationVersion operation returned by the service.
- See Also:
-
deleteApplicationVersion
default DeleteApplicationVersionResponse deleteApplicationVersion(Consumer<DeleteApplicationVersionRequest.Builder> deleteApplicationVersionRequest) throws SourceBundleDeletionException, InsufficientPrivilegesException, OperationInProgressException, S3LocationNotInServiceRegionException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified version from the specified application.
You cannot delete an application version that is associated with a running environment.
This is a convenience which creates an instance of the
DeleteApplicationVersionRequest.Builder
avoiding the need to create one manually viaDeleteApplicationVersionRequest.builder()
- Parameters:
deleteApplicationVersionRequest
- AConsumer
that will call methods onDeleteApplicationVersionRequest.Builder
to create a request. Request to delete an application version.- Returns:
- Result of the DeleteApplicationVersion operation returned by the service.
- See Also:
-
deleteConfigurationTemplate
default DeleteConfigurationTemplateResponse deleteConfigurationTemplate(DeleteConfigurationTemplateRequest deleteConfigurationTemplateRequest) throws OperationInProgressException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified configuration template.
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
- Parameters:
deleteConfigurationTemplateRequest
- Request to delete a configuration template.- Returns:
- Result of the DeleteConfigurationTemplate operation returned by the service.
- See Also:
-
deleteConfigurationTemplate
default DeleteConfigurationTemplateResponse deleteConfigurationTemplate(Consumer<DeleteConfigurationTemplateRequest.Builder> deleteConfigurationTemplateRequest) throws OperationInProgressException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified configuration template.
When you launch an environment using a configuration template, the environment gets a copy of the template. You can delete or modify the environment's copy of the template without affecting the running environment.
This is a convenience which creates an instance of the
DeleteConfigurationTemplateRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationTemplateRequest.builder()
- Parameters:
deleteConfigurationTemplateRequest
- AConsumer
that will call methods onDeleteConfigurationTemplateRequest.Builder
to create a request. Request to delete a configuration template.- Returns:
- Result of the DeleteConfigurationTemplate operation returned by the service.
- See Also:
-
deleteEnvironmentConfiguration
default DeleteEnvironmentConfigurationResponse deleteEnvironmentConfiguration(DeleteEnvironmentConfigurationRequest deleteEnvironmentConfigurationRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The
DeploymentStatus
for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.- Parameters:
deleteEnvironmentConfigurationRequest
- Request to delete a draft environment configuration.- Returns:
- Result of the DeleteEnvironmentConfiguration operation returned by the service.
- See Also:
-
deleteEnvironmentConfiguration
default DeleteEnvironmentConfigurationResponse deleteEnvironmentConfiguration(Consumer<DeleteEnvironmentConfigurationRequest.Builder> deleteEnvironmentConfigurationRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the draft configuration associated with the running environment.
Updating a running environment with any configuration changes creates a draft configuration set. You can get the draft configuration using DescribeConfigurationSettings while the update is in progress or if the update fails. The
DeploymentStatus
for the draft configuration indicates whether the deployment is in process or has failed. The draft configuration remains in existence until it is deleted with this action.
This is a convenience which creates an instance of the
DeleteEnvironmentConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentConfigurationRequest.builder()
- Parameters:
deleteEnvironmentConfigurationRequest
- AConsumer
that will call methods onDeleteEnvironmentConfigurationRequest.Builder
to create a request. Request to delete a draft environment configuration.- Returns:
- Result of the DeleteEnvironmentConfiguration operation returned by the service.
- See Also:
-
deletePlatformVersion
default DeletePlatformVersionResponse deletePlatformVersion(DeletePlatformVersionRequest deletePlatformVersionRequest) throws OperationInProgressException, InsufficientPrivilegesException, ElasticBeanstalkServiceException, PlatformVersionStillReferencedException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified version of a custom platform.
- Parameters:
deletePlatformVersionRequest
-- Returns:
- Result of the DeletePlatformVersion operation returned by the service.
- See Also:
-
deletePlatformVersion
default DeletePlatformVersionResponse deletePlatformVersion(Consumer<DeletePlatformVersionRequest.Builder> deletePlatformVersionRequest) throws OperationInProgressException, InsufficientPrivilegesException, ElasticBeanstalkServiceException, PlatformVersionStillReferencedException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes the specified version of a custom platform.
This is a convenience which creates an instance of the
DeletePlatformVersionRequest.Builder
avoiding the need to create one manually viaDeletePlatformVersionRequest.builder()
- Parameters:
deletePlatformVersionRequest
- AConsumer
that will call methods onDeletePlatformVersionRequest.Builder
to create a request.- Returns:
- Result of the DeletePlatformVersion operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes(Consumer<DescribeAccountAttributesRequest.Builder> describeAccountAttributesRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaDescribeAccountAttributesRequest.builder()
- Parameters:
describeAccountAttributesRequest
- AConsumer
that will call methods onDescribeAccountAttributesRequest.Builder
to create a request.- Returns:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeAccountAttributes
default DescribeAccountAttributesResponse describeAccountAttributes() throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns 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:
- Result of the DescribeAccountAttributes operation returned by the service.
- See Also:
-
describeApplicationVersions
default DescribeApplicationVersionsResponse describeApplicationVersions(DescribeApplicationVersionsRequest describeApplicationVersionsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Retrieve a list of application versions.
- Parameters:
describeApplicationVersionsRequest
- Request to describe application versions.- Returns:
- Result of the DescribeApplicationVersions operation returned by the service.
- See Also:
-
describeApplicationVersions
default DescribeApplicationVersionsResponse describeApplicationVersions(Consumer<DescribeApplicationVersionsRequest.Builder> describeApplicationVersionsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Retrieve a list of application versions.
This is a convenience which creates an instance of the
DescribeApplicationVersionsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationVersionsRequest.builder()
- Parameters:
describeApplicationVersionsRequest
- AConsumer
that will call methods onDescribeApplicationVersionsRequest.Builder
to create a request. Request to describe application versions.- Returns:
- Result of the DescribeApplicationVersions operation returned by the service.
- See Also:
-
describeApplicationVersions
default DescribeApplicationVersionsResponse describeApplicationVersions() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionRetrieve a list of application versions.
- Returns:
- Result of the DescribeApplicationVersions operation returned by the service.
- See Also:
-
describeApplications
default DescribeApplicationsResponse describeApplications(DescribeApplicationsRequest describeApplicationsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns the descriptions of existing applications.
- Parameters:
describeApplicationsRequest
- Request to describe one or more applications.- Returns:
- Result of the DescribeApplications operation returned by the service.
- See Also:
-
describeApplications
default DescribeApplicationsResponse describeApplications(Consumer<DescribeApplicationsRequest.Builder> describeApplicationsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns the descriptions of existing applications.
This is a convenience which creates an instance of the
DescribeApplicationsRequest.Builder
avoiding the need to create one manually viaDescribeApplicationsRequest.builder()
- Parameters:
describeApplicationsRequest
- AConsumer
that will call methods onDescribeApplicationsRequest.Builder
to create a request. Request to describe one or more applications.- Returns:
- Result of the DescribeApplications operation returned by the service.
- See Also:
-
describeApplications
default DescribeApplicationsResponse describeApplications() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns the descriptions of existing applications.
- Returns:
- Result of the DescribeApplications operation returned by the service.
- See Also:
-
describeConfigurationOptions
default DescribeConfigurationOptionsResponse describeConfigurationOptions(DescribeConfigurationOptionsRequest describeConfigurationOptionsRequest) throws TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
- Parameters:
describeConfigurationOptionsRequest
- Result message containing a list of application version descriptions.- Returns:
- Result of the DescribeConfigurationOptions operation returned by the service.
- See Also:
-
describeConfigurationOptions
default DescribeConfigurationOptionsResponse describeConfigurationOptions(Consumer<DescribeConfigurationOptionsRequest.Builder> describeConfigurationOptionsRequest) throws TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.
This is a convenience which creates an instance of the
DescribeConfigurationOptionsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationOptionsRequest.builder()
- Parameters:
describeConfigurationOptionsRequest
- AConsumer
that will call methods onDescribeConfigurationOptionsRequest.Builder
to create a request. Result message containing a list of application version descriptions.- Returns:
- Result of the DescribeConfigurationOptions operation returned by the service.
- See Also:
-
describeConfigurationSettings
default DescribeConfigurationSettingsResponse describeConfigurationSettings(DescribeConfigurationSettingsRequest describeConfigurationSettingsRequest) throws TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
- Parameters:
describeConfigurationSettingsRequest
- Result message containing all of the configuration settings for a specified solution stack or configuration template.- Returns:
- Result of the DescribeConfigurationSettings operation returned by the service.
- See Also:
-
describeConfigurationSettings
default DescribeConfigurationSettingsResponse describeConfigurationSettings(Consumer<DescribeConfigurationSettingsRequest.Builder> describeConfigurationSettingsRequest) throws TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.
When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.
Related Topics
This is a convenience which creates an instance of the
DescribeConfigurationSettingsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationSettingsRequest.builder()
- Parameters:
describeConfigurationSettingsRequest
- AConsumer
that will call methods onDescribeConfigurationSettingsRequest.Builder
to create a request. Result message containing all of the configuration settings for a specified solution stack or configuration template.- Returns:
- Result of the DescribeConfigurationSettings operation returned by the service.
- See Also:
-
describeEnvironmentHealth
default DescribeEnvironmentHealthResponse describeEnvironmentHealth(DescribeEnvironmentHealthRequest describeEnvironmentHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
- Parameters:
describeEnvironmentHealthRequest
- See the example below to learn how to create a request body.- Returns:
- Result of the DescribeEnvironmentHealth operation returned by the service.
- See Also:
-
describeEnvironmentHealth
default DescribeEnvironmentHealthResponse describeEnvironmentHealth(Consumer<DescribeEnvironmentHealthRequest.Builder> describeEnvironmentHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns information about the overall health of the specified environment. The DescribeEnvironmentHealth operation is only available with AWS Elastic Beanstalk Enhanced Health.
This is a convenience which creates an instance of the
DescribeEnvironmentHealthRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentHealthRequest.builder()
- Parameters:
describeEnvironmentHealthRequest
- AConsumer
that will call methods onDescribeEnvironmentHealthRequest.Builder
to create a request. See the example below to learn how to create a request body.- Returns:
- Result of the DescribeEnvironmentHealth operation returned by the service.
- See Also:
-
describeEnvironmentManagedActionHistory
default DescribeEnvironmentManagedActionHistoryResponse describeEnvironmentManagedActionHistory(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's completed and failed managed actions.
- Parameters:
describeEnvironmentManagedActionHistoryRequest
- Request to list completed and failed managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
- See Also:
-
describeEnvironmentManagedActionHistory
default DescribeEnvironmentManagedActionHistoryResponse describeEnvironmentManagedActionHistory(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's completed and failed managed actions.
This is a convenience which creates an instance of the
DescribeEnvironmentManagedActionHistoryRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentManagedActionHistoryRequest.builder()
- Parameters:
describeEnvironmentManagedActionHistoryRequest
- AConsumer
that will call methods onDescribeEnvironmentManagedActionHistoryRequest.Builder
to create a request. Request to list completed and failed managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActionHistory operation returned by the service.
- See Also:
-
describeEnvironmentManagedActionHistoryPaginator
default DescribeEnvironmentManagedActionHistoryIterable describeEnvironmentManagedActionHistoryPaginator(DescribeEnvironmentManagedActionHistoryRequest describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's completed and failed managed actions.
This is a variant of
describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client.describeEnvironmentManagedActionHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client .describeEnvironmentManagedActionHistoryPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client.describeEnvironmentManagedActionHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEnvironmentManagedActionHistoryPaginator
default DescribeEnvironmentManagedActionHistoryIterable describeEnvironmentManagedActionHistoryPaginator(Consumer<DescribeEnvironmentManagedActionHistoryRequest.Builder> describeEnvironmentManagedActionHistoryRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's completed and failed managed actions.
This is a variant of
describeEnvironmentManagedActionHistory(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client.describeEnvironmentManagedActionHistoryPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client .describeEnvironmentManagedActionHistoryPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentManagedActionHistoryResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEnvironmentManagedActionHistoryIterable responses = client.describeEnvironmentManagedActionHistoryPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeEnvironmentManagedActionHistoryRequest.builder()
- Parameters:
describeEnvironmentManagedActionHistoryRequest
- AConsumer
that will call methods onDescribeEnvironmentManagedActionHistoryRequest.Builder
to create a request. Request to list completed and failed managed actions.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEnvironmentManagedActions
default DescribeEnvironmentManagedActionsResponse describeEnvironmentManagedActions(DescribeEnvironmentManagedActionsRequest describeEnvironmentManagedActionsRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's upcoming and in-progress managed actions.
- Parameters:
describeEnvironmentManagedActionsRequest
- Request to list an environment's upcoming and in-progress managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActions operation returned by the service.
- See Also:
-
describeEnvironmentManagedActions
default DescribeEnvironmentManagedActionsResponse describeEnvironmentManagedActions(Consumer<DescribeEnvironmentManagedActionsRequest.Builder> describeEnvironmentManagedActionsRequest) throws ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException Lists an environment's upcoming and in-progress managed actions.
This is a convenience which creates an instance of the
DescribeEnvironmentManagedActionsRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentManagedActionsRequest.builder()
- Parameters:
describeEnvironmentManagedActionsRequest
- AConsumer
that will call methods onDescribeEnvironmentManagedActionsRequest.Builder
to create a request. Request to list an environment's upcoming and in-progress managed actions.- Returns:
- Result of the DescribeEnvironmentManagedActions operation returned by the service.
- See Also:
-
describeEnvironmentResources
default DescribeEnvironmentResourcesResponse describeEnvironmentResources(DescribeEnvironmentResourcesRequest describeEnvironmentResourcesRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns AWS resources for this environment.
- Parameters:
describeEnvironmentResourcesRequest
- Request to describe the resources in an environment.- Returns:
- Result of the DescribeEnvironmentResources operation returned by the service.
- See Also:
-
describeEnvironmentResources
default DescribeEnvironmentResourcesResponse describeEnvironmentResources(Consumer<DescribeEnvironmentResourcesRequest.Builder> describeEnvironmentResourcesRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Returns AWS resources for this environment.
This is a convenience which creates an instance of the
DescribeEnvironmentResourcesRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentResourcesRequest.builder()
- Parameters:
describeEnvironmentResourcesRequest
- AConsumer
that will call methods onDescribeEnvironmentResourcesRequest.Builder
to create a request. Request to describe the resources in an environment.- Returns:
- Result of the DescribeEnvironmentResources operation returned by the service.
- See Also:
-
describeEnvironments
default DescribeEnvironmentsResponse describeEnvironments(DescribeEnvironmentsRequest describeEnvironmentsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns descriptions for existing environments.
- Parameters:
describeEnvironmentsRequest
- Request to describe one or more environments.- Returns:
- Result of the DescribeEnvironments operation returned by the service.
- See Also:
-
describeEnvironments
default DescribeEnvironmentsResponse describeEnvironments(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns descriptions for existing environments.
This is a convenience which creates an instance of the
DescribeEnvironmentsRequest.Builder
avoiding the need to create one manually viaDescribeEnvironmentsRequest.builder()
- Parameters:
describeEnvironmentsRequest
- AConsumer
that will call methods onDescribeEnvironmentsRequest.Builder
to create a request. Request to describe one or more environments.- Returns:
- Result of the DescribeEnvironments operation returned by the service.
- See Also:
-
describeEnvironments
default DescribeEnvironmentsResponse describeEnvironments() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns descriptions for existing environments.
- Returns:
- Result of the DescribeEnvironments operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified
NextToken
.- Parameters:
describeEventsRequest
- Request to retrieve a list of events for an environment.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified
NextToken
.
This is a convenience which creates an instance of the
DescribeEventsRequest.Builder
avoiding the need to create one manually viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Request to retrieve a list of events for an environment.- Returns:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEvents
default DescribeEventsResponse describeEvents() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns 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:
- Result of the DescribeEvents operation returned by the service.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns 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 variant of
describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(DescribeEventsRequest describeEventsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified
NextToken
.
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
describeEventsPaginator
default DescribeEventsIterable describeEventsPaginator(Consumer<DescribeEventsRequest.Builder> describeEventsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns list of event descriptions matching criteria up to the last 6 weeks.
This action returns the most recent 1,000 events from the specified
NextToken
.
This is a variant of
describeEvents(software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client .describeEventsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEventsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.DescribeEventsIterable responses = client.describeEventsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaDescribeEventsRequest.builder()
- Parameters:
describeEventsRequest
- AConsumer
that will call methods onDescribeEventsRequest.Builder
to create a request. Request to retrieve a list of events for an environment.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
describeInstancesHealth
default DescribeInstancesHealthResponse describeInstancesHealth(DescribeInstancesHealthRequest describeInstancesHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 toDescribeInstancesHealth
.- Returns:
- Result of the DescribeInstancesHealth operation returned by the service.
- See Also:
-
describeInstancesHealth
default DescribeInstancesHealthResponse describeInstancesHealth(Consumer<DescribeInstancesHealthRequest.Builder> describeInstancesHealthRequest) throws InvalidRequestException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaDescribeInstancesHealthRequest.builder()
- Parameters:
describeInstancesHealthRequest
- AConsumer
that will call methods onDescribeInstancesHealthRequest.Builder
to create a request. Parameters for a call toDescribeInstancesHealth
.- Returns:
- Result of the DescribeInstancesHealth operation returned by the service.
- See Also:
-
describePlatformVersion
default DescribePlatformVersionResponse describePlatformVersion(DescribePlatformVersionRequest describePlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the DescribePlatformVersion operation returned by the service.
- See Also:
-
describePlatformVersion
default DescribePlatformVersionResponse describePlatformVersion(Consumer<DescribePlatformVersionRequest.Builder> describePlatformVersionRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaDescribePlatformVersionRequest.builder()
- Parameters:
describePlatformVersionRequest
- AConsumer
that will call methods onDescribePlatformVersionRequest.Builder
to create a request.- Returns:
- Result of the DescribePlatformVersion operation returned by the service.
- See Also:
-
disassociateEnvironmentOperationsRole
default DisassociateEnvironmentOperationsRoleResponse disassociateEnvironmentOperationsRole(DisassociateEnvironmentOperationsRoleRequest disassociateEnvironmentOperationsRoleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the DisassociateEnvironmentOperationsRole operation returned by the service.
- See Also:
-
disassociateEnvironmentOperationsRole
default DisassociateEnvironmentOperationsRoleResponse disassociateEnvironmentOperationsRole(Consumer<DisassociateEnvironmentOperationsRoleRequest.Builder> disassociateEnvironmentOperationsRoleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaDisassociateEnvironmentOperationsRoleRequest.builder()
- Parameters:
disassociateEnvironmentOperationsRoleRequest
- AConsumer
that will call methods onDisassociateEnvironmentOperationsRoleRequest.Builder
to create a request. Request to disassociate the operations role from an environment.- Returns:
- Result of the DisassociateEnvironmentOperationsRole operation returned by the service.
- See Also:
-
listAvailableSolutionStacks
default ListAvailableSolutionStacksResponse listAvailableSolutionStacks(ListAvailableSolutionStacksRequest listAvailableSolutionStacksRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
- Parameters:
listAvailableSolutionStacksRequest
-- Returns:
- Result of the ListAvailableSolutionStacks operation returned by the service.
- See Also:
-
listAvailableSolutionStacks
default ListAvailableSolutionStacksResponse listAvailableSolutionStacks(Consumer<ListAvailableSolutionStacksRequest.Builder> listAvailableSolutionStacksRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Returns a list of the available solution stack names, with the public version first and then in reverse chronological order.
This is a convenience which creates an instance of the
ListAvailableSolutionStacksRequest.Builder
avoiding the need to create one manually viaListAvailableSolutionStacksRequest.builder()
- Parameters:
listAvailableSolutionStacksRequest
- AConsumer
that will call methods onListAvailableSolutionStacksRequest.Builder
to create a request.- Returns:
- Result of the ListAvailableSolutionStacks operation returned by the service.
- See Also:
-
listAvailableSolutionStacks
default ListAvailableSolutionStacksResponse listAvailableSolutionStacks() throws AwsServiceException, SdkClientException, ElasticBeanstalkExceptionReturns a list of the available solution stack names, with the public version first and then in reverse chronological order.
- Returns:
- Result of the ListAvailableSolutionStacks operation returned by the service.
- See Also:
-
listPlatformBranches
default ListPlatformBranchesResponse listPlatformBranches(ListPlatformBranchesRequest listPlatformBranchesRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the ListPlatformBranches operation returned by the service.
- See Also:
-
listPlatformBranches
default ListPlatformBranchesResponse listPlatformBranches(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaListPlatformBranchesRequest.builder()
- Parameters:
listPlatformBranchesRequest
- AConsumer
that will call methods onListPlatformBranchesRequest.Builder
to create a request.- Returns:
- Result of the ListPlatformBranches operation returned by the service.
- See Also:
-
listPlatformBranchesPaginator
default ListPlatformBranchesIterable listPlatformBranchesPaginator(ListPlatformBranchesRequest listPlatformBranchesRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException 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 variant of
listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client.listPlatformBranchesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client .listPlatformBranchesPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client.listPlatformBranchesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformBranchesPaginator
default ListPlatformBranchesIterable listPlatformBranchesPaginator(Consumer<ListPlatformBranchesRequest.Builder> listPlatformBranchesRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException 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 variant of
listPlatformBranches(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client.listPlatformBranchesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client .listPlatformBranchesPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformBranchesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformBranchesIterable responses = client.listPlatformBranchesPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPlatformBranchesRequest.builder()
- Parameters:
listPlatformBranchesRequest
- AConsumer
that will call methods onListPlatformBranchesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformVersions
default ListPlatformVersionsResponse listPlatformVersions(ListPlatformVersionsRequest listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the ListPlatformVersions operation returned by the service.
- See Also:
-
listPlatformVersions
default ListPlatformVersionsResponse listPlatformVersions(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaListPlatformVersionsRequest.builder()
- Parameters:
listPlatformVersionsRequest
- AConsumer
that will call methods onListPlatformVersionsRequest.Builder
to create a request.- Returns:
- Result of the ListPlatformVersions operation returned by the service.
- See Also:
-
listPlatformVersions
default ListPlatformVersionsResponse listPlatformVersions() throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkExceptionLists 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:
- Result of the ListPlatformVersions operation returned by the service.
- See Also:
-
listPlatformVersionsPaginator
default ListPlatformVersionsIterable listPlatformVersionsPaginator() throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkExceptionLists 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 variant of
listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client .listPlatformVersionsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformVersionsPaginator
default ListPlatformVersionsIterable listPlatformVersionsPaginator(ListPlatformVersionsRequest listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 variant of
listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client .listPlatformVersionsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listPlatformVersionsPaginator
default ListPlatformVersionsIterable listPlatformVersionsPaginator(Consumer<ListPlatformVersionsRequest.Builder> listPlatformVersionsRequest) throws InsufficientPrivilegesException, ElasticBeanstalkServiceException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 variant of
listPlatformVersions(software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client .listPlatformVersionsPaginator(request); for (software.amazon.awssdk.services.elasticbeanstalk.model.ListPlatformVersionsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.elasticbeanstalk.paginators.ListPlatformVersionsIterable responses = client.listPlatformVersionsPaginator(request); responses.iterator().forEachRemaining(....);
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 viaListPlatformVersionsRequest.builder()
- Parameters:
listPlatformVersionsRequest
- AConsumer
that will call methods onListPlatformVersionsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InsufficientPrivilegesException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InsufficientPrivilegesException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
rebuildEnvironment
default RebuildEnvironmentResponse rebuildEnvironment(RebuildEnvironmentRequest rebuildEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
- Parameters:
rebuildEnvironmentRequest
-- Returns:
- Result of the RebuildEnvironment operation returned by the service.
- See Also:
-
rebuildEnvironment
default RebuildEnvironmentResponse rebuildEnvironment(Consumer<RebuildEnvironmentRequest.Builder> rebuildEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Deletes and recreates all of the AWS resources (for example: the Auto Scaling group, load balancer, etc.) for a specified environment and forces a restart.
This is a convenience which creates an instance of the
RebuildEnvironmentRequest.Builder
avoiding the need to create one manually viaRebuildEnvironmentRequest.builder()
- Parameters:
rebuildEnvironmentRequest
- AConsumer
that will call methods onRebuildEnvironmentRequest.Builder
to create a request.- Returns:
- Result of the RebuildEnvironment operation returned by the service.
- See Also:
-
requestEnvironmentInfo
default RequestEnvironmentInfoResponse requestEnvironmentInfo(RequestEnvironmentInfoRequest requestEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Initiates a request to compile the specified type of information of the deployed environment.
Setting the
InfoType
totail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.Setting the
InfoType
tobundle
compresses the application server log files for every Amazon EC2 instance into a.zip
file. Legacy and .NET containers do not support bundle logs.Use RetrieveEnvironmentInfo to obtain the set of logs.
Related Topics
- Parameters:
requestEnvironmentInfoRequest
- Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.- Returns:
- Result of the RequestEnvironmentInfo operation returned by the service.
- See Also:
-
requestEnvironmentInfo
default RequestEnvironmentInfoResponse requestEnvironmentInfo(Consumer<RequestEnvironmentInfoRequest.Builder> requestEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Initiates a request to compile the specified type of information of the deployed environment.
Setting the
InfoType
totail
compiles the last lines from the application server log files of every Amazon EC2 instance in your environment.Setting the
InfoType
tobundle
compresses the application server log files for every Amazon EC2 instance into a.zip
file. Legacy and .NET containers do not support bundle logs.Use RetrieveEnvironmentInfo to obtain the set of logs.
Related Topics
This is a convenience which creates an instance of the
RequestEnvironmentInfoRequest.Builder
avoiding the need to create one manually viaRequestEnvironmentInfoRequest.builder()
- Parameters:
requestEnvironmentInfoRequest
- AConsumer
that will call methods onRequestEnvironmentInfoRequest.Builder
to create a request. Request to retrieve logs from an environment and store them in your Elastic Beanstalk storage bucket.- Returns:
- Result of the RequestEnvironmentInfo operation returned by the service.
- See Also:
-
restartAppServer
default RestartAppServerResponse restartAppServer(RestartAppServerRequest restartAppServerRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Causes the environment to restart the application container server running on each Amazon EC2 instance.
- Parameters:
restartAppServerRequest
-- Returns:
- Result of the RestartAppServer operation returned by the service.
- See Also:
-
restartAppServer
default RestartAppServerResponse restartAppServer(Consumer<RestartAppServerRequest.Builder> restartAppServerRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Causes the environment to restart the application container server running on each Amazon EC2 instance.
This is a convenience which creates an instance of the
RestartAppServerRequest.Builder
avoiding the need to create one manually viaRestartAppServerRequest.builder()
- Parameters:
restartAppServerRequest
- AConsumer
that will call methods onRestartAppServerRequest.Builder
to create a request.- Returns:
- Result of the RestartAppServer operation returned by the service.
- See Also:
-
retrieveEnvironmentInfo
default RetrieveEnvironmentInfoResponse retrieveEnvironmentInfo(RetrieveEnvironmentInfoRequest retrieveEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
- Parameters:
retrieveEnvironmentInfoRequest
- Request to download logs retrieved with RequestEnvironmentInfo.- Returns:
- Result of the RetrieveEnvironmentInfo operation returned by the service.
- See Also:
-
retrieveEnvironmentInfo
default RetrieveEnvironmentInfoResponse retrieveEnvironmentInfo(Consumer<RetrieveEnvironmentInfoRequest.Builder> retrieveEnvironmentInfoRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Retrieves the compiled information from a RequestEnvironmentInfo request.
Related Topics
This is a convenience which creates an instance of the
RetrieveEnvironmentInfoRequest.Builder
avoiding the need to create one manually viaRetrieveEnvironmentInfoRequest.builder()
- Parameters:
retrieveEnvironmentInfoRequest
- AConsumer
that will call methods onRetrieveEnvironmentInfoRequest.Builder
to create a request. Request to download logs retrieved with RequestEnvironmentInfo.- Returns:
- Result of the RetrieveEnvironmentInfo operation returned by the service.
- See Also:
-
swapEnvironmentCNAMEs
default SwapEnvironmentCnamEsResponse swapEnvironmentCNAMEs(SwapEnvironmentCnamEsRequest swapEnvironmentCnamEsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Swaps the CNAMEs of two environments.
- Parameters:
swapEnvironmentCnamEsRequest
- Swaps the CNAMEs of two environments.- Returns:
- Result of the SwapEnvironmentCNAMEs operation returned by the service.
- See Also:
-
swapEnvironmentCNAMEs
default SwapEnvironmentCnamEsResponse swapEnvironmentCNAMEs(Consumer<SwapEnvironmentCnamEsRequest.Builder> swapEnvironmentCnamEsRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Swaps the CNAMEs of two environments.
This is a convenience which creates an instance of the
SwapEnvironmentCnamEsRequest.Builder
avoiding the need to create one manually viaSwapEnvironmentCnamEsRequest.builder()
- Parameters:
swapEnvironmentCnamEsRequest
- AConsumer
that will call methods onSwapEnvironmentCnamEsRequest.Builder
to create a request. Swaps the CNAMEs of two environments.- Returns:
- Result of the SwapEnvironmentCNAMEs operation returned by the service.
- See Also:
-
terminateEnvironment
default TerminateEnvironmentResponse terminateEnvironment(TerminateEnvironmentRequest terminateEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Terminates the specified environment.
- Parameters:
terminateEnvironmentRequest
- Request to terminate an environment.- Returns:
- Result of the TerminateEnvironment operation returned by the service.
- See Also:
-
terminateEnvironment
default TerminateEnvironmentResponse terminateEnvironment(Consumer<TerminateEnvironmentRequest.Builder> terminateEnvironmentRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Terminates the specified environment.
This is a convenience which creates an instance of the
TerminateEnvironmentRequest.Builder
avoiding the need to create one manually viaTerminateEnvironmentRequest.builder()
- Parameters:
terminateEnvironmentRequest
- AConsumer
that will call methods onTerminateEnvironmentRequest.Builder
to create a request. Request to terminate an environment.- Returns:
- Result of the TerminateEnvironment operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(UpdateApplicationRequest updateApplicationRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified application to have the specified properties.
If a property (for example,
description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.- Parameters:
updateApplicationRequest
- Request to update an application.- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateApplication
default UpdateApplicationResponse updateApplication(Consumer<UpdateApplicationRequest.Builder> updateApplicationRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified application to have the specified properties.
If a property (for example,
description
) is not provided, the value remains unchanged. To clear these properties, specify an empty string.
This is a convenience which creates an instance of the
UpdateApplicationRequest.Builder
avoiding the need to create one manually viaUpdateApplicationRequest.builder()
- Parameters:
updateApplicationRequest
- AConsumer
that will call methods onUpdateApplicationRequest.Builder
to create a request. Request to update an application.- Returns:
- Result of the UpdateApplication operation returned by the service.
- See Also:
-
updateApplicationResourceLifecycle
default UpdateApplicationResourceLifecycleResponse updateApplicationResourceLifecycle(UpdateApplicationResourceLifecycleRequest updateApplicationResourceLifecycleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Modifies lifecycle settings for an application.
- Parameters:
updateApplicationResourceLifecycleRequest
-- Returns:
- Result of the UpdateApplicationResourceLifecycle operation returned by the service.
- See Also:
-
updateApplicationResourceLifecycle
default UpdateApplicationResourceLifecycleResponse updateApplicationResourceLifecycle(Consumer<UpdateApplicationResourceLifecycleRequest.Builder> updateApplicationResourceLifecycleRequest) throws InsufficientPrivilegesException, AwsServiceException, SdkClientException, ElasticBeanstalkException Modifies lifecycle settings for an application.
This is a convenience which creates an instance of the
UpdateApplicationResourceLifecycleRequest.Builder
avoiding the need to create one manually viaUpdateApplicationResourceLifecycleRequest.builder()
- Parameters:
updateApplicationResourceLifecycleRequest
- AConsumer
that will call methods onUpdateApplicationResourceLifecycleRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplicationResourceLifecycle operation returned by the service.
- See Also:
-
updateApplicationVersion
default UpdateApplicationVersionResponse updateApplicationVersion(UpdateApplicationVersionRequest updateApplicationVersionRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified application version to have the specified properties.
If a property (for example,
description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.- Parameters:
updateApplicationVersionRequest
-- Returns:
- Result of the UpdateApplicationVersion operation returned by the service.
- See Also:
-
updateApplicationVersion
default UpdateApplicationVersionResponse updateApplicationVersion(Consumer<UpdateApplicationVersionRequest.Builder> updateApplicationVersionRequest) throws AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified application version to have the specified properties.
If a property (for example,
description
) is not provided, the value remains unchanged. To clear properties, specify an empty string.
This is a convenience which creates an instance of the
UpdateApplicationVersionRequest.Builder
avoiding the need to create one manually viaUpdateApplicationVersionRequest.builder()
- Parameters:
updateApplicationVersionRequest
- AConsumer
that will call methods onUpdateApplicationVersionRequest.Builder
to create a request.- Returns:
- Result of the UpdateApplicationVersion operation returned by the service.
- See Also:
-
updateConfigurationTemplate
default UpdateConfigurationTemplateResponse updateConfigurationTemplate(UpdateConfigurationTemplateRequest updateConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified configuration template to have the specified properties or configuration option values.
If a property (for example,
ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.Related Topics
- Parameters:
updateConfigurationTemplateRequest
- The result message containing the options for the specified solution stack.- Returns:
- Result of the UpdateConfigurationTemplate operation returned by the service.
- See Also:
-
updateConfigurationTemplate
default UpdateConfigurationTemplateResponse updateConfigurationTemplate(Consumer<UpdateConfigurationTemplateRequest.Builder> updateConfigurationTemplateRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the specified configuration template to have the specified properties or configuration option values.
If a property (for example,
ApplicationName
) is not provided, its value remains unchanged. To clear such properties, specify an empty string.Related Topics
This is a convenience which creates an instance of the
UpdateConfigurationTemplateRequest.Builder
avoiding the need to create one manually viaUpdateConfigurationTemplateRequest.builder()
- Parameters:
updateConfigurationTemplateRequest
- AConsumer
that will call methods onUpdateConfigurationTemplateRequest.Builder
to create a request. The result message containing the options for the specified solution stack.- Returns:
- Result of the UpdateConfigurationTemplate operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different
DeploymentStatus
values.- Parameters:
updateEnvironmentRequest
- Request to update an environment.- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateEnvironment
default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Updates the environment description, deploys a new application version, updates the configuration settings to an entirely new configuration template, or updates select configuration option values in the running environment.
Attempting to update both the release and configuration is not allowed and AWS Elastic Beanstalk returns an
InvalidParameterCombination
error.When updating the configuration settings to a new template or individual settings, a draft configuration is created and DescribeConfigurationSettings for this environment returns two setting descriptions with different
DeploymentStatus
values.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request. Request to update an environment.- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateTagsForResource
default UpdateTagsForResourceResponse updateTagsForResource(UpdateTagsForResourceRequest updateTagsForResourceRequest) throws InsufficientPrivilegesException, OperationInProgressException, TooManyTagsException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed:
TagsToAdd
for tags to add or update, andTagsToRemove
.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 theTagsToAdd
parameter. - elasticbeanstalk:RemoveTags
-
Controls permission to call
UpdateTagsForResource
and pass a list of tag keys to remove in theTagsToRemove
parameter.
For details about creating a custom user policy, see Creating a Custom User Policy.
- Parameters:
updateTagsForResourceRequest
-- Returns:
- Result of the UpdateTagsForResource operation returned by the service.
- See Also:
-
updateTagsForResource
default UpdateTagsForResourceResponse updateTagsForResource(Consumer<UpdateTagsForResourceRequest.Builder> updateTagsForResourceRequest) throws InsufficientPrivilegesException, OperationInProgressException, TooManyTagsException, ResourceNotFoundException, ResourceTypeNotSupportedException, AwsServiceException, SdkClientException, ElasticBeanstalkException Update the list of tags applied to an AWS Elastic Beanstalk resource. Two lists can be passed:
TagsToAdd
for tags to add or update, andTagsToRemove
.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 theTagsToAdd
parameter. - elasticbeanstalk:RemoveTags
-
Controls permission to call
UpdateTagsForResource
and pass a list of tag keys to remove in theTagsToRemove
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 viaUpdateTagsForResourceRequest.builder()
- Parameters:
updateTagsForResourceRequest
- AConsumer
that will call methods onUpdateTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the UpdateTagsForResource operation returned by the service.
- See Also:
-
validateConfigurationSettings
default ValidateConfigurationSettingsResponse validateConfigurationSettings(ValidateConfigurationSettingsRequest validateConfigurationSettingsRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
- Parameters:
validateConfigurationSettingsRequest
- A list of validation messages for a specified configuration template.- Returns:
- Result of the ValidateConfigurationSettings operation returned by the service.
- See Also:
-
validateConfigurationSettings
default ValidateConfigurationSettingsResponse validateConfigurationSettings(Consumer<ValidateConfigurationSettingsRequest.Builder> validateConfigurationSettingsRequest) throws InsufficientPrivilegesException, TooManyBucketsException, AwsServiceException, SdkClientException, ElasticBeanstalkException Takes a set of configuration settings and either a configuration template or environment, and determines whether those values are valid.
This action returns a list of messages indicating any errors or warnings associated with the selection of option values.
This is a convenience which creates an instance of the
ValidateConfigurationSettingsRequest.Builder
avoiding the need to create one manually viaValidateConfigurationSettingsRequest.builder()
- Parameters:
validateConfigurationSettingsRequest
- AConsumer
that will call methods onValidateConfigurationSettingsRequest.Builder
to create a request. A list of validation messages for a specified configuration template.- Returns:
- Result of the ValidateConfigurationSettings operation returned by the service.
- See Also:
-
waiter
Create an instance ofElasticBeanstalkWaiter
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
ElasticBeanstalkWaiter
-
create
Create aElasticBeanstalkClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aElasticBeanstalkClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-