AWSAutoScaling

@interface AWSAutoScaling

Amazon EC2 Auto Scaling

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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • Attaches one or more target groups to the specified Auto Scaling group.

    To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

    With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group 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 of AWSAutoScalingAttachLoadBalancerTargetGroupsResultType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • Attaches one or more target groups to the specified Auto Scaling group.

    To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups.

    With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

    To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

    To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

    For more information, see Attaching a Load Balancer to Your Auto Scaling Group 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 of AWSAutoScalingAttachLoadBalancersResultType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • Attaches one or more Classic Load Balancers to the specified Auto Scaling group.

    To attach an Application Load Balancer or a Network Load Balancer instead, see AttachLoadBalancerTargetGroups.

    To describe the load balancers for an Auto Scaling group, use DescribeLoadBalancers. To detach the load balancer from the Auto Scaling group, use DetachLoadBalancers.

    For more information, see Attaching a Load Balancer to Your Auto Scaling Group 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingBatchDeleteScheduledActionAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorAlreadyExists, AWSAutoScalingErrorLimitExceeded, 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:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

    5. 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 of AWSAutoScalingCompleteLifecycleActionAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

    5. 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Creates an Auto Scaling group with the specified name and attributes.

    If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

    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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorAlreadyExists, AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • Creates an Auto Scaling group with the specified name and attributes.

    If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see DescribeAccountLimits. For information about updating this limit, see Amazon EC2 Auto Scaling Service Quotas in the Amazon EC2 Auto Scaling User Guide.

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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. For information about viewing this limit, see DescribeAccountLimits. 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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. For information about viewing this limit, see DescribeAccountLimits. 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 DetachInstances 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 UpdateAutoScalingGroup 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 DetachInstances 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 UpdateAutoScalingGroup 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDeleteLifecycleHookAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeAccountLimitsAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Describes the policy adjustment types for use with PutScalingPolicy.

    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 of AWSAutoScalingDescribeAdjustmentTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Describes the policy adjustment types for use with PutScalingPolicy.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingAutoScalingGroupsType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingAutoScalingInstancesType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: 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 of AWSAutoScalingLaunchConfigurationsType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeLifecycleHookTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeLifecycleHooksAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 or Network Load Balancers, use DescribeLoadBalancerTargetGroups 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 of AWSAutoScalingDescribeLoadBalancersResponse. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 or Network Load Balancers, use DescribeLoadBalancerTargetGroups 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 EnableMetricsCollection.

    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 of AWSAutoScalingDescribeMetricCollectionTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 EnableMetricsCollection.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeNotificationConfigurationsAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingPoliciesType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingActivitiesType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorInvalidNextToken, AWSAutoScalingErrorResourceContention.

  • Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

    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 of AWSAutoScalingProcessesType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Describes the scaling process types for use with ResumeProcesses and SuspendProcesses.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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, use DescribeScalingActivities.

    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 of AWSAutoScalingScheduledActionsType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, use DescribeScalingActivities.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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.

    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 of AWSAutoScalingTagsType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDescribeTerminationPolicyTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDetachInstancesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingDetachLoadBalancerTargetGroupsResultType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 or Network Load Balancers, use DetachLoadBalancerTargetGroups 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 DescribeLoadBalancers. 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 of AWSAutoScalingDetachLoadBalancersResultType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 or Network Load Balancers, use DetachLoadBalancerTargetGroups 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 DescribeLoadBalancers. 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingEnterStandbyAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Executes the specified 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention.

  • Executes the specified 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingExitStandbyAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat.

    5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

    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 DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

    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 of AWSAutoScalingPutLifecycleHookAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state using RecordLifecycleActionHeartbeat.

    5. If you finish before the timeout period ends, complete the lifecycle action using CompleteLifecycleAction.

    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 DescribeLifecycleHooks. If you are no longer using a lifecycle hook, you can delete it using DeleteLifecycleHook.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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.

    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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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.

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 automatically, see Dynamic Scaling 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 of AWSAutoScalingPolicyARNType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 automatically, see Dynamic Scaling 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 PutLifecycleHook.

    This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

    5. 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 of AWSAutoScalingRecordLifecycleActionHeartbeatAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 PutLifecycleHook.

    This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:

    1. (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.

    2. (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.

    3. Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.

    4. If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.

    5. 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Resumes the specified suspended automatic 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceInUse, AWSAutoScalingErrorResourceContention.

  • Resumes the specified suspended automatic 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceInUse, AWSAutoScalingErrorResourceContention.

  • Sets the size of the specified Auto Scaling group.

    For more information about desired capacity, see What Is Amazon EC2 Auto 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention.

  • Sets the size of the specified Auto Scaling group.

    For more information about desired capacity, see What Is Amazon EC2 Auto 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 Protection in the Amazon EC2 Auto Scaling User Guide.

    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 of AWSAutoScalingSetInstanceProtectionAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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 Protection in the Amazon EC2 Auto Scaling User Guide.

    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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention.

  • Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

    If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

    To resume processes that have been suspended, use ResumeProcesses.

    For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

    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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceInUse, AWSAutoScalingErrorResourceContention.

  • Suspends the specified automatic scaling processes, or all processes, for the specified Auto Scaling group.

    If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly.

    To resume processes that have been suspended, use ResumeProcesses.

    For more information, see Suspending and Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain 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 of AWSAutoScalingActivityType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain 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, or nil if the request failed. error - An error object that indicates why the request failed, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention.

  • 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, or MinSize:

    • If a scale-in event 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 for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group’s DesiredCapacity to the new MinSize value.

    • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group’s DesiredCapacity to the new MaxSize value.

    To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.

    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 be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • 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, or MinSize:

    • If a scale-in event 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 for DesiredCapacity, and the new MinSize is larger than the current size of the group, this sets the group’s DesiredCapacity to the new MinSize value.

    • If you specify a new value for MaxSize without specifying a value for DesiredCapacity, and the new MaxSize is smaller than the current size of the group, this sets the group’s DesiredCapacity to the new MaxSize value.

    To see which parameters have been set, use DescribeAutoScalingGroups. You can also view the scaling policies for an Auto Scaling group using DescribePolicies. If the group has scaling policies, you can update them using PutScalingPolicy.

    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, or nil if the request was successful. On failed execution, error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.