@aws-sdk/client-auto-scaling-plans 3.296.0 → 3.298.0

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

@@ -1,6 +1,7 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
 import { AutoScalingPlansServiceException as __BaseException } from "./AutoScalingPlansServiceException";
 /**
+ * @public
  * <p>Concurrent updates caused an exception, for example, if you request an update to a
  *          scaling plan that already has a pending update.</p>
  */
@@ -14,6 +15,7 @@ export declare class ConcurrentUpdateException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ConcurrentUpdateException, __BaseException>);
 }
 /**
+ * @public
  * <p>Represents a tag.</p>
  */
 export interface TagFilter {
@@ -27,6 +29,7 @@ export interface TagFilter {
     Values?: string[];
 }
 /**
+ * @public
  * <p>Represents an application source.</p>
  */
 export interface ApplicationSource {
@@ -40,6 +43,7 @@ export interface ApplicationSource {
     TagFilters?: TagFilter[];
 }
 /**
+ * @public
  * <p>Represents a dimension for a customized metric.</p>
  */
 export interface MetricDimension {
@@ -52,6 +56,9 @@ export interface MetricDimension {
      */
     Value: string | undefined;
 }
+/**
+ * @public
+ */
 export declare enum MetricStatistic {
     Average = "Average",
     Maximum = "Maximum",
@@ -60,6 +67,7 @@ export declare enum MetricStatistic {
     Sum = "Sum"
 }
 /**
+ * @public
  * <p>Represents a CloudWatch metric of your choosing that can be used for predictive scaling. </p>
  *          <p>For predictive scaling to work with a customized load metric specification, AWS Auto Scaling
  *          needs access to the <code>Sum</code> and <code>Average</code> statistics that CloudWatch computes
@@ -109,6 +117,9 @@ export interface CustomizedLoadMetricSpecification {
      */
     Unit?: string;
 }
+/**
+ * @public
+ */
 export declare enum LoadMetricType {
     ALBTargetGroupRequestCount = "ALBTargetGroupRequestCount",
     ASGTotalCPUUtilization = "ASGTotalCPUUtilization",
@@ -116,6 +127,7 @@ export declare enum LoadMetricType {
     ASGTotalNetworkOut = "ASGTotalNetworkOut"
 }
 /**
+ * @public
  * <p>Represents a predefined metric that can be used for predictive scaling.</p>
  *          <p>After creating your scaling plan, you can use the AWS Auto Scaling console to visualize
  *          forecasts for the specified metric. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/plans/userguide/gs-create-scaling-plan.html#gs-view-resource">View
@@ -153,15 +165,24 @@ export interface PredefinedLoadMetricSpecification {
      */
     ResourceLabel?: string;
 }
+/**
+ * @public
+ */
 export declare enum PredictiveScalingMaxCapacityBehavior {
     SetForecastCapacityToMaxCapacity = "SetForecastCapacityToMaxCapacity",
     SetMaxCapacityAboveForecastCapacity = "SetMaxCapacityAboveForecastCapacity",
     SetMaxCapacityToForecastCapacity = "SetMaxCapacityToForecastCapacity"
 }
+/**
+ * @public
+ */
 export declare enum PredictiveScalingMode {
     ForecastAndScale = "ForecastAndScale",
     ForecastOnly = "ForecastOnly"
 }
+/**
+ * @public
+ */
 export declare enum ScalableDimension {
     AutoScalingGroupDesiredCapacity = "autoscaling:autoScalingGroup:DesiredCapacity",
     DynamoDBIndexReadCapacityUnits = "dynamodb:index:ReadCapacityUnits",
@@ -172,10 +193,16 @@ export declare enum ScalableDimension {
     ECSServiceDesiredCount = "ecs:service:DesiredCount",
     RDSClusterReadReplicaCount = "rds:cluster:ReadReplicaCount"
 }
+/**
+ * @public
+ */
 export declare enum ScalingPolicyUpdateBehavior {
     KeepExternalPolicies = "KeepExternalPolicies",
     ReplaceExternalPolicies = "ReplaceExternalPolicies"
 }
+/**
+ * @public
+ */
 export declare enum ServiceNamespace {
     AUTOSCALING = "autoscaling",
     DYNAMODB = "dynamodb",
@@ -184,6 +211,7 @@ export declare enum ServiceNamespace {
     RDS = "rds"
 }
 /**
+ * @public
  * <p>Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part
  *          of a target tracking scaling policy. </p>
  *          <p>To create your customized scaling metric specification:</p>
@@ -228,6 +256,9 @@ export interface CustomizedScalingMetricSpecification {
      */
     Unit?: string;
 }
+/**
+ * @public
+ */
 export declare enum ScalingMetricType {
     ALBRequestCountPerTarget = "ALBRequestCountPerTarget",
     ASGAverageCPUUtilization = "ASGAverageCPUUtilization",
@@ -244,6 +275,7 @@ export declare enum ScalingMetricType {
     RDSReaderAverageDatabaseConnections = "RDSReaderAverageDatabaseConnections"
 }
 /**
+ * @public
  * <p>Represents a predefined metric that can be used for dynamic scaling as part of a target
  *          tracking scaling policy.</p>
  */
@@ -281,6 +313,7 @@ export interface PredefinedScalingMetricSpecification {
     ResourceLabel?: string;
 }
 /**
+ * @public
  * <p>Describes a target tracking configuration to use with AWS Auto Scaling. Used with <a>ScalingInstruction</a> and <a>ScalingPolicy</a>.</p>
  */
 export interface TargetTrackingConfiguration {
@@ -337,6 +370,7 @@ export interface TargetTrackingConfiguration {
     EstimatedInstanceWarmup?: number;
 }
 /**
+ * @public
  * <p>Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling
  *          instruction applies to one resource.</p>
  *          <p>AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions.
@@ -532,6 +566,9 @@ export interface ScalingInstruction {
      */
     DisableDynamicScaling?: boolean;
 }
+/**
+ * @public
+ */
 export interface CreateScalingPlanRequest {
     /**
      * <p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward
@@ -550,6 +587,9 @@ export interface CreateScalingPlanRequest {
      */
     ScalingInstructions: ScalingInstruction[] | undefined;
 }
+/**
+ * @public
+ */
 export interface CreateScalingPlanResponse {
     /**
      * <p>The version number of the scaling plan. This value is always <code>1</code>. Currently,
@@ -558,6 +598,7 @@ export interface CreateScalingPlanResponse {
     ScalingPlanVersion: number | undefined;
 }
 /**
+ * @public
  * <p>The service encountered an internal error.</p>
  */
 export declare class InternalServiceException extends __BaseException {
@@ -570,6 +611,7 @@ export declare class InternalServiceException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
 }
 /**
+ * @public
  * <p>Your account exceeded a limit. This exception is thrown when a per-account resource
  *          limit is exceeded.</p>
  */
@@ -583,6 +625,7 @@ export declare class LimitExceededException extends __BaseException {
     constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
 }
 /**
+ * @public
  * <p>An exception was thrown for a validation issue. Review the parameters provided.</p>
  */
 export declare class ValidationException extends __BaseException {
@@ -594,6 +637,9 @@ export declare class ValidationException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DeleteScalingPlanRequest {
     /**
      * <p>The name of the scaling plan.</p>
@@ -605,9 +651,13 @@ export interface DeleteScalingPlanRequest {
      */
     ScalingPlanVersion: number | undefined;
 }
+/**
+ * @public
+ */
 export interface DeleteScalingPlanResponse {
 }
 /**
+ * @public
  * <p>The specified object could not be found.</p>
  */
 export declare class ObjectNotFoundException extends __BaseException {
@@ -619,6 +669,9 @@ export declare class ObjectNotFoundException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ObjectNotFoundException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeScalingPlanResourcesRequest {
     /**
      * <p>The name of the scaling plan.</p>
@@ -639,10 +692,14 @@ export interface DescribeScalingPlanResourcesRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum PolicyType {
     TargetTrackingScaling = "TargetTrackingScaling"
 }
 /**
+ * @public
  * <p>Represents a scaling policy.</p>
  */
 export interface ScalingPolicy {
@@ -660,12 +717,16 @@ export interface ScalingPolicy {
      */
     TargetTrackingConfiguration?: TargetTrackingConfiguration;
 }
+/**
+ * @public
+ */
 export declare enum ScalingStatusCode {
     Active = "Active",
     Inactive = "Inactive",
     PartiallyActive = "PartiallyActive"
 }
 /**
+ * @public
  * <p>Represents a scalable resource.</p>
  */
 export interface ScalingPlanResource {
@@ -781,6 +842,9 @@ export interface ScalingPlanResource {
      */
     ScalingStatusMessage?: string;
 }
+/**
+ * @public
+ */
 export interface DescribeScalingPlanResourcesResponse {
     /**
      * <p>Information about the scalable resources.</p>
@@ -793,6 +857,7 @@ export interface DescribeScalingPlanResourcesResponse {
     NextToken?: string;
 }
 /**
+ * @public
  * <p>The token provided is not valid.</p>
  */
 export declare class InvalidNextTokenException extends __BaseException {
@@ -804,6 +869,9 @@ export declare class InvalidNextTokenException extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
 }
+/**
+ * @public
+ */
 export interface DescribeScalingPlansRequest {
     /**
      * <p>The names of the scaling plans (up to 10). If you specify application sources, you
@@ -834,6 +902,9 @@ export interface DescribeScalingPlansRequest {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ScalingPlanStatusCode {
     Active = "Active",
     ActiveWithProblems = "ActiveWithProblems",
@@ -845,6 +916,7 @@ export declare enum ScalingPlanStatusCode {
     UpdateInProgress = "UpdateInProgress"
 }
 /**
+ * @public
  * <p>Represents a scaling plan.</p>
  */
 export interface ScalingPlan {
@@ -917,6 +989,9 @@ export interface ScalingPlan {
      */
     CreationTime?: Date;
 }
+/**
+ * @public
+ */
 export interface DescribeScalingPlansResponse {
     /**
      * <p>Information about the scaling plans.</p>
@@ -928,12 +1003,18 @@ export interface DescribeScalingPlansResponse {
      */
     NextToken?: string;
 }
+/**
+ * @public
+ */
 export declare enum ForecastDataType {
     CapacityForecast = "CapacityForecast",
     LoadForecast = "LoadForecast",
     ScheduledActionMaxCapacity = "ScheduledActionMaxCapacity",
     ScheduledActionMinCapacity = "ScheduledActionMinCapacity"
 }
+/**
+ * @public
+ */
 export interface GetScalingPlanResourceForecastDataRequest {
     /**
      * <p>The name of the scaling plan.</p>
@@ -1001,6 +1082,7 @@ export interface GetScalingPlanResourceForecastDataRequest {
     EndTime: Date | undefined;
 }
 /**
+ * @public
  * <p>Represents a single value in the forecast data used for predictive scaling.</p>
  */
 export interface Datapoint {
@@ -1013,12 +1095,18 @@ export interface Datapoint {
      */
     Value?: number;
 }
+/**
+ * @public
+ */
 export interface GetScalingPlanResourceForecastDataResponse {
     /**
      * <p>The data points to return.</p>
      */
     Datapoints: Datapoint[] | undefined;
 }
+/**
+ * @public
+ */
 export interface UpdateScalingPlanRequest {
     /**
      * <p>The name of the scaling plan.</p>
@@ -1040,105 +1128,8 @@ export interface UpdateScalingPlanRequest {
      */
     ScalingInstructions?: ScalingInstruction[];
 }
-export interface UpdateScalingPlanResponse {
-}
-/**
- * @internal
- */
-export declare const TagFilterFilterSensitiveLog: (obj: TagFilter) => any;
-/**
- * @internal
- */
-export declare const ApplicationSourceFilterSensitiveLog: (obj: ApplicationSource) => any;
-/**
- * @internal
- */
-export declare const MetricDimensionFilterSensitiveLog: (obj: MetricDimension) => any;
-/**
- * @internal
- */
-export declare const CustomizedLoadMetricSpecificationFilterSensitiveLog: (obj: CustomizedLoadMetricSpecification) => any;
-/**
- * @internal
- */
-export declare const PredefinedLoadMetricSpecificationFilterSensitiveLog: (obj: PredefinedLoadMetricSpecification) => any;
-/**
- * @internal
- */
-export declare const CustomizedScalingMetricSpecificationFilterSensitiveLog: (obj: CustomizedScalingMetricSpecification) => any;
-/**
- * @internal
- */
-export declare const PredefinedScalingMetricSpecificationFilterSensitiveLog: (obj: PredefinedScalingMetricSpecification) => any;
-/**
- * @internal
- */
-export declare const TargetTrackingConfigurationFilterSensitiveLog: (obj: TargetTrackingConfiguration) => any;
-/**
- * @internal
- */
-export declare const ScalingInstructionFilterSensitiveLog: (obj: ScalingInstruction) => any;
-/**
- * @internal
- */
-export declare const CreateScalingPlanRequestFilterSensitiveLog: (obj: CreateScalingPlanRequest) => any;
-/**
- * @internal
- */
-export declare const CreateScalingPlanResponseFilterSensitiveLog: (obj: CreateScalingPlanResponse) => any;
-/**
- * @internal
- */
-export declare const DeleteScalingPlanRequestFilterSensitiveLog: (obj: DeleteScalingPlanRequest) => any;
-/**
- * @internal
- */
-export declare const DeleteScalingPlanResponseFilterSensitiveLog: (obj: DeleteScalingPlanResponse) => any;
 /**
- * @internal
+ * @public
  */
-export declare const DescribeScalingPlanResourcesRequestFilterSensitiveLog: (obj: DescribeScalingPlanResourcesRequest) => any;
-/**
- * @internal
- */
-export declare const ScalingPolicyFilterSensitiveLog: (obj: ScalingPolicy) => any;
-/**
- * @internal
- */
-export declare const ScalingPlanResourceFilterSensitiveLog: (obj: ScalingPlanResource) => any;
-/**
- * @internal
- */
-export declare const DescribeScalingPlanResourcesResponseFilterSensitiveLog: (obj: DescribeScalingPlanResourcesResponse) => any;
-/**
- * @internal
- */
-export declare const DescribeScalingPlansRequestFilterSensitiveLog: (obj: DescribeScalingPlansRequest) => any;
-/**
- * @internal
- */
-export declare const ScalingPlanFilterSensitiveLog: (obj: ScalingPlan) => any;
-/**
- * @internal
- */
-export declare const DescribeScalingPlansResponseFilterSensitiveLog: (obj: DescribeScalingPlansResponse) => any;
-/**
- * @internal
- */
-export declare const GetScalingPlanResourceForecastDataRequestFilterSensitiveLog: (obj: GetScalingPlanResourceForecastDataRequest) => any;
-/**
- * @internal
- */
-export declare const DatapointFilterSensitiveLog: (obj: Datapoint) => any;
-/**
- * @internal
- */
-export declare const GetScalingPlanResourceForecastDataResponseFilterSensitiveLog: (obj: GetScalingPlanResourceForecastDataResponse) => any;
-/**
- * @internal
- */
-export declare const UpdateScalingPlanRequestFilterSensitiveLog: (obj: UpdateScalingPlanRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateScalingPlanResponseFilterSensitiveLog: (obj: UpdateScalingPlanResponse) => any;
+export interface UpdateScalingPlanResponse {
+}

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

@@ -274,72 +274,3 @@ export interface UpdateScalingPlanRequest {
   ScalingInstructions?: ScalingInstruction[];
 }
 export interface UpdateScalingPlanResponse {}
-export declare const TagFilterFilterSensitiveLog: (obj: TagFilter) => any;
-export declare const ApplicationSourceFilterSensitiveLog: (
-  obj: ApplicationSource
-) => any;
-export declare const MetricDimensionFilterSensitiveLog: (
-  obj: MetricDimension
-) => any;
-export declare const CustomizedLoadMetricSpecificationFilterSensitiveLog: (
-  obj: CustomizedLoadMetricSpecification
-) => any;
-export declare const PredefinedLoadMetricSpecificationFilterSensitiveLog: (
-  obj: PredefinedLoadMetricSpecification
-) => any;
-export declare const CustomizedScalingMetricSpecificationFilterSensitiveLog: (
-  obj: CustomizedScalingMetricSpecification
-) => any;
-export declare const PredefinedScalingMetricSpecificationFilterSensitiveLog: (
-  obj: PredefinedScalingMetricSpecification
-) => any;
-export declare const TargetTrackingConfigurationFilterSensitiveLog: (
-  obj: TargetTrackingConfiguration
-) => any;
-export declare const ScalingInstructionFilterSensitiveLog: (
-  obj: ScalingInstruction
-) => any;
-export declare const CreateScalingPlanRequestFilterSensitiveLog: (
-  obj: CreateScalingPlanRequest
-) => any;
-export declare const CreateScalingPlanResponseFilterSensitiveLog: (
-  obj: CreateScalingPlanResponse
-) => any;
-export declare const DeleteScalingPlanRequestFilterSensitiveLog: (
-  obj: DeleteScalingPlanRequest
-) => any;
-export declare const DeleteScalingPlanResponseFilterSensitiveLog: (
-  obj: DeleteScalingPlanResponse
-) => any;
-export declare const DescribeScalingPlanResourcesRequestFilterSensitiveLog: (
-  obj: DescribeScalingPlanResourcesRequest
-) => any;
-export declare const ScalingPolicyFilterSensitiveLog: (
-  obj: ScalingPolicy
-) => any;
-export declare const ScalingPlanResourceFilterSensitiveLog: (
-  obj: ScalingPlanResource
-) => any;
-export declare const DescribeScalingPlanResourcesResponseFilterSensitiveLog: (
-  obj: DescribeScalingPlanResourcesResponse
-) => any;
-export declare const DescribeScalingPlansRequestFilterSensitiveLog: (
-  obj: DescribeScalingPlansRequest
-) => any;
-export declare const ScalingPlanFilterSensitiveLog: (obj: ScalingPlan) => any;
-export declare const DescribeScalingPlansResponseFilterSensitiveLog: (
-  obj: DescribeScalingPlansResponse
-) => any;
-export declare const GetScalingPlanResourceForecastDataRequestFilterSensitiveLog: (
-  obj: GetScalingPlanResourceForecastDataRequest
-) => any;
-export declare const DatapointFilterSensitiveLog: (obj: Datapoint) => any;
-export declare const GetScalingPlanResourceForecastDataResponseFilterSensitiveLog: (
-  obj: GetScalingPlanResourceForecastDataResponse
-) => any;
-export declare const UpdateScalingPlanRequestFilterSensitiveLog: (
-  obj: UpdateScalingPlanRequest
-) => any;
-export declare const UpdateScalingPlanResponseFilterSensitiveLog: (
-  obj: UpdateScalingPlanResponse
-) => any;

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.296.0",
+  "version": "3.298.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -11,6 +11,7 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
+    "extract:docs": "api-extractor run --local",
     "generate:client": "node ../../scripts/generate-clients/single-service --solo auto-scaling-plans"
   },
   "main": "./dist-cjs/index.js",
@@ -20,9 +21,9 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sts": "3.296.0",
+    "@aws-sdk/client-sts": "3.298.0",
     "@aws-sdk/config-resolver": "3.296.0",
-    "@aws-sdk/credential-provider-node": "3.296.0",
+    "@aws-sdk/credential-provider-node": "3.298.0",
     "@aws-sdk/fetch-http-handler": "3.296.0",
     "@aws-sdk/hash-node": "3.296.0",
     "@aws-sdk/invalid-dependency": "3.296.0",