Skip to content

Commit 0f45892

Browse files
author
awstools
committed
feat(client-ssm): Added support for providing high-level overviews of managed nodes and previewing the potential impact of a runbook execution.
1 parent 1681d8f commit 0f45892

34 files changed

+4909
-1741
lines changed

Diff for: clients/client-ssm/README.md

+39-7
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,16 @@ using your favorite package manager:
5858

5959
The AWS SDK is modulized by clients and commands.
6060
To send a request, you only need to import the `SSMClient` and
61-
the commands you need, for example `ListAssociationsCommand`:
61+
the commands you need, for example `ListNodesCommand`:
6262

6363
```js
6464
// ES5 example
65-
const { SSMClient, ListAssociationsCommand } = require("@aws-sdk/client-ssm");
65+
const { SSMClient, ListNodesCommand } = require("@aws-sdk/client-ssm");
6666
```
6767

6868
```ts
6969
// ES6+ example
70-
import { SSMClient, ListAssociationsCommand } from "@aws-sdk/client-ssm";
70+
import { SSMClient, ListNodesCommand } from "@aws-sdk/client-ssm";
7171
```
7272

7373
### Usage
@@ -86,7 +86,7 @@ const client = new SSMClient({ region: "REGION" });
8686
const params = {
8787
/** input parameters */
8888
};
89-
const command = new ListAssociationsCommand(params);
89+
const command = new ListNodesCommand(params);
9090
```
9191

9292
#### Async/await
@@ -165,15 +165,15 @@ const client = new AWS.SSM({ region: "REGION" });
165165

166166
// async/await.
167167
try {
168-
const data = await client.listAssociations(params);
168+
const data = await client.listNodes(params);
169169
// process data.
170170
} catch (error) {
171171
// error handling.
172172
}
173173

174174
// Promises.
175175
client
176-
.listAssociations(params)
176+
.listNodes(params)
177177
.then((data) => {
178178
// process data.
179179
})
@@ -182,7 +182,7 @@ client
182182
});
183183

184184
// callbacks.
185-
client.listAssociations(params, (err, data) => {
185+
client.listNodes(params, (err, data) => {
186186
// process err and data.
187187
});
188188
```
@@ -797,6 +797,14 @@ GetDocument
797797

798798
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/GetDocumentCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/GetDocumentCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/GetDocumentCommandOutput/)
799799

800+
</details>
801+
<details>
802+
<summary>
803+
GetExecutionPreview
804+
</summary>
805+
806+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/GetExecutionPreviewCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/GetExecutionPreviewCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/GetExecutionPreviewCommandOutput/)
807+
800808
</details>
801809
<details>
802810
<summary>
@@ -1029,6 +1037,22 @@ ListInventoryEntries
10291037

10301038
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListInventoryEntriesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListInventoryEntriesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListInventoryEntriesCommandOutput/)
10311039

1040+
</details>
1041+
<details>
1042+
<summary>
1043+
ListNodes
1044+
</summary>
1045+
1046+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListNodesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListNodesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListNodesCommandOutput/)
1047+
1048+
</details>
1049+
<details>
1050+
<summary>
1051+
ListNodesSummary
1052+
</summary>
1053+
1054+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/ListNodesSummaryCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListNodesSummaryCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/ListNodesSummaryCommandOutput/)
1055+
10321056
</details>
10331057
<details>
10341058
<summary>
@@ -1213,6 +1237,14 @@ StartChangeRequestExecution
12131237

12141238
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/StartChangeRequestExecutionCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/StartChangeRequestExecutionCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/StartChangeRequestExecutionCommandOutput/)
12151239

1240+
</details>
1241+
<details>
1242+
<summary>
1243+
StartExecutionPreview
1244+
</summary>
1245+
1246+
[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm/command/StartExecutionPreviewCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/StartExecutionPreviewCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm/Interface/StartExecutionPreviewCommandOutput/)
1247+
12161248
</details>
12171249
<details>
12181250
<summary>

Diff for: clients/client-ssm/src/SSM.ts

+83
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,11 @@ import {
348348
GetDeployablePatchSnapshotForInstanceCommandOutput,
349349
} from "./commands/GetDeployablePatchSnapshotForInstanceCommand";
350350
import { GetDocumentCommand, GetDocumentCommandInput, GetDocumentCommandOutput } from "./commands/GetDocumentCommand";
351+
import {
352+
GetExecutionPreviewCommand,
353+
GetExecutionPreviewCommandInput,
354+
GetExecutionPreviewCommandOutput,
355+
} from "./commands/GetExecutionPreviewCommand";
351356
import {
352357
GetInventoryCommand,
353358
GetInventoryCommandInput,
@@ -489,6 +494,12 @@ import {
489494
ListInventoryEntriesCommandInput,
490495
ListInventoryEntriesCommandOutput,
491496
} from "./commands/ListInventoryEntriesCommand";
497+
import { ListNodesCommand, ListNodesCommandInput, ListNodesCommandOutput } from "./commands/ListNodesCommand";
498+
import {
499+
ListNodesSummaryCommand,
500+
ListNodesSummaryCommandInput,
501+
ListNodesSummaryCommandOutput,
502+
} from "./commands/ListNodesSummaryCommand";
492503
import {
493504
ListOpsItemEventsCommand,
494505
ListOpsItemEventsCommandInput,
@@ -600,6 +611,11 @@ import {
600611
StartChangeRequestExecutionCommandInput,
601612
StartChangeRequestExecutionCommandOutput,
602613
} from "./commands/StartChangeRequestExecutionCommand";
614+
import {
615+
StartExecutionPreviewCommand,
616+
StartExecutionPreviewCommandInput,
617+
StartExecutionPreviewCommandOutput,
618+
} from "./commands/StartExecutionPreviewCommand";
603619
import {
604620
StartSessionCommand,
605621
StartSessionCommandInput,
@@ -763,6 +779,7 @@ const commands = {
763779
GetDefaultPatchBaselineCommand,
764780
GetDeployablePatchSnapshotForInstanceCommand,
765781
GetDocumentCommand,
782+
GetExecutionPreviewCommand,
766783
GetInventoryCommand,
767784
GetInventorySchemaCommand,
768785
GetMaintenanceWindowCommand,
@@ -792,6 +809,8 @@ const commands = {
792809
ListDocumentsCommand,
793810
ListDocumentVersionsCommand,
794811
ListInventoryEntriesCommand,
812+
ListNodesCommand,
813+
ListNodesSummaryCommand,
795814
ListOpsItemEventsCommand,
796815
ListOpsItemRelatedItemsCommand,
797816
ListOpsMetadataCommand,
@@ -815,6 +834,7 @@ const commands = {
815834
StartAssociationsOnceCommand,
816835
StartAutomationExecutionCommand,
817836
StartChangeRequestExecutionCommand,
837+
StartExecutionPreviewCommand,
818838
StartSessionCommand,
819839
StopAutomationExecutionCommand,
820840
TerminateSessionCommand,
@@ -2005,6 +2025,23 @@ export interface SSM {
20052025
cb: (err: any, data?: GetDocumentCommandOutput) => void
20062026
): void;
20072027

2028+
/**
2029+
* @see {@link GetExecutionPreviewCommand}
2030+
*/
2031+
getExecutionPreview(
2032+
args: GetExecutionPreviewCommandInput,
2033+
options?: __HttpHandlerOptions
2034+
): Promise<GetExecutionPreviewCommandOutput>;
2035+
getExecutionPreview(
2036+
args: GetExecutionPreviewCommandInput,
2037+
cb: (err: any, data?: GetExecutionPreviewCommandOutput) => void
2038+
): void;
2039+
getExecutionPreview(
2040+
args: GetExecutionPreviewCommandInput,
2041+
options: __HttpHandlerOptions,
2042+
cb: (err: any, data?: GetExecutionPreviewCommandOutput) => void
2043+
): void;
2044+
20082045
/**
20092046
* @see {@link GetInventoryCommand}
20102047
*/
@@ -2462,6 +2499,35 @@ export interface SSM {
24622499
cb: (err: any, data?: ListInventoryEntriesCommandOutput) => void
24632500
): void;
24642501

2502+
/**
2503+
* @see {@link ListNodesCommand}
2504+
*/
2505+
listNodes(): Promise<ListNodesCommandOutput>;
2506+
listNodes(args: ListNodesCommandInput, options?: __HttpHandlerOptions): Promise<ListNodesCommandOutput>;
2507+
listNodes(args: ListNodesCommandInput, cb: (err: any, data?: ListNodesCommandOutput) => void): void;
2508+
listNodes(
2509+
args: ListNodesCommandInput,
2510+
options: __HttpHandlerOptions,
2511+
cb: (err: any, data?: ListNodesCommandOutput) => void
2512+
): void;
2513+
2514+
/**
2515+
* @see {@link ListNodesSummaryCommand}
2516+
*/
2517+
listNodesSummary(
2518+
args: ListNodesSummaryCommandInput,
2519+
options?: __HttpHandlerOptions
2520+
): Promise<ListNodesSummaryCommandOutput>;
2521+
listNodesSummary(
2522+
args: ListNodesSummaryCommandInput,
2523+
cb: (err: any, data?: ListNodesSummaryCommandOutput) => void
2524+
): void;
2525+
listNodesSummary(
2526+
args: ListNodesSummaryCommandInput,
2527+
options: __HttpHandlerOptions,
2528+
cb: (err: any, data?: ListNodesSummaryCommandOutput) => void
2529+
): void;
2530+
24652531
/**
24662532
* @see {@link ListOpsItemEventsCommand}
24672533
*/
@@ -2831,6 +2897,23 @@ export interface SSM {
28312897
cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void
28322898
): void;
28332899

2900+
/**
2901+
* @see {@link StartExecutionPreviewCommand}
2902+
*/
2903+
startExecutionPreview(
2904+
args: StartExecutionPreviewCommandInput,
2905+
options?: __HttpHandlerOptions
2906+
): Promise<StartExecutionPreviewCommandOutput>;
2907+
startExecutionPreview(
2908+
args: StartExecutionPreviewCommandInput,
2909+
cb: (err: any, data?: StartExecutionPreviewCommandOutput) => void
2910+
): void;
2911+
startExecutionPreview(
2912+
args: StartExecutionPreviewCommandInput,
2913+
options: __HttpHandlerOptions,
2914+
cb: (err: any, data?: StartExecutionPreviewCommandOutput) => void
2915+
): void;
2916+
28342917
/**
28352918
* @see {@link StartSessionCommand}
28362919
*/

Diff for: clients/client-ssm/src/SSMClient.ts

+18
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,10 @@ import {
270270
GetDeployablePatchSnapshotForInstanceCommandOutput,
271271
} from "./commands/GetDeployablePatchSnapshotForInstanceCommand";
272272
import { GetDocumentCommandInput, GetDocumentCommandOutput } from "./commands/GetDocumentCommand";
273+
import {
274+
GetExecutionPreviewCommandInput,
275+
GetExecutionPreviewCommandOutput,
276+
} from "./commands/GetExecutionPreviewCommand";
273277
import { GetInventoryCommandInput, GetInventoryCommandOutput } from "./commands/GetInventoryCommand";
274278
import { GetInventorySchemaCommandInput, GetInventorySchemaCommandOutput } from "./commands/GetInventorySchemaCommand";
275279
import {
@@ -350,6 +354,8 @@ import {
350354
ListInventoryEntriesCommandInput,
351355
ListInventoryEntriesCommandOutput,
352356
} from "./commands/ListInventoryEntriesCommand";
357+
import { ListNodesCommandInput, ListNodesCommandOutput } from "./commands/ListNodesCommand";
358+
import { ListNodesSummaryCommandInput, ListNodesSummaryCommandOutput } from "./commands/ListNodesSummaryCommand";
353359
import { ListOpsItemEventsCommandInput, ListOpsItemEventsCommandOutput } from "./commands/ListOpsItemEventsCommand";
354360
import {
355361
ListOpsItemRelatedItemsCommandInput,
@@ -418,6 +424,10 @@ import {
418424
StartChangeRequestExecutionCommandInput,
419425
StartChangeRequestExecutionCommandOutput,
420426
} from "./commands/StartChangeRequestExecutionCommand";
427+
import {
428+
StartExecutionPreviewCommandInput,
429+
StartExecutionPreviewCommandOutput,
430+
} from "./commands/StartExecutionPreviewCommand";
421431
import { StartSessionCommandInput, StartSessionCommandOutput } from "./commands/StartSessionCommand";
422432
import {
423433
StopAutomationExecutionCommandInput,
@@ -557,6 +567,7 @@ export type ServiceInputTypes =
557567
| GetDefaultPatchBaselineCommandInput
558568
| GetDeployablePatchSnapshotForInstanceCommandInput
559569
| GetDocumentCommandInput
570+
| GetExecutionPreviewCommandInput
560571
| GetInventoryCommandInput
561572
| GetInventorySchemaCommandInput
562573
| GetMaintenanceWindowCommandInput
@@ -586,6 +597,8 @@ export type ServiceInputTypes =
586597
| ListDocumentVersionsCommandInput
587598
| ListDocumentsCommandInput
588599
| ListInventoryEntriesCommandInput
600+
| ListNodesCommandInput
601+
| ListNodesSummaryCommandInput
589602
| ListOpsItemEventsCommandInput
590603
| ListOpsItemRelatedItemsCommandInput
591604
| ListOpsMetadataCommandInput
@@ -609,6 +622,7 @@ export type ServiceInputTypes =
609622
| StartAssociationsOnceCommandInput
610623
| StartAutomationExecutionCommandInput
611624
| StartChangeRequestExecutionCommandInput
625+
| StartExecutionPreviewCommandInput
612626
| StartSessionCommandInput
613627
| StopAutomationExecutionCommandInput
614628
| TerminateSessionCommandInput
@@ -702,6 +716,7 @@ export type ServiceOutputTypes =
702716
| GetDefaultPatchBaselineCommandOutput
703717
| GetDeployablePatchSnapshotForInstanceCommandOutput
704718
| GetDocumentCommandOutput
719+
| GetExecutionPreviewCommandOutput
705720
| GetInventoryCommandOutput
706721
| GetInventorySchemaCommandOutput
707722
| GetMaintenanceWindowCommandOutput
@@ -731,6 +746,8 @@ export type ServiceOutputTypes =
731746
| ListDocumentVersionsCommandOutput
732747
| ListDocumentsCommandOutput
733748
| ListInventoryEntriesCommandOutput
749+
| ListNodesCommandOutput
750+
| ListNodesSummaryCommandOutput
734751
| ListOpsItemEventsCommandOutput
735752
| ListOpsItemRelatedItemsCommandOutput
736753
| ListOpsMetadataCommandOutput
@@ -754,6 +771,7 @@ export type ServiceOutputTypes =
754771
| StartAssociationsOnceCommandOutput
755772
| StartAutomationExecutionCommandOutput
756773
| StartChangeRequestExecutionCommandOutput
774+
| StartExecutionPreviewCommandOutput
757775
| StartSessionCommandOutput
758776
| StopAutomationExecutionCommandOutput
759777
| TerminateSessionCommandOutput

Diff for: clients/client-ssm/src/commands/CreateResourceDataSyncCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface CreateResourceDataSyncCommandOutput extends CreateResourceDataS
3232
* Amazon Web Services Systems Manager offers two types of resource data sync: <code>SyncToDestination</code> and
3333
* <code>SyncFromSource</code>.</p>
3434
* <p>You can configure Systems Manager Inventory to use the <code>SyncToDestination</code> type to
35-
* synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-create-resource-data-sync.html">Creatinga a
35+
* synchronize Inventory data from multiple Amazon Web Services Regions to a single Amazon Simple Storage Service (Amazon S3) bucket. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/inventory-create-resource-data-sync.html">Creating a
3636
* resource data sync for Inventory</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3737
* <p>You can configure Systems Manager Explorer to use the <code>SyncFromSource</code> type to synchronize
3838
* operational work items (OpsItems) and operational data (OpsData) from multiple Amazon Web Services Regions to a

Diff for: clients/client-ssm/src/commands/DeleteActivationCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export interface DeleteActivationCommandOutput extends DeleteActivationResult, _
6060
* the ActivationCode don't match.</p>
6161
*
6262
* @throws {@link InvalidActivationId} (client fault)
63-
* <p>The activation ID isn't valid. Verify the you entered the correct ActivationId or
63+
* <p>The activation ID isn't valid. Verify that you entered the correct ActivationId or
6464
* ActivationCode and try again.</p>
6565
*
6666
* @throws {@link TooManyUpdates} (client fault)

Diff for: clients/client-ssm/src/commands/DescribeActivationsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ export interface DescribeActivationsCommandOutput extends DescribeActivationsRes
8787
* <p>An error occurred on the server side.</p>
8888
*
8989
* @throws {@link InvalidFilter} (client fault)
90-
* <p>The filter name isn't valid. Verify the you entered the correct name and try again.</p>
90+
* <p>The filter name isn't valid. Verify that you entered the correct name and try again.</p>
9191
*
9292
* @throws {@link InvalidNextToken} (client fault)
9393
* <p>The specified token isn't valid.</p>

Diff for: clients/client-ssm/src/commands/DescribeInstancePatchStatesForPatchGroupCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ export interface DescribeInstancePatchStatesForPatchGroupCommandOutput
104104
* <p>An error occurred on the server side.</p>
105105
*
106106
* @throws {@link InvalidFilter} (client fault)
107-
* <p>The filter name isn't valid. Verify the you entered the correct name and try again.</p>
107+
* <p>The filter name isn't valid. Verify that you entered the correct name and try again.</p>
108108
*
109109
* @throws {@link InvalidNextToken} (client fault)
110110
* <p>The specified token isn't valid.</p>

Diff for: clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePa
7878
* <p>An error occurred on the server side.</p>
7979
*
8080
* @throws {@link InvalidFilter} (client fault)
81-
* <p>The filter name isn't valid. Verify the you entered the correct name and try again.</p>
81+
* <p>The filter name isn't valid. Verify that you entered the correct name and try again.</p>
8282
*
8383
* @throws {@link InvalidInstanceId} (client fault)
8484
* <p>The following problems can cause this exception:</p>

Diff for: clients/client-ssm/src/commands/DescribeInstancePropertiesCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ export interface DescribeInstancePropertiesCommandOutput extends DescribeInstanc
114114
* <p>An error occurred on the server side.</p>
115115
*
116116
* @throws {@link InvalidActivationId} (client fault)
117-
* <p>The activation ID isn't valid. Verify the you entered the correct ActivationId or
117+
* <p>The activation ID isn't valid. Verify that you entered the correct ActivationId or
118118
* ActivationCode and try again.</p>
119119
*
120120
* @throws {@link InvalidDocument} (client fault)

0 commit comments

Comments
 (0)