We announced the upcoming end-of-support for AWS SDK for JavaScript v2.

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ApplicationAutoScaling

Inherits:

AWS.Service

Object
AWS.Service
AWS.ApplicationAutoScaling

show all

Identifier:: applicationautoscaling

API Version:: 2016-02-06

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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 inference components
Amazon SageMaker serverless endpoint provisioned concurrency
Spot Fleets (Amazon EC2)
Pool of WorkSpaces
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.

Sending a Request Using ApplicationAutoScaling

var applicationautoscaling = new AWS.ApplicationAutoScaling();
applicationautoscaling.deregisterScalableTarget(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ApplicationAutoScaling object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var applicationautoscaling = new AWS.ApplicationAutoScaling({apiVersion: '2016-02-06'});

You can also set the API version globally in AWS.config.apiVersions using the applicationautoscaling service identifier:

AWS.config.apiVersions = {
  applicationautoscaling: '2016-02-06',
  // other service API versions
};

var applicationautoscaling = new AWS.ApplicationAutoScaling();

Version:

2016-02-06

Constructor Summary collapse

new AWS.ApplicationAutoScaling(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

deleteScalingPolicy(params = {}, callback) ⇒ AWS.Request
Deletes the specified scaling policy for an Application Auto Scaling scalable target.

Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.
.
deleteScheduledAction(params = {}, callback) ⇒ AWS.Request
Deletes the specified scheduled action for an Application Auto Scaling scalable target.

For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.
.
deregisterScalableTarget(params = {}, callback) ⇒ AWS.Request
Deregisters an Application Auto Scaling scalable target when you have finished using it.
describeScalableTargets(params = {}, callback) ⇒ AWS.Request
Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.
.
describeScalingActivities(params = {}, callback) ⇒ AWS.Request
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using ResourceId and ScalableDimension.

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.
.
describeScalingPolicies(params = {}, callback) ⇒ AWS.Request
Describes the Application Auto Scaling scaling policies for the specified service namespace.

You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
.
describeScheduledActions(params = {}, callback) ⇒ AWS.Request
Describes the Application Auto Scaling scheduled actions for the specified service namespace.

You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
.
listTagsForResource(params = {}, callback) ⇒ AWS.Request
Returns all the tags on the specified Application Auto Scaling scalable target.

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.
.
putScalingPolicy(params = {}, callback) ⇒ AWS.Request
Creates or updates a scaling policy for an Application Auto Scaling scalable target.

Each scalable target is identified by a service namespace, resource ID, and scalable dimension.
putScheduledAction(params = {}, callback) ⇒ AWS.Request
Creates or updates a scheduled action for an Application Auto Scaling scalable target.
registerScalableTarget(params = {}, callback) ⇒ AWS.Request
Registers or updates a scalable target, which is the resource that you want to scale.

Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service.

When you register a new scalable target, you must specify values for the minimum and maximum capacity.
tagResource(params = {}, callback) ⇒ AWS.Request
Adds or edits tags on an Application Auto Scaling scalable target.

Each tag consists of a tag key and a tag value, which are both case-sensitive strings.
untagResource(params = {}, callback) ⇒ AWS.Request
Deletes tags from an Application Auto Scaling scalable target.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ApplicationAutoScaling(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ApplicationAutoScaling object

var applicationautoscaling = new AWS.ApplicationAutoScaling({apiVersion: '2016-02-06'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.ApplicationAutoScaling.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.ApplicationAutoScaling.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.ApplicationAutoScaling.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.
useFipsEndpoint (Boolean) —
Enables FIPS compatible endpoints. Defaults to false.
useDualstackEndpoint (Boolean) —
Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

deleteScalingPolicy(params = {}, callback) ⇒ `AWS.Request`

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

Deleting a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.

For more information, see Delete a step scaling policy and Delete a target tracking scaling policy in the Application Auto Scaling User Guide.

Service Reference:

DeleteScalingPolicy

Examples:

To delete a scaling policy


/* This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster. */

 var params = {
  PolicyName: "web-app-cpu-lt-25", 
  ResourceId: "service/default/web-app", 
  ScalableDimension: "ecs:service:DesiredCount", 
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.deleteScalingPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteScalingPolicy operation

var params = {
  PolicyName: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces /* required */
};
applicationautoscaling.deleteScalingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyName — (String)
  The name of the scaling policy.
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deleteScheduledAction(params = {}, callback) ⇒ `AWS.Request`

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

For more information, see Delete a scheduled action in the Application Auto Scaling User Guide.

Service Reference:

DeleteScheduledAction

Examples:

To delete a scheduled action


/* This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet. */

 var params = {
  ResourceId: "fleet/sample-fleet", 
  ScalableDimension: "appstream:fleet:DesiredCapacity", 
  ScheduledActionName: "my-recurring-action", 
  ServiceNamespace: "appstream"
 };
 applicationautoscaling.deleteScheduledAction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deleteScheduledAction operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ScheduledActionName: 'STRING_VALUE', /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces /* required */
};
applicationautoscaling.deleteScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ScheduledActionName — (String)
  The name of the scheduled action.
- ResourceId — (String)
  The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

deregisterScalableTarget(params = {}, callback) ⇒ `AWS.Request`

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

Note: Deregistering a scalable target deletes the scaling policies and the scheduled actions that are associated with it.

Service Reference:

DeregisterScalableTarget

Examples:

To deregister a scalable target


/* This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster. */

 var params = {
  ResourceId: "service/default/web-app", 
  ScalableDimension: "ecs:service:DesiredCount", 
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.deregisterScalableTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the deregisterScalableTarget operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces /* required */
};
applicationautoscaling.deregisterScalableTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeScalableTargets(params = {}, callback) ⇒ `AWS.Request`

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

Service Reference:

DescribeScalableTargets

Examples:

To describe scalable targets


/* This example describes the scalable targets for the ECS service namespace. */

 var params = {
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.describeScalableTargets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ScalableTargets: [
       {
      CreationTime: <Date Representation>, 
      MaxCapacity: 10, 
      MinCapacity: 1, 
      ResourceId: "service/default/web-app", 
      RoleARN: "arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService", 
      ScalableDimension: "ecs:service:DesiredCount", 
      ServiceNamespace: "ecs", 
      SuspendedState: {
       DynamicScalingInSuspended: false, 
       DynamicScalingOutSuspended: false, 
       ScheduledScalingSuspended: false
      }
     }
    ]
   }
   */
 });

Calling the describeScalableTargets operation

var params = {
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceIds: [
    'STRING_VALUE',
    /* more items */
  ],
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions
};
applicationautoscaling.describeScalableTargets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceIds — (Array<String>)
  The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- MaxResults — (Integer)
  The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
  
  If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
- NextToken — (String)
  The token for the next set of results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ScalableTargets — (Array<map>)
    The scalable targets that match the request parameters.
    
    ServiceNamespace — required — (String)
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    Possible values include:
    
    "ecs"
    
    "elasticmapreduce"
    
    "ec2"
    
    "appstream"
    
    "dynamodb"
    
    "rds"
    
    "sagemaker"
    
    "custom-resource"
    
    "comprehend"
    
    "lambda"
    
    "cassandra"
    
    "kafka"
    
    "elasticache"
    
    "neptune"
    
    "workspaces"
    
    ResourceId — required — (String)
    The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
    
    ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
    
    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
    
    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
    
    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
    
    DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
    
    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
    
    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    
    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
    
    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
    
    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
    
    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    
    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
    
    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
    
    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
    
    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
    
    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    
    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    
    ScalableDimension — required — (String)
    The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
    
    ecs:service:DesiredCount - The task count of an ECS service.
    
    elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    
    ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
    
    appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
    
    dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
    
    dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
    
    dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
    
    dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
    
    rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    
    sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
    
    custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
    
    comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
    
    comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
    
    lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    
    cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
    
    cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
    
    kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
    
    elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
    
    elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
    
    neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
    
    sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
    
    sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    
    workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    
    Possible values include:
    
    "ecs:service:DesiredCount"
    
    "ec2:spot-fleet-request:TargetCapacity"
    
    "elasticmapreduce:instancegroup:InstanceCount"
    
    "appstream:fleet:DesiredCapacity"
    
    "dynamodb:table:ReadCapacityUnits"
    
    "dynamodb:table:WriteCapacityUnits"
    
    "dynamodb:index:ReadCapacityUnits"
    
    "dynamodb:index:WriteCapacityUnits"
    
    "rds:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredInstanceCount"
    
    "custom-resource:ResourceType:Property"
    
    "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
    
    "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
    
    "lambda:function:ProvisionedConcurrency"
    
    "cassandra:table:ReadCapacityUnits"
    
    "cassandra:table:WriteCapacityUnits"
    
    "kafka:broker-storage:VolumeSize"
    
    "elasticache:replication-group:NodeGroups"
    
    "elasticache:replication-group:Replicas"
    
    "neptune:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredProvisionedConcurrency"
    
    "sagemaker:inference-component:DesiredCopyCount"
    
    "workspaces:workspacespool:DesiredUserSessions"
    
    MinCapacity — required — (Integer)
    The minimum value to scale to in response to a scale-in activity.
    
    MaxCapacity — required — (Integer)
    The maximum value to scale to in response to a scale-out activity.
    
    RoleARN — required — (String)
    The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
    
    CreationTime — required — (Date)
    The Unix timestamp for when the scalable target was created.
    
    SuspendedState — (map)
    Specifies whether the scaling activities for a scalable target are in a suspended state.
    
    DynamicScalingInSuspended — (Boolean)
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
    
    DynamicScalingOutSuspended — (Boolean)
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
    
    ScheduledScalingSuspended — (Boolean)
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
    
    ScalableTargetARN — (String)
    The ARN of the scalable target.
  - NextToken — (String)
    The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeScalingActivities(params = {}, callback) ⇒ `AWS.Request`

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

You can filter the results using ResourceId and ScalableDimension.

For information about viewing scaling activities using the Amazon Web Services CLI, see Scaling activities for Application Auto Scaling.

Service Reference:

DescribeScalingActivities

Examples:

To describe scaling activities for a scalable target


/* This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster. */

 var params = {
  ResourceId: "service/default/web-app", 
  ScalableDimension: "ecs:service:DesiredCount", 
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.describeScalingActivities(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ScalingActivities: [
       {
      ActivityId: "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399", 
      Cause: "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25", 
      Description: "Setting desired count to 1.", 
      EndTime: <Date Representation>, 
      ResourceId: "service/default/web-app", 
      ScalableDimension: "ecs:service:DesiredCount", 
      ServiceNamespace: "ecs", 
      StartTime: <Date Representation>, 
      StatusCode: "Successful", 
      StatusMessage: "Successfully set desired count to 1. Change successfully fulfilled by ecs."
     }
    ]
   }
   */
 });

Calling the describeScalingActivities operation

var params = {
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  IncludeNotScaledActivities: true || false,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE',
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions
};
applicationautoscaling.describeScalingActivities(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- MaxResults — (Integer)
  The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.
  
  If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
- NextToken — (String)
  The token for the next set of results.
- IncludeNotScaledActivities — (Boolean)
  Specifies whether to include activities that aren't scaled (not scaled activities) in the response. Not scaled activities are activities that aren't completed or started for various reasons, such as preventing infinite scaling loops. For help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ScalingActivities — (Array<map>)
    A list of scaling activity objects.
    
    ActivityId — required — (String)
    The unique identifier of the scaling activity.
    
    ServiceNamespace — required — (String)
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    Possible values include:
    
    "ecs"
    
    "elasticmapreduce"
    
    "ec2"
    
    "appstream"
    
    "dynamodb"
    
    "rds"
    
    "sagemaker"
    
    "custom-resource"
    
    "comprehend"
    
    "lambda"
    
    "cassandra"
    
    "kafka"
    
    "elasticache"
    
    "neptune"
    
    "workspaces"
    
    ResourceId — required — (String)
    The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
    
    ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
    
    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
    
    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
    
    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
    
    DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
    
    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
    
    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    
    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
    
    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
    
    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
    
    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    
    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
    
    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
    
    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
    
    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
    
    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    
    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    
    ScalableDimension — required — (String)
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    
    ecs:service:DesiredCount - The task count of an ECS service.
    
    elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    
    ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
    
    appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
    
    dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
    
    dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
    
    dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
    
    dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
    
    rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    
    sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
    
    custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
    
    comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
    
    comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
    
    lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    
    cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
    
    cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
    
    kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
    
    elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
    
    elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
    
    neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
    
    sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
    
    sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    
    workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    
    Possible values include:
    
    "ecs:service:DesiredCount"
    
    "ec2:spot-fleet-request:TargetCapacity"
    
    "elasticmapreduce:instancegroup:InstanceCount"
    
    "appstream:fleet:DesiredCapacity"
    
    "dynamodb:table:ReadCapacityUnits"
    
    "dynamodb:table:WriteCapacityUnits"
    
    "dynamodb:index:ReadCapacityUnits"
    
    "dynamodb:index:WriteCapacityUnits"
    
    "rds:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredInstanceCount"
    
    "custom-resource:ResourceType:Property"
    
    "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
    
    "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
    
    "lambda:function:ProvisionedConcurrency"
    
    "cassandra:table:ReadCapacityUnits"
    
    "cassandra:table:WriteCapacityUnits"
    
    "kafka:broker-storage:VolumeSize"
    
    "elasticache:replication-group:NodeGroups"
    
    "elasticache:replication-group:Replicas"
    
    "neptune:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredProvisionedConcurrency"
    
    "sagemaker:inference-component:DesiredCopyCount"
    
    "workspaces:workspacespool:DesiredUserSessions"
    
    Description — required — (String)
    A simple description of what action the scaling activity intends to accomplish.
    
    Cause — required — (String)
    A simple description of what caused the scaling activity to happen.
    
    StartTime — required — (Date)
    The Unix timestamp for when the scaling activity began.
    
    EndTime — (Date)
    The Unix timestamp for when the scaling activity ended.
    
    StatusCode — required — (String)
    Indicates the status of the scaling activity.
    Possible values include:
    
    "Pending"
    
    "InProgress"
    
    "Successful"
    
    "Overridden"
    
    "Unfulfilled"
    
    "Failed"
    
    StatusMessage — (String)
    A simple message about the current status of the scaling activity.
    
    Details — (String)
    The details about the scaling activity.
    
    NotScaledReasons — (Array<map>)
    Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.
    
    Code — required — (String)
    A code that represents the reason for not scaling.
    
    Valid values:
    
    AutoScalingAnticipatedFlapping
    
    TargetServicePutResourceAsUnscalable
    
    AlreadyAtMaxCapacity
    
    AlreadyAtMinCapacity
    
    AlreadyAtDesiredCapacity
    
    MaxCapacity — (Integer)
    The maximum capacity.
    
    MinCapacity — (Integer)
    The minimum capacity.
    
    CurrentCapacity — (Integer)
    The current capacity.
  - NextToken — (String)
    The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeScalingPolicies(params = {}, callback) ⇒ `AWS.Request`

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

You can filter the results using ResourceId, ScalableDimension, and PolicyNames.

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

Service Reference:

DescribeScalingPolicies

Examples:

To describe scaling policies


/* This example describes the scaling policies for the ECS service namespace. */

 var params = {
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.describeScalingPolicies(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    NextToken: "", 
    ScalingPolicies: [
       {
      Alarms: [
         {
        AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75", 
        AlarmName: "web-app-cpu-gt-75"
       }
      ], 
      CreationTime: <Date Representation>, 
      PolicyARN: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75", 
      PolicyName: "web-app-cpu-gt-75", 
      PolicyType: "StepScaling", 
      ResourceId: "service/default/web-app", 
      ScalableDimension: "ecs:service:DesiredCount", 
      ServiceNamespace: "ecs", 
      StepScalingPolicyConfiguration: {
       AdjustmentType: "PercentChangeInCapacity", 
       Cooldown: 60, 
       StepAdjustments: [
          {
         MetricIntervalLowerBound: 0, 
         ScalingAdjustment: 200
        }
       ]
      }
     }
    ]
   }
   */
 });

Calling the describeScalingPolicies operation

var params = {
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  PolicyNames: [
    'STRING_VALUE',
    /* more items */
  ],
  ResourceId: 'STRING_VALUE',
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions
};
applicationautoscaling.describeScalingPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyNames — (Array<String>)
  The names of the scaling policies to describe.
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- MaxResults — (Integer)
  The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10.
  
  If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 10 results and a NextToken value, if applicable.
- NextToken — (String)
  The token for the next set of results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ScalingPolicies — (Array<map>)
    Information about the scaling policies.
    
    PolicyARN — required — (String)
    The Amazon Resource Name (ARN) of the scaling policy.
    
    PolicyName — required — (String)
    The name of the scaling policy.
    
    ServiceNamespace — required — (String)
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    Possible values include:
    
    "ecs"
    
    "elasticmapreduce"
    
    "ec2"
    
    "appstream"
    
    "dynamodb"
    
    "rds"
    
    "sagemaker"
    
    "custom-resource"
    
    "comprehend"
    
    "lambda"
    
    "cassandra"
    
    "kafka"
    
    "elasticache"
    
    "neptune"
    
    "workspaces"
    
    ResourceId — required — (String)
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    
    ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
    
    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
    
    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
    
    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
    
    DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
    
    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
    
    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    
    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
    
    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
    
    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
    
    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    
    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
    
    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
    
    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
    
    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
    
    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    
    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    
    ScalableDimension — required — (String)
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    
    ecs:service:DesiredCount - The task count of an ECS service.
    
    elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    
    ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
    
    appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
    
    dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
    
    dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
    
    dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
    
    dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
    
    rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    
    sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
    
    custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
    
    comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
    
    comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
    
    lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    
    cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
    
    cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
    
    kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
    
    elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
    
    elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
    
    neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
    
    sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
    
    sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    
    workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    
    Possible values include:
    
    "ecs:service:DesiredCount"
    
    "ec2:spot-fleet-request:TargetCapacity"
    
    "elasticmapreduce:instancegroup:InstanceCount"
    
    "appstream:fleet:DesiredCapacity"
    
    "dynamodb:table:ReadCapacityUnits"
    
    "dynamodb:table:WriteCapacityUnits"
    
    "dynamodb:index:ReadCapacityUnits"
    
    "dynamodb:index:WriteCapacityUnits"
    
    "rds:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredInstanceCount"
    
    "custom-resource:ResourceType:Property"
    
    "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
    
    "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
    
    "lambda:function:ProvisionedConcurrency"
    
    "cassandra:table:ReadCapacityUnits"
    
    "cassandra:table:WriteCapacityUnits"
    
    "kafka:broker-storage:VolumeSize"
    
    "elasticache:replication-group:NodeGroups"
    
    "elasticache:replication-group:Replicas"
    
    "neptune:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredProvisionedConcurrency"
    
    "sagemaker:inference-component:DesiredCopyCount"
    
    "workspaces:workspacespool:DesiredUserSessions"
    
    PolicyType — required — (String)
    The scaling policy type.
    
    The following policy types are supported:
    
    TargetTrackingScaling—Not supported for Amazon EMR
    
    StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
    Possible values include:
    
    "StepScaling"
    
    "TargetTrackingScaling"
    
    StepScalingPolicyConfiguration — (map)
    A step scaling policy.
    
    AdjustmentType — (String)
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    AdjustmentType is required if you are adding a new step scaling policy configuration.
    Possible values include:
    
    "ChangeInCapacity"
    
    "PercentChangeInCapacity"
    
    "ExactCapacity"
    
    StepAdjustments — (Array<map>)
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    At least one step adjustment is required if you are adding a new step scaling policy configuration.
    
    MetricIntervalLowerBound — (Float)
    The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
    
    MetricIntervalUpperBound — (Float)
    The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
    
    The upper bound must be greater than the lower bound.
    
    ScalingAdjustment — required — (Integer)
    The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
    
    MinAdjustmentMagnitude — (Integer)
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
    
    Cooldown — (Integer)
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
    
    MetricAggregationType — (String)
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    Possible values include:
    
    "Average"
    
    "Minimum"
    
    "Maximum"
    
    TargetTrackingScalingPolicyConfiguration — (map)
    A target tracking scaling policy.
    
    TargetValue — required — (Float)
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 2³⁶⁰. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    
    Note: If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.
    
    PredefinedMetricSpecification — (map)
    A predefined metric. You can specify either a predefined metric or a customized metric.
    
    PredefinedMetricType — required — (String)
    The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
    Possible values include:
    
    "DynamoDBReadCapacityUtilization"
    
    "DynamoDBWriteCapacityUtilization"
    
    "ALBRequestCountPerTarget"
    
    "RDSReaderAverageCPUUtilization"
    
    "RDSReaderAverageDatabaseConnections"
    
    "EC2SpotFleetRequestAverageCPUUtilization"
    
    "EC2SpotFleetRequestAverageNetworkIn"
    
    "EC2SpotFleetRequestAverageNetworkOut"
    
    "SageMakerVariantInvocationsPerInstance"
    
    "ECSServiceAverageCPUUtilization"
    
    "ECSServiceAverageMemoryUtilization"
    
    "AppStreamAverageCapacityUtilization"
    
    "ComprehendInferenceUtilization"
    
    "LambdaProvisionedConcurrencyUtilization"
    
    "CassandraReadCapacityUtilization"
    
    "CassandraWriteCapacityUtilization"
    
    "KafkaBrokerStorageUtilization"
    
    "ElastiCachePrimaryEngineCPUUtilization"
    
    "ElastiCacheReplicaEngineCPUUtilization"
    
    "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"
    
    "NeptuneReaderAverageCPUUtilization"
    
    "SageMakerVariantProvisionedConcurrencyUtilization"
    
    "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"
    
    "SageMakerInferenceComponentInvocationsPerCopy"
    
    "WorkSpacesAverageUserSessionsCapacityUtilization"
    
    "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution"
    
    "SageMakerVariantConcurrentRequestsPerModelHighResolution"
    
    ResourceLabel — (String)
    Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
    
    You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
    
    app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
    
    Where:
    
    app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
    
    targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
    
    To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
    
    CustomizedMetricSpecification — (map)
    A customized metric. You can specify either a predefined metric or a customized metric.
    
    MetricName — (String)
    The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    
    Namespace — (String)
    The namespace of the metric.
    
    Dimensions — (Array<map>)
    The dimensions of the metric.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    
    Name — required — (String)
    The name of the dimension.
    
    Value — required — (String)
    The value of the dimension.
    
    Statistic — (String)
    The statistic of the metric.
    Possible values include:
    
    "Average"
    
    "Minimum"
    
    "Maximum"
    
    "SampleCount"
    
    "Sum"
    
    Unit — (String)
    The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    
    Metrics — (Array<map>)
    The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
    
    Expression — (String)
    The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.
    
    Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Id — required — (String)
    A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
    
    Label — (String)
    A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
    
    MetricStat — (map)
    Information about the metric data to return.
    
    Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
    
    Metric — required — (map)
    The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
    
    Dimensions — (Array<map>)
    The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    
    Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
    
    Name — required — (String)
    The name of the dimension.
    
    Value — required — (String)
    The value of the dimension.
    
    MetricName — (String)
    The name of the metric.
    
    Namespace — (String)
    The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
    
    Stat — required — (String)
    The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
    
    The most commonly used metric for scaling is Average.
    
    Unit — (String)
    The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    
    ReturnData — (Boolean)
    Indicates whether to return the timestamps and raw data values of this metric.
    
    If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.
    
    If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
    
    ScaleOutCooldown — (Integer)
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    
    ScaleInCooldown — (Integer)
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
    
    DisableScaleIn — (Boolean)
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.
    
    Alarms — (Array<map>)
    The CloudWatch alarms associated with the scaling policy.
    
    AlarmName — required — (String)
    The name of the alarm.
    
    AlarmARN — required — (String)
    The Amazon Resource Name (ARN) of the alarm.
    
    CreationTime — required — (Date)
    The Unix timestamp for when the scaling policy was created.
  - NextToken — (String)
    The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

describeScheduledActions(params = {}, callback) ⇒ `AWS.Request`

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

You can filter the results using the ResourceId, ScalableDimension, and ScheduledActionNames parameters.

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

Service Reference:

DescribeScheduledActions

Examples:

To describe scheduled actions


/* This example describes the scheduled actions for the dynamodb service namespace. */

 var params = {
  ServiceNamespace: "dynamodb"
 };
 applicationautoscaling.describeScheduledActions(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ScheduledActions: [
       {
      CreationTime: <Date Representation>, 
      ResourceId: "table/my-table", 
      ScalableDimension: "dynamodb:table:WriteCapacityUnits", 
      ScalableTargetAction: {
       MaxCapacity: 20, 
       MinCapacity: 15
      }, 
      Schedule: "at(2019-05-20T18:35:00)", 
      ScheduledActionARN: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action", 
      ScheduledActionName: "my-first-scheduled-action", 
      ServiceNamespace: "dynamodb"
     }, 
       {
      CreationTime: <Date Representation>, 
      ResourceId: "table/my-table", 
      ScalableDimension: "dynamodb:table:WriteCapacityUnits", 
      ScalableTargetAction: {
       MaxCapacity: 10, 
       MinCapacity: 5
      }, 
      Schedule: "at(2019-05-20T18:40:00)", 
      ScheduledActionARN: "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action", 
      ScheduledActionName: "my-second-scheduled-action", 
      ServiceNamespace: "dynamodb"
     }
    ]
   }
   */
 });

Calling the describeScheduledActions operation

var params = {
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceId: 'STRING_VALUE',
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions,
  ScheduledActionNames: [
    'STRING_VALUE',
    /* more items */
  ]
};
applicationautoscaling.describeScheduledActions(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ScheduledActionNames — (Array<String>)
  The names of the scheduled actions to describe.
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- MaxResults — (Integer)
  The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.
  
  If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.
- NextToken — (String)
  The token for the next set of results.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ScheduledActions — (Array<map>)
    Information about the scheduled actions.
    
    ScheduledActionName — required — (String)
    The name of the scheduled action.
    
    ScheduledActionARN — required — (String)
    The Amazon Resource Name (ARN) of the scheduled action.
    
    ServiceNamespace — required — (String)
    The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.
    Possible values include:
    
    "ecs"
    
    "elasticmapreduce"
    
    "ec2"
    
    "appstream"
    
    "dynamodb"
    
    "rds"
    
    "sagemaker"
    
    "custom-resource"
    
    "comprehend"
    
    "lambda"
    
    "cassandra"
    
    "kafka"
    
    "elasticache"
    
    "neptune"
    
    "workspaces"
    
    Schedule — required — (String)
    The schedule for this action. The following formats are supported:
    
    At expressions - "at(yyyy-mm-ddThh:mm:ss)"
    
    Rate expressions - "rate(value unit)"
    
    Cron expressions - "cron(fields)"
    
    At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
    
    At and cron expressions use Universal Coordinated Time (UTC) by default.
    
    The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
    
    For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
    
    For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
    
    Timezone — (String)
    The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.
    
    ResourceId — required — (String)
    The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
    
    ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
    
    Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
    
    EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
    
    AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
    
    DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
    
    DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
    
    Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
    
    SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
    
    Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
    
    Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
    
    Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
    
    Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
    
    Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
    
    Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
    
    Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
    
    SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
    
    SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
    
    Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
    
    ScalableDimension — (String)
    The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
    
    ecs:service:DesiredCount - The task count of an ECS service.
    
    elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
    
    ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
    
    appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
    
    dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
    
    dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
    
    dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
    
    dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
    
    rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
    
    sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
    
    custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
    
    comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
    
    comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
    
    lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
    
    cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
    
    cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
    
    kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
    
    elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
    
    elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
    
    neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
    
    sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
    
    sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
    
    workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
    
    Possible values include:
    
    "ecs:service:DesiredCount"
    
    "ec2:spot-fleet-request:TargetCapacity"
    
    "elasticmapreduce:instancegroup:InstanceCount"
    
    "appstream:fleet:DesiredCapacity"
    
    "dynamodb:table:ReadCapacityUnits"
    
    "dynamodb:table:WriteCapacityUnits"
    
    "dynamodb:index:ReadCapacityUnits"
    
    "dynamodb:index:WriteCapacityUnits"
    
    "rds:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredInstanceCount"
    
    "custom-resource:ResourceType:Property"
    
    "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
    
    "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
    
    "lambda:function:ProvisionedConcurrency"
    
    "cassandra:table:ReadCapacityUnits"
    
    "cassandra:table:WriteCapacityUnits"
    
    "kafka:broker-storage:VolumeSize"
    
    "elasticache:replication-group:NodeGroups"
    
    "elasticache:replication-group:Replicas"
    
    "neptune:cluster:ReadReplicaCount"
    
    "sagemaker:variant:DesiredProvisionedConcurrency"
    
    "sagemaker:inference-component:DesiredCopyCount"
    
    "workspaces:workspacespool:DesiredUserSessions"
    
    StartTime — (Date)
    The date and time that the action is scheduled to begin, in UTC.
    
    EndTime — (Date)
    The date and time that the action is scheduled to end, in UTC.
    
    ScalableTargetAction — (map)
    The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
    
    MinCapacity — (Integer)
    The minimum capacity.
    
    When the scheduled action runs, the resource will have at least this much capacity, but it might have more depending on other settings, such as the target utilization level of a target tracking scaling policy.
    
    MaxCapacity — (Integer)
    The maximum capacity.
    
    Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.
    
    CreationTime — required — (Date)
    The date and time that the scheduled action was created.
  - NextToken — (String)
    The token required to get the next set of results. This value is null if there are no more results to return.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

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

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.

Service Reference:

ListTagsForResource

Examples:

To list tags for a scalable target


/* This example lists the tag key names and values that are attached to the scalable target specified by its ARN. */

 var params = {
  ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
 };
 applicationautoscaling.listTagsForResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Tags: {
     "environment": "production"
    }
   }
   */
 });

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE' /* required */
};
applicationautoscaling.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceARN — (String)
  Specify the ARN of the scalable target.
  
  For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
  
  To get the ARN for a scalable target, use DescribeScalableTargets.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Tags — (map<String>)
    A list of tags. Each tag consists of a tag key and a tag value.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

putScalingPolicy(params = {}, callback) ⇒ `AWS.Request`

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

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as a scalable target.

Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale out and scale in. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30.

We recommend caution, however, when using target tracking scaling policies with step scaling policies because conflicts between these policies can cause undesirable behavior. For example, if the step scaling policy initiates a scale-in activity before the target tracking policy is ready to scale in, the scale-in activity will not be blocked. After the scale-in activity completes, the target tracking policy could instruct the scalable target to scale out again.

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

Note: If a scalable target is deregistered, the scalable target is no longer available to use scaling policies. Any scaling policies that were specified for the scalable target are deleted.

Service Reference:

PutScalingPolicy

Examples:

To apply a target tracking scaling policy with a predefined metric specification


/* The following example applies a target tracking scaling policy with a predefined metric specification to an Amazon ECS service called web-app in the default cluster. The policy keeps the average CPU utilization of the service at 75 percent, with scale-out and scale-in cooldown periods of 60 seconds. */

 var params = {
  PolicyName: "cpu75-target-tracking-scaling-policy", 
  PolicyType: "TargetTrackingScaling", 
  ResourceId: "service/default/web-app", 
  ScalableDimension: "ecs:service:DesiredCount", 
  ServiceNamespace: "ecs", 
  TargetTrackingScalingPolicyConfiguration: {
   PredefinedMetricSpecification: {
    PredefinedMetricType: "ECSServiceAverageCPUUtilization"
   }, 
   ScaleInCooldown: 60, 
   ScaleOutCooldown: 60, 
   TargetValue: 75
  }
 };
 applicationautoscaling.putScalingPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Alarms: [
       {
      AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca", 
      AlarmName: "TargetTracking-service/default/web-app-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca"
     }, 
       {
      AlarmARN: "arn:aws:cloudwatch:us-west-2:012345678910:alarm:TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d", 
      AlarmName: "TargetTracking-service/default/web-app-AlarmLow-1b437334-d19b-4a63-a812-6c67aaf2910d"
     }
    ], 
    PolicyARN: "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/cpu75-target-tracking-scaling-policy"
   }
   */
 });

Calling the putScalingPolicy operation

var params = {
  PolicyName: 'STRING_VALUE', /* required */
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  PolicyType: StepScaling | TargetTrackingScaling,
  StepScalingPolicyConfiguration: {
    AdjustmentType: ChangeInCapacity | PercentChangeInCapacity | ExactCapacity,
    Cooldown: 'NUMBER_VALUE',
    MetricAggregationType: Average | Minimum | Maximum,
    MinAdjustmentMagnitude: 'NUMBER_VALUE',
    StepAdjustments: [
      {
        ScalingAdjustment: 'NUMBER_VALUE', /* required */
        MetricIntervalLowerBound: 'NUMBER_VALUE',
        MetricIntervalUpperBound: 'NUMBER_VALUE'
      },
      /* more items */
    ]
  },
  TargetTrackingScalingPolicyConfiguration: {
    TargetValue: 'NUMBER_VALUE', /* required */
    CustomizedMetricSpecification: {
      Dimensions: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      MetricName: 'STRING_VALUE',
      Metrics: [
        {
          Id: 'STRING_VALUE', /* required */
          Expression: 'STRING_VALUE',
          Label: 'STRING_VALUE',
          MetricStat: {
            Metric: { /* required */
              Dimensions: [
                {
                  Name: 'STRING_VALUE', /* required */
                  Value: 'STRING_VALUE' /* required */
                },
                /* more items */
              ],
              MetricName: 'STRING_VALUE',
              Namespace: 'STRING_VALUE'
            },
            Stat: 'STRING_VALUE', /* required */
            Unit: 'STRING_VALUE'
          },
          ReturnData: true || false
        },
        /* more items */
      ],
      Namespace: 'STRING_VALUE',
      Statistic: Average | Minimum | Maximum | SampleCount | Sum,
      Unit: 'STRING_VALUE'
    },
    DisableScaleIn: true || false,
    PredefinedMetricSpecification: {
      PredefinedMetricType: DynamoDBReadCapacityUtilization | DynamoDBWriteCapacityUtilization | ALBRequestCountPerTarget | RDSReaderAverageCPUUtilization | RDSReaderAverageDatabaseConnections | EC2SpotFleetRequestAverageCPUUtilization | EC2SpotFleetRequestAverageNetworkIn | EC2SpotFleetRequestAverageNetworkOut | SageMakerVariantInvocationsPerInstance | ECSServiceAverageCPUUtilization | ECSServiceAverageMemoryUtilization | AppStreamAverageCapacityUtilization | ComprehendInferenceUtilization | LambdaProvisionedConcurrencyUtilization | CassandraReadCapacityUtilization | CassandraWriteCapacityUtilization | KafkaBrokerStorageUtilization | ElastiCachePrimaryEngineCPUUtilization | ElastiCacheReplicaEngineCPUUtilization | ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage | NeptuneReaderAverageCPUUtilization | SageMakerVariantProvisionedConcurrencyUtilization | ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage | SageMakerInferenceComponentInvocationsPerCopy | WorkSpacesAverageUserSessionsCapacityUtilization | SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution | SageMakerVariantConcurrentRequestsPerModelHighResolution, /* required */
      ResourceLabel: 'STRING_VALUE'
    },
    ScaleInCooldown: 'NUMBER_VALUE',
    ScaleOutCooldown: 'NUMBER_VALUE'
  }
};
applicationautoscaling.putScalingPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- PolicyName — (String)
  The name of the scaling policy.
  
  You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- PolicyType — (String)
  The scaling policy type. This parameter is required if you are creating a scaling policy.
  
  The following policy types are supported:
  
  TargetTrackingScaling—Not supported for Amazon EMR.
  
  StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.
  
  For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.
  Possible values include:
  - "StepScaling"
  - "TargetTrackingScaling"
- StepScalingPolicyConfiguration — (map)
  A step scaling policy.
  
  This parameter is required if you are creating a policy and the policy type is StepScaling.
  - AdjustmentType — (String)
    Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.
    
    AdjustmentType is required if you are adding a new step scaling policy configuration.
    Possible values include:
    - "ChangeInCapacity"
    - "PercentChangeInCapacity"
    - "ExactCapacity"
  - StepAdjustments — (Array<map>)
    A set of adjustments that enable you to scale based on the size of the alarm breach.
    
    At least one step adjustment is required if you are adding a new step scaling policy configuration.
    - MetricIntervalLowerBound — (Float)
      The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.
    - MetricIntervalUpperBound — (Float)
      The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.
      
      The upper bound must be greater than the lower bound.
    - ScalingAdjustment — required — (Integer)
      The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.
  - MinAdjustmentMagnitude — (Integer)
    The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.
  - Cooldown — (Integer)
    The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.
  - MetricAggregationType — (String)
    The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.
    Possible values include:
    - "Average"
    - "Minimum"
    - "Maximum"
- TargetTrackingScalingPolicyConfiguration — (map)
  A target tracking scaling policy. Includes support for predefined or customized metrics.
  
  This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling.
  - TargetValue — required — (Float)
    The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2³⁶⁰ to 2³⁶⁰. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.
    
    Note: If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.
  - PredefinedMetricSpecification — (map)
    A predefined metric. You can specify either a predefined metric or a customized metric.
    - PredefinedMetricType — required — (String)
      The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.
      Possible values include:
      
      "DynamoDBReadCapacityUtilization"
      
      "DynamoDBWriteCapacityUtilization"
      
      "ALBRequestCountPerTarget"
      
      "RDSReaderAverageCPUUtilization"
      
      "RDSReaderAverageDatabaseConnections"
      
      "EC2SpotFleetRequestAverageCPUUtilization"
      
      "EC2SpotFleetRequestAverageNetworkIn"
      
      "EC2SpotFleetRequestAverageNetworkOut"
      
      "SageMakerVariantInvocationsPerInstance"
      
      "ECSServiceAverageCPUUtilization"
      
      "ECSServiceAverageMemoryUtilization"
      
      "AppStreamAverageCapacityUtilization"
      
      "ComprehendInferenceUtilization"
      
      "LambdaProvisionedConcurrencyUtilization"
      
      "CassandraReadCapacityUtilization"
      
      "CassandraWriteCapacityUtilization"
      
      "KafkaBrokerStorageUtilization"
      
      "ElastiCachePrimaryEngineCPUUtilization"
      
      "ElastiCacheReplicaEngineCPUUtilization"
      
      "ElastiCacheDatabaseMemoryUsageCountedForEvictPercentage"
      
      "NeptuneReaderAverageCPUUtilization"
      
      "SageMakerVariantProvisionedConcurrencyUtilization"
      
      "ElastiCacheDatabaseCapacityUsageCountedForEvictPercentage"
      
      "SageMakerInferenceComponentInvocationsPerCopy"
      
      "WorkSpacesAverageUserSessionsCapacityUtilization"
      
      "SageMakerInferenceComponentConcurrentRequestsPerCopyHighResolution"
      
      "SageMakerVariantConcurrentRequestsPerModelHighResolution"
    - ResourceLabel — (String)
      Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.
      
      You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
      
      app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.
      
      Where:
      
      app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
      
      targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
      
      To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
  - CustomizedMetricSpecification — (map)
    A customized metric. You can specify either a predefined metric or a customized metric.
    - MetricName — (String)
      The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.
    - Namespace — (String)
      The namespace of the metric.
    - Dimensions — (Array<map>)
      The dimensions of the metric.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
      
      Name — required — (String)
      The name of the dimension.
      
      Value — required — (String)
      The value of the dimension.
    - Statistic — (String)
      The statistic of the metric.
      Possible values include:
      
      "Average"
      
      "Minimum"
      
      "Maximum"
      
      "SampleCount"
      
      "Sum"
    - Unit — (String)
      The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
    - Metrics — (Array<map>)
      The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.
      
      Expression — (String)
      The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.
      
      Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.
      
      Id — required — (String)
      A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.
      
      Label — (String)
      A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.
      
      MetricStat — (map)
      Information about the metric data to return.
      
      Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.
      
      Metric — required — (map)
      The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.
      
      Dimensions — (Array<map>)
      The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
      
      Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
      
      Name — required — (String)
      The name of the dimension.
      
      Value — required — (String)
      The value of the dimension.
      
      MetricName — (String)
      The name of the metric.
      
      Namespace — (String)
      The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
      
      Stat — required — (String)
      The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.
      
      The most commonly used metric for scaling is Average.
      
      Unit — (String)
      The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.
      
      ReturnData — (Boolean)
      Indicates whether to return the timestamps and raw data values of this metric.
      
      If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.
      
      If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).
  - ScaleOutCooldown — (Integer)
    The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
  - ScaleInCooldown — (Integer)
    The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.
  - DisableScaleIn — (Boolean)
    Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - PolicyARN — (String)
    The Amazon Resource Name (ARN) of the resulting scaling policy.
  - Alarms — (Array<map>)
    The CloudWatch alarms created for the target tracking scaling policy.
    
    AlarmName — required — (String)
    The name of the alarm.
    
    AlarmARN — required — (String)
    The Amazon Resource Name (ARN) of the alarm.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

putScheduledAction(params = {}, callback) ⇒ `AWS.Request`

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

Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target.

When you specify start and end times with a recurring schedule using a cron expression or rates, they form the boundaries for when the recurring action starts and stops.

To update a scheduled action, specify the parameters that you want to change. If you don't specify start and end times, the old values are deleted.

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

Note: If a scalable target is deregistered, the scalable target is no longer available to run scheduled actions. Any scheduled actions that were specified for the scalable target are deleted.

Service Reference:

PutScheduledAction

Examples:

To create a recurring scheduled action


/* This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity. */

 var params = {
  ResourceId: "table/TestTable", 
  ScalableDimension: "dynamodb:table:WriteCapacityUnits", 
  ScalableTargetAction: {
   MinCapacity: 6
  }, 
  Schedule: "cron(15 12 * * ? *)", 
  ScheduledActionName: "my-recurring-action", 
  ServiceNamespace: "dynamodb"
 };
 applicationautoscaling.putScheduledAction(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the putScheduledAction operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ScheduledActionName: 'STRING_VALUE', /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  ScalableTargetAction: {
    MaxCapacity: 'NUMBER_VALUE',
    MinCapacity: 'NUMBER_VALUE'
  },
  Schedule: 'STRING_VALUE',
  StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  Timezone: 'STRING_VALUE'
};
applicationautoscaling.putScheduledAction(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- Schedule — (String)
  The schedule for this action. The following formats are supported:
  - At expressions - "at(yyyy-mm-ddThh:mm:ss)"
  - Rate expressions - "rate(value unit)"
  - Cron expressions - "cron(fields)"
  At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.
  
  At and cron expressions use Universal Coordinated Time (UTC) by default.
  
  The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
  
  For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.
  
  For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
- Timezone — (String)
  Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default.
  
  Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.
- ScheduledActionName — (String)
  The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
- ResourceId — (String)
  The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- StartTime — (Date)
  The date and time for this scheduled action to start, in UTC.
- EndTime — (Date)
  The date and time for the recurring schedule to end, in UTC.
- ScalableTargetAction — (map)
  The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.
  - MinCapacity — (Integer)
    The minimum capacity.
    
    When the scheduled action runs, the resource will have at least this much capacity, but it might have more depending on other settings, such as the target utilization level of a target tracking scaling policy.
  - MaxCapacity — (Integer)
    The maximum capacity.
    
    Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

registerScalableTarget(params = {}, callback) ⇒ `AWS.Request`

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

Scalable targets are uniquely identified by the combination of resource ID, scalable dimension, and namespace, which represents some capacity dimension of the underlying service.

When you register a new scalable target, you must specify values for the minimum and maximum capacity. If the specified resource is not active in the target service, this operation does not change the resource's current capacity. Otherwise, it changes the resource's current capacity to a value that is inside of this range.

If you add a scaling policy, current capacity is adjustable within the specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are outside of the minimum and maximum range.

After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use DescribeScalableTargets. You can also view the scaling policies for a service namespace by using DescribeScalableTargets. If you no longer need a scalable target, you can deregister it by using DeregisterScalableTarget.

To update a scalable target, specify the parameters that you want to change. Include the parameters that identify the scalable target: resource ID, scalable dimension, and namespace. Any parameters that you don't specify are not changed by this update request.

Note: If you call the RegisterScalableTarget API operation to create a scalable target, there might be a brief delay until the operation achieves eventual consistency. You might become aware of this brief delay if you get unexpected errors when performing sequential operations. The typical strategy is to retry the request, and some Amazon Web Services SDKs include automatic backoff and retry logic. If you call the RegisterScalableTarget API operation to update an existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the scalable target to place it within these bounds, even if you don't include the MinCapacity or MaxCapacity request parameters.

Service Reference:

RegisterScalableTarget

Examples:

To register an ECS service as a scalable target


/* This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks. */

 var params = {
  MaxCapacity: 10, 
  MinCapacity: 1, 
  ResourceId: "service/default/web-app", 
  ScalableDimension: "ecs:service:DesiredCount", 
  ServiceNamespace: "ecs"
 };
 applicationautoscaling.registerScalableTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ScalableTargetARN: "arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
   }
   */
 });

Calling the registerScalableTarget operation

var params = {
  ResourceId: 'STRING_VALUE', /* required */
  ScalableDimension: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces, /* required */
  MaxCapacity: 'NUMBER_VALUE',
  MinCapacity: 'NUMBER_VALUE',
  RoleARN: 'STRING_VALUE',
  SuspendedState: {
    DynamicScalingInSuspended: true || false,
    DynamicScalingOutSuspended: true || false,
    ScheduledScalingSuspended: true || false
  },
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
applicationautoscaling.registerScalableTarget(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ServiceNamespace — (String)
  The namespace of the Amazon Web Services service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.
  Possible values include:
  - "ecs"
  - "elasticmapreduce"
  - "ec2"
  - "appstream"
  - "dynamodb"
  - "rds"
  - "sagemaker"
  - "custom-resource"
  - "comprehend"
  - "lambda"
  - "cassandra"
  - "kafka"
  - "elasticache"
  - "neptune"
  - "workspaces"
- ResourceId — (String)
  The identifier of the resource that is associated with the scalable target. This string consists of the resource type and unique identifier.
  - ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/my-cluster/my-service.
  - Spot Fleet - The resource type is spot-fleet-request and the unique identifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.
  - EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.
  - AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.
  - DynamoDB table - The resource type is table and the unique identifier is the table name. Example: table/my-table.
  - DynamoDB global secondary index - The resource type is index and the unique identifier is the index name. Example: table/my-table/index/my-table-index.
  - Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.
  - SageMaker endpoint variant - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - Custom resources are not supported with a resource type. This parameter must specify the OutputValue from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository.
  - Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE.
  - Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example: arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE.
  - Lambda provisioned concurrency - The resource type is function and the unique identifier is the function name with a function version or alias name suffix that is not $LATEST. Example: function:my-function:prod or function:my-function:1.
  - Amazon Keyspaces table - The resource type is table and the unique identifier is the table name. Example: keyspace/mykeyspace/table/mytable.
  - Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example: arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5.
  - Amazon ElastiCache replication group - The resource type is replication-group and the unique identifier is the replication group name. Example: replication-group/mycluster.
  - Neptune cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:mycluster.
  - SageMaker serverless endpoint - The resource type is variant and the unique identifier is the resource ID. Example: endpoint/my-end-point/variant/KMeansClustering.
  - SageMaker inference component - The resource type is inference-component and the unique identifier is the resource ID. Example: inference-component/my-inference-component.
  - Pool of WorkSpaces - The resource type is workspacespool and the unique identifier is the pool ID. Example: workspacespool/wspool-123456.
- ScalableDimension — (String)
  The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
  - ecs:service:DesiredCount - The task count of an ECS service.
  - elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.
  - ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet.
  - appstream:fleet:DesiredCapacity - The capacity of an AppStream 2.0 fleet.
  - dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.
  - dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.
  - dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.
  - dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.
  - rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
  - sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for a SageMaker model endpoint variant.
  - custom-resource:ResourceType:Property - The scalable dimension for a custom resource provided by your own application or service.
  - comprehend:document-classifier-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend document classification endpoint.
  - comprehend:entity-recognizer-endpoint:DesiredInferenceUnits - The number of inference units for an Amazon Comprehend entity recognizer endpoint.
  - lambda:function:ProvisionedConcurrency - The provisioned concurrency for a Lambda function.
  - cassandra:table:ReadCapacityUnits - The provisioned read capacity for an Amazon Keyspaces table.
  - cassandra:table:WriteCapacityUnits - The provisioned write capacity for an Amazon Keyspaces table.
  - kafka:broker-storage:VolumeSize - The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
  - elasticache:replication-group:NodeGroups - The number of node groups for an Amazon ElastiCache replication group.
  - elasticache:replication-group:Replicas - The number of replicas per node group for an Amazon ElastiCache replication group.
  - neptune:cluster:ReadReplicaCount - The count of read replicas in an Amazon Neptune DB cluster.
  - sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker serverless endpoint.
  - sagemaker:inference-component:DesiredCopyCount - The number of copies across an endpoint for a SageMaker inference component.
  - workspaces:workspacespool:DesiredUserSessions - The number of user sessions for the WorkSpaces in the pool.
  Possible values include:
  - "ecs:service:DesiredCount"
  - "ec2:spot-fleet-request:TargetCapacity"
  - "elasticmapreduce:instancegroup:InstanceCount"
  - "appstream:fleet:DesiredCapacity"
  - "dynamodb:table:ReadCapacityUnits"
  - "dynamodb:table:WriteCapacityUnits"
  - "dynamodb:index:ReadCapacityUnits"
  - "dynamodb:index:WriteCapacityUnits"
  - "rds:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredInstanceCount"
  - "custom-resource:ResourceType:Property"
  - "comprehend:document-classifier-endpoint:DesiredInferenceUnits"
  - "comprehend:entity-recognizer-endpoint:DesiredInferenceUnits"
  - "lambda:function:ProvisionedConcurrency"
  - "cassandra:table:ReadCapacityUnits"
  - "cassandra:table:WriteCapacityUnits"
  - "kafka:broker-storage:VolumeSize"
  - "elasticache:replication-group:NodeGroups"
  - "elasticache:replication-group:Replicas"
  - "neptune:cluster:ReadReplicaCount"
  - "sagemaker:variant:DesiredProvisionedConcurrency"
  - "sagemaker:inference-component:DesiredCopyCount"
  - "workspaces:workspacespool:DesiredUserSessions"
- MinCapacity — (Integer)
  The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.
  
  For the following resources, the minimum value allowed is 0.
  - AppStream 2.0 fleets
  - Aurora DB clusters
  - ECS services
  - EMR clusters
  - Lambda provisioned concurrency
  - SageMaker endpoint variants
  - SageMaker inference components
  - SageMaker serverless endpoint provisioned concurrency
  - Spot Fleets
  - custom resources
  It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization.
  
  For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.
- MaxCapacity — (Integer)
  The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.
  
  Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.
- RoleARN — (String)
  This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
  
  If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM.
- SuspendedState — (map)
  An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.
  
  Suspension Outcomes
  - For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.
  - For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.
  - For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.
  For more information, see Suspend and resume scaling in the Application Auto Scaling User Guide.
  - DynamicScalingInSuspended — (Boolean)
    Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default is false.
  - DynamicScalingOutSuspended — (Boolean)
    Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to true if you don't want Application Auto Scaling to add capacity when a scaling policy is triggered. The default is false.
  - ScheduledScalingSuspended — (Boolean)
    Whether scheduled scaling is suspended. Set the value to true if you don't want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default is false.
- Tags — (map<String>)
  Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is created. To tag an existing scalable target, use the TagResource operation.
  
  Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key.
  
  Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - ScalableTargetARN — (String)
    The ARN of the scalable target.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ `AWS.Request`

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

Each tag consists of a tag key and a tag value, which are both case-sensitive strings. To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag key and a new tag value.

You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a scaling policy or scheduled action.

You can also add tags to an Application Auto Scaling scalable target while creating it (RegisterScalableTarget).

For general information about tags, including the format and syntax, see Tagging your Amazon Web Services resources in the Amazon Web Services General Reference.

Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.

Service Reference:

TagResource

Examples:

To add a tag to a scalable target


/* This example adds a tag with the key name "environment" and the value "production" to the scalable target specified by its ARN. */

 var params = {
  ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", 
  Tags: {
   "environment": "production"
  }
 };
 applicationautoscaling.tagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
applicationautoscaling.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceARN — (String)
  Identifies the Application Auto Scaling scalable target that you want to apply tags to.
  
  For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
  
  To get the ARN for a scalable target, use DescribeScalableTargets.
- Tags — (map<String>)
  The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.
  
  Each tag consists of a tag key and a tag value.
  
  You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value with the specified one.
  
  For information about the rules that apply to tag keys and tag values, see User-defined tag restrictions in the Amazon Web Services Billing User Guide.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

UntagResource

Examples:

To remove a tag from a scalable target


/* This example removes the tag pair with the key name "environment" from the scalable target specified by its ARN. */

 var params = {
  ResourceARN: "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123", 
  TagKeys: [
     "environment"
  ]
 };
 applicationautoscaling.untagResource(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
applicationautoscaling.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ResourceARN — (String)
  Identifies the Application Auto Scaling scalable target from which to remove tags.
  
  For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123
  
  To get the ARN for a scalable target, use DescribeScalableTargets.
- TagKeys — (Array<String>)
  One or more tag keys. Specify only the tag keys, not the tag values.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.ApplicationAutoScaling

Overview

Service Description

Sending a Request Using ApplicationAutoScaling

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.ApplicationAutoScaling(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

deleteScalingPolicy(params = {}, callback) ⇒ AWS.Request

deleteScheduledAction(params = {}, callback) ⇒ AWS.Request

deregisterScalableTarget(params = {}, callback) ⇒ AWS.Request

describeScalableTargets(params = {}, callback) ⇒ AWS.Request

describeScalingActivities(params = {}, callback) ⇒ AWS.Request

describeScalingPolicies(params = {}, callback) ⇒ AWS.Request

describeScheduledActions(params = {}, callback) ⇒ AWS.Request

listTagsForResource(params = {}, callback) ⇒ AWS.Request

putScalingPolicy(params = {}, callback) ⇒ AWS.Request

putScheduledAction(params = {}, callback) ⇒ AWS.Request

registerScalableTarget(params = {}, callback) ⇒ AWS.Request

tagResource(params = {}, callback) ⇒ AWS.Request

untagResource(params = {}, callback) ⇒ AWS.Request

new AWS.ApplicationAutoScaling(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

deleteScalingPolicy(params = {}, callback) ⇒ `AWS.Request`

deleteScheduledAction(params = {}, callback) ⇒ `AWS.Request`

deregisterScalableTarget(params = {}, callback) ⇒ `AWS.Request`

describeScalableTargets(params = {}, callback) ⇒ `AWS.Request`

describeScalingActivities(params = {}, callback) ⇒ `AWS.Request`

describeScalingPolicies(params = {}, callback) ⇒ `AWS.Request`

describeScheduledActions(params = {}, callback) ⇒ `AWS.Request`

listTagsForResource(params = {}, callback) ⇒ `AWS.Request`

putScalingPolicy(params = {}, callback) ⇒ `AWS.Request`

putScheduledAction(params = {}, callback) ⇒ `AWS.Request`

registerScalableTarget(params = {}, callback) ⇒ `AWS.Request`

tagResource(params = {}, callback) ⇒ `AWS.Request`

untagResource(params = {}, callback) ⇒ `AWS.Request`