com.amazonaws.services.autoscaling.AmazonAutoScaling Maven / Gradle / Ivy
Show all versions of aws-java-sdk Show documentation
/*
* Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.autoscaling;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.autoscaling.model.*;
/**
* Interface for accessing AmazonAutoScaling.
* 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.
*
*/
public interface AmazonAutoScaling {
/**
* Overrides the default endpoint for this client ("https://autoscaling.amazonaws.com").
* Callers can use this method to control which AWS region they want to work with.
*
* Callers can pass in just the endpoint (ex: "autoscaling.amazonaws.com") or a full
* URL, including the protocol (ex: "https://autoscaling.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link 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.
*
* @param endpoint
* The endpoint (ex: "autoscaling.amazonaws.com") or a full URL,
* including the protocol (ex: "https://autoscaling.amazonaws.com") of
* the region specific AWS endpoint this client will communicate
* with.
*
* @throws IllegalArgumentException
* If any problems are detected with the specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonAutoScaling#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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException
* If the given region is null, or if this service isn't
* available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
*
* 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.
*
*
* @param describeAccountLimitsRequest Container for the necessary
* parameters to execute the DescribeAccountLimits service method on
* AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
throws 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.
*
*
* @param describeAutoScalingGroupsRequest Container for the necessary
* parameters to execute the DescribeAutoScalingGroups service method on
* AmazonAutoScaling.
*
* @return The response from the DescribeAutoScalingGroups service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
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 .
*
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
throws 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
* .
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
throws 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.
*
*
* @param deleteLaunchConfigurationRequest Container for the necessary
* parameters to execute the DeleteLaunchConfiguration service method on
* AmazonAutoScaling.
*
*
* @throws ResourceInUseException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
throws 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.
*
*
* @param describePoliciesRequest Container for the necessary parameters
* to execute the DescribePolicies service method on AmazonAutoScaling.
*
* @return The response from the DescribePolicies service method, as
* returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns scaling process types for use in the ResumeProcesses and
* SuspendProcesses actions.
*
*
* @param describeScalingProcessTypesRequest Container for the necessary
* parameters to execute the DescribeScalingProcessTypes service method
* on AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
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.
*
*
* @param createAutoScalingGroupRequest Container for the necessary
* parameters to execute the CreateAutoScalingGroup service method on
* AmazonAutoScaling.
*
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* 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 .
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void attachInstances(AttachInstancesRequest attachInstancesRequest)
throws 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.
*
*
* @param describeScalingActivitiesRequest Container for the necessary
* parameters to execute the DescribeScalingActivities service method on
* AmazonAutoScaling.
*
* @return The response from the DescribeScalingActivities service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of notification actions associated with Auto Scaling
* groups for specified events.
*
*
* @param describeNotificationConfigurationsRequest Container for the
* necessary parameters to execute the DescribeNotificationConfigurations
* service method on AmazonAutoScaling.
*
* @return The response from the DescribeNotificationConfigurations
* service method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of all termination policies supported by Auto Scaling.
*
*
* @param describeTerminationPolicyTypesRequest Container for the
* necessary parameters to execute the DescribeTerminationPolicyTypes
* service method on AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
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.
*
*
* @param describeTagsRequest Container for the necessary parameters to
* execute the DescribeTags service method on AmazonAutoScaling.
*
* @return The response from the DescribeTags service method, as returned
* by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Removes the specified tags or a set of tags from a set of resources.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteTags(DeleteTagsRequest deleteTagsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Executes the specified policy.
*
*
* @param executePolicyRequest Container for the necessary parameters to
* execute the ExecutePolicy service method on AmazonAutoScaling.
*
*
* @throws ScalingActivityInProgressException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void executePolicy(ExecutePolicyRequest executePolicyRequest)
throws 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.
*
*
* @param putScalingPolicyRequest Container for the necessary parameters
* to execute the PutScalingPolicy service method on AmazonAutoScaling.
*
* @return The response from the PutScalingPolicy service method, as
* returned by AmazonAutoScaling.
*
* @throws LimitExceededException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
throws 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.
*
*
* @param putNotificationConfigurationRequest Container for the necessary
* parameters to execute the PutNotificationConfiguration service method
* on AmazonAutoScaling.
*
*
* @throws LimitExceededException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes a policy created by PutScalingPolicy.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deletePolicy(DeletePolicyRequest deletePolicyRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes notifications created by PutNotificationConfiguration.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Deletes a scheduled action previously created using the
* PutScheduledUpdateGroupAction.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
throws 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
* .
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of all notification types that are supported by Auto
* Scaling.
*
*
* @param describeAutoScalingNotificationTypesRequest Container for the
* necessary parameters to execute the
* DescribeAutoScalingNotificationTypes service method on
* AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
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
* .
*
*
* @param createOrUpdateTagsRequest Container for the necessary
* parameters to execute the CreateOrUpdateTags service method on
* AmazonAutoScaling.
*
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
throws 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
* .
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
throws 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.
*
*
* @param createLaunchConfigurationRequest Container for the necessary
* parameters to execute the CreateLaunchConfiguration service method on
* AmazonAutoScaling.
*
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
throws 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.
*
*
* @param describeAutoScalingInstancesRequest Container for the necessary
* parameters to execute the DescribeAutoScalingInstances service method
* on AmazonAutoScaling.
*
* @return The response from the DescribeAutoScalingInstances service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
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.
*
*
* @param deleteAutoScalingGroupRequest Container for the necessary
* parameters to execute the DeleteAutoScalingGroup service method on
* AmazonAutoScaling.
*
*
* @throws ResourceInUseException
* @throws ScalingActivityInProgressException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
throws 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.
*
*
* @param 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
throws 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.
*
*
* @param updateAutoScalingGroupRequest Container for the necessary
* parameters to execute the UpdateAutoScalingGroup service method on
* AmazonAutoScaling.
*
*
* @throws ScalingActivityInProgressException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
throws 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.
*
*
* @param describeLaunchConfigurationsRequest Container for the necessary
* parameters to execute the DescribeLaunchConfigurations service method
* on AmazonAutoScaling.
*
* @return The response from the DescribeLaunchConfigurations service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns policy adjustment types for use in the PutScalingPolicy
* action.
*
*
* @param describeAdjustmentTypesRequest Container for the necessary
* parameters to execute the DescribeAdjustmentTypes service method on
* AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
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.
*
*
* @param describeScheduledActionsRequest Container for the necessary
* parameters to execute the DescribeScheduledActions service method on
* AmazonAutoScaling.
*
* @return The response from the DescribeScheduledActions service method,
* as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
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.
*
*
* @param putScheduledUpdateGroupActionRequest Container for the
* necessary parameters to execute the PutScheduledUpdateGroupAction
* service method on AmazonAutoScaling.
*
*
* @throws LimitExceededException
* @throws AlreadyExistsException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of metrics and a corresponding list of granularities
* for each metric.
*
*
* @param describeMetricCollectionTypesRequest Container for the
* necessary parameters to execute the DescribeMetricCollectionTypes
* service method on AmazonAutoScaling.
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
throws AmazonServiceException, AmazonClientException;
/**
*
* Sets the desired size of the specified AutoScalingGroup.
*
*
* @param setDesiredCapacityRequest Container for the necessary
* parameters to execute the SetDesiredCapacity service method on
* AmazonAutoScaling.
*
*
* @throws ScalingActivityInProgressException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
throws 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.
*
*
* @param terminateInstanceInAutoScalingGroupRequest Container for the
* necessary parameters to execute the
* TerminateInstanceInAutoScalingGroup service method on
* AmazonAutoScaling.
*
* @return The response from the TerminateInstanceInAutoScalingGroup
* service method, as returned by AmazonAutoScaling.
*
* @throws ScalingActivityInProgressException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
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.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAccountLimitsResult describeAccountLimits() 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.
*
*
* @return The response from the DescribeAutoScalingGroups service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingGroupsResult describeAutoScalingGroups() 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.
*
*
* @return The response from the DescribePolicies service method, as
* returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribePoliciesResult describePolicies() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns scaling process types for use in the ResumeProcesses and
* SuspendProcesses actions.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScalingProcessTypesResult describeScalingProcessTypes() 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.
*
*
* @return The response from the DescribeScalingActivities service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScalingActivitiesResult describeScalingActivities() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of notification actions associated with Auto Scaling
* groups for specified events.
*
*
* @return The response from the DescribeNotificationConfigurations
* service method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeNotificationConfigurationsResult describeNotificationConfigurations() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of all termination policies supported by Auto Scaling.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes() 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.
*
*
* @return The response from the DescribeTags service method, as returned
* by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeTagsResult describeTags() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of all notification types that are supported by Auto
* Scaling.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes() 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.
*
*
* @return The response from the DescribeAutoScalingInstances service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAutoScalingInstancesResult describeAutoScalingInstances() 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.
*
*
* @return The response from the DescribeLaunchConfigurations service
* method, as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeLaunchConfigurationsResult describeLaunchConfigurations() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns policy adjustment types for use in the PutScalingPolicy
* action.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeAdjustmentTypesResult describeAdjustmentTypes() 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.
*
*
* @return The response from the DescribeScheduledActions service method,
* as returned by AmazonAutoScaling.
*
* @throws InvalidNextTokenException
*
* @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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeScheduledActionsResult describeScheduledActions() throws AmazonServiceException, AmazonClientException;
/**
*
* Returns a list of metrics and a corresponding list of granularities
* for each metric.
*
*
* @return 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.
* @throws AmazonServiceException
* If an error response is returned by AmazonAutoScaling indicating
* either a problem with the data in the request, or a server side issue.
*/
public DescribeMetricCollectionTypesResult describeMetricCollectionTypes() throws AmazonServiceException, AmazonClientException;
/**
* Shuts down this client object, releasing any resources that might be held
* open. This is an optional method, and callers are not expected to call
* it, but can if they want to explicitly release any open resources. Once a
* client has been shutdown, it should not be used to make any more
* requests.
*/
public void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for
* debugging issues where a service isn't acting as expected. This data isn't considered part
* of the result data returned by an operation, so it's available through this separate,
* diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access
* this extra diagnostic information for an executed request, you should use this method
* to retrieve it as soon as possible after executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}