Class: AWS.ApplicationAutoScaling

Inherits:
AWS.Service 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.

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

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

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)

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

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

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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.

Property Details

endpointAWS.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 Application Auto Scaling scaling policy.

Deleting a 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.

To create a scaling policy or update an existing one, see PutScalingPolicy.

Service Reference:

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, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb /* 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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • 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/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • ScalableDimension — (String)

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"

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 a scalable target.

Deregistering a scalable target deletes the scaling policies that are associated with it.

To create a scalable target or update an existing one, see RegisterScalableTarget.

Service Reference:

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, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb /* 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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • 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/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • 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 desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"

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

Provides descriptive information about the scalable targets in the specified namespace.

You can filter the results using the ResourceIds and ScalableDimension parameters.

To create a scalable target or update an existing one, see RegisterScalableTarget. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

Service Reference:

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/ApplicationAutoscalingECSRole", 
      ScalableDimension: "ecs:service:DesiredCount", 
      ServiceNamespace: "ecs"
     }
    ]
   }
   */
 });

Calling the describeScalableTargets operation

var params = {
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb, /* required */
  MaxResults: 0,
  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
};
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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • ResourceIds — (Array<String>)

      The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • 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 desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"
    • MaxResults — (Integer)

      The maximum number of scalable target 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:

      • ScalableTargets — (Array<map>)

        The list of scalable targets that matches the request parameters.

        • ServiceNamespacerequired — (String)

          The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

          Possible values include:
          • "ecs"
          • "elasticmapreduce"
          • "ec2"
          • "appstream"
          • "dynamodb"
        • ResourceIdrequired — (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/default/sample-webapp.

          • Spot fleet request - 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 resource ID. Example: table/my-table.

          • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

        • ScalableDimensionrequired — (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 desired task count of an ECS service.

          • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

          • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

          • appstream:fleet:DesiredCapacity - The desired 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.

          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"
        • MinCapacityrequired — (Integer)

          The minimum value to scale to in response to a scale in event.

        • MaxCapacityrequired — (Integer)

          The maximum value to scale to in response to a scale out event.

        • RoleARNrequired — (String)

          The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

        • CreationTimerequired — (Date)

          The Unix timestamp for when the scalable target 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.

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 the ResourceId and ScalableDimension parameters.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

Service Reference:

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, /* required */
  MaxResults: 0,
  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
};
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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • ResourceId — (String)

      The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • 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 desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"
    • MaxResults — (Integer)

      The maximum number of scalable target 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:

      • ScalingActivities — (Array<map>)

        A list of scaling activity objects.

        • ActivityIdrequired — (String)

          The unique identifier of the scaling activity.

        • ServiceNamespacerequired — (String)

          The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

          Possible values include:
          • "ecs"
          • "elasticmapreduce"
          • "ec2"
          • "appstream"
          • "dynamodb"
        • ResourceIdrequired — (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/default/sample-webapp.

          • Spot fleet request - 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 resource ID. Example: table/my-table.

          • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

        • ScalableDimensionrequired — (String)

          The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

          • ecs:service:DesiredCount - The desired task count of an ECS service.

          • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

          • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

          • appstream:fleet:DesiredCapacity - The desired 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.

          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"
        • Descriptionrequired — (String)

          A simple description of what action the scaling activity intends to accomplish.

        • Causerequired — (String)

          A simple description of what caused the scaling activity to happen.

        • StartTimerequired — (Date)

          The Unix timestamp for when the scaling activity began.

        • EndTime — (Date)

          The Unix timestamp for when the scaling activity ended.

        • StatusCoderequired — (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.

      • 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

Provides descriptive information about the scaling policies in the specified namespace.

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

To create a scaling policy or update an existing one, see PutScalingPolicy. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Service Reference:

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, /* required */
  MaxResults: 0,
  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
};
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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • ResourceId — (String)

      The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

      • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • 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 desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"
    • MaxResults — (Integer)

      The maximum number of scalable target 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:

      • ScalingPolicies — (Array<map>)

        A list of scaling policy objects.

        • PolicyARNrequired — (String)

          The Amazon Resource Name (ARN) of the scaling policy.

        • PolicyNamerequired — (String)

          The name of the scaling policy.

        • ServiceNamespacerequired — (String)

          The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

          Possible values include:
          • "ecs"
          • "elasticmapreduce"
          • "ec2"
          • "appstream"
          • "dynamodb"
        • ResourceIdrequired — (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/default/sample-webapp.

          • Spot fleet request - 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 resource ID. Example: table/my-table.

          • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

        • ScalableDimensionrequired — (String)

          The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

          • ecs:service:DesiredCount - The desired task count of an ECS service.

          • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

          • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

          • appstream:fleet:DesiredCapacity - The desired 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.

          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"
        • PolicyTyperequired — (String)

          The scaling policy type.

          Possible values include:
          • "StepScaling"
          • "TargetTrackingScaling"
        • StepScalingPolicyConfiguration — (map)

          A step scaling policy.

          • AdjustmentType — (String)

            The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

            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.

            • 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 is 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 is 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.

            • ScalingAdjustmentrequired — (Integer)

              The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

          • MinAdjustmentMagnitude — (Integer)

            The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

          • Cooldown — (Integer)

            The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

            For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

            For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

          • MetricAggregationType — (String)

            The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

            Possible values include:
            • "Average"
            • "Minimum"
            • "Maximum"
        • TargetTrackingScalingPolicyConfiguration — (map)

          A target tracking policy.

          • TargetValuerequired — (Float)

            The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

          • PredefinedMetricSpecification — (map)

            A predefined metric.

            • PredefinedMetricTyperequired — (String)

              The metric type.

              Possible values include:
              • "DynamoDBReadCapacityUtilization"
              • "DynamoDBWriteCapacityUtilization"
            • ResourceLabel — (String)

              Reserved for future use.

          • CustomizedMetricSpecification — (map)

            Reserved for future use.

            • MetricNamerequired — (String)

              The name of the metric.

            • Namespacerequired — (String)

              The namespace of the metric.

            • Dimensions — (Array<map>)

              The dimensions of the metric.

              • Namerequired — (String)

                The name of the dimension.

              • Valuerequired — (String)

                The value of the dimension.

            • Statisticrequired — (String)

              The statistic of the metric.

              Possible values include:
              • "Average"
              • "Minimum"
              • "Maximum"
              • "SampleCount"
              • "Sum"
            • Unit — (String)

              The unit of the metric.

          • ScaleOutCooldown — (Integer)

            The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

            While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

          • ScaleInCooldown — (Integer)

            The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

            The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

        • Alarms — (Array<map>)

          The CloudWatch alarms associated with the scaling policy.

          • AlarmNamerequired — (String)

            The name of the alarm.

          • AlarmARNrequired — (String)

            The Amazon Resource Name (ARN) of the alarm.

        • CreationTimerequired — (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.

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

Creates or updates a 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 without first registering a scalable target using RegisterScalableTarget.

To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.

You can view the scaling policies for a service namespace using DescribeScalingPolicies. If you are no longer using a scaling policy, you can delete it using DeleteScalingPolicy.

Service Reference:

Examples:

To apply a scaling policy to an Amazon ECS service


/* This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds. */

 var params = {
  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
    }
   ]
  }
 };
 applicationautoscaling.putScalingPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    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"
   }
   */
 });

To apply a scaling policy to an Amazon EC2 Spot fleet


/* This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.",
   */

 var params = {
  PolicyName: "fleet-cpu-gt-75", 
  PolicyType: "StepScaling", 
  ResourceId: "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", 
  ScalableDimension: "ec2:spot-fleet-request:TargetCapacity", 
  ServiceNamespace: "ec2", 
  StepScalingPolicyConfiguration: {
   AdjustmentType: "PercentChangeInCapacity", 
   Cooldown: 180, 
   StepAdjustments: [
      {
     MetricIntervalLowerBound: 0, 
     ScalingAdjustment: 200
    }
   ]
  }
 };
 applicationautoscaling.putScalingPolicy(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PolicyARN: "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75"
   }
   */
 });

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, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb, /* required */
  PolicyType: StepScaling | TargetTrackingScaling,
  StepScalingPolicyConfiguration: {
    AdjustmentType: ChangeInCapacity | PercentChangeInCapacity | ExactCapacity,
    Cooldown: 0,
    MetricAggregationType: Average | Minimum | Maximum,
    MinAdjustmentMagnitude: 0,
    StepAdjustments: [
      {
        ScalingAdjustment: 0, /* required */
        MetricIntervalLowerBound: 0.0,
        MetricIntervalUpperBound: 0.0
      },
      /* more items */
    ]
  },
  TargetTrackingScalingPolicyConfiguration: {
    TargetValue: 0.0, /* required */
    CustomizedMetricSpecification: {
      MetricName: 'STRING_VALUE', /* required */
      Namespace: 'STRING_VALUE', /* required */
      Statistic: Average | Minimum | Maximum | SampleCount | Sum, /* required */
      Dimensions: [
        {
          Name: 'STRING_VALUE', /* required */
          Value: 'STRING_VALUE' /* required */
        },
        /* more items */
      ],
      Unit: 'STRING_VALUE'
    },
    PredefinedMetricSpecification: {
      PredefinedMetricType: DynamoDBReadCapacityUtilization | DynamoDBWriteCapacityUtilization, /* required */
      ResourceLabel: 'STRING_VALUE'
    },
    ScaleInCooldown: 0,
    ScaleOutCooldown: 0
  }
};
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.

    • ServiceNamespace — (String)

      The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • 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/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • ScalableDimension — (String)

      The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

      • ecs:service:DesiredCount - The desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"
    • PolicyType — (String)

      The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.

      For DynamoDB, only TargetTrackingScaling is supported. For any other service, only StepScaling is supported.

      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)

        The adjustment type, which specifies how the ScalingAdjustment parameter in a StepAdjustment is interpreted.

        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.

        • 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 is 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 is 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.

        • ScalingAdjustmentrequired — (Integer)

          The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.

      • MinAdjustmentMagnitude — (Integer)

        The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is PercentChangeInCapacity, the scaling policy changes the scalable dimension of the scalable target by this amount.

      • Cooldown — (Integer)

        The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.

        For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.

        For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

      • MetricAggregationType — (String)

        The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average.

        Possible values include:
        • "Average"
        • "Minimum"
        • "Maximum"
    • TargetTrackingScalingPolicyConfiguration — (map)

      A target tracking policy.

      This parameter is required if you are creating a new policy and the policy type is TargetTrackingScaling.

      • TargetValuerequired — (Float)

        The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).

      • PredefinedMetricSpecification — (map)

        A predefined metric.

        • PredefinedMetricTyperequired — (String)

          The metric type.

          Possible values include:
          • "DynamoDBReadCapacityUtilization"
          • "DynamoDBWriteCapacityUtilization"
        • ResourceLabel — (String)

          Reserved for future use.

      • CustomizedMetricSpecification — (map)

        Reserved for future use.

        • MetricNamerequired — (String)

          The name of the metric.

        • Namespacerequired — (String)

          The namespace of the metric.

        • Dimensions — (Array<map>)

          The dimensions of the metric.

          • Namerequired — (String)

            The name of the dimension.

          • Valuerequired — (String)

            The value of the dimension.

        • Statisticrequired — (String)

          The statistic of the metric.

          Possible values include:
          • "Average"
          • "Minimum"
          • "Maximum"
          • "SampleCount"
          • "Sum"
        • Unit — (String)

          The unit of the metric.

      • ScaleOutCooldown — (Integer)

        The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.

        While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.

      • ScaleInCooldown — (Integer)

        The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.

        The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.

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

        • AlarmNamerequired — (String)

          The name of the alarm.

        • AlarmARNrequired — (String)

          The Amazon Resource Name (ARN) of the alarm.

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. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for your scalable dimension.

After you register a scalable target, you can create and apply scaling policies using PutScalingPolicy. You can view the scaling policies for a service namespace using DescribeScalableTargets. If you are no longer using a scalable target, you can deregister it using DeregisterScalableTarget.

Service Reference:

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", 
  RoleARN: "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole", 
  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 = {
   }
   */
 });

To register an EC2 Spot fleet as a scalable target


/* This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10. */

 var params = {
  MaxCapacity: 10, 
  MinCapacity: 1, 
  ResourceId: "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3", 
  RoleARN: "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole", 
  ScalableDimension: "ec2:spot-fleet-request:TargetCapacity", 
  ServiceNamespace: "ec2"
 };
 applicationautoscaling.registerScalableTarget(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
   }
   */
 });

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, /* required */
  ServiceNamespace: ecs | elasticmapreduce | ec2 | appstream | dynamodb, /* required */
  MaxCapacity: 0,
  MinCapacity: 0,
  RoleARN: 'STRING_VALUE'
};
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 AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

      Possible values include:
      • "ecs"
      • "elasticmapreduce"
      • "ec2"
      • "appstream"
      • "dynamodb"
    • 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/default/sample-webapp.

      • Spot fleet request - 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 resource ID. Example: table/my-table.

      • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

    • 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 desired task count of an ECS service.

      • ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot fleet request.

      • elasticmapreduce:instancegroup:InstanceCount - The instance count of an EMR Instance Group.

      • appstream:fleet:DesiredCapacity - The desired 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.

      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"
    • MinCapacity — (Integer)

      The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target and optional if you are updating one.

    • MaxCapacity — (Integer)

      The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target and optional if you are updating one.

    • RoleARN — (String)

      The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.

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.