public class AmazonAutoScalingClient extends AmazonWebServiceClient implements AmazonAutoScaling
Auto Scaling
Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.
Modifier and Type | Field and Description |
---|---|
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> |
exceptionUnmarshallers
List of exception unmarshallers for all AmazonAutoScaling exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonAutoScalingClient()
Constructs a new client to invoke service methods on
AmazonAutoScaling.
|
AmazonAutoScalingClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on
AmazonAutoScaling using the specified AWS account credentials.
|
AmazonAutoScalingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonAutoScaling using the specified AWS account credentials
and client configuration options.
|
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on
AmazonAutoScaling using the specified AWS account credentials provider.
|
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonAutoScaling using the specified AWS account credentials
provider and client configuration options.
|
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on
AmazonAutoScaling using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AmazonAutoScalingClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on
AmazonAutoScaling.
|
Modifier and Type | Method and Description |
---|---|
void |
attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling
group.
|
AttachLoadBalancersResult |
attachLoadBalancers()
Attaches one or more load balancers to the specified Auto Scaling
group.
|
AttachLoadBalancersResult |
attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest)
Attaches one or more load balancers to the specified Auto Scaling
group.
|
CompleteLifecycleActionResult |
completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
Completes the lifecycle action for the associated token initiated
under the given lifecycle hook with the specified result.
|
void |
createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
Creates an Auto Scaling group with the specified name and attributes.
|
void |
createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
Creates a launch configuration.
|
void |
createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
|
void |
deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
|
void |
deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
|
DeleteLifecycleHookResult |
deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
|
void |
deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
|
void |
deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified Auto Scaling policy.
|
void |
deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
|
void |
deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
|
DescribeAccountLimitsResult |
describeAccountLimits()
Describes the current Auto Scaling resource limits for your AWS
account.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Auto Scaling resource limits for your AWS
account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Describes the policy adjustment types for use with PutScalingPolicy.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with PutScalingPolicy.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Describes the notification types that are supported by Auto Scaling.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Auto Scaling.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Describes one or more launch configurations.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Describes one or more launch configurations.
|
DescribeLifecycleHooksResult |
describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes()
Describes the available types of lifecycle hooks.
|
DescribeLifecycleHookTypesResult |
describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
|
DescribeLoadBalancersResult |
describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the load balancers for the specified Auto Scaling group.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes()
Describes the available CloudWatch metrics for Auto Scaling.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Describes the notification actions associated with the specified Auto
Scaling group.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto
Scaling group.
|
DescribePoliciesResult |
describePolicies()
Describes the policies for the specified Auto Scaling group.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Describes one or more scaling activities for the specified Auto
Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Describes one or more scaling activities for the specified Auto
Scaling group.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes()
Describes the scaling process types for use with ResumeProcesses and
SuspendProcesses.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses and
SuspendProcesses.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Describes the actions scheduled for your Auto Scaling group that
haven't run.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the actions scheduled for your Auto Scaling group that
haven't run.
|
DescribeTagsResult |
describeTags()
Describes the specified tags.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Describes the termination policies supported by Auto Scaling.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Auto Scaling.
|
DetachInstancesResult |
detachInstances(DetachInstancesRequest detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group.
|
DetachLoadBalancersResult |
detachLoadBalancers()
Removes one or more load balancers from the specified Auto Scaling
group.
|
DetachLoadBalancersResult |
detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
Removes one or more load balancers from the specified Auto Scaling
group.
|
void |
disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables monitoring of the specified metrics for the specified Auto
Scaling group.
|
void |
enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
Enables monitoring of the specified metrics for the specified Auto
Scaling group.
|
EnterStandbyResult |
enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves the specified instances into
Standby mode. |
void |
executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
|
ExitStandbyResult |
exitStandby(ExitStandbyRequest exitStandbyRequest)
Moves the specified instances out of
Standby mode. |
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.
|
PutLifecycleHookResult |
putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling
Group.
|
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.
|
RecordLifecycleActionHeartbeatResult |
recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with a
specific token.
|
void |
resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
Resumes the specified suspended Auto Scaling processes for the
specified Auto Scaling group.
|
void |
setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
|
void |
setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of the specified instance.
|
void |
suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends the specified Auto Scaling processes for the specified Auto
Scaling group.
|
TerminateInstanceInAutoScalingGroupResult |
terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired
group size.
|
void |
updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
Updates the configuration for the specified Auto Scaling group.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers
public AmazonAutoScalingClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonAutoScalingClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this
client connects to AmazonAutoScaling
(ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain
public AmazonAutoScalingClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.public AmazonAutoScalingClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonAutoScaling
(ex: proxy settings, retry counts, etc.).public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonAutoScaling
(ex: proxy settings, retry counts, etc.).public AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this
client connects to AmazonAutoScaling
(ex: proxy settings, retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic DescribeAccountLimitsResult describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference .
describeAccountLimits
in interface AmazonAutoScaling
describeAccountLimitsRequest
- Container for the necessary
parameters to execute the DescribeAccountLimits service method on
AmazonAutoScaling.ResourceContentionException
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.public DescribeAutoScalingGroupsResult describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
describeAutoScalingGroups
in interface AmazonAutoScaling
describeAutoScalingGroupsRequest
- Container for the necessary
parameters to execute the DescribeAutoScalingGroups service method on
AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public void resumeProcesses(ResumeProcessesRequest resumeProcessesRequest)
Resumes the specified suspended Auto Scaling processes for the
specified Auto Scaling group. To resume specific processes, use the
ScalingProcesses
parameter. To resume all processes, omit
the ScalingProcesses
parameter. For more information, see
Suspend and Resume Auto Scaling Processes
in the Auto Scaling Developer Guide .
resumeProcesses
in interface AmazonAutoScaling
resumeProcessesRequest
- Container for the necessary parameters
to execute the ResumeProcesses service method on AmazonAutoScaling.ResourceInUseException
ResourceContentionException
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.public void enableMetricsCollection(EnableMetricsCollectionRequest enableMetricsCollectionRequest)
Enables monitoring of the specified metrics for the specified Auto Scaling group.
You can only enable metrics collection if
InstanceMonitoring
in the launch configuration for the
group is set to True
.
enableMetricsCollection
in interface AmazonAutoScaling
enableMetricsCollectionRequest
- Container for the necessary
parameters to execute the EnableMetricsCollection service method on
AmazonAutoScaling.ResourceContentionException
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.public DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooks
in interface AmazonAutoScaling
describeLifecycleHooksRequest
- Container for the necessary
parameters to execute the DescribeLifecycleHooks service method on
AmazonAutoScaling.ResourceContentionException
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.public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
describePolicies
in interface AmazonAutoScaling
describePoliciesRequest
- Container for the necessary parameters
to execute the DescribePolicies service method on AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
describeScalingProcessTypes
in interface AmazonAutoScaling
describeScalingProcessTypesRequest
- Container for the necessary
parameters to execute the DescribeScalingProcessTypes service method
on AmazonAutoScaling.ResourceContentionException
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.public void deleteLaunchConfiguration(DeleteLaunchConfigurationRequest deleteLaunchConfigurationRequest)
Deletes the specified launch configuration.
The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.
deleteLaunchConfiguration
in interface AmazonAutoScaling
deleteLaunchConfigurationRequest
- Container for the necessary
parameters to execute the DeleteLaunchConfiguration service method on
AmazonAutoScaling.ResourceInUseException
ResourceContentionException
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.public void createAutoScalingGroup(CreateAutoScalingGroupRequest createAutoScalingGroupRequest)
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.
For more information, see Auto Scaling Groups in the Auto Scaling Developer Guide .
createAutoScalingGroup
in interface AmazonAutoScaling
createAutoScalingGroupRequest
- Container for the necessary
parameters to execute the CreateAutoScalingGroup service method on
AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public void attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide .
attachInstances
in interface AmazonAutoScaling
attachInstancesRequest
- Container for the necessary parameters
to execute the AttachInstances service method on AmazonAutoScaling.ResourceContentionException
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.public DescribeScalingActivitiesResult describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Describes one or more scaling activities for the specified Auto
Scaling group. If you omit the ActivityIds
, the call
returns all activities from the past six weeks. Activities are sorted
by the start time. Activities still in progress appear first on the
list.
describeScalingActivities
in interface AmazonAutoScaling
describeScalingActivitiesRequest
- Container for the necessary
parameters to execute the DescribeScalingActivities service method on
AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurations
in interface AmazonAutoScaling
describeNotificationConfigurationsRequest
- Container for the
necessary parameters to execute the DescribeNotificationConfigurations
service method on AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public DeleteLifecycleHookResult deleteLifecycleHook(DeleteLifecycleHookRequest deleteLifecycleHookRequest)
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed
first ( ABANDON
for launching instances,
CONTINUE
for terminating instances).
deleteLifecycleHook
in interface AmazonAutoScaling
deleteLifecycleHookRequest
- Container for the necessary
parameters to execute the DeleteLifecycleHook service method on
AmazonAutoScaling.ResourceContentionException
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.public PutLifecycleHookResult putLifecycleHook(PutLifecycleHookRequest putLifecycleHookRequest)
Creates or updates a lifecycle hook for the specified Auto Scaling Group.
A lifecycle hook tells Auto Scaling that you want to perform an action on an instance that is not actively in service; for example, either when the instance launches or before the instance terminates.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference .
putLifecycleHook
in interface AmazonAutoScaling
putLifecycleHookRequest
- Container for the necessary parameters
to execute the PutLifecycleHook service method on AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Auto Scaling.
describeTerminationPolicyTypes
in interface AmazonAutoScaling
describeTerminationPolicyTypesRequest
- Container for the
necessary parameters to execute the DescribeTerminationPolicyTypes
service method on AmazonAutoScaling.ResourceContentionException
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.public DescribeTagsResult describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
describeTags
in interface AmazonAutoScaling
describeTagsRequest
- Container for the necessary parameters to
execute the DescribeTags service method on AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public void deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
deleteTags
in interface AmazonAutoScaling
deleteTagsRequest
- Container for the necessary parameters to
execute the DeleteTags service method on AmazonAutoScaling.ResourceContentionException
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.public void executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
executePolicy
in interface AmazonAutoScaling
executePolicyRequest
- Container for the necessary parameters to
execute the ExecutePolicy service method on AmazonAutoScaling.ScalingActivityInProgressException
ResourceContentionException
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.public DetachLoadBalancersResult detachLoadBalancers(DetachLoadBalancersRequest detachLoadBalancersRequest)
Removes one or more load balancers from the specified Auto Scaling group.
When you detach a load balancer, it enters the Removing
state while deregistering the instances in the group. When all
instances are deregistered, then you can no longer describe the load
balancer using DescribeLoadBalancers. Note that the instances remain
running.
detachLoadBalancers
in interface AmazonAutoScaling
detachLoadBalancersRequest
- Container for the necessary
parameters to execute the DetachLoadBalancers service method on
AmazonAutoScaling.ResourceContentionException
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.public PutScalingPolicyResult putScalingPolicy(PutScalingPolicyRequest putScalingPolicyRequest)
Creates or updates a policy for an Auto Scaling group. To update an existing policy, use the existing policy name and set the parameters you want to change. Any existing parameter not changed in an update to an existing policy is not changed in this update request.
If you exceed your maximum limit of step adjustments, which by default is 20 per region, the call fails. For information about updating this limit, see AWS Service Limits in the Amazon Web Services General Reference .
putScalingPolicy
in interface AmazonAutoScaling
putScalingPolicyRequest
- Container for the necessary parameters
to execute the PutScalingPolicy service method on AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public void putNotificationConfiguration(PutNotificationConfigurationRequest putNotificationConfigurationRequest)
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to this topic can have messages for events delivered to an endpoint such as a web server or email address.
For more information see Getting Notifications When Your Auto Scaling Group Changes in the Auto Scaling Developer Guide .
This configuration overwrites an existing configuration.
putNotificationConfiguration
in interface AmazonAutoScaling
putNotificationConfigurationRequest
- Container for the necessary
parameters to execute the PutNotificationConfiguration service method
on AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public ExitStandbyResult exitStandby(ExitStandbyRequest exitStandbyRequest)
Moves the specified instances out of Standby
mode.
For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide .
exitStandby
in interface AmazonAutoScaling
exitStandbyRequest
- Container for the necessary parameters to
execute the ExitStandby service method on AmazonAutoScaling.ResourceContentionException
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.public void deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified Auto Scaling policy.
deletePolicy
in interface AmazonAutoScaling
deletePolicyRequest
- Container for the necessary parameters to
execute the DeletePolicy service method on AmazonAutoScaling.ResourceContentionException
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.public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
deleteScheduledAction
in interface AmazonAutoScaling
deleteScheduledActionRequest
- Container for the necessary
parameters to execute the DeleteScheduledAction service method on
AmazonAutoScaling.ResourceContentionException
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.public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
deleteNotificationConfiguration
in interface AmazonAutoScaling
deleteNotificationConfigurationRequest
- Container for the
necessary parameters to execute the DeleteNotificationConfiguration
service method on AmazonAutoScaling.ResourceContentionException
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.public CompleteLifecycleActionResult completeLifecycleAction(CompleteLifecycleActionRequest completeLifecycleActionRequest)
Completes the lifecycle action for the associated token initiated under the given lifecycle hook with the specified result.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .
completeLifecycleAction
in interface AmazonAutoScaling
completeLifecycleActionRequest
- Container for the necessary
parameters to execute the CompleteLifecycleAction service method on
AmazonAutoScaling.ResourceContentionException
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.public void setInstanceHealth(SetInstanceHealthRequest setInstanceHealthRequest)
Sets the health status of the specified instance.
For more information, see Health Checks in the Auto Scaling Developer Guide .
setInstanceHealth
in interface AmazonAutoScaling
setInstanceHealthRequest
- Container for the necessary parameters
to execute the SetInstanceHealth service method on AmazonAutoScaling.ResourceContentionException
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.public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Auto Scaling.
describeAutoScalingNotificationTypes
in interface AmazonAutoScaling
describeAutoScalingNotificationTypesRequest
- Container for the
necessary parameters to execute the
DescribeAutoScalingNotificationTypes service method on
AmazonAutoScaling.ResourceContentionException
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.public void suspendProcesses(SuspendProcessesRequest suspendProcessesRequest)
Suspends the specified Auto Scaling processes for the specified Auto
Scaling group. To suspend specific processes, use the
ScalingProcesses
parameter. To suspend all processes,
omit the ScalingProcesses
parameter.
Note that if you suspend either the Launch
or
Terminate
process types, it can prevent other process
types from functioning properly.
To resume processes that have been suspended, use ResumeProcesses.
For more information, see Suspend and Resume Auto Scaling Processes in the Auto Scaling Developer Guide .
suspendProcesses
in interface AmazonAutoScaling
suspendProcessesRequest
- Container for the necessary parameters
to execute the SuspendProcesses service method on AmazonAutoScaling.ResourceInUseException
ResourceContentionException
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.public void createOrUpdateTags(CreateOrUpdateTagsRequest createOrUpdateTagsRequest)
Creates or updates tags for the specified Auto Scaling group.
A tag is defined by its resource ID, resource type, key, value, and
propagate flag. The value and the propagate flag are optional
parameters. The only supported resource type is
auto-scaling-group
, and the resource ID must be the name
of the group. The PropagateAtLaunch
flag determines
whether the tag is added to instances launched in the group. Valid
values are true
or false
.
When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.
For more information, see Tagging Auto Scaling Groups and Instances in the Auto Scaling Developer Guide .
createOrUpdateTags
in interface AmazonAutoScaling
createOrUpdateTagsRequest
- Container for the necessary
parameters to execute the CreateOrUpdateTags service method on
AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the load balancers for the specified Auto Scaling group.
describeLoadBalancers
in interface AmazonAutoScaling
describeLoadBalancersRequest
- Container for the necessary
parameters to execute the DescribeLoadBalancers service method on
AmazonAutoScaling.ResourceContentionException
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.public AttachLoadBalancersResult attachLoadBalancers(AttachLoadBalancersRequest attachLoadBalancersRequest)
Attaches one or more load balancers to the specified Auto Scaling group.
To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide .
attachLoadBalancers
in interface AmazonAutoScaling
attachLoadBalancersRequest
- Container for the necessary
parameters to execute the AttachLoadBalancers service method on
AmazonAutoScaling.ResourceContentionException
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.public DetachInstancesResult detachInstances(DetachInstancesRequest detachInstancesRequest)
Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide .
detachInstances
in interface AmazonAutoScaling
detachInstancesRequest
- Container for the necessary parameters
to execute the DetachInstances service method on AmazonAutoScaling.ResourceContentionException
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.public DescribeAutoScalingInstancesResult describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
describeAutoScalingInstances
in interface AmazonAutoScaling
describeAutoScalingInstancesRequest
- Container for the necessary
parameters to execute the DescribeAutoScalingInstances service method
on AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public void createLaunchConfiguration(CreateLaunchConfigurationRequest createLaunchConfigurationRequest)
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see DescribeAccountLimits.
For more information, see Launch Configurations in the Auto Scaling Developer Guide .
createLaunchConfiguration
in interface AmazonAutoScaling
createLaunchConfigurationRequest
- Container for the necessary
parameters to execute the CreateLaunchConfiguration service method on
AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public EnterStandbyResult enterStandby(EnterStandbyRequest enterStandbyRequest)
Moves the specified instances into Standby
mode.
For more information, see Auto Scaling InService State in the Auto Scaling Developer Guide .
enterStandby
in interface AmazonAutoScaling
enterStandbyRequest
- Container for the necessary parameters to
execute the EnterStandby service method on AmazonAutoScaling.ResourceContentionException
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.public DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
describeLifecycleHookTypes
in interface AmazonAutoScaling
describeLifecycleHookTypesRequest
- Container for the necessary
parameters to execute the DescribeLifecycleHookTypes service method on
AmazonAutoScaling.ResourceContentionException
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.public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
The group must have no instances and no scaling activities in progress.
To remove all instances before calling
DeleteAutoScalingGroup
, call UpdateAutoScalingGroup to
set the minimum and maximum size of the Auto Scaling group to zero.
deleteAutoScalingGroup
in interface AmazonAutoScaling
deleteAutoScalingGroupRequest
- Container for the necessary
parameters to execute the DeleteAutoScalingGroup service method on
AmazonAutoScaling.ResourceInUseException
ScalingActivityInProgressException
ResourceContentionException
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.public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables monitoring of the specified metrics for the specified Auto Scaling group.
disableMetricsCollection
in interface AmazonAutoScaling
disableMetricsCollectionRequest
- Container for the necessary
parameters to execute the DisableMetricsCollection service method on
AmazonAutoScaling.ResourceContentionException
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.public void updateAutoScalingGroup(UpdateAutoScalingGroupRequest updateAutoScalingGroupRequest)
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group with a launch configuration with
InstanceMonitoring
set to False
, you must
first disable the collection of group metrics. Otherwise, you will get
an error. If you have previously enabled the collection of group
metrics, you can disable it using DisableMetricsCollection.
The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.
Note the following:
If you specify a new value for MinSize
without
specifying a value for DesiredCapacity
, and the new
MinSize
is larger than the current size of the group, we
implicitly call SetDesiredCapacity to set the size of the group to the
new value of MinSize
.
If you specify a new value for MaxSize
without
specifying a value for DesiredCapacity
, and the new
MaxSize
is smaller than the current size of the group, we
implicitly call SetDesiredCapacity to set the size of the group to the
new value of MaxSize
.
All other optional parameters are left unchanged if not specified.
updateAutoScalingGroup
in interface AmazonAutoScaling
updateAutoScalingGroupRequest
- Container for the necessary
parameters to execute the UpdateAutoScalingGroup service method on
AmazonAutoScaling.ScalingActivityInProgressException
ResourceContentionException
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.public DescribeLaunchConfigurationsResult describeLaunchConfigurations(DescribeLaunchConfigurationsRequest describeLaunchConfigurationsRequest)
Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
describeLaunchConfigurations
in interface AmazonAutoScaling
describeLaunchConfigurationsRequest
- Container for the necessary
parameters to execute the DescribeLaunchConfigurations service method
on AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with PutScalingPolicy.
describeAdjustmentTypes
in interface AmazonAutoScaling
describeAdjustmentTypesRequest
- Container for the necessary
parameters to execute the DescribeAdjustmentTypes service method on
AmazonAutoScaling.ResourceContentionException
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.public DescribeScheduledActionsResult describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
describeScheduledActions
in interface AmazonAutoScaling
describeScheduledActionsRequest
- Container for the necessary
parameters to execute the DescribeScheduledActions service method on
AmazonAutoScaling.InvalidNextTokenException
ResourceContentionException
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.public RecordLifecycleActionHeartbeatResult recordLifecycleActionHeartbeat(RecordLifecycleActionHeartbeatRequest recordLifecycleActionHeartbeatRequest)
Records a heartbeat for the lifecycle action associated with a
specific token. This extends the timeout by the length of time defined
by the HeartbeatTimeout
parameter of PutLifecycleHook.
This operation is a part of the basic sequence for adding a lifecycle hook to an Auto Scaling group:
For more information, see Auto Scaling Pending State and Auto Scaling Terminating State in the Auto Scaling Developer Guide .
recordLifecycleActionHeartbeat
in interface AmazonAutoScaling
recordLifecycleActionHeartbeatRequest
- Container for the
necessary parameters to execute the RecordLifecycleActionHeartbeat
service method on AmazonAutoScaling.ResourceContentionException
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.public void putScheduledUpdateGroupAction(PutScheduledUpdateGroupActionRequest putScheduledUpdateGroupActionRequest)
Creates or updates a scheduled scaling action for an Auto Scaling group. When updating a scheduled scaling action, if you leave a parameter unspecified, the corresponding value remains unchanged in the affected Auto Scaling group.
For more information, see Scheduled Scaling in the Auto Scaling Developer Guide .
putScheduledUpdateGroupAction
in interface AmazonAutoScaling
putScheduledUpdateGroupActionRequest
- Container for the
necessary parameters to execute the PutScheduledUpdateGroupAction
service method on AmazonAutoScaling.LimitExceededException
ResourceContentionException
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.public DescribeMetricCollectionTypesResult describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Auto Scaling.
Note that the GroupStandbyInstances
metric is not
returned by default. You must explicitly request this metric when
calling EnableMetricsCollection.
describeMetricCollectionTypes
in interface AmazonAutoScaling
describeMetricCollectionTypesRequest
- Container for the
necessary parameters to execute the DescribeMetricCollectionTypes
service method on AmazonAutoScaling.ResourceContentionException
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.public void setDesiredCapacity(SetDesiredCapacityRequest setDesiredCapacityRequest)
Sets the size of the specified Auto Scaling group.
For more information about desired capacity, see What Is Auto Scaling? in the Auto Scaling Developer Guide .
setDesiredCapacity
in interface AmazonAutoScaling
setDesiredCapacityRequest
- Container for the necessary
parameters to execute the SetDesiredCapacity service method on
AmazonAutoScaling.ScalingActivityInProgressException
ResourceContentionException
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.public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instances is not terminated immediately.
terminateInstanceInAutoScalingGroup
in interface AmazonAutoScaling
terminateInstanceInAutoScalingGroupRequest
- Container for the
necessary parameters to execute the
TerminateInstanceInAutoScalingGroup service method on
AmazonAutoScaling.ScalingActivityInProgressException
ResourceContentionException
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.public DescribeAccountLimitsResult describeAccountLimits() throws AmazonServiceException, AmazonClientException
Describes the current Auto Scaling resource limits for your AWS account.
For information about requesting an increase in these limits, see AWS Service Limits in the Amazon Web Services General Reference .
describeAccountLimits
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeAutoScalingGroupsResult describeAutoScalingGroups() throws AmazonServiceException, AmazonClientException
Describes one or more Auto Scaling groups. If a list of names is not provided, the call describes all Auto Scaling groups.
describeAutoScalingGroups
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribePoliciesResult describePolicies() throws AmazonServiceException, AmazonClientException
Describes the policies for the specified Auto Scaling group.
describePolicies
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeScalingProcessTypesResult describeScalingProcessTypes() throws AmazonServiceException, AmazonClientException
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
describeScalingProcessTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeScalingActivitiesResult describeScalingActivities() throws AmazonServiceException, AmazonClientException
Describes one or more scaling activities for the specified Auto
Scaling group. If you omit the ActivityIds
, the call
returns all activities from the past six weeks. Activities are sorted
by the start time. Activities still in progress appear first on the
list.
describeScalingActivities
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeNotificationConfigurationsResult describeNotificationConfigurations() throws AmazonServiceException, AmazonClientException
Describes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurations
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes() throws AmazonServiceException, AmazonClientException
Describes the termination policies supported by Auto Scaling.
describeTerminationPolicyTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeTagsResult describeTags() throws AmazonServiceException, AmazonClientException
Describes the specified tags.
You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at least one of the specified values for it to be included in the results.
You can also specify multiple filters. The result includes information for a particular tag only if it matches all the filters. If there's no match, no special message is returned.
describeTags
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DetachLoadBalancersResult detachLoadBalancers() throws AmazonServiceException, AmazonClientException
Removes one or more load balancers from the specified Auto Scaling group.
When you detach a load balancer, it enters the Removing
state while deregistering the instances in the group. When all
instances are deregistered, then you can no longer describe the load
balancer using DescribeLoadBalancers. Note that the instances remain
running.
detachLoadBalancers
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes() throws AmazonServiceException, AmazonClientException
Describes the notification types that are supported by Auto Scaling.
describeAutoScalingNotificationTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public AttachLoadBalancersResult attachLoadBalancers() throws AmazonServiceException, AmazonClientException
Attaches one or more load balancers to the specified Auto Scaling group.
To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.
For more information, see Attach a Load Balancer to Your Auto Scaling Group in the Auto Scaling Developer Guide .
attachLoadBalancers
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeAutoScalingInstancesResult describeAutoScalingInstances() throws AmazonServiceException, AmazonClientException
Describes one or more Auto Scaling instances. If a list is not provided, the call describes all instances.
describeAutoScalingInstances
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeLifecycleHookTypesResult describeLifecycleHookTypes() throws AmazonServiceException, AmazonClientException
Describes the available types of lifecycle hooks.
describeLifecycleHookTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeLaunchConfigurationsResult describeLaunchConfigurations() throws AmazonServiceException, AmazonClientException
Describes one or more launch configurations. If you omit the list of names, then the call describes all launch configurations.
describeLaunchConfigurations
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeAdjustmentTypesResult describeAdjustmentTypes() throws AmazonServiceException, AmazonClientException
Describes the policy adjustment types for use with PutScalingPolicy.
describeAdjustmentTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public DescribeScheduledActionsResult describeScheduledActions() throws AmazonServiceException, AmazonClientException
Describes the actions scheduled for your Auto Scaling group that haven't run. To describe the actions that have already run, use DescribeScalingActivities.
describeScheduledActions
in interface AmazonAutoScaling
InvalidNextTokenException
ResourceContentionException
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.public DescribeMetricCollectionTypesResult describeMetricCollectionTypes() throws AmazonServiceException, AmazonClientException
Describes the available CloudWatch metrics for Auto Scaling.
Note that the GroupStandbyInstances
metric is not
returned by default. You must explicitly request this metric when
calling EnableMetricsCollection.
describeMetricCollectionTypes
in interface AmazonAutoScaling
ResourceContentionException
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.public 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 the request.
getCachedResponseMetadata
in interface AmazonAutoScaling
request
- The originally executed requestCopyright © 2015. All rights reserved.