@aws-sdk/client-application-auto-scaling 3.295.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 (7) hide show
  1. package/dist-types/commands/DeleteScheduledActionCommand.d.ts +14 -0
  2. package/dist-types/commands/DescribeScheduledActionsCommand.d.ts +43 -0
  3. package/dist-types/commands/ListTagsForResourceCommand.d.ts +18 -0
  4. package/dist-types/commands/PutScheduledActionCommand.d.ts +18 -0
  5. package/dist-types/commands/TagResourceCommand.d.ts +14 -0
  6. package/dist-types/commands/UntagResourceCommand.d.ts +14 -0
  7. package/package.json +29 -29
package/dist-types/commands/DeleteScheduledActionCommand.d.ts CHANGED
@@ -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;
package/dist-types/commands/DescribeScheduledActionsCommand.d.ts CHANGED
@@ -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;
package/dist-types/commands/ListTagsForResourceCommand.d.ts CHANGED
@@ -35,6 +35,24 @@ export interface ListTagsForResourceCommandOutput extends ListTagsForResourceRes
35
35
  * <p>The specified resource doesn't exist.</p>
36
36
  *
37
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
+ *
38
56
  */
39
57
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
40
58
  readonly input: ListTagsForResourceCommandInput;
package/dist-types/commands/PutScheduledActionCommand.d.ts CHANGED
@@ -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;
package/dist-types/commands/TagResourceCommand.d.ts CHANGED
@@ -51,6 +51,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
51
51
  * API request.</p>
52
52
  *
53
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
+ *
54
68
  */
55
69
  export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
56
70
  readonly input: TagResourceCommandInput;
package/dist-types/commands/UntagResourceCommand.d.ts CHANGED
@@ -38,6 +38,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
38
38
  * API request.</p>
39
39
  *
40
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
+ *
41
55
  */
42
56
  export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, ApplicationAutoScalingClientResolvedConfig> {
43
57
  readonly input: UntagResourceCommandInput;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-application-auto-scaling",
3
3
  "description": "AWS SDK for JavaScript Application Auto Scaling Client for Node.js, Browser and React Native",
4
- "version": "3.295.0",
4
+ "version": "3.296.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,37 +20,37 @@
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.295.0",
24
- "@aws-sdk/config-resolver": "3.295.0",
25
- "@aws-sdk/credential-provider-node": "3.295.0",
26
- "@aws-sdk/fetch-http-handler": "3.295.0",
27
- "@aws-sdk/hash-node": "3.295.0",
28
- "@aws-sdk/invalid-dependency": "3.295.0",
29
- "@aws-sdk/middleware-content-length": "3.295.0",
30
- "@aws-sdk/middleware-endpoint": "3.295.0",
31
- "@aws-sdk/middleware-host-header": "3.295.0",
32
- "@aws-sdk/middleware-logger": "3.295.0",
33
- "@aws-sdk/middleware-recursion-detection": "3.295.0",
34
- "@aws-sdk/middleware-retry": "3.295.0",
35
- "@aws-sdk/middleware-serde": "3.295.0",
36
- "@aws-sdk/middleware-signing": "3.295.0",
37
- "@aws-sdk/middleware-stack": "3.295.0",
38
- "@aws-sdk/middleware-user-agent": "3.295.0",
39
- "@aws-sdk/node-config-provider": "3.295.0",
40
- "@aws-sdk/node-http-handler": "3.295.0",
41
- "@aws-sdk/protocol-http": "3.295.0",
42
- "@aws-sdk/smithy-client": "3.295.0",
43
- "@aws-sdk/types": "3.295.0",
44
- "@aws-sdk/url-parser": "3.295.0",
23
+ "@aws-sdk/client-sts": "3.296.0",
24
+ "@aws-sdk/config-resolver": "3.296.0",
25
+ "@aws-sdk/credential-provider-node": "3.296.0",
26
+ "@aws-sdk/fetch-http-handler": "3.296.0",
27
+ "@aws-sdk/hash-node": "3.296.0",
28
+ "@aws-sdk/invalid-dependency": "3.296.0",
29
+ "@aws-sdk/middleware-content-length": "3.296.0",
30
+ "@aws-sdk/middleware-endpoint": "3.296.0",
31
+ "@aws-sdk/middleware-host-header": "3.296.0",
32
+ "@aws-sdk/middleware-logger": "3.296.0",
33
+ "@aws-sdk/middleware-recursion-detection": "3.296.0",
34
+ "@aws-sdk/middleware-retry": "3.296.0",
35
+ "@aws-sdk/middleware-serde": "3.296.0",
36
+ "@aws-sdk/middleware-signing": "3.296.0",
37
+ "@aws-sdk/middleware-stack": "3.296.0",
38
+ "@aws-sdk/middleware-user-agent": "3.296.0",
39
+ "@aws-sdk/node-config-provider": "3.296.0",
40
+ "@aws-sdk/node-http-handler": "3.296.0",
41
+ "@aws-sdk/protocol-http": "3.296.0",
42
+ "@aws-sdk/smithy-client": "3.296.0",
43
+ "@aws-sdk/types": "3.296.0",
44
+ "@aws-sdk/url-parser": "3.296.0",
45
45
  "@aws-sdk/util-base64": "3.295.0",
46
46
  "@aws-sdk/util-body-length-browser": "3.295.0",
47
47
  "@aws-sdk/util-body-length-node": "3.295.0",
48
- "@aws-sdk/util-defaults-mode-browser": "3.295.0",
49
- "@aws-sdk/util-defaults-mode-node": "3.295.0",
50
- "@aws-sdk/util-endpoints": "3.295.0",
51
- "@aws-sdk/util-retry": "3.295.0",
52
- "@aws-sdk/util-user-agent-browser": "3.295.0",
53
- "@aws-sdk/util-user-agent-node": "3.295.0",
48
+ "@aws-sdk/util-defaults-mode-browser": "3.296.0",
49
+ "@aws-sdk/util-defaults-mode-node": "3.296.0",
50
+ "@aws-sdk/util-endpoints": "3.296.0",
51
+ "@aws-sdk/util-retry": "3.296.0",
52
+ "@aws-sdk/util-user-agent-browser": "3.296.0",
53
+ "@aws-sdk/util-user-agent-node": "3.296.0",
54
54
  "@aws-sdk/util-utf8": "3.295.0",
55
55
  "tslib": "^2.5.0"
56
56
  },