public interface AmazonAutoScaling
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
For information about this product's regions and endpoints, go to Regions and Endpoints in the Amazon Web Services General Reference.
Modifier and Type | Method and Description |
---|---|
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.
|
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 |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com").
|
void |
setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of a specified instance that belongs to any of
your Auto Scaling groups.
|
void |
setRegion(Region region)
An alternative to
setEndpoint(String) , sets the
regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
void |
suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends 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.
|
void setEndpoint(String endpoint) throws IllegalArgumentException
Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com") or a full
URL, including the protocol (ex: "https://autoscaling.amazonaws.com"). If the
protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "autoscaling.amazonaws.com") or a full URL,
including the protocol (ex: "https://autoscaling.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.IllegalArgumentException
- If any problems are detected with the specified endpoint.void setRegion(Region region) throws IllegalArgumentException
setEndpoint(String)
, sets the
regional endpoint for this client's service calls. Callers can use this
method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions)
for
accessing a given region.IllegalArgumentException
- If the given region is null, or if this service isn't
available in the given region. See
Region.isServiceSupported(String)
Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
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.
describeAutoScalingGroupsRequest
- Container for the necessary
parameters to execute the DescribeAutoScalingGroups service method on
AmazonAutoScaling.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.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
flag, in the Auto Scaling group's
launch configuration, is set to True
.
enableMetricsCollectionRequest
- Container for the necessary
parameters to execute the EnableMetricsCollection service method on
AmazonAutoScaling.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.void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest) throws AmazonServiceException, AmazonClientException
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 .
resumeProcessesRequest
- Container for the necessary parameters
to execute the ResumeProcesses service method on AmazonAutoScaling.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.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.
deleteLaunchConfigurationRequest
- Container for the necessary
parameters to execute the DeleteLaunchConfiguration service method on
AmazonAutoScaling.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.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.
describePoliciesRequest
- Container for the necessary parameters
to execute the DescribePolicies service method on AmazonAutoScaling.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.DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest) throws AmazonServiceException, AmazonClientException
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
describeScalingProcessTypesRequest
- Container for the necessary
parameters to execute the DescribeScalingProcessTypes service method
on AmazonAutoScaling.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.void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest) throws AmazonServiceException, AmazonClientException
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.
createAutoScalingGroupRequest
- Container for the necessary
parameters to execute the CreateAutoScalingGroup service method on
AmazonAutoScaling.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.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.
describeScalingActivitiesRequest
- Container for the necessary
parameters to execute the DescribeScalingActivities service method on
AmazonAutoScaling.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.DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of notification actions associated with Auto Scaling groups for specified events.
describeNotificationConfigurationsRequest
- Container for the
necessary parameters to execute the DescribeNotificationConfigurations
service method on AmazonAutoScaling.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.DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of all termination policies supported by Auto Scaling.
describeTerminationPolicyTypesRequest
- Container for the
necessary parameters to execute the DescribeTerminationPolicyTypes
service method on AmazonAutoScaling.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.DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest) 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.
describeTagsRequest
- Container for the necessary parameters to
execute the DescribeTags service method on AmazonAutoScaling.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.void executePolicy(ExecutePolicyRequest executePolicyRequest) throws AmazonServiceException, AmazonClientException
Executes the specified policy.
executePolicyRequest
- Container for the necessary parameters to
execute the ExecutePolicy service method on AmazonAutoScaling.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.void deleteTags(DeleteTagsRequest deleteTagsRequest) throws AmazonServiceException, AmazonClientException
Removes the specified tags or a set of tags from a set of resources.
deleteTagsRequest
- Container for the necessary parameters to
execute the DeleteTags service method on AmazonAutoScaling.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.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.
putScalingPolicyRequest
- Container for the necessary parameters
to execute the PutScalingPolicy service method on AmazonAutoScaling.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.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.
For more information see Get Email Notifications When Your Auto Scaling Group Changes
A new PutNotificationConfiguration
overwrites an existing
configuration.
putNotificationConfigurationRequest
- Container for the necessary
parameters to execute the PutNotificationConfiguration service method
on AmazonAutoScaling.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.void deletePolicy(DeletePolicyRequest deletePolicyRequest) throws AmazonServiceException, AmazonClientException
Deletes a policy created by PutScalingPolicy.
deletePolicyRequest
- Container for the necessary parameters to
execute the DeletePolicy service method on AmazonAutoScaling.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.void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest) throws AmazonServiceException, AmazonClientException
Deletes notifications created by PutNotificationConfiguration.
deleteNotificationConfigurationRequest
- Container for the
necessary parameters to execute the DeleteNotificationConfiguration
service method on AmazonAutoScaling.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.void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest) throws AmazonServiceException, AmazonClientException
Deletes a scheduled action previously created using the PutScheduledUpdateGroupAction.
deleteScheduledActionRequest
- Container for the necessary
parameters to execute the DeleteScheduledAction service method on
AmazonAutoScaling.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.void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest) throws AmazonServiceException, AmazonClientException
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 .
setInstanceHealthRequest
- Container for the necessary parameters
to execute the SetInstanceHealth service method on AmazonAutoScaling.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.DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of all notification types that are supported by Auto Scaling.
describeAutoScalingNotificationTypesRequest
- Container for the
necessary parameters to execute the
DescribeAutoScalingNotificationTypes service method on
AmazonAutoScaling.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.void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest) throws AmazonServiceException, AmazonClientException
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 .
createOrUpdateTagsRequest
- Container for the necessary
parameters to execute the CreateOrUpdateTags service method on
AmazonAutoScaling.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.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.
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 .
suspendProcessesRequest
- Container for the necessary parameters
to execute the SuspendProcesses service method on AmazonAutoScaling.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.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 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.
describeAutoScalingInstancesRequest
- Container for the necessary
parameters to execute the DescribeAutoScalingInstances service method
on AmazonAutoScaling.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.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.
NOTE: At this time, Auto Scaling launch configurations don't support compressed (e.g. zipped) user data files.
createLaunchConfigurationRequest
- Container for the necessary
parameters to execute the CreateLaunchConfiguration service method on
AmazonAutoScaling.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.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.
deleteAutoScalingGroupRequest
- Container for the necessary
parameters to execute the DeleteAutoScalingGroup service method on
AmazonAutoScaling.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.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.
disableMetricsCollectionRequest
- Container for the necessary
parameters to execute the DisableMetricsCollection service method on
AmazonAutoScaling.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.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 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.
updateAutoScalingGroupRequest
- Container for the necessary
parameters to execute the UpdateAutoScalingGroup service method on
AmazonAutoScaling.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.DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest) 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.
describeLaunchConfigurationsRequest
- Container for the necessary
parameters to execute the DescribeLaunchConfigurations service method
on AmazonAutoScaling.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.DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest) throws AmazonServiceException, AmazonClientException
Returns policy adjustment types for use in the PutScalingPolicy action.
describeAdjustmentTypesRequest
- Container for the necessary
parameters to execute the DescribeAdjustmentTypes service method on
AmazonAutoScaling.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.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 actions already executed, see the activity record returned in DescribeScalingActivities.
describeScheduledActionsRequest
- Container for the necessary
parameters to execute the DescribeScheduledActions service method on
AmazonAutoScaling.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.void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest) throws AmazonServiceException, AmazonClientException
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.
putScheduledUpdateGroupActionRequest
- Container for the
necessary parameters to execute the PutScheduledUpdateGroupAction
service method on AmazonAutoScaling.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.DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of metrics and a corresponding list of granularities for each metric.
describeMetricCollectionTypesRequest
- Container for the
necessary parameters to execute the DescribeMetricCollectionTypes
service method on AmazonAutoScaling.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.void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest) throws AmazonServiceException, AmazonClientException
Sets the desired size of the specified AutoScalingGroup.
setDesiredCapacityRequest
- Container for the necessary
parameters to execute the SetDesiredCapacity service method on
AmazonAutoScaling.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.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.
terminateInstanceInAutoScalingGroupRequest
- Container for the
necessary parameters to execute the
TerminateInstanceInAutoScalingGroup service method on
AmazonAutoScaling.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.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.
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.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.
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.DescribeScalingProcessTypesResult describeScalingProcessTypes() throws AmazonServiceException, AmazonClientException
Returns scaling process types for use in the ResumeProcesses and SuspendProcesses actions.
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.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.
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.DescribeNotificationConfigurationsResult describeNotificationConfigurations() throws AmazonServiceException, AmazonClientException
Returns a list of notification actions associated with Auto Scaling groups for specified events.
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.DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes() throws AmazonServiceException, AmazonClientException
Returns a list of all termination policies supported by Auto Scaling.
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.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.
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.DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes() throws AmazonServiceException, AmazonClientException
Returns a list of all notification types that are supported by Auto Scaling.
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.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.
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.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.
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.DescribeAdjustmentTypesResult describeAdjustmentTypes() throws AmazonServiceException, AmazonClientException
Returns policy adjustment types for use in the PutScalingPolicy action.
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.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.
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.DescribeMetricCollectionTypesResult describeMetricCollectionTypes() throws AmazonServiceException, AmazonClientException
Returns a list of metrics and a corresponding list of granularities for each metric.
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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.