com.amazonaws.services.autoscaling

Class AmazonAutoScalingClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.autoscaling.AmazonAutoScalingClient

All Implemented Interfaces:

AmazonAutoScaling

Direct Known Subclasses:

AmazonAutoScalingAsyncClient

public class AmazonAutoScalingClient
extends AmazonWebServiceClient
implements AmazonAutoScaling

Client for accessing AmazonAutoScaling. All service calls made using this client are blocking, and will not return until the service call completes.

Auto Scaling

Auto Scaling is a web service designed to automatically launch or terminate Amazon Elastic Compute Cloud (Amazon 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.

Auto Scaling provides APIs that you can call by submitting a Query Request. Query requests are HTTP or HTTPS requests that use the HTTP verbs GET or POST and a Query parameter named Action or Operation that specifies the API you are calling. Action is used throughout this documentation, although Operation is also supported for backward compatibility with other Amazon Web Services (AWS) Query APIs.

Calling the API using a Query request is the most direct way to access the web service, but requires that your application handle low-level details such as generating the hash to sign the request and error handling. The benefit of calling the service using a Query request is that you are assured of having access to the complete functionality of the API. For information about signing a a query request, see Use Query Requests to Call Auto Scaling APIs

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 actions, go to the Auto Scaling Developer Guide .

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

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

Endpoints

The examples in this guide assume that your instances are launched in the US East (Northern Virginia) region and use us-east-1 as the endpoint.

You can set up your Auto Scaling infrastructure in other AWS regions. For information about this product's regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Unmarshaller<AmazonServiceException,org.w3c.dom.Node>>	exceptionUnmarshallers List of exception unmarshallers for all AmazonAutoScaling exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonAutoScalingClient() Constructs a new client to invoke service methods on AmazonAutoScaling.
AmazonAutoScalingClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials.
AmazonAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials and client configuration options.
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider.
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider and client configuration options.
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonAutoScalingClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonAutoScaling.

Method Summary

Methods

Modifier and Type	Method and Description
void	attachInstances(AttachInstancesRequest attachInstancesRequest) Attaches one or more Amazon EC2 instances to an existing Auto Scaling group.
void	createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) Creates a new Auto Scaling group with the specified name and other attributes.
void	createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest) Creates a new launch configuration.
void	createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) Creates new tags or updates existing tags for an Auto Scaling group.
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.
void	deleteTags(DeleteTagsRequest deleteTagsRequest) Removes the specified tags or a set of tags from a set of resources.
DescribeAccountLimitsResult	describeAccountLimits() Returns the limits for the Auto Scaling resources currently allowed for your AWS account.
DescribeAccountLimitsResult	describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest) Returns the limits for the Auto Scaling resources currently allowed for your AWS account.
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, or the specified launch configurations, if they exist.
DescribeLaunchConfigurationsResult	describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) Returns a full description of the launch configurations, or the specified launch configurations, if they exist.
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.
DescribeTagsResult	describeTags() Lists the Auto Scaling group tags.
DescribeTagsResult	describeTags(DescribeTagsRequest describeTagsRequest) Lists the Auto Scaling group tags.
DescribeTerminationPolicyTypesResult	describeTerminationPolicyTypes() Returns a list of all termination policies supported by Auto Scaling.
DescribeTerminationPolicyTypesResult	describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) Returns a list of all termination policies supported by Auto Scaling.
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) Executes the specified policy.
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 or updates a scheduled scaling action for an Auto Scaling group.
void	resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) Resumes all suspended Auto Scaling processes for an Auto Scaling group.
void	setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) Sets the desired size of the specified AutoScalingGroup.
void	setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.
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.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.autoscaling.AmazonAutoScaling

setEndpoint, setRegion, shutdown

Field Detail

exceptionUnmarshallers

protected final java.util.List<Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonAutoScaling exceptions.

Constructor Detail

AmazonAutoScalingClient

public AmazonAutoScalingClient()

Constructs a new client to invoke service methods on AmazonAutoScaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonAutoScalingClient

public AmazonAutoScalingClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

AmazonAutoScalingClient

public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonAutoScaling using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonAutoScaling (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeAccountLimits

public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)

Returns the limits for the Auto Scaling resources currently allowed for your AWS account.

Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.

If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.

Specified by:

describeAccountLimits in interface AmazonAutoScaling

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:

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

public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)

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.

Specified by:

describeAutoScalingGroups in interface AmazonAutoScaling

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

public void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)

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 flag, in the Auto Scaling group's launch configuration, is set to True .

Specified by:

enableMetricsCollection in interface AmazonAutoScaling

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

public void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)

Resumes all suspended Auto Scaling processes for an Auto Scaling group. For information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process .

Specified by:

resumeProcesses in interface AmazonAutoScaling

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

public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)

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.

Specified by:

deleteLaunchConfiguration in interface AmazonAutoScaling

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

public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)

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.

Specified by:

describePolicies in interface AmazonAutoScaling

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

public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)

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

Specified by:

describeScalingProcessTypes in interface AmazonAutoScaling

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

public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)

Creates a new Auto Scaling group with the specified name and other attributes. 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.

Specified by:

createAutoScalingGroup in interface AmazonAutoScaling

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.

attachInstances

public void attachInstances(AttachInstancesRequest attachInstancesRequest)

Attaches one or more Amazon EC2 instances to an existing Auto Scaling group. After the instance(s) is attached, it becomes a part of the Auto Scaling group.

For more information, see Attach Amazon EC2 Instance(s) to Your Existing Auto Scaling Group in the Auto Scaling Developer Guide .

Specified by:

attachInstances in interface AmazonAutoScaling

Parameters:

attachInstancesRequest - Container for the necessary parameters to execute the AttachInstances 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.

describeScalingActivities

public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)

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

Specified by:

describeScalingActivities in interface AmazonAutoScaling

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

public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)

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

Specified by:

describeNotificationConfigurations in interface AmazonAutoScaling

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.

describeTerminationPolicyTypes

public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)

Returns a list of all termination policies supported by Auto Scaling.

Specified by:

describeTerminationPolicyTypes in interface AmazonAutoScaling

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:

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.

describeTags

public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your filters. If there's no match, no special message is returned.

Specified by:

describeTags in interface AmazonAutoScaling

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:

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.

deleteTags

public void deleteTags(DeleteTagsRequest deleteTagsRequest)

Removes the specified tags or a set of tags from a set of resources.

Specified by:

deleteTags in interface AmazonAutoScaling

Parameters:

deleteTagsRequest - Container for the necessary parameters to execute the DeleteTags 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.

executePolicy

public void executePolicy(ExecutePolicyRequest executePolicyRequest)

Executes the specified policy.

Specified by:

executePolicy in interface AmazonAutoScaling

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

public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)

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.

Specified by:

putScalingPolicy in interface AmazonAutoScaling

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

public void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)

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 Get Email Notifications When Your Auto Scaling Group Changes

A new PutNotificationConfiguration overwrites an existing configuration.

Specified by:

putNotificationConfiguration in interface AmazonAutoScaling

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

public void deletePolicy(DeletePolicyRequest deletePolicyRequest)

Deletes a policy created by PutScalingPolicy.

Specified by:

deletePolicy in interface AmazonAutoScaling

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

public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)

Deletes notifications created by PutNotificationConfiguration.

Specified by:

deleteNotificationConfiguration in interface AmazonAutoScaling

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

public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)

Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.

Specified by:

deleteScheduledAction in interface AmazonAutoScaling

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

public void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)

Sets the health status of a specified instance that belongs to any of your Auto Scaling groups.

For more information, see Configure Health Checks for Your Auto Scaling group .

Specified by:

setInstanceHealth in interface AmazonAutoScaling

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

public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)

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

Specified by:

describeAutoScalingNotificationTypes in interface AmazonAutoScaling

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.

createOrUpdateTags

public void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)

Creates new tags or updates existing tags for an Auto Scaling group.

NOTE: A tag's definition is composed of a resource ID, resource type, key and value, and the propagate flag. Value and the propagate flag are optional parameters. See the Request Parameters for more information.

For information on creating tags for your Auto Scaling group, see Tag Your Auto Scaling Groups and Amazon EC2 Instances .

Specified by:

createOrUpdateTags in interface AmazonAutoScaling

Parameters:

createOrUpdateTagsRequest - Container for the necessary parameters to execute the CreateOrUpdateTags 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.

suspendProcesses

public void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)

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.

To resume processes that have been suspended, use ResumeProcesses For more information on suspending and resuming Auto Scaling process, see Suspend and Resume Auto Scaling Process .

Specified by:

suspendProcesses in interface AmazonAutoScaling

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.

createLaunchConfiguration

public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)

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.

Specified by:

createLaunchConfiguration in interface AmazonAutoScaling

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.

describeAutoScalingInstances

public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)

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

Specified by:

describeAutoScalingInstances in interface AmazonAutoScaling

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.

deleteAutoScalingGroup

public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)

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.

Specified by:

deleteAutoScalingGroup in interface AmazonAutoScaling

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

public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)

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.

Specified by:

disableMetricsCollection in interface AmazonAutoScaling

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

public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)

Updates the configuration for the specified AutoScalingGroup.

NOTE: To update an Auto Scaling group with a launch configuration that has the InstanceMonitoring 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. Scaling activities that are currently in progress aren't affected.

NOTE: If a new value is specified for MinSize without specifying the value for DesiredCapacity, and if the new MinSize is larger than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MinSize. If a new value is specified for MaxSize without specifying the value for DesiredCapacity, and the new MaxSize is smaller than the current size of the Auto Scaling Group, there will be an implicit call to SetDesiredCapacity to set the group to the new MaxSize. All other optional parameters are left unchanged if not passed in the request.

Specified by:

updateAutoScalingGroup in interface AmazonAutoScaling

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

public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

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

Specified by:

describeLaunchConfigurations in interface AmazonAutoScaling

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

public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)

Returns policy adjustment types for use in the PutScalingPolicy action.

Specified by:

describeAdjustmentTypes in interface AmazonAutoScaling

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

public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)

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

Specified by:

describeScheduledActions in interface AmazonAutoScaling

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

public void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)

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 information on creating or updating a scheduled action for your Auto Scaling group, see Scale Based on a Schedule .

NOTE: Auto Scaling supports the date and time expressed in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only.

Specified by:

putScheduledUpdateGroupAction in interface AmazonAutoScaling

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

public DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)

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

Specified by:

describeMetricCollectionTypes in interface AmazonAutoScaling

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

public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)

Sets the desired size of the specified AutoScalingGroup.

Specified by:

setDesiredCapacity in interface AmazonAutoScaling

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

public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)

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.

Specified by:

terminateInstanceInAutoScalingGroup in interface AmazonAutoScaling

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.

describeAccountLimits

public DescribeAccountLimitsResult describeAccountLimits()
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Returns the limits for the Auto Scaling resources currently allowed for your AWS account.

Your AWS account comes with default limits on resources for Auto Scaling. There is a default limit of 20 Auto Scaling groups and 100 launch configurations per region.

If you reach the limits for the number of Auto Scaling groups or the launch configurations, you can go to the Support Center and place a request to raise the limits.

Specified by:

describeAccountLimits in interface AmazonAutoScaling

Returns:

The response from the DescribeAccountLimits 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.

describeAutoScalingGroups

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

Specified by:

describeAutoScalingGroups in interface 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.

describePolicies

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

Specified by:

describePolicies in interface 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

public DescribeScalingProcessTypesResult describeScalingProcessTypes()
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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

Specified by:

describeScalingProcessTypes in interface 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.

describeScalingActivities

public 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 the start 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.

Specified by:

describeScalingActivities in interface 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

public DescribeNotificationConfigurationsResult describeNotificationConfigurations()
                                                                            throws AmazonServiceException,
                                                                                   AmazonClientException

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

Specified by:

describeNotificationConfigurations in interface 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.

describeTerminationPolicyTypes

public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Returns a list of all termination policies supported by Auto Scaling.

Specified by:

describeTerminationPolicyTypes in interface AmazonAutoScaling

Returns:

The response from the DescribeTerminationPolicyTypes 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.

describeTags

public DescribeTagsResult describeTags()
                                throws AmazonServiceException,
                                       AmazonClientException

Lists the Auto Scaling group tags.

You can use filters to limit results when describing tags. For example, you can query for tags of a particular 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 your filters. If there's no match, no special message is returned.

Specified by:

describeTags in interface AmazonAutoScaling

Returns:

The response from the DescribeTags 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

public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
                                                                                throws AmazonServiceException,
                                                                                       AmazonClientException

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

Specified by:

describeAutoScalingNotificationTypes in interface 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.

describeAutoScalingInstances

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

Specified by:

describeAutoScalingInstances in interface 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.

describeLaunchConfigurations

public DescribeLaunchConfigurationsResult describeLaunchConfigurations()
                                                                throws AmazonServiceException,
                                                                       AmazonClientException

Returns a full description of the launch configurations, or the specified launch configurations, if they exist.

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

Specified by:

describeLaunchConfigurations in interface 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

public DescribeAdjustmentTypesResult describeAdjustmentTypes()
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Returns policy adjustment types for use in the PutScalingPolicy action.

Specified by:

describeAdjustmentTypes in interface 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

public 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 actions already executed, see the activity record returned in DescribeScalingActivities.

Specified by:

describeScheduledActions in interface 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.

describeMetricCollectionTypes

public DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

Specified by:

describeMetricCollectionTypes in interface 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.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonAutoScaling

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.