@aws-sdk/client-application-auto-scaling 3.294.0 → 3.296.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.
Files changed (59) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/ApplicationAutoScaling.js +45 -0
  3. package/dist-cjs/commands/DeleteScalingPolicyCommand.js +4 -4
  4. package/dist-cjs/commands/DeleteScheduledActionCommand.js +4 -4
  5. package/dist-cjs/commands/DeregisterScalableTargetCommand.js +4 -4
  6. package/dist-cjs/commands/DescribeScalableTargetsCommand.js +4 -4
  7. package/dist-cjs/commands/DescribeScalingActivitiesCommand.js +4 -4
  8. package/dist-cjs/commands/DescribeScalingPoliciesCommand.js +4 -4
  9. package/dist-cjs/commands/DescribeScheduledActionsCommand.js +4 -4
  10. package/dist-cjs/commands/ListTagsForResourceCommand.js +46 -0
  11. package/dist-cjs/commands/PutScalingPolicyCommand.js +4 -4
  12. package/dist-cjs/commands/PutScheduledActionCommand.js +4 -4
  13. package/dist-cjs/commands/RegisterScalableTargetCommand.js +4 -4
  14. package/dist-cjs/commands/TagResourceCommand.js +46 -0
  15. package/dist-cjs/commands/UntagResourceCommand.js +46 -0
  16. package/dist-cjs/commands/index.js +3 -0
  17. package/dist-cjs/models/models_0.js +56 -2
  18. package/dist-cjs/protocols/Aws_json1_1.js +230 -2
  19. package/dist-es/ApplicationAutoScaling.js +45 -0
  20. package/dist-es/commands/DeleteScalingPolicyCommand.js +4 -4
  21. package/dist-es/commands/DeleteScheduledActionCommand.js +4 -4
  22. package/dist-es/commands/DeregisterScalableTargetCommand.js +4 -4
  23. package/dist-es/commands/DescribeScalableTargetsCommand.js +4 -4
  24. package/dist-es/commands/DescribeScalingActivitiesCommand.js +4 -4
  25. package/dist-es/commands/DescribeScalingPoliciesCommand.js +4 -4
  26. package/dist-es/commands/DescribeScheduledActionsCommand.js +4 -4
  27. package/dist-es/commands/ListTagsForResourceCommand.js +42 -0
  28. package/dist-es/commands/PutScalingPolicyCommand.js +4 -4
  29. package/dist-es/commands/PutScheduledActionCommand.js +4 -4
  30. package/dist-es/commands/RegisterScalableTargetCommand.js +4 -4
  31. package/dist-es/commands/TagResourceCommand.js +42 -0
  32. package/dist-es/commands/UntagResourceCommand.js +42 -0
  33. package/dist-es/commands/index.js +3 -0
  34. package/dist-es/models/models_0.js +46 -0
  35. package/dist-es/protocols/Aws_json1_1.js +224 -2
  36. package/dist-types/ApplicationAutoScaling.d.ts +54 -12
  37. package/dist-types/ApplicationAutoScalingClient.d.ts +7 -4
  38. package/dist-types/commands/DeleteScheduledActionCommand.d.ts +14 -0
  39. package/dist-types/commands/DescribeScheduledActionsCommand.d.ts +43 -0
  40. package/dist-types/commands/ListTagsForResourceCommand.d.ts +67 -0
  41. package/dist-types/commands/PutScalingPolicyCommand.d.ts +2 -2
  42. package/dist-types/commands/PutScheduledActionCommand.d.ts +19 -1
  43. package/dist-types/commands/RegisterScalableTargetCommand.d.ts +16 -9
  44. package/dist-types/commands/TagResourceCommand.d.ts +79 -0
  45. package/dist-types/commands/UntagResourceCommand.d.ts +66 -0
  46. package/dist-types/commands/index.d.ts +3 -0
  47. package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
  48. package/dist-types/models/models_0.d.ts +141 -10
  49. package/dist-types/protocols/Aws_json1_1.d.ts +9 -0
  50. package/dist-types/ts3.4/ApplicationAutoScaling.d.ts +51 -0
  51. package/dist-types/ts3.4/ApplicationAutoScalingClient.d.ts +24 -6
  52. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +38 -0
  53. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +34 -0
  54. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +37 -0
  55. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  56. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +3 -4
  57. package/dist-types/ts3.4/models/models_0.d.ts +57 -1
  58. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  59. package/package.json +36 -36
@@ -14,12 +14,15 @@ import { DescribeScalableTargetsCommandInput, DescribeScalableTargetsCommandOutp
14
14
  import { DescribeScalingActivitiesCommandInput, DescribeScalingActivitiesCommandOutput } from "./commands/DescribeScalingActivitiesCommand";
15
15
  import { DescribeScalingPoliciesCommandInput, DescribeScalingPoliciesCommandOutput } from "./commands/DescribeScalingPoliciesCommand";
16
16
  import { DescribeScheduledActionsCommandInput, DescribeScheduledActionsCommandOutput } from "./commands/DescribeScheduledActionsCommand";
17
+ import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
17
18
  import { PutScalingPolicyCommandInput, PutScalingPolicyCommandOutput } from "./commands/PutScalingPolicyCommand";
18
19
  import { PutScheduledActionCommandInput, PutScheduledActionCommandOutput } from "./commands/PutScheduledActionCommand";
19
20
  import { RegisterScalableTargetCommandInput, RegisterScalableTargetCommandOutput } from "./commands/RegisterScalableTargetCommand";
21
+ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
22
+ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
20
23
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
21
- export declare type ServiceInputTypes = DeleteScalingPolicyCommandInput | DeleteScheduledActionCommandInput | DeregisterScalableTargetCommandInput | DescribeScalableTargetsCommandInput | DescribeScalingActivitiesCommandInput | DescribeScalingPoliciesCommandInput | DescribeScheduledActionsCommandInput | PutScalingPolicyCommandInput | PutScheduledActionCommandInput | RegisterScalableTargetCommandInput;
22
- export declare type ServiceOutputTypes = DeleteScalingPolicyCommandOutput | DeleteScheduledActionCommandOutput | DeregisterScalableTargetCommandOutput | DescribeScalableTargetsCommandOutput | DescribeScalingActivitiesCommandOutput | DescribeScalingPoliciesCommandOutput | DescribeScheduledActionsCommandOutput | PutScalingPolicyCommandOutput | PutScheduledActionCommandOutput | RegisterScalableTargetCommandOutput;
24
+ export type ServiceInputTypes = DeleteScalingPolicyCommandInput | DeleteScheduledActionCommandInput | DeregisterScalableTargetCommandInput | DescribeScalableTargetsCommandInput | DescribeScalingActivitiesCommandInput | DescribeScalingPoliciesCommandInput | DescribeScheduledActionsCommandInput | ListTagsForResourceCommandInput | PutScalingPolicyCommandInput | PutScheduledActionCommandInput | RegisterScalableTargetCommandInput | TagResourceCommandInput | UntagResourceCommandInput;
25
+ export type ServiceOutputTypes = DeleteScalingPolicyCommandOutput | DeleteScheduledActionCommandOutput | DeregisterScalableTargetCommandOutput | DescribeScalableTargetsCommandOutput | DescribeScalingActivitiesCommandOutput | DescribeScalingPoliciesCommandOutput | DescribeScheduledActionsCommandOutput | ListTagsForResourceCommandOutput | PutScalingPolicyCommandOutput | PutScheduledActionCommandOutput | RegisterScalableTargetCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput;
23
26
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
24
27
  /**
25
28
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -120,13 +123,13 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
120
123
  */
121
124
  defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
122
125
  }
123
- declare type ApplicationAutoScalingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
126
+ type ApplicationAutoScalingClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
124
127
  /**
125
128
  * The configuration interface of ApplicationAutoScalingClient class constructor that set the region, credentials and other options.
126
129
  */
127
130
  export interface ApplicationAutoScalingClientConfig extends ApplicationAutoScalingClientConfigType {
128
131
  }
129
- declare type ApplicationAutoScalingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
132
+ type ApplicationAutoScalingClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
130
133
  /**
131
134
  * The resolved configuration interface of ApplicationAutoScalingClient class. This is resolved and normalized from the {@link ApplicationAutoScalingClientConfig | constructor configuration interface}.
132
135
  */
@@ -49,6 +49,20 @@ export interface DeleteScheduledActionCommandOutput extends DeleteScheduledActio
49
49
  * API request.</p>
50
50
  *
51
51
  *
52
+ * @example To delete a scheduled action
53
+ * ```javascript
54
+ * // This example deletes a scheduled action for the AppStream 2.0 fleet called sample-fleet.
55
+ * const input = {
56
+ * "ResourceId": "fleet/sample-fleet",
57
+ * "ScalableDimension": "appstream:fleet:DesiredCapacity",
58
+ * "ScheduledActionName": "my-recurring-action",
59
+ * "ServiceNamespace": "appstream"
60
+ * };
61
+ * const command = new DeleteScheduledActionCommand(input);
62
+ * await client.send(command);
63
+ * // example id: to-delete-a-scheduled-action-1677963329606
64
+ * ```
65
+ *
52
66
  */
53
67
  export declare class DeleteScheduledActionCommand extends $Command<DeleteScheduledActionCommandInput, DeleteScheduledActionCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
54
68
  readonly input: DeleteScheduledActionCommandInput;
@@ -48,6 +48,49 @@ export interface DescribeScheduledActionsCommandOutput extends DescribeScheduled
48
48
  * API request.</p>
49
49
  *
50
50
  *
51
+ * @example To describe scheduled actions
52
+ * ```javascript
53
+ * // This example describes the scheduled actions for the dynamodb service namespace.
54
+ * const input = {
55
+ * "ServiceNamespace": "dynamodb"
56
+ * };
57
+ * const command = new DescribeScheduledActionsCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "ScheduledActions": [
62
+ * {
63
+ * "CreationTime": 1561571888.361,
64
+ * "ResourceId": "table/my-table",
65
+ * "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
66
+ * "ScalableTargetAction": {
67
+ * "MaxCapacity": 20,
68
+ * "MinCapacity": 15
69
+ * },
70
+ * "Schedule": "at(2019-05-20T18:35:00)",
71
+ * "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-first-scheduled-action",
72
+ * "ScheduledActionName": "my-first-scheduled-action",
73
+ * "ServiceNamespace": "dynamodb"
74
+ * },
75
+ * {
76
+ * "CreationTime": 1561571946.021,
77
+ * "ResourceId": "table/my-table",
78
+ * "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
79
+ * "ScalableTargetAction": {
80
+ * "MaxCapacity": 10,
81
+ * "MinCapacity": 5
82
+ * },
83
+ * "Schedule": "at(2019-05-20T18:40:00)",
84
+ * "ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledAction:2d36aa3b-cdf9-4565-b290-81db519b227d:resource/dynamodb/table/my-table:scheduledActionName/my-second-scheduled-action",
85
+ * "ScheduledActionName": "my-second-scheduled-action",
86
+ * "ServiceNamespace": "dynamodb"
87
+ * }
88
+ * ]
89
+ * }
90
+ * *\/
91
+ * // example id: to-describe-scheduled-actions-1677965249349
92
+ * ```
93
+ *
51
94
  */
52
95
  export declare class DescribeScheduledActionsCommand extends $Command<DescribeScheduledActionsCommandInput, DescribeScheduledActionsCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
53
96
  readonly input: DescribeScheduledActionsCommandInput;
@@ -0,0 +1,67 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
5
+ import { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link ListTagsForResourceCommand}.
8
+ */
9
+ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequest {
10
+ }
11
+ /**
12
+ * The output of {@link ListTagsForResourceCommand}.
13
+ */
14
+ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Returns all the tags on the specified Application Auto Scaling scalable target.</p>
18
+ * <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
19
+ * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
20
+ * @example
21
+ * Use a bare-bones client and the command you need to make an API call.
22
+ * ```javascript
23
+ * import { ApplicationAutoScalingClient, ListTagsForResourceCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import
24
+ * // const { ApplicationAutoScalingClient, ListTagsForResourceCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import
25
+ * const client = new ApplicationAutoScalingClient(config);
26
+ * const command = new ListTagsForResourceCommand(input);
27
+ * const response = await client.send(command);
28
+ * ```
29
+ *
30
+ * @see {@link ListTagsForResourceCommandInput} for command's `input` shape.
31
+ * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
32
+ * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
33
+ *
34
+ * @throws {@link ResourceNotFoundException} (client fault)
35
+ * <p>The specified resource doesn't exist.</p>
36
+ *
37
+ *
38
+ * @example To list tags for a scalable target
39
+ * ```javascript
40
+ * // This example lists the tag key names and values that are attached to the scalable target specified by its ARN.
41
+ * const input = {
42
+ * "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123"
43
+ * };
44
+ * const command = new ListTagsForResourceCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "Tags": {
49
+ * "environment": "production"
50
+ * }
51
+ * }
52
+ * *\/
53
+ * // example id: to-list-tags-for-a-scalable-target-1677971474903
54
+ * ```
55
+ *
56
+ */
57
+ export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
58
+ readonly input: ListTagsForResourceCommandInput;
59
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
60
+ constructor(input: ListTagsForResourceCommandInput);
61
+ /**
62
+ * @internal
63
+ */
64
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput>;
65
+ private serialize;
66
+ private deserialize;
67
+ }
@@ -36,8 +36,8 @@ export interface PutScalingPolicyCommandOutput extends PutScalingPolicyResponse,
36
36
  * <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html">Target tracking scaling policies</a> and <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html">Step scaling policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>
37
37
  * <note>
38
38
  * <p>If a scalable target is deregistered, the scalable target is no longer available to
39
- * execute scaling policies. Any scaling policies that were specified for the scalable
40
- * target are deleted.</p>
39
+ * use scaling policies. Any scaling policies that were specified for the scalable target
40
+ * are deleted.</p>
41
41
  * </note>
42
42
  * @example
43
43
  * Use a bare-bones client and the command you need to make an API call.
@@ -19,7 +19,7 @@ export interface PutScheduledActionCommandOutput extends PutScheduledActionRespo
19
19
  * dimension. A scheduled action applies to the scalable target identified by those three
20
20
  * attributes. You cannot create a scheduled action until you have registered the resource as
21
21
  * a scalable target.</p>
22
- * <p>When start and end times are specified with a recurring schedule using a cron expression
22
+ * <p>When you specify start and end times with a recurring schedule using a cron expression
23
23
  * or rates, they form the boundaries for when the recurring action starts and stops.</p>
24
24
  * <p>To update a scheduled action, specify the parameters that you want to change. If you
25
25
  * don't specify start and end times, the old values are deleted.</p>
@@ -65,6 +65,24 @@ export interface PutScheduledActionCommandOutput extends PutScheduledActionRespo
65
65
  * API request.</p>
66
66
  *
67
67
  *
68
+ * @example To create a recurring scheduled action
69
+ * ```javascript
70
+ * // This example adds a scheduled action to a DynamoDB table called TestTable to scale out on a recurring schedule. On the specified schedule (every day at 12:15pm UTC), if the current capacity is below the value specified for MinCapacity, Application Auto Scaling scales out to the value specified by MinCapacity.
71
+ * const input = {
72
+ * "ResourceId": "table/TestTable",
73
+ * "ScalableDimension": "dynamodb:table:WriteCapacityUnits",
74
+ * "ScalableTargetAction": {
75
+ * "MinCapacity": 6
76
+ * },
77
+ * "Schedule": "cron(15 12 * * ? *)",
78
+ * "ScheduledActionName": "my-recurring-action",
79
+ * "ServiceNamespace": "dynamodb"
80
+ * };
81
+ * const command = new PutScheduledActionCommand(input);
82
+ * await client.send(command);
83
+ * // example id: to-create-a-recurring-scheduled-action-1677970068621
84
+ * ```
85
+ *
68
86
  */
69
87
  export declare class PutScheduledActionCommand extends $Command<PutScheduledActionCommandInput, PutScheduledActionCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
70
88
  readonly input: PutScheduledActionCommandInput;
@@ -14,7 +14,8 @@ export interface RegisterScalableTargetCommandInput extends RegisterScalableTarg
14
14
  export interface RegisterScalableTargetCommandOutput extends RegisterScalableTargetResponse, __MetadataBearer {
15
15
  }
16
16
  /**
17
- * <p>Registers or updates a scalable target, the resource that you want to scale.</p>
17
+ * <p>Registers or updates a scalable target, which is the resource that you want to
18
+ * scale.</p>
18
19
  * <p>Scalable targets are uniquely identified by the combination of resource ID, scalable
19
20
  * dimension, and namespace, which represents some capacity dimension of the underlying
20
21
  * service.</p>
@@ -22,9 +23,9 @@ export interface RegisterScalableTargetCommandOutput extends RegisterScalableTar
22
23
  * maximum capacity. If the specified resource is not active in the target service, this
23
24
  * operation does not change the resource's current capacity. Otherwise, it changes the
24
25
  * resource's current capacity to a value that is inside of this range.</p>
25
- * <p>If you choose to add a scaling policy, current capacity is adjustable within the
26
- * specified range when scaling starts. Application Auto Scaling scaling policies will not scale capacity to
27
- * values that are outside of the minimum and maximum range.</p>
26
+ * <p>If you add a scaling policy, current capacity is adjustable within the specified range
27
+ * when scaling starts. Application Auto Scaling scaling policies will not scale capacity to values that are
28
+ * outside of the minimum and maximum range.</p>
28
29
  * <p>After you register a scalable target, you do not need to register it again to use other
29
30
  * Application Auto Scaling operations. To see which resources have been registered, use <a href="https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html">DescribeScalableTargets</a>. You can also view the scaling policies for a service
30
31
  * namespace by using <a href="https://docs.aws.amazon.com/autoscaling/application/APIReference/API_DescribeScalableTargets.html">DescribeScalableTargets</a>. If you no longer need a scalable target, you can
@@ -33,11 +34,17 @@ export interface RegisterScalableTargetCommandOutput extends RegisterScalableTar
33
34
  * parameters that identify the scalable target: resource ID, scalable dimension, and
34
35
  * namespace. Any parameters that you don't specify are not changed by this update request. </p>
35
36
  * <note>
36
- * <p>If you call the <code>RegisterScalableTarget</code> API to update an existing
37
- * scalable target, Application Auto Scaling retrieves the current capacity of the resource. If it is below
38
- * the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the capacity of the
39
- * scalable target to place it within these bounds, even if you don't include the
40
- * <code>MinCapacity</code> or <code>MaxCapacity</code> request parameters.</p>
37
+ * <p>If you call the <code>RegisterScalableTarget</code> API operation to create a
38
+ * scalable target, there might be a brief delay until the operation achieves <a href="https://en.wikipedia.org/wiki/Eventual_consistency">eventual
39
+ * consistency</a>. You might become aware of this brief delay if you get unexpected
40
+ * errors when performing sequential operations. The typical strategy is to retry the
41
+ * request, and some Amazon Web Services SDKs include automatic backoff and retry logic.</p>
42
+ * <p>If you call the <code>RegisterScalableTarget</code> API operation to update an
43
+ * existing scalable target, Application Auto Scaling retrieves the current capacity of the resource. If
44
+ * it's below the minimum capacity or above the maximum capacity, Application Auto Scaling adjusts the
45
+ * capacity of the scalable target to place it within these bounds, even if you don't
46
+ * include the <code>MinCapacity</code> or <code>MaxCapacity</code> request
47
+ * parameters.</p>
41
48
  * </note>
42
49
  * @example
43
50
  * Use a bare-bones client and the command you need to make an API call.
@@ -0,0 +1,79 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
5
+ import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link TagResourceCommand}.
8
+ */
9
+ export interface TagResourceCommandInput extends TagResourceRequest {
10
+ }
11
+ /**
12
+ * The output of {@link TagResourceCommand}.
13
+ */
14
+ export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Adds or edits tags on an Application Auto Scaling scalable target.</p>
18
+ * <p>Each tag consists of a tag key and a tag value, which are both case-sensitive strings.
19
+ * To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag
20
+ * key and a new tag value.</p>
21
+ * <p>You can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a
22
+ * scaling policy or scheduled action.</p>
23
+ * <p>You can also add tags to an Application Auto Scaling scalable target while creating it
24
+ * (<code>RegisterScalableTarget</code>).</p>
25
+ * <p>For general information about tags, including the format and syntax, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
26
+ * resources</a> in the <i>Amazon Web Services General Reference</i>.</p>
27
+ * <p>Use tags to control access to a scalable target. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/application/userguide/resource-tagging-support.html">Tagging support
28
+ * for Application Auto Scaling</a> in the <i>Application Auto Scaling User Guide</i>.</p>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { ApplicationAutoScalingClient, TagResourceCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import
33
+ * // const { ApplicationAutoScalingClient, TagResourceCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import
34
+ * const client = new ApplicationAutoScalingClient(config);
35
+ * const command = new TagResourceCommand(input);
36
+ * const response = await client.send(command);
37
+ * ```
38
+ *
39
+ * @see {@link TagResourceCommandInput} for command's `input` shape.
40
+ * @see {@link TagResourceCommandOutput} for command's `response` shape.
41
+ * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
42
+ *
43
+ * @throws {@link ResourceNotFoundException} (client fault)
44
+ * <p>The specified resource doesn't exist.</p>
45
+ *
46
+ * @throws {@link TooManyTagsException} (client fault)
47
+ * <p>The request contains too many tags. Try the request again with fewer tags.</p>
48
+ *
49
+ * @throws {@link ValidationException} (client fault)
50
+ * <p>An exception was thrown for a validation issue. Review the available parameters for the
51
+ * API request.</p>
52
+ *
53
+ *
54
+ * @example To add a tag to a scalable target
55
+ * ```javascript
56
+ * // This example adds a tag with the key name "environment" and the value "production" to the scalable target specified by its ARN.
57
+ * const input = {
58
+ * "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
59
+ * "Tags": {
60
+ * "environment": "production"
61
+ * }
62
+ * };
63
+ * const command = new TagResourceCommand(input);
64
+ * await client.send(command);
65
+ * // example id: to-add-a-tag-to-a-scalable-target-1677970764620
66
+ * ```
67
+ *
68
+ */
69
+ export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
70
+ readonly input: TagResourceCommandInput;
71
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
72
+ constructor(input: TagResourceCommandInput);
73
+ /**
74
+ * @internal
75
+ */
76
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
77
+ private serialize;
78
+ private deserialize;
79
+ }
@@ -0,0 +1,66 @@
1
+ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
2
+ import { Command as $Command } from "@aws-sdk/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
4
+ import { ApplicationAutoScalingClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ApplicationAutoScalingClient";
5
+ import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
6
+ /**
7
+ * The input for {@link UntagResourceCommand}.
8
+ */
9
+ export interface UntagResourceCommandInput extends UntagResourceRequest {
10
+ }
11
+ /**
12
+ * The output of {@link UntagResourceCommand}.
13
+ */
14
+ export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
15
+ }
16
+ /**
17
+ * <p>Deletes tags from an Application Auto Scaling scalable target. To delete a tag, specify the tag key and
18
+ * the Application Auto Scaling scalable target.</p>
19
+ * @example
20
+ * Use a bare-bones client and the command you need to make an API call.
21
+ * ```javascript
22
+ * import { ApplicationAutoScalingClient, UntagResourceCommand } from "@aws-sdk/client-application-auto-scaling"; // ES Modules import
23
+ * // const { ApplicationAutoScalingClient, UntagResourceCommand } = require("@aws-sdk/client-application-auto-scaling"); // CommonJS import
24
+ * const client = new ApplicationAutoScalingClient(config);
25
+ * const command = new UntagResourceCommand(input);
26
+ * const response = await client.send(command);
27
+ * ```
28
+ *
29
+ * @see {@link UntagResourceCommandInput} for command's `input` shape.
30
+ * @see {@link UntagResourceCommandOutput} for command's `response` shape.
31
+ * @see {@link ApplicationAutoScalingClientResolvedConfig | config} for ApplicationAutoScalingClient's `config` shape.
32
+ *
33
+ * @throws {@link ResourceNotFoundException} (client fault)
34
+ * <p>The specified resource doesn't exist.</p>
35
+ *
36
+ * @throws {@link ValidationException} (client fault)
37
+ * <p>An exception was thrown for a validation issue. Review the available parameters for the
38
+ * API request.</p>
39
+ *
40
+ *
41
+ * @example To remove a tag from a scalable target
42
+ * ```javascript
43
+ * // This example removes the tag pair with the key name "environment" from the scalable target specified by its ARN.
44
+ * const input = {
45
+ * "ResourceARN": "arn:aws:application-autoscaling:us-west-2:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123",
46
+ * "TagKeys": [
47
+ * "environment"
48
+ * ]
49
+ * };
50
+ * const command = new UntagResourceCommand(input);
51
+ * await client.send(command);
52
+ * // example id: to-remove-a-tag-from-a-scalable-target-1677971117168
53
+ * ```
54
+ *
55
+ */
56
+ export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
57
+ readonly input: UntagResourceCommandInput;
58
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
59
+ constructor(input: UntagResourceCommandInput);
60
+ /**
61
+ * @internal
62
+ */
63
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ApplicationAutoScalingClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
64
+ private serialize;
65
+ private deserialize;
66
+ }
@@ -5,6 +5,9 @@ export * from "./DescribeScalableTargetsCommand";
5
5
  export * from "./DescribeScalingActivitiesCommand";
6
6
  export * from "./DescribeScalingPoliciesCommand";
7
7
  export * from "./DescribeScheduledActionsCommand";
8
+ export * from "./ListTagsForResourceCommand";
8
9
  export * from "./PutScalingPolicyCommand";
9
10
  export * from "./PutScheduledActionCommand";
10
11
  export * from "./RegisterScalableTargetCommand";
12
+ export * from "./TagResourceCommand";
13
+ export * from "./UntagResourceCommand";
@@ -5,7 +5,7 @@ export interface ClientInputEndpointParameters {
5
5
  useFipsEndpoint?: boolean | Provider<boolean>;
6
6
  endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
7
7
  }
8
- export declare type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
8
+ export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
9
9
  defaultSigningName: string;
10
10
  };
11
11
  export declare const resolveClientEndpointParameters: <T>(options: T & ClientInputEndpointParameters) => T & ClientInputEndpointParameters & {