AWSAutoScaling

Objective-C

@interface AWSAutoScaling

Swift

class 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.

For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide. For information about granting IAM users required permissions for calls to Amazon EC2 Auto Scaling, see Granting IAM users required permissions for Amazon EC2 Auto Scaling resources in the Amazon EC2 Auto Scaling API Reference.

  • 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

  • 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) async throws

    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.

    This operation is used with the following load balancer types:

    • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

    • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

    • Gateway Load Balancer - Operates at the network layer (layer 3).

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

    This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.

    For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingAttachLoadBalancerTargetGroupsType

    See

    AWSAutoScalingAttachLoadBalancerTargetGroupsResultType

    Declaration

    Objective-C

    - (id)attachLoadBalancerTargetGroups:
    (nonnull AWSAutoScalingAttachLoadBalancerTargetGroupsType *)request;

    Swift

    func attachLoadBalancerTargetGroups(_ request: AWSAutoScalingAttachLoadBalancerTargetGroupsType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AttachLoadBalancerTargetGroups service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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.

    This operation is used with the following load balancer types:

    • Application Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.

    • Network Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.

    • Gateway Load Balancer - Operates at the network layer (layer 3).

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

    This operation is additive and does not detach existing target groups or Classic Load Balancers from the Auto Scaling group.

    For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingAttachLoadBalancerTargetGroupsType

    See

    AWSAutoScalingAttachLoadBalancerTargetGroupsResultType

    Declaration

    Objective-C

    - (void)
    attachLoadBalancerTargetGroups:
        (nonnull AWSAutoScalingAttachLoadBalancerTargetGroupsType *)request
                 completionHandler:
                     (void (^_Nullable)(
                         AWSAutoScalingAttachLoadBalancerTargetGroupsResultType
                             *_Nullable,
                         NSError *_Nullable))completionHandler;

    Swift

    func attachLoadBalancerTargetGroups(_ request: AWSAutoScalingAttachLoadBalancerTargetGroupsType) async throws -> AWSAutoScalingAttachLoadBalancerTargetGroupsResultType

    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.

  • To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.

    Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.

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

    This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.

    For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingAttachLoadBalancersType

    See

    AWSAutoScalingAttachLoadBalancersResultType

    Declaration

    Objective-C

    - (id)attachLoadBalancers:
    (nonnull AWSAutoScalingAttachLoadBalancersType *)request;

    Swift

    func attachLoadBalancers(_ request: AWSAutoScalingAttachLoadBalancersType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the AttachLoadBalancers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingAttachLoadBalancersResultType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • To attach an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.

    Attaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling registers the running instances with these Classic Load Balancers.

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

    This operation is additive and does not detach existing Classic Load Balancers or target groups from the Auto Scaling group.

    For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingAttachLoadBalancersType

    See

    AWSAutoScalingAttachLoadBalancersResultType

    Declaration

    Objective-C

    - (void)attachLoadBalancers:
            (nonnull AWSAutoScalingAttachLoadBalancersType *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSAutoScalingAttachLoadBalancersResultType *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func attachLoadBalancers(_ request: AWSAutoScalingAttachLoadBalancersType) async throws -> AWSAutoScalingAttachLoadBalancersResultType

    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) async throws -> AWSAutoScalingBatchDeleteScheduledActionAnswer

    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.

    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.

    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) async throws -> AWSAutoScalingBatchPutScheduledUpdateGroupActionAnswer

    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.

  • Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

    See

    AWSAutoScalingCancelInstanceRefreshType

    See

    AWSAutoScalingCancelInstanceRefreshAnswer

    Declaration

    Objective-C

    - (id)cancelInstanceRefresh:
    (nonnull AWSAutoScalingCancelInstanceRefreshType *)request;

    Swift

    func cancelInstanceRefresh(_ request: AWSAutoScalingCancelInstanceRefreshType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CancelInstanceRefresh service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingCancelInstanceRefreshAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorActiveInstanceRefreshNotFound.

  • Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

    See

    AWSAutoScalingCancelInstanceRefreshType

    See

    AWSAutoScalingCancelInstanceRefreshAnswer

    Declaration

    Objective-C

    - (void)cancelInstanceRefresh:
            (nonnull AWSAutoScalingCancelInstanceRefreshType *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSAutoScalingCancelInstanceRefreshAnswer *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func cancelInstanceRefresh(_ request: AWSAutoScalingCancelInstanceRefreshType) async throws -> AWSAutoScalingCancelInstanceRefreshAnswer

    Parameters

    request

    A container for the necessary parameters to execute the CancelInstanceRefresh service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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, AWSAutoScalingErrorActiveInstanceRefreshNotFound.

  • Completes the lifecycle action for the specified token or instance with the specified result.

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

    1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

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

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    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 launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

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

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    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) async throws -> AWSAutoScalingCompleteLifecycleActionAnswer

    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.

  • We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

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

    If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

    For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.

    Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

    See

    AWSAutoScalingCreateAutoScalingGroupType

    Declaration

    Objective-C

    - (id)createAutoScalingGroup:
    (nonnull AWSAutoScalingCreateAutoScalingGroupType *)request;

    Swift

    func createAutoScalingGroup(_ request: AWSAutoScalingCreateAutoScalingGroupType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateAutoScalingGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorAlreadyExists, AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

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

    If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

    For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.

    Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.

    See

    AWSAutoScalingCreateAutoScalingGroupType

    Declaration

    Objective-C

    - (void)createAutoScalingGroup:
            (nonnull AWSAutoScalingCreateAutoScalingGroupType *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func createAutoScalingGroup(_ request: AWSAutoScalingCreateAutoScalingGroupType) async throws

    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. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

    For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingCreateLaunchConfigurationType

    Declaration

    Objective-C

    - (id)createLaunchConfiguration:
    (nonnull AWSAutoScalingCreateLaunchConfigurationType *)request;

    Swift

    func createLaunchConfiguration(_ request: AWSAutoScalingCreateLaunchConfigurationType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the CreateLaunchConfiguration service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Amazon EC2 Auto Scaling service quotas in the Amazon EC2 Auto Scaling User Guide.

    For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingCreateLaunchConfigurationType

    Declaration

    Objective-C

    - (void)createLaunchConfiguration:
            (nonnull AWSAutoScalingCreateLaunchConfigurationType *)request
                completionHandler:
                    (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func createLaunchConfiguration(_ request: AWSAutoScalingCreateLaunchConfigurationType) async throws

    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) async throws

    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 the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

    To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.

    See

    AWSAutoScalingDeleteAutoScalingGroupType

    Declaration

    Objective-C

    - (id)deleteAutoScalingGroup:
    (nonnull AWSAutoScalingDeleteAutoScalingGroupType *)request;

    Swift

    func delete(_ request: AWSAutoScalingDeleteAutoScalingGroupType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteAutoScalingGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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 the DetachInstances API with the list of instances and the option to decrement the desired capacity. This ensures that Amazon EC2 Auto Scaling does not launch replacement instances.

    To terminate all instances before deleting the Auto Scaling group, call the UpdateAutoScalingGroup API and set the minimum size and desired capacity of the Auto Scaling group to zero.

    See

    AWSAutoScalingDeleteAutoScalingGroupType

    Declaration

    Objective-C

    - (void)deleteAutoScalingGroup:
            (nonnull AWSAutoScalingDeleteAutoScalingGroupType *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func delete(_ request: AWSAutoScalingDeleteAutoScalingGroupType) async throws

    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) async throws

    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) async throws -> AWSAutoScalingDeleteLifecycleHookAnswer

    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) async throws

    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) async throws

    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) async throws

    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) async throws

    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.

  • Deletes the warm pool for the specified Auto Scaling group.

    For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDeleteWarmPoolType

    See

    AWSAutoScalingDeleteWarmPoolAnswer

    Declaration

    Objective-C

    - (id)deleteWarmPool:(nonnull AWSAutoScalingDeleteWarmPoolType *)request;

    Swift

    func deleteWarmPool(_ request: AWSAutoScalingDeleteWarmPoolType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DeleteWarmPool service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingDeleteWarmPoolAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceInUse.

  • Deletes the warm pool for the specified Auto Scaling group.

    For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDeleteWarmPoolType

    See

    AWSAutoScalingDeleteWarmPoolAnswer

    Declaration

    Objective-C

    - (void)deleteWarmPool:(nonnull AWSAutoScalingDeleteWarmPoolType *)request
     completionHandler:
         (void (^_Nullable)(AWSAutoScalingDeleteWarmPoolAnswer *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func deleteWarmPool(_ request: AWSAutoScalingDeleteWarmPoolType) async throws -> AWSAutoScalingDeleteWarmPoolAnswer

    Parameters

    request

    A container for the necessary parameters to execute the DeleteWarmPool 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, AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceInUse.

  • Describes the current Amazon EC2 Auto Scaling resource quotas for your account.

    When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, 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 account.

    When you establish an Amazon Web Services account, the account has initial quotas on the maximum number of Auto Scaling groups and launch configurations that you can create in a given Region. For more information, 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!) async throws -> AWSAutoScalingDescribeAccountLimitsAnswer

    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 available adjustment types for step scaling and simple scaling policies.

    The following adjustment types are supported:

    • ChangeInCapacity

    • ExactCapacity

    • PercentChangeInCapacity

    See

    AWSRequest

    See

    AWSAutoScalingDescribeAdjustmentTypesAnswer

    Declaration

    Objective-C

    - (id)describeAdjustmentTypes:(id)request;

    Swift

    func describeAdjustmentTypes(_ request: Any!) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeAdjustmentTypes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingDescribeAdjustmentTypesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Describes the available adjustment types for step scaling and simple scaling policies.

    The following adjustment types are supported:

    • ChangeInCapacity

    • ExactCapacity

    • PercentChangeInCapacity

    See

    AWSRequest

    See

    AWSAutoScalingDescribeAdjustmentTypesAnswer

    Declaration

    Objective-C

    - (void)describeAdjustmentTypes:(id)request
              completionHandler:
                  (void (^_Nullable)(
                      AWSAutoScalingDescribeAdjustmentTypesAnswer *_Nullable,
                      NSError *_Nullable))completionHandler;

    Swift

    func describeAdjustmentTypes(_ request: Any!) async throws -> AWSAutoScalingDescribeAdjustmentTypesAnswer

    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.

  • Gets information about the Auto Scaling groups in the account and Region.

    If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.

    This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.

    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.

  • Gets information about the Auto Scaling groups in the account and Region.

    If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.

    This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.

    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) async throws -> AWSAutoScalingAutoScalingGroupsType

    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.

  • Gets information about the Auto Scaling instances in the account and Region.

    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.

  • Gets information about the Auto Scaling instances in the account and Region.

    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) async throws -> AWSAutoScalingAutoScalingInstancesType

    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!) async throws -> AWSAutoScalingDescribeAutoScalingNotificationTypesAnswer

    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.

  • Gets information about the instance refreshes for the specified Auto Scaling group.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

    To help you determine the status of an instance refresh, this operation returns information about the instance refreshes you previously initiated, including their status, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete.

    The following are the possible statuses:

    • Pending - The request was created, but the operation has not started.

    • InProgress - The operation is in progress.

    • Successful - The operation completed successfully.

    • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

    • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

    • Cancelled - The operation is cancelled.

    See

    AWSAutoScalingDescribeInstanceRefreshesType

    See

    AWSAutoScalingDescribeInstanceRefreshesAnswer

    Declaration

    Objective-C

    - (id)describeInstanceRefreshes:
    (nonnull AWSAutoScalingDescribeInstanceRefreshesType *)request;

    Swift

    func describeInstanceRefreshes(_ request: AWSAutoScalingDescribeInstanceRefreshesType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeInstanceRefreshes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingDescribeInstanceRefreshesAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorInvalidNextToken, AWSAutoScalingErrorResourceContention.

  • Gets information about the instance refreshes for the specified Auto Scaling group.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.

    To help you determine the status of an instance refresh, this operation returns information about the instance refreshes you previously initiated, including their status, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete.

    The following are the possible statuses:

    • Pending - The request was created, but the operation has not started.

    • InProgress - The operation is in progress.

    • Successful - The operation completed successfully.

    • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

    • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

    • Cancelled - The operation is cancelled.

    See

    AWSAutoScalingDescribeInstanceRefreshesType

    See

    AWSAutoScalingDescribeInstanceRefreshesAnswer

    Declaration

    Objective-C

    - (void)
    describeInstanceRefreshes:
        (nonnull AWSAutoScalingDescribeInstanceRefreshesType *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSAutoScalingDescribeInstanceRefreshesAnswer *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func describeInstanceRefreshes(_ request: AWSAutoScalingDescribeInstanceRefreshesType) async throws -> AWSAutoScalingDescribeInstanceRefreshesAnswer

    Parameters

    request

    A container for the necessary parameters to execute the DescribeInstanceRefreshes service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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.

  • Gets information about the launch configurations in the account and Region.

    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.

  • Gets information about the launch configurations in the account and Region.

    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) async throws -> AWSAutoScalingLaunchConfigurationsType

    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!) async throws -> AWSAutoScalingDescribeLifecycleHookTypesAnswer

    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.

  • Gets information about 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.

  • Gets information about 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) async throws -> AWSAutoScalingDescribeLifecycleHooksAnswer

    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.

  • Gets information about the load balancer target groups for the specified Auto Scaling group.

    To determine the availability of registered instances, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn’t enter the InService state.

    Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

    For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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, AWSAutoScalingErrorInvalidNextToken.

  • Gets information about the load balancer target groups for the specified Auto Scaling group.

    To determine the availability of registered instances, use the State element in the response. When you attach a target group to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the target group. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the target group is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the target group doesn’t enter the InService state.

    Target groups also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your target group state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

    For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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) async throws -> AWSAutoScalingDescribeLoadBalancerTargetGroupsResponse

    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, AWSAutoScalingErrorInvalidNextToken.

  • Gets information about the load balancers for the specified Auto Scaling group.

    This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.

    To determine the availability of registered instances, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn’t enter the InService state.

    Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

    For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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, AWSAutoScalingErrorInvalidNextToken.

  • Gets information about the load balancers for the specified Auto Scaling group.

    This operation describes only Classic Load Balancers. If you have Application Load Balancers, Network Load Balancers, or Gateway Load Balancers, use the DescribeLoadBalancerTargetGroups API instead.

    To determine the availability of registered instances, use the State element in the response. When you attach a load balancer to an Auto Scaling group, the initial State value is Adding. The state transitions to Added after all Auto Scaling instances are registered with the load balancer. If Elastic Load Balancing health checks are enabled for the Auto Scaling group, the state transitions to InService after at least one Auto Scaling instance passes the health check. When the load balancer is in the InService state, Amazon EC2 Auto Scaling can terminate and replace any instances that are reported as unhealthy. If no registered instances pass the health checks, the load balancer doesn’t enter the InService state.

    Load balancers also have an InService state if you attach them in the CreateAutoScalingGroup API call. If your load balancer state is InService, but it is not working properly, check the scaling activities by calling DescribeScalingActivities and take any corrective actions necessary.

    For help with failed health checks, see Troubleshooting Amazon EC2 Auto Scaling: Health checks in the Amazon EC2 Auto Scaling User Guide. For more information, see Elastic Load Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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) async throws -> AWSAutoScalingDescribeLoadBalancersResponse

    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, AWSAutoScalingErrorInvalidNextToken.

  • Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

    The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling the EnableMetricsCollection API.

    See

    AWSRequest

    See

    AWSAutoScalingDescribeMetricCollectionTypesAnswer

    Declaration

    Objective-C

    - (id)describeMetricCollectionTypes:(id)request;

    Swift

    func describeMetricCollectionTypes(_ request: Any!) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeMetricCollectionTypes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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 the EnableMetricsCollection API.

    See

    AWSRequest

    See

    AWSAutoScalingDescribeMetricCollectionTypesAnswer

    Declaration

    Objective-C

    - (void)describeMetricCollectionTypes:(id)request
                    completionHandler:
                        (void (^_Nullable)(
                            AWSAutoScalingDescribeMetricCollectionTypesAnswer
                                *_Nullable,
                            NSError *_Nullable))completionHandler;

    Swift

    func describeMetricCollectionTypes(_ request: Any!) async throws -> AWSAutoScalingDescribeMetricCollectionTypesAnswer

    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.

  • Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

    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.

  • Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.

    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) async throws -> AWSAutoScalingDescribeNotificationConfigurationsAnswer

    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.

  • Gets information about the scaling policies in the account and Region.

    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.

  • Gets information about the scaling policies in the account and Region.

    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) async throws -> AWSAutoScalingPoliciesType

    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.

  • Gets information about the scaling activities in the account and Region.

    When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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.

  • Gets information about the scaling activities in the account and Region.

    When scaling events occur, you see a record of the scaling activity in the scaling activities. For more information, see Verifying a scaling activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

    If the scaling event succeeds, the value of the StatusCode element in the response is Successful. If an attempt to launch instances failed, the StatusCode value is Failed or Cancelled and the StatusMessage element in the response indicates the cause of the failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    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) async throws -> AWSAutoScalingActivitiesType

    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 the ResumeProcesses and SuspendProcesses APIs.

    See

    AWSRequest

    See

    AWSAutoScalingProcessesType

    Declaration

    Objective-C

    - (id)describeScalingProcessTypes:(id)request;

    Swift

    func describeProcessTypes(_ request: Any!) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeScalingProcessTypes service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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 the ResumeProcesses and SuspendProcesses APIs.

    See

    AWSRequest

    See

    AWSAutoScalingProcessesType

    Declaration

    Objective-C

    - (void)describeScalingProcessTypes:(id)request
                  completionHandler:
                      (void (^_Nullable)(AWSAutoScalingProcessesType *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func describeProcessTypes(_ request: Any!) async throws -> AWSAutoScalingProcessesType

    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.

  • Gets information about the scheduled actions that haven’t run or that have not reached their end time.

    To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.

    See

    AWSAutoScalingDescribeScheduledActionsType

    See

    AWSAutoScalingScheduledActionsType

    Declaration

    Objective-C

    - (id)describeScheduledActions:
    (nonnull AWSAutoScalingDescribeScheduledActionsType *)request;

    Swift

    func describeScheduledActions(_ request: AWSAutoScalingDescribeScheduledActionsType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeScheduledActions service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingScheduledActionsType. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorInvalidNextToken, AWSAutoScalingErrorResourceContention.

  • Gets information about the scheduled actions that haven’t run or that have not reached their end time.

    To describe the scaling activities for scheduled actions that have already run, call the DescribeScalingActivities API.

    See

    AWSAutoScalingDescribeScheduledActionsType

    See

    AWSAutoScalingScheduledActionsType

    Declaration

    Objective-C

    - (void)
    describeScheduledActions:
        (nonnull AWSAutoScalingDescribeScheduledActionsType *)request
           completionHandler:
               (void (^_Nullable)(AWSAutoScalingScheduledActionsType *_Nullable,
                                  NSError *_Nullable))completionHandler;

    Swift

    func describeScheduledActions(_ request: AWSAutoScalingDescribeScheduledActionsType) async throws -> AWSAutoScalingScheduledActionsType

    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.

    For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDescribeTagsType

    See

    AWSAutoScalingTagsType

    Declaration

    Objective-C

    - (id)describeTags:(nonnull AWSAutoScalingDescribeTagsType *)request;

    Swift

    func describeTags(_ request: AWSAutoScalingDescribeTagsType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeTags service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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.

    For more information, see Tagging Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDescribeTagsType

    See

    AWSAutoScalingTagsType

    Declaration

    Objective-C

    - (void)describeTags:(nonnull AWSAutoScalingDescribeTagsType *)request
    completionHandler:(void (^_Nullable)(AWSAutoScalingTagsType *_Nullable,
                                         NSError *_Nullable))completionHandler;

    Swift

    func describeTags(_ request: AWSAutoScalingDescribeTagsType) async throws -> AWSAutoScalingTagsType

    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!) async throws -> AWSAutoScalingDescribeTerminationPolicyTypesAnswer

    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.

  • Gets information about a warm pool and its instances.

    For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDescribeWarmPoolType

    See

    AWSAutoScalingDescribeWarmPoolAnswer

    Declaration

    Objective-C

    - (id)describeWarmPool:(nonnull AWSAutoScalingDescribeWarmPoolType *)request;

    Swift

    func describeWarmPool(_ request: AWSAutoScalingDescribeWarmPoolType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DescribeWarmPool service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingDescribeWarmPoolAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorInvalidNextToken, AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention.

  • Gets information about a warm pool and its instances.

    For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingDescribeWarmPoolType

    See

    AWSAutoScalingDescribeWarmPoolAnswer

    Declaration

    Objective-C

    - (void)describeWarmPool:(nonnull AWSAutoScalingDescribeWarmPoolType *)request
       completionHandler:
           (void (^_Nullable)(AWSAutoScalingDescribeWarmPoolAnswer *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func describeWarmPool(_ request: AWSAutoScalingDescribeWarmPoolType) async throws -> AWSAutoScalingDescribeWarmPoolAnswer

    Parameters

    request

    A container for the necessary parameters to execute the DescribeWarmPool 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, AWSAutoScalingErrorLimitExceeded, 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) async throws -> AWSAutoScalingDetachInstancesAnswer

    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) async throws -> AWSAutoScalingDetachLoadBalancerTargetGroupsResultType

    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, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

    When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

    See

    AWSAutoScalingDetachLoadBalancersType

    See

    AWSAutoScalingDetachLoadBalancersResultType

    Declaration

    Objective-C

    - (id)detachLoadBalancers:
    (nonnull AWSAutoScalingDetachLoadBalancersType *)request;

    Swift

    func detachLoadBalancers(_ request: AWSAutoScalingDetachLoadBalancersType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the DetachLoadBalancers service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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, Network Load Balancers, or Gateway Load Balancers, use the DetachLoadBalancerTargetGroups API instead.

    When you detach a load balancer, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using the DescribeLoadBalancers API call. The instances remain running.

    See

    AWSAutoScalingDetachLoadBalancersType

    See

    AWSAutoScalingDetachLoadBalancersResultType

    Declaration

    Objective-C

    - (void)detachLoadBalancers:
            (nonnull AWSAutoScalingDetachLoadBalancersType *)request
          completionHandler:
              (void (^_Nullable)(
                  AWSAutoScalingDetachLoadBalancersResultType *_Nullable,
                  NSError *_Nullable))completionHandler;

    Swift

    func detachLoadBalancers(_ request: AWSAutoScalingDetachLoadBalancersType) async throws -> AWSAutoScalingDetachLoadBalancersResultType

    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) async throws

    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 CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingEnableMetricsCollectionQuery

    Declaration

    Objective-C

    - (id)enableMetricsCollection:
    (nonnull AWSAutoScalingEnableMetricsCollectionQuery *)request;

    Swift

    func enableMetricsCollection(_ request: AWSAutoScalingEnableMetricsCollectionQuery) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the EnableMetricsCollection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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 CloudWatch metrics for your Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingEnableMetricsCollectionQuery

    Declaration

    Objective-C

    - (void)enableMetricsCollection:
            (nonnull AWSAutoScalingEnableMetricsCollectionQuery *)request
              completionHandler:
                  (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func enableMetricsCollection(_ request: AWSAutoScalingEnableMetricsCollectionQuery) async throws

    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) async throws -> AWSAutoScalingEnterStandbyAnswer

    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. This can be useful for testing the design of your scaling policy.

    See

    AWSAutoScalingExecutePolicyType

    Declaration

    Objective-C

    - (id)executePolicy:(nonnull AWSAutoScalingExecutePolicyType *)request;

    Swift

    func executePolicy(_ request: AWSAutoScalingExecutePolicyType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ExecutePolicy service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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. This can be useful for testing the design of your scaling policy.

    See

    AWSAutoScalingExecutePolicyType

    Declaration

    Objective-C

    - (void)executePolicy:(nonnull AWSAutoScalingExecutePolicyType *)request
    completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func executePolicy(_ request: AWSAutoScalingExecutePolicyType) async throws

    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) async throws -> AWSAutoScalingExitStandbyAnswer

    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.

  • Retrieves the forecast data for a predictive scaling policy.

    Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.

    A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.

    For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingGetPredictiveScalingForecastType

    See

    AWSAutoScalingGetPredictiveScalingForecastAnswer

    Declaration

    Objective-C

    - (id)getPredictiveScalingForecast:
    (nonnull AWSAutoScalingGetPredictiveScalingForecastType *)request;

    Swift

    func getPredictiveScalingForecast(_ request: AWSAutoScalingGetPredictiveScalingForecastType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the GetPredictiveScalingForecast service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingGetPredictiveScalingForecastAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceContention.

  • Retrieves the forecast data for a predictive scaling policy.

    Load forecasts are predictions of the hourly load values using historical load data from CloudWatch and an analysis of historical trends. Capacity forecasts are represented as predicted values for the minimum capacity that is needed on an hourly basis, based on the hourly load forecast.

    A minimum of 24 hours of data is required to create the initial forecasts. However, having a full 14 days of historical data results in more accurate forecasts.

    For more information, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingGetPredictiveScalingForecastType

    See

    AWSAutoScalingGetPredictiveScalingForecastAnswer

    Declaration

    Objective-C

    - (void)getPredictiveScalingForecast:
            (nonnull AWSAutoScalingGetPredictiveScalingForecastType *)request
                   completionHandler:
                       (void (^_Nullable)(
                           AWSAutoScalingGetPredictiveScalingForecastAnswer
                               *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func predictiveScalingForecast(_ request: AWSAutoScalingGetPredictiveScalingForecastType) async throws -> AWSAutoScalingGetPredictiveScalingForecastAnswer

    Parameters

    request

    A container for the necessary parameters to execute the GetPredictiveScalingForecast 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.

    Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

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

    1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

    5. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

    If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

    You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

    See

    AWSAutoScalingPutLifecycleHookType

    See

    AWSAutoScalingPutLifecycleHookAnswer

    Declaration

    Objective-C

    - (id)putLifecycleHook:(nonnull AWSAutoScalingPutLifecycleHookType *)request;

    Swift

    func putLifecycleHook(_ request: AWSAutoScalingPutLifecycleHookType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutLifecycleHook service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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.

    Lifecycle hooks let you create solutions that are aware of events in the Auto Scaling instance lifecycle, and then perform a custom action on instances when the corresponding lifecycle event occurs.

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

    1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

    5. If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state using the RecordLifecycleActionHeartbeat API call.

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.

    If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling group, the call fails.

    You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle hook, you can delete it by calling the DeleteLifecycleHook API.

    See

    AWSAutoScalingPutLifecycleHookType

    See

    AWSAutoScalingPutLifecycleHookAnswer

    Declaration

    Objective-C

    - (void)putLifecycleHook:(nonnull AWSAutoScalingPutLifecycleHookType *)request
       completionHandler:
           (void (^_Nullable)(AWSAutoScalingPutLifecycleHookAnswer *_Nullable,
                              NSError *_Nullable))completionHandler;

    Swift

    func putLifecycleHook(_ request: AWSAutoScalingPutLifecycleHookType) async throws -> AWSAutoScalingPutLifecycleHookAnswer

    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.

    If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.

    See

    AWSAutoScalingPutNotificationConfigurationType

    Declaration

    Objective-C

    - (id)putNotificationConfiguration:
    (nonnull AWSAutoScalingPutNotificationConfigurationType *)request;

    Swift

    func putNotificationConfiguration(_ request: AWSAutoScalingPutNotificationConfigurationType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutNotificationConfiguration service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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.

    If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call fails.

    See

    AWSAutoScalingPutNotificationConfigurationType

    Declaration

    Objective-C

    - (void)putNotificationConfiguration:
            (nonnull AWSAutoScalingPutNotificationConfigurationType *)request
                   completionHandler:
                       (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func putNotificationConfiguration(_ request: AWSAutoScalingPutNotificationConfigurationType) async throws

    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. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

    For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

    For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

    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. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no policies are defined, the dynamic scaling and predictive scaling features are not used.

    For more information about using dynamic scaling, see Target tracking scaling policies and Step and simple scaling policies in the Amazon EC2 Auto Scaling User Guide.

    For more information about using predictive scaling, see Predictive scaling for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    You can view the scaling policies for an Auto Scaling group using the DescribePolicies API call. If you are no longer using a scaling policy, you can delete it by calling the DeletePolicy API.

    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) async throws -> AWSAutoScalingPolicyARNType

    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.

    For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.

    You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.

    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.

    For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide.

    You can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a scheduled action, you can delete it by calling the DeleteScheduledAction API.

    See

    AWSAutoScalingPutScheduledUpdateGroupActionType

    Declaration

    Objective-C

    - (void)putScheduledUpdateGroupAction:
            (nonnull AWSAutoScalingPutScheduledUpdateGroupActionType *)request
                    completionHandler:(void (^_Nullable)(NSError *_Nullable))
                                          completionHandler;

    Swift

    func putScheduledUpdateGroupAction(_ request: AWSAutoScalingPutScheduledUpdateGroupActionType) async throws

    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.

  • Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.

    You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.

    See

    AWSAutoScalingPutWarmPoolType

    See

    AWSAutoScalingPutWarmPoolAnswer

    Declaration

    Objective-C

    - (id)putWarmPool:(nonnull AWSAutoScalingPutWarmPoolType *)request;

    Swift

    func putWarmPool(_ request: AWSAutoScalingPutWarmPoolType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the PutWarmPool service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingPutWarmPoolAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention.

  • Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

    This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.

    You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.

    See

    AWSAutoScalingPutWarmPoolType

    See

    AWSAutoScalingPutWarmPoolAnswer

    Declaration

    Objective-C

    - (void)putWarmPool:(nonnull AWSAutoScalingPutWarmPoolType *)request
    completionHandler:
        (void (^_Nullable)(AWSAutoScalingPutWarmPoolAnswer *_Nullable,
                           NSError *_Nullable))completionHandler;

    Swift

    func putWarmPool(_ request: AWSAutoScalingPutWarmPoolType) async throws -> AWSAutoScalingPutWarmPoolAnswer

    Parameters

    request

    A container for the necessary parameters to execute the PutWarmPool 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.

  • Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.

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

    1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

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

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    For more information, see Amazon EC2 Auto Scaling lifecycle hooks 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 the PutLifecycleHook API call.

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

    1. (Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.

    2. (Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.

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

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

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

    6. If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.

    For more information, see Amazon EC2 Auto Scaling lifecycle hooks 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) async throws -> AWSAutoScalingRecordLifecycleActionHeartbeatAnswer

    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 auto scaling processes, or all suspended process, for the specified Auto Scaling group.

    For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingScalingProcessQuery

    Declaration

    Objective-C

    - (id)resumeProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request;

    Swift

    func resumeProcesses(_ request: AWSAutoScalingScalingProcessQuery) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the ResumeProcesses service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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 auto scaling processes, or all suspended process, for the specified Auto Scaling group.

    For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingScalingProcessQuery

    Declaration

    Objective-C

    - (void)resumeProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request
      completionHandler:
          (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func resumeProcesses(_ request: AWSAutoScalingScalingProcessQuery) async throws

    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.

    If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

    For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingSetDesiredCapacityType

    Declaration

    Objective-C

    - (id)setDesiredCapacity:
    (nonnull AWSAutoScalingSetDesiredCapacityType *)request;

    Swift

    func setDesiredCapacity(_ request: AWSAutoScalingSetDesiredCapacityType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetDesiredCapacity service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will 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.

    If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

    For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.

    See

    AWSAutoScalingSetDesiredCapacityType

    Declaration

    Objective-C

    - (void)
    setDesiredCapacity:(nonnull AWSAutoScalingSetDesiredCapacityType *)request
     completionHandler:(void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func setDesiredCapacity(_ request: AWSAutoScalingSetDesiredCapacityType) async throws

    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) async throws

    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. This operation cannot be called on instances in a warm pool.

    For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

    If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.

    See

    AWSAutoScalingSetInstanceProtectionQuery

    See

    AWSAutoScalingSetInstanceProtectionAnswer

    Declaration

    Objective-C

    - (id)setInstanceProtection:
    (nonnull AWSAutoScalingSetInstanceProtectionQuery *)request;

    Swift

    func setInstanceProtection(_ request: AWSAutoScalingSetInstanceProtectionQuery) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SetInstanceProtection service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance 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. This operation cannot be called on instances in a warm pool.

    For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.

    If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.

    See

    AWSAutoScalingSetInstanceProtectionQuery

    See

    AWSAutoScalingSetInstanceProtectionAnswer

    Declaration

    Objective-C

    - (void)setInstanceProtection:
            (nonnull AWSAutoScalingSetInstanceProtectionQuery *)request
            completionHandler:
                (void (^_Nullable)(
                    AWSAutoScalingSetInstanceProtectionAnswer *_Nullable,
                    NSError *_Nullable))completionHandler;

    Swift

    func setInstanceProtection(_ request: AWSAutoScalingSetInstanceProtectionQuery) async throws -> AWSAutoScalingSetInstanceProtectionAnswer

    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.

  • Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.

    If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.

    See

    AWSAutoScalingStartInstanceRefreshType

    See

    AWSAutoScalingStartInstanceRefreshAnswer

    Declaration

    Objective-C

    - (id)startInstanceRefresh:
    (nonnull AWSAutoScalingStartInstanceRefreshType *)request;

    Swift

    func startInstanceRefresh(_ request: AWSAutoScalingStartInstanceRefreshType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the StartInstanceRefresh service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will contain an instance of AWSAutoScalingStartInstanceRefreshAnswer. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorLimitExceeded, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorInstanceRefreshInProgress.

  • Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.

    This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.

    If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.

    See

    AWSAutoScalingStartInstanceRefreshType

    See

    AWSAutoScalingStartInstanceRefreshAnswer

    Declaration

    Objective-C

    - (void)startInstanceRefresh:
            (nonnull AWSAutoScalingStartInstanceRefreshType *)request
           completionHandler:
               (void (^_Nullable)(
                   AWSAutoScalingStartInstanceRefreshAnswer *_Nullable,
                   NSError *_Nullable))completionHandler;

    Swift

    func startInstanceRefresh(_ request: AWSAutoScalingStartInstanceRefreshType) async throws -> AWSAutoScalingStartInstanceRefreshAnswer

    Parameters

    request

    A container for the necessary parameters to execute the StartInstanceRefresh service method.
    completionHandler

    The completion handler to call when the load request is complete. response - A response object, 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, AWSAutoScalingErrorInstanceRefreshInProgress.

  • Suspends the specified auto 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. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

    To resume processes that have been suspended, call the ResumeProcesses API.

    See

    AWSAutoScalingScalingProcessQuery

    Declaration

    Objective-C

    - (id)suspendProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request;

    Swift

    func suspendProcesses(_ request: AWSAutoScalingScalingProcessQuery) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the SuspendProcesses service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorResourceInUse, AWSAutoScalingErrorResourceContention.

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

    If you suspend either the Launch or Terminate process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.

    To resume processes that have been suspended, call the ResumeProcesses API.

    See

    AWSAutoScalingScalingProcessQuery

    Declaration

    Objective-C

    - (void)suspendProcesses:(nonnull AWSAutoScalingScalingProcessQuery *)request
       completionHandler:
           (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func suspendProcesses(_ request: AWSAutoScalingScalingProcessQuery) async throws

    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 operation cannot be called on instances in a warm pool.

    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 operation cannot be called on instances in a warm pool.

    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) async throws -> AWSAutoScalingActivityType

    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.

  • We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

    Updates the configuration for the specified Auto Scaling group.

    To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don’t specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.

    If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

    Note the following about changing DesiredCapacity, MaxSize, or MinSize:

    • If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

    • If you specify a new value for MinSize without specifying a value 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, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.

    See

    AWSAutoScalingUpdateAutoScalingGroupType

    Declaration

    Objective-C

    - (id)updateAutoScalingGroup:
    (nonnull AWSAutoScalingUpdateAutoScalingGroupType *)request;

    Swift

    func update(_ request: AWSAutoScalingUpdateAutoScalingGroupType) -> Any!

    Parameters

    request

    A container for the necessary parameters to execute the UpdateAutoScalingGroup service method.

    Return Value

    An instance of AWSTask. On successful execution, task.result will be nil. On failed execution, task.error may contain an NSError with AWSAutoScalingErrorDomain domain and the following error code: AWSAutoScalingErrorScalingActivityInProgress, AWSAutoScalingErrorResourceContention, AWSAutoScalingErrorServiceLinkedRoleFailure.

  • We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.

    Updates the configuration for the specified Auto Scaling group.

    To update an Auto Scaling group, specify the name of the group and the parameter that you want to change. Any parameters that you don’t specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.

    If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.

    Note the following about changing DesiredCapacity, MaxSize, or MinSize:

    • If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

    • If you specify a new value for MinSize without specifying a value 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, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.

    See

    AWSAutoScalingUpdateAutoScalingGroupType

    Declaration

    Objective-C

    - (void)updateAutoScalingGroup:
            (nonnull AWSAutoScalingUpdateAutoScalingGroupType *)request
             completionHandler:
                 (void (^_Nullable)(NSError *_Nullable))completionHandler;

    Swift

    func update(_ request: AWSAutoScalingUpdateAutoScalingGroupType) async throws

    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.