Interface AutoScalingClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface AutoScalingClient extends AwsClient
Service client for accessing Auto Scaling. This can be created using the staticbuilder()method.Amazon EC2 Auto Scaling Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
attachInstances
default AttachInstancesResponse attachInstances(AttachInstancesRequest attachInstancesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
attachInstancesRequest-- Returns:
- Result of the AttachInstances operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachInstances
default AttachInstancesResponse attachInstances(Consumer<AttachInstancesRequest.Builder> attachInstancesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
AttachInstancesRequest.Builderavoiding the need to create one manually viaAttachInstancesRequest.builder()- Parameters:
attachInstancesRequest- AConsumerthat will call methods onAttachInstancesRequest.Builderto create a request.- Returns:
- Result of the AttachInstances operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachLoadBalancerTargetGroups
default AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancerTargetGroups. You can use both the originalAttachLoadBalancerTargetGroupsAPI operation andAttachTrafficSourceson the same Auto Scaling group.Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
-
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
-
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
-
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
attachLoadBalancerTargetGroupsRequest-- Returns:
- Result of the AttachLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
attachLoadBalancerTargetGroups
default AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(Consumer<AttachLoadBalancerTargetGroupsRequest.Builder> attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancerTargetGroups. You can use both the originalAttachLoadBalancerTargetGroupsAPI operation andAttachTrafficSourceson the same Auto Scaling group.Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
-
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
-
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
-
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
AttachLoadBalancerTargetGroupsRequest.Builderavoiding the need to create one manually viaAttachLoadBalancerTargetGroupsRequest.builder()- Parameters:
attachLoadBalancerTargetGroupsRequest- AConsumerthat will call methods onAttachLoadBalancerTargetGroupsRequest.Builderto create a request.- Returns:
- Result of the AttachLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
attachLoadBalancers
default AttachLoadBalancersResponse attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancers. You can use both the originalAttachLoadBalancersAPI operation andAttachTrafficSourceson the same Auto Scaling group.Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
attachLoadBalancersRequest-- Returns:
- Result of the AttachLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachLoadBalancers
default AttachLoadBalancersResponse attachLoadBalancers(Consumer<AttachLoadBalancersRequest.Builder> attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using
AttachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportAttachLoadBalancers. You can use both the originalAttachLoadBalancersAPI operation andAttachTrafficSourceson the same Auto Scaling group.Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach a load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.
For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
AttachLoadBalancersRequest.Builderavoiding the need to create one manually viaAttachLoadBalancersRequest.builder()- Parameters:
attachLoadBalancersRequest- AConsumerthat will call methods onAttachLoadBalancersRequest.Builderto create a request.- Returns:
- Result of the AttachLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
attachTrafficSources
default AttachTrafficSourcesResponse attachTrafficSources(AttachTrafficSourcesRequest attachTrafficSourcesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
-
Application Load Balancer
-
Classic Load Balancer
-
Gateway Load Balancer
-
Network Load Balancer
-
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
- Parameters:
attachTrafficSourcesRequest-- Returns:
- Result of the AttachTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
attachTrafficSources
default AttachTrafficSourcesResponse attachTrafficSources(Consumer<AttachTrafficSourcesRequest.Builder> attachTrafficSourcesRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Attaches one or more traffic sources to the specified Auto Scaling group.
You can use any of the following as traffic sources for an Auto Scaling group:
-
Application Load Balancer
-
Classic Load Balancer
-
Gateway Load Balancer
-
Network Load Balancer
-
VPC Lattice
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
After the operation completes, use the DescribeTrafficSources API to return details about the state of the attachments between traffic sources and your Auto Scaling group. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
This is a convenience which creates an instance of the
AttachTrafficSourcesRequest.Builderavoiding the need to create one manually viaAttachTrafficSourcesRequest.builder()- Parameters:
attachTrafficSourcesRequest- AConsumerthat will call methods onAttachTrafficSourcesRequest.Builderto create a request.- Returns:
- Result of the AttachTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
batchDeleteScheduledAction
default BatchDeleteScheduledActionResponse batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes one or more scheduled actions for the specified Auto Scaling group.
- Parameters:
batchDeleteScheduledActionRequest-- Returns:
- Result of the BatchDeleteScheduledAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchDeleteScheduledAction
default BatchDeleteScheduledActionResponse batchDeleteScheduledAction(Consumer<BatchDeleteScheduledActionRequest.Builder> batchDeleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes one or more scheduled actions for the specified Auto Scaling group.
This is a convenience which creates an instance of the
BatchDeleteScheduledActionRequest.Builderavoiding the need to create one manually viaBatchDeleteScheduledActionRequest.builder()- Parameters:
batchDeleteScheduledActionRequest- AConsumerthat will call methods onBatchDeleteScheduledActionRequest.Builderto create a request.- Returns:
- Result of the BatchDeleteScheduledAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutScheduledUpdateGroupAction
default BatchPutScheduledUpdateGroupActionResponse batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
- Parameters:
batchPutScheduledUpdateGroupActionRequest-- Returns:
- Result of the BatchPutScheduledUpdateGroupAction operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
batchPutScheduledUpdateGroupAction
default BatchPutScheduledUpdateGroupActionResponse batchPutScheduledUpdateGroupAction(Consumer<BatchPutScheduledUpdateGroupActionRequest.Builder> batchPutScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
This is a convenience which creates an instance of the
BatchPutScheduledUpdateGroupActionRequest.Builderavoiding the need to create one manually viaBatchPutScheduledUpdateGroupActionRequest.builder()- Parameters:
batchPutScheduledUpdateGroupActionRequest- AConsumerthat will call methods onBatchPutScheduledUpdateGroupActionRequest.Builderto create a request.- Returns:
- Result of the BatchPutScheduledUpdateGroupAction operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelInstanceRefresh
default CancelInstanceRefreshResponse cancelInstanceRefresh(CancelInstanceRefreshRequest cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an
ActiveInstanceRefreshNotFounderror occurs.This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
- Parameters:
cancelInstanceRefreshRequest-- Returns:
- Result of the CancelInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ActiveInstanceRefreshNotFoundException- The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
cancelInstanceRefresh
default CancelInstanceRefreshResponse cancelInstanceRefresh(Consumer<CancelInstanceRefreshRequest.Builder> cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an
ActiveInstanceRefreshNotFounderror occurs.This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
This is a convenience which creates an instance of the
CancelInstanceRefreshRequest.Builderavoiding the need to create one manually viaCancelInstanceRefreshRequest.builder()- Parameters:
cancelInstanceRefreshRequest- AConsumerthat will call methods onCancelInstanceRefreshRequest.Builderto create a request.- Returns:
- Result of the CancelInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ActiveInstanceRefreshNotFoundException- The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
completeLifecycleAction
default CompleteLifecycleActionResponse completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
completeLifecycleActionRequest-- Returns:
- Result of the CompleteLifecycleAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
completeLifecycleAction
default CompleteLifecycleActionResponse completeLifecycleAction(Consumer<CompleteLifecycleActionRequest.Builder> completeLifecycleActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Complete a lifecycle action in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CompleteLifecycleActionRequest.Builderavoiding the need to create one manually viaCompleteLifecycleActionRequest.builder()- Parameters:
completeLifecycleActionRequest- AConsumerthat will call methods onCompleteLifecycleActionRequest.Builderto create a request.- Returns:
- Result of the CompleteLifecycleAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
createAutoScalingGroup
default CreateAutoScalingGroupResponse createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (
DesiredCapacity,MaxSize, andMinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.- Parameters:
createAutoScalingGroupRequest-- Returns:
- Result of the CreateAutoScalingGroup operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createAutoScalingGroup
default CreateAutoScalingGroupResponse createAutoScalingGroup(Consumer<CreateAutoScalingGroupRequest.Builder> createAutoScalingGroupRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (
DesiredCapacity,MaxSize, andMinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
This is a convenience which creates an instance of the
CreateAutoScalingGroupRequest.Builderavoiding the need to create one manually viaCreateAutoScalingGroupRequest.builder()- Parameters:
createAutoScalingGroupRequest- AConsumerthat will call methods onCreateAutoScalingGroupRequest.Builderto create a request.- Returns:
- Result of the CreateAutoScalingGroup operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLaunchConfiguration
default CreateLaunchConfigurationResponse createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
createLaunchConfigurationRequest-- Returns:
- Result of the CreateLaunchConfiguration operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createLaunchConfiguration
default CreateLaunchConfigurationResponse createLaunchConfiguration(Consumer<CreateLaunchConfigurationRequest.Builder> createLaunchConfigurationRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CreateLaunchConfigurationRequest.Builderavoiding the need to create one manually viaCreateLaunchConfigurationRequest.builder()- Parameters:
createLaunchConfigurationRequest- AConsumerthat will call methods onCreateLaunchConfigurationRequest.Builderto create a request.- Returns:
- Result of the CreateLaunchConfiguration operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createOrUpdateTags
default CreateOrUpdateTagsResponse createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) throws LimitExceededException, AlreadyExistsException, ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
createOrUpdateTagsRequest-- Returns:
- Result of the CreateOrUpdateTags operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
createOrUpdateTags
default CreateOrUpdateTagsResponse createOrUpdateTags(Consumer<CreateOrUpdateTagsRequest.Builder> createOrUpdateTagsRequest) throws LimitExceededException, AlreadyExistsException, ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates tags for the specified Auto Scaling group.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
CreateOrUpdateTagsRequest.Builderavoiding the need to create one manually viaCreateOrUpdateTagsRequest.builder()- Parameters:
createOrUpdateTagsRequest- AConsumerthat will call methods onCreateOrUpdateTagsRequest.Builderto create a request.- Returns:
- Result of the CreateOrUpdateTags operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAutoScalingGroup
default DeleteAutoScalingGroupResponse deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
deleteAutoScalingGroupRequest-- Returns:
- Result of the DeleteAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteAutoScalingGroup
default DeleteAutoScalingGroupResponse deleteAutoScalingGroup(Consumer<DeleteAutoScalingGroupRequest.Builder> deleteAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed. The force delete operation will also terminate the EC2 instances. If the group has a warm pool, the force delete option also deletes the warm pool.
To remove instances from the Auto Scaling group before deleting it, call the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
If the group has scaling policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
For more information, see Delete your Auto Scaling infrastructure in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DeleteAutoScalingGroupRequest.Builderavoiding the need to create one manually viaDeleteAutoScalingGroupRequest.builder()- Parameters:
deleteAutoScalingGroupRequest- AConsumerthat will call methods onDeleteAutoScalingGroupRequest.Builderto create a request.- Returns:
- Result of the DeleteAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLaunchConfiguration
default DeleteLaunchConfigurationResponse deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
- Parameters:
deleteLaunchConfigurationRequest-- Returns:
- Result of the DeleteLaunchConfiguration operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLaunchConfiguration
default DeleteLaunchConfigurationResponse deleteLaunchConfiguration(Consumer<DeleteLaunchConfigurationRequest.Builder> deleteLaunchConfigurationRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
This is a convenience which creates an instance of the
DeleteLaunchConfigurationRequest.Builderavoiding the need to create one manually viaDeleteLaunchConfigurationRequest.builder()- Parameters:
deleteLaunchConfigurationRequest- AConsumerthat will call methods onDeleteLaunchConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteLaunchConfiguration operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecycleHook
default DeleteLifecycleHookResponse deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDONfor launching instances,CONTINUEfor terminating instances).- Parameters:
deleteLifecycleHookRequest-- Returns:
- Result of the DeleteLifecycleHook operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteLifecycleHook
default DeleteLifecycleHookResponse deleteLifecycleHook(Consumer<DeleteLifecycleHookRequest.Builder> deleteLifecycleHookRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDONfor launching instances,CONTINUEfor terminating instances).
This is a convenience which creates an instance of the
DeleteLifecycleHookRequest.Builderavoiding the need to create one manually viaDeleteLifecycleHookRequest.builder()- Parameters:
deleteLifecycleHookRequest- AConsumerthat will call methods onDeleteLifecycleHookRequest.Builderto create a request.- Returns:
- Result of the DeleteLifecycleHook operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified notification.
- Parameters:
deleteNotificationConfigurationRequest-- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteNotificationConfiguration
default DeleteNotificationConfigurationResponse deleteNotificationConfiguration(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified notification.
This is a convenience which creates an instance of the
DeleteNotificationConfigurationRequest.Builderavoiding the need to create one manually viaDeleteNotificationConfigurationRequest.builder()- Parameters:
deleteNotificationConfigurationRequest- AConsumerthat will call methods onDeleteNotificationConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteNotificationConfiguration operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePolicy
default DeletePolicyResponse deletePolicy(DeletePolicyRequest deletePolicyRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
deletePolicyRequest-- Returns:
- Result of the DeletePolicy operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deletePolicy
default DeletePolicyResponse deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DeletePolicyRequest.Builderavoiding the need to create one manually viaDeletePolicyRequest.builder()- Parameters:
deletePolicyRequest- AConsumerthat will call methods onDeletePolicyRequest.Builderto create a request.- Returns:
- Result of the DeletePolicy operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScheduledAction
default DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified scheduled action.
- Parameters:
deleteScheduledActionRequest-- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteScheduledAction
default DeleteScheduledActionResponse deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified scheduled action.
This is a convenience which creates an instance of the
DeleteScheduledActionRequest.Builderavoiding the need to create one manually viaDeleteScheduledActionRequest.builder()- Parameters:
deleteScheduledActionRequest- AConsumerthat will call methods onDeleteScheduledActionRequest.Builderto create a request.- Returns:
- Result of the DeleteScheduledAction operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTags
default DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified tags.
- Parameters:
deleteTagsRequest-- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteTags
default DeleteTagsResponse deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest) throws ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified tags.
This is a convenience which creates an instance of the
DeleteTagsRequest.Builderavoiding the need to create one manually viaDeleteTagsRequest.builder()- Parameters:
deleteTagsRequest- AConsumerthat will call methods onDeleteTagsRequest.Builderto create a request.- Returns:
- Result of the DeleteTags operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWarmPool
default DeleteWarmPoolResponse deleteWarmPool(DeleteWarmPoolRequest deleteWarmPoolRequest) throws LimitExceededException, ResourceContentionException, ScalingActivityInProgressException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
deleteWarmPoolRequest-- Returns:
- Result of the DeleteWarmPool operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
deleteWarmPool
default DeleteWarmPoolResponse deleteWarmPool(Consumer<DeleteWarmPoolRequest.Builder> deleteWarmPoolRequest) throws LimitExceededException, ResourceContentionException, ScalingActivityInProgressException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the warm pool for the specified Auto Scaling group.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DeleteWarmPoolRequest.Builderavoiding the need to create one manually viaDeleteWarmPoolRequest.builder()- Parameters:
deleteWarmPoolRequest- AConsumerthat will call methods onDeleteWarmPoolRequest.Builderto create a request.- Returns:
- Result of the DeleteWarmPool operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceInUseException- The operation can't be performed because the resource is in use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeAccountLimitsRequest-- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeAccountLimitsRequest.Builderavoiding the need to create one manually viaDescribeAccountLimitsRequest.builder()- Parameters:
describeAccountLimitsRequest- AConsumerthat will call methods onDescribeAccountLimitsRequest.Builderto create a request.- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAccountLimits
default DescribeAccountLimitsResponse describeAccountLimits() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeAccountLimits operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAccountLimits(DescribeAccountLimitsRequest), AWS API Documentation
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity -
ExactCapacity -
PercentChangeInCapacity
- Parameters:
describeAdjustmentTypesRequest-- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes(Consumer<DescribeAdjustmentTypesRequest.Builder> describeAdjustmentTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity -
ExactCapacity -
PercentChangeInCapacity
This is a convenience which creates an instance of the
DescribeAdjustmentTypesRequest.Builderavoiding the need to create one manually viaDescribeAdjustmentTypesRequest.builder()- Parameters:
describeAdjustmentTypesRequest- AConsumerthat will call methods onDescribeAdjustmentTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeAdjustmentTypes
default DescribeAdjustmentTypesResponse describeAdjustmentTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available adjustment types for step scaling and simple scaling policies.
The following adjustment types are supported:
-
ChangeInCapacity -
ExactCapacity -
PercentChangeInCapacity
- Returns:
- Result of the DescribeAdjustmentTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAdjustmentTypes(DescribeAdjustmentTypesRequest), AWS API Documentation
-
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
- Parameters:
describeAutoScalingGroupsRequest-- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
This is a convenience which creates an instance of the
DescribeAutoScalingGroupsRequest.Builderavoiding the need to create one manually viaDescribeAutoScalingGroupsRequest.builder()- Parameters:
describeAutoScalingGroupsRequest- AConsumerthat will call methods onDescribeAutoScalingGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingGroups
default DescribeAutoScalingGroupsResponse describeAutoScalingGroups() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
- Returns:
- Result of the DescribeAutoScalingGroups operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest), AWS API Documentation
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(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
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAutoScalingGroupsPaginator(DescribeAutoScalingGroupsRequest), AWS API Documentation
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(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
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)operation.- Parameters:
describeAutoScalingGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingGroupsPaginator
default DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client .describeAutoScalingGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(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
describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeAutoScalingGroupsRequest.Builderavoiding the need to create one manually viaDescribeAutoScalingGroupsRequest.builder()- Parameters:
describeAutoScalingGroupsRequest- AConsumerthat will call methods onDescribeAutoScalingGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
- Parameters:
describeAutoScalingInstancesRequest-- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
This is a convenience which creates an instance of the
DescribeAutoScalingInstancesRequest.Builderavoiding the need to create one manually viaDescribeAutoScalingInstancesRequest.builder()- Parameters:
describeAutoScalingInstancesRequest- AConsumerthat will call methods onDescribeAutoScalingInstancesRequest.Builderto create a request.- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingInstances
default DescribeAutoScalingInstancesResponse describeAutoScalingInstances() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
- Returns:
- Result of the DescribeAutoScalingInstances operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest), AWS API Documentation
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(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
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest), AWS API Documentation
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(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
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)operation.- Parameters:
describeAutoScalingInstancesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingInstancesPaginator
default DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client .describeAutoScalingInstancesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(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
describeAutoScalingInstances(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingInstancesRequest)operation.
This is a convenience which creates an instance of the
DescribeAutoScalingInstancesRequest.Builderavoiding the need to create one manually viaDescribeAutoScalingInstancesRequest.builder()- Parameters:
describeAutoScalingInstancesRequest- AConsumerthat will call methods onDescribeAutoScalingInstancesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
- Parameters:
describeAutoScalingNotificationTypesRequest-- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes(Consumer<DescribeAutoScalingNotificationTypesRequest.Builder> describeAutoScalingNotificationTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
This is a convenience which creates an instance of the
DescribeAutoScalingNotificationTypesRequest.Builderavoiding the need to create one manually viaDescribeAutoScalingNotificationTypesRequest.builder()- Parameters:
describeAutoScalingNotificationTypesRequest- AConsumerthat will call methods onDescribeAutoScalingNotificationTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeAutoScalingNotificationTypes
default DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
- Returns:
- Result of the DescribeAutoScalingNotificationTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest), AWS API Documentation
-
describeInstanceRefreshes
default DescribeInstanceRefreshesResponse describeInstanceRefreshes(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
- Parameters:
describeInstanceRefreshesRequest-- Returns:
- Result of the DescribeInstanceRefreshes operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInstanceRefreshes
default DescribeInstanceRefreshesResponse describeInstanceRefreshes(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
This is a convenience which creates an instance of the
DescribeInstanceRefreshesRequest.Builderavoiding the need to create one manually viaDescribeInstanceRefreshesRequest.builder()- Parameters:
describeInstanceRefreshesRequest- AConsumerthat will call methods onDescribeInstanceRefreshesRequest.Builderto create a request.- Returns:
- Result of the DescribeInstanceRefreshes operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInstanceRefreshesPaginator
default DescribeInstanceRefreshesIterable describeInstanceRefreshesPaginator(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client .describeInstanceRefreshesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(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
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)operation.- Parameters:
describeInstanceRefreshesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeInstanceRefreshesPaginator
default DescribeInstanceRefreshesIterable describeInstanceRefreshesPaginator(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client .describeInstanceRefreshesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeInstanceRefreshesIterable responses = client.describeInstanceRefreshesPaginator(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
describeInstanceRefreshes(software.amazon.awssdk.services.autoscaling.model.DescribeInstanceRefreshesRequest)operation.
This is a convenience which creates an instance of the
DescribeInstanceRefreshesRequest.Builderavoiding the need to create one manually viaDescribeInstanceRefreshesRequest.builder()- Parameters:
describeInstanceRefreshesRequest- AConsumerthat will call methods onDescribeInstanceRefreshesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
- Parameters:
describeLaunchConfigurationsRequest-- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
This is a convenience which creates an instance of the
DescribeLaunchConfigurationsRequest.Builderavoiding the need to create one manually viaDescribeLaunchConfigurationsRequest.builder()- Parameters:
describeLaunchConfigurationsRequest- AConsumerthat will call methods onDescribeLaunchConfigurationsRequest.Builderto create a request.- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLaunchConfigurations
default DescribeLaunchConfigurationsResponse describeLaunchConfigurations() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
- Returns:
- Result of the DescribeLaunchConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest), AWS API Documentation
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(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
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest), AWS API Documentation
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(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
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)operation.- Parameters:
describeLaunchConfigurationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLaunchConfigurationsPaginator
default DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client .describeLaunchConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(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
describeLaunchConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeLaunchConfigurationsRequest)operation.
This is a convenience which creates an instance of the
DescribeLaunchConfigurationsRequest.Builderavoiding the need to create one manually viaDescribeLaunchConfigurationsRequest.builder()- Parameters:
describeLaunchConfigurationsRequest- AConsumerthat will call methods onDescribeLaunchConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING -
autoscaling:EC2_INSTANCE_TERMINATING
- Parameters:
describeLifecycleHookTypesRequest-- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes(Consumer<DescribeLifecycleHookTypesRequest.Builder> describeLifecycleHookTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING -
autoscaling:EC2_INSTANCE_TERMINATING
This is a convenience which creates an instance of the
DescribeLifecycleHookTypesRequest.Builderavoiding the need to create one manually viaDescribeLifecycleHookTypesRequest.builder()- Parameters:
describeLifecycleHookTypesRequest- AConsumerthat will call methods onDescribeLifecycleHookTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
describeLifecycleHookTypes
default DescribeLifecycleHookTypesResponse describeLifecycleHookTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available types of lifecycle hooks.
The following hook types are supported:
-
autoscaling:EC2_INSTANCE_LAUNCHING -
autoscaling:EC2_INSTANCE_TERMINATING
- Returns:
- Result of the DescribeLifecycleHookTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest), AWS API Documentation
-
-
describeLifecycleHooks
default DescribeLifecycleHooksResponse describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the lifecycle hooks for the specified Auto Scaling group.
- Parameters:
describeLifecycleHooksRequest-- Returns:
- Result of the DescribeLifecycleHooks operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLifecycleHooks
default DescribeLifecycleHooksResponse describeLifecycleHooks(Consumer<DescribeLifecycleHooksRequest.Builder> describeLifecycleHooksRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the lifecycle hooks for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DescribeLifecycleHooksRequest.Builderavoiding the need to create one manually viaDescribeLifecycleHooksRequest.builder()- Parameters:
describeLifecycleHooksRequest- AConsumerthat will call methods onDescribeLifecycleHooksRequest.Builderto create a request.- Returns:
- Result of the DescribeLifecycleHooks operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancerTargetGroups
default DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancerTargetGroups. You can use both the originalDescribeLoadBalancerTargetGroupsAPI operation andDescribeTrafficSourceson the same Auto Scaling group.Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the
Stateelement in the response. When you attach a target group to an Auto Scaling group, the initialStatevalue isAdding. The state transitions toAddedafter all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInServiceafter at least one Auto Scaling instance passes the health check. When the target group is in theInServicestate, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter theInServicestate.Target groups also have an
InServicestate if you attach them in the CreateAutoScalingGroup API call. If your target group state isInService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
- Parameters:
describeLoadBalancerTargetGroupsRequest-- Returns:
- Result of the DescribeLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancerTargetGroups
default DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancerTargetGroups. You can use both the originalDescribeLoadBalancerTargetGroupsAPI operation andDescribeTrafficSourceson the same Auto Scaling group.Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
To determine the attachment status of the target group, use the
Stateelement in the response. When you attach a target group to an Auto Scaling group, the initialStatevalue isAdding. The state transitions toAddedafter all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInServiceafter at least one Auto Scaling instance passes the health check. When the target group is in theInServicestate, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn't enter theInServicestate.Target groups also have an
InServicestate if you attach them in the CreateAutoScalingGroup API call. If your target group state isInService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
You can use this operation to describe target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This is a convenience which creates an instance of the
DescribeLoadBalancerTargetGroupsRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancerTargetGroupsRequest.builder()- Parameters:
describeLoadBalancerTargetGroupsRequest- AConsumerthat will call methods onDescribeLoadBalancerTargetGroupsRequest.Builderto create a request.- Returns:
- Result of the DescribeLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancerTargetGroupsPaginator
default DescribeLoadBalancerTargetGroupsIterable describeLoadBalancerTargetGroupsPaginator(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client .describeLoadBalancerTargetGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(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
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)operation.- Parameters:
describeLoadBalancerTargetGroupsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancerTargetGroupsPaginator
default DescribeLoadBalancerTargetGroupsIterable describeLoadBalancerTargetGroupsPaginator(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client .describeLoadBalancerTargetGroupsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancerTargetGroupsIterable responses = client.describeLoadBalancerTargetGroupsPaginator(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
describeLoadBalancerTargetGroups(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancerTargetGroupsRequest)operation.
This is a convenience which creates an instance of the
DescribeLoadBalancerTargetGroupsRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancerTargetGroupsRequest.builder()- Parameters:
describeLoadBalancerTargetGroupsRequest- AConsumerthat will call methods onDescribeLoadBalancerTargetGroupsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DescribeTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancers. You can use both the originalDescribeLoadBalancersAPI operation andDescribeTrafficSourceson the same Auto Scaling group.Gets information about the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
To determine the attachment status of the load balancer, use the
Stateelement in the response. When you attach a load balancer to an Auto Scaling group, the initialStatevalue isAdding. The state transitions toAddedafter all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInServiceafter at least one Auto Scaling instance passes the health check. When the load balancer is in theInServicestate, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter theInServicestate.Load balancers also have an
InServicestate if you attach them in the CreateAutoScalingGroup API call. If your load balancer state isInService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeLoadBalancersRequest-- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancers
default DescribeLoadBalancersResponse describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using
DescribeTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDescribeLoadBalancers. You can use both the originalDescribeLoadBalancersAPI operation andDescribeTrafficSourceson the same Auto Scaling group.Gets information about the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
To determine the attachment status of the load balancer, use the
Stateelement in the response. When you attach a load balancer to an Auto Scaling group, the initialStatevalue isAdding. The state transitions toAddedafter all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions toInServiceafter at least one Auto Scaling instance passes the health check. When the load balancer is in theInServicestate, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn't enter theInServicestate.Load balancers also have an
InServicestate if you attach them in the CreateAutoScalingGroup API call. If your load balancer state isInService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()- Parameters:
describeLoadBalancersRequest- AConsumerthat will call methods onDescribeLoadBalancersRequest.Builderto create a request.- Returns:
- Result of the DescribeLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(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
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)operation.- Parameters:
describeLoadBalancersRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeLoadBalancersPaginator
default DescribeLoadBalancersIterable describeLoadBalancersPaginator(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client .describeLoadBalancersPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeLoadBalancersIterable responses = client.describeLoadBalancersPaginator(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
describeLoadBalancers(software.amazon.awssdk.services.autoscaling.model.DescribeLoadBalancersRequest)operation.
This is a convenience which creates an instance of the
DescribeLoadBalancersRequest.Builderavoiding the need to create one manually viaDescribeLoadBalancersRequest.builder()- Parameters:
describeLoadBalancersRequest- AConsumerthat will call methods onDescribeLoadBalancersRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
- Parameters:
describeMetricCollectionTypesRequest-- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes(Consumer<DescribeMetricCollectionTypesRequest.Builder> describeMetricCollectionTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
This is a convenience which creates an instance of the
DescribeMetricCollectionTypesRequest.Builderavoiding the need to create one manually viaDescribeMetricCollectionTypesRequest.builder()- Parameters:
describeMetricCollectionTypesRequest- AConsumerthat will call methods onDescribeMetricCollectionTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeMetricCollectionTypes
default DescribeMetricCollectionTypesResponse describeMetricCollectionTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
- Returns:
- Result of the DescribeMetricCollectionTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest), AWS API Documentation
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
- Parameters:
describeNotificationConfigurationsRequest-- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
This is a convenience which creates an instance of the
DescribeNotificationConfigurationsRequest.Builderavoiding the need to create one manually viaDescribeNotificationConfigurationsRequest.builder()- Parameters:
describeNotificationConfigurationsRequest- AConsumerthat will call methods onDescribeNotificationConfigurationsRequest.Builderto create a request.- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNotificationConfigurations
default DescribeNotificationConfigurationsResponse describeNotificationConfigurations() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
- Returns:
- Result of the DescribeNotificationConfigurations operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest), AWS API Documentation
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(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
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeNotificationConfigurationsPaginator(DescribeNotificationConfigurationsRequest), AWS API Documentation
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(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
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)operation.- Parameters:
describeNotificationConfigurationsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeNotificationConfigurationsPaginator
default DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client .describeNotificationConfigurationsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(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
describeNotificationConfigurations(software.amazon.awssdk.services.autoscaling.model.DescribeNotificationConfigurationsRequest)operation.
This is a convenience which creates an instance of the
DescribeNotificationConfigurationsRequest.Builderavoiding the need to create one manually viaDescribeNotificationConfigurationsRequest.builder()- Parameters:
describeNotificationConfigurationsRequest- AConsumerthat will call methods onDescribeNotificationConfigurationsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePolicies
default DescribePoliciesResponse describePolicies(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
- Parameters:
describePoliciesRequest-- Returns:
- Result of the DescribePolicies operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePolicies
default DescribePoliciesResponse describePolicies(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
This is a convenience which creates an instance of the
DescribePoliciesRequest.Builderavoiding the need to create one manually viaDescribePoliciesRequest.builder()- Parameters:
describePoliciesRequest- AConsumerthat will call methods onDescribePoliciesRequest.Builderto create a request.- Returns:
- Result of the DescribePolicies operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePolicies
default DescribePoliciesResponse describePolicies() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
- Returns:
- Result of the DescribePolicies operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePolicies(DescribePoliciesRequest), AWS API Documentation
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(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
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describePoliciesPaginator(DescribePoliciesRequest), AWS API Documentation
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(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
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)operation.- Parameters:
describePoliciesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describePoliciesPaginator
default DescribePoliciesIterable describePoliciesPaginator(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client .describePoliciesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribePoliciesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(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
describePolicies(software.amazon.awssdk.services.autoscaling.model.DescribePoliciesRequest)operation.
This is a convenience which creates an instance of the
DescribePoliciesRequest.Builderavoiding the need to create one manually viaDescribePoliciesRequest.builder()- Parameters:
describePoliciesRequest- AConsumerthat will call methods onDescribePoliciesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCodeelement in the response isSuccessful. If an attempt to launch instances failed, theStatusCodevalue isFailedorCancelledand theStatusMessageelement in the response indicates the cause of the failure. For help interpreting theStatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.- Parameters:
describeScalingActivitiesRequest-- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCodeelement in the response isSuccessful. If an attempt to launch instances failed, theStatusCodevalue isFailedorCancelledand theStatusMessageelement in the response indicates the cause of the failure. For help interpreting theStatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeScalingActivitiesRequest.Builderavoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()- Parameters:
describeScalingActivitiesRequest- AConsumerthat will call methods onDescribeScalingActivitiesRequest.Builderto create a request.- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingActivities
default DescribeScalingActivitiesResponse describeScalingActivities() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling activities in the account and Region.
When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
If the scaling event succeeds, the value of the
StatusCodeelement in the response isSuccessful. If an attempt to launch instances failed, theStatusCodevalue isFailedorCancelledand theStatusMessageelement in the response indicates the cause of the failure. For help interpreting theStatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.- Returns:
- Result of the DescribeScalingActivities operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeScalingActivities(DescribeScalingActivitiesRequest), AWS API Documentation
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(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
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest), AWS API Documentation
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(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
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)operation.- Parameters:
describeScalingActivitiesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingActivitiesPaginator
default DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client .describeScalingActivitiesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(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
describeScalingActivities(software.amazon.awssdk.services.autoscaling.model.DescribeScalingActivitiesRequest)operation.
This is a convenience which creates an instance of the
DescribeScalingActivitiesRequest.Builderavoiding the need to create one manually viaDescribeScalingActivitiesRequest.builder()- Parameters:
describeScalingActivitiesRequest- AConsumerthat will call methods onDescribeScalingActivitiesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
- Parameters:
describeScalingProcessTypesRequest-- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes(Consumer<DescribeScalingProcessTypesRequest.Builder> describeScalingProcessTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
This is a convenience which creates an instance of the
DescribeScalingProcessTypesRequest.Builderavoiding the need to create one manually viaDescribeScalingProcessTypesRequest.builder()- Parameters:
describeScalingProcessTypesRequest- AConsumerthat will call methods onDescribeScalingProcessTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScalingProcessTypes
default DescribeScalingProcessTypesResponse describeScalingProcessTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
- Returns:
- Result of the DescribeScalingProcessTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeScalingProcessTypes(DescribeScalingProcessTypesRequest), AWS API Documentation
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
- Parameters:
describeScheduledActionsRequest-- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScheduledActions
default DescribeScheduledActionsResponse describeScheduledActions() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scheduled actions that haven't run or that have not reached their end time.
To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.
- Returns:
- Result of the DescribeScheduledActions operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeScheduledActions(DescribeScheduledActionsRequest), AWS API Documentation
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(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
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeScheduledActionsPaginator(DescribeScheduledActionsRequest), AWS API Documentation
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(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
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)operation.- Parameters:
describeScheduledActionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeScheduledActionsPaginator
default DescribeScheduledActionsIterable describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client .describeScheduledActionsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(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
describeScheduledActions(software.amazon.awssdk.services.autoscaling.model.DescribeScheduledActionsRequest)operation.
This is a convenience which creates an instance of the
DescribeScheduledActionsRequest.Builderavoiding the need to create one manually viaDescribeScheduledActionsRequest.builder()- Parameters:
describeScheduledActionsRequest- AConsumerthat will call methods onDescribeScheduledActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTags
default DescribeTagsResponse describeTags(DescribeTagsRequest describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeTagsRequest-- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTags
default DescribeTagsResponse describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTags
default DescribeTagsResponse describeTags() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeTags operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeTags(DescribeTagsRequest), AWS API Documentation
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(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
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeTagsPaginator(DescribeTagsRequest), AWS API Documentation
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(DescribeTagsRequest describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(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
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)operation.- Parameters:
describeTagsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTagsPaginator
default DescribeTagsIterable describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTagsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(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
describeTags(software.amazon.awssdk.services.autoscaling.model.DescribeTagsRequest)operation.
This is a convenience which creates an instance of the
DescribeTagsRequest.Builderavoiding the need to create one manually viaDescribeTagsRequest.builder()- Parameters:
describeTagsRequest- AConsumerthat will call methods onDescribeTagsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeTerminationPolicyTypesRequest-- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes(Consumer<DescribeTerminationPolicyTypesRequest.Builder> describeTerminationPolicyTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeTerminationPolicyTypesRequest.Builderavoiding the need to create one manually viaDescribeTerminationPolicyTypesRequest.builder()- Parameters:
describeTerminationPolicyTypesRequest- AConsumerthat will call methods onDescribeTerminationPolicyTypesRequest.Builderto create a request.- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTerminationPolicyTypes
default DescribeTerminationPolicyTypesResponse describeTerminationPolicyTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Work with Amazon EC2 Auto Scaling termination policies in the Amazon EC2 Auto Scaling User Guide.
- Returns:
- Result of the DescribeTerminationPolicyTypes operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest), AWS API Documentation
-
describeTrafficSources
default DescribeTrafficSourcesResponse describeTrafficSources(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
- Parameters:
describeTrafficSourcesRequest-- Returns:
- Result of the DescribeTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrafficSources
default DescribeTrafficSourcesResponse describeTrafficSources(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the traffic sources for the specified Auto Scaling group.
You can optionally provide a traffic source type. If you provide a traffic source type, then the results only include that traffic source type.
If you do not provide a traffic source type, then the results include all the traffic sources for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DescribeTrafficSourcesRequest.Builderavoiding the need to create one manually viaDescribeTrafficSourcesRequest.builder()- Parameters:
describeTrafficSourcesRequest- AConsumerthat will call methods onDescribeTrafficSourcesRequest.Builderto create a request.- Returns:
- Result of the DescribeTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrafficSourcesPaginator
default DescribeTrafficSourcesIterable describeTrafficSourcesPaginator(DescribeTrafficSourcesRequest describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client .describeTrafficSourcesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(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
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)operation.- Parameters:
describeTrafficSourcesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeTrafficSourcesPaginator
default DescribeTrafficSourcesIterable describeTrafficSourcesPaginator(Consumer<DescribeTrafficSourcesRequest.Builder> describeTrafficSourcesRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client .describeTrafficSourcesPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeTrafficSourcesIterable responses = client.describeTrafficSourcesPaginator(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
describeTrafficSources(software.amazon.awssdk.services.autoscaling.model.DescribeTrafficSourcesRequest)operation.
This is a convenience which creates an instance of the
DescribeTrafficSourcesRequest.Builderavoiding the need to create one manually viaDescribeTrafficSourcesRequest.builder()- Parameters:
describeTrafficSourcesRequest- AConsumerthat will call methods onDescribeTrafficSourcesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InvalidNextTokenException- TheNextTokenvalue is not valid.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWarmPool
default DescribeWarmPoolResponse describeWarmPool(DescribeWarmPoolRequest describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
describeWarmPoolRequest-- Returns:
- Result of the DescribeWarmPool operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWarmPool
default DescribeWarmPoolResponse describeWarmPool(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about a warm pool and its instances.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DescribeWarmPoolRequest.Builderavoiding the need to create one manually viaDescribeWarmPoolRequest.builder()- Parameters:
describeWarmPoolRequest- AConsumerthat will call methods onDescribeWarmPoolRequest.Builderto create a request.- Returns:
- Result of the DescribeWarmPool operation returned by the service.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWarmPoolPaginator
default DescribeWarmPoolIterable describeWarmPoolPaginator(DescribeWarmPoolRequest describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client .describeWarmPoolPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(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
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)operation.- Parameters:
describeWarmPoolRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
describeWarmPoolPaginator
default DescribeWarmPoolIterable describeWarmPoolPaginator(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest) throws InvalidNextTokenException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This is a variant of
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client .describeWarmPoolPaginator(request); for (software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.autoscaling.paginators.DescribeWarmPoolIterable responses = client.describeWarmPoolPaginator(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
describeWarmPool(software.amazon.awssdk.services.autoscaling.model.DescribeWarmPoolRequest)operation.
This is a convenience which creates an instance of the
DescribeWarmPoolRequest.Builderavoiding the need to create one manually viaDescribeWarmPoolRequest.builder()- Parameters:
describeWarmPoolRequest- AConsumerthat will call methods onDescribeWarmPoolRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
InvalidNextTokenException- TheNextTokenvalue is not valid.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachInstances
default DetachInstancesResponse detachInstances(DetachInstancesRequest detachInstancesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
detachInstancesRequest-- Returns:
- Result of the DetachInstances operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachInstances
default DetachInstancesResponse detachInstances(Consumer<DetachInstancesRequest.Builder> detachInstancesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
DetachInstancesRequest.Builderavoiding the need to create one manually viaDetachInstancesRequest.builder()- Parameters:
detachInstancesRequest- AConsumerthat will call methods onDetachInstancesRequest.Builderto create a request.- Returns:
- Result of the DetachInstances operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachLoadBalancerTargetGroups
default DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancerTargetGroups. You can use both the originalDetachLoadBalancerTargetGroupsAPI operation andDetachTrafficSourceson the same Auto Scaling group.Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
- Parameters:
detachLoadBalancerTargetGroupsRequest-- Returns:
- Result of the DetachLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachLoadBalancerTargetGroups
default DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(Consumer<DetachLoadBalancerTargetGroupsRequest.Builder> detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancerTargetGroups. You can use both the originalDetachLoadBalancerTargetGroupsAPI operation andDetachTrafficSourceson the same Auto Scaling group.Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeLoadBalancerTargetGroups API call. The instances remain running.You can use this operation to detach target groups that were attached by using AttachLoadBalancerTargetGroups, but not for target groups that were attached by using AttachTrafficSources.
This is a convenience which creates an instance of the
DetachLoadBalancerTargetGroupsRequest.Builderavoiding the need to create one manually viaDetachLoadBalancerTargetGroupsRequest.builder()- Parameters:
detachLoadBalancerTargetGroupsRequest- AConsumerthat will call methods onDetachLoadBalancerTargetGroupsRequest.Builderto create a request.- Returns:
- Result of the DetachLoadBalancerTargetGroups operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachLoadBalancers
default DetachLoadBalancersResponse detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancers. You can use both the originalDetachLoadBalancersAPI operation andDetachTrafficSourceson the same Auto Scaling group.Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.- Parameters:
detachLoadBalancersRequest-- Returns:
- Result of the DetachLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachLoadBalancers
default DetachLoadBalancersResponse detachLoadBalancers(Consumer<DetachLoadBalancersRequest.Builder> detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using
DetachTrafficSourcesto simplify how you manage traffic sources. However, we continue to supportDetachLoadBalancers. You can use both the originalDetachLoadBalancersAPI operation andDetachTrafficSourceson the same Auto Scaling group.Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.
This is a convenience which creates an instance of the
DetachLoadBalancersRequest.Builderavoiding the need to create one manually viaDetachLoadBalancersRequest.builder()- Parameters:
detachLoadBalancersRequest- AConsumerthat will call methods onDetachLoadBalancersRequest.Builderto create a request.- Returns:
- Result of the DetachLoadBalancers operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachTrafficSources
default DetachTrafficSourcesResponse detachTrafficSources(DetachTrafficSourcesRequest detachTrafficSourcesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.- Parameters:
detachTrafficSourcesRequest-- Returns:
- Result of the DetachTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
detachTrafficSources
default DetachTrafficSourcesResponse detachTrafficSources(Consumer<DetachTrafficSourcesRequest.Builder> detachTrafficSourcesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Detaches one or more traffic sources from the specified Auto Scaling group.
When you detach a traffic source, it enters the
Removingstate while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources API call. The instances continue to run.
This is a convenience which creates an instance of the
DetachTrafficSourcesRequest.Builderavoiding the need to create one manually viaDetachTrafficSourcesRequest.builder()- Parameters:
detachTrafficSourcesRequest- AConsumerthat will call methods onDetachTrafficSourcesRequest.Builderto create a request.- Returns:
- Result of the DetachTrafficSources operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disableMetricsCollection
default DisableMetricsCollectionResponse disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Disables group metrics collection for the specified Auto Scaling group.
- Parameters:
disableMetricsCollectionRequest-- Returns:
- Result of the DisableMetricsCollection operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
disableMetricsCollection
default DisableMetricsCollectionResponse disableMetricsCollection(Consumer<DisableMetricsCollectionRequest.Builder> disableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Disables group metrics collection for the specified Auto Scaling group.
This is a convenience which creates an instance of the
DisableMetricsCollectionRequest.Builderavoiding the need to create one manually viaDisableMetricsCollectionRequest.builder()- Parameters:
disableMetricsCollectionRequest- AConsumerthat will call methods onDisableMetricsCollectionRequest.Builderto create a request.- Returns:
- Result of the DisableMetricsCollection operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableMetricsCollection
default EnableMetricsCollectionResponse enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
enableMetricsCollectionRequest-- Returns:
- Result of the EnableMetricsCollection operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enableMetricsCollection
default EnableMetricsCollectionResponse enableMetricsCollection(Consumer<EnableMetricsCollectionRequest.Builder> enableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Enables group metrics collection for the specified Auto Scaling group.
You can use these metrics to track changes in an Auto Scaling group and to set alarms on threshold values. You can view group metrics using the Amazon EC2 Auto Scaling console or the CloudWatch console. For more information, see Monitor CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
EnableMetricsCollectionRequest.Builderavoiding the need to create one manually viaEnableMetricsCollectionRequest.builder()- Parameters:
enableMetricsCollectionRequest- AConsumerthat will call methods onEnableMetricsCollectionRequest.Builderto create a request.- Returns:
- Result of the EnableMetricsCollection operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enterStandby
default EnterStandbyResponse enterStandby(EnterStandbyRequest enterStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
enterStandbyRequest-- Returns:
- Result of the EnterStandby operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
enterStandby
default EnterStandbyResponse enterStandby(Consumer<EnterStandbyRequest.Builder> enterStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
EnterStandbyRequest.Builderavoiding the need to create one manually viaEnterStandbyRequest.builder()- Parameters:
enterStandbyRequest- AConsumerthat will call methods onEnterStandbyRequest.Builderto create a request.- Returns:
- Result of the EnterStandby operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
executePolicy
default ExecutePolicyResponse executePolicy(ExecutePolicyRequest executePolicyRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Executes the specified policy. This can be useful for testing the design of your scaling policy.
- Parameters:
executePolicyRequest-- Returns:
- Result of the ExecutePolicy operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
executePolicy
default ExecutePolicyResponse executePolicy(Consumer<ExecutePolicyRequest.Builder> executePolicyRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Executes the specified policy. This can be useful for testing the design of your scaling policy.
This is a convenience which creates an instance of the
ExecutePolicyRequest.Builderavoiding the need to create one manually viaExecutePolicyRequest.builder()- Parameters:
executePolicyRequest- AConsumerthat will call methods onExecutePolicyRequest.Builderto create a request.- Returns:
- Result of the ExecutePolicy operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
exitStandby
default ExitStandbyResponse exitStandby(ExitStandbyRequest exitStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
exitStandbyRequest-- Returns:
- Result of the ExitStandby operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
exitStandby
default ExitStandbyResponse exitStandby(Consumer<ExitStandbyRequest.Builder> exitStandbyRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
ExitStandbyRequest.Builderavoiding the need to create one manually viaExitStandbyRequest.builder()- Parameters:
exitStandbyRequest- AConsumerthat will call methods onExitStandbyRequest.Builderto create a request.- Returns:
- Result of the ExitStandby operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(GetPredictiveScalingForecastRequest getPredictiveScalingForecastRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
getPredictiveScalingForecastRequest-- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
getPredictiveScalingForecast
default GetPredictiveScalingForecastResponse getPredictiveScalingForecast(Consumer<GetPredictiveScalingForecastRequest.Builder> getPredictiveScalingForecastRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Retrieves the forecast data for a predictive scaling policy.
Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.
A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.
For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
GetPredictiveScalingForecastRequest.Builderavoiding the need to create one manually viaGetPredictiveScalingForecastRequest.builder()- Parameters:
getPredictiveScalingForecastRequest- AConsumerthat will call methods onGetPredictiveScalingForecastRequest.Builderto create a request.- Returns:
- Result of the GetPredictiveScalingForecast operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putLifecycleHook
default PutLifecycleHookResponse putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
- Parameters:
putLifecycleHookRequest-- Returns:
- Result of the PutLifecycleHook operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
putLifecycleHook
default PutLifecycleHookResponse putLifecycleHook(Consumer<PutLifecycleHookRequest.Builder> putLifecycleHookRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a lifecycle hook for the specified Auto Scaling group.
Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
This is a convenience which creates an instance of the
PutLifecycleHookRequest.Builderavoiding the need to create one manually viaPutLifecycleHookRequest.builder()- Parameters:
putLifecycleHookRequest- AConsumerthat will call methods onPutLifecycleHookRequest.Builderto create a request.- Returns:
- Result of the PutLifecycleHook operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
putNotificationConfiguration
default PutNotificationConfigurationResponse putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
- Parameters:
putNotificationConfigurationRequest-- Returns:
- Result of the PutNotificationConfiguration operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putNotificationConfiguration
default PutNotificationConfigurationResponse putNotificationConfiguration(Consumer<PutNotificationConfigurationRequest.Builder> putNotificationConfigurationRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
This is a convenience which creates an instance of the
PutNotificationConfigurationRequest.Builderavoiding the need to create one manually viaPutNotificationConfigurationRequest.builder()- Parameters:
putNotificationConfigurationRequest- AConsumerthat will call methods onPutNotificationConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutNotificationConfiguration operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putScalingPolicy
default PutScalingPolicyResponse putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
- Parameters:
putScalingPolicyRequest-- Returns:
- Result of the PutScalingPolicy operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putScalingPolicy
default PutScalingPolicyResponse putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest) throws LimitExceededException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.
For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.
This is a convenience which creates an instance of the
PutScalingPolicyRequest.Builderavoiding the need to create one manually viaPutScalingPolicyRequest.builder()- Parameters:
putScalingPolicyRequest- AConsumerthat will call methods onPutScalingPolicyRequest.Builderto create a request.- Returns:
- Result of the PutScalingPolicy operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putScheduledUpdateGroupAction
default PutScheduledUpdateGroupActionResponse putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
- Parameters:
putScheduledUpdateGroupActionRequest-- Returns:
- Result of the PutScheduledUpdateGroupAction operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putScheduledUpdateGroupAction
default PutScheduledUpdateGroupActionResponse putScheduledUpdateGroupAction(Consumer<PutScheduledUpdateGroupActionRequest.Builder> putScheduledUpdateGroupActionRequest) throws AlreadyExistsException, LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a scheduled scaling action for an Auto Scaling group.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error message.
This is a convenience which creates an instance of the
PutScheduledUpdateGroupActionRequest.Builderavoiding the need to create one manually viaPutScheduledUpdateGroupActionRequest.builder()- Parameters:
putScheduledUpdateGroupActionRequest- AConsumerthat will call methods onPutScheduledUpdateGroupActionRequest.Builderto create a request.- Returns:
- Result of the PutScheduledUpdateGroupAction operation returned by the service.
- Throws:
AlreadyExistsException- You already have an Auto Scaling group or launch configuration with this name.LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putWarmPool
default PutWarmPoolResponse putWarmPool(PutWarmPoolRequest putWarmPoolRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
- Parameters:
putWarmPoolRequest-- Returns:
- Result of the PutWarmPool operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
putWarmPool
default PutWarmPoolResponse putWarmPool(Consumer<PutWarmPoolRequest.Builder> putWarmPoolRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
This is a convenience which creates an instance of the
PutWarmPoolRequest.Builderavoiding the need to create one manually viaPutWarmPoolRequest.builder()- Parameters:
putWarmPoolRequest- AConsumerthat will call methods onPutWarmPoolRequest.Builderto create a request.- Returns:
- Result of the PutWarmPool operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
recordLifecycleActionHeartbeat
default RecordLifecycleActionHeartbeatResponse recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
recordLifecycleActionHeartbeatRequest-- Returns:
- Result of the RecordLifecycleActionHeartbeat operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
recordLifecycleActionHeartbeat
default RecordLifecycleActionHeartbeatResponse recordLifecycleActionHeartbeat(Consumer<RecordLifecycleActionHeartbeatRequest.Builder> recordLifecycleActionHeartbeatRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
-
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
-
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
-
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
-
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
-
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
-
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
RecordLifecycleActionHeartbeatRequest.Builderavoiding the need to create one manually viaRecordLifecycleActionHeartbeatRequest.builder()- Parameters:
recordLifecycleActionHeartbeatRequest- AConsumerthat will call methods onRecordLifecycleActionHeartbeatRequest.Builderto create a request.- Returns:
- Result of the RecordLifecycleActionHeartbeat operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
resumeProcesses
default ResumeProcessesResponse resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
resumeProcessesRequest-- Returns:
- Result of the ResumeProcesses operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
resumeProcesses
default ResumeProcessesResponse resumeProcesses(Consumer<ResumeProcessesRequest.Builder> resumeProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
ResumeProcessesRequest.Builderavoiding the need to create one manually viaResumeProcessesRequest.builder()- Parameters:
resumeProcessesRequest- AConsumerthat will call methods onResumeProcessesRequest.Builderto create a request.- Returns:
- Result of the ResumeProcesses operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
rollbackInstanceRefresh
default RollbackInstanceRefreshResponse rollbackInstanceRefresh(RollbackInstanceRefreshRequest rollbackInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, IrreversibleInstanceRefreshException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
-
There is no desired configuration specified for the instance refresh.
-
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageIdproperty. -
The Auto Scaling group uses the launch template's
$Latestor$Defaultversion.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
- Parameters:
rollbackInstanceRefreshRequest-- Returns:
- Result of the RollbackInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ActiveInstanceRefreshNotFoundException- The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.IrreversibleInstanceRefreshException- The request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latestor$Default) is present on the Auto Scaling group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
rollbackInstanceRefresh
default RollbackInstanceRefreshResponse rollbackInstanceRefresh(Consumer<RollbackInstanceRefreshRequest.Builder> rollbackInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, IrreversibleInstanceRefreshException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
-
There is no desired configuration specified for the instance refresh.
-
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageIdproperty. -
The Auto Scaling group uses the launch template's
$Latestor$Defaultversion.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
This is a convenience which creates an instance of the
RollbackInstanceRefreshRequest.Builderavoiding the need to create one manually viaRollbackInstanceRefreshRequest.builder()- Parameters:
rollbackInstanceRefreshRequest- AConsumerthat will call methods onRollbackInstanceRefreshRequest.Builderto create a request.- Returns:
- Result of the RollbackInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ActiveInstanceRefreshNotFoundException- The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.IrreversibleInstanceRefreshException- The request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latestor$Default) is present on the Auto Scaling group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
setDesiredCapacity
default SetDesiredCapacityResponse setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new
DesiredCapacityvalue that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
setDesiredCapacityRequest-- Returns:
- Result of the SetDesiredCapacity operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setDesiredCapacity
default SetDesiredCapacityResponse setDesiredCapacity(Consumer<SetDesiredCapacityRequest.Builder> setDesiredCapacityRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new
DesiredCapacityvalue that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
SetDesiredCapacityRequest.Builderavoiding the need to create one manually viaSetDesiredCapacityRequest.builder()- Parameters:
setDesiredCapacityRequest- AConsumerthat will call methods onSetDesiredCapacityRequest.Builderto create a request.- Returns:
- Result of the SetDesiredCapacity operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setInstanceHealth
default SetInstanceHealthResponse setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
setInstanceHealthRequest-- Returns:
- Result of the SetInstanceHealth operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setInstanceHealth
default SetInstanceHealthResponse setInstanceHealth(Consumer<SetInstanceHealthRequest.Builder> setInstanceHealthRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
SetInstanceHealthRequest.Builderavoiding the need to create one manually viaSetInstanceHealthRequest.builder()- Parameters:
setInstanceHealthRequest- AConsumerthat will call methods onSetInstanceHealthRequest.Builderto create a request.- Returns:
- Result of the SetInstanceHealth operation returned by the service.
- Throws:
ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setInstanceProtection
default SetInstanceProtectionResponse setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
- Parameters:
setInstanceProtectionRequest-- Returns:
- Result of the SetInstanceProtection operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
setInstanceProtection
default SetInstanceProtectionResponse setInstanceProtection(Consumer<SetInstanceProtectionRequest.Builder> setInstanceProtectionRequest) throws LimitExceededException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
This is a convenience which creates an instance of the
SetInstanceProtectionRequest.Builderavoiding the need to create one manually viaSetInstanceProtectionRequest.builder()- Parameters:
setInstanceProtectionRequest- AConsumerthat will call methods onSetInstanceProtectionRequest.Builderto create a request.- Returns:
- Result of the SetInstanceProtection operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startInstanceRefresh
default StartInstanceRefreshResponse startInstanceRefresh(StartInstanceRefreshRequest startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException
Starts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in
Standbystate or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the
AutoRollbackproperty in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.- Parameters:
startInstanceRefreshRequest-- Returns:
- Result of the StartInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InstanceRefreshInProgressException- The request failed because an active instance refresh already exists for the specified Auto Scaling group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
startInstanceRefresh
default StartInstanceRefreshResponse startInstanceRefresh(Consumer<StartInstanceRefreshRequest.Builder> startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException
Starts an instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in
Standbystate or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the
AutoRollbackproperty in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
This is a convenience which creates an instance of the
StartInstanceRefreshRequest.Builderavoiding the need to create one manually viaStartInstanceRefreshRequest.builder()- Parameters:
startInstanceRefreshRequest- AConsumerthat will call methods onStartInstanceRefreshRequest.Builderto create a request.- Returns:
- Result of the StartInstanceRefresh operation returned by the service.
- Throws:
LimitExceededException- You have already reached a limit for your Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).InstanceRefreshInProgressException- The request failed because an active instance refresh already exists for the specified Auto Scaling group.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
suspendProcesses
default SuspendProcessesResponse suspendProcesses(SuspendProcessesRequest suspendProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
LaunchorTerminateprocess types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.To resume processes that have been suspended, call the ResumeProcesses API.
- Parameters:
suspendProcessesRequest-- Returns:
- Result of the SuspendProcesses operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
suspendProcesses
default SuspendProcessesResponse suspendProcesses(Consumer<SuspendProcessesRequest.Builder> suspendProcessesRequest) throws ResourceInUseException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
LaunchorTerminateprocess types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.To resume processes that have been suspended, call the ResumeProcesses API.
This is a convenience which creates an instance of the
SuspendProcessesRequest.Builderavoiding the need to create one manually viaSuspendProcessesRequest.builder()- Parameters:
suspendProcessesRequest- AConsumerthat will call methods onSuspendProcessesRequest.Builderto create a request.- Returns:
- Result of the SuspendProcesses operation returned by the service.
- Throws:
ResourceInUseException- The operation can't be performed because the resource is in use.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
terminateInstanceInAutoScalingGroup
default TerminateInstanceInAutoScalingGroupResponse terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to
terminated. You can't connect to or start an instance after you've terminated it.If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
- Parameters:
terminateInstanceInAutoScalingGroupRequest-- Returns:
- Result of the TerminateInstanceInAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
terminateInstanceInAutoScalingGroup
default TerminateInstanceInAutoScalingGroupResponse terminateInstanceInAutoScalingGroup(Consumer<TerminateInstanceInAutoScalingGroupRequest.Builder> terminateInstanceInAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to
terminated. You can't connect to or start an instance after you've terminated it.If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the
TerminateInstanceInAutoScalingGroupRequest.Builderavoiding the need to create one manually viaTerminateInstanceInAutoScalingGroupRequest.builder()- Parameters:
terminateInstanceInAutoScalingGroupRequest- AConsumerthat will call methods onTerminateInstanceInAutoScalingGroupRequest.Builderto create a request.- Returns:
- Result of the TerminateInstanceInAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
updateAutoScalingGroup
default UpdateAutoScalingGroupResponse updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing
DesiredCapacity,MaxSize, orMinSize:-
If a scale-in activity occurs as a result of a new
DesiredCapacityvalue that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. -
If you specify a new value for
MinSizewithout specifying a value forDesiredCapacity, and the newMinSizeis larger than the current size of the group, this sets the group'sDesiredCapacityto the newMinSizevalue. -
If you specify a new value for
MaxSizewithout specifying a value forDesiredCapacity, and the newMaxSizeis smaller than the current size of the group, this sets the group'sDesiredCapacityto the newMaxSizevalue.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
- Parameters:
updateAutoScalingGroupRequest-- Returns:
- Result of the UpdateAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
updateAutoScalingGroup
default UpdateAutoScalingGroupResponse updateAutoScalingGroup(Consumer<UpdateAutoScalingGroupRequest.Builder> updateAutoScalingGroupRequest) throws ScalingActivityInProgressException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing
DesiredCapacity,MaxSize, orMinSize:-
If a scale-in activity occurs as a result of a new
DesiredCapacityvalue that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. -
If you specify a new value for
MinSizewithout specifying a value forDesiredCapacity, and the newMinSizeis larger than the current size of the group, this sets the group'sDesiredCapacityto the newMinSizevalue. -
If you specify a new value for
MaxSizewithout specifying a value forDesiredCapacity, and the newMaxSizeis smaller than the current size of the group, this sets the group'sDesiredCapacityto the newMaxSizevalue.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
This is a convenience which creates an instance of the
UpdateAutoScalingGroupRequest.Builderavoiding the need to create one manually viaUpdateAutoScalingGroupRequest.builder()- Parameters:
updateAutoScalingGroupRequest- AConsumerthat will call methods onUpdateAutoScalingGroupRequest.Builderto create a request.- Returns:
- Result of the UpdateAutoScalingGroup operation returned by the service.
- Throws:
ScalingActivityInProgressException- The operation can't be performed because there are scaling activities in progress.ResourceContentionException- You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).ServiceLinkedRoleFailureException- The service-linked role is not yet ready for use.SdkException- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.SdkClientException- If any client side error occurs such as an IO related failure, failure to get credentials, etc.AutoScalingException- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException- See Also:
- AWS API Documentation
-
-
waiter
default AutoScalingWaiter waiter()
Create an instance ofAutoScalingWaiterusing 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
AutoScalingWaiter
-
create
static AutoScalingClient create()
Create aAutoScalingClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static AutoScalingClientBuilder builder()
Create a builder that can be used to configure and create aAutoScalingClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default AutoScalingServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-