public class AmazonAutoScalingClient extends AmazonWebServiceClient implements AmazonAutoScaling
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.
LOGGING_AWS_REQUEST_METRIC| Constructor and Description |
|---|
AmazonAutoScalingClient()
Constructs a new client to invoke service methods on Auto Scaling.
|
AmazonAutoScalingClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Auto Scaling using
the specified AWS account credentials.
|
AmazonAutoScalingClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Auto Scaling using
the specified AWS account credentials and client configuration options.
|
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Auto Scaling using
the specified AWS account credentials provider.
|
AmazonAutoScalingClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Auto Scaling 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 Auto Scaling 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 Auto Scaling.
|
| Modifier and Type | Method and Description |
|---|---|
void |
attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
|
AttachLoadBalancersResult |
attachLoadBalancers()
Simplified method form for invoking the AttachLoadBalancers operation.
|
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()
Simplified method form for invoking the DescribeAccountLimits operation.
|
DescribeAccountLimitsResult |
describeAccountLimits(DescribeAccountLimitsRequest describeAccountLimitsRequest)
Describes the current Auto Scaling resource limits for your AWS account.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes()
Simplified method form for invoking the DescribeAdjustmentTypes
operation.
|
DescribeAdjustmentTypesResult |
describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with
PutScalingPolicy.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups()
Simplified method form for invoking the DescribeAutoScalingGroups
operation.
|
DescribeAutoScalingGroupsResult |
describeAutoScalingGroups(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
Describes one or more Auto Scaling groups.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances()
Simplified method form for invoking the DescribeAutoScalingInstances
operation.
|
DescribeAutoScalingInstancesResult |
describeAutoScalingInstances(DescribeAutoScalingInstancesRequest describeAutoScalingInstancesRequest)
Describes one or more Auto Scaling instances.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes()
Simplified method form for invoking the
DescribeAutoScalingNotificationTypes operation.
|
DescribeAutoScalingNotificationTypesResult |
describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Auto Scaling.
|
DescribeLaunchConfigurationsResult |
describeLaunchConfigurations()
Simplified method form for invoking the DescribeLaunchConfigurations
operation.
|
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()
Simplified method form for invoking the DescribeLifecycleHookTypes
operation.
|
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()
Simplified method form for invoking the DescribeMetricCollectionTypes
operation.
|
DescribeMetricCollectionTypesResult |
describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest describeMetricCollectionTypesRequest)
Describes the available CloudWatch metrics for Auto Scaling.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations()
Simplified method form for invoking the
DescribeNotificationConfigurations operation.
|
DescribeNotificationConfigurationsResult |
describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto
Scaling group.
|
DescribePoliciesResult |
describePolicies()
Simplified method form for invoking the DescribePolicies operation.
|
DescribePoliciesResult |
describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
|
DescribeScalingActivitiesResult |
describeScalingActivities()
Simplified method form for invoking the DescribeScalingActivities
operation.
|
DescribeScalingActivitiesResult |
describeScalingActivities(DescribeScalingActivitiesRequest describeScalingActivitiesRequest)
Describes one or more scaling activities for the specified Auto Scaling
group.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes()
Simplified method form for invoking the DescribeScalingProcessTypes
operation.
|
DescribeScalingProcessTypesResult |
describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses
and SuspendProcesses.
|
DescribeScheduledActionsResult |
describeScheduledActions()
Simplified method form for invoking the DescribeScheduledActions
operation.
|
DescribeScheduledActionsResult |
describeScheduledActions(DescribeScheduledActionsRequest describeScheduledActionsRequest)
Describes the actions scheduled for your Auto Scaling group that haven't
run.
|
DescribeTagsResult |
describeTags()
Simplified method form for invoking the DescribeTags operation.
|
DescribeTagsResult |
describeTags(DescribeTagsRequest describeTagsRequest)
Describes the specified tags.
|
DescribeTerminationPolicyTypesResult |
describeTerminationPolicyTypes()
Simplified method form for invoking the DescribeTerminationPolicyTypes
operation.
|
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()
Simplified method form for invoking the DetachLoadBalancers operation.
|
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.
|
SetInstanceProtectionResult |
setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
|
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, configureRegion, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerRegionOverride, getTimeOffset, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsetEndpoint, setRegion, shutdownpublic AmazonAutoScalingClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChainpublic 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 Auto Scaling (ex: proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChainpublic 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 Auto Scaling (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 Auto Scaling (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 Auto Scaling (ex: proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic void attachInstances(AttachInstancesRequest attachInstancesRequest)
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.
For more information, see Attach EC2 Instances to Your Auto Scaling Group in the Auto Scaling Developer Guide.
attachInstances in interface AmazonAutoScalingattachInstancesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingattachLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public AttachLoadBalancersResult attachLoadBalancers()
AmazonAutoScalingattachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.attachLoadBalancers(AttachLoadBalancersRequest)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 AmazonAutoScalingcompleteLifecycleActionRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingcreateAutoScalingGroupRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration
with this name.LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingcreateLaunchConfigurationRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration
with this name.LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingcreateOrUpdateTagsRequest - LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.AlreadyExistsException - You already have an Auto Scaling group or launch configuration
with this name.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void deleteAutoScalingGroup(DeleteAutoScalingGroupRequest deleteAutoScalingGroupRequest)
Deletes the specified Auto Scaling group.
If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.
If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.
To remove instances from the Auto Scaling group before deleting it, call DetachInstances with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call UpdateAutoScalingGroup and set the minimum size and desired capacity of the Auto Scaling group to zero.
deleteAutoScalingGroup in interface AmazonAutoScalingdeleteAutoScalingGroupRequest - ScalingActivityInProgressException - The Auto Scaling group can't be deleted because there are scaling
activities in progress.ResourceInUseException - The Auto Scaling group or launch configuration can't be deleted
because it is in use.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingdeleteLaunchConfigurationRequest - ResourceInUseException - The Auto Scaling group or launch configuration can't be deleted
because it is in use.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingdeleteLifecycleHookRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void deleteNotificationConfiguration(DeleteNotificationConfigurationRequest deleteNotificationConfigurationRequest)
Deletes the specified notification.
deleteNotificationConfiguration in interface AmazonAutoScalingdeleteNotificationConfigurationRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void deletePolicy(DeletePolicyRequest deletePolicyRequest)
Deletes the specified Auto Scaling policy.
Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
deletePolicy in interface AmazonAutoScalingdeletePolicyRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void deleteScheduledAction(DeleteScheduledActionRequest deleteScheduledActionRequest)
Deletes the specified scheduled action.
deleteScheduledAction in interface AmazonAutoScalingdeleteScheduledActionRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void deleteTags(DeleteTagsRequest deleteTagsRequest)
Deletes the specified tags.
deleteTags in interface AmazonAutoScalingdeleteTagsRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public 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 AmazonAutoScalingdescribeAccountLimitsRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeAccountLimitsResult describeAccountLimits()
AmazonAutoScalingdescribeAccountLimits in interface AmazonAutoScalingAmazonAutoScaling.describeAccountLimits(DescribeAccountLimitsRequest)public DescribeAdjustmentTypesResult describeAdjustmentTypes(DescribeAdjustmentTypesRequest describeAdjustmentTypesRequest)
Describes the policy adjustment types for use with PutScalingPolicy.
describeAdjustmentTypes in interface AmazonAutoScalingdescribeAdjustmentTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeAdjustmentTypesResult describeAdjustmentTypes()
AmazonAutoScalingdescribeAdjustmentTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAdjustmentTypes(DescribeAdjustmentTypesRequest)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 AmazonAutoScalingdescribeAutoScalingGroupsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeAutoScalingGroupsResult describeAutoScalingGroups()
AmazonAutoScalingdescribeAutoScalingGroups in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingGroups(DescribeAutoScalingGroupsRequest)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 AmazonAutoScalingdescribeAutoScalingInstancesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeAutoScalingInstancesResult describeAutoScalingInstances()
AmazonAutoScalingdescribeAutoScalingInstances in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingInstances(DescribeAutoScalingInstancesRequest)public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest describeAutoScalingNotificationTypesRequest)
Describes the notification types that are supported by Auto Scaling.
describeAutoScalingNotificationTypes in interface AmazonAutoScalingdescribeAutoScalingNotificationTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeAutoScalingNotificationTypesResult describeAutoScalingNotificationTypes()
AmazonAutoScalingdescribeAutoScalingNotificationTypes in interface AmazonAutoScalingAmazonAutoScaling.describeAutoScalingNotificationTypes(DescribeAutoScalingNotificationTypesRequest)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 AmazonAutoScalingdescribeLaunchConfigurationsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeLaunchConfigurationsResult describeLaunchConfigurations()
AmazonAutoScalingdescribeLaunchConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeLaunchConfigurations(DescribeLaunchConfigurationsRequest)public DescribeLifecycleHookTypesResult describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest describeLifecycleHookTypesRequest)
Describes the available types of lifecycle hooks.
describeLifecycleHookTypes in interface AmazonAutoScalingdescribeLifecycleHookTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeLifecycleHookTypesResult describeLifecycleHookTypes()
AmazonAutoScalingdescribeLifecycleHookTypes in interface AmazonAutoScalingAmazonAutoScaling.describeLifecycleHookTypes(DescribeLifecycleHookTypesRequest)public DescribeLifecycleHooksResult describeLifecycleHooks(DescribeLifecycleHooksRequest describeLifecycleHooksRequest)
Describes the lifecycle hooks for the specified Auto Scaling group.
describeLifecycleHooks in interface AmazonAutoScalingdescribeLifecycleHooksRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeLoadBalancersResult describeLoadBalancers(DescribeLoadBalancersRequest describeLoadBalancersRequest)
Describes the load balancers for the specified Auto Scaling group.
describeLoadBalancers in interface AmazonAutoScalingdescribeLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingdescribeMetricCollectionTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeMetricCollectionTypesResult describeMetricCollectionTypes()
AmazonAutoScalingdescribeMetricCollectionTypes in interface AmazonAutoScalingAmazonAutoScaling.describeMetricCollectionTypes(DescribeMetricCollectionTypesRequest)public DescribeNotificationConfigurationsResult describeNotificationConfigurations(DescribeNotificationConfigurationsRequest describeNotificationConfigurationsRequest)
Describes the notification actions associated with the specified Auto Scaling group.
describeNotificationConfigurations in interface AmazonAutoScalingdescribeNotificationConfigurationsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeNotificationConfigurationsResult describeNotificationConfigurations()
AmazonAutoScalingdescribeNotificationConfigurations in interface AmazonAutoScalingAmazonAutoScaling.describeNotificationConfigurations(DescribeNotificationConfigurationsRequest)public DescribePoliciesResult describePolicies(DescribePoliciesRequest describePoliciesRequest)
Describes the policies for the specified Auto Scaling group.
describePolicies in interface AmazonAutoScalingdescribePoliciesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribePoliciesResult describePolicies()
AmazonAutoScalingdescribePolicies in interface AmazonAutoScalingAmazonAutoScaling.describePolicies(DescribePoliciesRequest)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 AmazonAutoScalingdescribeScalingActivitiesRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeScalingActivitiesResult describeScalingActivities()
AmazonAutoScalingdescribeScalingActivities in interface AmazonAutoScalingAmazonAutoScaling.describeScalingActivities(DescribeScalingActivitiesRequest)public DescribeScalingProcessTypesResult describeScalingProcessTypes(DescribeScalingProcessTypesRequest describeScalingProcessTypesRequest)
Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.
describeScalingProcessTypes in interface AmazonAutoScalingdescribeScalingProcessTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeScalingProcessTypesResult describeScalingProcessTypes()
AmazonAutoScalingdescribeScalingProcessTypes in interface AmazonAutoScalingAmazonAutoScaling.describeScalingProcessTypes(DescribeScalingProcessTypesRequest)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 AmazonAutoScalingdescribeScheduledActionsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeScheduledActionsResult describeScheduledActions()
AmazonAutoScalingdescribeScheduledActions in interface AmazonAutoScalingAmazonAutoScaling.describeScheduledActions(DescribeScheduledActionsRequest)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 AmazonAutoScalingdescribeTagsRequest - InvalidNextTokenException - The NextToken value is not valid.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeTagsResult describeTags()
AmazonAutoScalingdescribeTags in interface AmazonAutoScalingAmazonAutoScaling.describeTags(DescribeTagsRequest)public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest describeTerminationPolicyTypesRequest)
Describes the termination policies supported by Auto Scaling.
describeTerminationPolicyTypes in interface AmazonAutoScalingdescribeTerminationPolicyTypesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DescribeTerminationPolicyTypesResult describeTerminationPolicyTypes()
AmazonAutoScalingdescribeTerminationPolicyTypes in interface AmazonAutoScalingAmazonAutoScaling.describeTerminationPolicyTypes(DescribeTerminationPolicyTypesRequest)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.
If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.
For more information, see Detach EC2 Instances from Your Auto Scaling Group in the Auto Scaling Developer Guide.
detachInstances in interface AmazonAutoScalingdetachInstancesRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingdetachLoadBalancersRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public DetachLoadBalancersResult detachLoadBalancers()
AmazonAutoScalingdetachLoadBalancers in interface AmazonAutoScalingAmazonAutoScaling.detachLoadBalancers(DetachLoadBalancersRequest)public void disableMetricsCollection(DisableMetricsCollectionRequest disableMetricsCollectionRequest)
Disables monitoring of the specified metrics for the specified Auto Scaling group.
disableMetricsCollection in interface AmazonAutoScalingdisableMetricsCollectionRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingenableMetricsCollectionRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingenterStandbyRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public void executePolicy(ExecutePolicyRequest executePolicyRequest)
Executes the specified policy.
executePolicy in interface AmazonAutoScalingexecutePolicyRequest - ScalingActivityInProgressException - The Auto Scaling group can't be deleted because there are scaling
activities in progress.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingexitStandbyRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingputLifecycleHookRequest - LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingputNotificationConfigurationRequest - LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingputScalingPolicyRequest - LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingputScheduledUpdateGroupActionRequest - AlreadyExistsException - You already have an Auto Scaling group or launch configuration
with this name.LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingrecordLifecycleActionHeartbeatRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingresumeProcessesRequest - ResourceInUseException - The Auto Scaling group or launch configuration can't be deleted
because it is in use.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingsetDesiredCapacityRequest - ScalingActivityInProgressException - The Auto Scaling group can't be deleted because there are scaling
activities in progress.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingsetInstanceHealthRequest - ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public SetInstanceProtectionResult setInstanceProtection(SetInstanceProtectionRequest setInstanceProtectionRequest)
Updates the instance protection settings of the specified instances.
For more information, see Instance Protection in the Auto Scaling Developer Guide.
setInstanceProtection in interface AmazonAutoScalingsetInstanceProtectionRequest - LimitExceededException - You have already reached a limit for your Auto Scaling resources
(for example, groups, launch configurations, or lifecycle hooks).
For more information, see DescribeAccountLimits.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingsuspendProcessesRequest - ResourceInUseException - The Auto Scaling group or launch configuration can't be deleted
because it is in use.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).public TerminateInstanceInAutoScalingGroupResult terminateInstanceInAutoScalingGroup(TerminateInstanceInAutoScalingGroupRequest terminateInstanceInAutoScalingGroupRequest)
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately.
terminateInstanceInAutoScalingGroup in interface AmazonAutoScalingterminateInstanceInAutoScalingGroupRequest - ScalingActivityInProgressException - The Auto Scaling group can't be deleted because there are scaling
activities in progress.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingupdateAutoScalingGroupRequest - ScalingActivityInProgressException - The Auto Scaling group can't be deleted because there are scaling
activities in progress.ResourceContentionException - You already have a pending update to an Auto Scaling resource
(for example, a group, instance, or load balancer).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 AmazonAutoScalingrequest - The originally executed requestCopyright © 2013 Amazon Web Services, Inc. All Rights Reserved.