@aws-sdk/client-ssm 3.698.0 → 3.699.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.
@@ -82,6 +82,35 @@ declare const GetExecutionPreviewCommand_base: {
82
82
  * <p>Base exception class for all service exceptions from SSM service.</p>
83
83
  *
84
84
  * @public
85
+ * @example GetExecutionPreview
86
+ * ```javascript
87
+ * // This example illustrates one usage of GetExecutionPreview
88
+ * const input = {
89
+ * "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0ab47bb26"
90
+ * };
91
+ * const command = new GetExecutionPreviewCommand(input);
92
+ * const response = await client.send(command);
93
+ * /* response ==
94
+ * {
95
+ * "EndedAt": "2024-11-13T01:50:39.424000+00:00",
96
+ * "ExecutionPreview": {
97
+ * "Automation": {
98
+ * "Regions": [
99
+ * "us-east-2"
100
+ * ],
101
+ * "StepPreviews": {
102
+ * "Undetermined": 1
103
+ * },
104
+ * "TotalAccounts": 1
105
+ * }
106
+ * },
107
+ * "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0ab47bb26",
108
+ * "Status": "Success"
109
+ * }
110
+ * *\/
111
+ * // example id: getexecutionpreview-f6ae6a7e734e
112
+ * ```
113
+ *
85
114
  */
86
115
  export declare class GetExecutionPreviewCommand extends GetExecutionPreviewCommand_base {
87
116
  /** @internal type navigation helper, not in runtime. */
@@ -107,6 +107,58 @@ declare const ListNodesCommand_base: {
107
107
  * <p>Base exception class for all service exceptions from SSM service.</p>
108
108
  *
109
109
  * @public
110
+ * @example ListNodes
111
+ * ```javascript
112
+ * // This example illustrates one usage of ListNodes
113
+ * const input = {
114
+ * "Filters": [
115
+ * {
116
+ * "Key": "Region",
117
+ * "Type": "Equal",
118
+ * "Values": [
119
+ * "us-east-2"
120
+ * ]
121
+ * }
122
+ * ],
123
+ * "MaxResults": 1,
124
+ * "SyncName": "AWS-QuickSetup-ManagedNode"
125
+ * };
126
+ * const command = new ListNodesCommand(input);
127
+ * const response = await client.send(command);
128
+ * /* response ==
129
+ * {
130
+ * "NextToken": "A9lT8CAxj9aDFRi+MNAoFq08IEXAMPLE",
131
+ * "Nodes": [
132
+ * {
133
+ * "CaptureTime": "2024-11-19T22:01:18",
134
+ * "Id": "i-02573cafcfEXAMPLE",
135
+ * "NodeType": {
136
+ * "Instance": {
137
+ * "AgentType": "amazon-ssm-agent",
138
+ * "AgentVersion": "3.3.859.0",
139
+ * "ComputerName": "ip-192.0.2.0.ec2.internal",
140
+ * "InstanceStatus": "Active",
141
+ * "IpAddress": "192.0.2.0",
142
+ * "ManagedStatus": "Managed",
143
+ * "PlatformName": "Amazon Linux",
144
+ * "PlatformType": "Linux",
145
+ * "PlatformVersion": "2023",
146
+ * "ResourceType": "EC2Instance"
147
+ * }
148
+ * },
149
+ * "Owner": {
150
+ * "AccountId": "111122223333",
151
+ * "OrganizationalUnitId": "ou-b8dn-sasv9tfp",
152
+ * "OrganizationalUnitPath": "r-b8dn/ou-b8dn-sasv9tfp"
153
+ * },
154
+ * "Region": "us-east-2"
155
+ * }
156
+ * ]
157
+ * }
158
+ * *\/
159
+ * // example id: listnodes--ec13d561ee02
160
+ * ```
161
+ *
110
162
  */
111
163
  export declare class ListNodesCommand extends ListNodesCommand_base {
112
164
  /** @internal type navigation helper, not in runtime. */
@@ -107,6 +107,49 @@ declare const ListNodesSummaryCommand_base: {
107
107
  * <p>Base exception class for all service exceptions from SSM service.</p>
108
108
  *
109
109
  * @public
110
+ * @example ListNodesSummary
111
+ * ```javascript
112
+ * // This example illustrates one usage of ListNodesSummary
113
+ * const input = {
114
+ * "Aggregators": [
115
+ * {
116
+ * "AggregatorType": "Count",
117
+ * "AttributeName": "Region",
118
+ * "TypeName": "Instance"
119
+ * }
120
+ * ],
121
+ * "Filters": [
122
+ * {
123
+ * "Key": "InstanceStatus",
124
+ * "Type": "Equal",
125
+ * "Values": [
126
+ * "Active"
127
+ * ]
128
+ * }
129
+ * ],
130
+ * "MaxResults": 2,
131
+ * "NextToken": "A9lT8CAxj9aDFRi+MNAoFq08I---EXAMPLE",
132
+ * "SyncName": "AWS-QuickSetup-ManagedNode"
133
+ * };
134
+ * const command = new ListNodesSummaryCommand(input);
135
+ * const response = await client.send(command);
136
+ * /* response ==
137
+ * {
138
+ * "Summary": [
139
+ * {
140
+ * "Count": "26",
141
+ * "Region": "us-east-1"
142
+ * },
143
+ * {
144
+ * "Count": "7",
145
+ * "Region": "us-east-2"
146
+ * }
147
+ * ]
148
+ * }
149
+ * *\/
150
+ * // example id: listnodessummary-9a63f9e71ee0
151
+ * ```
152
+ *
110
153
  */
111
154
  export declare class ListNodesSummaryCommand extends ListNodesSummaryCommand_base {
112
155
  /** @internal type navigation helper, not in runtime. */
@@ -125,6 +125,22 @@ declare const StartExecutionPreviewCommand_base: {
125
125
  * <p>Base exception class for all service exceptions from SSM service.</p>
126
126
  *
127
127
  * @public
128
+ * @example StartExecutionPreview
129
+ * ```javascript
130
+ * // This example illustrates one usage of StartExecutionPreview
131
+ * const input = {
132
+ * "DocumentName": "AWS-StartEC2Instance"
133
+ * };
134
+ * const command = new StartExecutionPreviewCommand(input);
135
+ * const response = await client.send(command);
136
+ * /* response ==
137
+ * {
138
+ * "ExecutionPreviewId": "2f27d6e5-9676-4708-b8bd-aef0ab47bb26"
139
+ * }
140
+ * *\/
141
+ * // example id: startexecutionpreview-7a6b962646a9
142
+ * ```
143
+ *
128
144
  */
129
145
  export declare class StartExecutionPreviewCommand extends StartExecutionPreviewCommand_base {
130
146
  /** @internal type navigation helper, not in runtime. */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ssm",
3
3
  "description": "AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native",
4
- "version": "3.698.0",
4
+ "version": "3.699.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-ssm",
@@ -20,10 +20,10 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/client-sso-oidc": "3.696.0",
24
- "@aws-sdk/client-sts": "3.696.0",
23
+ "@aws-sdk/client-sso-oidc": "3.699.0",
24
+ "@aws-sdk/client-sts": "3.699.0",
25
25
  "@aws-sdk/core": "3.696.0",
26
- "@aws-sdk/credential-provider-node": "3.696.0",
26
+ "@aws-sdk/credential-provider-node": "3.699.0",
27
27
  "@aws-sdk/middleware-host-header": "3.696.0",
28
28
  "@aws-sdk/middleware-logger": "3.696.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.696.0",