applicationautoscaling/aws.sdk.kotlin.services.applicationautoscaling/ApplicationAutoScalingClient

ApplicationAutoScalingClient

interface ApplicationAutoScalingClient : SdkClient

With Application Auto Scaling, you can configure automatic scaling for the following resources:

Amazon AppStream 2.0 fleets
Amazon Aurora Replicas
Amazon Comprehend document classification and entity recognizer endpoints
Amazon DynamoDB tables and global secondary indexes throughput capacity
Amazon ECS services
Amazon ElastiCache for Redis clusters (replication groups)
Amazon EMR clusters
Amazon Keyspaces (for Apache Cassandra) tables
Lambda function provisioned concurrency
Amazon Managed Streaming for Apache Kafka broker storage
Amazon Neptune clusters
Amazon SageMaker endpoint variants
Amazon SageMaker Serverless endpoint provisioned concurrency
Amazon SageMaker inference components
Spot Fleets (Amazon EC2)
Custom resources provided by your own applications or services

To learn more about Application Auto Scaling, see the Application Auto Scaling User Guide.

API Summary

The Application Auto Scaling service API includes three key sets of actions:

Register and manage scalable targets - Register Amazon Web Services or custom resources as scalable targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and retrieve information on existing scalable targets.
Configure and manage automatic scaling - Define scaling policies to dynamically scale your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve your recent scaling activity history.
Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can suspend and resume (individually or in combination) scale-out activities that are triggered by a scaling policy, scale-in activities that are triggered by a scaling policy, and scheduled scaling.

Types

Builder

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

Companion

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

Config

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

Properties

config

abstract override val config: ApplicationAutoScalingClient.Config

ApplicationAutoScalingClient's configuration

Functions

deleteScalingPolicy

abstract suspend fun deleteScalingPolicy(input: DeleteScalingPolicyRequest): DeleteScalingPolicyResponse

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

deleteScheduledAction

abstract suspend fun deleteScheduledAction(input: DeleteScheduledActionRequest): DeleteScheduledActionResponse

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

deregisterScalableTarget

abstract suspend fun deregisterScalableTarget(input: DeregisterScalableTargetRequest): DeregisterScalableTargetResponse

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.

describeScalableTargets

abstract suspend fun describeScalableTargets(input: DescribeScalableTargetsRequest): DescribeScalableTargetsResponse

Gets information about the scalable targets in the specified namespace.

describeScalingActivities

abstract suspend fun describeScalingActivities(input: DescribeScalingActivitiesRequest): DescribeScalingActivitiesResponse

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

describeScalingPolicies

abstract suspend fun describeScalingPolicies(input: DescribeScalingPoliciesRequest): DescribeScalingPoliciesResponse

Describes the Application Auto Scaling scaling policies for the specified service namespace.

describeScheduledActions

abstract suspend fun describeScheduledActions(input: DescribeScheduledActionsRequest): DescribeScheduledActionsResponse

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

Returns all the tags on the specified Application Auto Scaling scalable target.

putScalingPolicy

abstract suspend fun putScalingPolicy(input: PutScalingPolicyRequest): PutScalingPolicyResponse

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

putScheduledAction

abstract suspend fun putScheduledAction(input: PutScheduledActionRequest): PutScheduledActionResponse

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

registerScalableTarget

abstract suspend fun registerScalableTarget(input: RegisterScalableTargetRequest): RegisterScalableTargetResponse

Registers or updates a scalable target, which is the resource that you want to scale.

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds or edits tags on an Application Auto Scaling scalable target.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.

Inherited functions

expect abstract fun close()

deleteScalingPolicy

inline suspend fun ApplicationAutoScalingClient.deleteScalingPolicy(crossinline block: DeleteScalingPolicyRequest.Builder.() -> Unit): DeleteScalingPolicyResponse

Deletes the specified scaling policy for an Application Auto Scaling scalable target.

deleteScheduledAction

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

Deletes the specified scheduled action for an Application Auto Scaling scalable target.

deregisterScalableTarget

inline suspend fun ApplicationAutoScalingClient.deregisterScalableTarget(crossinline block: DeregisterScalableTargetRequest.Builder.() -> Unit): DeregisterScalableTargetResponse

Deregisters an Application Auto Scaling scalable target when you have finished using it. To see which resources have been registered, use DescribeScalableTargets.

describeScalableTargets

inline suspend fun ApplicationAutoScalingClient.describeScalableTargets(crossinline block: DescribeScalableTargetsRequest.Builder.() -> Unit): DescribeScalableTargetsResponse

Gets information about the scalable targets in the specified namespace.

describeScalableTargetsPaginated

fun ApplicationAutoScalingClient.describeScalableTargetsPaginated(initialRequest: DescribeScalableTargetsRequest): Flow<DescribeScalableTargetsResponse>

fun ApplicationAutoScalingClient.describeScalableTargetsPaginated(block: DescribeScalableTargetsRequest.Builder.() -> Unit): Flow<DescribeScalableTargetsResponse>

Paginate over DescribeScalableTargetsResponse results.

describeScalingActivities

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

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

describeScalingActivitiesPaginated

fun ApplicationAutoScalingClient.describeScalingActivitiesPaginated(initialRequest: DescribeScalingActivitiesRequest): Flow<DescribeScalingActivitiesResponse>

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

Paginate over DescribeScalingActivitiesResponse results.

describeScalingPolicies

inline suspend fun ApplicationAutoScalingClient.describeScalingPolicies(crossinline block: DescribeScalingPoliciesRequest.Builder.() -> Unit): DescribeScalingPoliciesResponse

Describes the Application Auto Scaling scaling policies for the specified service namespace.

describeScalingPoliciesPaginated

fun ApplicationAutoScalingClient.describeScalingPoliciesPaginated(initialRequest: DescribeScalingPoliciesRequest): Flow<DescribeScalingPoliciesResponse>

fun ApplicationAutoScalingClient.describeScalingPoliciesPaginated(block: DescribeScalingPoliciesRequest.Builder.() -> Unit): Flow<DescribeScalingPoliciesResponse>

Paginate over DescribeScalingPoliciesResponse results.

describeScheduledActions

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

Describes the Application Auto Scaling scheduled actions for the specified service namespace.

describeScheduledActionsPaginated

fun ApplicationAutoScalingClient.describeScheduledActionsPaginated(initialRequest: DescribeScheduledActionsRequest): Flow<DescribeScheduledActionsResponse>

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

Paginate over DescribeScheduledActionsResponse results.

listTagsForResource

inline suspend fun ApplicationAutoScalingClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns all the tags on the specified Application Auto Scaling scalable target.

putScalingPolicy

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

Creates or updates a scaling policy for an Application Auto Scaling scalable target.

putScheduledAction

inline suspend fun ApplicationAutoScalingClient.putScheduledAction(crossinline block: PutScheduledActionRequest.Builder.() -> Unit): PutScheduledActionResponse

Creates or updates a scheduled action for an Application Auto Scaling scalable target.

registerScalableTarget

inline suspend fun ApplicationAutoScalingClient.registerScalableTarget(crossinline block: RegisterScalableTargetRequest.Builder.() -> Unit): RegisterScalableTargetResponse

Registers or updates a scalable target, which is the resource that you want to scale.

tagResource

inline suspend fun ApplicationAutoScalingClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds or edits tags on an Application Auto Scaling scalable target.

untagResource

inline suspend fun ApplicationAutoScalingClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and the Application Auto Scaling scalable target.

withConfig

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

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.