@aws-sdk/client-ssm 3.696.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.
Files changed (67) hide show
  1. package/README.md +39 -7
  2. package/dist-cjs/index.js +834 -437
  3. package/dist-es/SSM.js +8 -0
  4. package/dist-es/commands/GetExecutionPreviewCommand.js +22 -0
  5. package/dist-es/commands/ListNodesCommand.js +23 -0
  6. package/dist-es/commands/ListNodesSummaryCommand.js +22 -0
  7. package/dist-es/commands/SendCommandCommand.js +1 -1
  8. package/dist-es/commands/StartExecutionPreviewCommand.js +22 -0
  9. package/dist-es/commands/index.js +4 -0
  10. package/dist-es/models/models_1.js +99 -144
  11. package/dist-es/models/models_2.js +167 -1
  12. package/dist-es/pagination/ListNodesPaginator.js +4 -0
  13. package/dist-es/pagination/ListNodesSummaryPaginator.js +4 -0
  14. package/dist-es/pagination/index.js +2 -0
  15. package/dist-es/protocols/Aws_json1_1.js +159 -3
  16. package/dist-types/SSM.d.ts +29 -0
  17. package/dist-types/SSMClient.d.ts +6 -2
  18. package/dist-types/commands/CreateResourceDataSyncCommand.d.ts +1 -1
  19. package/dist-types/commands/DeleteActivationCommand.d.ts +1 -1
  20. package/dist-types/commands/DescribeActivationsCommand.d.ts +1 -1
  21. package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +1 -1
  22. package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +1 -1
  23. package/dist-types/commands/DescribeInstancePropertiesCommand.d.ts +1 -1
  24. package/dist-types/commands/GetExecutionPreviewCommand.d.ts +127 -0
  25. package/dist-types/commands/GetInventoryCommand.d.ts +3 -4
  26. package/dist-types/commands/GetOpsSummaryCommand.d.ts +3 -4
  27. package/dist-types/commands/ListComplianceItemsCommand.d.ts +1 -1
  28. package/dist-types/commands/ListComplianceSummariesCommand.d.ts +1 -1
  29. package/dist-types/commands/ListInventoryEntriesCommand.d.ts +1 -1
  30. package/dist-types/commands/ListNodesCommand.d.ts +175 -0
  31. package/dist-types/commands/ListNodesSummaryCommand.d.ts +166 -0
  32. package/dist-types/commands/ListResourceComplianceSummariesCommand.d.ts +1 -1
  33. package/dist-types/commands/ResetServiceSettingCommand.d.ts +2 -1
  34. package/dist-types/commands/ResumeSessionCommand.d.ts +1 -1
  35. package/dist-types/commands/SendAutomationSignalCommand.d.ts +1 -1
  36. package/dist-types/commands/SendCommandCommand.d.ts +1 -1
  37. package/dist-types/commands/StartAssociationsOnceCommand.d.ts +1 -1
  38. package/dist-types/commands/StartAutomationExecutionCommand.d.ts +1 -1
  39. package/dist-types/commands/StartExecutionPreviewCommand.d.ts +157 -0
  40. package/dist-types/commands/index.d.ts +4 -0
  41. package/dist-types/models/models_0.d.ts +9 -4
  42. package/dist-types/models/models_1.d.ts +955 -989
  43. package/dist-types/models/models_2.d.ts +770 -5
  44. package/dist-types/pagination/ListNodesPaginator.d.ts +7 -0
  45. package/dist-types/pagination/ListNodesSummaryPaginator.d.ts +7 -0
  46. package/dist-types/pagination/index.d.ts +2 -0
  47. package/dist-types/protocols/Aws_json1_1.d.ts +36 -0
  48. package/dist-types/ts3.4/SSM.d.ts +69 -0
  49. package/dist-types/ts3.4/SSMClient.d.ts +24 -0
  50. package/dist-types/ts3.4/commands/GetExecutionPreviewCommand.d.ts +51 -0
  51. package/dist-types/ts3.4/commands/ListNodesCommand.d.ts +47 -0
  52. package/dist-types/ts3.4/commands/ListNodesSummaryCommand.d.ts +48 -0
  53. package/dist-types/ts3.4/commands/ResetServiceSettingCommand.d.ts +2 -4
  54. package/dist-types/ts3.4/commands/ResumeSessionCommand.d.ts +1 -1
  55. package/dist-types/ts3.4/commands/SendAutomationSignalCommand.d.ts +1 -1
  56. package/dist-types/ts3.4/commands/SendCommandCommand.d.ts +1 -1
  57. package/dist-types/ts3.4/commands/StartAssociationsOnceCommand.d.ts +1 -1
  58. package/dist-types/ts3.4/commands/StartAutomationExecutionCommand.d.ts +1 -1
  59. package/dist-types/ts3.4/commands/StartExecutionPreviewCommand.d.ts +51 -0
  60. package/dist-types/ts3.4/commands/index.d.ts +4 -0
  61. package/dist-types/ts3.4/models/models_1.d.ts +176 -170
  62. package/dist-types/ts3.4/models/models_2.d.ts +236 -0
  63. package/dist-types/ts3.4/pagination/ListNodesPaginator.d.ts +11 -0
  64. package/dist-types/ts3.4/pagination/ListNodesSummaryPaginator.d.ts +11 -0
  65. package/dist-types/ts3.4/pagination/index.d.ts +2 -0
  66. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +48 -0
  67. package/package.json +4 -4
@@ -1,7 +1,556 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
- import { AlarmConfiguration, AssociationComplianceSeverity, AssociationDescription, AssociationStatus, AssociationSyncCompliance, AttachmentsSource, DocumentDescription, DocumentFormat, InstanceAssociationOutputLocation, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchFilterGroup, PatchRuleGroup, PatchSource, RelatedOpsItem, ResourceDataSyncSource, Runbook, Tag, Target, TargetLocation } from "./models_0";
3
- import { DocumentReviewCommentSource, InventoryFilter, InventoryGroup, LoggingInfo, MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskInvocationParameters, MaintenanceWindowTaskParameterValueExpression, OpsFilter, OpsItemStatus, OpsResultAttribute, ResultAttribute } from "./models_1";
2
+ import { AlarmConfiguration, AssociationComplianceSeverity, AssociationDescription, AssociationStatus, AssociationSyncCompliance, AttachmentsSource, DocumentDescription, DocumentFormat, DocumentHashType, ExecutionMode, InstanceAssociationOutputLocation, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, PatchAction, PatchComplianceLevel, PatchFilterGroup, PatchRuleGroup, PatchSource, RelatedOpsItem, ResourceDataSyncSource, Runbook, Tag, Target, TargetLocation } from "./models_0";
3
+ import { CloudWatchOutputConfig, Command, DocumentReviewCommentSource, InventoryFilter, InventoryGroup, LoggingInfo, MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskInvocationParameters, MaintenanceWindowTaskParameterValueExpression, NodeAggregatorType, NodeAttributeName, NodeFilter, NodeTypeName, NotificationConfig, OpsFilter, OpsItemStatus, OpsResultAttribute, ResultAttribute, ServiceSetting } from "./models_1";
4
4
  import { SSMServiceException as __BaseException } from "./SSMServiceException";
5
+ /**
6
+ * <p>The result body of the ResetServiceSetting API operation.</p>
7
+ * @public
8
+ */
9
+ export interface ResetServiceSettingResult {
10
+ /**
11
+ * <p>The current, effective service setting after calling the ResetServiceSetting API
12
+ * operation.</p>
13
+ * @public
14
+ */
15
+ ServiceSetting?: ServiceSetting | undefined;
16
+ }
17
+ /**
18
+ * @public
19
+ */
20
+ export interface ResumeSessionRequest {
21
+ /**
22
+ * <p>The ID of the disconnected session to resume.</p>
23
+ * @public
24
+ */
25
+ SessionId: string | undefined;
26
+ }
27
+ /**
28
+ * @public
29
+ */
30
+ export interface ResumeSessionResponse {
31
+ /**
32
+ * <p>The ID of the session.</p>
33
+ * @public
34
+ */
35
+ SessionId?: string | undefined;
36
+ /**
37
+ * <p>An encrypted token value containing session and caller information. Used to authenticate the
38
+ * connection to the managed node.</p>
39
+ * @public
40
+ */
41
+ TokenValue?: string | undefined;
42
+ /**
43
+ * <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
44
+ * receive output from the managed node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p>
45
+ * <p>
46
+ * <b>region</b> represents the Region identifier for an
47
+ * Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
48
+ * For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the
49
+ * <i>Amazon Web Services General Reference</i>.</p>
50
+ * <p>
51
+ * <b>session-id</b> represents the ID of a Session Manager session, such as
52
+ * <code>1a2b3c4dEXAMPLE</code>.</p>
53
+ * @public
54
+ */
55
+ StreamUrl?: string | undefined;
56
+ }
57
+ /**
58
+ * <p>The specified step name and execution ID don't exist. Verify the information and try
59
+ * again.</p>
60
+ * @public
61
+ */
62
+ export declare class AutomationStepNotFoundException extends __BaseException {
63
+ readonly name: "AutomationStepNotFoundException";
64
+ readonly $fault: "client";
65
+ Message?: string | undefined;
66
+ /**
67
+ * @internal
68
+ */
69
+ constructor(opts: __ExceptionOptionType<AutomationStepNotFoundException, __BaseException>);
70
+ }
71
+ /**
72
+ * <p>The signal isn't valid for the current Automation execution.</p>
73
+ * @public
74
+ */
75
+ export declare class InvalidAutomationSignalException extends __BaseException {
76
+ readonly name: "InvalidAutomationSignalException";
77
+ readonly $fault: "client";
78
+ Message?: string | undefined;
79
+ /**
80
+ * @internal
81
+ */
82
+ constructor(opts: __ExceptionOptionType<InvalidAutomationSignalException, __BaseException>);
83
+ }
84
+ /**
85
+ * @public
86
+ * @enum
87
+ */
88
+ export declare const SignalType: {
89
+ readonly APPROVE: "Approve";
90
+ readonly REJECT: "Reject";
91
+ readonly RESUME: "Resume";
92
+ readonly START_STEP: "StartStep";
93
+ readonly STOP_STEP: "StopStep";
94
+ };
95
+ /**
96
+ * @public
97
+ */
98
+ export type SignalType = (typeof SignalType)[keyof typeof SignalType];
99
+ /**
100
+ * @public
101
+ */
102
+ export interface SendAutomationSignalRequest {
103
+ /**
104
+ * <p>The unique identifier for an existing Automation execution that you want to send the signal
105
+ * to.</p>
106
+ * @public
107
+ */
108
+ AutomationExecutionId: string | undefined;
109
+ /**
110
+ * <p>The type of signal to send to an Automation execution. </p>
111
+ * @public
112
+ */
113
+ SignalType: SignalType | undefined;
114
+ /**
115
+ * <p>The data sent with the signal. The data schema depends on the type of signal used in the
116
+ * request.</p>
117
+ * <p>For <code>Approve</code> and <code>Reject</code> signal types, the payload is an optional
118
+ * comment that you can send with the signal type. For example:</p>
119
+ * <p>
120
+ * <code>Comment="Looks good"</code>
121
+ * </p>
122
+ * <p>For <code>StartStep</code> and <code>Resume</code> signal types, you must send the name of
123
+ * the Automation step to start or resume as the payload. For example:</p>
124
+ * <p>
125
+ * <code>StepName="step1"</code>
126
+ * </p>
127
+ * <p>For the <code>StopStep</code> signal type, you must send the step execution ID as the
128
+ * payload. For example:</p>
129
+ * <p>
130
+ * <code>StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"</code>
131
+ * </p>
132
+ * @public
133
+ */
134
+ Payload?: Record<string, string[]> | undefined;
135
+ }
136
+ /**
137
+ * @public
138
+ */
139
+ export interface SendAutomationSignalResult {
140
+ }
141
+ /**
142
+ * <p>One or more configuration items isn't valid. Verify that a valid Amazon Resource Name (ARN)
143
+ * was provided for an Amazon Simple Notification Service topic.</p>
144
+ * @public
145
+ */
146
+ export declare class InvalidNotificationConfig extends __BaseException {
147
+ readonly name: "InvalidNotificationConfig";
148
+ readonly $fault: "client";
149
+ Message?: string | undefined;
150
+ /**
151
+ * @internal
152
+ */
153
+ constructor(opts: __ExceptionOptionType<InvalidNotificationConfig, __BaseException>);
154
+ }
155
+ /**
156
+ * <p>The S3 bucket doesn't exist.</p>
157
+ * @public
158
+ */
159
+ export declare class InvalidOutputFolder extends __BaseException {
160
+ readonly name: "InvalidOutputFolder";
161
+ readonly $fault: "client";
162
+ /**
163
+ * @internal
164
+ */
165
+ constructor(opts: __ExceptionOptionType<InvalidOutputFolder, __BaseException>);
166
+ }
167
+ /**
168
+ * <p>The role name can't contain invalid characters. Also verify that you specified an IAM role for notifications that includes the required trust policy. For information about
169
+ * configuring the IAM role for Run Command notifications, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in
170
+ * the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
171
+ * @public
172
+ */
173
+ export declare class InvalidRole extends __BaseException {
174
+ readonly name: "InvalidRole";
175
+ readonly $fault: "client";
176
+ Message?: string | undefined;
177
+ /**
178
+ * @internal
179
+ */
180
+ constructor(opts: __ExceptionOptionType<InvalidRole, __BaseException>);
181
+ }
182
+ /**
183
+ * @public
184
+ */
185
+ export interface SendCommandRequest {
186
+ /**
187
+ * <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is
188
+ * most useful when you are targeting a limited number of managed nodes, though you can specify up
189
+ * to 50 IDs.</p>
190
+ * <p>To target a larger number of managed nodes, or if you prefer not to list individual node
191
+ * IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>,
192
+ * which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a
193
+ * send command to tens, hundreds, or thousands of nodes at once.</p>
194
+ * <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
195
+ * in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
196
+ * @public
197
+ */
198
+ InstanceIds?: string[] | undefined;
199
+ /**
200
+ * <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code>
201
+ * combination that you specify. Specifying targets is most useful when you want to send a command
202
+ * to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag
203
+ * key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands
204
+ * of nodes at once.</p>
205
+ * <p>To send a command to a smaller number of managed nodes, you can use the
206
+ * <code>InstanceIds</code> option instead.</p>
207
+ * <p>For more information about how to use targets, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html">Run commands at scale</a>
208
+ * in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
209
+ * @public
210
+ */
211
+ Targets?: Target[] | undefined;
212
+ /**
213
+ * <p>The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a
214
+ * custom document. To run a shared document belonging to another account, specify the document
215
+ * Amazon Resource Name (ARN). For more information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/ssm-using-shared.html">Sharing SSM
216
+ * documents</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
217
+ * <note>
218
+ * <p>If you specify a document name or ARN that hasn't been shared with your account, you
219
+ * receive an <code>InvalidDocument</code> error. </p>
220
+ * </note>
221
+ * @public
222
+ */
223
+ DocumentName: string | undefined;
224
+ /**
225
+ * <p>The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a
226
+ * specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then
227
+ * you must escape the first two options by using a backslash. If you specify a version number, then
228
+ * you don't need to use the backslash. For example:</p>
229
+ * <p>--document-version "\$DEFAULT"</p>
230
+ * <p>--document-version "\$LATEST"</p>
231
+ * <p>--document-version "3"</p>
232
+ * @public
233
+ */
234
+ DocumentVersion?: string | undefined;
235
+ /**
236
+ * <p>The Sha256 or Sha1 hash created by the system when the document was created. </p>
237
+ * <note>
238
+ * <p>Sha1 hashes have been deprecated.</p>
239
+ * </note>
240
+ * @public
241
+ */
242
+ DocumentHash?: string | undefined;
243
+ /**
244
+ * <p>Sha256 or Sha1.</p>
245
+ * <note>
246
+ * <p>Sha1 hashes have been deprecated.</p>
247
+ * </note>
248
+ * @public
249
+ */
250
+ DocumentHashType?: DocumentHashType | undefined;
251
+ /**
252
+ * <p>If this time is reached and the command hasn't already started running, it won't run.</p>
253
+ * @public
254
+ */
255
+ TimeoutSeconds?: number | undefined;
256
+ /**
257
+ * <p>User-specified information about the command, such as a brief description of what the
258
+ * command should do.</p>
259
+ * @public
260
+ */
261
+ Comment?: string | undefined;
262
+ /**
263
+ * <p>The required and optional parameters specified in the document being run.</p>
264
+ * @public
265
+ */
266
+ Parameters?: Record<string, string[]> | undefined;
267
+ /**
268
+ * <p>(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager
269
+ * automatically determines the Amazon Web Services Region of the S3 bucket.</p>
270
+ * @public
271
+ */
272
+ OutputS3Region?: string | undefined;
273
+ /**
274
+ * <p>The name of the S3 bucket where command execution responses should be stored.</p>
275
+ * @public
276
+ */
277
+ OutputS3BucketName?: string | undefined;
278
+ /**
279
+ * <p>The directory structure within the S3 bucket where the responses should be stored.</p>
280
+ * @public
281
+ */
282
+ OutputS3KeyPrefix?: string | undefined;
283
+ /**
284
+ * <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the
285
+ * same time. You can specify a number such as 10 or a percentage such as 10%. The default value is
286
+ * <code>50</code>. For more information about how to use <code>MaxConcurrency</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-velocity">Using
287
+ * concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
288
+ * @public
289
+ */
290
+ MaxConcurrency?: string | undefined;
291
+ /**
292
+ * <p>The maximum number of errors allowed without the command failing. When the command fails one
293
+ * more time beyond the value of <code>MaxErrors</code>, the systems stops sending the command to
294
+ * additional targets. You can specify a number like 10 or a percentage like 10%. The default value
295
+ * is <code>0</code>. For more information about how to use <code>MaxErrors</code>, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/send-commands-multiple.html#send-commands-maxerrors">Using
296
+ * error controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
297
+ * @public
298
+ */
299
+ MaxErrors?: string | undefined;
300
+ /**
301
+ * <p>The ARN of the Identity and Access Management (IAM) service role to use to publish
302
+ * Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.</p>
303
+ * <p>This role must provide the <code>sns:Publish</code> permission for your notification topic.
304
+ * For information about creating and using this service role, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitoring-sns-notifications.html">Monitoring Systems Manager status changes using Amazon SNS notifications</a> in the
305
+ * <i>Amazon Web Services Systems Manager User Guide</i>.</p>
306
+ * @public
307
+ */
308
+ ServiceRoleArn?: string | undefined;
309
+ /**
310
+ * <p>Configurations for sending notifications.</p>
311
+ * @public
312
+ */
313
+ NotificationConfig?: NotificationConfig | undefined;
314
+ /**
315
+ * <p>Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a
316
+ * capability of Amazon Web Services Systems Manager.</p>
317
+ * @public
318
+ */
319
+ CloudWatchOutputConfig?: CloudWatchOutputConfig | undefined;
320
+ /**
321
+ * <p>The CloudWatch alarm you want to apply to your command.</p>
322
+ * @public
323
+ */
324
+ AlarmConfiguration?: AlarmConfiguration | undefined;
325
+ }
326
+ /**
327
+ * @public
328
+ */
329
+ export interface SendCommandResult {
330
+ /**
331
+ * <p>The request as it was received by Systems Manager. Also provides the command ID which can be used
332
+ * future references to this request.</p>
333
+ * @public
334
+ */
335
+ Command?: Command | undefined;
336
+ }
337
+ /**
338
+ * <p>The association isn't valid or doesn't exist. </p>
339
+ * @public
340
+ */
341
+ export declare class InvalidAssociation extends __BaseException {
342
+ readonly name: "InvalidAssociation";
343
+ readonly $fault: "client";
344
+ Message?: string | undefined;
345
+ /**
346
+ * @internal
347
+ */
348
+ constructor(opts: __ExceptionOptionType<InvalidAssociation, __BaseException>);
349
+ }
350
+ /**
351
+ * @public
352
+ */
353
+ export interface StartAssociationsOnceRequest {
354
+ /**
355
+ * <p>The association IDs that you want to run immediately and only one time.</p>
356
+ * @public
357
+ */
358
+ AssociationIds: string[] | undefined;
359
+ }
360
+ /**
361
+ * @public
362
+ */
363
+ export interface StartAssociationsOnceResult {
364
+ }
365
+ /**
366
+ * <p>An Automation runbook with the specified name couldn't be found.</p>
367
+ * @public
368
+ */
369
+ export declare class AutomationDefinitionNotFoundException extends __BaseException {
370
+ readonly name: "AutomationDefinitionNotFoundException";
371
+ readonly $fault: "client";
372
+ Message?: string | undefined;
373
+ /**
374
+ * @internal
375
+ */
376
+ constructor(opts: __ExceptionOptionType<AutomationDefinitionNotFoundException, __BaseException>);
377
+ }
378
+ /**
379
+ * <p>An Automation runbook with the specified name and version couldn't be found.</p>
380
+ * @public
381
+ */
382
+ export declare class AutomationDefinitionVersionNotFoundException extends __BaseException {
383
+ readonly name: "AutomationDefinitionVersionNotFoundException";
384
+ readonly $fault: "client";
385
+ Message?: string | undefined;
386
+ /**
387
+ * @internal
388
+ */
389
+ constructor(opts: __ExceptionOptionType<AutomationDefinitionVersionNotFoundException, __BaseException>);
390
+ }
391
+ /**
392
+ * <p>The number of simultaneously running Automation executions exceeded the allowable
393
+ * limit.</p>
394
+ * @public
395
+ */
396
+ export declare class AutomationExecutionLimitExceededException extends __BaseException {
397
+ readonly name: "AutomationExecutionLimitExceededException";
398
+ readonly $fault: "client";
399
+ Message?: string | undefined;
400
+ /**
401
+ * @internal
402
+ */
403
+ constructor(opts: __ExceptionOptionType<AutomationExecutionLimitExceededException, __BaseException>);
404
+ }
405
+ /**
406
+ * <p>The supplied parameters for invoking the specified Automation runbook are incorrect. For
407
+ * example, they may not match the set of parameters permitted for the specified Automation
408
+ * document.</p>
409
+ * @public
410
+ */
411
+ export declare class InvalidAutomationExecutionParametersException extends __BaseException {
412
+ readonly name: "InvalidAutomationExecutionParametersException";
413
+ readonly $fault: "client";
414
+ Message?: string | undefined;
415
+ /**
416
+ * @internal
417
+ */
418
+ constructor(opts: __ExceptionOptionType<InvalidAutomationExecutionParametersException, __BaseException>);
419
+ }
420
+ /**
421
+ * @public
422
+ */
423
+ export interface StartAutomationExecutionRequest {
424
+ /**
425
+ * <p>The name of the SSM document to run. This can be a public document or a custom document. To
426
+ * run a shared document belonging to another account, specify the document ARN. For more
427
+ * information about how to use shared documents, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/documents-ssm-sharing.html">Sharing SSM documents</a>
428
+ * in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
429
+ * @public
430
+ */
431
+ DocumentName: string | undefined;
432
+ /**
433
+ * <p>The version of the Automation runbook to use for this execution.</p>
434
+ * @public
435
+ */
436
+ DocumentVersion?: string | undefined;
437
+ /**
438
+ * <p>A key-value map of execution parameters, which match the declared parameters in the
439
+ * Automation runbook.</p>
440
+ * @public
441
+ */
442
+ Parameters?: Record<string, string[]> | undefined;
443
+ /**
444
+ * <p>User-provided idempotency token. The token must be unique, is case insensitive, enforces the
445
+ * UUID format, and can't be reused.</p>
446
+ * @public
447
+ */
448
+ ClientToken?: string | undefined;
449
+ /**
450
+ * <p>The execution mode of the automation. Valid modes include the following: Auto and
451
+ * Interactive. The default mode is Auto.</p>
452
+ * @public
453
+ */
454
+ Mode?: ExecutionMode | undefined;
455
+ /**
456
+ * <p>The name of the parameter used as the target resource for the rate-controlled execution.
457
+ * Required if you specify targets.</p>
458
+ * @public
459
+ */
460
+ TargetParameterName?: string | undefined;
461
+ /**
462
+ * <p>A key-value mapping to target resources. Required if you specify TargetParameterName.</p>
463
+ * <p>If both this parameter and the <code>TargetLocation:Targets</code> parameter are supplied,
464
+ * <code>TargetLocation:Targets</code> takes precedence.</p>
465
+ * @public
466
+ */
467
+ Targets?: Target[] | undefined;
468
+ /**
469
+ * <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
470
+ * can't be specified together.</p>
471
+ * @public
472
+ */
473
+ TargetMaps?: Record<string, string[]>[] | undefined;
474
+ /**
475
+ * <p>The maximum number of targets allowed to run this task in parallel. You can specify a
476
+ * number, such as 10, or a percentage, such as 10%. The default value is <code>10</code>.</p>
477
+ * <p>If both this parameter and the <code>TargetLocation:TargetsMaxConcurrency</code> are
478
+ * supplied, <code>TargetLocation:TargetsMaxConcurrency</code> takes precedence.</p>
479
+ * @public
480
+ */
481
+ MaxConcurrency?: string | undefined;
482
+ /**
483
+ * <p>The number of errors that are allowed before the system stops running the automation on
484
+ * additional targets. You can specify either an absolute number of errors, for example 10, or a
485
+ * percentage of the target set, for example 10%. If you specify 3, for example, the system stops
486
+ * running the automation when the fourth error is received. If you specify 0, then the system stops
487
+ * running the automation on additional targets after the first error result is returned. If you run
488
+ * an automation on 50 resources and set max-errors to 10%, then the system stops running the
489
+ * automation on additional targets when the sixth error is received.</p>
490
+ * <p>Executions that are already running an automation when max-errors is reached are allowed to
491
+ * complete, but some of these executions may fail as well. If you need to ensure that there won't
492
+ * be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one
493
+ * at a time.</p>
494
+ * <p>If this parameter and the <code>TargetLocation:TargetsMaxErrors</code> parameter are both
495
+ * supplied, <code>TargetLocation:TargetsMaxErrors</code> takes precedence.</p>
496
+ * @public
497
+ */
498
+ MaxErrors?: string | undefined;
499
+ /**
500
+ * <p>A location is a combination of Amazon Web Services Regions and/or Amazon Web Services accounts where you want to run the
501
+ * automation. Use this operation to start an automation in multiple Amazon Web Services Regions and multiple
502
+ * Amazon Web Services accounts. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-automation-multiple-accounts-and-regions.html">Running automations in multiple Amazon Web Services Regions and accounts</a> in the
503
+ * <i>Amazon Web Services Systems Manager User Guide</i>. </p>
504
+ * @public
505
+ */
506
+ TargetLocations?: TargetLocation[] | undefined;
507
+ /**
508
+ * <p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for
509
+ * an automation. Tags enable you to categorize a resource in different ways, such as by purpose,
510
+ * owner, or environment. For example, you might want to tag an automation to identify an
511
+ * environment or operating system. In this case, you could specify the following key-value
512
+ * pairs:</p>
513
+ * <ul>
514
+ * <li>
515
+ * <p>
516
+ * <code>Key=environment,Value=test</code>
517
+ * </p>
518
+ * </li>
519
+ * <li>
520
+ * <p>
521
+ * <code>Key=OS,Value=Windows</code>
522
+ * </p>
523
+ * </li>
524
+ * </ul>
525
+ * <note>
526
+ * <p>To add tags to an existing automation, use the <a>AddTagsToResource</a>
527
+ * operation.</p>
528
+ * </note>
529
+ * @public
530
+ */
531
+ Tags?: Tag[] | undefined;
532
+ /**
533
+ * <p>The CloudWatch alarm you want to apply to your automation.</p>
534
+ * @public
535
+ */
536
+ AlarmConfiguration?: AlarmConfiguration | undefined;
537
+ /**
538
+ * <p>Specify a publicly accessible URL for a file that contains the <code>TargetLocations</code>
539
+ * body. Currently, only files in presigned Amazon S3 buckets are supported. </p>
540
+ * @public
541
+ */
542
+ TargetLocationsURL?: string | undefined;
543
+ }
544
+ /**
545
+ * @public
546
+ */
547
+ export interface StartAutomationExecutionResult {
548
+ /**
549
+ * <p>The unique ID of a newly scheduled automation execution.</p>
550
+ * @public
551
+ */
552
+ AutomationExecutionId?: string | undefined;
553
+ }
5
554
  /**
6
555
  * <p>Indicates that the Change Manager change template used in the change request was rejected or is
7
556
  * still in a pending state.</p>
@@ -126,6 +675,132 @@ export interface StartChangeRequestExecutionResult {
126
675
  */
127
676
  AutomationExecutionId?: string | undefined;
128
677
  }
678
+ /**
679
+ * <p>Information about the optional inputs that can be specified for an automation execution
680
+ * preview.</p>
681
+ * @public
682
+ */
683
+ export interface AutomationExecutionInputs {
684
+ /**
685
+ * <p>Information about parameters that can be specified for the preview operation.
686
+ * </p>
687
+ * @public
688
+ */
689
+ Parameters?: Record<string, string[]> | undefined;
690
+ /**
691
+ * <p>The name of the parameter used as the target resource for the rate-controlled execution.
692
+ * Required if you specify targets.</p>
693
+ * @public
694
+ */
695
+ TargetParameterName?: string | undefined;
696
+ /**
697
+ * <p>Information about the resources that would be included in the actual runbook execution, if
698
+ * it were to be run. Both Targets and TargetMaps can't be specified together.</p>
699
+ * @public
700
+ */
701
+ Targets?: Target[] | undefined;
702
+ /**
703
+ * <p>A key-value mapping of document parameters to target resources. Both Targets and TargetMaps
704
+ * can't be specified together.</p>
705
+ * @public
706
+ */
707
+ TargetMaps?: Record<string, string[]>[] | undefined;
708
+ /**
709
+ * <p>Information about the Amazon Web Services Regions and Amazon Web Services accounts targeted by the Automation execution
710
+ * preview operation.</p>
711
+ * @public
712
+ */
713
+ TargetLocations?: TargetLocation[] | undefined;
714
+ /**
715
+ * <p>A publicly accessible URL for a file that contains the <code>TargetLocations</code> body.
716
+ * Currently, only files in presigned Amazon S3 buckets are supported.</p>
717
+ * @public
718
+ */
719
+ TargetLocationsURL?: string | undefined;
720
+ }
721
+ /**
722
+ * <p>Information about the inputs for an execution preview.</p>
723
+ * @public
724
+ */
725
+ export type ExecutionInputs = ExecutionInputs.AutomationMember | ExecutionInputs.$UnknownMember;
726
+ /**
727
+ * @public
728
+ */
729
+ export declare namespace ExecutionInputs {
730
+ /**
731
+ * <p>Information about the optional inputs that can be specified for an automation execution
732
+ * preview.</p>
733
+ * @public
734
+ */
735
+ interface AutomationMember {
736
+ Automation: AutomationExecutionInputs;
737
+ $unknown?: never;
738
+ }
739
+ /**
740
+ * @public
741
+ */
742
+ interface $UnknownMember {
743
+ Automation?: never;
744
+ $unknown: [string, any];
745
+ }
746
+ interface Visitor<T> {
747
+ Automation: (value: AutomationExecutionInputs) => T;
748
+ _: (name: string, value: any) => T;
749
+ }
750
+ const visit: <T>(value: ExecutionInputs, visitor: Visitor<T>) => T;
751
+ }
752
+ /**
753
+ * @public
754
+ */
755
+ export interface StartExecutionPreviewRequest {
756
+ /**
757
+ * <p>The name of the Automation runbook to run. The result of the execution preview indicates
758
+ * what the impact would be of running this runbook.</p>
759
+ * @public
760
+ */
761
+ DocumentName: string | undefined;
762
+ /**
763
+ * <p>The version of the Automation runbook to run. The default value is
764
+ * <code>$DEFAULT</code>.</p>
765
+ * @public
766
+ */
767
+ DocumentVersion?: string | undefined;
768
+ /**
769
+ * <p>Information about the inputs that can be specified for the preview operation.
770
+ * </p>
771
+ * @public
772
+ */
773
+ ExecutionInputs?: ExecutionInputs | undefined;
774
+ }
775
+ /**
776
+ * @public
777
+ */
778
+ export interface StartExecutionPreviewResponse {
779
+ /**
780
+ * <p>The ID of the execution preview generated by the system.</p>
781
+ * @public
782
+ */
783
+ ExecutionPreviewId?: string | undefined;
784
+ }
785
+ /**
786
+ * <p>The request isn't valid. Verify that you entered valid contents for the command and try
787
+ * again.</p>
788
+ * @public
789
+ */
790
+ export declare class ValidationException extends __BaseException {
791
+ readonly name: "ValidationException";
792
+ readonly $fault: "client";
793
+ Message?: string | undefined;
794
+ /**
795
+ * <p>The reason code for the invalid request.</p>
796
+ * @public
797
+ */
798
+ ReasonCode?: string | undefined;
799
+ /**
800
+ * @internal
801
+ */
802
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
803
+ }
129
804
  /**
130
805
  * @public
131
806
  */
@@ -1538,6 +2213,10 @@ export interface UpdatePatchBaselineRequest {
1538
2213
  Name?: string | undefined;
1539
2214
  /**
1540
2215
  * <p>A set of global filters used to include patches in the baseline.</p>
2216
+ * <important>
2217
+ * <p>The <code>GlobalFilters</code> parameter can be configured only by using the CLI or an Amazon Web Services SDK. It can't be configured from the Patch Manager
2218
+ * console, and its value isn't displayed in the console.</p>
2219
+ * </important>
1541
2220
  * @public
1542
2221
  */
1543
2222
  GlobalFilters?: PatchFilterGroup | undefined;
@@ -1757,7 +2436,7 @@ export interface UpdateServiceSettingRequest {
1757
2436
  * <ul>
1758
2437
  * <li>
1759
2438
  * <p>
1760
- * <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
2439
+ * <code>/ssm/appmanager/appmanager-enabled</code>
1761
2440
  * </p>
1762
2441
  * </li>
1763
2442
  * <li>
@@ -1771,6 +2450,9 @@ export interface UpdateServiceSettingRequest {
1771
2450
  * </p>
1772
2451
  * </li>
1773
2452
  * <li>
2453
+ * <p>/ssm/automation/enable-adaptive-concurrency</p>
2454
+ * </li>
2455
+ * <li>
1774
2456
  * <p>
1775
2457
  * <code>/ssm/documents/console/public-sharing-permission</code>
1776
2458
  * </p>
@@ -1782,6 +2464,11 @@ export interface UpdateServiceSettingRequest {
1782
2464
  * </li>
1783
2465
  * <li>
1784
2466
  * <p>
2467
+ * <code>/ssm/managed-instance/default-ec2-instance-management-role</code>
2468
+ * </p>
2469
+ * </li>
2470
+ * <li>
2471
+ * <p>
1785
2472
  * <code>/ssm/opsinsights/opscenter</code>
1786
2473
  * </p>
1787
2474
  * </li>
@@ -1810,8 +2497,8 @@ export interface UpdateServiceSettingRequest {
1810
2497
  * values for each setting.</p>
1811
2498
  * <ul>
1812
2499
  * <li>
1813
- * <p>For <code>/ssm/managed-instance/default-ec2-instance-management-role</code>, enter the
1814
- * name of an IAM role. </p>
2500
+ * <p>For <code>/ssm/appmanager/appmanager-enabled</code>, enter <code>True</code> or
2501
+ * <code>False</code>.</p>
1815
2502
  * </li>
1816
2503
  * <li>
1817
2504
  * <p>For <code>/ssm/automation/customer-script-log-destination</code>, enter <code>CloudWatch</code>.</p>
@@ -1829,6 +2516,10 @@ export interface UpdateServiceSettingRequest {
1829
2516
  * <code>advanced</code>.</p>
1830
2517
  * </li>
1831
2518
  * <li>
2519
+ * <p>For <code>/ssm/managed-instance/default-ec2-instance-management-role</code>, enter the
2520
+ * name of an IAM role. </p>
2521
+ * </li>
2522
+ * <li>
1832
2523
  * <p> For <code>/ssm/opsinsights/opscenter</code>, enter <code>Enabled</code> or
1833
2524
  * <code>Disabled</code>. </p>
1834
2525
  * </li>
@@ -1874,6 +2565,35 @@ export interface InventoryAggregator {
1874
2565
  */
1875
2566
  Groups?: InventoryGroup[] | undefined;
1876
2567
  }
2568
+ /**
2569
+ * <p>One or more aggregators for viewing counts of nodes using different
2570
+ * dimensions.</p>
2571
+ * @public
2572
+ */
2573
+ export interface NodeAggregator {
2574
+ /**
2575
+ * <p>The aggregator type for limiting a node summary. Currently, only <code>Count</code> is
2576
+ * supported.</p>
2577
+ * @public
2578
+ */
2579
+ AggregatorType: NodeAggregatorType | undefined;
2580
+ /**
2581
+ * <p>The data type name to use for viewing counts of nodes. Currently, only <code>Instance</code>
2582
+ * is supported.</p>
2583
+ * @public
2584
+ */
2585
+ TypeName: NodeTypeName | undefined;
2586
+ /**
2587
+ * <p>The name of a node attribute on which to limit the count of nodes.</p>
2588
+ * @public
2589
+ */
2590
+ AttributeName: NodeAttributeName | undefined;
2591
+ /**
2592
+ * <p>Information about aggregators used to refine a node summary.</p>
2593
+ * @public
2594
+ */
2595
+ Aggregators?: NodeAggregator[] | undefined;
2596
+ }
1877
2597
  /**
1878
2598
  * <p>One or more aggregators for viewing counts of OpsData using different dimensions such as
1879
2599
  * <code>Source</code>, <code>CreatedTime</code>, or <code>Source and CreatedTime</code>, to name a
@@ -1984,6 +2704,51 @@ export interface GetOpsSummaryRequest {
1984
2704
  */
1985
2705
  MaxResults?: number | undefined;
1986
2706
  }
2707
+ /**
2708
+ * @public
2709
+ */
2710
+ export interface ListNodesSummaryRequest {
2711
+ /**
2712
+ * <p>The name of the resource data sync to retrieve information about. Required for
2713
+ * cross-account/cross-Region configuration. Optional for single account/single-Region
2714
+ * configurations.</p>
2715
+ * @public
2716
+ */
2717
+ SyncName?: string | undefined;
2718
+ /**
2719
+ * <p>One or more filters. Use a filter to generate a summary that matches your specified filter
2720
+ * criteria.</p>
2721
+ * @public
2722
+ */
2723
+ Filters?: NodeFilter[] | undefined;
2724
+ /**
2725
+ * <p>Specify one or more aggregators to return a count of managed nodes that match that
2726
+ * expression. For example, a count of managed nodes by operating system.</p>
2727
+ * @public
2728
+ */
2729
+ Aggregators: NodeAggregator[] | undefined;
2730
+ /**
2731
+ * <p>The token for the next set of items to return. (You received this token from a previous
2732
+ * call.) The call also returns a token that you can specify in a subsequent call to get the next
2733
+ * set of results.</p>
2734
+ * @public
2735
+ */
2736
+ NextToken?: string | undefined;
2737
+ /**
2738
+ * <p>The maximum number of items to return for this call. The call also returns a token that you
2739
+ * can specify in a subsequent call to get the next set of results.</p>
2740
+ * @public
2741
+ */
2742
+ MaxResults?: number | undefined;
2743
+ }
2744
+ /**
2745
+ * @internal
2746
+ */
2747
+ export declare const SendCommandRequestFilterSensitiveLog: (obj: SendCommandRequest) => any;
2748
+ /**
2749
+ * @internal
2750
+ */
2751
+ export declare const SendCommandResultFilterSensitiveLog: (obj: SendCommandResult) => any;
1987
2752
  /**
1988
2753
  * @internal
1989
2754
  */