com.amazonaws.services.autoscaling
Interface AmazonAutoScaling

All Known Subinterfaces:

AmazonAutoScalingAsync

All Known Implementing Classes:

AmazonAutoScalingAsyncClient, AmazonAutoScalingClient

public interface AmazonAutoScaling

Interface for accessing AmazonAutoScaling. Auto Scaling

This is the Auto Scaling API Reference . This guide provides detailed information about Auto Scaling actions, data types, parameters, and errors. For detailed information about Auto Scaling features and their associated API calls, go to the Auto Scaling Developer Guide .

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

This reference is based on the current WSDL, which is available at:

http://autoscaling.amazonaws.com/doc/2011-01-01/AutoScaling.wsdl

Endpoints

For information about this product's regions and endpoints, go to Regions and Endpoints in the Amazon Web Services General Reference.

Method Summary

void	createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) Creates a new Auto Scaling group with the specified name.
void	createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) Creates a new launch configuration.
void	deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest) Deletes the specified auto scaling group if the group has no instances and no scaling activities in progress.
void	deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest) Deletes the specified LaunchConfiguration.
void	deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) Deletes notifications created by PutNotificationConfiguration.
void	deletePolicy(DeletePolicyRequest deletePolicyRequest) Deletes a policy created by PutScalingPolicy
void	deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
DescribeAdjustmentTypesResult	describeAdjustmentTypes() Returns policy adjustment types for use in the PutScalingPolicy action.
DescribeAdjustmentTypesResult	describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) Returns policy adjustment types for use in the PutScalingPolicy action.
DescribeAutoScalingGroupsResult	describeAutoScalingGroups() Returns a full description of each Auto Scaling group in the given list.
DescribeAutoScalingGroupsResult	describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest) Returns a full description of each Auto Scaling group in the given list.
DescribeAutoScalingInstancesResult	describeAutoScalingInstances() Returns a description of each Auto Scaling instance in the InstanceIds list.
DescribeAutoScalingInstancesResult	describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest) Returns a description of each Auto Scaling instance in the InstanceIds list.
DescribeAutoScalingNotificationTypesResult	describeAutoScalingNotificationTypes() Returns a list of all notification types that are supported by Auto Scaling.
DescribeAutoScalingNotificationTypesResult	describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) Returns a list of all notification types that are supported by Auto Scaling.
DescribeLaunchConfigurationsResult	describeLaunchConfigurations() Returns a full description of the launch configurations given the specified names.
DescribeLaunchConfigurationsResult	describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) Returns a full description of the launch configurations given the specified names.
DescribeMetricCollectionTypesResult	describeMetricCollectionTypes() Returns a list of metrics and a corresponding list of granularities for each metric.
DescribeMetricCollectionTypesResult	describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) Returns a list of metrics and a corresponding list of granularities for each metric.
DescribeNotificationConfigurationsResult	describeNotificationConfigurations() Returns a list of notification actions associated with Auto Scaling groups for specified events.
DescribeNotificationConfigurationsResult	describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) Returns a list of notification actions associated with Auto Scaling groups for specified events.
DescribePoliciesResult	describePolicies() Returns descriptions of what each policy does.
DescribePoliciesResult	describePolicies(DescribePoliciesRequest describePoliciesRequest) Returns descriptions of what each policy does.
DescribeScalingActivitiesResult	describeScalingActivities() Returns the scaling activities for the specified Auto Scaling group.
DescribeScalingActivitiesResult	describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest) Returns the scaling activities for the specified Auto Scaling group.
DescribeScalingProcessTypesResult	describeScalingProcessTypes() Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
DescribeScalingProcessTypesResult	describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
DescribeScheduledActionsResult	describeScheduledActions() Lists all the actions scheduled for your Auto Scaling group that haven't been executed.
DescribeScheduledActionsResult	describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest) Lists all the actions scheduled for your Auto Scaling group that haven't been executed.
void	disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest) Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName.
void	enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest) Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName.
void	executePolicy(ExecutePolicyRequest executePolicyRequest) Runs the policy you create for your Auto Scaling group in PutScalingPolicy.
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.
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 a scheduled scaling action for a Auto Scaling group.
void	resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) Resumes Auto Scaling processes for an Auto Scaling group.
void	setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) Adjusts the desired size of the AutoScalingGroup by initiating scaling activities.
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 an instance.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
void	suspendProcesses(SuspendProcessesRequest suspendProcessesRequest) Suspends Auto Scaling processes for an Auto Scaling group.
TerminateInstanceInAutoScalingGroupResult	terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest) Terminates the specified instance.
void	updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest) Updates the configuration for the specified AutoScalingGroup.

Method Detail

setEndpoint

void setEndpoint(java.lang.String endpoint)
                 throws java.lang.IllegalArgumentException

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: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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

Parameters:

endpoint - The endpoint (ex: "ec2.amazonaws.com") or a full URL, including the protocol (ex: "https://ec2.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.

describeAutoScalingGroups

DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

enableMetricsCollection

void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
                             throws AmazonServiceException,
                                    AmazonClientException

Enables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of enabled metrics with the Metrics parameter.

Auto scaling metrics collection can be turned on only if the InstanceMonitoring.Enabled flag, in the Auto Scaling group's launch configuration, is set to true .

Parameters:

enableMetricsCollectionRequest - Container for the necessary parameters to execute the EnableMetricsCollection service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

resumeProcesses

void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
                     throws AmazonServiceException,
                            AmazonClientException

Resumes Auto Scaling processes for an Auto Scaling group. For more information, see SuspendProcesses and ProcessType.

Parameters:

resumeProcessesRequest - Container for the necessary parameters to execute the ResumeProcesses service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteLaunchConfiguration

void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Deletes the specified LaunchConfiguration.

The specified 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:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describePolicies

DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingProcessTypes

DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.

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:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

createAutoScalingGroup

void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Creates a new Auto Scaling group with the specified name. When the creation request is completed, the Auto Scaling group is ready to be used in other calls.

NOTE: The Auto Scaling group name must be unique within the scope of your AWS account, and under the quota of Auto Scaling groups allowed for your account.

Parameters:

createAutoScalingGroupRequest - Container for the necessary parameters to execute the CreateAutoScalingGroup service method on AmazonAutoScaling.

Throws:

LimitExceededException

AlreadyExistsException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingActivities

DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeNotificationConfigurations

DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Returns a list of notification actions associated with Auto Scaling groups for specified events.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

executePolicy

void executePolicy(ExecutePolicyRequest executePolicyRequest)
                   throws AmazonServiceException,
                          AmazonClientException

Runs the policy you create for your Auto Scaling group in PutScalingPolicy.

Parameters:

executePolicyRequest - Container for the necessary parameters to execute the ExecutePolicy service method on AmazonAutoScaling.

Throws:

ScalingActivityInProgressException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putScalingPolicy

PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameter(s) 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:

LimitExceededException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putNotificationConfiguration

void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
                                  throws AmazonServiceException,
                                         AmazonClientException

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.

A new PutNotificationConfiguration overwrites an existing configuration.

Parameters:

putNotificationConfigurationRequest - Container for the necessary parameters to execute the PutNotificationConfiguration service method on AmazonAutoScaling.

Throws:

LimitExceededException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deletePolicy

void deletePolicy(DeletePolicyRequest deletePolicyRequest)
                  throws AmazonServiceException,
                         AmazonClientException

Deletes a policy created by PutScalingPolicy

Parameters:

deletePolicyRequest - Container for the necessary parameters to execute the DeletePolicy service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteNotificationConfiguration

void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
                                     throws AmazonServiceException,
                                            AmazonClientException

Deletes notifications created by PutNotificationConfiguration.

Parameters:

deleteNotificationConfigurationRequest - Container for the necessary parameters to execute the DeleteNotificationConfiguration service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteScheduledAction

void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
                           throws AmazonServiceException,
                                  AmazonClientException

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

Parameters:

deleteScheduledActionRequest - Container for the necessary parameters to execute the DeleteScheduledAction service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

setInstanceHealth

void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
                       throws AmazonServiceException,
                              AmazonClientException

Sets the health status of an instance.

Parameters:

setInstanceHealthRequest - Container for the necessary parameters to execute the SetInstanceHealth service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingNotificationTypes

DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Returns a list of all 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:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

suspendProcesses

void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
                      throws AmazonServiceException,
                             AmazonClientException

Suspends Auto Scaling processes for an Auto Scaling group. To suspend specific process types, specify them by name with the ScalingProcesses.member.N parameter. To suspend all process types, omit the ScalingProcesses.member.N parameter.

IMPORTANT: Suspending either of the two primary process types, Launch or Terminate, can prevent other process types from functioning properly. For more information about processes and their dependencies, see ProcessType.

To resume processes that have been suspended, use ResumeProcesses.

Parameters:

suspendProcessesRequest - Container for the necessary parameters to execute the SuspendProcesses service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingInstances

DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of fifty. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

createLaunchConfiguration

void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
                               throws AmazonServiceException,
                                      AmazonClientException

Creates a new launch configuration. The launch configuration name must be unique within the scope of the client's AWS account. The maximum limit of launch configurations, which by default is 100, must not yet have been met; otherwise, the call will fail. When created, the new launch configuration is available for immediate use.

You can create a launch configuration with Amazon EC2 security groups or with Amazon VPC security groups. However, you can't use Amazon EC2 security groups together with Amazon VPC security groups, or vice versa. In addition, you can only create Auto Scaling launch configurations with Amazon VPC security groups in the Regions where Amazon VPC is supported. Amazon VPC is currently available only in the Amazon EC2 US-East (Northern Virginia) Region, and in the Amazon EC2 EU-West (Ireland) Region.

NOTE: At this time, Auto Scaling launch configurations don't support compressed (e.g. gzipped) user data files.

Parameters:

createLaunchConfigurationRequest - Container for the necessary parameters to execute the CreateLaunchConfiguration service method on AmazonAutoScaling.

Throws:

LimitExceededException

AlreadyExistsException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

deleteAutoScalingGroup

void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Deletes the specified auto scaling group if the group has no instances and no scaling activities in progress.

NOTE: To remove all instances before calling DeleteAutoScalingGroup, you can call UpdateAutoScalingGroup to set the minimum and maximum size of the AutoScalingGroup to zero.

Parameters:

deleteAutoScalingGroupRequest - Container for the necessary parameters to execute the DeleteAutoScalingGroup service method on AmazonAutoScaling.

Throws:

ResourceInUseException

ScalingActivityInProgressException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

disableMetricsCollection

void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
                              throws AmazonServiceException,
                                     AmazonClientException

Disables monitoring of group metrics for the Auto Scaling group specified in AutoScalingGroupName. You can specify the list of affected metrics with the Metrics parameter.

Parameters:

disableMetricsCollectionRequest - Container for the necessary parameters to execute the DisableMetricsCollection service method on AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

updateAutoScalingGroup

void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
                            throws AmazonServiceException,
                                   AmazonClientException

Updates the configuration for the specified AutoScalingGroup.

NOTE: To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring.enabled flag set to false, you must first ensure that collection of group metrics is disabled. Otherwise, calls to UpdateAutoScalingGroup will fail. If you have previously enabled group metrics collection, you can disable collection of all group metrics by calling 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. Triggers that are currently in progress aren't affected.

NOTE: If the new values are specified for the MinSize or MaxSize parameters, then there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All optional parameters are left unchanged if not passed in the request.

Parameters:

updateAutoScalingGroupRequest - Container for the necessary parameters to execute the UpdateAutoScalingGroup service method on AmazonAutoScaling.

Throws:

ScalingActivityInProgressException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeLaunchConfigurations

DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a full description of the launch configurations given the specified names.

If no names are specified, then the full details of all launch configurations are returned.

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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAdjustmentTypes

DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns policy adjustment types for use in the PutScalingPolicy action.

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:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScheduledActions

DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of action already executed, see the activity record returned in 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:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

putScheduledUpdateGroupAction

void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
                                   throws AmazonServiceException,
                                          AmazonClientException

Creates a scheduled scaling action for a Auto Scaling group. If you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.

Parameters:

putScheduledUpdateGroupActionRequest - Container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method on AmazonAutoScaling.

Throws:

LimitExceededException

AlreadyExistsException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeMetricCollectionTypes

DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Returns a list of metrics and a corresponding list of granularities for each metric.

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:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

setDesiredCapacity

void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
                        throws AmazonServiceException,
                               AmazonClientException

Adjusts the desired size of the AutoScalingGroup by initiating scaling activities. When reducing the size of the group, it is not possible to define which EC2 instances will be terminated. This applies to any auto-scaling decisions that might result in terminating instances.

There are two common use cases for SetDesiredCapacity : one for users of the Auto Scaling triggering system, and another for developers who write their own triggering systems. Both use cases relate to the concept of cooldown.

In the first case, if you use the Auto Scaling triggering system, SetDesiredCapacity changes the size of your Auto Scaling group without regard to the cooldown period. This could be useful, for example, if Auto Scaling did something unexpected for some reason. If your cooldown period is 10 minutes, Auto Scaling would normally reject requests to change the size of the group for that entire 10 minute period. The SetDesiredCapacity command allows you to circumvent this restriction and change the size of the group before the end of the cooldown period.

In the second case, if you write your own triggering system, you can use SetDesiredCapacity to control the size of your Auto Scaling group. If you want the same cooldown functionality that Auto Scaling offers, you can configure SetDesiredCapacity to honor cooldown by setting the HonorCooldown parameter to true .

Parameters:

setDesiredCapacityRequest - Container for the necessary parameters to execute the SetDesiredCapacity service method on AmazonAutoScaling.

Throws:

ScalingActivityInProgressException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

terminateInstanceInAutoScalingGroup

TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
                                                                              throws AmazonServiceException,
                                                                                     AmazonClientException

Terminates the specified instance. Optionally, the desired group size can be adjusted.

NOTE: This call simply registers a termination request. The termination of the instance cannot happen 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:

ScalingActivityInProgressException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingGroups

DescribeAutoScalingGroupsResult describeAutoScalingGroups()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns a full description of each Auto Scaling group in the given list. This includes all Amazon EC2 instances that are members of the group. If a list of names is not provided, the service returns the full details of all Auto Scaling groups.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

Returns:

The response from the DescribeAutoScalingGroups service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describePolicies

DescribePoliciesResult describePolicies()
                                        throws AmazonServiceException,
                                               AmazonClientException

Returns descriptions of what each policy does. This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

Returns:

The response from the DescribePolicies service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingProcessTypes

DescribeScalingProcessTypesResult describeScalingProcessTypes()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.

Returns:

The response from the DescribeScalingProcessTypes service method, as returned by AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScalingActivities

DescribeScalingActivitiesResult describeScalingActivities()
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Returns the scaling activities for the specified Auto Scaling group.

If the specified ActivityIds list is empty, all the activities from the past six weeks are returned. Activities are sorted by completion time. Activities still in progress appear first on the list.

This action supports pagination. If the response includes a token, there are more records available. To get the additional records, repeat the request with the response token as the NextToken parameter.

Returns:

The response from the DescribeScalingActivities service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeNotificationConfigurations

DescribeNotificationConfigurationsResult describeNotificationConfigurations()
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

Returns a list of notification actions associated with Auto Scaling groups for specified events.

Returns:

The response from the DescribeNotificationConfigurations service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingNotificationTypes

DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

Returns a list of all notification types that are supported by Auto Scaling.

Returns:

The response from the DescribeAutoScalingNotificationTypes service method, as returned by AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAutoScalingInstances

DescribeAutoScalingInstancesResult describeAutoScalingInstances()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of fifty. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

Returns:

The response from the DescribeAutoScalingInstances service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeLaunchConfigurations

DescribeLaunchConfigurationsResult describeLaunchConfigurations()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a full description of the launch configurations given the specified names.

If no names are specified, then the full details of all launch configurations are returned.

Returns:

The response from the DescribeLaunchConfigurations service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeAdjustmentTypes

DescribeAdjustmentTypesResult describeAdjustmentTypes()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns policy adjustment types for use in the PutScalingPolicy action.

Returns:

The response from the DescribeAdjustmentTypes service method, as returned by AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeScheduledActions

DescribeScheduledActionsResult describeScheduledActions()
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Lists all the actions scheduled for your Auto Scaling group that haven't been executed. To see a list of action already executed, see the activity record returned in DescribeScalingActivities.

Returns:

The response from the DescribeScheduledActions service method, as returned by AmazonAutoScaling.

Throws:

InvalidNextTokenException

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

describeMetricCollectionTypes

DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Returns a list of metrics and a corresponding list of granularities for each metric.

Returns:

The response from the DescribeMetricCollectionTypes service method, as returned by AmazonAutoScaling.

Throws:

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 AmazonAutoScaling indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

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.

getCachedResponseMetadata

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