@aws-sdk/client-auto-scaling-plans 3.379.1 → 3.382.0

package/dist-types/models/models_0.d.ts

@@ -20,10 +20,12 @@ export declare class ConcurrentUpdateException extends __BaseException {
  */
 export interface TagFilter {
     /**
+     * @public
      * <p>The tag key.</p>
      */
     Key?: string;
     /**
+     * @public
      * <p>The tag values (0 to 20).</p>
      */
     Values?: string[];
@@ -34,10 +36,12 @@ export interface TagFilter {
  */
 export interface ApplicationSource {
     /**
+     * @public
      * <p>The Amazon Resource Name (ARN) of a AWS CloudFormation stack.</p>
      */
     CloudFormationStackARN?: string;
     /**
+     * @public
      * <p>A set of tags (up to 50).</p>
      */
     TagFilters?: TagFilter[];
@@ -48,10 +52,12 @@ export interface ApplicationSource {
  */
 export interface MetricDimension {
     /**
+     * @public
      * <p>The name of the dimension.</p>
      */
     Name: string | undefined;
     /**
+     * @public
      * <p>The value of the dimension.</p>
      */
     Value: string | undefined;
@@ -100,24 +106,29 @@ export type MetricStatistic = (typeof MetricStatistic)[keyof typeof MetricStatis
  */
 export interface CustomizedLoadMetricSpecification {
     /**
+     * @public
      * <p>The name of the metric.</p>
      */
     MetricName: string | undefined;
     /**
+     * @public
      * <p>The namespace of the metric.</p>
      */
     Namespace: string | undefined;
     /**
+     * @public
      * <p>The dimensions of the metric.</p>
      *          <p>Conditional: If you published your metric with dimensions, you must specify the same
      *          dimensions in your customized load metric specification.</p>
      */
     Dimensions?: MetricDimension[];
     /**
+     * @public
      * <p>The statistic of the metric. The only valid value is <code>Sum</code>.</p>
      */
     Statistic: MetricStatistic | string | undefined;
     /**
+     * @public
      * <p>The unit of the metric.</p>
      */
     Unit?: string;
@@ -146,10 +157,12 @@ export type LoadMetricType = (typeof LoadMetricType)[keyof typeof LoadMetricType
  */
 export interface PredefinedLoadMetricSpecification {
     /**
+     * @public
      * <p>The metric type.</p>
      */
     PredefinedLoadMetricType: LoadMetricType | string | undefined;
     /**
+     * @public
      * <p>Identifies the resource associated with the metric type. You can't specify a resource
      *          label unless the metric type is <code>ALBTargetGroupRequestCount</code> and there is a
      *          target group for an Application Load Balancer attached to the Auto Scaling group.</p>
@@ -269,24 +282,29 @@ export type ServiceNamespace = (typeof ServiceNamespace)[keyof typeof ServiceNam
  */
 export interface CustomizedScalingMetricSpecification {
     /**
+     * @public
      * <p>The name of the metric.</p>
      */
     MetricName: string | undefined;
     /**
+     * @public
      * <p>The namespace of the metric.</p>
      */
     Namespace: string | undefined;
     /**
+     * @public
      * <p>The dimensions of the metric.</p>
      *          <p>Conditional: If you published your metric with dimensions, you must specify the same
      *          dimensions in your customized scaling metric specification.</p>
      */
     Dimensions?: MetricDimension[];
     /**
+     * @public
      * <p>The statistic of the metric.</p>
      */
     Statistic: MetricStatistic | string | undefined;
     /**
+     * @public
      * <p>The unit of the metric. </p>
      */
     Unit?: string;
@@ -321,11 +339,13 @@ export type ScalingMetricType = (typeof ScalingMetricType)[keyof typeof ScalingM
  */
 export interface PredefinedScalingMetricSpecification {
     /**
+     * @public
      * <p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to
      *          Auto Scaling groups, Spot Fleet requests, and ECS services.</p>
      */
     PredefinedScalingMetricType: ScalingMetricType | string | undefined;
     /**
+     * @public
      * <p>Identifies the resource associated with the metric type. You can't specify a resource
      *          label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target
      *          group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or
@@ -358,22 +378,26 @@ export interface PredefinedScalingMetricSpecification {
  */
 export interface TargetTrackingConfiguration {
     /**
+     * @public
      * <p>A predefined metric. You can specify either a predefined metric or a customized
      *          metric.</p>
      */
     PredefinedScalingMetricSpecification?: PredefinedScalingMetricSpecification;
     /**
+     * @public
      * <p>A customized metric. You can specify either a predefined metric or a customized metric.
      *       </p>
      */
     CustomizedScalingMetricSpecification?: CustomizedScalingMetricSpecification;
     /**
+     * @public
      * <p>The target value for the metric. Although this property accepts numbers of type Double,
      *          it won't accept values that are either too small or too large. Values must be in the range
      *          of -2^360 to 2^360.</p>
      */
     TargetValue: number | undefined;
     /**
+     * @public
      * <p>Indicates whether scale in by the target tracking scaling policy is disabled. If the
      *          value is <code>true</code>, scale in is disabled and the target tracking scaling policy
      *          doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the
@@ -382,6 +406,7 @@ export interface TargetTrackingConfiguration {
      */
     DisableScaleIn?: boolean;
     /**
+     * @public
      * <p>The amount of time, in seconds, to wait for a previous scale-out activity to take
      *          effect. This property is not used if the scalable resource is an Auto Scaling
      *          group.</p>
@@ -393,6 +418,7 @@ export interface TargetTrackingConfiguration {
      */
     ScaleOutCooldown?: number;
     /**
+     * @public
      * <p>The amount of time, in seconds, after a scale-in activity completes before another
      *          scale-in activity can start. This property is not used if the scalable resource is an Auto Scaling
      *          group.</p>
@@ -404,6 +430,7 @@ export interface TargetTrackingConfiguration {
      */
     ScaleInCooldown?: number;
     /**
+     * @public
      * <p>The estimated time, in seconds, until a newly launched instance can contribute to the
      *          CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.</p>
      */
@@ -432,10 +459,12 @@ export interface TargetTrackingConfiguration {
  */
 export interface ScalingInstruction {
     /**
+     * @public
      * <p>The namespace of the AWS service.</p>
      */
     ServiceNamespace: ServiceNamespace | string | undefined;
     /**
+     * @public
      * <p>The ID of the resource. This string consists of the resource type and unique
      *          identifier.</p>
      *          <ul>
@@ -467,6 +496,7 @@ export interface ScalingInstruction {
      */
     ResourceId: string | undefined;
     /**
+     * @public
      * <p>The scalable dimension associated with the resource.</p>
      *          <ul>
      *             <li>
@@ -505,30 +535,36 @@ export interface ScalingInstruction {
      */
     ScalableDimension: ScalableDimension | string | undefined;
     /**
+     * @public
      * <p>The minimum capacity of the resource. </p>
      */
     MinCapacity: number | undefined;
     /**
+     * @public
      * <p>The maximum capacity of the resource. The exception to this upper limit is if you
      *          specify a non-default setting for <b>PredictiveScalingMaxCapacityBehavior</b>. </p>
      */
     MaxCapacity: number | undefined;
     /**
+     * @public
      * <p>The target tracking configurations (up to 10). Each of these structures must specify a
      *          unique scaling metric and a target value for the metric. </p>
      */
     TargetTrackingConfigurations: TargetTrackingConfiguration[] | undefined;
     /**
+     * @public
      * <p>The predefined load metric to use for predictive scaling. This parameter or a <b>CustomizedLoadMetricSpecification</b> is required when configuring
      *          predictive scaling, and cannot be used otherwise. </p>
      */
     PredefinedLoadMetricSpecification?: PredefinedLoadMetricSpecification;
     /**
+     * @public
      * <p>The customized load metric to use for predictive scaling. This parameter or a <b>PredefinedLoadMetricSpecification</b> is required when configuring
      *          predictive scaling, and cannot be used otherwise. </p>
      */
     CustomizedLoadMetricSpecification?: CustomizedLoadMetricSpecification;
     /**
+     * @public
      * <p>The amount of time, in seconds, to buffer the run time of scheduled scaling actions when
      *          scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer
      *          time is 5 minutes, then the run time of the corresponding scheduled scaling action will be
@@ -542,6 +578,7 @@ export interface ScalingInstruction {
      */
     ScheduledActionBufferTime?: number;
     /**
+     * @public
      * <p>Defines the behavior that should be applied if the forecast capacity approaches or
      *          exceeds the maximum capacity specified for the resource. The default value is
      *             <code>SetForecastCapacityToMaxCapacity</code>.</p>
@@ -571,6 +608,7 @@ export interface ScalingInstruction {
      */
     PredictiveScalingMaxCapacityBehavior?: PredictiveScalingMaxCapacityBehavior | string;
     /**
+     * @public
      * <p>The size of the capacity buffer to use when the forecast capacity is close to or exceeds
      *          the maximum capacity. The value is specified as a percentage relative to the forecast
      *          capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if
@@ -582,12 +620,14 @@ export interface ScalingInstruction {
      */
     PredictiveScalingMaxCapacityBuffer?: number;
     /**
+     * @public
      * <p>The predictive scaling mode. The default value is <code>ForecastAndScale</code>.
      *          Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions
      *          based on the capacity forecast. </p>
      */
     PredictiveScalingMode?: PredictiveScalingMode | string;
     /**
+     * @public
      * <p>Controls whether a resource's externally created scaling policies are kept or replaced. </p>
      *          <p>The default value is <code>KeepExternalPolicies</code>. If the parameter is set to
      *             <code>ReplaceExternalPolicies</code>, any scaling policies that are external to AWS Auto Scaling
@@ -599,6 +639,7 @@ export interface ScalingInstruction {
      */
     ScalingPolicyUpdateBehavior?: ScalingPolicyUpdateBehavior | string;
     /**
+     * @public
      * <p>Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is
      *          enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target
      *          tracking configurations. </p>
@@ -611,17 +652,20 @@ export interface ScalingInstruction {
  */
 export interface CreateScalingPlanRequest {
     /**
+     * @public
      * <p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward
      *          slashes.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>A CloudFormation stack or set of tags. You can create one scaling plan per application
      *          source.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html">ApplicationSource</a> in the <i>AWS Auto Scaling API Reference</i>.</p>
      */
     ApplicationSource: ApplicationSource | undefined;
     /**
+     * @public
      * <p>The scaling instructions.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html">ScalingInstruction</a> in the <i>AWS Auto Scaling API Reference</i>.</p>
      */
@@ -632,6 +676,7 @@ export interface CreateScalingPlanRequest {
  */
 export interface CreateScalingPlanResponse {
     /**
+     * @public
      * <p>The version number of the scaling plan. This value is always <code>1</code>. Currently,
      *          you cannot have multiple scaling plan versions.</p>
      */
@@ -682,10 +727,12 @@ export declare class ValidationException extends __BaseException {
  */
 export interface DeleteScalingPlanRequest {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan. Currently, the only valid value is
      *             <code>1</code>.</p>
      */
@@ -714,20 +761,24 @@ export declare class ObjectNotFoundException extends __BaseException {
  */
 export interface DescribeScalingPlanResourcesRequest {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan. Currently, the only valid value is
      *             <code>1</code>.</p>
      */
     ScalingPlanVersion: number | undefined;
     /**
+     * @public
      * <p>The maximum number of scalable resources to return. The value must be between
      *          1 and 50. The default value is 50.</p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results.</p>
      */
     NextToken?: string;
@@ -749,14 +800,17 @@ export type PolicyType = (typeof PolicyType)[keyof typeof PolicyType];
  */
 export interface ScalingPolicy {
     /**
+     * @public
      * <p>The name of the scaling policy.</p>
      */
     PolicyName: string | undefined;
     /**
+     * @public
      * <p>The type of scaling policy.</p>
      */
     PolicyType: PolicyType | string | undefined;
     /**
+     * @public
      * <p>The target tracking scaling policy. Includes support for predefined or customized
      *          metrics.</p>
      */
@@ -781,18 +835,22 @@ export type ScalingStatusCode = (typeof ScalingStatusCode)[keyof typeof ScalingS
  */
 export interface ScalingPlanResource {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan.</p>
      */
     ScalingPlanVersion: number | undefined;
     /**
+     * @public
      * <p>The namespace of the AWS service.</p>
      */
     ServiceNamespace: ServiceNamespace | string | undefined;
     /**
+     * @public
      * <p>The ID of the resource. This string consists of the resource type and unique
      *          identifier.</p>
      *          <ul>
@@ -824,6 +882,7 @@ export interface ScalingPlanResource {
      */
     ResourceId: string | undefined;
     /**
+     * @public
      * <p>The scalable dimension for the resource.</p>
      *          <ul>
      *             <li>
@@ -862,10 +921,12 @@ export interface ScalingPlanResource {
      */
     ScalableDimension: ScalableDimension | string | undefined;
     /**
+     * @public
      * <p>The scaling policies.</p>
      */
     ScalingPolicies?: ScalingPolicy[];
     /**
+     * @public
      * <p>The scaling status of the resource.</p>
      *          <ul>
      *             <li>
@@ -888,6 +949,7 @@ export interface ScalingPlanResource {
      */
     ScalingStatusCode: ScalingStatusCode | string | undefined;
     /**
+     * @public
      * <p>A simple message about the current scaling status of the resource.</p>
      */
     ScalingStatusMessage?: string;
@@ -897,10 +959,12 @@ export interface ScalingPlanResource {
  */
 export interface DescribeScalingPlanResourcesResponse {
     /**
+     * @public
      * <p>Information about the scalable resources.</p>
      */
     ScalingPlanResources?: ScalingPlanResource[];
     /**
+     * @public
      * <p>The token required to get the next set of results. This value is <code>null</code> if
      *          there are no more results to return.</p>
      */
@@ -924,11 +988,13 @@ export declare class InvalidNextTokenException extends __BaseException {
  */
 export interface DescribeScalingPlansRequest {
     /**
+     * @public
      * <p>The names of the scaling plans (up to 10). If you specify application sources, you
      *          cannot specify scaling plan names.</p>
      */
     ScalingPlanNames?: string[];
     /**
+     * @public
      * <p>The version number of the scaling plan. Currently, the only valid value is
      *             <code>1</code>.</p>
      *          <note>
@@ -938,16 +1004,19 @@ export interface DescribeScalingPlansRequest {
      */
     ScalingPlanVersion?: number;
     /**
+     * @public
      * <p>The sources for the applications (up to 10). If you specify scaling plan names, you
      *          cannot specify application sources.</p>
      */
     ApplicationSources?: ApplicationSource[];
     /**
+     * @public
      * <p>The maximum number of scalable resources to return. This value can be between
      *          1 and 50. The default value is 50.</p>
      */
     MaxResults?: number;
     /**
+     * @public
      * <p>The token for the next set of results.</p>
      */
     NextToken?: string;
@@ -976,23 +1045,28 @@ export type ScalingPlanStatusCode = (typeof ScalingPlanStatusCode)[keyof typeof
  */
 export interface ScalingPlan {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan.</p>
      */
     ScalingPlanVersion: number | undefined;
     /**
+     * @public
      * <p>A CloudFormation stack or a set of tags. You can create one scaling plan per application
      *          source.</p>
      */
     ApplicationSource: ApplicationSource | undefined;
     /**
+     * @public
      * <p>The scaling instructions.</p>
      */
     ScalingInstructions: ScalingInstruction[] | undefined;
     /**
+     * @public
      * <p>The status of the scaling plan.</p>
      *          <ul>
      *             <li>
@@ -1032,14 +1106,17 @@ export interface ScalingPlan {
      */
     StatusCode: ScalingPlanStatusCode | string | undefined;
     /**
+     * @public
      * <p>A simple message about the current status of the scaling plan.</p>
      */
     StatusMessage?: string;
     /**
+     * @public
      * <p>The Unix time stamp when the scaling plan entered the current status.</p>
      */
     StatusStartTime?: Date;
     /**
+     * @public
      * <p>The Unix time stamp when the scaling plan was created.</p>
      */
     CreationTime?: Date;
@@ -1049,10 +1126,12 @@ export interface ScalingPlan {
  */
 export interface DescribeScalingPlansResponse {
     /**
+     * @public
      * <p>Information about the scaling plans.</p>
      */
     ScalingPlans?: ScalingPlan[];
     /**
+     * @public
      * <p>The token required to get the next set of results. This value is <code>null</code> if
      *          there are no more results to return.</p>
      */
@@ -1077,31 +1156,37 @@ export type ForecastDataType = (typeof ForecastDataType)[keyof typeof ForecastDa
  */
 export interface GetScalingPlanResourceForecastDataRequest {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan. Currently, the only valid value is
      *             <code>1</code>.</p>
      */
     ScalingPlanVersion: number | undefined;
     /**
+     * @public
      * <p>The namespace of the AWS service. The only valid value is <code>autoscaling</code>.
      *       </p>
      */
     ServiceNamespace: ServiceNamespace | string | undefined;
     /**
+     * @public
      * <p>The ID of the resource. This string consists of a prefix (<code>autoScalingGroup</code>)
      *          followed by the name of a specified Auto Scaling group (<code>my-asg</code>). Example:
      *             <code>autoScalingGroup/my-asg</code>. </p>
      */
     ResourceId: string | undefined;
     /**
+     * @public
      * <p>The scalable dimension for the resource. The only valid value is
      *             <code>autoscaling:autoScalingGroup:DesiredCapacity</code>. </p>
      */
     ScalableDimension: ScalableDimension | string | undefined;
     /**
+     * @public
      * <p>The type of forecast data to get.</p>
      *          <ul>
      *             <li>
@@ -1128,11 +1213,13 @@ export interface GetScalingPlanResourceForecastDataRequest {
      */
     ForecastDataType: ForecastDataType | string | undefined;
     /**
+     * @public
      * <p>The inclusive start time of the time range for the forecast data to get. The date and
      *          time can be at most 56 days before the current date and time. </p>
      */
     StartTime: Date | undefined;
     /**
+     * @public
      * <p>The exclusive end time of the time range for the forecast data to get. The maximum time
      *          duration between the start and end time is seven days. </p>
      *          <p>Although this parameter can accept a date and time that is more than two days in the
@@ -1147,10 +1234,12 @@ export interface GetScalingPlanResourceForecastDataRequest {
  */
 export interface Datapoint {
     /**
+     * @public
      * <p>The time stamp for the data point in UTC format.</p>
      */
     Timestamp?: Date;
     /**
+     * @public
      * <p>The value of the data point.</p>
      */
     Value?: number;
@@ -1160,6 +1249,7 @@ export interface Datapoint {
  */
 export interface GetScalingPlanResourceForecastDataResponse {
     /**
+     * @public
      * <p>The data points to return.</p>
      */
     Datapoints: Datapoint[] | undefined;
@@ -1169,20 +1259,24 @@ export interface GetScalingPlanResourceForecastDataResponse {
  */
 export interface UpdateScalingPlanRequest {
     /**
+     * @public
      * <p>The name of the scaling plan.</p>
      */
     ScalingPlanName: string | undefined;
     /**
+     * @public
      * <p>The version number of the scaling plan. The only valid value is <code>1</code>.
      *          Currently, you cannot have multiple scaling plan versions.</p>
      */
     ScalingPlanVersion: number | undefined;
     /**
+     * @public
      * <p>A CloudFormation stack or set of tags.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ApplicationSource.html">ApplicationSource</a> in the <i>AWS Auto Scaling API Reference</i>.</p>
      */
     ApplicationSource?: ApplicationSource;
     /**
+     * @public
      * <p>The scaling instructions.</p>
      *          <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/plans/APIReference/API_ScalingInstruction.html">ScalingInstruction</a> in the <i>AWS Auto Scaling API Reference</i>.</p>
      */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-auto-scaling-plans",
   "description": "AWS SDK for JavaScript Auto Scaling Plans Client for Node.js, Browser and React Native",
-  "version": "3.379.1",
+  "version": "3.382.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.379.1",
-    "@aws-sdk/credential-provider-node": "3.379.1",
+    "@aws-sdk/client-sts": "3.382.0",
+    "@aws-sdk/credential-provider-node": "3.382.0",
     "@aws-sdk/middleware-host-header": "3.379.1",
     "@aws-sdk/middleware-logger": "3.378.0",
     "@aws-sdk/middleware-recursion-detection": "3.378.0",
     "@aws-sdk/middleware-signing": "3.379.1",
-    "@aws-sdk/middleware-user-agent": "3.379.1",
+    "@aws-sdk/middleware-user-agent": "3.382.0",
     "@aws-sdk/types": "3.378.0",
-    "@aws-sdk/util-endpoints": "3.378.0",
+    "@aws-sdk/util-endpoints": "3.382.0",
     "@aws-sdk/util-user-agent-browser": "3.378.0",
     "@aws-sdk/util-user-agent-node": "3.378.0",
     "@smithy/config-resolver": "^2.0.1",