@aws-sdk/client-ssm 3.42.0 → 3.46.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.
- package/CHANGELOG.md +50 -0
- package/README.md +12 -6
- package/dist-cjs/commands/UpdateDocumentMetadataCommand.js +2 -1
- package/dist-cjs/commands/UpdateMaintenanceWindowCommand.js +1 -2
- package/dist-cjs/endpoints.js +1 -0
- package/dist-cjs/models/models_0.js +42 -24
- package/dist-cjs/models/models_1.js +35 -19
- package/dist-cjs/models/models_2.js +14 -1
- package/dist-cjs/protocols/Aws_json1_1.js +30 -0
- package/dist-cjs/runtimeConfig.js +0 -2
- package/dist-es/commands/UpdateDocumentMetadataCommand.js +2 -1
- package/dist-es/commands/UpdateMaintenanceWindowCommand.js +1 -2
- package/dist-es/endpoints.js +1 -0
- package/dist-es/models/models_0.js +31 -22
- package/dist-es/models/models_1.js +28 -20
- package/dist-es/models/models_2.js +8 -0
- package/dist-es/protocols/Aws_json1_1.js +39 -13
- package/dist-es/runtimeConfig.js +0 -2
- package/dist-types/SSM.d.ts +87 -81
- package/dist-types/SSMClient.d.ts +12 -6
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +5 -5
- package/dist-types/commands/CreateActivationCommand.d.ts +6 -6
- package/dist-types/commands/CreateAssociationBatchCommand.d.ts +6 -6
- package/dist-types/commands/CreateAssociationCommand.d.ts +10 -10
- package/dist-types/commands/CreateDocumentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteActivationCommand.d.ts +2 -3
- package/dist-types/commands/DeleteAssociationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDocumentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourceDataSyncCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterManagedInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActivationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEffectiveInstanceAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceAssociationsStatusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceInformationCommand.d.ts +7 -6
- package/dist-types/commands/DescribeInstancePatchStatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeMaintenanceWindowsForTargetCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandInvocationCommand.d.ts +2 -2
- package/dist-types/commands/GetConnectionStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +2 -2
- package/dist-types/commands/GetInventoryCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListCommandInvocationsCommand.d.ts +4 -4
- package/dist-types/commands/PutComplianceItemsCommand.d.ts +1 -1
- package/dist-types/commands/PutInventoryCommand.d.ts +1 -1
- package/dist-types/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/commands/StartSessionCommand.d.ts +1 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateMaintenanceWindowCommand.d.ts +1 -2
- package/dist-types/commands/UpdateManagedInstanceRoleCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +232 -266
- package/dist-types/models/models_1.d.ts +257 -278
- package/dist-types/models/models_2.d.ts +100 -13
- package/dist-types/ts3.4/commands/UpdateDocumentMetadataCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateMaintenanceWindowCommand.d.ts +1 -2
- package/dist-types/ts3.4/models/models_0.d.ts +33 -44
- package/dist-types/ts3.4/models/models_1.d.ts +35 -39
- package/dist-types/ts3.4/models/models_2.d.ts +38 -0
- package/package.json +37 -44
|
@@ -1,5 +1,69 @@
|
|
|
1
1
|
import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
|
|
2
|
-
import { AssociationComplianceSeverity, AssociationDescription, AssociationOverview, AssociationStatus, AssociationSyncCompliance, AttachmentsSource, AutomationExecutionStatus, AutomationSubtype, DocumentDescription, DocumentFormat, DocumentHashType, DocumentPermissionType, DocumentRequires, DocumentStatus, DocumentType, ExecutionMode, InstanceAssociationOutputLocation, LoggingInfo, MaintenanceWindowExecutionStatus, MaintenanceWindowResourceType, MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskParameterValueExpression, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, OpsItemStatus, ParameterInlinePolicy,
|
|
2
|
+
import { AssociationComplianceSeverity, AssociationDescription, AssociationOverview, AssociationStatus, AssociationSyncCompliance, AttachmentsSource, AutomationExecutionStatus, AutomationSubtype, DocumentDescription, DocumentFormat, DocumentHashType, DocumentPermissionType, DocumentRequires, DocumentStatus, DocumentType, ExecutionMode, InstanceAssociationOutputLocation, LoggingInfo, MaintenanceWindowExecutionStatus, MaintenanceWindowResourceType, MaintenanceWindowTaskCutoffBehavior, MaintenanceWindowTaskParameterValueExpression, MaintenanceWindowTaskType, MetadataValue, OperatingSystem, OpsItemDataValue, OpsItemNotification, OpsItemStatus, ParameterInlinePolicy, ParameterStringFilter, ParameterTier, PatchAction, PatchComplianceLevel, PatchFilterGroup, PatchOrchestratorFilter, PatchRuleGroup, PatchSource, PlatformType, RelatedOpsItem, ResolvedTargets, ResourceDataSyncAwsOrganizationsSource, ResourceDataSyncS3Destination, ResourceTypeForTagging, ReviewStatus, Runbook, StepExecution, Tag, Target, TargetLocation } from "./models_0";
|
|
3
|
+
export declare enum ParameterType {
|
|
4
|
+
SECURE_STRING = "SecureString",
|
|
5
|
+
STRING = "String",
|
|
6
|
+
STRING_LIST = "StringList"
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* <p>Metadata includes information like the ARN of the last user and the date/time the parameter
|
|
10
|
+
* was last used.</p>
|
|
11
|
+
*/
|
|
12
|
+
export interface ParameterMetadata {
|
|
13
|
+
/**
|
|
14
|
+
* <p>The parameter name.</p>
|
|
15
|
+
*/
|
|
16
|
+
Name?: string;
|
|
17
|
+
/**
|
|
18
|
+
* <p>The type of parameter. Valid parameter types include the following: <code>String</code>,
|
|
19
|
+
* <code>StringList</code>, and <code>SecureString</code>.</p>
|
|
20
|
+
*/
|
|
21
|
+
Type?: ParameterType | string;
|
|
22
|
+
/**
|
|
23
|
+
* <p>The ID of the query key used for this parameter.</p>
|
|
24
|
+
*/
|
|
25
|
+
KeyId?: string;
|
|
26
|
+
/**
|
|
27
|
+
* <p>Date the parameter was last changed or updated.</p>
|
|
28
|
+
*/
|
|
29
|
+
LastModifiedDate?: Date;
|
|
30
|
+
/**
|
|
31
|
+
* <p>Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.</p>
|
|
32
|
+
*/
|
|
33
|
+
LastModifiedUser?: string;
|
|
34
|
+
/**
|
|
35
|
+
* <p>Description of the parameter actions.</p>
|
|
36
|
+
*/
|
|
37
|
+
Description?: string;
|
|
38
|
+
/**
|
|
39
|
+
* <p>A parameter name can include only the following letters and symbols.</p>
|
|
40
|
+
* <p>a-zA-Z0-9_.-</p>
|
|
41
|
+
*/
|
|
42
|
+
AllowedPattern?: string;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The parameter version.</p>
|
|
45
|
+
*/
|
|
46
|
+
Version?: number;
|
|
47
|
+
/**
|
|
48
|
+
* <p>The parameter tier.</p>
|
|
49
|
+
*/
|
|
50
|
+
Tier?: ParameterTier | string;
|
|
51
|
+
/**
|
|
52
|
+
* <p>A list of policies associated with a parameter.</p>
|
|
53
|
+
*/
|
|
54
|
+
Policies?: ParameterInlinePolicy[];
|
|
55
|
+
/**
|
|
56
|
+
* <p>The data type of the parameter, such as <code>text</code> or <code>aws:ec2:image</code>. The
|
|
57
|
+
* default is <code>text</code>.</p>
|
|
58
|
+
*/
|
|
59
|
+
DataType?: string;
|
|
60
|
+
}
|
|
61
|
+
export declare namespace ParameterMetadata {
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
const filterSensitiveLog: (obj: ParameterMetadata) => any;
|
|
66
|
+
}
|
|
3
67
|
export interface DescribeParametersResult {
|
|
4
68
|
/**
|
|
5
69
|
* <p>Parameters returned by the request.</p>
|
|
@@ -240,25 +304,26 @@ export declare namespace DescribePatchGroupStateRequest {
|
|
|
240
304
|
}
|
|
241
305
|
export interface DescribePatchGroupStateResult {
|
|
242
306
|
/**
|
|
243
|
-
* <p>The number of
|
|
307
|
+
* <p>The number of managed nodes in the patch group.</p>
|
|
244
308
|
*/
|
|
245
309
|
Instances?: number;
|
|
246
310
|
/**
|
|
247
|
-
* <p>The number of
|
|
311
|
+
* <p>The number of managed nodes with installed patches.</p>
|
|
248
312
|
*/
|
|
249
313
|
InstancesWithInstalledPatches?: number;
|
|
250
314
|
/**
|
|
251
|
-
* <p>The number of
|
|
315
|
+
* <p>The number of managed nodes with patches installed that aren't defined in the patch
|
|
252
316
|
* baseline.</p>
|
|
253
317
|
*/
|
|
254
318
|
InstancesWithInstalledOtherPatches?: number;
|
|
255
319
|
/**
|
|
256
|
-
* <p>The number of
|
|
257
|
-
* after the patch installation. The status of these
|
|
320
|
+
* <p>The number of managed nodes with patches installed by Patch Manager that haven't been
|
|
321
|
+
* rebooted after the patch installation. The status of these managed nodes is
|
|
322
|
+
* <code>NON_COMPLIANT</code>.</p>
|
|
258
323
|
*/
|
|
259
324
|
InstancesWithInstalledPendingRebootPatches?: number;
|
|
260
325
|
/**
|
|
261
|
-
* <p>The number of
|
|
326
|
+
* <p>The number of managed nodes with patches installed that are specified in a
|
|
262
327
|
* <code>RejectedPatches</code> list. Patches with a status of <code>INSTALLED_REJECTED</code> were
|
|
263
328
|
* typically installed before they were added to a <code>RejectedPatches</code> list.</p>
|
|
264
329
|
* <note>
|
|
@@ -269,40 +334,41 @@ export interface DescribePatchGroupStateResult {
|
|
|
269
334
|
*/
|
|
270
335
|
InstancesWithInstalledRejectedPatches?: number;
|
|
271
336
|
/**
|
|
272
|
-
* <p>The number of
|
|
337
|
+
* <p>The number of managed nodes with missing patches from the patch baseline.</p>
|
|
273
338
|
*/
|
|
274
339
|
InstancesWithMissingPatches?: number;
|
|
275
340
|
/**
|
|
276
|
-
* <p>The number of
|
|
341
|
+
* <p>The number of managed nodes with patches from the patch baseline that failed to
|
|
342
|
+
* install.</p>
|
|
277
343
|
*/
|
|
278
344
|
InstancesWithFailedPatches?: number;
|
|
279
345
|
/**
|
|
280
|
-
* <p>The number of
|
|
346
|
+
* <p>The number of managed nodes with patches that aren't applicable.</p>
|
|
281
347
|
*/
|
|
282
348
|
InstancesWithNotApplicablePatches?: number;
|
|
283
349
|
/**
|
|
284
|
-
* <p>The number of
|
|
285
|
-
* which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>
|
|
350
|
+
* <p>The number of managed nodes with <code>NotApplicable</code> patches beyond the supported
|
|
351
|
+
* limit, which aren't reported by name to Inventory. Inventory is a capability of Amazon Web Services Systems Manager.</p>
|
|
286
352
|
*/
|
|
287
353
|
InstancesWithUnreportedNotApplicablePatches?: number;
|
|
288
354
|
/**
|
|
289
|
-
* <p>The number of
|
|
355
|
+
* <p>The number of managed nodes where patches that are specified as <code>Critical</code> for
|
|
290
356
|
* compliance reporting in the patch baseline aren't installed. These patches might be missing, have
|
|
291
|
-
* failed installation, were rejected, or were installed but awaiting a required
|
|
292
|
-
* The status of these
|
|
357
|
+
* failed installation, were rejected, or were installed but awaiting a required managed node reboot.
|
|
358
|
+
* The status of these managed nodes is <code>NON_COMPLIANT</code>.</p>
|
|
293
359
|
*/
|
|
294
360
|
InstancesWithCriticalNonCompliantPatches?: number;
|
|
295
361
|
/**
|
|
296
|
-
* <p>The number of
|
|
297
|
-
* advisory aren't installed. These patches might be missing, have failed installation, were
|
|
298
|
-
* rejected, or were installed but awaiting a required
|
|
299
|
-
*
|
|
362
|
+
* <p>The number of managed nodes where patches that are specified as <code>Security</code> in a
|
|
363
|
+
* patch advisory aren't installed. These patches might be missing, have failed installation, were
|
|
364
|
+
* rejected, or were installed but awaiting a required managed node reboot. The status of these managed
|
|
365
|
+
* nodes is <code>NON_COMPLIANT</code>.</p>
|
|
300
366
|
*/
|
|
301
367
|
InstancesWithSecurityNonCompliantPatches?: number;
|
|
302
368
|
/**
|
|
303
|
-
* <p>The number of
|
|
369
|
+
* <p>The number of managed nodes with patches installed that are specified as other than
|
|
304
370
|
* <code>Critical</code> or <code>Security</code> but aren't compliant with the patch baseline. The
|
|
305
|
-
* status of these
|
|
371
|
+
* status of these managed nodes is <code>NON_COMPLIANT</code>.</p>
|
|
306
372
|
*/
|
|
307
373
|
InstancesWithOtherNonCompliantPatches?: number;
|
|
308
374
|
}
|
|
@@ -401,7 +467,7 @@ export interface SessionFilter {
|
|
|
401
467
|
* 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.</p>
|
|
402
468
|
* </li>
|
|
403
469
|
* <li>
|
|
404
|
-
* <p>Target: Specify
|
|
470
|
+
* <p>Target: Specify a managed node to which session connections have been made.</p>
|
|
405
471
|
* </li>
|
|
406
472
|
* <li>
|
|
407
473
|
* <p>Owner: Specify an Amazon Web Services user account to see a list of sessions started by that
|
|
@@ -502,7 +568,7 @@ export declare enum SessionStatus {
|
|
|
502
568
|
TERMINATING = "Terminating"
|
|
503
569
|
}
|
|
504
570
|
/**
|
|
505
|
-
* <p>Information about a Session Manager connection to
|
|
571
|
+
* <p>Information about a Session Manager connection to a managed node.</p>
|
|
506
572
|
*/
|
|
507
573
|
export interface Session {
|
|
508
574
|
/**
|
|
@@ -510,7 +576,7 @@ export interface Session {
|
|
|
510
576
|
*/
|
|
511
577
|
SessionId?: string;
|
|
512
578
|
/**
|
|
513
|
-
* <p>The
|
|
579
|
+
* <p>The managed node that the Session Manager session connected to.</p>
|
|
514
580
|
*/
|
|
515
581
|
Target?: string;
|
|
516
582
|
/**
|
|
@@ -914,9 +980,8 @@ export interface GetCommandInvocationRequest {
|
|
|
914
980
|
*/
|
|
915
981
|
CommandId: string | undefined;
|
|
916
982
|
/**
|
|
917
|
-
* <p>(Required) The ID of the managed
|
|
918
|
-
*
|
|
919
|
-
* Amazon Web Services Systems Manager.</p>
|
|
983
|
+
* <p>(Required) The ID of the managed node targeted by the command. A <i>managed node</i> can be an
|
|
984
|
+
* Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, and on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.</p>
|
|
920
985
|
*/
|
|
921
986
|
InstanceId: string | undefined;
|
|
922
987
|
/**
|
|
@@ -980,8 +1045,8 @@ export interface GetCommandInvocationResult {
|
|
|
980
1045
|
*/
|
|
981
1046
|
CommandId?: string;
|
|
982
1047
|
/**
|
|
983
|
-
* <p>The ID of the managed
|
|
984
|
-
* instance or
|
|
1048
|
+
* <p>The ID of the managed node targeted by the command. A <i>managed node</i> can be an
|
|
1049
|
+
* Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for Amazon Web Services Systems Manager.</p>
|
|
985
1050
|
*/
|
|
986
1051
|
InstanceId?: string;
|
|
987
1052
|
/**
|
|
@@ -1003,8 +1068,8 @@ export interface GetCommandInvocationResult {
|
|
|
1003
1068
|
PluginName?: string;
|
|
1004
1069
|
/**
|
|
1005
1070
|
* <p>The error level response code for the plugin script. If the response code is
|
|
1006
|
-
* <code>-1</code>, then the command hasn't started running on the
|
|
1007
|
-
* by the
|
|
1071
|
+
* <code>-1</code>, then the command hasn't started running on the managed node, or it wasn't received
|
|
1072
|
+
* by the node.</p>
|
|
1008
1073
|
*/
|
|
1009
1074
|
ResponseCode?: number;
|
|
1010
1075
|
/**
|
|
@@ -1045,33 +1110,33 @@ export interface GetCommandInvocationResult {
|
|
|
1045
1110
|
* <code>StatusDetails</code> can be one of the following values:</p>
|
|
1046
1111
|
* <ul>
|
|
1047
1112
|
* <li>
|
|
1048
|
-
* <p>Pending: The command hasn't been sent to the
|
|
1113
|
+
* <p>Pending: The command hasn't been sent to the managed node.</p>
|
|
1049
1114
|
* </li>
|
|
1050
1115
|
* <li>
|
|
1051
|
-
* <p>In Progress: The command has been sent to the
|
|
1116
|
+
* <p>In Progress: The command has been sent to the managed node but hasn't reached a terminal
|
|
1052
1117
|
* state.</p>
|
|
1053
1118
|
* </li>
|
|
1054
1119
|
* <li>
|
|
1055
1120
|
* <p>Delayed: The system attempted to send the command to the target, but the target wasn't
|
|
1056
|
-
* available. The
|
|
1121
|
+
* available. The managed node might not be available because of network issues, because the node
|
|
1057
1122
|
* was stopped, or for similar reasons. The system will try to send the command again.</p>
|
|
1058
1123
|
* </li>
|
|
1059
1124
|
* <li>
|
|
1060
1125
|
* <p>Success: The command or plugin ran successfully. This is a terminal state.</p>
|
|
1061
1126
|
* </li>
|
|
1062
1127
|
* <li>
|
|
1063
|
-
* <p>Delivery Timed Out: The command wasn't delivered to the
|
|
1128
|
+
* <p>Delivery Timed Out: The command wasn't delivered to the managed node before the delivery
|
|
1064
1129
|
* timeout expired. Delivery timeouts don't count against the parent command's
|
|
1065
1130
|
* <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is
|
|
1066
1131
|
* Success or Incomplete. This is a terminal state.</p>
|
|
1067
1132
|
* </li>
|
|
1068
1133
|
* <li>
|
|
1069
|
-
* <p>Execution Timed Out: The command started to run on the
|
|
1134
|
+
* <p>Execution Timed Out: The command started to run on the managed node, but the execution wasn't
|
|
1070
1135
|
* complete before the timeout expired. Execution timeouts count against the
|
|
1071
1136
|
* <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p>
|
|
1072
1137
|
* </li>
|
|
1073
1138
|
* <li>
|
|
1074
|
-
* <p>Failed: The command wasn't run successfully on the
|
|
1139
|
+
* <p>Failed: The command wasn't run successfully on the managed node. For a plugin, this indicates
|
|
1075
1140
|
* that the result code wasn't zero. For a command invocation, this indicates that the result code
|
|
1076
1141
|
* for one or more plugins wasn't zero. Invocation failures count against the
|
|
1077
1142
|
* <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p>
|
|
@@ -1081,7 +1146,7 @@ export interface GetCommandInvocationResult {
|
|
|
1081
1146
|
* state.</p>
|
|
1082
1147
|
* </li>
|
|
1083
1148
|
* <li>
|
|
1084
|
-
* <p>Undeliverable: The command can't be delivered to the
|
|
1149
|
+
* <p>Undeliverable: The command can't be delivered to the managed node. The node might not
|
|
1085
1150
|
* exist or might not be responding. Undeliverable invocations don't count against the parent
|
|
1086
1151
|
* command's <code>MaxErrors</code> limit and don't contribute to whether the parent command
|
|
1087
1152
|
* status is Success or Incomplete. This is a terminal state.</p>
|
|
@@ -1139,8 +1204,8 @@ export declare namespace InvalidPluginName {
|
|
|
1139
1204
|
const filterSensitiveLog: (obj: InvalidPluginName) => any;
|
|
1140
1205
|
}
|
|
1141
1206
|
/**
|
|
1142
|
-
* <p>The command ID and
|
|
1143
|
-
* command ID and the
|
|
1207
|
+
* <p>The command ID and managed node ID you specified didn't match any invocations. Verify the
|
|
1208
|
+
* command ID and the managed node ID and try again. </p>
|
|
1144
1209
|
*/
|
|
1145
1210
|
export interface InvocationDoesNotExist extends __SmithyException, $MetadataBearer {
|
|
1146
1211
|
name: "InvocationDoesNotExist";
|
|
@@ -1154,7 +1219,7 @@ export declare namespace InvocationDoesNotExist {
|
|
|
1154
1219
|
}
|
|
1155
1220
|
export interface GetConnectionStatusRequest {
|
|
1156
1221
|
/**
|
|
1157
|
-
* <p>The
|
|
1222
|
+
* <p>The managed node ID.</p>
|
|
1158
1223
|
*/
|
|
1159
1224
|
Target: string | undefined;
|
|
1160
1225
|
}
|
|
@@ -1170,11 +1235,11 @@ export declare enum ConnectionStatus {
|
|
|
1170
1235
|
}
|
|
1171
1236
|
export interface GetConnectionStatusResponse {
|
|
1172
1237
|
/**
|
|
1173
|
-
* <p>The ID of the
|
|
1238
|
+
* <p>The ID of the managed node to check connection status. </p>
|
|
1174
1239
|
*/
|
|
1175
1240
|
Target?: string;
|
|
1176
1241
|
/**
|
|
1177
|
-
* <p>The status of the connection to the
|
|
1242
|
+
* <p>The status of the connection to the managed node. For example, 'Connected' or 'Not
|
|
1178
1243
|
* Connected'.</p>
|
|
1179
1244
|
*/
|
|
1180
1245
|
Status?: ConnectionStatus | string;
|
|
@@ -1256,13 +1321,13 @@ export interface BaselineOverride {
|
|
|
1256
1321
|
RejectedPatchesAction?: PatchAction | string;
|
|
1257
1322
|
/**
|
|
1258
1323
|
* <p>Indicates whether the list of approved patches includes non-security updates that should be
|
|
1259
|
-
* applied to the
|
|
1260
|
-
* only.</p>
|
|
1324
|
+
* applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
|
|
1325
|
+
* nodes only.</p>
|
|
1261
1326
|
*/
|
|
1262
1327
|
ApprovedPatchesEnableNonSecurity?: boolean;
|
|
1263
1328
|
/**
|
|
1264
|
-
* <p>Information about the patches to use to update the
|
|
1265
|
-
* systems and source repositories. Applies to Linux
|
|
1329
|
+
* <p>Information about the patches to use to update the managed nodes, including target operating
|
|
1330
|
+
* systems and source repositories. Applies to Linux managed nodes only.</p>
|
|
1266
1331
|
*/
|
|
1267
1332
|
Sources?: PatchSource[];
|
|
1268
1333
|
}
|
|
@@ -1274,7 +1339,7 @@ export declare namespace BaselineOverride {
|
|
|
1274
1339
|
}
|
|
1275
1340
|
export interface GetDeployablePatchSnapshotForInstanceRequest {
|
|
1276
1341
|
/**
|
|
1277
|
-
* <p>The ID of the
|
|
1342
|
+
* <p>The ID of the managed node for which the appropriate patch snapshot should be retrieved.</p>
|
|
1278
1343
|
*/
|
|
1279
1344
|
InstanceId: string | undefined;
|
|
1280
1345
|
/**
|
|
@@ -1294,7 +1359,7 @@ export declare namespace GetDeployablePatchSnapshotForInstanceRequest {
|
|
|
1294
1359
|
}
|
|
1295
1360
|
export interface GetDeployablePatchSnapshotForInstanceResult {
|
|
1296
1361
|
/**
|
|
1297
|
-
* <p>The
|
|
1362
|
+
* <p>The managed node ID.</p>
|
|
1298
1363
|
*/
|
|
1299
1364
|
InstanceId?: string;
|
|
1300
1365
|
/**
|
|
@@ -1308,7 +1373,7 @@ export interface GetDeployablePatchSnapshotForInstanceResult {
|
|
|
1308
1373
|
SnapshotDownloadUrl?: string;
|
|
1309
1374
|
/**
|
|
1310
1375
|
* <p>Returns the specific operating system (for example Windows Server 2012 or Amazon Linux
|
|
1311
|
-
* 2015.09) on the
|
|
1376
|
+
* 2015.09) on the managed node for the specified patch snapshot.</p>
|
|
1312
1377
|
*/
|
|
1313
1378
|
Product?: string;
|
|
1314
1379
|
}
|
|
@@ -1485,7 +1550,7 @@ export interface InventoryFilter {
|
|
|
1485
1550
|
*/
|
|
1486
1551
|
Key: string | undefined;
|
|
1487
1552
|
/**
|
|
1488
|
-
* <p>Inventory filter values. Example: inventory filter where
|
|
1553
|
+
* <p>Inventory filter values. Example: inventory filter where managed node IDs are specified as
|
|
1489
1554
|
* values <code>Key=AWS:InstanceInformation.InstanceId,Values= i-a12b3c4d5e6g,
|
|
1490
1555
|
* i-1a2b3c4d5e6,Type=Equal</code>. </p>
|
|
1491
1556
|
*/
|
|
@@ -1585,8 +1650,8 @@ export declare namespace InventoryResultItem {
|
|
|
1585
1650
|
*/
|
|
1586
1651
|
export interface InventoryResultEntity {
|
|
1587
1652
|
/**
|
|
1588
|
-
* <p>ID of the inventory result entity. For example, for managed
|
|
1589
|
-
* will be the managed
|
|
1653
|
+
* <p>ID of the inventory result entity. For example, for managed node inventory the result
|
|
1654
|
+
* will be the managed node ID. For EC2 instance inventory, the result will be the instance ID.
|
|
1590
1655
|
* </p>
|
|
1591
1656
|
*/
|
|
1592
1657
|
Id?: string;
|
|
@@ -1605,7 +1670,7 @@ export declare namespace InventoryResultEntity {
|
|
|
1605
1670
|
}
|
|
1606
1671
|
export interface GetInventoryResult {
|
|
1607
1672
|
/**
|
|
1608
|
-
* <p>Collection of inventory entities such as a collection of
|
|
1673
|
+
* <p>Collection of inventory entities such as a collection of managed node inventory. </p>
|
|
1609
1674
|
*/
|
|
1610
1675
|
Entities?: InventoryResultEntity[];
|
|
1611
1676
|
/**
|
|
@@ -2214,8 +2279,8 @@ export interface NotificationConfig {
|
|
|
2214
2279
|
* </li>
|
|
2215
2280
|
* <li>
|
|
2216
2281
|
* <p>
|
|
2217
|
-
* <code>Invocation</code>: For commands sent to multiple
|
|
2218
|
-
* a per-
|
|
2282
|
+
* <code>Invocation</code>: For commands sent to multiple managed nodes, receive notification
|
|
2283
|
+
* on a per-node basis when the status of a command changes. </p>
|
|
2219
2284
|
* </li>
|
|
2220
2285
|
* </ul>
|
|
2221
2286
|
*/
|
|
@@ -2282,7 +2347,7 @@ export interface MaintenanceWindowRunCommandParameters {
|
|
|
2282
2347
|
*/
|
|
2283
2348
|
DocumentVersion?: string;
|
|
2284
2349
|
/**
|
|
2285
|
-
* <p>Configurations for sending notifications about command status changes on a per-
|
|
2350
|
+
* <p>Configurations for sending notifications about command status changes on a per-managed node
|
|
2286
2351
|
* basis.</p>
|
|
2287
2352
|
*/
|
|
2288
2353
|
NotificationConfig?: NotificationConfig;
|
|
@@ -3179,8 +3244,8 @@ export interface GetPatchBaselineResult {
|
|
|
3179
3244
|
ApprovedPatchesComplianceLevel?: PatchComplianceLevel | string;
|
|
3180
3245
|
/**
|
|
3181
3246
|
* <p>Indicates whether the list of approved patches includes non-security updates that should be
|
|
3182
|
-
* applied to the
|
|
3183
|
-
* only.</p>
|
|
3247
|
+
* applied to the managed nodes. The default value is <code>false</code>. Applies to Linux managed
|
|
3248
|
+
* nodes only.</p>
|
|
3184
3249
|
*/
|
|
3185
3250
|
ApprovedPatchesEnableNonSecurity?: boolean;
|
|
3186
3251
|
/**
|
|
@@ -3210,8 +3275,8 @@ export interface GetPatchBaselineResult {
|
|
|
3210
3275
|
*/
|
|
3211
3276
|
Description?: string;
|
|
3212
3277
|
/**
|
|
3213
|
-
* <p>Information about the patches to use to update the
|
|
3214
|
-
* systems and source repositories. Applies to Linux
|
|
3278
|
+
* <p>Information about the patches to use to update the managed nodes, including target operating
|
|
3279
|
+
* systems and source repositories. Applies to Linux managed nodes only.</p>
|
|
3215
3280
|
*/
|
|
3216
3281
|
Sources?: PatchSource[];
|
|
3217
3282
|
}
|
|
@@ -3489,7 +3554,7 @@ export interface ListAssociationsRequest {
|
|
|
3489
3554
|
* <note>
|
|
3490
3555
|
* <p>Filtering associations using the <code>InstanceID</code> attribute only returns legacy
|
|
3491
3556
|
* associations created using the <code>InstanceID</code> attribute. Associations targeting the
|
|
3492
|
-
*
|
|
3557
|
+
* managed node that are part of the Target Attributes <code>ResourceGroup</code> or <code>Tags</code>
|
|
3493
3558
|
* aren't returned.</p>
|
|
3494
3559
|
* </note>
|
|
3495
3560
|
*/
|
|
@@ -3512,7 +3577,7 @@ export declare namespace ListAssociationsRequest {
|
|
|
3512
3577
|
const filterSensitiveLog: (obj: ListAssociationsRequest) => any;
|
|
3513
3578
|
}
|
|
3514
3579
|
/**
|
|
3515
|
-
* <p>Describes an association of a Amazon Web Services Systems Manager document (SSM document) and
|
|
3580
|
+
* <p>Describes an association of a Amazon Web Services Systems Manager document (SSM document) and a managed node.</p>
|
|
3516
3581
|
*/
|
|
3517
3582
|
export interface Association {
|
|
3518
3583
|
/**
|
|
@@ -3520,7 +3585,7 @@ export interface Association {
|
|
|
3520
3585
|
*/
|
|
3521
3586
|
Name?: string;
|
|
3522
3587
|
/**
|
|
3523
|
-
* <p>The
|
|
3588
|
+
* <p>The managed node ID.</p>
|
|
3524
3589
|
*/
|
|
3525
3590
|
InstanceId?: string;
|
|
3526
3591
|
/**
|
|
@@ -3537,9 +3602,9 @@ export interface Association {
|
|
|
3537
3602
|
*/
|
|
3538
3603
|
DocumentVersion?: string;
|
|
3539
3604
|
/**
|
|
3540
|
-
* <p>The
|
|
3541
|
-
* in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of
|
|
3542
|
-
*
|
|
3605
|
+
* <p>The managed nodes targeted by the request to create an association. You can target all
|
|
3606
|
+
* managed nodes in an Amazon Web Services account by specifying the <code>InstanceIds</code> key with a value of
|
|
3607
|
+
* <code>*</code>.</p>
|
|
3543
3608
|
*/
|
|
3544
3609
|
Targets?: Target[];
|
|
3545
3610
|
/**
|
|
@@ -3660,8 +3725,8 @@ export interface AssociationVersionInfo {
|
|
|
3660
3725
|
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
3661
3726
|
* the system stops sending requests when the fourth error is received. If you specify 0, then the
|
|
3662
3727
|
* system stops sending requests after the first error is returned. If you run an association on 50
|
|
3663
|
-
*
|
|
3664
|
-
* the sixth error is received.</p>
|
|
3728
|
+
* managed nodes and set <code>MaxError</code> to 10%, then the system stops sending the request
|
|
3729
|
+
* when the sixth error is received.</p>
|
|
3665
3730
|
* <p>Executions that are already running an association when <code>MaxErrors</code> is reached
|
|
3666
3731
|
* are allowed to complete, but some of these executions may fail as well. If you need to ensure
|
|
3667
3732
|
* that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1
|
|
@@ -3672,9 +3737,9 @@ export interface AssociationVersionInfo {
|
|
|
3672
3737
|
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
3673
3738
|
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
3674
3739
|
* value is 100%, which means all targets run the association at the same time.</p>
|
|
3675
|
-
* <p>If a new
|
|
3740
|
+
* <p>If a new managed node starts and attempts to run an association while Systems Manager is running
|
|
3676
3741
|
* <code>MaxConcurrency</code> associations, the association is allowed to run. During the next
|
|
3677
|
-
* association interval, the new
|
|
3742
|
+
* association interval, the new managed node will process its association within the limit specified
|
|
3678
3743
|
* for <code>MaxConcurrency</code>.</p>
|
|
3679
3744
|
*/
|
|
3680
3745
|
MaxConcurrency?: string;
|
|
@@ -3748,13 +3813,17 @@ export declare enum CommandFilterKey {
|
|
|
3748
3813
|
/**
|
|
3749
3814
|
* <p>Describes a command filter.</p>
|
|
3750
3815
|
* <note>
|
|
3751
|
-
* <p>
|
|
3752
|
-
* command hasn't run on the
|
|
3816
|
+
* <p>A managed node ID can't be specified when a command status is <code>Pending</code> because the
|
|
3817
|
+
* command hasn't run on the node yet.</p>
|
|
3753
3818
|
* </note>
|
|
3754
3819
|
*/
|
|
3755
3820
|
export interface CommandFilter {
|
|
3756
3821
|
/**
|
|
3757
3822
|
* <p>The name of the filter.</p>
|
|
3823
|
+
* <note>
|
|
3824
|
+
* <p>The <code>ExecutionStage</code> filter can't be used with the
|
|
3825
|
+
* <code>ListCommandInvocations</code> operation, only with <code>ListCommands</code>.</p>
|
|
3826
|
+
* </note>
|
|
3758
3827
|
*/
|
|
3759
3828
|
key: CommandFilterKey | string | undefined;
|
|
3760
3829
|
/**
|
|
@@ -3911,12 +3980,12 @@ export interface CommandFilter {
|
|
|
3911
3980
|
* <b>DocumentName</b>: Specify name of the Amazon Web Services Systems Manager document (SSM
|
|
3912
3981
|
* document) for which you want to see command execution results. For example, specify
|
|
3913
3982
|
* <code>AWS-RunPatchBaseline</code> to see command executions that used this SSM document to
|
|
3914
|
-
* perform security patching operations on
|
|
3983
|
+
* perform security patching operations on managed nodes. </p>
|
|
3915
3984
|
* </li>
|
|
3916
3985
|
* <li>
|
|
3917
3986
|
* <p>
|
|
3918
|
-
* <b>ExecutionStage</b>: Specify one of the following
|
|
3919
|
-
*
|
|
3987
|
+
* <b>ExecutionStage</b>: Specify one of the following values
|
|
3988
|
+
* (<code>ListCommands</code> operations only):</p>
|
|
3920
3989
|
* <ul>
|
|
3921
3990
|
* <li>
|
|
3922
3991
|
* <p>
|
|
@@ -3946,7 +4015,7 @@ export interface ListCommandInvocationsRequest {
|
|
|
3946
4015
|
*/
|
|
3947
4016
|
CommandId?: string;
|
|
3948
4017
|
/**
|
|
3949
|
-
* <p>(Optional) The command execution details for a specific
|
|
4018
|
+
* <p>(Optional) The command execution details for a specific managed node ID.</p>
|
|
3950
4019
|
*/
|
|
3951
4020
|
InstanceId?: string;
|
|
3952
4021
|
/**
|
|
@@ -4008,10 +4077,10 @@ export interface CommandPlugin {
|
|
|
4008
4077
|
* following values:</p>
|
|
4009
4078
|
* <ul>
|
|
4010
4079
|
* <li>
|
|
4011
|
-
* <p>Pending: The command hasn't been sent to the
|
|
4080
|
+
* <p>Pending: The command hasn't been sent to the managed node.</p>
|
|
4012
4081
|
* </li>
|
|
4013
4082
|
* <li>
|
|
4014
|
-
* <p>In Progress: The command has been sent to the
|
|
4083
|
+
* <p>In Progress: The command has been sent to the managed node but hasn't reached a terminal
|
|
4015
4084
|
* state.</p>
|
|
4016
4085
|
* </li>
|
|
4017
4086
|
* <li>
|
|
@@ -4019,18 +4088,18 @@ export interface CommandPlugin {
|
|
|
4019
4088
|
* terminal state.</p>
|
|
4020
4089
|
* </li>
|
|
4021
4090
|
* <li>
|
|
4022
|
-
* <p>Delivery Timed Out: The command wasn't delivered to the
|
|
4091
|
+
* <p>Delivery Timed Out: The command wasn't delivered to the managed node before the delivery
|
|
4023
4092
|
* timeout expired. Delivery timeouts don't count against the parent command's
|
|
4024
4093
|
* <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is
|
|
4025
4094
|
* Success or Incomplete. This is a terminal state.</p>
|
|
4026
4095
|
* </li>
|
|
4027
4096
|
* <li>
|
|
4028
|
-
* <p>Execution Timed Out: Command execution started on the
|
|
4097
|
+
* <p>Execution Timed Out: Command execution started on the managed node, but the execution wasn't
|
|
4029
4098
|
* complete before the execution timeout expired. Execution timeouts count against the
|
|
4030
4099
|
* <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p>
|
|
4031
4100
|
* </li>
|
|
4032
4101
|
* <li>
|
|
4033
|
-
* <p>Failed: The command wasn't successful on the
|
|
4102
|
+
* <p>Failed: The command wasn't successful on the managed node. For a plugin, this indicates that
|
|
4034
4103
|
* the result code wasn't zero. For a command invocation, this indicates that the result code for
|
|
4035
4104
|
* one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the
|
|
4036
4105
|
* parent command. This is a terminal state.</p>
|
|
@@ -4040,7 +4109,7 @@ export interface CommandPlugin {
|
|
|
4040
4109
|
* state.</p>
|
|
4041
4110
|
* </li>
|
|
4042
4111
|
* <li>
|
|
4043
|
-
* <p>Undeliverable: The command can't be delivered to the
|
|
4112
|
+
* <p>Undeliverable: The command can't be delivered to the managed node. The managed node might not
|
|
4044
4113
|
* exist, or it might not be responding. Undeliverable invocations don't count against the parent
|
|
4045
4114
|
* command's MaxErrors limit, and they don't contribute to whether the parent command status is
|
|
4046
4115
|
* Success or Incomplete. This is a terminal state.</p>
|
|
@@ -4095,7 +4164,7 @@ export interface CommandPlugin {
|
|
|
4095
4164
|
* <p>
|
|
4096
4165
|
* <code>ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix</code> is the name of the S3 prefix;</p>
|
|
4097
4166
|
* <p>
|
|
4098
|
-
* <code>i-02573cafcfEXAMPLE</code> is the
|
|
4167
|
+
* <code>i-02573cafcfEXAMPLE</code> is the managed node ID;</p>
|
|
4099
4168
|
* <p>
|
|
4100
4169
|
* <code>awsrunShellScript</code> is the name of the plugin.</p>
|
|
4101
4170
|
*/
|
|
@@ -4112,7 +4181,7 @@ export interface CommandPlugin {
|
|
|
4112
4181
|
* <p>
|
|
4113
4182
|
* <code>ab19cb99-a030-46dd-9dfc-8eSAMPLEPre-Fix</code> is the name of the S3 prefix;</p>
|
|
4114
4183
|
* <p>
|
|
4115
|
-
* <code>i-02573cafcfEXAMPLE</code> is the
|
|
4184
|
+
* <code>i-02573cafcfEXAMPLE</code> is the managed node ID;</p>
|
|
4116
4185
|
* <p>
|
|
4117
4186
|
* <code>awsrunShellScript</code> is the name of the plugin.</p>
|
|
4118
4187
|
*/
|
|
@@ -4125,11 +4194,11 @@ export declare namespace CommandPlugin {
|
|
|
4125
4194
|
const filterSensitiveLog: (obj: CommandPlugin) => any;
|
|
4126
4195
|
}
|
|
4127
4196
|
/**
|
|
4128
|
-
* <p>An invocation is copy of a command sent to a specific
|
|
4129
|
-
* or more
|
|
4130
|
-
*
|
|
4131
|
-
*
|
|
4132
|
-
*
|
|
4197
|
+
* <p>An invocation is a copy of a command sent to a specific managed node. A command can apply to one
|
|
4198
|
+
* or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
|
|
4199
|
+
* <code>SendCommand</code> against three managed nodes, then a command invocation is created for
|
|
4200
|
+
* each requested managed node ID. A command invocation returns status and detail information about a
|
|
4201
|
+
* command you ran. </p>
|
|
4133
4202
|
*/
|
|
4134
4203
|
export interface CommandInvocation {
|
|
4135
4204
|
/**
|
|
@@ -4137,11 +4206,11 @@ export interface CommandInvocation {
|
|
|
4137
4206
|
*/
|
|
4138
4207
|
CommandId?: string;
|
|
4139
4208
|
/**
|
|
4140
|
-
* <p>The
|
|
4209
|
+
* <p>The managed node ID in which this invocation was requested.</p>
|
|
4141
4210
|
*/
|
|
4142
4211
|
InstanceId?: string;
|
|
4143
4212
|
/**
|
|
4144
|
-
* <p>The fully qualified host name of the managed
|
|
4213
|
+
* <p>The fully qualified host name of the managed node.</p>
|
|
4145
4214
|
*/
|
|
4146
4215
|
InstanceName?: string;
|
|
4147
4216
|
/**
|
|
@@ -4158,7 +4227,7 @@ export interface CommandInvocation {
|
|
|
4158
4227
|
*/
|
|
4159
4228
|
DocumentVersion?: string;
|
|
4160
4229
|
/**
|
|
4161
|
-
* <p>The time and date the request was sent to this
|
|
4230
|
+
* <p>The time and date the request was sent to this managed node.</p>
|
|
4162
4231
|
*/
|
|
4163
4232
|
RequestedDateTime?: Date;
|
|
4164
4233
|
/**
|
|
@@ -4166,7 +4235,7 @@ export interface CommandInvocation {
|
|
|
4166
4235
|
*/
|
|
4167
4236
|
Status?: CommandInvocationStatus | string;
|
|
4168
4237
|
/**
|
|
4169
|
-
* <p>A detailed status of the command execution for each invocation (each
|
|
4238
|
+
* <p>A detailed status of the command execution for each invocation (each managed node targeted by
|
|
4170
4239
|
* the command). StatusDetails includes more information than Status because it includes states
|
|
4171
4240
|
* resulting from error and concurrency control parameters. StatusDetails can show different results
|
|
4172
4241
|
* than Status. For more information about these statuses, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html">Understanding command
|
|
@@ -4174,10 +4243,10 @@ export interface CommandInvocation {
|
|
|
4174
4243
|
* following values:</p>
|
|
4175
4244
|
* <ul>
|
|
4176
4245
|
* <li>
|
|
4177
|
-
* <p>Pending: The command hasn't been sent to the
|
|
4246
|
+
* <p>Pending: The command hasn't been sent to the managed node.</p>
|
|
4178
4247
|
* </li>
|
|
4179
4248
|
* <li>
|
|
4180
|
-
* <p>In Progress: The command has been sent to the
|
|
4249
|
+
* <p>In Progress: The command has been sent to the managed node but hasn't reached a terminal
|
|
4181
4250
|
* state.</p>
|
|
4182
4251
|
* </li>
|
|
4183
4252
|
* <li>
|
|
@@ -4185,18 +4254,18 @@ export interface CommandInvocation {
|
|
|
4185
4254
|
* terminal state.</p>
|
|
4186
4255
|
* </li>
|
|
4187
4256
|
* <li>
|
|
4188
|
-
* <p>Delivery Timed Out: The command wasn't delivered to the
|
|
4257
|
+
* <p>Delivery Timed Out: The command wasn't delivered to the managed node before the delivery
|
|
4189
4258
|
* timeout expired. Delivery timeouts don't count against the parent command's
|
|
4190
4259
|
* <code>MaxErrors</code> limit, but they do contribute to whether the parent command status is
|
|
4191
4260
|
* Success or Incomplete. This is a terminal state.</p>
|
|
4192
4261
|
* </li>
|
|
4193
4262
|
* <li>
|
|
4194
|
-
* <p>Execution Timed Out: Command execution started on the
|
|
4263
|
+
* <p>Execution Timed Out: Command execution started on the managed node, but the execution wasn't
|
|
4195
4264
|
* complete before the execution timeout expired. Execution timeouts count against the
|
|
4196
4265
|
* <code>MaxErrors</code> limit of the parent command. This is a terminal state.</p>
|
|
4197
4266
|
* </li>
|
|
4198
4267
|
* <li>
|
|
4199
|
-
* <p>Failed: The command wasn't successful on the
|
|
4268
|
+
* <p>Failed: The command wasn't successful on the managed node. For a plugin, this indicates that
|
|
4200
4269
|
* the result code wasn't zero. For a command invocation, this indicates that the result code for
|
|
4201
4270
|
* one or more plugins wasn't zero. Invocation failures count against the <code>MaxErrors</code>
|
|
4202
4271
|
* limit of the parent command. This is a terminal state.</p>
|
|
@@ -4206,7 +4275,7 @@ export interface CommandInvocation {
|
|
|
4206
4275
|
* state.</p>
|
|
4207
4276
|
* </li>
|
|
4208
4277
|
* <li>
|
|
4209
|
-
* <p>Undeliverable: The command can't be delivered to the
|
|
4278
|
+
* <p>Undeliverable: The command can't be delivered to the managed node. The managed node might not
|
|
4210
4279
|
* exist or might not be responding. Undeliverable invocations don't count against the parent
|
|
4211
4280
|
* command's MaxErrors limit and don't contribute to whether the parent command status is Success
|
|
4212
4281
|
* or Incomplete. This is a terminal state.</p>
|
|
@@ -4243,11 +4312,11 @@ export interface CommandInvocation {
|
|
|
4243
4312
|
/**
|
|
4244
4313
|
* <p>The Identity and Access Management (IAM) service role that Run Command, a capability
|
|
4245
4314
|
* of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes
|
|
4246
|
-
* on a per
|
|
4315
|
+
* on a per managed node basis.</p>
|
|
4247
4316
|
*/
|
|
4248
4317
|
ServiceRole?: string;
|
|
4249
4318
|
/**
|
|
4250
|
-
* <p>Configurations for sending notifications about command status changes on a per
|
|
4319
|
+
* <p>Configurations for sending notifications about command status changes on a per managed node
|
|
4251
4320
|
* basis.</p>
|
|
4252
4321
|
*/
|
|
4253
4322
|
NotificationConfig?: NotificationConfig;
|
|
@@ -4286,10 +4355,10 @@ export interface ListCommandsRequest {
|
|
|
4286
4355
|
*/
|
|
4287
4356
|
CommandId?: string;
|
|
4288
4357
|
/**
|
|
4289
|
-
* <p>(Optional) Lists commands issued against this
|
|
4358
|
+
* <p>(Optional) Lists commands issued against this managed node ID.</p>
|
|
4290
4359
|
* <note>
|
|
4291
|
-
* <p>You can't specify
|
|
4292
|
-
* <code>Pending</code>. This is because the command hasn't reached the
|
|
4360
|
+
* <p>You can't specify a managed node ID in the same command that you specify <code>Status</code> =
|
|
4361
|
+
* <code>Pending</code>. This is because the command hasn't reached the managed node yet.</p>
|
|
4293
4362
|
* </note>
|
|
4294
4363
|
*/
|
|
4295
4364
|
InstanceId?: string;
|
|
@@ -4358,12 +4427,13 @@ export interface Command {
|
|
|
4358
4427
|
[key: string]: string[];
|
|
4359
4428
|
};
|
|
4360
4429
|
/**
|
|
4361
|
-
* <p>The
|
|
4430
|
+
* <p>The managed node IDs against which this command was requested.</p>
|
|
4362
4431
|
*/
|
|
4363
4432
|
InstanceIds?: string[];
|
|
4364
4433
|
/**
|
|
4365
|
-
* <p>An array of search criteria that targets
|
|
4366
|
-
* specify. Targets is required if you don't provide one or more
|
|
4434
|
+
* <p>An array of search criteria that targets managed nodes using a Key,Value combination that
|
|
4435
|
+
* you specify. Targets is required if you don't provide one or more managed node IDs in the
|
|
4436
|
+
* call.</p>
|
|
4367
4437
|
*/
|
|
4368
4438
|
Targets?: Target[];
|
|
4369
4439
|
/**
|
|
@@ -4383,11 +4453,11 @@ export interface Command {
|
|
|
4383
4453
|
* following values:</p>
|
|
4384
4454
|
* <ul>
|
|
4385
4455
|
* <li>
|
|
4386
|
-
* <p>Pending: The command hasn't been sent to any
|
|
4456
|
+
* <p>Pending: The command hasn't been sent to any managed nodes.</p>
|
|
4387
4457
|
* </li>
|
|
4388
4458
|
* <li>
|
|
4389
|
-
* <p>In Progress: The command has been sent to at least one
|
|
4390
|
-
* state on all
|
|
4459
|
+
* <p>In Progress: The command has been sent to at least one managed node but hasn't reached a final
|
|
4460
|
+
* state on all managed nodes.</p>
|
|
4391
4461
|
* </li>
|
|
4392
4462
|
* <li>
|
|
4393
4463
|
* <p>Success: The command successfully ran on all invocations. This is a terminal state.</p>
|
|
@@ -4405,18 +4475,18 @@ export interface Command {
|
|
|
4405
4475
|
* is a terminal state.</p>
|
|
4406
4476
|
* </li>
|
|
4407
4477
|
* <li>
|
|
4408
|
-
* <p>Incomplete: The command was attempted on all
|
|
4409
|
-
* have a value of Success but not enough invocations failed for the status to be Failed.
|
|
4410
|
-
* a terminal state.</p>
|
|
4478
|
+
* <p>Incomplete: The command was attempted on all managed nodes and one or more invocations
|
|
4479
|
+
* doesn't have a value of Success but not enough invocations failed for the status to be Failed.
|
|
4480
|
+
* This is a terminal state.</p>
|
|
4411
4481
|
* </li>
|
|
4412
4482
|
* <li>
|
|
4413
4483
|
* <p>Canceled: The command was terminated before it was completed. This is a terminal
|
|
4414
4484
|
* state.</p>
|
|
4415
4485
|
* </li>
|
|
4416
4486
|
* <li>
|
|
4417
|
-
* <p>Rate Exceeded: The number of
|
|
4418
|
-
* for pending invocations. The system has canceled the command before running it on any
|
|
4419
|
-
* This is a terminal state.</p>
|
|
4487
|
+
* <p>Rate Exceeded: The number of managed nodes targeted by the command exceeded the account
|
|
4488
|
+
* limit for pending invocations. The system has canceled the command before running it on any
|
|
4489
|
+
* managed node. This is a terminal state.</p>
|
|
4420
4490
|
* </li>
|
|
4421
4491
|
* </ul>
|
|
4422
4492
|
*/
|
|
@@ -4437,8 +4507,8 @@ export interface Command {
|
|
|
4437
4507
|
*/
|
|
4438
4508
|
OutputS3KeyPrefix?: string;
|
|
4439
4509
|
/**
|
|
4440
|
-
* <p>The maximum number of
|
|
4441
|
-
* can specify a number of
|
|
4510
|
+
* <p>The maximum number of managed nodes that are allowed to run the command at the same time.
|
|
4511
|
+
* You can specify a number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The
|
|
4442
4512
|
* default value is 50. For more information about how to use <code>MaxConcurrency</code>, see
|
|
4443
4513
|
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/run-command.html">Running
|
|
4444
4514
|
* commands using Systems Manager Run Command</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
@@ -4632,7 +4702,7 @@ export interface ComplianceItem {
|
|
|
4632
4702
|
*/
|
|
4633
4703
|
ResourceType?: string;
|
|
4634
4704
|
/**
|
|
4635
|
-
* <p>An ID for the resource. For a managed
|
|
4705
|
+
* <p>An ID for the resource. For a managed node, this is the node ID.</p>
|
|
4636
4706
|
*/
|
|
4637
4707
|
ResourceId?: string;
|
|
4638
4708
|
/**
|
|
@@ -4715,7 +4785,7 @@ export declare namespace ListComplianceSummariesRequest {
|
|
|
4715
4785
|
const filterSensitiveLog: (obj: ListComplianceSummariesRequest) => any;
|
|
4716
4786
|
}
|
|
4717
4787
|
/**
|
|
4718
|
-
* <p>The number of managed
|
|
4788
|
+
* <p>The number of managed nodes found for each patch severity level defined in the request
|
|
4719
4789
|
* filter.</p>
|
|
4720
4790
|
*/
|
|
4721
4791
|
export interface SeveritySummary {
|
|
@@ -5375,7 +5445,7 @@ export declare namespace ListDocumentVersionsResult {
|
|
|
5375
5445
|
}
|
|
5376
5446
|
export interface ListInventoryEntriesRequest {
|
|
5377
5447
|
/**
|
|
5378
|
-
* <p>The
|
|
5448
|
+
* <p>The managed node ID for which you want inventory information.</p>
|
|
5379
5449
|
*/
|
|
5380
5450
|
InstanceId: string | undefined;
|
|
5381
5451
|
/**
|
|
@@ -5409,19 +5479,19 @@ export interface ListInventoryEntriesResult {
|
|
|
5409
5479
|
*/
|
|
5410
5480
|
TypeName?: string;
|
|
5411
5481
|
/**
|
|
5412
|
-
* <p>The
|
|
5482
|
+
* <p>The managed node ID targeted by the request to query inventory information.</p>
|
|
5413
5483
|
*/
|
|
5414
5484
|
InstanceId?: string;
|
|
5415
5485
|
/**
|
|
5416
|
-
* <p>The inventory schema version used by the
|
|
5486
|
+
* <p>The inventory schema version used by the managed node(s).</p>
|
|
5417
5487
|
*/
|
|
5418
5488
|
SchemaVersion?: string;
|
|
5419
5489
|
/**
|
|
5420
|
-
* <p>The time that inventory information was collected for the
|
|
5490
|
+
* <p>The time that inventory information was collected for the managed node(s).</p>
|
|
5421
5491
|
*/
|
|
5422
5492
|
CaptureTime?: string;
|
|
5423
5493
|
/**
|
|
5424
|
-
* <p>A list of inventory items on the
|
|
5494
|
+
* <p>A list of inventory items on the managed node(s).</p>
|
|
5425
5495
|
*/
|
|
5426
5496
|
Entries?: {
|
|
5427
5497
|
[key: string]: string;
|
|
@@ -5842,9 +5912,9 @@ export declare namespace ResourceComplianceSummaryItem {
|
|
|
5842
5912
|
}
|
|
5843
5913
|
export interface ListResourceComplianceSummariesResult {
|
|
5844
5914
|
/**
|
|
5845
|
-
* <p>A summary count for specified or targeted managed
|
|
5846
|
-
*
|
|
5847
|
-
*
|
|
5915
|
+
* <p>A summary count for specified or targeted managed nodes. Summary count includes information
|
|
5916
|
+
* about compliant and non-compliant State Manager associations, patch status, or custom items
|
|
5917
|
+
* according to the filter criteria that you specify. </p>
|
|
5848
5918
|
*/
|
|
5849
5919
|
ResourceComplianceSummaryItems?: ResourceComplianceSummaryItem[];
|
|
5850
5920
|
/**
|
|
@@ -6199,7 +6269,7 @@ export declare enum ComplianceUploadType {
|
|
|
6199
6269
|
}
|
|
6200
6270
|
export interface PutComplianceItemsRequest {
|
|
6201
6271
|
/**
|
|
6202
|
-
* <p>Specify an ID for this resource. For a managed
|
|
6272
|
+
* <p>Specify an ID for this resource. For a managed node, this is the node ID.</p>
|
|
6203
6273
|
*/
|
|
6204
6274
|
ResourceId: string | undefined;
|
|
6205
6275
|
/**
|
|
@@ -6318,7 +6388,7 @@ export declare namespace ItemContentMismatchException {
|
|
|
6318
6388
|
const filterSensitiveLog: (obj: ItemContentMismatchException) => any;
|
|
6319
6389
|
}
|
|
6320
6390
|
/**
|
|
6321
|
-
* <p>Information collected from managed
|
|
6391
|
+
* <p>Information collected from managed nodes based on your inventory policy document</p>
|
|
6322
6392
|
*/
|
|
6323
6393
|
export interface InventoryItem {
|
|
6324
6394
|
/**
|
|
@@ -6366,11 +6436,11 @@ export declare namespace InventoryItem {
|
|
|
6366
6436
|
}
|
|
6367
6437
|
export interface PutInventoryRequest {
|
|
6368
6438
|
/**
|
|
6369
|
-
* <p>An
|
|
6439
|
+
* <p>An managed node ID where you want to add or update inventory items.</p>
|
|
6370
6440
|
*/
|
|
6371
6441
|
InstanceId: string | undefined;
|
|
6372
6442
|
/**
|
|
6373
|
-
* <p>The inventory items that you want to add or update on
|
|
6443
|
+
* <p>The inventory items that you want to add or update on managed nodes.</p>
|
|
6374
6444
|
*/
|
|
6375
6445
|
Items: InventoryItem[] | undefined;
|
|
6376
6446
|
}
|
|
@@ -6833,10 +6903,10 @@ export interface PutParameterRequest {
|
|
|
6833
6903
|
* you specify the expiration date. You can update the expiration date and time by updating the
|
|
6834
6904
|
* policy. Updating the <i>parameter</i> doesn't affect the expiration date and time.
|
|
6835
6905
|
* When the expiration time is reached, Parameter Store deletes the parameter.</p>
|
|
6836
|
-
* <p>ExpirationNotification: This policy
|
|
6906
|
+
* <p>ExpirationNotification: This policy initiates an event in Amazon CloudWatch Events that
|
|
6837
6907
|
* notifies you about the expiration. By using this policy, you can receive notification before or
|
|
6838
6908
|
* after the expiration time is reached, in units of days or hours.</p>
|
|
6839
|
-
* <p>NoChangeNotification: This policy
|
|
6909
|
+
* <p>NoChangeNotification: This policy initiates a CloudWatch Events event if a parameter hasn't
|
|
6840
6910
|
* been modified for a specified period of time. This policy type is useful when, for example, a
|
|
6841
6911
|
* secret needs to be changed within a period of time, but it hasn't been changed.</p>
|
|
6842
6912
|
* <p>All existing policies are preserved until you send new policies or an empty policy. For more
|
|
@@ -6976,53 +7046,48 @@ export interface RegisterTargetWithMaintenanceWindowRequest {
|
|
|
6976
7046
|
*/
|
|
6977
7047
|
ResourceType: MaintenanceWindowResourceType | string | undefined;
|
|
6978
7048
|
/**
|
|
6979
|
-
* <p>The targets to register with the maintenance window. In other words, the
|
|
6980
|
-
* commands on when the maintenance window runs.</p>
|
|
7049
|
+
* <p>The targets to register with the maintenance window. In other words, the managed nodes to
|
|
7050
|
+
* run commands on when the maintenance window runs.</p>
|
|
6981
7051
|
* <note>
|
|
6982
7052
|
* <p>If a single maintenance window task is registered with multiple targets, its task
|
|
6983
7053
|
* invocations occur sequentially and not in parallel. If your task must run on multiple targets at
|
|
6984
7054
|
* the same time, register a task for each target individually and assign each task the same
|
|
6985
7055
|
* priority level.</p>
|
|
6986
7056
|
* </note>
|
|
6987
|
-
* <p>You can specify targets using
|
|
6988
|
-
* applied to
|
|
7057
|
+
* <p>You can specify targets using managed node IDs, resource group names, or tags that have been
|
|
7058
|
+
* applied to managed nodes.</p>
|
|
6989
7059
|
* <p>
|
|
6990
|
-
* <b>Example 1</b>: Specify
|
|
7060
|
+
* <b>Example 1</b>: Specify managed node IDs</p>
|
|
6991
7061
|
* <p>
|
|
6992
|
-
* <code>Key=InstanceIds,Values=<
|
|
6993
|
-
* </code>
|
|
7062
|
+
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2>,<instance-id-3></code>
|
|
6994
7063
|
* </p>
|
|
6995
7064
|
* <p>
|
|
6996
|
-
* <b>Example 2</b>: Use tag key-pairs applied to
|
|
7065
|
+
* <b>Example 2</b>: Use tag key-pairs applied to managed
|
|
7066
|
+
* nodes</p>
|
|
6997
7067
|
* <p>
|
|
6998
|
-
* <code>Key=tag:<
|
|
6999
|
-
* </code>
|
|
7068
|
+
* <code>Key=tag:<my-tag-key>,Values=<my-tag-value-1>,<my-tag-value-2></code>
|
|
7000
7069
|
* </p>
|
|
7001
7070
|
* <p>
|
|
7002
|
-
* <b>Example 3</b>: Use tag-keys applied to
|
|
7071
|
+
* <b>Example 3</b>: Use tag-keys applied to managed nodes</p>
|
|
7003
7072
|
* <p>
|
|
7004
|
-
* <code>Key=tag-key,Values=<
|
|
7005
|
-
* </code>
|
|
7073
|
+
* <code>Key=tag-key,Values=<my-tag-key-1>,<my-tag-key-2></code>
|
|
7006
7074
|
* </p>
|
|
7007
7075
|
*
|
|
7008
7076
|
* <p>
|
|
7009
7077
|
* <b>Example 4</b>: Use resource group names</p>
|
|
7010
7078
|
* <p>
|
|
7011
|
-
* <code>Key=resource-groups:Name,Values=<
|
|
7012
|
-
* </code>
|
|
7079
|
+
* <code>Key=resource-groups:Name,Values=<resource-group-name></code>
|
|
7013
7080
|
* </p>
|
|
7014
7081
|
* <p>
|
|
7015
7082
|
* <b>Example 5</b>: Use filters for resource group types</p>
|
|
7016
7083
|
* <p>
|
|
7017
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values=<
|
|
7018
|
-
* </code>
|
|
7084
|
+
* <code>Key=resource-groups:ResourceTypeFilters,Values=<resource-type-1>,<resource-type-2></code>
|
|
7019
7085
|
* </p>
|
|
7020
7086
|
* <note>
|
|
7021
7087
|
* <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the
|
|
7022
7088
|
* following format</p>
|
|
7023
7089
|
* <p>
|
|
7024
|
-
* <code>Key=resource-groups:ResourceTypeFilters,Values
|
|
7025
|
-
* </code>
|
|
7090
|
+
* <code>Key=resource-groups:ResourceTypeFilters,Values=AWS::EC2::INSTANCE,AWS::EC2::VPC</code>
|
|
7026
7091
|
* </p>
|
|
7027
7092
|
* </note>
|
|
7028
7093
|
*
|
|
@@ -7088,7 +7153,7 @@ export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
|
7088
7153
|
*/
|
|
7089
7154
|
WindowId: string | undefined;
|
|
7090
7155
|
/**
|
|
7091
|
-
* <p>The targets (either
|
|
7156
|
+
* <p>The targets (either managed nodes or maintenance window targets).</p>
|
|
7092
7157
|
* <note>
|
|
7093
7158
|
* <p>One or more targets must be specified for maintenance window Run Command-type tasks.
|
|
7094
7159
|
* Depending on the task, targets are optional for other maintenance window task types (Automation,
|
|
@@ -7097,7 +7162,7 @@ export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
|
7097
7162
|
* maintenance window tasks without targets</a> in the
|
|
7098
7163
|
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
7099
7164
|
* </note>
|
|
7100
|
-
* <p>Specify
|
|
7165
|
+
* <p>Specify managed nodes using the following format: </p>
|
|
7101
7166
|
* <p>
|
|
7102
7167
|
* <code>Key=InstanceIds,Values=<instance-id-1>,<instance-id-2></code>
|
|
7103
7168
|
* </p>
|
|
@@ -7181,7 +7246,7 @@ export interface RegisterTaskWithMaintenanceWindowRequest {
|
|
|
7181
7246
|
MaxErrors?: string;
|
|
7182
7247
|
/**
|
|
7183
7248
|
* <p>A structure containing information about an Amazon Simple Storage Service (Amazon S3) bucket
|
|
7184
|
-
* to write
|
|
7249
|
+
* to write managed node-level logs to. </p>
|
|
7185
7250
|
* <note>
|
|
7186
7251
|
* <p>
|
|
7187
7252
|
* <code>LoggingInfo</code> has been deprecated. To specify an Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use the
|
|
@@ -7256,7 +7321,7 @@ export interface RemoveTagsFromResourceRequest {
|
|
|
7256
7321
|
* <p>The type of resource from which you want to remove a tag.</p>
|
|
7257
7322
|
* <note>
|
|
7258
7323
|
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
7259
|
-
* managed
|
|
7324
|
+
* managed nodes. Specify the name of the managed node in the following format:
|
|
7260
7325
|
* <code>mi-<i>ID_number</i>
|
|
7261
7326
|
* </code>. For example,
|
|
7262
7327
|
* <code>mi-1a2b3c4d5e6f</code>.</p>
|
|
@@ -7276,9 +7341,9 @@ export interface RemoveTagsFromResourceRequest {
|
|
|
7276
7341
|
* <code>/aws/ssm/MyGroup/appmanager</code>.</p>
|
|
7277
7342
|
* <p>For the Document and Parameter values, use the name of the resource.</p>
|
|
7278
7343
|
* <note>
|
|
7279
|
-
* <p>The ManagedInstance type for this API operation is only for on-premises
|
|
7280
|
-
* Specify the name of the managed
|
|
7281
|
-
* mi-1a2b3c4d5e6f.</p>
|
|
7344
|
+
* <p>The <code>ManagedInstance</code> type for this API operation is only for on-premises
|
|
7345
|
+
* managed nodes. Specify the name of the managed node in the following format: mi-ID_number. For
|
|
7346
|
+
* example, mi-1a2b3c4d5e6f.</p>
|
|
7282
7347
|
* </note>
|
|
7283
7348
|
*/
|
|
7284
7349
|
ResourceId: string | undefined;
|
|
@@ -7384,12 +7449,12 @@ export interface ResumeSessionResponse {
|
|
|
7384
7449
|
SessionId?: string;
|
|
7385
7450
|
/**
|
|
7386
7451
|
* <p>An encrypted token value containing session and caller information. Used to authenticate the
|
|
7387
|
-
* connection to the
|
|
7452
|
+
* connection to the managed node.</p>
|
|
7388
7453
|
*/
|
|
7389
7454
|
TokenValue?: string;
|
|
7390
7455
|
/**
|
|
7391
|
-
* <p>A URL back to SSM Agent on the
|
|
7392
|
-
* receive output from the
|
|
7456
|
+
* <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
|
|
7457
|
+
* 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>
|
|
7393
7458
|
* <p>
|
|
7394
7459
|
* <b>region</b> represents the Region identifier for an
|
|
7395
7460
|
* Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region.
|
|
@@ -7536,26 +7601,26 @@ export declare namespace InvalidRole {
|
|
|
7536
7601
|
}
|
|
7537
7602
|
export interface SendCommandRequest {
|
|
7538
7603
|
/**
|
|
7539
|
-
* <p>The IDs of the
|
|
7540
|
-
* useful when you are targeting a limited number of
|
|
7604
|
+
* <p>The IDs of the managed nodes where the command should run. Specifying managed node IDs is most
|
|
7605
|
+
* useful when you are targeting a limited number of managed nodes, though you can specify up to 50
|
|
7541
7606
|
* IDs.</p>
|
|
7542
|
-
* <p>To target a larger number of
|
|
7607
|
+
* <p>To target a larger number of managed nodes, or if you prefer not to list individual node
|
|
7543
7608
|
* IDs, we recommend using the <code>Targets</code> option instead. Using <code>Targets</code>,
|
|
7544
|
-
* which accepts tag key-value pairs to identify the
|
|
7545
|
-
* command to tens, hundreds, or thousands of
|
|
7609
|
+
* which accepts tag key-value pairs to identify the managed nodes to send commands to, you can a
|
|
7610
|
+
* send command to tens, hundreds, or thousands of nodes at once.</p>
|
|
7546
7611
|
* <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">Using targets and rate
|
|
7547
7612
|
* controls to send commands to a fleet</a> in the
|
|
7548
7613
|
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
7549
7614
|
*/
|
|
7550
7615
|
InstanceIds?: string[];
|
|
7551
7616
|
/**
|
|
7552
|
-
* <p>An array of search criteria that targets
|
|
7617
|
+
* <p>An array of search criteria that targets managed nodes using a <code>Key,Value</code>
|
|
7553
7618
|
* combination that you specify. Specifying targets is most useful when you want to send a command
|
|
7554
|
-
* to a large number of
|
|
7555
|
-
* pairs to identify
|
|
7556
|
-
* at once.</p>
|
|
7557
|
-
* <p>To send a command to a smaller number of
|
|
7558
|
-
*
|
|
7619
|
+
* to a large number of managed nodes at once. Using <code>Targets</code>, which accepts tag
|
|
7620
|
+
* key-value pairs to identify managed nodes, you can send a command to tens, hundreds, or thousands
|
|
7621
|
+
* of nodes at once.</p>
|
|
7622
|
+
* <p>To send a command to a smaller number of managed nodes, you can use the
|
|
7623
|
+
* <code>InstanceIds</code> option instead.</p>
|
|
7559
7624
|
* <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">Sending commands to a
|
|
7560
7625
|
* fleet</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
7561
7626
|
*/
|
|
@@ -7624,8 +7689,8 @@ export interface SendCommandRequest {
|
|
|
7624
7689
|
*/
|
|
7625
7690
|
OutputS3KeyPrefix?: string;
|
|
7626
7691
|
/**
|
|
7627
|
-
* <p>(Optional) The maximum number of
|
|
7628
|
-
* time. You can specify a number such as 10 or a percentage such as 10%. The default value is
|
|
7692
|
+
* <p>(Optional) The maximum number of managed nodes that are allowed to run the command at the
|
|
7693
|
+
* same time. You can specify a number such as 10 or a percentage such as 10%. The default value is
|
|
7629
7694
|
* <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
|
|
7630
7695
|
* concurrency controls</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
7631
7696
|
*/
|
|
@@ -8002,17 +8067,18 @@ export declare namespace StartChangeRequestExecutionResult {
|
|
|
8002
8067
|
}
|
|
8003
8068
|
export interface StartSessionRequest {
|
|
8004
8069
|
/**
|
|
8005
|
-
* <p>The
|
|
8070
|
+
* <p>The managed node to connect to for the session.</p>
|
|
8006
8071
|
*/
|
|
8007
8072
|
Target: string | undefined;
|
|
8008
8073
|
/**
|
|
8009
8074
|
* <p>The name of the SSM document to define the parameters and plugin settings for the session.
|
|
8010
8075
|
* For example, <code>SSM-SessionManagerRunShell</code>. You can call the <a>GetDocument</a> API to verify the document exists before attempting to start a session.
|
|
8011
|
-
* If no document name is provided, a shell to the
|
|
8076
|
+
* If no document name is provided, a shell to the managed node is launched by default.</p>
|
|
8012
8077
|
*/
|
|
8013
8078
|
DocumentName?: string;
|
|
8014
8079
|
/**
|
|
8015
|
-
* <p>The reason for connecting to the instance. This value is included in the details for the
|
|
8080
|
+
* <p>The reason for connecting to the instance. This value is included in the details for the
|
|
8081
|
+
* Amazon CloudWatch Events event created when you start the session.</p>
|
|
8016
8082
|
*/
|
|
8017
8083
|
Reason?: string;
|
|
8018
8084
|
/**
|
|
@@ -8035,12 +8101,12 @@ export interface StartSessionResponse {
|
|
|
8035
8101
|
SessionId?: string;
|
|
8036
8102
|
/**
|
|
8037
8103
|
* <p>An encrypted token value containing session and caller information. Used to authenticate the
|
|
8038
|
-
* connection to the
|
|
8104
|
+
* connection to the managed node.</p>
|
|
8039
8105
|
*/
|
|
8040
8106
|
TokenValue?: string;
|
|
8041
8107
|
/**
|
|
8042
|
-
* <p>A URL back to SSM Agent on the
|
|
8043
|
-
* receive output from the
|
|
8108
|
+
* <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and
|
|
8109
|
+
* receive output from the node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>
|
|
8044
8110
|
* </p>
|
|
8045
8111
|
* <p>
|
|
8046
8112
|
* <b>region</b> represents the Region identifier for an
|
|
@@ -8060,10 +8126,10 @@ export declare namespace StartSessionResponse {
|
|
|
8060
8126
|
const filterSensitiveLog: (obj: StartSessionResponse) => any;
|
|
8061
8127
|
}
|
|
8062
8128
|
/**
|
|
8063
|
-
* <p>The specified target
|
|
8129
|
+
* <p>The specified target managed node for the session isn't fully configured for use with Session Manager. For
|
|
8064
8130
|
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-getting-started.html">Getting started with
|
|
8065
8131
|
* Session Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. This error is also returned if you
|
|
8066
|
-
* attempt to start a session on
|
|
8132
|
+
* attempt to start a session on a managed node that is located in a different account or Region</p>
|
|
8067
8133
|
*/
|
|
8068
8134
|
export interface TargetNotConnected extends __SmithyException, $MetadataBearer {
|
|
8069
8135
|
name: "TargetNotConnected";
|
|
@@ -8236,7 +8302,7 @@ export interface UpdateAssociationRequest {
|
|
|
8236
8302
|
OutputLocation?: InstanceAssociationOutputLocation;
|
|
8237
8303
|
/**
|
|
8238
8304
|
* <p>The name of the SSM Command document or Automation runbook that contains the configuration
|
|
8239
|
-
* information for the
|
|
8305
|
+
* information for the managed node.</p>
|
|
8240
8306
|
* <p>You can specify Amazon Web Services-predefined documents, documents you created, or a document that is
|
|
8241
8307
|
* shared with you from another account.</p>
|
|
8242
8308
|
* <p>For Systems Manager document (SSM document) that are shared with you from other Amazon Web Services accounts, you
|
|
@@ -8280,8 +8346,8 @@ export interface UpdateAssociationRequest {
|
|
|
8280
8346
|
* example 10, or a percentage of the target set, for example 10%. If you specify 3, for example,
|
|
8281
8347
|
* the system stops sending requests when the fourth error is received. If you specify 0, then the
|
|
8282
8348
|
* system stops sending requests after the first error is returned. If you run an association on 50
|
|
8283
|
-
*
|
|
8284
|
-
* the sixth error is received.</p>
|
|
8349
|
+
* managed nodes and set <code>MaxError</code> to 10%, then the system stops sending the request
|
|
8350
|
+
* when the sixth error is received.</p>
|
|
8285
8351
|
* <p>Executions that are already running an association when <code>MaxErrors</code> is reached
|
|
8286
8352
|
* are allowed to complete, but some of these executions may fail as well. If you need to ensure
|
|
8287
8353
|
* that there won't be more than max-errors failed executions, set <code>MaxConcurrency</code> to 1
|
|
@@ -8292,9 +8358,9 @@ export interface UpdateAssociationRequest {
|
|
|
8292
8358
|
* <p>The maximum number of targets allowed to run the association at the same time. You can
|
|
8293
8359
|
* specify a number, for example 10, or a percentage of the target set, for example 10%. The default
|
|
8294
8360
|
* value is 100%, which means all targets run the association at the same time.</p>
|
|
8295
|
-
* <p>If a new
|
|
8361
|
+
* <p>If a new managed node starts and attempts to run an association while Systems Manager is running
|
|
8296
8362
|
* <code>MaxConcurrency</code> associations, the association is allowed to run. During the next
|
|
8297
|
-
* association interval, the new
|
|
8363
|
+
* association interval, the new managed node will process its association within the limit specified
|
|
8298
8364
|
* for <code>MaxConcurrency</code>.</p>
|
|
8299
8365
|
*/
|
|
8300
8366
|
MaxConcurrency?: string;
|
|
@@ -8377,7 +8443,7 @@ export interface UpdateAssociationStatusRequest {
|
|
|
8377
8443
|
*/
|
|
8378
8444
|
Name: string | undefined;
|
|
8379
8445
|
/**
|
|
8380
|
-
* <p>The
|
|
8446
|
+
* <p>The managed node ID.</p>
|
|
8381
8447
|
*/
|
|
8382
8448
|
InstanceId: string | undefined;
|
|
8383
8449
|
/**
|
|
@@ -8603,90 +8669,3 @@ export declare namespace UpdateDocumentMetadataRequest {
|
|
|
8603
8669
|
*/
|
|
8604
8670
|
const filterSensitiveLog: (obj: UpdateDocumentMetadataRequest) => any;
|
|
8605
8671
|
}
|
|
8606
|
-
export interface UpdateDocumentMetadataResponse {
|
|
8607
|
-
}
|
|
8608
|
-
export declare namespace UpdateDocumentMetadataResponse {
|
|
8609
|
-
/**
|
|
8610
|
-
* @internal
|
|
8611
|
-
*/
|
|
8612
|
-
const filterSensitiveLog: (obj: UpdateDocumentMetadataResponse) => any;
|
|
8613
|
-
}
|
|
8614
|
-
export interface UpdateMaintenanceWindowRequest {
|
|
8615
|
-
/**
|
|
8616
|
-
* <p>The ID of the maintenance window to update.</p>
|
|
8617
|
-
*/
|
|
8618
|
-
WindowId: string | undefined;
|
|
8619
|
-
/**
|
|
8620
|
-
* <p>The name of the maintenance window.</p>
|
|
8621
|
-
*/
|
|
8622
|
-
Name?: string;
|
|
8623
|
-
/**
|
|
8624
|
-
* <p>An optional description for the update request.</p>
|
|
8625
|
-
*/
|
|
8626
|
-
Description?: string;
|
|
8627
|
-
/**
|
|
8628
|
-
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
8629
|
-
* Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
|
|
8630
|
-
* "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
|
|
8631
|
-
* Zone Database</a> on the IANA website.</p>
|
|
8632
|
-
*/
|
|
8633
|
-
StartDate?: string;
|
|
8634
|
-
/**
|
|
8635
|
-
* <p>The date and time, in ISO-8601 Extended format, for when you want the maintenance window to
|
|
8636
|
-
* become inactive. <code>EndDate</code> allows you to set a date and time in the future when the
|
|
8637
|
-
* maintenance window will no longer run.</p>
|
|
8638
|
-
*/
|
|
8639
|
-
EndDate?: string;
|
|
8640
|
-
/**
|
|
8641
|
-
* <p>The schedule of the maintenance window in the form of a cron or rate expression.</p>
|
|
8642
|
-
*/
|
|
8643
|
-
Schedule?: string;
|
|
8644
|
-
/**
|
|
8645
|
-
* <p>The time zone that the scheduled maintenance window executions are based on, in Internet
|
|
8646
|
-
* Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or
|
|
8647
|
-
* "Asia/Seoul". For more information, see the <a href="https://www.iana.org/time-zones">Time
|
|
8648
|
-
* Zone Database</a> on the IANA website.</p>
|
|
8649
|
-
*/
|
|
8650
|
-
ScheduleTimezone?: string;
|
|
8651
|
-
/**
|
|
8652
|
-
* <p>The number of days to wait after the date and time specified by a cron expression before
|
|
8653
|
-
* running the maintenance window.</p>
|
|
8654
|
-
* <p>For example, the following cron expression schedules a maintenance window to run the third
|
|
8655
|
-
* Tuesday of every month at 11:30 PM.</p>
|
|
8656
|
-
* <p>
|
|
8657
|
-
* <code>cron(30 23 ? * TUE#3 *)</code>
|
|
8658
|
-
* </p>
|
|
8659
|
-
* <p>If the schedule offset is <code>2</code>, the maintenance window won't run until two days
|
|
8660
|
-
* later.</p>
|
|
8661
|
-
*/
|
|
8662
|
-
ScheduleOffset?: number;
|
|
8663
|
-
/**
|
|
8664
|
-
* <p>The duration of the maintenance window in hours.</p>
|
|
8665
|
-
*/
|
|
8666
|
-
Duration?: number;
|
|
8667
|
-
/**
|
|
8668
|
-
* <p>The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling
|
|
8669
|
-
* new tasks for execution.</p>
|
|
8670
|
-
*/
|
|
8671
|
-
Cutoff?: number;
|
|
8672
|
-
/**
|
|
8673
|
-
* <p>Whether targets must be registered with the maintenance window before tasks can be defined
|
|
8674
|
-
* for those targets.</p>
|
|
8675
|
-
*/
|
|
8676
|
-
AllowUnassociatedTargets?: boolean;
|
|
8677
|
-
/**
|
|
8678
|
-
* <p>Whether the maintenance window is enabled.</p>
|
|
8679
|
-
*/
|
|
8680
|
-
Enabled?: boolean;
|
|
8681
|
-
/**
|
|
8682
|
-
* <p>If <code>True</code>, then all fields that are required by the <a>CreateMaintenanceWindow</a> operation are also required for this API request. Optional
|
|
8683
|
-
* fields that aren't specified are set to null. </p>
|
|
8684
|
-
*/
|
|
8685
|
-
Replace?: boolean;
|
|
8686
|
-
}
|
|
8687
|
-
export declare namespace UpdateMaintenanceWindowRequest {
|
|
8688
|
-
/**
|
|
8689
|
-
* @internal
|
|
8690
|
-
*/
|
|
8691
|
-
const filterSensitiveLog: (obj: UpdateMaintenanceWindowRequest) => any;
|
|
8692
|
-
}
|