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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,7 @@ import { DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput } f
7
7
  import { GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput } from "./commands/GetScalingPlanResourceForecastDataCommand";
8
8
  import { UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput } from "./commands/UpdateScalingPlanCommand";
9
9
  /**
10
+ * @public
10
11
  * <fullname>AWS Auto Scaling</fullname>
11
12
  *
12
13
  *
@@ -45,12 +46,14 @@ import { UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput } from ".
45
46
  */
46
47
  export declare class AutoScalingPlans extends AutoScalingPlansClient {
47
48
  /**
49
+ * @public
48
50
  * <p>Creates a scaling plan. </p>
49
51
  */
50
52
  createScalingPlan(args: CreateScalingPlanCommandInput, options?: __HttpHandlerOptions): Promise<CreateScalingPlanCommandOutput>;
51
53
  createScalingPlan(args: CreateScalingPlanCommandInput, cb: (err: any, data?: CreateScalingPlanCommandOutput) => void): void;
52
54
  createScalingPlan(args: CreateScalingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScalingPlanCommandOutput) => void): void;
53
55
  /**
56
+ * @public
54
57
  * <p>Deletes the specified scaling plan.</p>
55
58
  * <p>Deleting a scaling plan deletes the underlying <a>ScalingInstruction</a> for
56
59
  * all of the scalable resources that are covered by the plan.</p>
@@ -61,18 +64,21 @@ export declare class AutoScalingPlans extends AutoScalingPlansClient {
61
64
  deleteScalingPlan(args: DeleteScalingPlanCommandInput, cb: (err: any, data?: DeleteScalingPlanCommandOutput) => void): void;
62
65
  deleteScalingPlan(args: DeleteScalingPlanCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScalingPlanCommandOutput) => void): void;
63
66
  /**
67
+ * @public
64
68
  * <p>Describes the scalable resources in the specified scaling plan.</p>
65
69
  */
66
70
  describeScalingPlanResources(args: DescribeScalingPlanResourcesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScalingPlanResourcesCommandOutput>;
67
71
  describeScalingPlanResources(args: DescribeScalingPlanResourcesCommandInput, cb: (err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void): void;
68
72
  describeScalingPlanResources(args: DescribeScalingPlanResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPlanResourcesCommandOutput) => void): void;
69
73
  /**
74
+ * @public
70
75
  * <p>Describes one or more of your scaling plans.</p>
71
76
  */
72
77
  describeScalingPlans(args: DescribeScalingPlansCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScalingPlansCommandOutput>;
73
78
  describeScalingPlans(args: DescribeScalingPlansCommandInput, cb: (err: any, data?: DescribeScalingPlansCommandOutput) => void): void;
74
79
  describeScalingPlans(args: DescribeScalingPlansCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPlansCommandOutput) => void): void;
75
80
  /**
81
+ * @public
76
82
  * <p>Retrieves the forecast data for a scalable resource.</p>
77
83
  * <p>Capacity forecasts are represented as predicted values, or data points, that are
78
84
  * calculated using historical data points from a specified CloudWatch load metric. Data points are
@@ -82,6 +88,7 @@ export declare class AutoScalingPlans extends AutoScalingPlansClient {
82
88
  getScalingPlanResourceForecastData(args: GetScalingPlanResourceForecastDataCommandInput, cb: (err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void): void;
83
89
  getScalingPlanResourceForecastData(args: GetScalingPlanResourceForecastDataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetScalingPlanResourceForecastDataCommandOutput) => void): void;
84
90
  /**
91
+ * @public
85
92
  * <p>Updates the specified scaling plan.</p>
86
93
  * <p>You cannot update a scaling plan if it is in the process of being created, updated, or
87
94
  * deleted.</p>
@@ -14,15 +14,24 @@ import { DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput } f
14
14
  import { GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput } from "./commands/GetScalingPlanResourceForecastDataCommand";
15
15
  import { UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput } from "./commands/UpdateScalingPlanCommand";
16
16
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
17
+ /**
18
+ * @public
19
+ */
17
20
  export type ServiceInputTypes = CreateScalingPlanCommandInput | DeleteScalingPlanCommandInput | DescribeScalingPlanResourcesCommandInput | DescribeScalingPlansCommandInput | GetScalingPlanResourceForecastDataCommandInput | UpdateScalingPlanCommandInput;
21
+ /**
22
+ * @public
23
+ */
18
24
  export type ServiceOutputTypes = CreateScalingPlanCommandOutput | DeleteScalingPlanCommandOutput | DescribeScalingPlanResourcesCommandOutput | DescribeScalingPlansCommandOutput | GetScalingPlanResourceForecastDataCommandOutput | UpdateScalingPlanCommandOutput;
25
+ /**
26
+ * @public
27
+ */
19
28
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
20
29
  /**
21
30
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
22
31
  */
23
32
  requestHandler?: __HttpHandler;
24
33
  /**
25
- * A constructor for a class implementing the {@link __Checksum} interface
34
+ * A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
26
35
  * that computes the SHA-256 HMAC or checksum of a string or binary buffer.
27
36
  * @internal
28
37
  */
@@ -112,23 +121,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
112
121
  */
113
122
  logger?: __Logger;
114
123
  /**
115
- * The {@link __DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
124
+ * The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
116
125
  */
117
126
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
118
127
  }
128
+ /**
129
+ * @public
130
+ */
119
131
  type AutoScalingPlansClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
120
132
  /**
121
- * The configuration interface of AutoScalingPlansClient class constructor that set the region, credentials and other options.
133
+ * @public
134
+ *
135
+ * The configuration interface of AutoScalingPlansClient class constructor that set the region, credentials and other options.
122
136
  */
123
137
  export interface AutoScalingPlansClientConfig extends AutoScalingPlansClientConfigType {
124
138
  }
139
+ /**
140
+ * @public
141
+ */
125
142
  type AutoScalingPlansClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
126
143
  /**
127
- * The resolved configuration interface of AutoScalingPlansClient class. This is resolved and normalized from the {@link AutoScalingPlansClientConfig | constructor configuration interface}.
144
+ * @public
145
+ *
146
+ * The resolved configuration interface of AutoScalingPlansClient class. This is resolved and normalized from the {@link AutoScalingPlansClientConfig | constructor configuration interface}.
128
147
  */
129
148
  export interface AutoScalingPlansClientResolvedConfig extends AutoScalingPlansClientResolvedConfigType {
130
149
  }
131
150
  /**
151
+ * @public
132
152
  * <fullname>AWS Auto Scaling</fullname>
133
153
  *
134
154
  *
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { CreateScalingPlanRequest, CreateScalingPlanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link CreateScalingPlanCommand}.
8
10
  */
9
11
  export interface CreateScalingPlanCommandInput extends CreateScalingPlanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link CreateScalingPlanCommand}.
13
17
  */
14
18
  export interface CreateScalingPlanCommandOutput extends CreateScalingPlanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Creates a scaling plan. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface CreateScalingPlanCommandOutput extends CreateScalingPlanRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param CreateScalingPlanCommandInput - {@link CreateScalingPlanCommandInput}
34
+ * @returns {@link CreateScalingPlanCommandOutput}
28
35
  * @see {@link CreateScalingPlanCommandInput} for command's `input` shape.
29
36
  * @see {@link CreateScalingPlanCommandOutput} for command's `response` shape.
30
37
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -48,11 +55,20 @@ export interface CreateScalingPlanCommandOutput extends CreateScalingPlanRespons
48
55
  export declare class CreateScalingPlanCommand extends $Command<CreateScalingPlanCommandInput, CreateScalingPlanCommandOutput, AutoScalingPlansClientResolvedConfig> {
49
56
  readonly input: CreateScalingPlanCommandInput;
50
57
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
58
+ /**
59
+ * @public
60
+ */
51
61
  constructor(input: CreateScalingPlanCommandInput);
52
62
  /**
53
63
  * @internal
54
64
  */
55
65
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateScalingPlanCommandInput, CreateScalingPlanCommandOutput>;
66
+ /**
67
+ * @internal
68
+ */
56
69
  private serialize;
70
+ /**
71
+ * @internal
72
+ */
57
73
  private deserialize;
58
74
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { DeleteScalingPlanRequest, DeleteScalingPlanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteScalingPlanCommand}.
8
10
  */
9
11
  export interface DeleteScalingPlanCommandInput extends DeleteScalingPlanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteScalingPlanCommand}.
13
17
  */
14
18
  export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified scaling plan.</p>
18
23
  * <p>Deleting a scaling plan deletes the underlying <a>ScalingInstruction</a> for
19
24
  * all of the scalable resources that are covered by the plan.</p>
@@ -29,6 +34,8 @@ export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanRespons
29
34
  * const response = await client.send(command);
30
35
  * ```
31
36
  *
37
+ * @param DeleteScalingPlanCommandInput - {@link DeleteScalingPlanCommandInput}
38
+ * @returns {@link DeleteScalingPlanCommandOutput}
32
39
  * @see {@link DeleteScalingPlanCommandInput} for command's `input` shape.
33
40
  * @see {@link DeleteScalingPlanCommandOutput} for command's `response` shape.
34
41
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -51,11 +58,20 @@ export interface DeleteScalingPlanCommandOutput extends DeleteScalingPlanRespons
51
58
  export declare class DeleteScalingPlanCommand extends $Command<DeleteScalingPlanCommandInput, DeleteScalingPlanCommandOutput, AutoScalingPlansClientResolvedConfig> {
52
59
  readonly input: DeleteScalingPlanCommandInput;
53
60
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
61
+ /**
62
+ * @public
63
+ */
54
64
  constructor(input: DeleteScalingPlanCommandInput);
55
65
  /**
56
66
  * @internal
57
67
  */
58
68
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteScalingPlanCommandInput, DeleteScalingPlanCommandOutput>;
69
+ /**
70
+ * @internal
71
+ */
59
72
  private serialize;
73
+ /**
74
+ * @internal
75
+ */
60
76
  private deserialize;
61
77
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { DescribeScalingPlanResourcesRequest, DescribeScalingPlanResourcesResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeScalingPlanResourcesCommand}.
8
10
  */
9
11
  export interface DescribeScalingPlanResourcesCommandInput extends DescribeScalingPlanResourcesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeScalingPlanResourcesCommand}.
13
17
  */
14
18
  export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScalingPlanResourcesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes the scalable resources in the specified scaling plan.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScali
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeScalingPlanResourcesCommandInput - {@link DescribeScalingPlanResourcesCommandInput}
34
+ * @returns {@link DescribeScalingPlanResourcesCommandOutput}
28
35
  * @see {@link DescribeScalingPlanResourcesCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeScalingPlanResourcesCommandOutput} for command's `response` shape.
30
37
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeScalingPlanResourcesCommandOutput extends DescribeScali
47
54
  export declare class DescribeScalingPlanResourcesCommand extends $Command<DescribeScalingPlanResourcesCommandInput, DescribeScalingPlanResourcesCommandOutput, AutoScalingPlansClientResolvedConfig> {
48
55
  readonly input: DescribeScalingPlanResourcesCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeScalingPlanResourcesCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScalingPlanResourcesCommandInput, DescribeScalingPlanResourcesCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { DescribeScalingPlansRequest, DescribeScalingPlansResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeScalingPlansCommand}.
8
10
  */
9
11
  export interface DescribeScalingPlansCommandInput extends DescribeScalingPlansRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeScalingPlansCommand}.
13
17
  */
14
18
  export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Describes one or more of your scaling plans.</p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeScalingPlansCommandInput - {@link DescribeScalingPlansCommandInput}
34
+ * @returns {@link DescribeScalingPlansCommandOutput}
28
35
  * @see {@link DescribeScalingPlansCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeScalingPlansCommandOutput} for command's `response` shape.
30
37
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -47,11 +54,20 @@ export interface DescribeScalingPlansCommandOutput extends DescribeScalingPlansR
47
54
  export declare class DescribeScalingPlansCommand extends $Command<DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput, AutoScalingPlansClientResolvedConfig> {
48
55
  readonly input: DescribeScalingPlansCommandInput;
49
56
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
57
+ /**
58
+ * @public
59
+ */
50
60
  constructor(input: DescribeScalingPlansCommandInput);
51
61
  /**
52
62
  * @internal
53
63
  */
54
64
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeScalingPlansCommandInput, DescribeScalingPlansCommandOutput>;
65
+ /**
66
+ * @internal
67
+ */
55
68
  private serialize;
69
+ /**
70
+ * @internal
71
+ */
56
72
  private deserialize;
57
73
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { GetScalingPlanResourceForecastDataRequest, GetScalingPlanResourceForecastDataResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link GetScalingPlanResourceForecastDataCommand}.
8
10
  */
9
11
  export interface GetScalingPlanResourceForecastDataCommandInput extends GetScalingPlanResourceForecastDataRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link GetScalingPlanResourceForecastDataCommand}.
13
17
  */
14
18
  export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScalingPlanResourceForecastDataResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the forecast data for a scalable resource.</p>
18
23
  * <p>Capacity forecasts are represented as predicted values, or data points, that are
19
24
  * calculated using historical data points from a specified CloudWatch load metric. Data points are
@@ -28,6 +33,8 @@ export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScal
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param GetScalingPlanResourceForecastDataCommandInput - {@link GetScalingPlanResourceForecastDataCommandInput}
37
+ * @returns {@link GetScalingPlanResourceForecastDataCommandOutput}
31
38
  * @see {@link GetScalingPlanResourceForecastDataCommandInput} for command's `input` shape.
32
39
  * @see {@link GetScalingPlanResourceForecastDataCommandOutput} for command's `response` shape.
33
40
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -43,11 +50,20 @@ export interface GetScalingPlanResourceForecastDataCommandOutput extends GetScal
43
50
  export declare class GetScalingPlanResourceForecastDataCommand extends $Command<GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput, AutoScalingPlansClientResolvedConfig> {
44
51
  readonly input: GetScalingPlanResourceForecastDataCommandInput;
45
52
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
53
+ /**
54
+ * @public
55
+ */
46
56
  constructor(input: GetScalingPlanResourceForecastDataCommandInput);
47
57
  /**
48
58
  * @internal
49
59
  */
50
60
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetScalingPlanResourceForecastDataCommandInput, GetScalingPlanResourceForecastDataCommandOutput>;
61
+ /**
62
+ * @internal
63
+ */
51
64
  private serialize;
65
+ /**
66
+ * @internal
67
+ */
52
68
  private deserialize;
53
69
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { AutoScalingPlansClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../AutoScalingPlansClient";
5
5
  import { UpdateScalingPlanRequest, UpdateScalingPlanResponse } from "../models/models_0";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link UpdateScalingPlanCommand}.
8
10
  */
9
11
  export interface UpdateScalingPlanCommandInput extends UpdateScalingPlanRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link UpdateScalingPlanCommand}.
13
17
  */
14
18
  export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Updates the specified scaling plan.</p>
18
23
  * <p>You cannot update a scaling plan if it is in the process of being created, updated, or
19
24
  * deleted.</p>
@@ -27,6 +32,8 @@ export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanRespons
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param UpdateScalingPlanCommandInput - {@link UpdateScalingPlanCommandInput}
36
+ * @returns {@link UpdateScalingPlanCommandOutput}
30
37
  * @see {@link UpdateScalingPlanCommandInput} for command's `input` shape.
31
38
  * @see {@link UpdateScalingPlanCommandOutput} for command's `response` shape.
32
39
  * @see {@link AutoScalingPlansClientResolvedConfig | config} for AutoScalingPlansClient's `config` shape.
@@ -49,11 +56,20 @@ export interface UpdateScalingPlanCommandOutput extends UpdateScalingPlanRespons
49
56
  export declare class UpdateScalingPlanCommand extends $Command<UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput, AutoScalingPlansClientResolvedConfig> {
50
57
  readonly input: UpdateScalingPlanCommandInput;
51
58
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ /**
60
+ * @public
61
+ */
52
62
  constructor(input: UpdateScalingPlanCommandInput);
53
63
  /**
54
64
  * @internal
55
65
  */
56
66
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: AutoScalingPlansClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateScalingPlanCommandInput, UpdateScalingPlanCommandOutput>;
67
+ /**
68
+ * @internal
69
+ */
57
70
  private serialize;
71
+ /**
72
+ * @internal
73
+ */
58
74
  private deserialize;
59
75
  }
@@ -1,5 +1,7 @@
1
1
  import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
2
  /**
3
+ * @public
4
+ *
3
5
  * Base exception class for all service exceptions from AutoScalingPlans service.
4
6
  */
5
7
  export declare class AutoScalingPlansServiceException extends __ServiceException {
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { AutoScalingPlansServiceException as __BaseException } from "./AutoScalingPlansServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p>Concurrent updates caused an exception, for example, if you request an update to a
5
6
  * scaling plan that already has a pending update.</p>
6
7
  */
@@ -14,6 +15,7 @@ export declare class ConcurrentUpdateException extends __BaseException {
14
15
  constructor(opts: __ExceptionOptionType<ConcurrentUpdateException, __BaseException>);
15
16
  }
16
17
  /**
18
+ * @public
17
19
  * <p>Represents a tag.</p>
18
20
  */
19
21
  export interface TagFilter {
@@ -27,6 +29,7 @@ export interface TagFilter {
27
29
  Values?: string[];
28
30
  }
29
31
  /**
32
+ * @public
30
33
  * <p>Represents an application source.</p>
31
34
  */
32
35
  export interface ApplicationSource {
@@ -40,6 +43,7 @@ export interface ApplicationSource {
40
43
  TagFilters?: TagFilter[];
41
44
  }
42
45
  /**
46
+ * @public
43
47
  * <p>Represents a dimension for a customized metric.</p>
44
48
  */
45
49
  export interface MetricDimension {
@@ -52,6 +56,9 @@ export interface MetricDimension {
52
56
  */
53
57
  Value: string | undefined;
54
58
  }
59
+ /**
60
+ * @public
61
+ */
55
62
  export declare enum MetricStatistic {
56
63
  Average = "Average",
57
64
  Maximum = "Maximum",
@@ -60,6 +67,7 @@ export declare enum MetricStatistic {
60
67
  Sum = "Sum"
61
68
  }
62
69
  /**
70
+ * @public
63
71
  * <p>Represents a CloudWatch metric of your choosing that can be used for predictive scaling. </p>
64
72
  * <p>For predictive scaling to work with a customized load metric specification, AWS Auto Scaling
65
73
  * needs access to the <code>Sum</code> and <code>Average</code> statistics that CloudWatch computes
@@ -109,6 +117,9 @@ export interface CustomizedLoadMetricSpecification {
109
117
  */
110
118
  Unit?: string;
111
119
  }
120
+ /**
121
+ * @public
122
+ */
112
123
  export declare enum LoadMetricType {
113
124
  ALBTargetGroupRequestCount = "ALBTargetGroupRequestCount",
114
125
  ASGTotalCPUUtilization = "ASGTotalCPUUtilization",
@@ -116,6 +127,7 @@ export declare enum LoadMetricType {
116
127
  ASGTotalNetworkOut = "ASGTotalNetworkOut"
117
128
  }
118
129
  /**
130
+ * @public
119
131
  * <p>Represents a predefined metric that can be used for predictive scaling.</p>
120
132
  * <p>After creating your scaling plan, you can use the AWS Auto Scaling console to visualize
121
133
  * 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 {
153
165
  */
154
166
  ResourceLabel?: string;
155
167
  }
168
+ /**
169
+ * @public
170
+ */
156
171
  export declare enum PredictiveScalingMaxCapacityBehavior {
157
172
  SetForecastCapacityToMaxCapacity = "SetForecastCapacityToMaxCapacity",
158
173
  SetMaxCapacityAboveForecastCapacity = "SetMaxCapacityAboveForecastCapacity",
159
174
  SetMaxCapacityToForecastCapacity = "SetMaxCapacityToForecastCapacity"
160
175
  }
176
+ /**
177
+ * @public
178
+ */
161
179
  export declare enum PredictiveScalingMode {
162
180
  ForecastAndScale = "ForecastAndScale",
163
181
  ForecastOnly = "ForecastOnly"
164
182
  }
183
+ /**
184
+ * @public
185
+ */
165
186
  export declare enum ScalableDimension {
166
187
  AutoScalingGroupDesiredCapacity = "autoscaling:autoScalingGroup:DesiredCapacity",
167
188
  DynamoDBIndexReadCapacityUnits = "dynamodb:index:ReadCapacityUnits",
@@ -172,10 +193,16 @@ export declare enum ScalableDimension {
172
193
  ECSServiceDesiredCount = "ecs:service:DesiredCount",
173
194
  RDSClusterReadReplicaCount = "rds:cluster:ReadReplicaCount"
174
195
  }
196
+ /**
197
+ * @public
198
+ */
175
199
  export declare enum ScalingPolicyUpdateBehavior {
176
200
  KeepExternalPolicies = "KeepExternalPolicies",
177
201
  ReplaceExternalPolicies = "ReplaceExternalPolicies"
178
202
  }
203
+ /**
204
+ * @public
205
+ */
179
206
  export declare enum ServiceNamespace {
180
207
  AUTOSCALING = "autoscaling",
181
208
  DYNAMODB = "dynamodb",
@@ -184,6 +211,7 @@ export declare enum ServiceNamespace {
184
211
  RDS = "rds"
185
212
  }
186
213
  /**
214
+ * @public
187
215
  * <p>Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part
188
216
  * of a target tracking scaling policy. </p>
189
217
  * <p>To create your customized scaling metric specification:</p>
@@ -228,6 +256,9 @@ export interface CustomizedScalingMetricSpecification {
228
256
  */
229
257
  Unit?: string;
230
258
  }
259
+ /**
260
+ * @public
261
+ */
231
262
  export declare enum ScalingMetricType {
232
263
  ALBRequestCountPerTarget = "ALBRequestCountPerTarget",
233
264
  ASGAverageCPUUtilization = "ASGAverageCPUUtilization",
@@ -244,6 +275,7 @@ export declare enum ScalingMetricType {
244
275
  RDSReaderAverageDatabaseConnections = "RDSReaderAverageDatabaseConnections"
245
276
  }
246
277
  /**
278
+ * @public
247
279
  * <p>Represents a predefined metric that can be used for dynamic scaling as part of a target
248
280
  * tracking scaling policy.</p>
249
281
  */
@@ -281,6 +313,7 @@ export interface PredefinedScalingMetricSpecification {
281
313
  ResourceLabel?: string;
282
314
  }
283
315
  /**
316
+ * @public
284
317
  * <p>Describes a target tracking configuration to use with AWS Auto Scaling. Used with <a>ScalingInstruction</a> and <a>ScalingPolicy</a>.</p>
285
318
  */
286
319
  export interface TargetTrackingConfiguration {
@@ -337,6 +370,7 @@ export interface TargetTrackingConfiguration {
337
370
  EstimatedInstanceWarmup?: number;
338
371
  }
339
372
  /**
373
+ * @public
340
374
  * <p>Describes a scaling instruction for a scalable resource in a scaling plan. Each scaling
341
375
  * instruction applies to one resource.</p>
342
376
  * <p>AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions.
@@ -532,6 +566,9 @@ export interface ScalingInstruction {
532
566
  */
533
567
  DisableDynamicScaling?: boolean;
534
568
  }
569
+ /**
570
+ * @public
571
+ */
535
572
  export interface CreateScalingPlanRequest {
536
573
  /**
537
574
  * <p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward
@@ -550,6 +587,9 @@ export interface CreateScalingPlanRequest {
550
587
  */
551
588
  ScalingInstructions: ScalingInstruction[] | undefined;
552
589
  }
590
+ /**
591
+ * @public
592
+ */
553
593
  export interface CreateScalingPlanResponse {
554
594
  /**
555
595
  * <p>The version number of the scaling plan. This value is always <code>1</code>. Currently,
@@ -558,6 +598,7 @@ export interface CreateScalingPlanResponse {
558
598
  ScalingPlanVersion: number | undefined;
559
599
  }
560
600
  /**
601
+ * @public
561
602
  * <p>The service encountered an internal error.</p>
562
603
  */
563
604
  export declare class InternalServiceException extends __BaseException {
@@ -570,6 +611,7 @@ export declare class InternalServiceException extends __BaseException {
570
611
  constructor(opts: __ExceptionOptionType<InternalServiceException, __BaseException>);
571
612
  }
572
613
  /**
614
+ * @public
573
615
  * <p>Your account exceeded a limit. This exception is thrown when a per-account resource
574
616
  * limit is exceeded.</p>
575
617
  */
@@ -583,6 +625,7 @@ export declare class LimitExceededException extends __BaseException {
583
625
  constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
584
626
  }
585
627
  /**
628
+ * @public
586
629
  * <p>An exception was thrown for a validation issue. Review the parameters provided.</p>
587
630
  */
588
631
  export declare class ValidationException extends __BaseException {
@@ -594,6 +637,9 @@ export declare class ValidationException extends __BaseException {
594
637
  */
595
638
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
596
639
  }
640
+ /**
641
+ * @public
642
+ */
597
643
  export interface DeleteScalingPlanRequest {
598
644
  /**
599
645
  * <p>The name of the scaling plan.</p>
@@ -605,9 +651,13 @@ export interface DeleteScalingPlanRequest {
605
651
  */
606
652
  ScalingPlanVersion: number | undefined;
607
653
  }
654
+ /**
655
+ * @public
656
+ */
608
657
  export interface DeleteScalingPlanResponse {
609
658
  }
610
659
  /**
660
+ * @public
611
661
  * <p>The specified object could not be found.</p>
612
662
  */
613
663
  export declare class ObjectNotFoundException extends __BaseException {
@@ -619,6 +669,9 @@ export declare class ObjectNotFoundException extends __BaseException {
619
669
  */
620
670
  constructor(opts: __ExceptionOptionType<ObjectNotFoundException, __BaseException>);
621
671
  }
672
+ /**
673
+ * @public
674
+ */
622
675
  export interface DescribeScalingPlanResourcesRequest {
623
676
  /**
624
677
  * <p>The name of the scaling plan.</p>
@@ -639,10 +692,14 @@ export interface DescribeScalingPlanResourcesRequest {
639
692
  */
640
693
  NextToken?: string;
641
694
  }
695
+ /**
696
+ * @public
697
+ */
642
698
  export declare enum PolicyType {
643
699
  TargetTrackingScaling = "TargetTrackingScaling"
644
700
  }
645
701
  /**
702
+ * @public
646
703
  * <p>Represents a scaling policy.</p>
647
704
  */
648
705
  export interface ScalingPolicy {
@@ -660,12 +717,16 @@ export interface ScalingPolicy {
660
717
  */
661
718
  TargetTrackingConfiguration?: TargetTrackingConfiguration;
662
719
  }
720
+ /**
721
+ * @public
722
+ */
663
723
  export declare enum ScalingStatusCode {
664
724
  Active = "Active",
665
725
  Inactive = "Inactive",
666
726
  PartiallyActive = "PartiallyActive"
667
727
  }
668
728
  /**
729
+ * @public
669
730
  * <p>Represents a scalable resource.</p>
670
731
  */
671
732
  export interface ScalingPlanResource {
@@ -781,6 +842,9 @@ export interface ScalingPlanResource {
781
842
  */
782
843
  ScalingStatusMessage?: string;
783
844
  }
845
+ /**
846
+ * @public
847
+ */
784
848
  export interface DescribeScalingPlanResourcesResponse {
785
849
  /**
786
850
  * <p>Information about the scalable resources.</p>
@@ -793,6 +857,7 @@ export interface DescribeScalingPlanResourcesResponse {
793
857
  NextToken?: string;
794
858
  }
795
859
  /**
860
+ * @public
796
861
  * <p>The token provided is not valid.</p>
797
862
  */
798
863
  export declare class InvalidNextTokenException extends __BaseException {
@@ -804,6 +869,9 @@ export declare class InvalidNextTokenException extends __BaseException {
804
869
  */
805
870
  constructor(opts: __ExceptionOptionType<InvalidNextTokenException, __BaseException>);
806
871
  }
872
+ /**
873
+ * @public
874
+ */
807
875
  export interface DescribeScalingPlansRequest {
808
876
  /**
809
877
  * <p>The names of the scaling plans (up to 10). If you specify application sources, you
@@ -834,6 +902,9 @@ export interface DescribeScalingPlansRequest {
834
902
  */
835
903
  NextToken?: string;
836
904
  }
905
+ /**
906
+ * @public
907
+ */
837
908
  export declare enum ScalingPlanStatusCode {
838
909
  Active = "Active",
839
910
  ActiveWithProblems = "ActiveWithProblems",
@@ -845,6 +916,7 @@ export declare enum ScalingPlanStatusCode {
845
916
  UpdateInProgress = "UpdateInProgress"
846
917
  }
847
918
  /**
919
+ * @public
848
920
  * <p>Represents a scaling plan.</p>
849
921
  */
850
922
  export interface ScalingPlan {
@@ -917,6 +989,9 @@ export interface ScalingPlan {
917
989
  */
918
990
  CreationTime?: Date;
919
991
  }
992
+ /**
993
+ * @public
994
+ */
920
995
  export interface DescribeScalingPlansResponse {
921
996
  /**
922
997
  * <p>Information about the scaling plans.</p>
@@ -928,12 +1003,18 @@ export interface DescribeScalingPlansResponse {
928
1003
  */
929
1004
  NextToken?: string;
930
1005
  }
1006
+ /**
1007
+ * @public
1008
+ */
931
1009
  export declare enum ForecastDataType {
932
1010
  CapacityForecast = "CapacityForecast",
933
1011
  LoadForecast = "LoadForecast",
934
1012
  ScheduledActionMaxCapacity = "ScheduledActionMaxCapacity",
935
1013
  ScheduledActionMinCapacity = "ScheduledActionMinCapacity"
936
1014
  }
1015
+ /**
1016
+ * @public
1017
+ */
937
1018
  export interface GetScalingPlanResourceForecastDataRequest {
938
1019
  /**
939
1020
  * <p>The name of the scaling plan.</p>
@@ -1001,6 +1082,7 @@ export interface GetScalingPlanResourceForecastDataRequest {
1001
1082
  EndTime: Date | undefined;
1002
1083
  }
1003
1084
  /**
1085
+ * @public
1004
1086
  * <p>Represents a single value in the forecast data used for predictive scaling.</p>
1005
1087
  */
1006
1088
  export interface Datapoint {
@@ -1013,12 +1095,18 @@ export interface Datapoint {
1013
1095
  */
1014
1096
  Value?: number;
1015
1097
  }
1098
+ /**
1099
+ * @public
1100
+ */
1016
1101
  export interface GetScalingPlanResourceForecastDataResponse {
1017
1102
  /**
1018
1103
  * <p>The data points to return.</p>
1019
1104
  */
1020
1105
  Datapoints: Datapoint[] | undefined;
1021
1106
  }
1107
+ /**
1108
+ * @public
1109
+ */
1022
1110
  export interface UpdateScalingPlanRequest {
1023
1111
  /**
1024
1112
  * <p>The name of the scaling plan.</p>
@@ -1040,6 +1128,9 @@ export interface UpdateScalingPlanRequest {
1040
1128
  */
1041
1129
  ScalingInstructions?: ScalingInstruction[];
1042
1130
  }
1131
+ /**
1132
+ * @public
1133
+ */
1043
1134
  export interface UpdateScalingPlanResponse {
1044
1135
  }
1045
1136
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-auto-scaling-plans",
3
3
  "description": "AWS SDK for JavaScript Auto Scaling Plans Client for Node.js, Browser and React Native",
4
- "version": "3.296.0",
4
+ "version": "3.297.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -20,9 +20,9 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "3.0.0",
22
22
  "@aws-crypto/sha256-js": "3.0.0",
23
- "@aws-sdk/client-sts": "3.296.0",
23
+ "@aws-sdk/client-sts": "3.297.0",
24
24
  "@aws-sdk/config-resolver": "3.296.0",
25
- "@aws-sdk/credential-provider-node": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.297.0",
26
26
  "@aws-sdk/fetch-http-handler": "3.296.0",
27
27
  "@aws-sdk/hash-node": "3.296.0",
28
28
  "@aws-sdk/invalid-dependency": "3.296.0",