AWSAutoScaling
Objective-C
@interface AWSAutoScaling
Swift
class AWSAutoScaling
Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks. Use this service with AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing.
For more information, including information about granting IAM users required permissions for Amazon EC2 Auto Scaling actions, see the Amazon EC2 Auto Scaling User Guide.
-
The service configuration used to instantiate this service client.
Warning
Once the client is instantiated, do not modify the configuration object. It may cause unspecified behaviors.Declaration
Objective-C
@property (nonatomic, strong, readonly) AWSServiceConfiguration *configuration
Swift
var configuration: UnsafeMutablePointer<Int32> { get }
-
Returns the singleton service client. If the singleton object does not exist, the SDK instantiates the default service client with
defaultServiceConfiguration
from[AWSServiceManager defaultServiceManager]
. The reference to this object is maintained by the SDK, and you do not need to retain it manually.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USEast1, credentialsProvider: credentialProvider) AWSServiceManager.default().defaultServiceConfiguration = configuration return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:credentialsProvider]; [AWSServiceManager defaultServiceManager].defaultServiceConfiguration = configuration; return YES; }
Then call the following to get the default service client:
Swift
let AutoScaling = AWSAutoScaling.default()
Objective-C
AWSAutoScaling *AutoScaling = [AWSAutoScaling defaultAutoScaling];
Declaration
Objective-C
+ (nonnull instancetype)defaultAutoScaling;
Swift
class func `default`() -> Self
Return Value
The default service client.
-
Creates a service client with the given service configuration and registers it for the key.
For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSAutoScaling.register(with: configuration!, forKey: "USWest2AutoScaling") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSAutoScaling registerAutoScalingWithConfiguration:configuration forKey:@"USWest2AutoScaling"]; return YES; }
Then call the following to get the service client:
Swift
let AutoScaling = AWSAutoScaling(forKey: "USWest2AutoScaling")
Objective-C
AWSAutoScaling *AutoScaling = [AWSAutoScaling AutoScalingForKey:@"USWest2AutoScaling"];
Warning
After calling this method, do not modify the configuration object. It may cause unspecified behaviors.
Declaration
Objective-C
+ (void)registerAutoScalingWithConfiguration:(id)configuration forKey:(nonnull NSString *)key;
Swift
class func register(withConfiguration configuration: Any!, forKey key: String)
Parameters
configuration
A service configuration object.
key
A string to identify the service client.
-
Retrieves the service client associated with the key. You need to call
+ registerAutoScalingWithConfiguration:forKey:
before invoking this method.For example, set the default service configuration in
- application:didFinishLaunchingWithOptions:
Swift
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { let credentialProvider = AWSCognitoCredentialsProvider(regionType: .USEast1, identityPoolId: "YourIdentityPoolId") let configuration = AWSServiceConfiguration(region: .USWest2, credentialsProvider: credentialProvider) AWSAutoScaling.register(with: configuration!, forKey: "USWest2AutoScaling") return true
}
Objective-C
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { AWSCognitoCredentialsProvider *credentialsProvider = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:@"YourIdentityPoolId"]; AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSWest2 credentialsProvider:credentialsProvider]; [AWSAutoScaling registerAutoScalingWithConfiguration:configuration forKey:@"USWest2AutoScaling"]; return YES; }
Then call the following to get the service client:
Swift
let AutoScaling = AWSAutoScaling(forKey: "USWest2AutoScaling")
Objective-C
AWSAutoScaling *AutoScaling = [AWSAutoScaling AutoScalingForKey:@"USWest2AutoScaling"];
Declaration
Objective-C
+ (nonnull instancetype)AutoScalingForKey:(nonnull NSString *)key;
Swift
convenience init(forKey key: String)
Parameters
key
A string to identify the service client.
Return Value
An instance of the service client.
-
Removes the service client associated with the key and release it.
Warning
Before calling this method, make sure no method is running on this client.
Declaration
Objective-C
+ (void)removeAutoScalingForKey:(nonnull NSString *)key;
Swift
class func remove(forKey key: String)
Parameters
key
A string to identify the service client.
-
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 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.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachInstancesQuery
Declaration
Objective-C
- (id)attachInstances:(nonnull AWSAutoScalingAttachInstancesQuery *)request;
Swift
func attachInstances(_ request: AWSAutoScalingAttachInstancesQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachInstances service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Attaches one or more EC2 instances to the specified Auto Scaling group.
When you attach instances, Amazon EC2 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.
If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.
For more information, see Attach EC2 instances to your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachInstancesQuery
Declaration
Objective-C
- (void)attachInstances:(nonnull AWSAutoScalingAttachInstancesQuery *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func attachInstances(_ request: AWSAutoScalingAttachInstancesQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AttachInstances service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachLoadBalancerTargetGroupsType
See
AWSAutoScalingAttachLoadBalancerTargetGroupsResultType
Declaration
Objective-C
- (id)attachLoadBalancerTargetGroups: (nonnull AWSAutoScalingAttachLoadBalancerTargetGroupsType *)request;
Swift
func attachLoadBalancerTargetGroups(_ request: AWSAutoScalingAttachLoadBalancerTargetGroupsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachLoadBalancerTargetGroups service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingAttachLoadBalancerTargetGroupsResultType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Attaches one or more target groups to the specified Auto Scaling group.
This operation is used with the following load balancer types:
Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
Gateway Load Balancer - Operates at the network layer (layer 3).
To describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachLoadBalancerTargetGroupsType
See
AWSAutoScalingAttachLoadBalancerTargetGroupsResultType
Declaration
Objective-C
- (void) attachLoadBalancerTargetGroups: (nonnull AWSAutoScalingAttachLoadBalancerTargetGroupsType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingAttachLoadBalancerTargetGroupsResultType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachLoadBalancerTargetGroups(_ request: AWSAutoScalingAttachLoadBalancerTargetGroupsType, completionHandler: ((AWSAutoScalingAttachLoadBalancerTargetGroupsResultType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AttachLoadBalancerTargetGroups service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachLoadBalancersType
See
AWSAutoScalingAttachLoadBalancersResultType
Declaration
Objective-C
- (id)attachLoadBalancers: (nonnull AWSAutoScalingAttachLoadBalancersType *)request;
Swift
func attachLoadBalancers(_ request: AWSAutoScalingAttachLoadBalancersType) -> Any!
Parameters
request
A container for the necessary parameters to execute the AttachLoadBalancers service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingAttachLoadBalancersResultType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.
To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling group, call the DetachLoadBalancers API.
For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingAttachLoadBalancersType
See
AWSAutoScalingAttachLoadBalancersResultType
Declaration
Objective-C
- (void)attachLoadBalancers: (nonnull AWSAutoScalingAttachLoadBalancersType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingAttachLoadBalancersResultType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func attachLoadBalancers(_ request: AWSAutoScalingAttachLoadBalancersType, completionHandler: ((AWSAutoScalingAttachLoadBalancersResultType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the AttachLoadBalancers service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Deletes one or more scheduled actions for the specified Auto Scaling group.
See
AWSAutoScalingBatchDeleteScheduledActionType
See
AWSAutoScalingBatchDeleteScheduledActionAnswer
Declaration
Objective-C
- (id)batchDeleteScheduledAction: (nonnull AWSAutoScalingBatchDeleteScheduledActionType *)request;
Swift
func batchDeleteScheduledAction(_ request: AWSAutoScalingBatchDeleteScheduledActionType) -> Any!
Parameters
request
A container for the necessary parameters to execute the BatchDeleteScheduledAction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingBatchDeleteScheduledActionAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes one or more scheduled actions for the specified Auto Scaling group.
See
AWSAutoScalingBatchDeleteScheduledActionType
See
AWSAutoScalingBatchDeleteScheduledActionAnswer
Declaration
Objective-C
- (void) batchDeleteScheduledAction: (nonnull AWSAutoScalingBatchDeleteScheduledActionType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingBatchDeleteScheduledActionAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func batchDeleteScheduledAction(_ request: AWSAutoScalingBatchDeleteScheduledActionType, completionHandler: ((AWSAutoScalingBatchDeleteScheduledActionAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the BatchDeleteScheduledAction service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
See
AWSAutoScalingBatchPutScheduledUpdateGroupActionType
See
AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer
Declaration
Objective-C
- (id)batchPutScheduledUpdateGroupAction: (nonnull AWSAutoScalingBatchPutScheduledUpdateGroupActionType *)request;
Swift
func batchPutScheduledUpdateGroupAction(_ request: AWSAutoScalingBatchPutScheduledUpdateGroupActionType) -> Any!
Parameters
request
A container for the necessary parameters to execute the BatchPutScheduledUpdateGroupAction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
See
AWSAutoScalingBatchPutScheduledUpdateGroupActionType
See
AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer
Declaration
Objective-C
- (void) batchPutScheduledUpdateGroupAction: (nonnull AWSAutoScalingBatchPutScheduledUpdateGroupActionType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func batchPutScheduledUpdateGroupAction(_ request: AWSAutoScalingBatchPutScheduledUpdateGroupActionType, completionHandler: ((AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the BatchPutScheduledUpdateGroupAction service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingCancelInstanceRefreshType
See
AWSAutoScalingCancelInstanceRefreshAnswer
Declaration
Objective-C
- (id)cancelInstanceRefresh: (nonnull AWSAutoScalingCancelInstanceRefreshType *)request;
Swift
func cancelInstanceRefresh(_ request: AWSAutoScalingCancelInstanceRefreshType) -> Any!
Parameters
request
A container for the necessary parameters to execute the CancelInstanceRefresh service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingCancelInstanceRefreshAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorActiveInstanceRefreshNotFound
. -
Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingCancelInstanceRefreshType
See
AWSAutoScalingCancelInstanceRefreshAnswer
Declaration
Objective-C
- (void)cancelInstanceRefresh: (nonnull AWSAutoScalingCancelInstanceRefreshType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingCancelInstanceRefreshAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func cancelInstanceRefresh(_ request: AWSAutoScalingCancelInstanceRefreshType, completionHandler: ((AWSAutoScalingCancelInstanceRefreshAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CancelInstanceRefresh service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorActiveInstanceRefreshNotFound
. -
Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCompleteLifecycleActionType
See
AWSAutoScalingCompleteLifecycleActionAnswer
Declaration
Objective-C
- (id)completeLifecycleAction: (nonnull AWSAutoScalingCompleteLifecycleActionType *)request;
Swift
func completeLifecycleAction(_ request: AWSAutoScalingCompleteLifecycleActionType) -> Any!
Parameters
request
A container for the necessary parameters to execute the CompleteLifecycleAction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingCompleteLifecycleActionAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCompleteLifecycleActionType
See
AWSAutoScalingCompleteLifecycleActionAnswer
Declaration
Objective-C
- (void)completeLifecycleAction: (nonnull AWSAutoScalingCompleteLifecycleActionType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingCompleteLifecycleActionAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func completeLifecycleAction(_ request: AWSAutoScalingCompleteLifecycleActionType, completionHandler: ((AWSAutoScalingCompleteLifecycleActionAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CompleteLifecycleAction service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size parameters (
DesiredCapacity
,MaxSize
, andMinSize
). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.See
AWSAutoScalingCreateAutoScalingGroupType
Declaration
Objective-C
- (id)createAutoScalingGroup: (nonnull AWSAutoScalingCreateAutoScalingGroupType *)request;
Swift
func createAutoScalingGroup(_ request: AWSAutoScalingCreateAutoScalingGroupType) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateAutoScalingGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size parameters (
DesiredCapacity
,MaxSize
, andMinSize
). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.See
AWSAutoScalingCreateAutoScalingGroupType
Declaration
Objective-C
- (void)createAutoScalingGroup: (nonnull AWSAutoScalingCreateAutoScalingGroupType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createAutoScalingGroup(_ request: AWSAutoScalingCreateAutoScalingGroupType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateAutoScalingGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCreateLaunchConfigurationType
Declaration
Objective-C
- (id)createLaunchConfiguration: (nonnull AWSAutoScalingCreateLaunchConfigurationType *)request;
Swift
func createLaunchConfiguration(_ request: AWSAutoScalingCreateLaunchConfigurationType) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateLaunchConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCreateLaunchConfigurationType
Declaration
Objective-C
- (void)createLaunchConfiguration: (nonnull AWSAutoScalingCreateLaunchConfigurationType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createLaunchConfiguration(_ request: AWSAutoScalingCreateLaunchConfigurationType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateLaunchConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Creates or updates tags for the specified Auto Scaling group.
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 Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCreateOrUpdateTagsType
Declaration
Objective-C
- (id)createOrUpdateTags: (nonnull AWSAutoScalingCreateOrUpdateTagsType *)request;
Swift
func createOrUpdateTags(_ request: AWSAutoScalingCreateOrUpdateTagsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the CreateOrUpdateTags service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorResourceInUse
. -
Creates or updates tags for the specified Auto Scaling group.
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 Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingCreateOrUpdateTagsType
Declaration
Objective-C
- (void) createOrUpdateTags:(nonnull AWSAutoScalingCreateOrUpdateTagsType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func createOrUpdateTags(_ request: AWSAutoScalingCreateOrUpdateTagsType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the CreateOrUpdateTags service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorResourceInUse
. -
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 the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
See
AWSAutoScalingDeleteAutoScalingGroupType
Declaration
Objective-C
- (id)deleteAutoScalingGroup: (nonnull AWSAutoScalingDeleteAutoScalingGroupType *)request;
Swift
func delete(_ request: AWSAutoScalingDeleteAutoScalingGroupType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteAutoScalingGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
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 the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.
To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.
See
AWSAutoScalingDeleteAutoScalingGroupType
Declaration
Objective-C
- (void)deleteAutoScalingGroup: (nonnull AWSAutoScalingDeleteAutoScalingGroupType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func delete(_ request: AWSAutoScalingDeleteAutoScalingGroupType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteAutoScalingGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
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.
See
AWSAutoScalingLaunchConfigurationNameType
Declaration
Objective-C
- (id)deleteLaunchConfiguration: (nonnull AWSAutoScalingLaunchConfigurationNameType *)request;
Swift
func deleteLaunchConfiguration(_ request: AWSAutoScalingLaunchConfigurationNameType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteLaunchConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
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.
See
AWSAutoScalingLaunchConfigurationNameType
Declaration
Objective-C
- (void)deleteLaunchConfiguration: (nonnull AWSAutoScalingLaunchConfigurationNameType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteLaunchConfiguration(_ request: AWSAutoScalingLaunchConfigurationNameType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteLaunchConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDON
for launching instances,CONTINUE
for terminating instances).See
AWSAutoScalingDeleteLifecycleHookType
See
AWSAutoScalingDeleteLifecycleHookAnswer
Declaration
Objective-C
- (id)deleteLifecycleHook: (nonnull AWSAutoScalingDeleteLifecycleHookType *)request;
Swift
func deleteLifecycleHook(_ request: AWSAutoScalingDeleteLifecycleHookType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteLifecycleHook service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDeleteLifecycleHookAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified lifecycle hook.
If there are any outstanding lifecycle actions, they are completed first (
ABANDON
for launching instances,CONTINUE
for terminating instances).See
AWSAutoScalingDeleteLifecycleHookType
See
AWSAutoScalingDeleteLifecycleHookAnswer
Declaration
Objective-C
- (void) deleteLifecycleHook:(nonnull AWSAutoScalingDeleteLifecycleHookType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingDeleteLifecycleHookAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func deleteLifecycleHook(_ request: AWSAutoScalingDeleteLifecycleHookType, completionHandler: ((AWSAutoScalingDeleteLifecycleHookAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteLifecycleHook service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified notification.
See
AWSAutoScalingDeleteNotificationConfigurationType
Declaration
Objective-C
- (id)deleteNotificationConfiguration: (nonnull AWSAutoScalingDeleteNotificationConfigurationType *)request;
Swift
func deleteNotificationConfiguration(_ request: AWSAutoScalingDeleteNotificationConfigurationType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteNotificationConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified notification.
See
AWSAutoScalingDeleteNotificationConfigurationType
Declaration
Objective-C
- (void)deleteNotificationConfiguration: (nonnull AWSAutoScalingDeleteNotificationConfigurationType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func deleteNotificationConfiguration(_ request: AWSAutoScalingDeleteNotificationConfigurationType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteNotificationConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDeletePolicyType
Declaration
Objective-C
- (id)deletePolicy:(nonnull AWSAutoScalingDeletePolicyType *)request;
Swift
func deletePolicy(_ request: AWSAutoScalingDeletePolicyType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeletePolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Deletes the specified scaling policy.
Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.
For more information, see Deleting a scaling policy in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDeletePolicyType
Declaration
Objective-C
- (void)deletePolicy:(nonnull AWSAutoScalingDeletePolicyType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deletePolicy(_ request: AWSAutoScalingDeletePolicyType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeletePolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Deletes the specified scheduled action.
See
AWSAutoScalingDeleteScheduledActionType
Declaration
Objective-C
- (id)deleteScheduledAction: (nonnull AWSAutoScalingDeleteScheduledActionType *)request;
Swift
func deleteScheduledAction(_ request: AWSAutoScalingDeleteScheduledActionType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteScheduledAction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified scheduled action.
See
AWSAutoScalingDeleteScheduledActionType
Declaration
Objective-C
- (void)deleteScheduledAction: (nonnull AWSAutoScalingDeleteScheduledActionType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteScheduledAction(_ request: AWSAutoScalingDeleteScheduledActionType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteScheduledAction service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Deletes the specified tags.
See
AWSAutoScalingDeleteTagsType
Declaration
Objective-C
- (id)deleteTags:(nonnull AWSAutoScalingDeleteTagsType *)request;
Swift
func deleteTags(_ request: AWSAutoScalingDeleteTagsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DeleteTags service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorResourceInUse
. -
Deletes the specified tags.
See
AWSAutoScalingDeleteTagsType
Declaration
Objective-C
- (void)deleteTags:(nonnull AWSAutoScalingDeleteTagsType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func deleteTags(_ request: AWSAutoScalingDeleteTagsType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DeleteTags service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorResourceInUse
. -
Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
For information about requesting an increase, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
See
AWSRequest
See
AWSAutoScalingDescribeAccountLimitsAnswer
Declaration
Objective-C
- (id)describeAccountLimits:(id)request;
Swift
func describeAccountLimits(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAccountLimits service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeAccountLimitsAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
For information about requesting an increase, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.
See
AWSRequest
See
AWSAutoScalingDescribeAccountLimitsAnswer
Declaration
Objective-C
- (void)describeAccountLimits:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeAccountLimitsAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeAccountLimits(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeAccountLimitsAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeAccountLimits service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the available adjustment types for Amazon EC2 Auto Scaling scaling policies. These settings apply to step scaling policies and simple scaling policies; they do not apply to target tracking scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
See
AWSRequest
See
AWSAutoScalingDescribeAdjustmentTypesAnswer
Declaration
Objective-C
- (id)describeAdjustmentTypes:(id)request;
Swift
func describeAdjustmentTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAdjustmentTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeAdjustmentTypesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the available adjustment types for Amazon EC2 Auto Scaling scaling policies. These settings apply to step scaling policies and simple scaling policies; they do not apply to target tracking scaling policies.
The following adjustment types are supported:
ChangeInCapacity
ExactCapacity
PercentChangeInCapacity
See
AWSRequest
See
AWSAutoScalingDescribeAdjustmentTypesAnswer
Declaration
Objective-C
- (void)describeAdjustmentTypes:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeAdjustmentTypesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeAdjustmentTypes(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeAdjustmentTypesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeAdjustmentTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes one or more Auto Scaling groups.
See
AWSAutoScalingAutoScalingGroupNamesType
See
AWSAutoScalingAutoScalingGroupsType
Declaration
Objective-C
- (id)describeAutoScalingGroups: (nonnull AWSAutoScalingAutoScalingGroupNamesType *)request;
Swift
func describeGroups(_ request: AWSAutoScalingAutoScalingGroupNamesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingGroups service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingAutoScalingGroupsType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more Auto Scaling groups.
See
AWSAutoScalingAutoScalingGroupNamesType
See
AWSAutoScalingAutoScalingGroupsType
Declaration
Objective-C
- (void)describeAutoScalingGroups: (nonnull AWSAutoScalingAutoScalingGroupNamesType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingAutoScalingGroupsType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeGroups(_ request: AWSAutoScalingAutoScalingGroupNamesType, completionHandler: ((AWSAutoScalingAutoScalingGroupsType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingGroups service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more Auto Scaling instances.
See
AWSAutoScalingDescribeAutoScalingInstancesType
See
AWSAutoScalingAutoScalingInstancesType
Declaration
Objective-C
- (id)describeAutoScalingInstances: (nonnull AWSAutoScalingDescribeAutoScalingInstancesType *)request;
Swift
func describe(_ request: AWSAutoScalingDescribeAutoScalingInstancesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingInstances service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingAutoScalingInstancesType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more Auto Scaling instances.
See
AWSAutoScalingDescribeAutoScalingInstancesType
See
AWSAutoScalingAutoScalingInstancesType
Declaration
Objective-C
- (void)describeAutoScalingInstances: (nonnull AWSAutoScalingDescribeAutoScalingInstancesType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingAutoScalingInstancesType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describe(_ request: AWSAutoScalingDescribeAutoScalingInstancesType, completionHandler: ((AWSAutoScalingAutoScalingInstancesType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingInstances service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
See
AWSRequest
See
AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer
Declaration
Objective-C
- (id)describeAutoScalingNotificationTypes:(id)request;
Swift
func describeNotificationTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeAutoScalingNotificationTypesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
See
AWSRequest
See
AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer
Declaration
Objective-C
- (void) describeAutoScalingNotificationTypes:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeNotificationTypes(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeAutoScalingNotificationTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes one or more instance refreshes.
You can determine the status of a request by looking at the
Status
parameter. The following are the possible statuses:Pending
- The request was created, but the operation has not started.InProgress
- The operation is in progress.Successful
- The operation completed successfully.Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.Cancelled
- The operation is cancelled.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingDescribeInstanceRefreshesType
See
AWSAutoScalingDescribeInstanceRefreshesAnswer
Declaration
Objective-C
- (id)describeInstanceRefreshes: (nonnull AWSAutoScalingDescribeInstanceRefreshesType *)request;
Swift
func describeInstanceRefreshes(_ request: AWSAutoScalingDescribeInstanceRefreshesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceRefreshes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeInstanceRefreshesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more instance refreshes.
You can determine the status of a request by looking at the
Status
parameter. The following are the possible statuses:Pending
- The request was created, but the operation has not started.InProgress
- The operation is in progress.Successful
- The operation completed successfully.Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.Cancelled
- The operation is cancelled.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingDescribeInstanceRefreshesType
See
AWSAutoScalingDescribeInstanceRefreshesAnswer
Declaration
Objective-C
- (void) describeInstanceRefreshes: (nonnull AWSAutoScalingDescribeInstanceRefreshesType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeInstanceRefreshesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeInstanceRefreshes(_ request: AWSAutoScalingDescribeInstanceRefreshesType, completionHandler: ((AWSAutoScalingDescribeInstanceRefreshesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeInstanceRefreshes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more launch configurations.
See
AWSAutoScalingLaunchConfigurationNamesType
See
AWSAutoScalingLaunchConfigurationsType
Declaration
Objective-C
- (id)describeLaunchConfigurations: (nonnull AWSAutoScalingLaunchConfigurationNamesType *)request;
Swift
func describeLaunchConfigurations(_ request: AWSAutoScalingLaunchConfigurationNamesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLaunchConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingLaunchConfigurationsType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more launch configurations.
See
AWSAutoScalingLaunchConfigurationNamesType
See
AWSAutoScalingLaunchConfigurationsType
Declaration
Objective-C
- (void)describeLaunchConfigurations: (nonnull AWSAutoScalingLaunchConfigurationNamesType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingLaunchConfigurationsType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLaunchConfigurations(_ request: AWSAutoScalingLaunchConfigurationNamesType, completionHandler: ((AWSAutoScalingLaunchConfigurationsType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeLaunchConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
See
AWSRequest
See
AWSAutoScalingDescribeLifecycleHookTypesAnswer
Declaration
Objective-C
- (id)describeLifecycleHookTypes:(id)request;
Swift
func describeLifecycleHookTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeLifecycleHookTypesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
See
AWSRequest
See
AWSAutoScalingDescribeLifecycleHookTypesAnswer
Declaration
Objective-C
- (void) describeLifecycleHookTypes:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeLifecycleHookTypesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLifecycleHookTypes(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeLifecycleHookTypesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeLifecycleHookTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the lifecycle hooks for the specified Auto Scaling group.
See
AWSAutoScalingDescribeLifecycleHooksType
See
AWSAutoScalingDescribeLifecycleHooksAnswer
Declaration
Objective-C
- (id)describeLifecycleHooks: (nonnull AWSAutoScalingDescribeLifecycleHooksType *)request;
Swift
func describeLifecycleHooks(_ request: AWSAutoScalingDescribeLifecycleHooksType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLifecycleHooks service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeLifecycleHooksAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the lifecycle hooks for the specified Auto Scaling group.
See
AWSAutoScalingDescribeLifecycleHooksType
See
AWSAutoScalingDescribeLifecycleHooksAnswer
Declaration
Objective-C
- (void)describeLifecycleHooks: (nonnull AWSAutoScalingDescribeLifecycleHooksType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeLifecycleHooksAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLifecycleHooks(_ request: AWSAutoScalingDescribeLifecycleHooksType, completionHandler: ((AWSAutoScalingDescribeLifecycleHooksAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeLifecycleHooks service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the target groups for the specified Auto Scaling group.
See
AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest
See
AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse
Declaration
Objective-C
- (id)describeLoadBalancerTargetGroups: (nonnull AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest *)request;
Swift
func describeLoadBalancerTargetGroups(_ request: AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLoadBalancerTargetGroups service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeLoadBalancerTargetGroupsResponse
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the target groups for the specified Auto Scaling group.
See
AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest
See
AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse
Declaration
Objective-C
- (void) describeLoadBalancerTargetGroups: (nonnull AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLoadBalancerTargetGroups(_ request: AWSAutoScalingDescribeLoadBalancerTargetGroupsRequest, completionHandler: ((AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeLoadBalancerTargetGroups service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
See
AWSAutoScalingDescribeLoadBalancersRequest
See
AWSAutoScalingDescribeLoadBalancersResponse
Declaration
Objective-C
- (id)describeLoadBalancers: (nonnull AWSAutoScalingDescribeLoadBalancersRequest *)request;
Swift
func describeLoadBalancers(_ request: AWSAutoScalingDescribeLoadBalancersRequest) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeLoadBalancers service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeLoadBalancersResponse
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the load balancers for the specified Auto Scaling group.
This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.
See
AWSAutoScalingDescribeLoadBalancersRequest
See
AWSAutoScalingDescribeLoadBalancersResponse
Declaration
Objective-C
- (void)describeLoadBalancers: (nonnull AWSAutoScalingDescribeLoadBalancersRequest *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeLoadBalancersResponse *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeLoadBalancers(_ request: AWSAutoScalingDescribeLoadBalancersRequest, completionHandler: ((AWSAutoScalingDescribeLoadBalancersResponse?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeLoadBalancers service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
The
GroupStandbyInstances
metric is not returned by default. You must explicitly request this metric when calling the EnableMetricsCollection API.See
AWSRequest
See
AWSAutoScalingDescribeMetricCollectionTypesAnswer
Declaration
Objective-C
- (id)describeMetricCollectionTypes:(id)request;
Swift
func describeMetricCollectionTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeMetricCollectionTypesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
The
GroupStandbyInstances
metric is not returned by default. You must explicitly request this metric when calling the EnableMetricsCollection API.See
AWSRequest
See
AWSAutoScalingDescribeMetricCollectionTypesAnswer
Declaration
Objective-C
- (void)describeMetricCollectionTypes:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeMetricCollectionTypesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeMetricCollectionTypes(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeMetricCollectionTypesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the notification actions associated with the specified Auto Scaling group.
See
AWSAutoScalingDescribeNotificationConfigurationsType
See
AWSAutoScalingDescribeNotificationConfigurationsAnswer
Declaration
Objective-C
- (id)describeNotificationConfigurations: (nonnull AWSAutoScalingDescribeNotificationConfigurationsType *)request;
Swift
func describeNotificationConfigurations(_ request: AWSAutoScalingDescribeNotificationConfigurationsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeNotificationConfigurations service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeNotificationConfigurationsAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the notification actions associated with the specified Auto Scaling group.
See
AWSAutoScalingDescribeNotificationConfigurationsType
See
AWSAutoScalingDescribeNotificationConfigurationsAnswer
Declaration
Objective-C
- (void) describeNotificationConfigurations: (nonnull AWSAutoScalingDescribeNotificationConfigurationsType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeNotificationConfigurationsAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeNotificationConfigurations(_ request: AWSAutoScalingDescribeNotificationConfigurationsType, completionHandler: ((AWSAutoScalingDescribeNotificationConfigurationsAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeNotificationConfigurations service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the policies for the specified Auto Scaling group.
See
AWSAutoScalingDescribePoliciesType
See
AWSAutoScalingPoliciesType
Declaration
Objective-C
- (id)describePolicies:(nonnull AWSAutoScalingDescribePoliciesType *)request;
Swift
func describePolicies(_ request: AWSAutoScalingDescribePoliciesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribePolicies service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingPoliciesType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Describes the policies for the specified Auto Scaling group.
See
AWSAutoScalingDescribePoliciesType
See
AWSAutoScalingPoliciesType
Declaration
Objective-C
- (void)describePolicies:(nonnull AWSAutoScalingDescribePoliciesType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingPoliciesType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describePolicies(_ request: AWSAutoScalingDescribePoliciesType, completionHandler: ((AWSAutoScalingPoliciesType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribePolicies service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Describes one or more scaling activities for the specified Auto Scaling group.
See
AWSAutoScalingDescribeScalingActivitiesType
See
AWSAutoScalingActivitiesType
Declaration
Objective-C
- (id)describeScalingActivities: (nonnull AWSAutoScalingDescribeScalingActivitiesType *)request;
Swift
func describe(_ request: AWSAutoScalingDescribeScalingActivitiesType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeScalingActivities service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingActivitiesType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes one or more scaling activities for the specified Auto Scaling group.
See
AWSAutoScalingDescribeScalingActivitiesType
See
AWSAutoScalingActivitiesType
Declaration
Objective-C
- (void)describeScalingActivities: (nonnull AWSAutoScalingDescribeScalingActivitiesType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingActivitiesType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describe(_ request: AWSAutoScalingDescribeScalingActivitiesType, completionHandler: ((AWSAutoScalingActivitiesType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeScalingActivities service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
See
AWSRequest
See
AWSAutoScalingProcessesType
Declaration
Objective-C
- (id)describeScalingProcessTypes:(id)request;
Swift
func describeProcessTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeScalingProcessTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingProcessesType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
See
AWSRequest
See
AWSAutoScalingProcessesType
Declaration
Objective-C
- (void)describeScalingProcessTypes:(id)request completionHandler: (void (^_Nullable)(AWSAutoScalingProcessesType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeProcessTypes(_ request: Any!, completionHandler: ((AWSAutoScalingProcessesType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeScalingProcessTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the actions scheduled for your Auto Scaling group that haven’t run or that have not reached their end time. To describe the actions that have already run, call the DescribeScalingActivities API.
See
AWSAutoScalingDescribeScheduledActionsType
See
AWSAutoScalingScheduledActionsType
Declaration
Objective-C
- (id)describeScheduledActions: (nonnull AWSAutoScalingDescribeScheduledActionsType *)request;
Swift
func describeScheduledActions(_ request: AWSAutoScalingDescribeScheduledActionsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeScheduledActions service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingScheduledActionsType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the actions scheduled for your Auto Scaling group that haven’t run or that have not reached their end time. To describe the actions that have already run, call the DescribeScalingActivities API.
See
AWSAutoScalingDescribeScheduledActionsType
See
AWSAutoScalingScheduledActionsType
Declaration
Objective-C
- (void) describeScheduledActions: (nonnull AWSAutoScalingDescribeScheduledActionsType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingScheduledActionsType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeScheduledActions(_ request: AWSAutoScalingDescribeScheduledActionsType, completionHandler: ((AWSAutoScalingScheduledActionsType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeScheduledActions service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
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.
For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDescribeTagsType
See
AWSAutoScalingTagsType
Declaration
Objective-C
- (id)describeTags:(nonnull AWSAutoScalingDescribeTagsType *)request;
Swift
func describeTags(_ request: AWSAutoScalingDescribeTagsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeTags service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingTagsType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
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.
For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDescribeTagsType
See
AWSAutoScalingTagsType
Declaration
Objective-C
- (void)describeTags:(nonnull AWSAutoScalingDescribeTagsType *)request completionHandler:(void (^_Nullable)(AWSAutoScalingTagsType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeTags(_ request: AWSAutoScalingDescribeTagsType, completionHandler: ((AWSAutoScalingTagsType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeTags service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorInvalidNextToken
,AWSAutoScalingErrorResourceContention
. -
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.
See
AWSRequest
See
AWSAutoScalingDescribeTerminationPolicyTypesAnswer
Declaration
Objective-C
- (id)describeTerminationPolicyTypes:(id)request;
Swift
func describeTerminationPolicyTypes(_ request: Any!) -> Any!
Parameters
request
A container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDescribeTerminationPolicyTypesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Describes the termination policies supported by Amazon EC2 Auto Scaling.
For more information, see Controlling which Auto Scaling instances terminate during scale in in the Amazon EC2 Auto Scaling User Guide.
See
AWSRequest
See
AWSAutoScalingDescribeTerminationPolicyTypesAnswer
Declaration
Objective-C
- (void)describeTerminationPolicyTypes:(id)request completionHandler: (void (^_Nullable)( AWSAutoScalingDescribeTerminationPolicyTypesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func describeTerminationPolicyTypes(_ request: Any!, completionHandler: ((AWSAutoScalingDescribeTerminationPolicyTypesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DescribeTerminationPolicyTypes service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDetachInstancesQuery
See
AWSAutoScalingDetachInstancesAnswer
Declaration
Objective-C
- (id)detachInstances:(nonnull AWSAutoScalingDetachInstancesQuery *)request;
Swift
func detachInstances(_ request: AWSAutoScalingDetachInstancesQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the DetachInstances service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDetachInstancesAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Removes one or more instances from the specified Auto Scaling group.
After the instances are detached, you can manage them independent of the Auto Scaling group.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are detached.
If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.
For more information, see Detach EC2 instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingDetachInstancesQuery
See
AWSAutoScalingDetachInstancesAnswer
Declaration
Objective-C
- (void)detachInstances:(nonnull AWSAutoScalingDetachInstancesQuery *)request completionHandler: (void (^_Nullable)(AWSAutoScalingDetachInstancesAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func detachInstances(_ request: AWSAutoScalingDetachInstancesQuery, completionHandler: ((AWSAutoScalingDetachInstancesAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DetachInstances service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Detaches one or more target groups from the specified Auto Scaling group.
See
AWSAutoScalingDetachLoadBalancerTargetGroupsType
See
AWSAutoScalingDetachLoadBalancerTargetGroupsResultType
Declaration
Objective-C
- (id)detachLoadBalancerTargetGroups: (nonnull AWSAutoScalingDetachLoadBalancerTargetGroupsType *)request;
Swift
func detachLoadBalancerTargetGroups(_ request: AWSAutoScalingDetachLoadBalancerTargetGroupsType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DetachLoadBalancerTargetGroups service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDetachLoadBalancerTargetGroupsResultType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Detaches one or more target groups from the specified Auto Scaling group.
See
AWSAutoScalingDetachLoadBalancerTargetGroupsType
See
AWSAutoScalingDetachLoadBalancerTargetGroupsResultType
Declaration
Objective-C
- (void) detachLoadBalancerTargetGroups: (nonnull AWSAutoScalingDetachLoadBalancerTargetGroupsType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDetachLoadBalancerTargetGroupsResultType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func detachLoadBalancerTargetGroups(_ request: AWSAutoScalingDetachLoadBalancerTargetGroupsType, completionHandler: ((AWSAutoScalingDetachLoadBalancerTargetGroupsResultType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DetachLoadBalancerTargetGroups service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
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 the DescribeLoadBalancers API call. The instances remain running.See
AWSAutoScalingDetachLoadBalancersType
See
AWSAutoScalingDetachLoadBalancersResultType
Declaration
Objective-C
- (id)detachLoadBalancers: (nonnull AWSAutoScalingDetachLoadBalancersType *)request;
Swift
func detachLoadBalancers(_ request: AWSAutoScalingDetachLoadBalancersType) -> Any!
Parameters
request
A container for the necessary parameters to execute the DetachLoadBalancers service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingDetachLoadBalancersResultType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Detaches one or more Classic Load Balancers from the specified Auto Scaling group.
This operation detaches only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.
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 the DescribeLoadBalancers API call. The instances remain running.See
AWSAutoScalingDetachLoadBalancersType
See
AWSAutoScalingDetachLoadBalancersResultType
Declaration
Objective-C
- (void)detachLoadBalancers: (nonnull AWSAutoScalingDetachLoadBalancersType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingDetachLoadBalancersResultType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func detachLoadBalancers(_ request: AWSAutoScalingDetachLoadBalancersType, completionHandler: ((AWSAutoScalingDetachLoadBalancersResultType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DetachLoadBalancers service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Disables group metrics for the specified Auto Scaling group.
See
AWSAutoScalingDisableMetricsCollectionQuery
Declaration
Objective-C
- (id)disableMetricsCollection: (nonnull AWSAutoScalingDisableMetricsCollectionQuery *)request;
Swift
func disableMetricsCollection(_ request: AWSAutoScalingDisableMetricsCollectionQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the DisableMetricsCollection service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Disables group metrics for the specified Auto Scaling group.
See
AWSAutoScalingDisableMetricsCollectionQuery
Declaration
Objective-C
- (void)disableMetricsCollection: (nonnull AWSAutoScalingDisableMetricsCollectionQuery *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func disableMetricsCollection(_ request: AWSAutoScalingDisableMetricsCollectionQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the DisableMetricsCollection service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingEnableMetricsCollectionQuery
Declaration
Objective-C
- (id)enableMetricsCollection: (nonnull AWSAutoScalingEnableMetricsCollectionQuery *)request;
Swift
func enableMetricsCollection(_ request: AWSAutoScalingEnableMetricsCollectionQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the EnableMetricsCollection service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingEnableMetricsCollectionQuery
Declaration
Objective-C
- (void)enableMetricsCollection: (nonnull AWSAutoScalingEnableMetricsCollectionQuery *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func enableMetricsCollection(_ request: AWSAutoScalingEnableMetricsCollectionQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the EnableMetricsCollection service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingEnterStandbyQuery
See
AWSAutoScalingEnterStandbyAnswer
Declaration
Objective-C
- (id)enterStandby:(nonnull AWSAutoScalingEnterStandbyQuery *)request;
Swift
func enterStandby(_ request: AWSAutoScalingEnterStandbyQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the EnterStandby service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingEnterStandbyAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Moves the specified instances into the standby state.
If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.
If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingEnterStandbyQuery
See
AWSAutoScalingEnterStandbyAnswer
Declaration
Objective-C
- (void)enterStandby:(nonnull AWSAutoScalingEnterStandbyQuery *)request completionHandler: (void (^_Nullable)(AWSAutoScalingEnterStandbyAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func enterStandby(_ request: AWSAutoScalingEnterStandbyQuery, completionHandler: ((AWSAutoScalingEnterStandbyAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the EnterStandby service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Executes the specified policy. This can be useful for testing the design of your scaling policy.
See
AWSAutoScalingExecutePolicyType
Declaration
Objective-C
- (id)executePolicy:(nonnull AWSAutoScalingExecutePolicyType *)request;
Swift
func executePolicy(_ request: AWSAutoScalingExecutePolicyType) -> Any!
Parameters
request
A container for the necessary parameters to execute the ExecutePolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
Executes the specified policy. This can be useful for testing the design of your scaling policy.
See
AWSAutoScalingExecutePolicyType
Declaration
Objective-C
- (void)executePolicy:(nonnull AWSAutoScalingExecutePolicyType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func executePolicy(_ request: AWSAutoScalingExecutePolicyType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ExecutePolicy service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingExitStandbyQuery
See
AWSAutoScalingExitStandbyAnswer
Declaration
Objective-C
- (id)exitStandby:(nonnull AWSAutoScalingExitStandbyQuery *)request;
Swift
func exitStandby(_ request: AWSAutoScalingExitStandbyQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the ExitStandby service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingExitStandbyAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Moves the specified instances out of the standby state.
After you put the instances back in service, the desired capacity is incremented.
For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingExitStandbyQuery
See
AWSAutoScalingExitStandbyAnswer
Declaration
Objective-C
- (void)exitStandby:(nonnull AWSAutoScalingExitStandbyQuery *)request completionHandler: (void (^_Nullable)(AWSAutoScalingExitStandbyAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func exitStandby(_ request: AWSAutoScalingExitStandbyQuery, completionHandler: ((AWSAutoScalingExitStandbyAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ExitStandby service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Creates or updates a lifecycle hook for the specified Auto Scaling group.
A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, complete the lifecycle action using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
See
AWSAutoScalingPutLifecycleHookType
See
AWSAutoScalingPutLifecycleHookAnswer
Declaration
Objective-C
- (id)putLifecycleHook:(nonnull AWSAutoScalingPutLifecycleHookType *)request;
Swift
func putLifecycleHook(_ request: AWSAutoScalingPutLifecycleHookType) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutLifecycleHook service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingPutLifecycleHookAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Creates or updates a lifecycle hook for the specified Auto Scaling group.
A lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance launches (before it is put into service) or as the instance terminates (before it is fully terminated).
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using the RecordLifecycleActionHeartbeat API call.
If you finish before the timeout period ends, complete the lifecycle action using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.
You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.
See
AWSAutoScalingPutLifecycleHookType
See
AWSAutoScalingPutLifecycleHookAnswer
Declaration
Objective-C
- (void)putLifecycleHook:(nonnull AWSAutoScalingPutLifecycleHookType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingPutLifecycleHookAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func putLifecycleHook(_ request: AWSAutoScalingPutLifecycleHookType, completionHandler: ((AWSAutoScalingPutLifecycleHookAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the PutLifecycleHook service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
See
AWSAutoScalingPutNotificationConfigurationType
Declaration
Objective-C
- (id)putNotificationConfiguration: (nonnull AWSAutoScalingPutNotificationConfigurationType *)request;
Swift
func putNotificationConfiguration(_ request: AWSAutoScalingPutNotificationConfigurationType) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutNotificationConfiguration service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an endpoint such as a web server or an email address.
This configuration overwrites any existing configuration.
For more information, see Getting Amazon SNS notifications when your Auto Scaling group scales in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.
See
AWSAutoScalingPutNotificationConfigurationType
Declaration
Objective-C
- (void)putNotificationConfiguration: (nonnull AWSAutoScalingPutNotificationConfigurationType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func putNotificationConfiguration(_ request: AWSAutoScalingPutNotificationConfigurationType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the PutNotificationConfiguration service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Creates or updates a scaling policy for an Auto Scaling group.
For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingPutScalingPolicyType
See
AWSAutoScalingPolicyARNType
Declaration
Objective-C
- (id)putScalingPolicy:(nonnull AWSAutoScalingPutScalingPolicyType *)request;
Swift
func put(_ request: AWSAutoScalingPutScalingPolicyType) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutScalingPolicy service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingPolicyARNType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Creates or updates a scaling policy for an Auto Scaling group.
For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingPutScalingPolicyType
See
AWSAutoScalingPolicyARNType
Declaration
Objective-C
- (void)putScalingPolicy:(nonnull AWSAutoScalingPutScalingPolicyType *)request completionHandler: (void (^_Nullable)(AWSAutoScalingPolicyARNType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func put(_ request: AWSAutoScalingPutScalingPolicyType, completionHandler: ((AWSAutoScalingPolicyARNType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the PutScalingPolicy service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingPutScheduledUpdateGroupActionType
Declaration
Objective-C
- (id)putScheduledUpdateGroupAction: (nonnull AWSAutoScalingPutScheduledUpdateGroupActionType *)request;
Swift
func putScheduledUpdateGroupAction(_ request: AWSAutoScalingPutScheduledUpdateGroupActionType) -> Any!
Parameters
request
A container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.
For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingPutScheduledUpdateGroupActionType
Declaration
Objective-C
- (void)putScheduledUpdateGroupAction: (nonnull AWSAutoScalingPutScheduledUpdateGroupActionType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable)) completionHandler;
Swift
func putScheduledUpdateGroupAction(_ request: AWSAutoScalingPutScheduledUpdateGroupActionType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the PutScheduledUpdateGroupAction service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorAlreadyExists
,AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling lifecycle in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingRecordLifecycleActionHeartbeatType
See
AWSAutoScalingRecordLifecycleActionHeartbeatAnswer
Declaration
Objective-C
- (id)recordLifecycleActionHeartbeat: (nonnull AWSAutoScalingRecordLifecycleActionHeartbeatType *)request;
Swift
func recordLifecycleActionHeartbeat(_ request: AWSAutoScalingRecordLifecycleActionHeartbeatType) -> Any!
Parameters
request
A container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingRecordLifecycleActionHeartbeatAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates instances.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.
If you finish before the timeout period ends, complete the lifecycle action.
For more information, see Auto Scaling lifecycle in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingRecordLifecycleActionHeartbeatType
See
AWSAutoScalingRecordLifecycleActionHeartbeatAnswer
Declaration
Objective-C
- (void)recordLifecycleActionHeartbeat: (nonnull AWSAutoScalingRecordLifecycleActionHeartbeatType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingRecordLifecycleActionHeartbeatAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func recordLifecycleActionHeartbeat(_ request: AWSAutoScalingRecordLifecycleActionHeartbeatType, completionHandler: ((AWSAutoScalingRecordLifecycleActionHeartbeatAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the RecordLifecycleActionHeartbeat service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingScalingProcessQuery
Declaration
Objective-C
- (id)resumeProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request;
Swift
func resumeProcesses(_ request: AWSAutoScalingScalingProcessQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the ResumeProcesses service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingScalingProcessQuery
Declaration
Objective-C
- (void)resumeProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func resumeProcesses(_ request: AWSAutoScalingScalingProcessQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the ResumeProcesses service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new
DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingSetDesiredCapacityType
Declaration
Objective-C
- (id)setDesiredCapacity: (nonnull AWSAutoScalingSetDesiredCapacityType *)request;
Swift
func setDesiredCapacity(_ request: AWSAutoScalingSetDesiredCapacityType) -> Any!
Parameters
request
A container for the necessary parameters to execute the SetDesiredCapacity service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new
DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingSetDesiredCapacityType
Declaration
Objective-C
- (void) setDesiredCapacity:(nonnull AWSAutoScalingSetDesiredCapacityType *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func setDesiredCapacity(_ request: AWSAutoScalingSetDesiredCapacityType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the SetDesiredCapacity service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingSetInstanceHealthQuery
Declaration
Objective-C
- (id)setInstanceHealth:(nonnull AWSAutoScalingSetInstanceHealthQuery *)request;
Swift
func setInstanceHealth(_ request: AWSAutoScalingSetInstanceHealthQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the SetInstanceHealth service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingSetInstanceHealthQuery
Declaration
Objective-C
- (void) setInstanceHealth:(nonnull AWSAutoScalingSetInstanceHealthQuery *)request completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func setInstanceHealth(_ request: AWSAutoScalingSetInstanceHealthQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the SetInstanceHealth service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceContention
. -
Updates the instance protection settings of the specified instances.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
See
AWSAutoScalingSetInstanceProtectionQuery
See
AWSAutoScalingSetInstanceProtectionAnswer
Declaration
Objective-C
- (id)setInstanceProtection: (nonnull AWSAutoScalingSetInstanceProtectionQuery *)request;
Swift
func setInstanceProtection(_ request: AWSAutoScalingSetInstanceProtectionQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the SetInstanceProtection service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingSetInstanceProtectionAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Updates the instance protection settings of the specified instances.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
See
AWSAutoScalingSetInstanceProtectionQuery
See
AWSAutoScalingSetInstanceProtectionAnswer
Declaration
Objective-C
- (void)setInstanceProtection: (nonnull AWSAutoScalingSetInstanceProtectionQuery *)request completionHandler: (void (^_Nullable)( AWSAutoScalingSetInstanceProtectionAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func setInstanceProtection(_ request: AWSAutoScalingSetInstanceProtectionQuery, completionHandler: ((AWSAutoScalingSetInstanceProtectionAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the SetInstanceProtection service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
. -
Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.
If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingStartInstanceRefreshType
See
AWSAutoScalingStartInstanceRefreshAnswer
Declaration
Objective-C
- (id)startInstanceRefresh: (nonnull AWSAutoScalingStartInstanceRefreshType *)request;
Swift
func startInstanceRefresh(_ request: AWSAutoScalingStartInstanceRefreshType) -> Any!
Parameters
request
A container for the necessary parameters to execute the StartInstanceRefresh service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingStartInstanceRefreshAnswer
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorInstanceRefreshInProgress
. -
Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.
If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.
For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.
See
AWSAutoScalingStartInstanceRefreshType
See
AWSAutoScalingStartInstanceRefreshAnswer
Declaration
Objective-C
- (void)startInstanceRefresh: (nonnull AWSAutoScalingStartInstanceRefreshType *)request completionHandler: (void (^_Nullable)( AWSAutoScalingStartInstanceRefreshAnswer *_Nullable, NSError *_Nullable))completionHandler;
Swift
func startInstanceRefresh(_ request: AWSAutoScalingStartInstanceRefreshType, completionHandler: ((AWSAutoScalingStartInstanceRefreshAnswer?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the StartInstanceRefresh service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorLimitExceeded
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorInstanceRefreshInProgress
. -
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
Launch
orTerminate
process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.To resume processes that have been suspended, call the ResumeProcesses API.
See
AWSAutoScalingScalingProcessQuery
Declaration
Objective-C
- (id)suspendProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request;
Swift
func suspendProcesses(_ request: AWSAutoScalingScalingProcessQuery) -> Any!
Parameters
request
A container for the necessary parameters to execute the SuspendProcesses service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the
Launch
orTerminate
process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.To resume processes that have been suspended, call the ResumeProcesses API.
See
AWSAutoScalingScalingProcessQuery
Declaration
Objective-C
- (void)suspendProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func suspendProcesses(_ request: AWSAutoScalingScalingProcessQuery, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the SuspendProcesses service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorResourceInUse
,AWSAutoScalingErrorResourceContention
. -
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to
terminated
. You can’t connect to or start an instance after you’ve terminated it.If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingTerminateInstanceInAutoScalingGroupType
See
AWSAutoScalingActivityType
Declaration
Objective-C
- (id)terminateInstanceInAutoScalingGroup: (nonnull AWSAutoScalingTerminateInstanceInAutoScalingGroupType *)request;
Swift
func terminateInstance(_ request: AWSAutoScalingTerminateInstanceInAutoScalingGroupType) -> Any!
Parameters
request
A container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will contain an instance ofAWSAutoScalingActivityType
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
Terminates the specified instance and optionally adjusts the desired group size.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to
terminated
. You can’t connect to or start an instance after you’ve terminated it.If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
See
AWSAutoScalingTerminateInstanceInAutoScalingGroupType
See
AWSAutoScalingActivityType
Declaration
Objective-C
- (void)terminateInstanceInAutoScalingGroup: (nonnull AWSAutoScalingTerminateInstanceInAutoScalingGroupType *) request completionHandler: (void (^_Nullable)( AWSAutoScalingActivityType *_Nullable, NSError *_Nullable))completionHandler;
Swift
func terminateInstance(_ request: AWSAutoScalingTerminateInstanceInAutoScalingGroupType, completionHandler: ((AWSAutoScalingActivityType?, Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the TerminateInstanceInAutoScalingGroup service method.
completionHandler
The completion handler to call when the load request is complete.
response
- A response object, ornil
if the request failed.error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
. -
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don’t specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing
DesiredCapacity
,MaxSize
, orMinSize
:If a scale-in activity occurs as a result of a new
DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.If you specify a new value for
MinSize
without specifying a value forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group’sDesiredCapacity
to the newMinSize
value.If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group’sDesiredCapacity
to the newMaxSize
value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
See
AWSAutoScalingUpdateAutoScalingGroupType
Declaration
Objective-C
- (id)updateAutoScalingGroup: (nonnull AWSAutoScalingUpdateAutoScalingGroupType *)request;
Swift
func update(_ request: AWSAutoScalingUpdateAutoScalingGroupType) -> Any!
Parameters
request
A container for the necessary parameters to execute the UpdateAutoScalingGroup service method.
Return Value
An instance of
AWSTask
. On successful execution,task.result
will benil
. On failed execution,task.error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
. -
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don’t specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing
DesiredCapacity
,MaxSize
, orMinSize
:If a scale-in activity occurs as a result of a new
DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.If you specify a new value for
MinSize
without specifying a value forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group’sDesiredCapacity
to the newMinSize
value.If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group’sDesiredCapacity
to the newMaxSize
value.
To see which parameters have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
See
AWSAutoScalingUpdateAutoScalingGroupType
Declaration
Objective-C
- (void)updateAutoScalingGroup: (nonnull AWSAutoScalingUpdateAutoScalingGroupType *)request completionHandler: (void (^_Nullable)(NSError *_Nullable))completionHandler;
Swift
func update(_ request: AWSAutoScalingUpdateAutoScalingGroupType, completionHandler: ((Error?) -> Void)? = nil)
Parameters
request
A container for the necessary parameters to execute the UpdateAutoScalingGroup service method.
completionHandler
The completion handler to call when the load request is complete.
error
- An error object that indicates why the request failed, ornil
if the request was successful. On failed execution,error
may contain anNSError
withAWSAutoScalingErrorDomain
domain and the following error code:AWSAutoScalingErrorScalingActivityInProgress
,AWSAutoScalingErrorResourceContention
,AWSAutoScalingErrorServiceLinkedRoleFailure
.