Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   /*
    * Copyright 2010-2015 Amazon.com, Inc. or its affiliates. All Rights Reserved.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License").
    * You may not use this file except in compliance with the License.
    * A copy of the License is located at
    * 
    *  http://aws.amazon.com/apache2.0
    * 
   * or in the "license" file accompanying this file. This file is distributed
   * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
   * express or implied. See the License for the specific language governing
   * permissions and limitations under the License.
   */
  package com.amazonaws.services.autoscaling;
  
  import com.amazonaws.*;
Interface for accessing AmazonAutoScaling. Auto Scaling

Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.

  
  public interface AmazonAutoScaling {

    
Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

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 com.amazonaws.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.

Parameters:
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.
Throws:
java.lang.IllegalArgumentException If any problems are detected with the specified endpoint.
  
      public void setEndpoint(String endpointthrows java.lang.IllegalArgumentException;

    
An alternative to setEndpoint(java.lang.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 com.amazonaws.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.

  
      public void setRegion(Region regionthrows java.lang.IllegalArgumentException;
    
    

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference .

Parameters:
describeAccountLimitsRequest Container for the necessary parameters to execute the DescribeAccountLimits service method on AmazonAutoScaling.
Returns:
The response from the DescribeAccountLimits service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.

Parameters:
describeAutoScalingGroupsRequest Container for the necessary parameters to execute the DescribeAutoScalingGroups service method on AmazonAutoScaling.
Returns:
The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Enables monitoring of the specified metrics for the specified Auto Scaling group.

You can only enable metrics collection if InstanceMonitoring in the launch configuration for the group is set to True .

Parameters:
enableMetricsCollectionRequest Container for the necessary parameters to execute the EnableMetricsCollection service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Resumes the specified suspended Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the ScalingProcesses parameter. To resume all processes, omit the ScalingProcesses parameter. For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide .

Parameters:
resumeProcessesRequest Container for the necessary parameters to execute the ResumeProcesses service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the lifecycle hooks for the specified Auto Scaling group.

Parameters:
describeLifecycleHooksRequest Container for the necessary parameters to execute the DescribeLifecycleHooks service method on AmazonAutoScaling.
Returns:
The response from the DescribeLifecycleHooks service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the policies for the specified Auto Scaling group.

Parameters:
describePoliciesRequest Container for the necessary parameters to execute the DescribePolicies service method on AmazonAutoScaling.
Returns:
The response from the DescribePolicies service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

Parameters:
describeScalingProcessTypesRequest Container for the necessary parameters to execute the DescribeScalingProcessTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified launch configuration.

The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.

Parameters:
deleteLaunchConfigurationRequest Container for the necessary parameters to execute the DeleteLaunchConfiguration service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ResourceInUseException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Creates an Auto Scaling group with the specified name and attributes.

If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating these limits, see DescribeAccountLimits.

Parameters:
createAutoScalingGroupRequest Container for the necessary parameters to execute the CreateAutoScalingGroup service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.services.autoscaling.model.AlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Attaches one or more EC2 instances to the specified Auto Scaling group.

For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide .

Parameters:
attachInstancesRequest Container for the necessary parameters to execute the AttachInstances service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void attachInstances(AttachInstancesRequest attachInstancesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds , the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.

Parameters:
describeScalingActivitiesRequest Container for the necessary parameters to execute the DescribeScalingActivities service method on AmazonAutoScaling.
Returns:
The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the notification actions associated with the specified Auto Scaling group.

Parameters:
describeNotificationConfigurationsRequest Container for the necessary parameters to execute the DescribeNotificationConfigurations service method on AmazonAutoScaling.
Returns:
The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified lifecycle hook.

If there are any outstanding lifecycle actions, they are completed first ( ABANDON for launching instances, CONTINUE for terminating instances).

Parameters:
deleteLifecycleHookRequest Container for the necessary parameters to execute the DeleteLifecycleHook service method on AmazonAutoScaling.
Returns:
The response from the DeleteLifecycleHook service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Creates or updates a lifecycle hook for the specified Auto Scaling Group.

A lifecycle hook tells Auto Scaling that you want 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 operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .

Parameters:
putLifecycleHookRequest Container for the necessary parameters to execute the PutLifecycleHook service method on AmazonAutoScaling.
Returns:
The response from the PutLifecycleHook service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the termination policies supported by Auto Scaling.

Parameters:
describeTerminationPolicyTypesRequest Container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeTerminationPolicyTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

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.

Parameters:
describeTagsRequest Container for the necessary parameters to execute the DescribeTags service method on AmazonAutoScaling.
Returns:
The response from the DescribeTags service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified tags.

Parameters:
deleteTagsRequest Container for the necessary parameters to execute the DeleteTags service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteTags(DeleteTagsRequest deleteTagsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Executes the specified policy.

Parameters:
executePolicyRequest Container for the necessary parameters to execute the ExecutePolicy service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void executePolicy(ExecutePolicyRequest executePolicyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.

Parameters:
putScalingPolicyRequest Container for the necessary parameters to execute the PutScalingPolicy service method on AmazonAutoScaling.
Returns:
The response from the PutScalingPolicy service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.

For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide .

This configuration overwrites an existing configuration.

Parameters:
putNotificationConfigurationRequest Container for the necessary parameters to execute the PutNotificationConfiguration service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Moves the specified instances out of Standby mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide .

Parameters:
exitStandbyRequest Container for the necessary parameters to execute the ExitStandby service method on AmazonAutoScaling.
Returns:
The response from the ExitStandby service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public ExitStandbyResult exitStandby(ExitStandbyRequest exitStandbyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified Auto Scaling policy.

Parameters:
deletePolicyRequest Container for the necessary parameters to execute the DeletePolicy service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void deletePolicy(DeletePolicyRequest deletePolicyRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action .

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .

Parameters:
completeLifecycleActionRequest Container for the necessary parameters to execute the CompleteLifecycleAction service method on AmazonAutoScaling.
Returns:
The response from the CompleteLifecycleAction service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified notification.

Parameters:
deleteNotificationConfigurationRequest Container for the necessary parameters to execute the DeleteNotificationConfiguration service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified scheduled action.

Parameters:
deleteScheduledActionRequest Container for the necessary parameters to execute the DeleteScheduledAction service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling Developer Guide .

Parameters:
setInstanceHealthRequest Container for the necessary parameters to execute the SetInstanceHealth service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes the notification types that are supported by Auto Scaling.

Parameters:
describeAutoScalingNotificationTypesRequest Container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Suspends the specified Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the ScalingProcesses parameter. To suspend all processes, omit the ScalingProcesses parameter.

Note that 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 Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide .

Parameters:
suspendProcessesRequest Container for the necessary parameters to execute the SuspendProcesses service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Creates or updates tags for the specified Auto Scaling group.

A tag is defined by its resource ID, resource type, key, value, and propagate flag. The value and the propagate flag are optional parameters. The only supported resource type is auto-scaling-group , and the resource ID must be the name of the group. The PropagateAtLaunch flag determines whether the tag is added to instances launched in the group. Valid values are true or false .

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 Auto Scaling Developer Guide .

Parameters:
createOrUpdateTagsRequest Container for the necessary parameters to execute the CreateOrUpdateTags service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.services.autoscaling.model.AlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.

For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide .

Parameters:
detachInstancesRequest Container for the necessary parameters to execute the DetachInstances service method on AmazonAutoScaling.
Returns:
The response from the DetachInstances service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public DetachInstancesResult detachInstances(DetachInstancesRequest detachInstancesRequest
             throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.

Parameters:
describeAutoScalingInstancesRequest Container for the necessary parameters to execute the DescribeAutoScalingInstances service method on AmazonAutoScaling.
Returns:
The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
             throws AmazonServiceExceptionAmazonClientException;

    

Creates a launch configuration.

If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating these limits, see DescribeAccountLimits.

Parameters:
createLaunchConfigurationRequest Container for the necessary parameters to execute the CreateLaunchConfiguration service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.services.autoscaling.model.AlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
 
     public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Moves the specified instances into Standby mode.

For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide .

Parameters:
enterStandbyRequest Container for the necessary parameters to execute the EnterStandby service method on AmazonAutoScaling.
Returns:
The response from the EnterStandby service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public EnterStandbyResult enterStandby(EnterStandbyRequest enterStandbyRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the available types of lifecycle hooks.

Parameters:
describeLifecycleHookTypesRequest Container for the necessary parameters to execute the DescribeLifecycleHookTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeLifecycleHookTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Deletes the specified Auto Scaling group.

The group must have no instances and no scaling activities in progress.

To remove all instances before calling DeleteAutoScalingGroup , call UpdateAutoScalingGroup to set the minimum and maximum size of the Auto Scaling group to zero.

Parameters:
deleteAutoScalingGroupRequest Container for the necessary parameters to execute the DeleteAutoScalingGroup service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ResourceInUseException
com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Disables monitoring of the specified metrics for the specified Auto Scaling group.

Parameters:
disableMetricsCollectionRequest Container for the necessary parameters to execute the DisableMetricsCollection service method on AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Updates the configuration for the specified Auto Scaling group.

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 will get an error. If you have previously enabled the collection of group metrics, you can disable it using DisableMetricsCollection.

The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.

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.

Parameters:
updateAutoScalingGroupRequest Container for the necessary parameters to execute the UpdateAutoScalingGroup service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.

Parameters:
describeLaunchConfigurationsRequest Container for the necessary parameters to execute the DescribeLaunchConfigurations service method on AmazonAutoScaling.
Returns:
The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the policy adjustment types for use with PutScalingPolicy.

Parameters:
describeAdjustmentTypesRequest Container for the necessary parameters to execute the DescribeAdjustmentTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.

Parameters:
describeScheduledActionsRequest Container for the necessary parameters to execute the DescribeScheduledActions service method on AmazonAutoScaling.
Returns:
The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Records a heartbeat for the lifecycle action associated with a specific token. This extends the timeout by the length of time defined by the HeartbeatTimeout parameter of PutLifecycleHook.

This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:

  1. Create a notification target. A target can be either an Amazon SQS queue or an Amazon SNS topic.
  2. Create an IAM role. This role allows Auto Scaling to publish lifecycle notifications to the designated SQS queue or SNS topic.
  3. Create the lifecycle hook. You can create a hook that acts when instances launch or when instances terminate.
  4. If necessary, record the lifecycle action heartbeat to keep the instance in a pending state.
  5. Complete the lifecycle action.

For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .

Parameters:
recordLifecycleActionHeartbeatRequest Container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method on AmazonAutoScaling.
Returns:
The response from the RecordLifecycleActionHeartbeat service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

For more information, see Scheduled Scaling in the Auto Scaling Developer Guide .

Parameters:
putScheduledUpdateGroupActionRequest Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.LimitExceededException
com.amazonaws.services.autoscaling.model.AlreadyExistsException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the available CloudWatch metrics for Auto Scaling.

Note that the GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

Parameters:
describeMetricCollectionTypesRequest Container for the necessary parameters to execute the DescribeMetricCollectionTypes service method on AmazonAutoScaling.
Returns:
The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Sets the size of the specified Auto Scaling group.

Parameters:
setDesiredCapacityRequest Container for the necessary parameters to execute the SetDesiredCapacity service method on AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
    public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest
            throws AmazonServiceExceptionAmazonClientException;

    

Terminates the specified instance and optionally adjusts the desired group size.

This call simply makes a termination request. The instances is not terminated immediately.

Parameters:
terminateInstanceInAutoScalingGroupRequest Container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method on AmazonAutoScaling.
Returns:
The response from the TerminateInstanceInAutoScalingGroup service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.ScalingActivityInProgressException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
            throws AmazonServiceExceptionAmazonClientException;

    

Describes the current Auto Scaling resource limits for your AWS account.

For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference .

Returns:
The response from the DescribeAccountLimits service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.

Returns:
The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the policies for the specified Auto Scaling group.

Returns:
The response from the DescribePolicies service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

Returns:
The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes one or more scaling activities for the specified Auto Scaling group. If you omit the ActivityIds , the call returns all activities from the past six weeks. Activities are sorted by the start time. Activities still in progress appear first on the list.

Returns:
The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the notification actions associated with the specified Auto Scaling group.

Returns:
The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the termination policies supported by Auto Scaling.

Returns:
The response from the DescribeTerminationPolicyTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

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.

Returns:
The response from the DescribeTags service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the notification types that are supported by Auto Scaling.

Returns:
The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.

Returns:
The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the available types of lifecycle hooks.

Returns:
The response from the DescribeLifecycleHookTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.

Returns:
The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the policy adjustment types for use with PutScalingPolicy.

Returns:
The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.

Returns:
The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.services.autoscaling.model.InvalidNextTokenException
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

Describes the available CloudWatch metrics for Auto Scaling.

Note that the GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

Returns:
The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.
Throws:
com.amazonaws.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.
com.amazonaws.AmazonServiceException If an error response is returned by AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    public void shutdown();
    
    
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

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.

Parameters:
request The originally executed request.
Returns:
The response metadata for the specified request, or null if none is available.
}
        
New to GrepCode? Check out our FAQ X