AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Implementation for accessing AutoScalingPlans AWS Auto Scaling

Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services.

Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.

For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the AWS Auto Scaling User Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.AutoScalingPlans.AmazonAutoScalingPlansClient

Namespace: Amazon.AutoScalingPlans
Assembly: AWSSDK.AutoScalingPlans.dll
Version: 3.x.y.z

Syntax

C#
public class AmazonAutoScalingPlansClient : AmazonServiceClient
         IAmazonAutoScalingPlans, IAmazonService, IDisposable

The AmazonAutoScalingPlansClient type exposes the following members

Constructors

NameDescription
Public Method AmazonAutoScalingPlansClient()

Constructs AmazonAutoScalingPlansClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAutoScalingPlansClient(RegionEndpoint)

Constructs AmazonAutoScalingPlansClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAutoScalingPlansClient(AmazonAutoScalingPlansConfig)

Constructs AmazonAutoScalingPlansClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonAutoScalingPlansClient(AWSCredentials)

Constructs AmazonAutoScalingPlansClient with AWS Credentials

Public Method AmazonAutoScalingPlansClient(AWSCredentials, RegionEndpoint)

Constructs AmazonAutoScalingPlansClient with AWS Credentials

Public Method AmazonAutoScalingPlansClient(AWSCredentials, AmazonAutoScalingPlansConfig)

Constructs AmazonAutoScalingPlansClient with AWS Credentials and an AmazonAutoScalingPlansClient Configuration object.

Public Method AmazonAutoScalingPlansClient(string, string)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAutoScalingPlansClient(string, string, RegionEndpoint)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAutoScalingPlansClient(string, string, AmazonAutoScalingPlansConfig)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingPlansClient Configuration object.

Public Method AmazonAutoScalingPlansClient(string, string, string)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAutoScalingPlansClient(string, string, string, RegionEndpoint)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonAutoScalingPlansClient(string, string, string, AmazonAutoScalingPlansConfig)

Constructs AmazonAutoScalingPlansClient with AWS Access Key ID, AWS Secret Key and an AmazonAutoScalingPlansClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method CreateScalingPlan(CreateScalingPlanRequest)

Creates a scaling plan.

Public Method CreateScalingPlanAsync(CreateScalingPlanRequest, CancellationToken)

Creates a scaling plan.

Public Method DeleteScalingPlan(DeleteScalingPlanRequest)

Deletes the specified scaling plan.

Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

Public Method DeleteScalingPlanAsync(DeleteScalingPlanRequest, CancellationToken)

Deletes the specified scaling plan.

Deleting a scaling plan deletes the underlying ScalingInstruction for all of the scalable resources that are covered by the plan.

If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.

Public Method DescribeScalingPlanResources(DescribeScalingPlanResourcesRequest)

Describes the scalable resources in the specified scaling plan.

Public Method DescribeScalingPlanResourcesAsync(DescribeScalingPlanResourcesRequest, CancellationToken)

Describes the scalable resources in the specified scaling plan.

Public Method DescribeScalingPlans(DescribeScalingPlansRequest)

Describes one or more of your scaling plans.

Public Method DescribeScalingPlansAsync(DescribeScalingPlansRequest, CancellationToken)

Describes one or more of your scaling plans.

Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method GetScalingPlanResourceForecastData(GetScalingPlanResourceForecastDataRequest)

Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

Public Method GetScalingPlanResourceForecastDataAsync(GetScalingPlanResourceForecastDataRequest, CancellationToken)

Retrieves the forecast data for a scalable resource.

Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days.

Public Method UpdateScalingPlan(UpdateScalingPlanRequest)

Updates the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

Public Method UpdateScalingPlanAsync(UpdateScalingPlanRequest, CancellationToken)

Updates the specified scaling plan.

You cannot update a scaling plan if it is in the process of being created, updated, or deleted.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms