public interface AmazonAutoScaling
Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.
For more information, see the Amazon EC2 Auto Scaling User Guide.
Modifier and Type | Method and Description |
---|---|
void |
attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
AttachLoadBalancersResult |
attachLoadBalancers()
Attaches one or more Classic Load Balancers to the specified Auto Scaling
group.
|
AttachLoadBalancersResult |
attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest)
Attaches one or more Classic Load Balancers to the specified Auto Scaling
group.
|
AttachLoadBalancerTargetGroupsResult |
attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest)
Attaches one or more target groups to the specified Auto Scaling group.
|
BatchDeleteScheduledActionResult |
batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest)
Deletes one or more scheduled actions for the specified Auto Scaling
group.
|
BatchPutScheduledUpdateGroupActionResult |
batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest)
Creates or updates one or more scheduled scaling actions for an Auto
Scaling group.
|
CompleteLifecycleActionResult |
completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
Completes the lifecycle action for the specified token or instance with
the specified result.
|
void |
createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
Creates an Auto Scaling group with the specified name and attributes.
|
void |
createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
Creates a launch configuration.
|
void |
createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
|
void |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
|
void |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
|
DeleteLifecycleHookResult |
deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
|
void |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified Auto Scaling policy.
|
void |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
|
void |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
|
DescribeAccountLimitsResult |
describeAccountLimits()
Describes the current Auto Scaling resource limits for your AWS account.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Auto Scaling resource limits for your AWS account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Describes the policy adjustment types for use with
PutScalingPolicy.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with
PutScalingPolicy.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Describes the notification types that are supported by Amazon EC2 Auto
Scaling.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Amazon EC2 Auto
Scaling.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Describes one or more launch configurations.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Describes one or more launch configurations.
|
DescribeLifecycleHooksResult |
describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes()
Describes the available types of lifecycle hooks.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the load balancers for the specified Auto Scaling group.
|
DescribeLoadBalancerTargetGroupsResult |
describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest)
Describes the target groups for the specified Auto Scaling group.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes()
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Describes the notification actions associated with the specified Auto
Scaling group.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto
Scaling group.
|
DescribePoliciesResult |
describePolicies()
Describes the policies for the specified Auto Scaling group.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Describes one or more scaling activities for the specified Auto Scaling
group.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Describes one or more scaling activities for the specified Auto Scaling
group.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes()
Describes the scaling process types for use with ResumeProcesses
and SuspendProcesses.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses
and SuspendProcesses.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Describes the actions scheduled for your Auto Scaling group that haven't
run.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the actions scheduled for your Auto Scaling group that haven't
run.
|
DescribeTagsResult |
describeTags()
Describes the specified tags.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Amazon EC2 Auto Scaling.
|
DetachInstancesResult |
detachInstances(DetachInstancesRequest detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers()
Detaches one or more Classic Load Balancers from the specified Auto
Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
Detaches one or more Classic Load Balancers from the specified Auto
Scaling group.
|
DetachLoadBalancerTargetGroupsResult |
detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest)
Detaches one or more target groups from the specified Auto Scaling group.
|
void |
disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables group metrics for the specified Auto Scaling group.
|
void |
enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
Enables group metrics for the specified Auto Scaling group.
|
EnterStandbyResult |
enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves the specified instances into the standby state.
|
void |
executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
|
ExitStandbyResult |
exitStandby(ExitStandbyRequest exitStandbyRequest)
Moves the specified instances out of the standby state.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
PutLifecycleHookResult |
putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling group.
|
void |
putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
Configures an Auto Scaling group to send notifications when specified
events take place.
|
PutScalingPolicyResult |
putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a policy for an Auto Scaling group.
|
void |
putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
Creates or updates a scheduled scaling action for an Auto Scaling group.
|
RecordLifecycleActionHeartbeatResult |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with the
specified token or instance.
|
void |
resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
Resumes the specified suspended automatic scaling processes, or all
suspended process, for the specified Auto Scaling group.
|
void |
setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
|
void |
setEndpoint(java.lang.String endpoint)
Overrides the default endpoint for this client
("https://autoscaling.amazonaws.com").
|
void |
setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of the specified instance.
|
SetInstanceProtectionResult |
setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends the specified automatic scaling processes, or all processes, for
the specified Auto Scaling group.
|
TerminateInstanceInAutoScalingGroupResult |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired
group size.
|
void |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
Updates the configuration for the specified Auto Scaling group.
|
void setEndpoint(java.lang.String endpoint) throws java.lang.IllegalArgumentException
Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com")
or a full URL, including the protocol (ex:
"https://autoscaling.amazonaws.com"). If the protocol is not specified
here, the default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "autoscaling.amazonaws.com") or a full
URL, including the protocol (ex:
"https://autoscaling.amazonaws.com") of the region specific
AWS endpoint this client will communicate with.java.lang.IllegalArgumentException
- If any problems are detected with the
specified endpoint.void setRegion(Region region) throws java.lang.IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.java.lang.IllegalArgumentException
- If the given region is null,
or if this service isn't available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
void attachInstances(AttachInstancesRequest attachInstancesRequest) throws AmazonClientException, AmazonServiceException
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
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.AttachLoadBalancerTargetGroupsResult attachLoadBalancerTargetGroups(AttachLoadBalancerTargetGroupsRequest attachLoadBalancerTargetGroupsRequest) throws AmazonClientException, AmazonServiceException
Attaches one or more target groups to the specified Auto Scaling group.
To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancerTargetGroupsRequest
- ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.AttachLoadBalancersResult attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest) throws AmazonClientException, AmazonServiceException
Attaches one or more Classic Load Balancers to the specified Auto Scaling group.
To attach an Application Load Balancer instead, see AttachLoadBalancerTargetGroups.
To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
attachLoadBalancersRequest
- ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.BatchDeleteScheduledActionResult batchDeleteScheduledAction(BatchDeleteScheduledActionRequest batchDeleteScheduledActionRequest) throws AmazonClientException, AmazonServiceException
Deletes one or more scheduled actions for the specified Auto Scaling group.
batchDeleteScheduledActionRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.BatchPutScheduledUpdateGroupActionResult batchPutScheduledUpdateGroupAction(BatchPutScheduledUpdateGroupActionRequest batchPutScheduledUpdateGroupActionRequest) throws AmazonClientException, AmazonServiceException
Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
batchPutScheduledUpdateGroupActionRequest
- AlreadyExistsException
LimitExceededException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest) throws AmazonClientException, AmazonServiceException
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 Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
completeLifecycleActionRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) throws AmazonClientException, AmazonServiceException
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
For more information, see Auto Scaling Groups in the Amazon EC2 Auto Scaling User Guide.
createAutoScalingGroupRequest
- AlreadyExistsException
LimitExceededException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) throws AmazonClientException, AmazonServiceException
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch Configurations in the Amazon EC2 Auto Scaling User Guide.
createLaunchConfigurationRequest
- AlreadyExistsException
LimitExceededException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) throws AmazonClientException, AmazonServiceException
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 Tagging Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
createOrUpdateTagsRequest
- LimitExceededException
AlreadyExistsException
ResourceContentionException
ResourceInUseException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) throws AmazonClientException, AmazonServiceException
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 DetachInstances 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 UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
deleteAutoScalingGroupRequest
- ScalingActivityInProgressException
ResourceInUseException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) throws AmazonClientException, AmazonServiceException
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
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest) throws AmazonClientException, AmazonServiceException
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
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified notification.
deleteNotificationConfigurationRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified Auto Scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
deletePolicyRequest
- ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified scheduled action.
deleteScheduledActionRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void deleteTags(DeleteTagsRequest deleteTagsRequest) throws AmazonClientException, AmazonServiceException
Deletes the specified tags.
deleteTagsRequest
- ResourceContentionException
ResourceInUseException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) throws AmazonClientException, AmazonServiceException
Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
describeAccountLimitsRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the policy adjustment types for use with PutScalingPolicy.
describeAdjustmentTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) throws AmazonClientException, AmazonServiceException
Describes one or more Auto Scaling groups.
describeAutoScalingGroupsRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) throws AmazonClientException, AmazonServiceException
Describes one or more Auto Scaling instances.
describeAutoScalingInstancesRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
describeAutoScalingNotificationTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Describes one or more launch configurations.
describeLaunchConfigurationsRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
describeLifecycleHookTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest) throws AmazonClientException, AmazonServiceException
Describes the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooksRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLoadBalancerTargetGroupsResult describeLoadBalancerTargetGroups(DescribeLoadBalancerTargetGroupsRequest describeLoadBalancerTargetGroupsRequest) throws AmazonClientException, AmazonServiceException
Describes the target groups for the specified Auto Scaling group.
describeLoadBalancerTargetGroupsRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest) throws AmazonClientException, AmazonServiceException
Describes the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, use DescribeLoadBalancerTargetGroups instead.
describeLoadBalancersRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
The GroupStandbyInstances
metric is not returned by default.
You must explicitly request this metric when calling
EnableMetricsCollection.
describeMetricCollectionTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws AmazonClientException, AmazonServiceException
Describes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurationsRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest) throws AmazonClientException, AmazonServiceException
Describes the policies for the specified Auto Scaling group.
describePoliciesRequest
- InvalidNextTokenException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) throws AmazonClientException, AmazonServiceException
Describes one or more scaling activities for the specified Auto Scaling group.
describeScalingActivitiesRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
describeScalingProcessTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) throws AmazonClientException, AmazonServiceException
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
describeScheduledActionsRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) throws AmazonClientException, AmazonServiceException
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.
describeTagsRequest
- InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) throws AmazonClientException, AmazonServiceException
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.
describeTerminationPolicyTypesRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DetachInstancesResult detachInstances(DetachInstancesRequest detachInstancesRequest) throws AmazonClientException, AmazonServiceException
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
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DetachLoadBalancerTargetGroupsResult detachLoadBalancerTargetGroups(DetachLoadBalancerTargetGroupsRequest detachLoadBalancerTargetGroupsRequest) throws AmazonClientException, AmazonServiceException
Detaches one or more target groups from the specified Auto Scaling group.
detachLoadBalancerTargetGroupsRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DetachLoadBalancersResult detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest) throws AmazonClientException, AmazonServiceException
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, use DetachLoadBalancerTargetGroups 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
DescribeLoadBalancers. The instances remain running.
detachLoadBalancersRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) throws AmazonClientException, AmazonServiceException
Disables group metrics for the specified Auto Scaling group.
disableMetricsCollectionRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest) throws AmazonClientException, AmazonServiceException
Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the Amazon EC2 Auto Scaling User Guide.
enableMetricsCollectionRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.EnterStandbyResult enterStandby(EnterStandbyRequest enterStandbyRequest) throws AmazonClientException, AmazonServiceException
Moves the specified instances into the standby state.
For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
enterStandbyRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void executePolicy(ExecutePolicyRequest executePolicyRequest) throws AmazonClientException, AmazonServiceException
Executes the specified policy.
executePolicyRequest
- ScalingActivityInProgressException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.ExitStandbyResult exitStandby(ExitStandbyRequest exitStandbyRequest) throws AmazonClientException, AmazonServiceException
Moves the specified instances out of the standby state.
For more information, see Temporarily Removing Instances from Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
exitStandbyRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest) throws AmazonClientException, AmazonServiceException
Creates or updates a lifecycle hook for the specified Auto Scaling group.
A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see 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. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
putLifecycleHookRequest
- LimitExceededException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest) throws AmazonClientException, AmazonServiceException
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 SNS Notifications When Your Auto Scaling Group Scales in the Auto Scaling User Guide.
putNotificationConfigurationRequest
- LimitExceededException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest) throws AmazonClientException, AmazonServiceException
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference.
putScalingPolicyRequest
- LimitExceededException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) throws AmazonClientException, AmazonServiceException
Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.
putScheduledUpdateGroupActionRequest
- AlreadyExistsException
LimitExceededException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest) throws AmazonClientException, AmazonServiceException
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 PutLifecycleHook.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(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 pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling Lifecycle in the Amazon EC2 Auto Scaling User Guide.
recordLifecycleActionHeartbeatRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) throws AmazonClientException, AmazonServiceException
Resumes the specified suspended automatic 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
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) throws AmazonClientException, AmazonServiceException
Sets the size of the specified Auto Scaling group.
For more information about desired capacity, see What Is Amazon EC2 Auto Scaling? in the Amazon EC2 Auto Scaling User Guide.
setDesiredCapacityRequest
- ScalingActivityInProgressException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) throws AmazonClientException, AmazonServiceException
Sets the health status of the specified instance.
For more information, see Health Checks in the Amazon EC2 Auto Scaling User Guide.
setInstanceHealthRequest
- ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.SetInstanceProtectionResult setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest) throws AmazonClientException, AmazonServiceException
Updates the instance protection settings of the specified instances.
For more information, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
setInstanceProtectionRequest
- LimitExceededException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest) throws AmazonClientException, AmazonServiceException
Suspends the specified automatic 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.
To resume processes that have been suspended, use ResumeProcesses.
For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
suspendProcessesRequest
- ResourceInUseException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) throws AmazonClientException, AmazonServiceException
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately.
terminateInstanceInAutoScalingGroupRequest
- ScalingActivityInProgressException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) throws AmazonClientException, AmazonServiceException
Updates the configuration for the specified Auto Scaling group.
The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.
To update an Auto Scaling group with a launch configuration with
InstanceMonitoring
set to false
, you must first
disable the collection of group metrics. Otherwise, you get an error. If
you have previously enabled the collection of group metrics, you can
disable it using DisableMetricsCollection.
Note the following:
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, we implicitly call
SetDesiredCapacity to set the size of the group to the new value
of MinSize
.
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, we implicitly call
SetDesiredCapacity to set the size of the group to the new value
of MaxSize
.
All other optional parameters are left unchanged if not specified.
updateAutoScalingGroupRequest
- ScalingActivityInProgressException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAccountLimitsResult describeAccountLimits() throws AmazonClientException, AmazonServiceException
Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see Auto Scaling Limits in the Amazon EC2 Auto Scaling User Guide.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingGroupsResult describeAutoScalingGroups() throws AmazonClientException, AmazonServiceException
Describes one or more Auto Scaling groups.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribePoliciesResult describePolicies() throws AmazonClientException, AmazonServiceException
Describes the policies for the specified Auto Scaling group.
InvalidNextTokenException
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScalingProcessTypesResult describeScalingProcessTypes() throws AmazonClientException, AmazonServiceException
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScalingActivitiesResult describeScalingActivities() throws AmazonClientException, AmazonServiceException
Describes one or more scaling activities for the specified Auto Scaling group.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeNotificationConfigurationsResult describeNotificationConfigurations() throws AmazonClientException, AmazonServiceException
Describes the notification actions associated with the specified Auto Scaling group.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes() throws AmazonClientException, AmazonServiceException
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeTagsResult describeTags() throws AmazonClientException, AmazonServiceException
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.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DetachLoadBalancersResult detachLoadBalancers() throws AmazonClientException, AmazonServiceException
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, use DetachLoadBalancerTargetGroups 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
DescribeLoadBalancers. The instances remain running.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes() throws AmazonClientException, AmazonServiceException
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.AttachLoadBalancersResult attachLoadBalancers() throws AmazonClientException, AmazonServiceException
Attaches one or more Classic Load Balancers to the specified Auto Scaling group.
To attach an Application Load Balancer instead, see AttachLoadBalancerTargetGroups.
To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
ResourceContentionException
ServiceLinkedRoleFailureException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAutoScalingInstancesResult describeAutoScalingInstances() throws AmazonClientException, AmazonServiceException
Describes one or more Auto Scaling instances.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLifecycleHookTypesResult describeLifecycleHookTypes() throws AmazonClientException, AmazonServiceException
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeLaunchConfigurationsResult describeLaunchConfigurations() throws AmazonClientException, AmazonServiceException
Describes one or more launch configurations.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeAdjustmentTypesResult describeAdjustmentTypes() throws AmazonClientException, AmazonServiceException
Describes the policy adjustment types for use with PutScalingPolicy.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeScheduledActionsResult describeScheduledActions() throws AmazonClientException, AmazonServiceException
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
InvalidNextTokenException
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.DescribeMetricCollectionTypesResult describeMetricCollectionTypes() throws AmazonClientException, AmazonServiceException
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
The GroupStandbyInstances
metric is not returned by default.
You must explicitly request this metric when calling
EnableMetricsCollection.
ResourceContentionException
AmazonClientException
- If any internal errors are encountered
inside the client while attempting to make the request or
handle the response. For example if a network connection is
not available.AmazonServiceException
- If an error response is returned by Amazon
Auto Scaling indicating either a problem with the data in the
request, or a server side issue.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.