@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface AutoScalingClient extends SdkClient
builder() method.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AttachInstancesResponse |
attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
default AttachInstancesResponse |
attachInstances(Consumer<AttachInstancesRequest.Builder> attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
default AttachLoadBalancersResponse |
attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest)
|
default AttachLoadBalancersResponse |
attachLoadBalancers(Consumer<AttachLoadBalancersRequest.Builder> attachLoadBalancersRequest)
|
default AttachLoadBalancerTargetGroupsResponse |
attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest)
Attaches one or more target groups to the specified Auto Scaling group.
|
default AttachLoadBalancerTargetGroupsResponse |
attachLoadBalancerTargetGroups(Consumer<AttachLoadBalancerTargetGroupsRequest.Builder> attachLoadBalancerTargetGroupsRequest)
Attaches one or more target groups to the specified Auto Scaling group.
|
default BatchDeleteScheduledActionResponse |
batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest)
Deletes one or more scheduled actions for the specified Auto Scaling group.
|
default BatchDeleteScheduledActionResponse |
batchDeleteScheduledAction(Consumer<BatchDeleteScheduledActionRequest.Builder> batchDeleteScheduledActionRequest)
Deletes one or more scheduled actions for the specified Auto Scaling group.
|
default BatchPutScheduledUpdateGroupActionResponse |
batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest)
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
|
default BatchPutScheduledUpdateGroupActionResponse |
batchPutScheduledUpdateGroupAction(Consumer<BatchPutScheduledUpdateGroupActionRequest.Builder> batchPutScheduledUpdateGroupActionRequest)
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
|
static AutoScalingClientBuilder |
builder()
Create a builder that can be used to configure and create a
AutoScalingClient. |
default CancelInstanceRefreshResponse |
cancelInstanceRefresh(CancelInstanceRefreshRequest cancelInstanceRefreshRequest)
Cancels an instance refresh operation in progress.
|
default CancelInstanceRefreshResponse |
cancelInstanceRefresh(Consumer<CancelInstanceRefreshRequest.Builder> cancelInstanceRefreshRequest)
Cancels an instance refresh operation in progress.
|
default CompleteLifecycleActionResponse |
completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
Completes the lifecycle action for the specified token or instance with the specified result.
|
default CompleteLifecycleActionResponse |
completeLifecycleAction(Consumer<CompleteLifecycleActionRequest.Builder> completeLifecycleActionRequest)
Completes the lifecycle action for the specified token or instance with the specified result.
|
static AutoScalingClient |
create()
Create a
AutoScalingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateAutoScalingGroupResponse |
createAutoScalingGroup(Consumer<CreateAutoScalingGroupRequest.Builder> createAutoScalingGroupRequest)
We strongly recommend using a launch template when calling this operation to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
default CreateAutoScalingGroupResponse |
createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
We strongly recommend using a launch template when calling this operation to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
default CreateLaunchConfigurationResponse |
createLaunchConfiguration(Consumer<CreateLaunchConfigurationRequest.Builder> createLaunchConfigurationRequest)
Creates a launch configuration.
|
default CreateLaunchConfigurationResponse |
createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
Creates a launch configuration.
|
default CreateOrUpdateTagsResponse |
createOrUpdateTags(Consumer<CreateOrUpdateTagsRequest.Builder> createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
|
default CreateOrUpdateTagsResponse |
createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
|
default DeleteAutoScalingGroupResponse |
deleteAutoScalingGroup(Consumer<DeleteAutoScalingGroupRequest.Builder> deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
|
default DeleteAutoScalingGroupResponse |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
|
default DeleteLaunchConfigurationResponse |
deleteLaunchConfiguration(Consumer<DeleteLaunchConfigurationRequest.Builder> deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
|
default DeleteLaunchConfigurationResponse |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
|
default DeleteLifecycleHookResponse |
deleteLifecycleHook(Consumer<DeleteLifecycleHookRequest.Builder> deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
|
default DeleteLifecycleHookResponse |
deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
|
default DeleteNotificationConfigurationResponse |
deleteNotificationConfiguration(Consumer<DeleteNotificationConfigurationRequest.Builder> deleteNotificationConfigurationRequest)
Deletes the specified notification.
|
default DeleteNotificationConfigurationResponse |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
|
default DeletePolicyResponse |
deletePolicy(Consumer<DeletePolicyRequest.Builder> deletePolicyRequest)
Deletes the specified scaling policy.
|
default DeletePolicyResponse |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified scaling policy.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(Consumer<DeleteScheduledActionRequest.Builder> deleteScheduledActionRequest)
Deletes the specified scheduled action.
|
default DeleteScheduledActionResponse |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
|
default DeleteTagsResponse |
deleteTags(Consumer<DeleteTagsRequest.Builder> deleteTagsRequest)
Deletes the specified tags.
|
default DeleteTagsResponse |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
|
default DeleteWarmPoolResponse |
deleteWarmPool(Consumer<DeleteWarmPoolRequest.Builder> deleteWarmPoolRequest)
Deletes the warm pool for the specified Auto Scaling group.
|
default DeleteWarmPoolResponse |
deleteWarmPool(DeleteWarmPoolRequest deleteWarmPoolRequest)
Deletes the warm pool for the specified Auto Scaling group.
|
default DescribeAccountLimitsResponse |
describeAccountLimits()
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(Consumer<DescribeAccountLimitsRequest.Builder> describeAccountLimitsRequest)
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
|
default DescribeAccountLimitsResponse |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
|
default DescribeAdjustmentTypesResponse |
describeAdjustmentTypes()
Describes the available adjustment types for step scaling and simple scaling policies.
|
default DescribeAdjustmentTypesResponse |
describeAdjustmentTypes(Consumer<DescribeAdjustmentTypesRequest.Builder> describeAdjustmentTypesRequest)
Describes the available adjustment types for step scaling and simple scaling policies.
|
default DescribeAdjustmentTypesResponse |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the available adjustment types for step scaling and simple scaling policies.
|
default DescribeAutoScalingGroupsResponse |
describeAutoScalingGroups()
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingGroupsResponse |
describeAutoScalingGroups(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest)
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingGroupsResponse |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingGroupsIterable |
describeAutoScalingGroupsPaginator()
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingGroupsIterable |
describeAutoScalingGroupsPaginator(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest)
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingGroupsIterable |
describeAutoScalingGroupsPaginator(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Gets information about the Auto Scaling groups in the account and Region.
|
default DescribeAutoScalingInstancesResponse |
describeAutoScalingInstances()
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingInstancesResponse |
describeAutoScalingInstances(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest)
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingInstancesResponse |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingInstancesIterable |
describeAutoScalingInstancesPaginator()
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingInstancesIterable |
describeAutoScalingInstancesPaginator(Consumer<DescribeAutoScalingInstancesRequest.Builder> describeAutoScalingInstancesRequest)
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingInstancesIterable |
describeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Gets information about the Auto Scaling instances in the account and Region.
|
default DescribeAutoScalingNotificationTypesResponse |
describeAutoScalingNotificationTypes()
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
default DescribeAutoScalingNotificationTypesResponse |
describeAutoScalingNotificationTypes(Consumer<DescribeAutoScalingNotificationTypesRequest.Builder> describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
default DescribeAutoScalingNotificationTypesResponse |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
|
default DescribeInstanceRefreshesResponse |
describeInstanceRefreshes(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest)
Gets information about the instance refreshes for the specified Auto Scaling group.
|
default DescribeInstanceRefreshesResponse |
describeInstanceRefreshes(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest)
Gets information about the instance refreshes for the specified Auto Scaling group.
|
default DescribeLaunchConfigurationsResponse |
describeLaunchConfigurations()
Gets information about the launch configurations in the account and Region.
|
default DescribeLaunchConfigurationsResponse |
describeLaunchConfigurations(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest)
Gets information about the launch configurations in the account and Region.
|
default DescribeLaunchConfigurationsResponse |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Gets information about the launch configurations in the account and Region.
|
default DescribeLaunchConfigurationsIterable |
describeLaunchConfigurationsPaginator()
Gets information about the launch configurations in the account and Region.
|
default DescribeLaunchConfigurationsIterable |
describeLaunchConfigurationsPaginator(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest)
Gets information about the launch configurations in the account and Region.
|
default DescribeLaunchConfigurationsIterable |
describeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Gets information about the launch configurations in the account and Region.
|
default DescribeLifecycleHooksResponse |
describeLifecycleHooks(Consumer<DescribeLifecycleHooksRequest.Builder> describeLifecycleHooksRequest)
Gets information about the lifecycle hooks for the specified Auto Scaling group.
|
default DescribeLifecycleHooksResponse |
describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Gets information about the lifecycle hooks for the specified Auto Scaling group.
|
default DescribeLifecycleHookTypesResponse |
describeLifecycleHookTypes()
Describes the available types of lifecycle hooks.
|
default DescribeLifecycleHookTypesResponse |
describeLifecycleHookTypes(Consumer<DescribeLifecycleHookTypesRequest.Builder> describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
|
default DescribeLifecycleHookTypesResponse |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest)
Gets information about the load balancers for the specified Auto Scaling group.
|
default DescribeLoadBalancersResponse |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Gets information about the load balancers for the specified Auto Scaling group.
|
default DescribeLoadBalancerTargetGroupsResponse |
describeLoadBalancerTargetGroups(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest)
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
|
default DescribeLoadBalancerTargetGroupsResponse |
describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest)
Gets information about the Elastic Load Balancing target groups for the specified Auto Scaling group.
|
default DescribeMetricCollectionTypesResponse |
describeMetricCollectionTypes()
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
default DescribeMetricCollectionTypesResponse |
describeMetricCollectionTypes(Consumer<DescribeMetricCollectionTypesRequest.Builder> describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
default DescribeMetricCollectionTypesResponse |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
default DescribeNotificationConfigurationsResponse |
describeNotificationConfigurations()
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribeNotificationConfigurationsResponse |
describeNotificationConfigurations(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest)
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribeNotificationConfigurationsResponse |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribeNotificationConfigurationsIterable |
describeNotificationConfigurationsPaginator()
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribeNotificationConfigurationsIterable |
describeNotificationConfigurationsPaginator(Consumer<DescribeNotificationConfigurationsRequest.Builder> describeNotificationConfigurationsRequest)
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribeNotificationConfigurationsIterable |
describeNotificationConfigurationsPaginator(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
|
default DescribePoliciesResponse |
describePolicies()
Gets information about the scaling policies in the account and Region.
|
default DescribePoliciesResponse |
describePolicies(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest)
Gets information about the scaling policies in the account and Region.
|
default DescribePoliciesResponse |
describePolicies(DescribePoliciesRequest describePoliciesRequest)
Gets information about the scaling policies in the account and Region.
|
default DescribePoliciesIterable |
describePoliciesPaginator()
Gets information about the scaling policies in the account and Region.
|
default DescribePoliciesIterable |
describePoliciesPaginator(Consumer<DescribePoliciesRequest.Builder> describePoliciesRequest)
Gets information about the scaling policies in the account and Region.
|
default DescribePoliciesIterable |
describePoliciesPaginator(DescribePoliciesRequest describePoliciesRequest)
Gets information about the scaling policies in the account and Region.
|
default DescribeScalingActivitiesResponse |
describeScalingActivities()
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingActivitiesResponse |
describeScalingActivities(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingActivitiesResponse |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingActivitiesIterable |
describeScalingActivitiesPaginator()
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingActivitiesIterable |
describeScalingActivitiesPaginator(Consumer<DescribeScalingActivitiesRequest.Builder> describeScalingActivitiesRequest)
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingActivitiesIterable |
describeScalingActivitiesPaginator(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Gets information about the scaling activities in the account and Region.
|
default DescribeScalingProcessTypesResponse |
describeScalingProcessTypes()
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
|
default DescribeScalingProcessTypesResponse |
describeScalingProcessTypes(Consumer<DescribeScalingProcessTypesRequest.Builder> describeScalingProcessTypesRequest)
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
|
default DescribeScalingProcessTypesResponse |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
|
default DescribeScheduledActionsResponse |
describeScheduledActions()
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeScheduledActionsResponse |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator()
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(Consumer<DescribeScheduledActionsRequest.Builder> describeScheduledActionsRequest)
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeScheduledActionsIterable |
describeScheduledActionsPaginator(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Gets information about the scheduled actions that haven't run or that have not reached their end time.
|
default DescribeTagsResponse |
describeTags()
Describes the specified tags.
|
default DescribeTagsResponse |
describeTags(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags.
|
default DescribeTagsResponse |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
|
default DescribeTagsIterable |
describeTagsPaginator()
Describes the specified tags.
|
default DescribeTagsIterable |
describeTagsPaginator(Consumer<DescribeTagsRequest.Builder> describeTagsRequest)
Describes the specified tags.
|
default DescribeTagsIterable |
describeTagsPaginator(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
|
default DescribeTerminationPolicyTypesResponse |
describeTerminationPolicyTypes()
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
default DescribeTerminationPolicyTypesResponse |
describeTerminationPolicyTypes(Consumer<DescribeTerminationPolicyTypesRequest.Builder> describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
default DescribeTerminationPolicyTypesResponse |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
default DescribeWarmPoolResponse |
describeWarmPool(Consumer<DescribeWarmPoolRequest.Builder> describeWarmPoolRequest)
Gets information about a warm pool and its instances.
|
default DescribeWarmPoolResponse |
describeWarmPool(DescribeWarmPoolRequest describeWarmPoolRequest)
Gets information about a warm pool and its instances.
|
default DetachInstancesResponse |
detachInstances(Consumer<DetachInstancesRequest.Builder> detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group.
|
default DetachInstancesResponse |
detachInstances(DetachInstancesRequest detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group.
|
default DetachLoadBalancersResponse |
detachLoadBalancers(Consumer<DetachLoadBalancersRequest.Builder> detachLoadBalancersRequest)
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
|
default DetachLoadBalancersResponse |
detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
|
default DetachLoadBalancerTargetGroupsResponse |
detachLoadBalancerTargetGroups(Consumer<DetachLoadBalancerTargetGroupsRequest.Builder> detachLoadBalancerTargetGroupsRequest)
Detaches one or more target groups from the specified Auto Scaling group.
|
default DetachLoadBalancerTargetGroupsResponse |
detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest)
Detaches one or more target groups from the specified Auto Scaling group.
|
default DisableMetricsCollectionResponse |
disableMetricsCollection(Consumer<DisableMetricsCollectionRequest.Builder> disableMetricsCollectionRequest)
Disables group metrics collection for the specified Auto Scaling group.
|
default DisableMetricsCollectionResponse |
disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables group metrics collection for the specified Auto Scaling group.
|
default EnableMetricsCollectionResponse |
enableMetricsCollection(Consumer<EnableMetricsCollectionRequest.Builder> enableMetricsCollectionRequest)
Enables group metrics collection for the specified Auto Scaling group.
|
default EnableMetricsCollectionResponse |
enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
Enables group metrics collection for the specified Auto Scaling group.
|
default EnterStandbyResponse |
enterStandby(Consumer<EnterStandbyRequest.Builder> enterStandbyRequest)
Moves the specified instances into the standby state.
|
default EnterStandbyResponse |
enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves the specified instances into the standby state.
|
default ExecutePolicyResponse |
executePolicy(Consumer<ExecutePolicyRequest.Builder> executePolicyRequest)
Executes the specified policy.
|
default ExecutePolicyResponse |
executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
|
default ExitStandbyResponse |
exitStandby(Consumer<ExitStandbyRequest.Builder> exitStandbyRequest)
Moves the specified instances out of the standby state.
|
default ExitStandbyResponse |
exitStandby(ExitStandbyRequest exitStandbyRequest)
Moves the specified instances out of the standby state.
|
default GetPredictiveScalingForecastResponse |
getPredictiveScalingForecast(Consumer<GetPredictiveScalingForecastRequest.Builder> getPredictiveScalingForecastRequest)
Retrieves the forecast data for a predictive scaling policy.
|
default GetPredictiveScalingForecastResponse |
getPredictiveScalingForecast(GetPredictiveScalingForecastRequest getPredictiveScalingForecastRequest)
Retrieves the forecast data for a predictive scaling policy.
|
default PutLifecycleHookResponse |
putLifecycleHook(Consumer<PutLifecycleHookRequest.Builder> putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
default PutLifecycleHookResponse |
putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
default PutNotificationConfigurationResponse |
putNotificationConfiguration(Consumer<PutNotificationConfigurationRequest.Builder> putNotificationConfigurationRequest)
Configures an Auto Scaling group to send notifications when specified events take place.
|
default PutNotificationConfigurationResponse |
putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
Configures an Auto Scaling group to send notifications when specified events take place.
|
default PutScalingPolicyResponse |
putScalingPolicy(Consumer<PutScalingPolicyRequest.Builder> putScalingPolicyRequest)
Creates or updates a scaling policy for an Auto Scaling group.
|
default PutScalingPolicyResponse |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a scaling policy for an Auto Scaling group.
|
default PutScheduledUpdateGroupActionResponse |
putScheduledUpdateGroupAction(Consumer<PutScheduledUpdateGroupActionRequest.Builder> putScheduledUpdateGroupActionRequest)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
default PutScheduledUpdateGroupActionResponse |
putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
default PutWarmPoolResponse |
putWarmPool(Consumer<PutWarmPoolRequest.Builder> putWarmPoolRequest)
Creates or updates a warm pool for the specified Auto Scaling group.
|
default PutWarmPoolResponse |
putWarmPool(PutWarmPoolRequest putWarmPoolRequest)
Creates or updates a warm pool for the specified Auto Scaling group.
|
default RecordLifecycleActionHeartbeatResponse |
recordLifecycleActionHeartbeat(Consumer<RecordLifecycleActionHeartbeatRequest.Builder> recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with the specified token or instance.
|
default RecordLifecycleActionHeartbeatResponse |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with the specified token or instance.
|
default ResumeProcessesResponse |
resumeProcesses(Consumer<ResumeProcessesRequest.Builder> resumeProcessesRequest)
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling
group.
|
default ResumeProcessesResponse |
resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling
group.
|
static ServiceMetadata |
serviceMetadata() |
default SetDesiredCapacityResponse |
setDesiredCapacity(Consumer<SetDesiredCapacityRequest.Builder> setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
|
default SetDesiredCapacityResponse |
setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
|
default SetInstanceHealthResponse |
setInstanceHealth(Consumer<SetInstanceHealthRequest.Builder> setInstanceHealthRequest)
Sets the health status of the specified instance.
|
default SetInstanceHealthResponse |
setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of the specified instance.
|
default SetInstanceProtectionResponse |
setInstanceProtection(Consumer<SetInstanceProtectionRequest.Builder> setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
|
default SetInstanceProtectionResponse |
setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
|
default StartInstanceRefreshResponse |
startInstanceRefresh(Consumer<StartInstanceRefreshRequest.Builder> startInstanceRefreshRequest)
Starts a new instance refresh operation.
|
default StartInstanceRefreshResponse |
startInstanceRefresh(StartInstanceRefreshRequest startInstanceRefreshRequest)
Starts a new instance refresh operation.
|
default SuspendProcessesResponse |
suspendProcesses(Consumer<SuspendProcessesRequest.Builder> suspendProcessesRequest)
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
|
default SuspendProcessesResponse |
suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
|
default TerminateInstanceInAutoScalingGroupResponse |
terminateInstanceInAutoScalingGroup(Consumer<TerminateInstanceInAutoScalingGroupRequest.Builder> terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
|
default TerminateInstanceInAutoScalingGroupResponse |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
|
default UpdateAutoScalingGroupResponse |
updateAutoScalingGroup(Consumer<UpdateAutoScalingGroupRequest.Builder> updateAutoScalingGroupRequest)
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
default UpdateAutoScalingGroupResponse |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for
Amazon EC2 Auto Scaling and Amazon EC2.
|
default AutoScalingWaiter |
waiter()
Create an instance of
AutoScalingWaiter using this client. |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static AutoScalingClient create()
AutoScalingClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static AutoScalingClientBuilder builder()
AutoScalingClient.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.
attachInstancesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via AttachInstancesRequest.builder()
attachInstancesRequest - A Consumer that will call methods on AttachInstancesQuery.Builder to create a request.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.AwsServiceExceptiondefault AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
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.
attachLoadBalancerTargetGroupsRequest - 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.AwsServiceExceptiondefault AttachLoadBalancerTargetGroupsResponse attachLoadBalancerTargetGroups(Consumer<AttachLoadBalancerTargetGroupsRequest.Builder> attachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
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.Builder
avoiding the need to create one manually via AttachLoadBalancerTargetGroupsRequest.builder()
attachLoadBalancerTargetGroupsRequest - A Consumer that will call methods on AttachLoadBalancerTargetGroupsType.Builder to create
a request.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.AwsServiceExceptiondefault AttachLoadBalancersResponse attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
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.
attachLoadBalancersRequest - 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.AwsServiceExceptiondefault AttachLoadBalancersResponse attachLoadBalancers(Consumer<AttachLoadBalancersRequest.Builder> attachLoadBalancersRequest) throws ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
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.Builder avoiding the
need to create one manually via AttachLoadBalancersRequest.builder()
attachLoadBalancersRequest - A Consumer that will call methods on AttachLoadBalancersType.Builder to create a request.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.AwsServiceExceptiondefault BatchDeleteScheduledActionResponse batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes one or more scheduled actions for the specified Auto Scaling group.
batchDeleteScheduledActionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via BatchDeleteScheduledActionRequest.builder()
batchDeleteScheduledActionRequest - A Consumer that will call methods on BatchDeleteScheduledActionType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
batchPutScheduledUpdateGroupActionRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via BatchPutScheduledUpdateGroupActionRequest.builder()
batchPutScheduledUpdateGroupActionRequest - A Consumer that will call methods on BatchPutScheduledUpdateGroupActionType.Builder to
create a request.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.AwsServiceExceptiondefault CancelInstanceRefreshResponse cancelInstanceRefresh(CancelInstanceRefreshRequest cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
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.
cancelInstanceRefreshRequest - 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 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.AwsServiceExceptiondefault CancelInstanceRefreshResponse cancelInstanceRefresh(Consumer<CancelInstanceRefreshRequest.Builder> cancelInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, ActiveInstanceRefreshNotFoundException, AwsServiceException, SdkClientException, AutoScalingException
Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
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.
This is a convenience which creates an instance of the CancelInstanceRefreshRequest.Builder avoiding the
need to create one manually via CancelInstanceRefreshRequest.builder()
cancelInstanceRefreshRequest - A Consumer that will call methods on CancelInstanceRefreshType.Builder to create a
request.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 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.AwsServiceExceptiondefault 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 Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
completeLifecycleActionRequest - 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.AwsServiceExceptiondefault 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 Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
This is a convenience which creates an instance of the CompleteLifecycleActionRequest.Builder avoiding
the need to create one manually via CompleteLifecycleActionRequest.builder()
completeLifecycleActionRequest - A Consumer that will call methods on CompleteLifecycleActionType.Builder to create a
request.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.AwsServiceExceptiondefault 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, and
MinSize). 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.
createAutoScalingGroupRequest - 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.AwsServiceExceptiondefault 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, and
MinSize). 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.Builder avoiding the
need to create one manually via CreateAutoScalingGroupRequest.builder()
createAutoScalingGroupRequest - A Consumer that will call methods on CreateAutoScalingGroupType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
createLaunchConfigurationRequest - 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.AwsServiceExceptiondefault 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.
This is a convenience which creates an instance of the CreateLaunchConfigurationRequest.Builder avoiding
the need to create one manually via CreateLaunchConfigurationRequest.builder()
createLaunchConfigurationRequest - A Consumer that will call methods on CreateLaunchConfigurationType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
createOrUpdateTagsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via CreateOrUpdateTagsRequest.builder()
createOrUpdateTagsRequest - A Consumer that will call methods on CreateOrUpdateTagsType.Builder to create a request.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.AwsServiceExceptiondefault 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.
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
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.
deleteAutoScalingGroupRequest - 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.AwsServiceExceptiondefault 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.
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
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.
This is a convenience which creates an instance of the DeleteAutoScalingGroupRequest.Builder avoiding the
need to create one manually via DeleteAutoScalingGroupRequest.builder()
deleteAutoScalingGroupRequest - A Consumer that will call methods on DeleteAutoScalingGroupType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
deleteLaunchConfigurationRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DeleteLaunchConfigurationRequest.builder()
deleteLaunchConfigurationRequest - A Consumer that will call methods on LaunchConfigurationNameType.Builder to create a
request.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.AwsServiceExceptiondefault 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 (ABANDON for launching
instances, CONTINUE for terminating instances).
deleteLifecycleHookRequest - 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.AwsServiceExceptiondefault 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 (ABANDON for launching
instances, CONTINUE for terminating instances).
This is a convenience which creates an instance of the DeleteLifecycleHookRequest.Builder avoiding the
need to create one manually via DeleteLifecycleHookRequest.builder()
deleteLifecycleHookRequest - A Consumer that will call methods on DeleteLifecycleHookType.Builder to create a request.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.AwsServiceExceptiondefault DeleteNotificationConfigurationResponse deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified notification.
deleteNotificationConfigurationRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DeleteNotificationConfigurationRequest.builder()
deleteNotificationConfigurationRequest - A Consumer that will call methods on DeleteNotificationConfigurationType.Builder to create
a request.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.AwsServiceExceptiondefault 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.
deletePolicyRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeletePolicyRequest.builder()
deletePolicyRequest - A Consumer that will call methods on DeletePolicyType.Builder to create a request.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.AwsServiceExceptiondefault DeleteScheduledActionResponse deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified scheduled action.
deleteScheduledActionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DeleteScheduledActionRequest.builder()
deleteScheduledActionRequest - A Consumer that will call methods on DeleteScheduledActionType.Builder to create a
request.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.AwsServiceExceptiondefault DeleteTagsResponse deleteTags(DeleteTagsRequest deleteTagsRequest) throws ResourceContentionException, ResourceInUseException, AwsServiceException, SdkClientException, AutoScalingException
Deletes the specified tags.
deleteTagsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeleteTagsRequest.builder()
deleteTagsRequest - A Consumer that will call methods on DeleteTagsType.Builder to create a request.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.AwsServiceExceptiondefault 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.
deleteWarmPoolRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeleteWarmPoolRequest.builder()
deleteWarmPoolRequest - A Consumer that will call methods on DeleteWarmPoolType.Builder to create a request.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.AwsServiceExceptiondefault 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.
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.AwsServiceExceptiondescribeAccountLimits(DescribeAccountLimitsRequest),
AWS API Documentationdefault 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.
describeAccountLimitsRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeAccountLimitsRequest.builder()
describeAccountLimitsRequest - A Consumer that will call methods on DescribeAccountLimitsRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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
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.AwsServiceExceptiondescribeAdjustmentTypes(DescribeAdjustmentTypesRequest),
AWS API Documentationdefault 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
describeAdjustmentTypesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeAdjustmentTypesRequest.builder()
describeAdjustmentTypesRequest - A Consumer that will call methods on DescribeAdjustmentTypesRequest.Builder to create a
request.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.AwsServiceExceptiondefault 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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeAutoScalingGroups(DescribeAutoScalingGroupsRequest),
AWS API Documentationdefault 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.
describeAutoScalingGroupsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeAutoScalingGroupsRequest.builder()
describeAutoScalingGroupsRequest - A Consumer that will call methods on AutoScalingGroupNamesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator() 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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeAutoScalingGroupsPaginator(DescribeAutoScalingGroupsRequest),
AWS API Documentationdefault DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(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.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeAutoScalingGroupsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingGroupsIterable describeAutoScalingGroupsPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingGroupsIterable responses = client.describeAutoScalingGroupsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeAutoScalingGroupsRequest.builder()
describeAutoScalingGroupsRequest - A Consumer that will call methods on AutoScalingGroupNamesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingInstancesResponse describeAutoScalingInstances() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeAutoScalingInstances(DescribeAutoScalingInstancesRequest),
AWS API Documentationdefault DescribeAutoScalingInstancesResponse describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
describeAutoScalingInstancesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeAutoScalingInstancesRequest.builder()
describeAutoScalingInstancesRequest - A Consumer that will call methods on DescribeAutoScalingInstancesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest),
AWS API Documentationdefault DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the Auto Scaling instances in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeAutoScalingInstancesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingInstancesIterable describeAutoScalingInstancesPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeAutoScalingInstancesIterable responses = client.describeAutoScalingInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeAutoScalingInstancesRequest.builder()
describeAutoScalingInstancesRequest - A Consumer that will call methods on DescribeAutoScalingInstancesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
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.AwsServiceExceptiondescribeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest),
AWS API Documentationdefault DescribeAutoScalingNotificationTypesResponse describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
describeAutoScalingNotificationTypesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to create one manually via
DescribeAutoScalingNotificationTypesRequest.builder()
describeAutoScalingNotificationTypesRequest - A Consumer that will call methods on DescribeAutoScalingNotificationTypesRequest.Builder
to create a request.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.AwsServiceExceptiondefault DescribeInstanceRefreshesResponse describeInstanceRefreshes(DescribeInstanceRefreshesRequest describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the instance refreshes for the specified Auto Scaling group.
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, this operation returns information about the instance refreshes you previously initiated, including their status, 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.
The following are the possible statuses:
Pending - The request was created, but the operation has not started.
InProgress - The operation is in progress.
Successful - The operation completed successfully.
Failed - The operation failed to complete. You can troubleshoot using the status reason and the
scaling activities.
Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any
replacements that have already been completed, but it prevents new replacements from being started.
Cancelled - The operation is cancelled.
describeInstanceRefreshesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeInstanceRefreshesResponse describeInstanceRefreshes(Consumer<DescribeInstanceRefreshesRequest.Builder> describeInstanceRefreshesRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the instance refreshes for the specified Auto Scaling group.
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, this operation returns information about the instance refreshes you previously initiated, including their status, 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.
The following are the possible statuses:
Pending - The request was created, but the operation has not started.
InProgress - The operation is in progress.
Successful - The operation completed successfully.
Failed - The operation failed to complete. You can troubleshoot using the status reason and the
scaling activities.
Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any
replacements that have already been completed, but it prevents new replacements from being started.
Cancelled - The operation is cancelled.
This is a convenience which creates an instance of the DescribeInstanceRefreshesRequest.Builder avoiding
the need to create one manually via DescribeInstanceRefreshesRequest.builder()
describeInstanceRefreshesRequest - A Consumer that will call methods on DescribeInstanceRefreshesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeLaunchConfigurationsResponse describeLaunchConfigurations() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeLaunchConfigurations(DescribeLaunchConfigurationsRequest),
AWS API Documentationdefault DescribeLaunchConfigurationsResponse describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
describeLaunchConfigurationsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeLaunchConfigurationsRequest.builder()
describeLaunchConfigurationsRequest - A Consumer that will call methods on LaunchConfigurationNamesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator() throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest),
AWS API Documentationdefault DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeLaunchConfigurationsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeLaunchConfigurationsIterable describeLaunchConfigurationsPaginator(Consumer<DescribeLaunchConfigurationsRequest.Builder> describeLaunchConfigurationsRequest) throws InvalidNextTokenException, ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the launch configurations in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeLaunchConfigurationsIterable responses = client.describeLaunchConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeLaunchConfigurationsRequest.builder()
describeLaunchConfigurationsRequest - A Consumer that will call methods on LaunchConfigurationNamesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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
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.AwsServiceExceptiondescribeLifecycleHookTypes(DescribeLifecycleHookTypesRequest),
AWS API Documentationdefault 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
describeLifecycleHookTypesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeLifecycleHookTypesRequest.builder()
describeLifecycleHookTypesRequest - A Consumer that will call methods on DescribeLifecycleHookTypesRequest.Builder to create a
request.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.AwsServiceExceptiondefault DescribeLifecycleHooksResponse describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooksRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeLifecycleHooksRequest.builder()
describeLifecycleHooksRequest - A Consumer that will call methods on DescribeLifecycleHooksType.Builder to create a
request.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.AwsServiceExceptiondefault DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
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 State element in the response. When
you attach a target group to an Auto Scaling group, the initial State value is Adding.
The state transitions to Added after 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 to
InService after at least one Auto Scaling instance passes the health check. When the target group is
in the InService state, 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 the
InService state.
Target groups also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your target group state is InService, 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.
describeLoadBalancerTargetGroupsRequest - 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 - The NextToken value 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.AwsServiceExceptiondefault DescribeLoadBalancerTargetGroupsResponse describeLoadBalancerTargetGroups(Consumer<DescribeLoadBalancerTargetGroupsRequest.Builder> describeLoadBalancerTargetGroupsRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
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 State element in the response. When
you attach a target group to an Auto Scaling group, the initial State value is Adding.
The state transitions to Added after 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 to
InService after at least one Auto Scaling instance passes the health check. When the target group is
in the InService state, 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 the
InService state.
Target groups also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your target group state is InService, 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 DescribeLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually via DescribeLoadBalancerTargetGroupsRequest.builder()
describeLoadBalancerTargetGroupsRequest - A Consumer that will call methods on DescribeLoadBalancerTargetGroupsRequest.Builder to
create a request.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 - The NextToken value 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.AwsServiceExceptiondefault DescribeLoadBalancersResponse describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
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 Balancer, use the DescribeLoadBalancerTargetGroups API instead.
To determine the attachment status of the load balancer, use the State element in the response. When
you attach a load balancer to an Auto Scaling group, the initial State value is Adding.
The state transitions to Added after 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
to InService after at least one Auto Scaling instance passes the health check. When the load
balancer is in the InService state, 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 the InService state.
Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your load balancer state is InService, 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.
describeLoadBalancersRequest - 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 - The NextToken value 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.AwsServiceExceptiondefault DescribeLoadBalancersResponse describeLoadBalancers(Consumer<DescribeLoadBalancersRequest.Builder> describeLoadBalancersRequest) throws ResourceContentionException, InvalidNextTokenException, AwsServiceException, SdkClientException, AutoScalingException
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 Balancer, use the DescribeLoadBalancerTargetGroups API instead.
To determine the attachment status of the load balancer, use the State element in the response. When
you attach a load balancer to an Auto Scaling group, the initial State value is Adding.
The state transitions to Added after 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
to InService after at least one Auto Scaling instance passes the health check. When the load
balancer is in the InService state, 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 the InService state.
Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup
API call. If your load balancer state is InService, 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.Builder avoiding the
need to create one manually via DescribeLoadBalancersRequest.builder()
describeLoadBalancersRequest - A Consumer that will call methods on DescribeLoadBalancersRequest.Builder to create a
request.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 - The NextToken value 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.AwsServiceExceptiondefault DescribeMetricCollectionTypesResponse describeMetricCollectionTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
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.AwsServiceExceptiondescribeMetricCollectionTypes(DescribeMetricCollectionTypesRequest),
AWS API Documentationdefault DescribeMetricCollectionTypesResponse describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
describeMetricCollectionTypesRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeMetricCollectionTypesRequest.builder()
describeMetricCollectionTypesRequest - A Consumer that will call methods on DescribeMetricCollectionTypesRequest.Builder to
create a request.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.AwsServiceExceptiondefault 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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeNotificationConfigurations(DescribeNotificationConfigurationsRequest),
AWS API Documentationdefault 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.
describeNotificationConfigurationsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeNotificationConfigurationsRequest.builder()
describeNotificationConfigurationsRequest - A Consumer that will call methods on DescribeNotificationConfigurationsType.Builder to
create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator() 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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeNotificationConfigurationsPaginator(DescribeNotificationConfigurationsRequest),
AWS API Documentationdefault DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(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.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeNotificationConfigurationsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeNotificationConfigurationsIterable describeNotificationConfigurationsPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeNotificationConfigurationsIterable responses = client.describeNotificationConfigurationsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeNotificationConfigurationsRequest.builder()
describeNotificationConfigurationsRequest - A Consumer that will call methods on DescribeNotificationConfigurationsType.Builder to
create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribePoliciesResponse describePolicies() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribePolicies(DescribePoliciesRequest),
AWS
API Documentationdefault DescribePoliciesResponse describePolicies(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
describePoliciesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribePoliciesRequest.builder()
describePoliciesRequest - A Consumer that will call methods on DescribePoliciesType.Builder to create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribePoliciesIterable describePoliciesPaginator() throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribePoliciesPaginator(DescribePoliciesRequest),
AWS
API Documentationdefault DescribePoliciesIterable describePoliciesPaginator(DescribePoliciesRequest describePoliciesRequest) throws InvalidNextTokenException, ResourceContentionException, ServiceLinkedRoleFailureException, AwsServiceException, SdkClientException, AutoScalingException
Gets information about the scaling policies in the account and Region.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describePoliciesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribePoliciesIterable describePoliciesPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribePoliciesIterable responses = client.describePoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via DescribePoliciesRequest.builder()
describePoliciesRequest - A Consumer that will call methods on DescribePoliciesType.Builder to create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeScalingActivities(DescribeScalingActivitiesRequest),
AWS API Documentationdefault 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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
describeScalingActivitiesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, 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.Builder avoiding
the need to create one manually via DescribeScalingActivitiesRequest.builder()
describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeScalingActivitiesIterable describeScalingActivitiesPaginator() 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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeScalingActivitiesPaginator(DescribeScalingActivitiesRequest),
AWS API Documentationdefault DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeScalingActivitiesRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeScalingActivitiesIterable describeScalingActivitiesPaginator(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 StatusCode element in the response is
Successful. If an attempt to launch instances failed, the StatusCode value is
Failed or Cancelled and the StatusMessage element in the response
indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2
Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScalingActivitiesIterable responses = client.describeScalingActivitiesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeScalingActivitiesRequest.builder()
describeScalingActivitiesRequest - A Consumer that will call methods on DescribeScalingActivitiesType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeScalingProcessTypesResponse describeScalingProcessTypes() throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
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.AwsServiceExceptiondescribeScalingProcessTypes(DescribeScalingProcessTypesRequest),
AWS API Documentationdefault DescribeScalingProcessTypesResponse describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
describeScalingProcessTypesRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeScalingProcessTypesRequest.builder()
describeScalingProcessTypesRequest - A Consumer that will call methods on DescribeScalingProcessTypesRequest.Builder to create
a request.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.AwsServiceExceptiondefault 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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeScheduledActions(DescribeScheduledActionsRequest),
AWS API Documentationdefault 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.
describeScheduledActionsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator() 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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeScheduledActionsPaginator(DescribeScheduledActionsRequest),
AWS API Documentationdefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(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.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeScheduledActionsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeScheduledActionsIterable describeScheduledActionsPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeScheduledActionsIterable responses = client.describeScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeScheduledActionsRequest.builder()
describeScheduledActionsRequest - A Consumer that will call methods on DescribeScheduledActionsType.Builder to create a
request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeTags(DescribeTagsRequest),
AWS API
Documentationdefault 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.
describeTagsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on DescribeTagsType.Builder to create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeTagsIterable describeTagsPaginator() 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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondescribeTagsPaginator(DescribeTagsRequest),
AWS API
Documentationdefault DescribeTagsIterable describeTagsPaginator(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.
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
software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeTagsRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault DescribeTagsIterable describeTagsPaginator(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 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
software.amazon.awssdk.services.autoscaling.paginators.DescribeTagsIterable responses = client.describeTagsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via DescribeTagsRequest.builder()
describeTagsRequest - A Consumer that will call methods on DescribeTagsType.Builder to create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.
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.AwsServiceExceptiondescribeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest),
AWS API Documentationdefault 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.
describeTerminationPolicyTypesRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeTerminationPolicyTypesRequest.builder()
describeTerminationPolicyTypesRequest - A Consumer that will call methods on DescribeTerminationPolicyTypesRequest.Builder to
create a request.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.AwsServiceExceptiondefault 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.
describeWarmPoolRequest - InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeWarmPoolRequest.builder()
describeWarmPoolRequest - A Consumer that will call methods on DescribeWarmPoolType.Builder to create a request.InvalidNextTokenException - The NextToken value 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.AwsServiceExceptiondefault 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.
detachInstancesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DetachInstancesRequest.builder()
detachInstancesRequest - A Consumer that will call methods on DetachInstancesQuery.Builder to create a request.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.AwsServiceExceptiondefault DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the Removing state 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.
detachLoadBalancerTargetGroupsRequest - 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.AwsServiceExceptiondefault DetachLoadBalancerTargetGroupsResponse detachLoadBalancerTargetGroups(Consumer<DetachLoadBalancerTargetGroupsRequest.Builder> detachLoadBalancerTargetGroupsRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Detaches one or more target groups from the specified Auto Scaling group.
When you detach a target group, it enters the Removing state 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.
This is a convenience which creates an instance of the DetachLoadBalancerTargetGroupsRequest.Builder
avoiding the need to create one manually via DetachLoadBalancerTargetGroupsRequest.builder()
detachLoadBalancerTargetGroupsRequest - A Consumer that will call methods on DetachLoadBalancerTargetGroupsType.Builder to create
a request.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.AwsServiceExceptiondefault DetachLoadBalancersResponse detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
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 Balancer, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the Removing state 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.
detachLoadBalancersRequest - 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.AwsServiceExceptiondefault DetachLoadBalancersResponse detachLoadBalancers(Consumer<DetachLoadBalancersRequest.Builder> detachLoadBalancersRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
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 Balancer, use the DetachLoadBalancerTargetGroups API instead.
When you detach a load balancer, it enters the Removing state 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.Builder avoiding the
need to create one manually via DetachLoadBalancersRequest.builder()
detachLoadBalancersRequest - A Consumer that will call methods on DetachLoadBalancersType.Builder to create a request.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.AwsServiceExceptiondefault DisableMetricsCollectionResponse disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) throws ResourceContentionException, AwsServiceException, SdkClientException, AutoScalingException
Disables group metrics collection for the specified Auto Scaling group.
disableMetricsCollectionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DisableMetricsCollectionRequest.builder()
disableMetricsCollectionRequest - A Consumer that will call methods on DisableMetricsCollectionQuery.Builder to create a
request.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.AwsServiceExceptiondefault 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.
enableMetricsCollectionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via EnableMetricsCollectionRequest.builder()
enableMetricsCollectionRequest - A Consumer that will call methods on EnableMetricsCollectionQuery.Builder to create a
request.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.AwsServiceExceptiondefault 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.
enterStandbyRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via EnterStandbyRequest.builder()
enterStandbyRequest - A Consumer that will call methods on EnterStandbyQuery.Builder to create a request.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.AwsServiceExceptiondefault 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.
executePolicyRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ExecutePolicyRequest.builder()
executePolicyRequest - A Consumer that will call methods on ExecutePolicyType.Builder to create a request.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.AwsServiceExceptiondefault 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.
exitStandbyRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ExitStandbyRequest.builder()
exitStandbyRequest - A Consumer that will call methods on ExitStandbyQuery.Builder to create a request.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.AwsServiceExceptiondefault 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.
getPredictiveScalingForecastRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via GetPredictiveScalingForecastRequest.builder()
getPredictiveScalingForecastRequest - A Consumer that will call methods on GetPredictiveScalingForecastType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
putLifecycleHookRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via PutLifecycleHookRequest.builder()
putLifecycleHookRequest - A Consumer that will call methods on PutLifecycleHookType.Builder to create a request.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.AwsServiceExceptiondefault 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.
putNotificationConfigurationRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via PutNotificationConfigurationRequest.builder()
putNotificationConfigurationRequest - A Consumer that will call methods on PutNotificationConfigurationType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
putScalingPolicyRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via PutScalingPolicyRequest.builder()
putScalingPolicyRequest - A Consumer that will call methods on PutScalingPolicyType.Builder to create a request.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.AwsServiceExceptiondefault 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.
putScheduledUpdateGroupActionRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via PutScheduledUpdateGroupActionRequest.builder()
putScheduledUpdateGroupActionRequest - A Consumer that will call methods on PutScheduledUpdateGroupActionType.Builder to create a
request.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.AwsServiceExceptiondefault 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.
putWarmPoolRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via PutWarmPoolRequest.builder()
putWarmPoolRequest - A Consumer that will call methods on PutWarmPoolType.Builder to create a request.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.AwsServiceExceptiondefault 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.
recordLifecycleActionHeartbeatRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via RecordLifecycleActionHeartbeatRequest.builder()
recordLifecycleActionHeartbeatRequest - A Consumer that will call methods on RecordLifecycleActionHeartbeatType.Builder to create
a request.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.AwsServiceExceptiondefault 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.
resumeProcessesRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ResumeProcessesRequest.builder()
resumeProcessesRequest - A Consumer that will call methods on ScalingProcessQuery.Builder to create a request.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.AwsServiceExceptiondefault 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 DesiredCapacity value 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.
setDesiredCapacityRequest - 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.AwsServiceExceptiondefault 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 DesiredCapacity value 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.Builder avoiding the
need to create one manually via SetDesiredCapacityRequest.builder()
setDesiredCapacityRequest - A Consumer that will call methods on SetDesiredCapacityType.Builder to create a request.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.AwsServiceExceptiondefault 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.
setInstanceHealthRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via SetInstanceHealthRequest.builder()
setInstanceHealthRequest - A Consumer that will call methods on SetInstanceHealthQuery.Builder to create a request.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.AwsServiceExceptiondefault 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.
setInstanceProtectionRequest - 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.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via SetInstanceProtectionRequest.builder()
setInstanceProtectionRequest - A Consumer that will call methods on SetInstanceProtectionQuery.Builder to create a
request.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.AwsServiceExceptiondefault StartInstanceRefreshResponse startInstanceRefresh(StartInstanceRefreshRequest startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException
Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
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 the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. 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 operation in progress, use the CancelInstanceRefresh API.
startInstanceRefreshRequest - 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 operation 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.AwsServiceExceptiondefault StartInstanceRefreshResponse startInstanceRefresh(Consumer<StartInstanceRefreshRequest.Builder> startInstanceRefreshRequest) throws LimitExceededException, ResourceContentionException, InstanceRefreshInProgressException, AwsServiceException, SdkClientException, AutoScalingException
Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
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 the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. 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 operation in progress, use the CancelInstanceRefresh API.
This is a convenience which creates an instance of the StartInstanceRefreshRequest.Builder avoiding the
need to create one manually via StartInstanceRefreshRequest.builder()
startInstanceRefreshRequest - A Consumer that will call methods on StartInstanceRefreshType.Builder to create a request.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 operation 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.AwsServiceExceptiondefault 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 Launch or Terminate process 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.
suspendProcessesRequest - 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.AwsServiceExceptiondefault 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 Launch or Terminate process 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.Builder avoiding the need
to create one manually via SuspendProcessesRequest.builder()
suspendProcessesRequest - A Consumer that will call methods on ScalingProcessQuery.Builder to create a request.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.AwsServiceExceptiondefault 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.
terminateInstanceInAutoScalingGroupRequest - 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.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via TerminateInstanceInAutoScalingGroupRequest.builder()
terminateInstanceInAutoScalingGroupRequest - A Consumer that will call methods on TerminateInstanceInAutoScalingGroupType.Builder to
create a request.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.AwsServiceExceptiondefault 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, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value 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 MinSize without specifying a value for DesiredCapacity,
and the new MinSize is larger than the current size of the group, this sets the group's
DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity,
and the new MaxSize is smaller than the current size of the group, this sets the group's
DesiredCapacity to the new MaxSize value.
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.
updateAutoScalingGroupRequest - 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.AwsServiceExceptiondefault 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, or MinSize:
If a scale-in activity occurs as a result of a new DesiredCapacity value 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 MinSize without specifying a value for DesiredCapacity,
and the new MinSize is larger than the current size of the group, this sets the group's
DesiredCapacity to the new MinSize value.
If you specify a new value for MaxSize without specifying a value for DesiredCapacity,
and the new MaxSize is smaller than the current size of the group, this sets the group's
DesiredCapacity to the new MaxSize value.
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.Builder avoiding the
need to create one manually via UpdateAutoScalingGroupRequest.builder()
updateAutoScalingGroupRequest - A Consumer that will call methods on UpdateAutoScalingGroupType.Builder to create a
request.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.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
default AutoScalingWaiter waiter()
AutoScalingWaiter using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
AutoScalingWaiterCopyright © 2022. All rights reserved.