autoscaling/aws.sdk.kotlin.services.autoscaling/AutoScalingClient

AutoScalingClient

Amazon EC2 Auto Scaling

Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.

For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.

Types

Builder

class Builder : AbstractSdkClientBuilder<AutoScalingClient.Config, AutoScalingClient.Config.Builder, AutoScalingClient>

Companion

object Companion : AbstractAwsSdkClientFactory<AutoScalingClient.Config, AutoScalingClient.Config.Builder, AutoScalingClient, AutoScalingClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: AutoScalingClient.Config

AutoScalingClient's configuration

Functions

attachInstances

abstract suspend fun attachInstances(input: AttachInstancesRequest): AttachInstancesResponse

Attaches one or more EC2 instances to the specified Auto Scaling group.

attachLoadBalancers

abstract suspend fun attachLoadBalancers(input: AttachLoadBalancersRequest): AttachLoadBalancersResponse

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancers. You can use both the original AttachLoadBalancers API operation and AttachTrafficSources on the same Auto Scaling group.

attachLoadBalancerTargetGroups

abstract suspend fun attachLoadBalancerTargetGroups(input: AttachLoadBalancerTargetGroupsRequest): AttachLoadBalancerTargetGroupsResponse

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group.

attachTrafficSources

abstract suspend fun attachTrafficSources(input: AttachTrafficSourcesRequest): AttachTrafficSourcesResponse

Attaches one or more traffic sources to the specified Auto Scaling group.

batchDeleteScheduledAction

abstract suspend fun batchDeleteScheduledAction(input: BatchDeleteScheduledActionRequest): BatchDeleteScheduledActionResponse

Deletes one or more scheduled actions for the specified Auto Scaling group.

batchPutScheduledUpdateGroupAction

abstract suspend fun batchPutScheduledUpdateGroupAction(input: BatchPutScheduledUpdateGroupActionRequest): BatchPutScheduledUpdateGroupActionResponse

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

cancelInstanceRefresh

abstract suspend fun cancelInstanceRefresh(input: CancelInstanceRefreshRequest): CancelInstanceRefreshResponse

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

completeLifecycleAction

abstract suspend fun completeLifecycleAction(input: CompleteLifecycleActionRequest): CompleteLifecycleActionResponse

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

createAutoScalingGroup

abstract suspend fun createAutoScalingGroup(input: CreateAutoScalingGroupRequest): CreateAutoScalingGroupResponse

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

createLaunchConfiguration

abstract suspend fun createLaunchConfiguration(input: CreateLaunchConfigurationRequest): CreateLaunchConfigurationResponse

Creates a launch configuration.

createOrUpdateTags

abstract suspend fun createOrUpdateTags(input: CreateOrUpdateTagsRequest): CreateOrUpdateTagsResponse

Creates or updates tags for the specified Auto Scaling group.

deleteAutoScalingGroup

abstract suspend fun deleteAutoScalingGroup(input: DeleteAutoScalingGroupRequest): DeleteAutoScalingGroupResponse

Deletes the specified Auto Scaling group.

deleteLaunchConfiguration

abstract suspend fun deleteLaunchConfiguration(input: DeleteLaunchConfigurationRequest): DeleteLaunchConfigurationResponse

Deletes the specified launch configuration.

deleteLifecycleHook

abstract suspend fun deleteLifecycleHook(input: DeleteLifecycleHookRequest): DeleteLifecycleHookResponse

Deletes the specified lifecycle hook.

deleteNotificationConfiguration

abstract suspend fun deleteNotificationConfiguration(input: DeleteNotificationConfigurationRequest): DeleteNotificationConfigurationResponse

Deletes the specified notification.

deletePolicy

abstract suspend fun deletePolicy(input: DeletePolicyRequest): DeletePolicyResponse

Deletes the specified scaling policy.

deleteScheduledAction

abstract suspend fun deleteScheduledAction(input: DeleteScheduledActionRequest): DeleteScheduledActionResponse

Deletes the specified scheduled action.

deleteTags

abstract suspend fun deleteTags(input: DeleteTagsRequest): DeleteTagsResponse

Deletes the specified tags.

deleteWarmPool

abstract suspend fun deleteWarmPool(input: DeleteWarmPoolRequest): DeleteWarmPoolResponse

Deletes the warm pool for the specified Auto Scaling group.

describeAccountLimits

abstract suspend fun describeAccountLimits(input: DescribeAccountLimitsRequest = DescribeAccountLimitsRequest { }): DescribeAccountLimitsResponse

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

describeAdjustmentTypes

abstract suspend fun describeAdjustmentTypes(input: DescribeAdjustmentTypesRequest = DescribeAdjustmentTypesRequest { }): DescribeAdjustmentTypesResponse

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

describeAutoScalingGroups

abstract suspend fun describeAutoScalingGroups(input: DescribeAutoScalingGroupsRequest = DescribeAutoScalingGroupsRequest { }): DescribeAutoScalingGroupsResponse

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

describeAutoScalingInstances

abstract suspend fun describeAutoScalingInstances(input: DescribeAutoScalingInstancesRequest = DescribeAutoScalingInstancesRequest { }): DescribeAutoScalingInstancesResponse

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

describeAutoScalingNotificationTypes

abstract suspend fun describeAutoScalingNotificationTypes(input: DescribeAutoScalingNotificationTypesRequest = DescribeAutoScalingNotificationTypesRequest { }): DescribeAutoScalingNotificationTypesResponse

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

describeInstanceRefreshes

abstract suspend fun describeInstanceRefreshes(input: DescribeInstanceRefreshesRequest): DescribeInstanceRefreshesResponse

Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.

describeLaunchConfigurations

abstract suspend fun describeLaunchConfigurations(input: DescribeLaunchConfigurationsRequest = DescribeLaunchConfigurationsRequest { }): DescribeLaunchConfigurationsResponse

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

describeLifecycleHooks

abstract suspend fun describeLifecycleHooks(input: DescribeLifecycleHooksRequest): DescribeLifecycleHooksResponse

Gets information about the lifecycle hooks for the specified Auto Scaling group.

describeLifecycleHookTypes

abstract suspend fun describeLifecycleHookTypes(input: DescribeLifecycleHookTypesRequest = DescribeLifecycleHookTypesRequest { }): DescribeLifecycleHookTypesResponse

Describes the available types of lifecycle hooks.

describeLoadBalancers

abstract suspend fun describeLoadBalancers(input: DescribeLoadBalancersRequest): DescribeLoadBalancersResponse

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancers. You can use both the original DescribeLoadBalancers API operation and DescribeTrafficSources on the same Auto Scaling group.

describeLoadBalancerTargetGroups

abstract suspend fun describeLoadBalancerTargetGroups(input: DescribeLoadBalancerTargetGroupsRequest): DescribeLoadBalancerTargetGroupsResponse

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DescribeLoadBalancerTargetGroups. You can use both the original DescribeLoadBalancerTargetGroups API operation and DescribeTrafficSources on the same Auto Scaling group.

describeMetricCollectionTypes

abstract suspend fun describeMetricCollectionTypes(input: DescribeMetricCollectionTypesRequest = DescribeMetricCollectionTypesRequest { }): DescribeMetricCollectionTypesResponse

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

describeNotificationConfigurations

abstract suspend fun describeNotificationConfigurations(input: DescribeNotificationConfigurationsRequest = DescribeNotificationConfigurationsRequest { }): DescribeNotificationConfigurationsResponse

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

describePolicies

abstract suspend fun describePolicies(input: DescribePoliciesRequest = DescribePoliciesRequest { }): DescribePoliciesResponse

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

describeScalingActivities

abstract suspend fun describeScalingActivities(input: DescribeScalingActivitiesRequest = DescribeScalingActivitiesRequest { }): DescribeScalingActivitiesResponse

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

describeScalingProcessTypes

abstract suspend fun describeScalingProcessTypes(input: DescribeScalingProcessTypesRequest = DescribeScalingProcessTypesRequest { }): DescribeScalingProcessTypesResponse

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

describeScheduledActions

abstract suspend fun describeScheduledActions(input: DescribeScheduledActionsRequest = DescribeScheduledActionsRequest { }): DescribeScheduledActionsResponse

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

describeTags

abstract suspend fun describeTags(input: DescribeTagsRequest = DescribeTagsRequest { }): DescribeTagsResponse

Describes the specified tags.

describeTerminationPolicyTypes

abstract suspend fun describeTerminationPolicyTypes(input: DescribeTerminationPolicyTypesRequest = DescribeTerminationPolicyTypesRequest { }): DescribeTerminationPolicyTypesResponse

Describes the termination policies supported by Amazon EC2 Auto Scaling.

describeTrafficSources

abstract suspend fun describeTrafficSources(input: DescribeTrafficSourcesRequest): DescribeTrafficSourcesResponse

Gets information about the traffic sources for the specified Auto Scaling group.

describeWarmPool

abstract suspend fun describeWarmPool(input: DescribeWarmPoolRequest): DescribeWarmPoolResponse

Gets information about a warm pool and its instances.

detachInstances

abstract suspend fun detachInstances(input: DetachInstancesRequest): DetachInstancesResponse

Removes one or more instances from the specified Auto Scaling group.

detachLoadBalancers

abstract suspend fun detachLoadBalancers(input: DetachLoadBalancersRequest): DetachLoadBalancersResponse

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancers. You can use both the original DetachLoadBalancers API operation and DetachTrafficSources on the same Auto Scaling group.

detachLoadBalancerTargetGroups

abstract suspend fun detachLoadBalancerTargetGroups(input: DetachLoadBalancerTargetGroupsRequest): DetachLoadBalancerTargetGroupsResponse

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group.

detachTrafficSources

abstract suspend fun detachTrafficSources(input: DetachTrafficSourcesRequest): DetachTrafficSourcesResponse

Detaches one or more traffic sources from the specified Auto Scaling group.

disableMetricsCollection

abstract suspend fun disableMetricsCollection(input: DisableMetricsCollectionRequest): DisableMetricsCollectionResponse

Disables group metrics collection for the specified Auto Scaling group.

enableMetricsCollection

abstract suspend fun enableMetricsCollection(input: EnableMetricsCollectionRequest): EnableMetricsCollectionResponse

Enables group metrics collection for the specified Auto Scaling group.

enterStandby

abstract suspend fun enterStandby(input: EnterStandbyRequest): EnterStandbyResponse

Moves the specified instances into the standby state.

executePolicy

abstract suspend fun executePolicy(input: ExecutePolicyRequest): ExecutePolicyResponse

Executes the specified policy. This can be useful for testing the design of your scaling policy.

exitStandby

abstract suspend fun exitStandby(input: ExitStandbyRequest): ExitStandbyResponse

Moves the specified instances out of the standby state.

getPredictiveScalingForecast

abstract suspend fun getPredictiveScalingForecast(input: GetPredictiveScalingForecastRequest): GetPredictiveScalingForecastResponse

Retrieves the forecast data for a predictive scaling policy.

putLifecycleHook

abstract suspend fun putLifecycleHook(input: PutLifecycleHookRequest): PutLifecycleHookResponse

Creates or updates a lifecycle hook for the specified Auto Scaling group.

putNotificationConfiguration

abstract suspend fun putNotificationConfiguration(input: PutNotificationConfigurationRequest): PutNotificationConfigurationResponse

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.

putScalingPolicy

abstract suspend fun putScalingPolicy(input: PutScalingPolicyRequest): PutScalingPolicyResponse

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.

putScheduledUpdateGroupAction

abstract suspend fun putScheduledUpdateGroupAction(input: PutScheduledUpdateGroupActionRequest): PutScheduledUpdateGroupActionResponse

Creates or updates a scheduled scaling action for an Auto Scaling group.

putWarmPool

abstract suspend fun putWarmPool(input: PutWarmPoolRequest): PutWarmPoolResponse

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.

recordLifecycleActionHeartbeat

abstract suspend fun recordLifecycleActionHeartbeat(input: RecordLifecycleActionHeartbeatRequest): RecordLifecycleActionHeartbeatResponse

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.

resumeProcesses

abstract suspend fun resumeProcesses(input: ResumeProcessesRequest): ResumeProcessesResponse

Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.

rollbackInstanceRefresh

abstract suspend fun rollbackInstanceRefresh(input: RollbackInstanceRefreshRequest): RollbackInstanceRefreshResponse

Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.

setDesiredCapacity

abstract suspend fun setDesiredCapacity(input: SetDesiredCapacityRequest): SetDesiredCapacityResponse

Sets the size of the specified Auto Scaling group.

setInstanceHealth

abstract suspend fun setInstanceHealth(input: SetInstanceHealthRequest): SetInstanceHealthResponse

Sets the health status of the specified instance.

setInstanceProtection

abstract suspend fun setInstanceProtection(input: SetInstanceProtectionRequest): SetInstanceProtectionResponse

Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.

startInstanceRefresh

abstract suspend fun startInstanceRefresh(input: StartInstanceRefreshRequest): StartInstanceRefreshResponse

Starts an instance refresh.

suspendProcesses

abstract suspend fun suspendProcesses(input: SuspendProcessesRequest): SuspendProcessesResponse

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

terminateInstanceInAutoScalingGroup

abstract suspend fun terminateInstanceInAutoScalingGroup(input: TerminateInstanceInAutoScalingGroupRequest): TerminateInstanceInAutoScalingGroupResponse

Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.

updateAutoScalingGroup

abstract suspend fun updateAutoScalingGroup(input: UpdateAutoScalingGroupRequest): UpdateAutoScalingGroupResponse

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

Inherited functions

attachInstances

inline suspend fun AutoScalingClient.attachInstances(crossinline block: AttachInstancesRequest.Builder.() -> Unit): AttachInstancesResponse

Attaches one or more EC2 instances to the specified Auto Scaling group.

attachLoadBalancers

inline suspend fun AutoScalingClient.attachLoadBalancers(crossinline block: AttachLoadBalancersRequest.Builder.() -> Unit): AttachLoadBalancersResponse

attachLoadBalancerTargetGroups

inline suspend fun AutoScalingClient.attachLoadBalancerTargetGroups(crossinline block: AttachLoadBalancerTargetGroupsRequest.Builder.() -> Unit): AttachLoadBalancerTargetGroupsResponse

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types. We recommend using AttachTrafficSources to simplify how you manage traffic sources. However, we continue to support AttachLoadBalancerTargetGroups. You can use both the original AttachLoadBalancerTargetGroups API operation and AttachTrafficSources on the same Auto Scaling group.

attachTrafficSources

inline suspend fun AutoScalingClient.attachTrafficSources(crossinline block: AttachTrafficSourcesRequest.Builder.() -> Unit): AttachTrafficSourcesResponse

Attaches one or more traffic sources to the specified Auto Scaling group.

batchDeleteScheduledAction

inline suspend fun AutoScalingClient.batchDeleteScheduledAction(crossinline block: BatchDeleteScheduledActionRequest.Builder.() -> Unit): BatchDeleteScheduledActionResponse

Deletes one or more scheduled actions for the specified Auto Scaling group.

batchPutScheduledUpdateGroupAction

inline suspend fun AutoScalingClient.batchPutScheduledUpdateGroupAction(crossinline block: BatchPutScheduledUpdateGroupActionRequest.Builder.() -> Unit): BatchPutScheduledUpdateGroupActionResponse

Creates or updates one or more scheduled scaling actions for an Auto Scaling group.

cancelInstanceRefresh

inline suspend fun AutoScalingClient.cancelInstanceRefresh(crossinline block: CancelInstanceRefreshRequest.Builder.() -> Unit): CancelInstanceRefreshResponse

Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error occurs.

expect abstract fun close()

completeLifecycleAction

inline suspend fun AutoScalingClient.completeLifecycleAction(crossinline block: CompleteLifecycleActionRequest.Builder.() -> Unit): CompleteLifecycleActionResponse

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

createAutoScalingGroup

inline suspend fun AutoScalingClient.createAutoScalingGroup(crossinline block: CreateAutoScalingGroupRequest.Builder.() -> Unit): CreateAutoScalingGroupResponse

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

createLaunchConfiguration

inline suspend fun AutoScalingClient.createLaunchConfiguration(crossinline block: CreateLaunchConfigurationRequest.Builder.() -> Unit): CreateLaunchConfigurationResponse

Creates a launch configuration.

createOrUpdateTags

inline suspend fun AutoScalingClient.createOrUpdateTags(crossinline block: CreateOrUpdateTagsRequest.Builder.() -> Unit): CreateOrUpdateTagsResponse

Creates or updates tags for the specified Auto Scaling group.

deleteAutoScalingGroup

inline suspend fun AutoScalingClient.deleteAutoScalingGroup(crossinline block: DeleteAutoScalingGroupRequest.Builder.() -> Unit): DeleteAutoScalingGroupResponse

Deletes the specified Auto Scaling group.

deleteLaunchConfiguration

inline suspend fun AutoScalingClient.deleteLaunchConfiguration(crossinline block: DeleteLaunchConfigurationRequest.Builder.() -> Unit): DeleteLaunchConfigurationResponse

Deletes the specified launch configuration.

deleteLifecycleHook

inline suspend fun AutoScalingClient.deleteLifecycleHook(crossinline block: DeleteLifecycleHookRequest.Builder.() -> Unit): DeleteLifecycleHookResponse

Deletes the specified lifecycle hook.

deleteNotificationConfiguration

inline suspend fun AutoScalingClient.deleteNotificationConfiguration(crossinline block: DeleteNotificationConfigurationRequest.Builder.() -> Unit): DeleteNotificationConfigurationResponse

Deletes the specified notification.

deletePolicy

inline suspend fun AutoScalingClient.deletePolicy(crossinline block: DeletePolicyRequest.Builder.() -> Unit): DeletePolicyResponse

Deletes the specified scaling policy.

deleteScheduledAction

inline suspend fun AutoScalingClient.deleteScheduledAction(crossinline block: DeleteScheduledActionRequest.Builder.() -> Unit): DeleteScheduledActionResponse

Deletes the specified scheduled action.

deleteTags

inline suspend fun AutoScalingClient.deleteTags(crossinline block: DeleteTagsRequest.Builder.() -> Unit): DeleteTagsResponse

Deletes the specified tags.

deleteWarmPool

inline suspend fun AutoScalingClient.deleteWarmPool(crossinline block: DeleteWarmPoolRequest.Builder.() -> Unit): DeleteWarmPoolResponse

Deletes the warm pool for the specified Auto Scaling group.

describeAccountLimits

inline suspend fun AutoScalingClient.describeAccountLimits(crossinline block: DescribeAccountLimitsRequest.Builder.() -> Unit): DescribeAccountLimitsResponse

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

describeAdjustmentTypes

inline suspend fun AutoScalingClient.describeAdjustmentTypes(crossinline block: DescribeAdjustmentTypesRequest.Builder.() -> Unit): DescribeAdjustmentTypesResponse

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

describeAutoScalingGroups

inline suspend fun AutoScalingClient.describeAutoScalingGroups(crossinline block: DescribeAutoScalingGroupsRequest.Builder.() -> Unit): DescribeAutoScalingGroupsResponse

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

describeAutoScalingGroupsPaginated

fun AutoScalingClient.describeAutoScalingGroupsPaginated(initialRequest: DescribeAutoScalingGroupsRequest = DescribeAutoScalingGroupsRequest { }): Flow<DescribeAutoScalingGroupsResponse>

fun AutoScalingClient.describeAutoScalingGroupsPaginated(block: DescribeAutoScalingGroupsRequest.Builder.() -> Unit): Flow<DescribeAutoScalingGroupsResponse>

Paginate over DescribeAutoScalingGroupsResponse results.

describeAutoScalingInstances

inline suspend fun AutoScalingClient.describeAutoScalingInstances(crossinline block: DescribeAutoScalingInstancesRequest.Builder.() -> Unit): DescribeAutoScalingInstancesResponse

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

describeAutoScalingInstancesPaginated

fun AutoScalingClient.describeAutoScalingInstancesPaginated(initialRequest: DescribeAutoScalingInstancesRequest = DescribeAutoScalingInstancesRequest { }): Flow<DescribeAutoScalingInstancesResponse>

fun AutoScalingClient.describeAutoScalingInstancesPaginated(block: DescribeAutoScalingInstancesRequest.Builder.() -> Unit): Flow<DescribeAutoScalingInstancesResponse>

Paginate over DescribeAutoScalingInstancesResponse results.

describeAutoScalingNotificationTypes

inline suspend fun AutoScalingClient.describeAutoScalingNotificationTypes(crossinline block: DescribeAutoScalingNotificationTypesRequest.Builder.() -> Unit): DescribeAutoScalingNotificationTypesResponse

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

describeInstanceRefreshes

inline suspend fun AutoScalingClient.describeInstanceRefreshes(crossinline block: DescribeInstanceRefreshesRequest.Builder.() -> Unit): DescribeInstanceRefreshesResponse

Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.

describeInstanceRefreshesPaginated

fun AutoScalingClient.describeInstanceRefreshesPaginated(initialRequest: DescribeInstanceRefreshesRequest): Flow<DescribeInstanceRefreshesResponse>

fun AutoScalingClient.describeInstanceRefreshesPaginated(block: DescribeInstanceRefreshesRequest.Builder.() -> Unit): Flow<DescribeInstanceRefreshesResponse>

Paginate over DescribeInstanceRefreshesResponse results.

describeLaunchConfigurations

inline suspend fun AutoScalingClient.describeLaunchConfigurations(crossinline block: DescribeLaunchConfigurationsRequest.Builder.() -> Unit): DescribeLaunchConfigurationsResponse

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

describeLaunchConfigurationsPaginated

fun AutoScalingClient.describeLaunchConfigurationsPaginated(initialRequest: DescribeLaunchConfigurationsRequest = DescribeLaunchConfigurationsRequest { }): Flow<DescribeLaunchConfigurationsResponse>

fun AutoScalingClient.describeLaunchConfigurationsPaginated(block: DescribeLaunchConfigurationsRequest.Builder.() -> Unit): Flow<DescribeLaunchConfigurationsResponse>

Paginate over DescribeLaunchConfigurationsResponse results.

describeLifecycleHooks

inline suspend fun AutoScalingClient.describeLifecycleHooks(crossinline block: DescribeLifecycleHooksRequest.Builder.() -> Unit): DescribeLifecycleHooksResponse

Gets information about the lifecycle hooks for the specified Auto Scaling group.

describeLifecycleHookTypes

inline suspend fun AutoScalingClient.describeLifecycleHookTypes(crossinline block: DescribeLifecycleHookTypesRequest.Builder.() -> Unit): DescribeLifecycleHookTypesResponse

Describes the available types of lifecycle hooks.

describeLoadBalancers

inline suspend fun AutoScalingClient.describeLoadBalancers(crossinline block: DescribeLoadBalancersRequest.Builder.() -> Unit): DescribeLoadBalancersResponse

describeLoadBalancersPaginated

fun AutoScalingClient.describeLoadBalancersPaginated(initialRequest: DescribeLoadBalancersRequest): Flow<DescribeLoadBalancersResponse>

fun AutoScalingClient.describeLoadBalancersPaginated(block: DescribeLoadBalancersRequest.Builder.() -> Unit): Flow<DescribeLoadBalancersResponse>

Paginate over DescribeLoadBalancersResponse results.

describeLoadBalancerTargetGroups

inline suspend fun AutoScalingClient.describeLoadBalancerTargetGroups(crossinline block: DescribeLoadBalancerTargetGroupsRequest.Builder.() -> Unit): DescribeLoadBalancerTargetGroupsResponse

describeLoadBalancerTargetGroupsPaginated

fun AutoScalingClient.describeLoadBalancerTargetGroupsPaginated(initialRequest: DescribeLoadBalancerTargetGroupsRequest): Flow<DescribeLoadBalancerTargetGroupsResponse>

fun AutoScalingClient.describeLoadBalancerTargetGroupsPaginated(block: DescribeLoadBalancerTargetGroupsRequest.Builder.() -> Unit): Flow<DescribeLoadBalancerTargetGroupsResponse>

Paginate over DescribeLoadBalancerTargetGroupsResponse results.

describeMetricCollectionTypes

inline suspend fun AutoScalingClient.describeMetricCollectionTypes(crossinline block: DescribeMetricCollectionTypesRequest.Builder.() -> Unit): DescribeMetricCollectionTypesResponse

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.

describeNotificationConfigurations

inline suspend fun AutoScalingClient.describeNotificationConfigurations(crossinline block: DescribeNotificationConfigurationsRequest.Builder.() -> Unit): DescribeNotificationConfigurationsResponse

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

describeNotificationConfigurationsPaginated

fun AutoScalingClient.describeNotificationConfigurationsPaginated(initialRequest: DescribeNotificationConfigurationsRequest = DescribeNotificationConfigurationsRequest { }): Flow<DescribeNotificationConfigurationsResponse>

fun AutoScalingClient.describeNotificationConfigurationsPaginated(block: DescribeNotificationConfigurationsRequest.Builder.() -> Unit): Flow<DescribeNotificationConfigurationsResponse>

Paginate over DescribeNotificationConfigurationsResponse results.

describePolicies

inline suspend fun AutoScalingClient.describePolicies(crossinline block: DescribePoliciesRequest.Builder.() -> Unit): DescribePoliciesResponse

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

describePoliciesPaginated

fun AutoScalingClient.describePoliciesPaginated(initialRequest: DescribePoliciesRequest = DescribePoliciesRequest { }): Flow<DescribePoliciesResponse>

fun AutoScalingClient.describePoliciesPaginated(block: DescribePoliciesRequest.Builder.() -> Unit): Flow<DescribePoliciesResponse>

Paginate over DescribePoliciesResponse results.

describeScalingActivities

inline suspend fun AutoScalingClient.describeScalingActivities(crossinline block: DescribeScalingActivitiesRequest.Builder.() -> Unit): DescribeScalingActivitiesResponse

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

describeScalingActivitiesPaginated

fun AutoScalingClient.describeScalingActivitiesPaginated(initialRequest: DescribeScalingActivitiesRequest = DescribeScalingActivitiesRequest { }): Flow<DescribeScalingActivitiesResponse>

fun AutoScalingClient.describeScalingActivitiesPaginated(block: DescribeScalingActivitiesRequest.Builder.() -> Unit): Flow<DescribeScalingActivitiesResponse>

Paginate over DescribeScalingActivitiesResponse results.

describeScalingProcessTypes

inline suspend fun AutoScalingClient.describeScalingProcessTypes(crossinline block: DescribeScalingProcessTypesRequest.Builder.() -> Unit): DescribeScalingProcessTypesResponse

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

describeScheduledActions

inline suspend fun AutoScalingClient.describeScheduledActions(crossinline block: DescribeScheduledActionsRequest.Builder.() -> Unit): DescribeScheduledActionsResponse

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

describeScheduledActionsPaginated

fun AutoScalingClient.describeScheduledActionsPaginated(initialRequest: DescribeScheduledActionsRequest = DescribeScheduledActionsRequest { }): Flow<DescribeScheduledActionsResponse>

fun AutoScalingClient.describeScheduledActionsPaginated(block: DescribeScheduledActionsRequest.Builder.() -> Unit): Flow<DescribeScheduledActionsResponse>

Paginate over DescribeScheduledActionsResponse results.

describeTags

inline suspend fun AutoScalingClient.describeTags(crossinline block: DescribeTagsRequest.Builder.() -> Unit): DescribeTagsResponse

Describes the specified tags.

describeTagsPaginated

fun AutoScalingClient.describeTagsPaginated(initialRequest: DescribeTagsRequest = DescribeTagsRequest { }): Flow<DescribeTagsResponse>

fun AutoScalingClient.describeTagsPaginated(block: DescribeTagsRequest.Builder.() -> Unit): Flow<DescribeTagsResponse>

Paginate over DescribeTagsResponse results.

describeTerminationPolicyTypes

inline suspend fun AutoScalingClient.describeTerminationPolicyTypes(crossinline block: DescribeTerminationPolicyTypesRequest.Builder.() -> Unit): DescribeTerminationPolicyTypesResponse

Describes the termination policies supported by Amazon EC2 Auto Scaling.

describeTrafficSources

inline suspend fun AutoScalingClient.describeTrafficSources(crossinline block: DescribeTrafficSourcesRequest.Builder.() -> Unit): DescribeTrafficSourcesResponse

Gets information about the traffic sources for the specified Auto Scaling group.

describeTrafficSourcesPaginated

fun AutoScalingClient.describeTrafficSourcesPaginated(initialRequest: DescribeTrafficSourcesRequest): Flow<DescribeTrafficSourcesResponse>

fun AutoScalingClient.describeTrafficSourcesPaginated(block: DescribeTrafficSourcesRequest.Builder.() -> Unit): Flow<DescribeTrafficSourcesResponse>

Paginate over DescribeTrafficSourcesResponse results.

describeWarmPool

inline suspend fun AutoScalingClient.describeWarmPool(crossinline block: DescribeWarmPoolRequest.Builder.() -> Unit): DescribeWarmPoolResponse

Gets information about a warm pool and its instances.

describeWarmPoolPaginated

fun AutoScalingClient.describeWarmPoolPaginated(initialRequest: DescribeWarmPoolRequest): Flow<DescribeWarmPoolResponse>

fun AutoScalingClient.describeWarmPoolPaginated(block: DescribeWarmPoolRequest.Builder.() -> Unit): Flow<DescribeWarmPoolResponse>

Paginate over DescribeWarmPoolResponse results.

detachInstances

inline suspend fun AutoScalingClient.detachInstances(crossinline block: DetachInstancesRequest.Builder.() -> Unit): DetachInstancesResponse

Removes one or more instances from the specified Auto Scaling group.

detachLoadBalancers

inline suspend fun AutoScalingClient.detachLoadBalancers(crossinline block: DetachLoadBalancersRequest.Builder.() -> Unit): DetachLoadBalancersResponse

detachLoadBalancerTargetGroups

inline suspend fun AutoScalingClient.detachLoadBalancerTargetGroups(crossinline block: DetachLoadBalancerTargetGroupsRequest.Builder.() -> Unit): DetachLoadBalancerTargetGroupsResponse

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types. We recommend using DetachTrafficSources to simplify how you manage traffic sources. However, we continue to support DetachLoadBalancerTargetGroups. You can use both the original DetachLoadBalancerTargetGroups API operation and DetachTrafficSources on the same Auto Scaling group.

detachTrafficSources

inline suspend fun AutoScalingClient.detachTrafficSources(crossinline block: DetachTrafficSourcesRequest.Builder.() -> Unit): DetachTrafficSourcesResponse

Detaches one or more traffic sources from the specified Auto Scaling group.

disableMetricsCollection

inline suspend fun AutoScalingClient.disableMetricsCollection(crossinline block: DisableMetricsCollectionRequest.Builder.() -> Unit): DisableMetricsCollectionResponse

Disables group metrics collection for the specified Auto Scaling group.

enableMetricsCollection

inline suspend fun AutoScalingClient.enableMetricsCollection(crossinline block: EnableMetricsCollectionRequest.Builder.() -> Unit): EnableMetricsCollectionResponse

Enables group metrics collection for the specified Auto Scaling group.

enterStandby

inline suspend fun AutoScalingClient.enterStandby(crossinline block: EnterStandbyRequest.Builder.() -> Unit): EnterStandbyResponse

Moves the specified instances into the standby state.

executePolicy

inline suspend fun AutoScalingClient.executePolicy(crossinline block: ExecutePolicyRequest.Builder.() -> Unit): ExecutePolicyResponse

Executes the specified policy. This can be useful for testing the design of your scaling policy.

exitStandby

inline suspend fun AutoScalingClient.exitStandby(crossinline block: ExitStandbyRequest.Builder.() -> Unit): ExitStandbyResponse

Moves the specified instances out of the standby state.

getPredictiveScalingForecast

inline suspend fun AutoScalingClient.getPredictiveScalingForecast(crossinline block: GetPredictiveScalingForecastRequest.Builder.() -> Unit): GetPredictiveScalingForecastResponse

Retrieves the forecast data for a predictive scaling policy.

putLifecycleHook

inline suspend fun AutoScalingClient.putLifecycleHook(crossinline block: PutLifecycleHookRequest.Builder.() -> Unit): PutLifecycleHookResponse

Creates or updates a lifecycle hook for the specified Auto Scaling group.

putNotificationConfiguration

inline suspend fun AutoScalingClient.putNotificationConfiguration(crossinline block: PutNotificationConfigurationRequest.Builder.() -> Unit): PutNotificationConfigurationResponse

putScalingPolicy

inline suspend fun AutoScalingClient.putScalingPolicy(crossinline block: PutScalingPolicyRequest.Builder.() -> Unit): PutScalingPolicyResponse

putScheduledUpdateGroupAction

inline suspend fun AutoScalingClient.putScheduledUpdateGroupAction(crossinline block: PutScheduledUpdateGroupActionRequest.Builder.() -> Unit): PutScheduledUpdateGroupActionResponse

Creates or updates a scheduled scaling action for an Auto Scaling group.

putWarmPool

inline suspend fun AutoScalingClient.putWarmPool(crossinline block: PutWarmPoolRequest.Builder.() -> Unit): PutWarmPoolResponse

recordLifecycleActionHeartbeat

inline suspend fun AutoScalingClient.recordLifecycleActionHeartbeat(crossinline block: RecordLifecycleActionHeartbeatRequest.Builder.() -> Unit): RecordLifecycleActionHeartbeatResponse

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.

resumeProcesses

inline suspend fun AutoScalingClient.resumeProcesses(crossinline block: ResumeProcessesRequest.Builder.() -> Unit): ResumeProcessesResponse

Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.

rollbackInstanceRefresh

inline suspend fun AutoScalingClient.rollbackInstanceRefresh(crossinline block: RollbackInstanceRefreshRequest.Builder.() -> Unit): RollbackInstanceRefreshResponse

setDesiredCapacity

inline suspend fun AutoScalingClient.setDesiredCapacity(crossinline block: SetDesiredCapacityRequest.Builder.() -> Unit): SetDesiredCapacityResponse

Sets the size of the specified Auto Scaling group.

setInstanceHealth

inline suspend fun AutoScalingClient.setInstanceHealth(crossinline block: SetInstanceHealthRequest.Builder.() -> Unit): SetInstanceHealthResponse

Sets the health status of the specified instance.

setInstanceProtection

inline suspend fun AutoScalingClient.setInstanceProtection(crossinline block: SetInstanceProtectionRequest.Builder.() -> Unit): SetInstanceProtectionResponse

Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.

startInstanceRefresh

inline suspend fun AutoScalingClient.startInstanceRefresh(crossinline block: StartInstanceRefreshRequest.Builder.() -> Unit): StartInstanceRefreshResponse

Starts an instance refresh.

suspendProcesses

inline suspend fun AutoScalingClient.suspendProcesses(crossinline block: SuspendProcessesRequest.Builder.() -> Unit): SuspendProcessesResponse

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

terminateInstanceInAutoScalingGroup

inline suspend fun AutoScalingClient.terminateInstanceInAutoScalingGroup(crossinline block: TerminateInstanceInAutoScalingGroupRequest.Builder.() -> Unit): TerminateInstanceInAutoScalingGroupResponse

Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.

updateAutoScalingGroup

inline suspend fun AutoScalingClient.updateAutoScalingGroup(crossinline block: UpdateAutoScalingGroupRequest.Builder.() -> Unit): UpdateAutoScalingGroupResponse

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

waitUntilGroupExists

suspend fun AutoScalingClient.waitUntilGroupExists(request: DescribeAutoScalingGroupsRequest = DescribeAutoScalingGroupsRequest { }): Outcome<DescribeAutoScalingGroupsResponse>

suspend fun AutoScalingClient.waitUntilGroupExists(block: DescribeAutoScalingGroupsRequest.Builder.() -> Unit): Outcome<DescribeAutoScalingGroupsResponse>

waitUntilGroupInService

suspend fun AutoScalingClient.waitUntilGroupInService(request: DescribeAutoScalingGroupsRequest = DescribeAutoScalingGroupsRequest { }): Outcome<DescribeAutoScalingGroupsResponse>

suspend fun AutoScalingClient.waitUntilGroupInService(block: DescribeAutoScalingGroupsRequest.Builder.() -> Unit): Outcome<DescribeAutoScalingGroupsResponse>

waitUntilGroupNotExists

suspend fun AutoScalingClient.waitUntilGroupNotExists(request: DescribeAutoScalingGroupsRequest = DescribeAutoScalingGroupsRequest { }): Outcome<DescribeAutoScalingGroupsResponse>

suspend fun AutoScalingClient.waitUntilGroupNotExists(block: DescribeAutoScalingGroupsRequest.Builder.() -> Unit): Outcome<DescribeAutoScalingGroupsResponse>

withConfig

fun AutoScalingClient.withConfig(block: AutoScalingClient.Config.Builder.() -> Unit): AutoScalingClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.