The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Paws-0.40
River stage two • 9 direct dependents • 11 total dependents
57 ++
/ Paws::ApplicationAutoScaling

NAME

Paws::ApplicationAutoScaling - Perl Interface to AWS Application Auto Scaling

SYNOPSIS

  use Paws;

  my $obj = Paws->service('ApplicationAutoScaling');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

With Application Auto Scaling, you can configure automatic scaling for your scalable resources. You can use Application Auto Scaling to accomplish the following tasks:

  • Define scaling policies to automatically scale your AWS or custom resources

  • Scale your resources in response to CloudWatch alarms

  • Schedule one-time or recurring scaling actions

  • View the history of your scaling events

Application Auto Scaling can scale the following resources:

  • Amazon ECS services. For more information, see Service Auto Scaling (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html) in the Amazon Elastic Container Service Developer Guide.

  • Amazon EC2 Spot fleets. For more information, see Automatic Scaling for Spot Fleet (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html) in the Amazon EC2 User Guide.

  • Amazon EMR clusters. For more information, see Using Automatic Scaling in Amazon EMR (https://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html) in the Amazon EMR Management Guide.

  • AppStream 2.0 fleets. For more information, see Fleet Auto Scaling for Amazon AppStream 2.0 (https://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html) in the Amazon AppStream 2.0 Developer Guide.

  • Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see Managing Throughput Capacity Automatically with DynamoDB Auto Scaling (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html) in the Amazon DynamoDB Developer Guide.

  • Amazon Aurora Replicas. For more information, see Using Amazon Aurora Auto Scaling with Aurora Replicas (https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html).

  • Amazon SageMaker endpoint variants. For more information, see Automatically Scaling Amazon SageMaker Models (https://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html).

  • Custom resources provided by your own applications or services. More information is available in our GitHub repository (https://github.com/aws/aws-auto-scaling-custom-resource).

To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the Application Auto Scaling User Guide (https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/autoscaling-2016-02-06

METHODS

DeleteScalingPolicy

PolicyName => Str
ResourceId => Str
ScalableDimension => Str
ServiceNamespace => Str

Each argument is described in detail in: Paws::ApplicationAutoScaling::DeleteScalingPolicy

Returns: a Paws::ApplicationAutoScaling::DeleteScalingPolicyResponse instance

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.

DeleteScheduledAction

ResourceId => Str
ScheduledActionName => Str
ServiceNamespace => Str
[ScalableDimension => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::DeleteScheduledAction

Returns: a Paws::ApplicationAutoScaling::DeleteScheduledActionResponse instance

Deletes the specified Application Auto Scaling scheduled action.

DeregisterScalableTarget

ResourceId => Str
ScalableDimension => Str
ServiceNamespace => Str

Each argument is described in detail in: Paws::ApplicationAutoScaling::DeregisterScalableTarget

Returns: a Paws::ApplicationAutoScaling::DeregisterScalableTargetResponse instance

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.

DescribeScalableTargets

ServiceNamespace => Str
[MaxResults => Int]
[NextToken => Str]
[ResourceIds => ArrayRef[Str|Undef]]
[ScalableDimension => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::DescribeScalableTargets

Returns: a Paws::ApplicationAutoScaling::DescribeScalableTargetsResponse instance

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

DescribeScalingActivities

ServiceNamespace => Str
[MaxResults => Int]
[NextToken => Str]
[ResourceId => Str]
[ScalableDimension => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::DescribeScalingActivities

Returns: a Paws::ApplicationAutoScaling::DescribeScalingActivitiesResponse instance

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.

DescribeScalingPolicies

ServiceNamespace => Str
[MaxResults => Int]
[NextToken => Str]
[PolicyNames => ArrayRef[Str|Undef]]
[ResourceId => Str]
[ScalableDimension => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::DescribeScalingPolicies

Returns: a Paws::ApplicationAutoScaling::DescribeScalingPoliciesResponse instance

Describes the scaling policies for the specified service 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.

DescribeScheduledActions

ServiceNamespace => Str
[MaxResults => Int]
[NextToken => Str]
[ResourceId => Str]
[ScalableDimension => Str]
[ScheduledActionNames => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::ApplicationAutoScaling::DescribeScheduledActions

Returns: a Paws::ApplicationAutoScaling::DescribeScheduledActionsResponse instance

Describes the scheduled actions for the specified service namespace.

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

To create a scheduled action or update an existing one, see PutScheduledAction. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

PutScalingPolicy

PolicyName => Str
ResourceId => Str
ScalableDimension => Str
ServiceNamespace => Str
[PolicyType => Str]
[StepScalingPolicyConfiguration => Paws::ApplicationAutoScaling::StepScalingPolicyConfiguration]
[TargetTrackingScalingPolicyConfiguration => Paws::ApplicationAutoScaling::TargetTrackingScalingPolicyConfiguration]

Each argument is described in detail in: Paws::ApplicationAutoScaling::PutScalingPolicy

Returns: a Paws::ApplicationAutoScaling::PutScalingPolicyResponse instance

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 until you have registered the resource as 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.

PutScheduledAction

ResourceId => Str
ScheduledActionName => Str
ServiceNamespace => Str
[EndTime => Str]
[ScalableDimension => Str]
[ScalableTargetAction => Paws::ApplicationAutoScaling::ScalableTargetAction]
[Schedule => Str]
[StartTime => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::PutScheduledAction

Returns: a Paws::ApplicationAutoScaling::PutScheduledActionResponse instance

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 using RegisterScalableTarget.

To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.

You can view the scheduled actions using DescribeScheduledActions. If you are no longer using a scheduled action, you can delete it using DeleteScheduledAction.

RegisterScalableTarget

ResourceId => Str
ScalableDimension => Str
ServiceNamespace => Str
[MaxCapacity => Int]
[MinCapacity => Int]
[RoleARN => Str]

Each argument is described in detail in: Paws::ApplicationAutoScaling::RegisterScalableTarget

Returns: a Paws::ApplicationAutoScaling::RegisterScalableTargetResponse instance

Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale in and scale out. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity.

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 using DescribeScalableTargets.

If you no longer need a scalable target, you can deregister it using DeregisterScalableTarget.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllScalableTargets(sub { },ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceIds => ArrayRef[Str|Undef], ScalableDimension => Str])

DescribeAllScalableTargets(ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceIds => ArrayRef[Str|Undef], ScalableDimension => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ScalableTargets, passing the object as the first parameter, and the string 'ScalableTargets' as the second parameter

If not, it will return a a Paws::ApplicationAutoScaling::DescribeScalableTargetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllScalingActivities(sub { },ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceId => Str, ScalableDimension => Str])

DescribeAllScalingActivities(ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceId => Str, ScalableDimension => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ScalingActivities, passing the object as the first parameter, and the string 'ScalingActivities' as the second parameter

If not, it will return a a Paws::ApplicationAutoScaling::DescribeScalingActivitiesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllScalingPolicies(sub { },ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, PolicyNames => ArrayRef[Str|Undef], ResourceId => Str, ScalableDimension => Str])

DescribeAllScalingPolicies(ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, PolicyNames => ArrayRef[Str|Undef], ResourceId => Str, ScalableDimension => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ScalingPolicies, passing the object as the first parameter, and the string 'ScalingPolicies' as the second parameter

If not, it will return a a Paws::ApplicationAutoScaling::DescribeScalingPoliciesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllScheduledActions(sub { },ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceId => Str, ScalableDimension => Str, ScheduledActionNames => ArrayRef[Str|Undef]])

DescribeAllScheduledActions(ServiceNamespace => Str, [MaxResults => Int, NextToken => Str, ResourceId => Str, ScalableDimension => Str, ScheduledActionNames => ArrayRef[Str|Undef]])

If passed a sub as first parameter, it will call the sub for each element found in :

 - ScheduledActions, passing the object as the first parameter, and the string 'ScheduledActions' as the second parameter

If not, it will return a a Paws::ApplicationAutoScaling::DescribeScheduledActionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues