@aws-sdk/client-ssm 3.40.0 → 3.44.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 +49 -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 +16 -0
- package/dist-cjs/models/models_0.js +43 -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 +33 -0
- package/dist-es/commands/UpdateDocumentMetadataCommand.js +2 -1
- package/dist-es/commands/UpdateMaintenanceWindowCommand.js +1 -2
- package/dist-es/endpoints.js +16 -0
- package/dist-es/models/models_0.js +32 -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 +43 -15
- package/dist-types/SSM.d.ts +87 -81
- package/dist-types/SSMClient.d.ts +12 -6
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +6 -6
- package/dist-types/commands/AssociateOpsItemRelatedItemCommand.d.ts +1 -1
- package/dist-types/commands/CancelCommandCommand.d.ts +1 -1
- package/dist-types/commands/CancelMaintenanceWindowExecutionCommand.d.ts +1 -1
- package/dist-types/commands/CreateActivationCommand.d.ts +7 -7
- package/dist-types/commands/CreateAssociationBatchCommand.d.ts +7 -7
- package/dist-types/commands/CreateAssociationCommand.d.ts +11 -11
- package/dist-types/commands/CreateDocumentCommand.d.ts +2 -2
- package/dist-types/commands/CreateMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/CreateOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/CreateOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/CreatePatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/CreateResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/commands/DeleteActivationCommand.d.ts +3 -4
- package/dist-types/commands/DeleteAssociationCommand.d.ts +5 -5
- package/dist-types/commands/DeleteDocumentCommand.d.ts +3 -3
- package/dist-types/commands/DeleteInventoryCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/DeleteOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/DeleteParameterCommand.d.ts +1 -1
- package/dist-types/commands/DeleteParametersCommand.d.ts +1 -1
- package/dist-types/commands/DeletePatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceDataSyncCommand.d.ts +3 -3
- package/dist-types/commands/DeregisterManagedInstanceCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterTargetFromMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/DeregisterTaskFromMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActivationsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAssociationCommand.d.ts +2 -2
- package/dist-types/commands/DescribeAssociationExecutionTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssociationExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAutomationExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAutomationStepExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAvailablePatchesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDocumentCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDocumentPermissionCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEffectiveInstanceAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeEffectivePatchesForPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceAssociationsStatusCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstanceInformationCommand.d.ts +8 -7
- package/dist-types/commands/DescribeInstancePatchStatesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeInventoryDeletionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowExecutionTaskInvocationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowExecutionTasksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowExecutionsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowScheduleCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowTargetsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowTasksCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeMaintenanceWindowsForTargetCommand.d.ts +2 -2
- package/dist-types/commands/DescribeOpsItemsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeParametersCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchBaselinesCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchGroupStateCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchGroupsCommand.d.ts +1 -1
- package/dist-types/commands/DescribePatchPropertiesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeSessionsCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateOpsItemRelatedItemCommand.d.ts +1 -1
- package/dist-types/commands/GetAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetCalendarStateCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandInvocationCommand.d.ts +3 -3
- package/dist-types/commands/GetConnectionStatusCommand.d.ts +2 -2
- package/dist-types/commands/GetDefaultPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +3 -3
- package/dist-types/commands/GetDocumentCommand.d.ts +1 -1
- package/dist-types/commands/GetInventoryCommand.d.ts +2 -2
- package/dist-types/commands/GetInventorySchemaCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionTaskCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowExecutionTaskInvocationCommand.d.ts +1 -1
- package/dist-types/commands/GetMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/GetOpsSummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetParameterCommand.d.ts +1 -1
- package/dist-types/commands/GetParameterHistoryCommand.d.ts +1 -1
- package/dist-types/commands/GetParametersByPathCommand.d.ts +1 -1
- package/dist-types/commands/GetParametersCommand.d.ts +1 -1
- package/dist-types/commands/GetPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/GetPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetServiceSettingCommand.d.ts +1 -1
- package/dist-types/commands/LabelParameterVersionCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociationVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListCommandInvocationsCommand.d.ts +5 -5
- package/dist-types/commands/ListCommandsCommand.d.ts +1 -1
- package/dist-types/commands/ListComplianceItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListComplianceSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ListDocumentMetadataHistoryCommand.d.ts +1 -1
- package/dist-types/commands/ListDocumentVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListInventoryEntriesCommand.d.ts +1 -1
- package/dist-types/commands/ListOpsItemEventsCommand.d.ts +1 -1
- package/dist-types/commands/ListOpsItemRelatedItemsCommand.d.ts +1 -1
- package/dist-types/commands/ListOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceComplianceSummariesCommand.d.ts +1 -1
- package/dist-types/commands/ListResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDocumentPermissionCommand.d.ts +1 -1
- package/dist-types/commands/PutComplianceItemsCommand.d.ts +2 -2
- package/dist-types/commands/PutInventoryCommand.d.ts +2 -2
- package/dist-types/commands/PutParameterCommand.d.ts +1 -1
- package/dist-types/commands/RegisterDefaultPatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/RegisterPatchBaselineForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTargetWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RegisterTaskWithMaintenanceWindowCommand.d.ts +1 -1
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +1 -1
- package/dist-types/commands/ResetServiceSettingCommand.d.ts +1 -1
- package/dist-types/commands/ResumeSessionCommand.d.ts +2 -2
- package/dist-types/commands/SendAutomationSignalCommand.d.ts +1 -1
- package/dist-types/commands/SendCommandCommand.d.ts +2 -2
- package/dist-types/commands/StartAssociationsOnceCommand.d.ts +1 -1
- package/dist-types/commands/StartAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/StartChangeRequestExecutionCommand.d.ts +1 -1
- package/dist-types/commands/StartSessionCommand.d.ts +2 -2
- package/dist-types/commands/StopAutomationExecutionCommand.d.ts +1 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +2 -2
- package/dist-types/commands/UnlabelParameterVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationStatusCommand.d.ts +2 -2
- package/dist-types/commands/UpdateDocumentCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentDefaultVersionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentMetadataCommand.d.ts +3 -2
- package/dist-types/commands/UpdateMaintenanceWindowCommand.d.ts +2 -3
- package/dist-types/commands/UpdateMaintenanceWindowTargetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMaintenanceWindowTaskCommand.d.ts +1 -1
- package/dist-types/commands/UpdateManagedInstanceRoleCommand.d.ts +3 -3
- package/dist-types/commands/UpdateOpsItemCommand.d.ts +1 -1
- package/dist-types/commands/UpdateOpsMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePatchBaselineCommand.d.ts +1 -1
- package/dist-types/commands/UpdateResourceDataSyncCommand.d.ts +1 -1
- package/dist-types/commands/UpdateServiceSettingCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +240 -273
- package/dist-types/models/models_1.d.ts +271 -280
- 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 +34 -44
- package/dist-types/ts3.4/models/models_1.d.ts +41 -39
- package/dist-types/ts3.4/models/models_2.d.ts +38 -0
- package/package.json +4 -4
package/dist-types/SSM.d.ts
CHANGED
|
@@ -139,13 +139,19 @@ import { SSMClient } from "./SSMClient";
|
|
|
139
139
|
* <p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
|
|
140
140
|
* collecting system inventory, applying operating system (OS) patches, automating the creation of
|
|
141
141
|
* Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
|
|
142
|
-
* Systems Manager lets you remotely and securely manage the configuration of your managed
|
|
143
|
-
* <i>managed
|
|
144
|
-
* on-premises server or virtual machine (VM)
|
|
145
|
-
*
|
|
142
|
+
* Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A
|
|
143
|
+
* <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge
|
|
144
|
+
* device, or on-premises server or virtual machine (VM) that has been configured for
|
|
145
|
+
* Systems Manager. </p>
|
|
146
|
+
* <note>
|
|
147
|
+
* <p>With support for IoT Greengrass Version 2 devices, the phrase <i>managed
|
|
148
|
+
* instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
|
|
149
|
+
* documentation. The Systems Manager console, API
|
|
150
|
+
* calls, error messages, and SSM documents still use the term instance.</p>
|
|
151
|
+
* </note>
|
|
146
152
|
* <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>.</p>
|
|
147
|
-
* <p>To get started, verify prerequisites and configure managed
|
|
148
|
-
*
|
|
153
|
+
* <p>To get started, verify prerequisites and configure managed nodes. For more information, see
|
|
154
|
+
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
|
|
149
155
|
* Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
150
156
|
* <p class="title">
|
|
151
157
|
* <b>Related resources</b>
|
|
@@ -172,11 +178,11 @@ import { SSMClient } from "./SSMClient";
|
|
|
172
178
|
export declare class SSM extends SSMClient {
|
|
173
179
|
/**
|
|
174
180
|
* <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
|
|
175
|
-
* can assign to your documents, managed
|
|
176
|
-
*
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
181
|
+
* can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and
|
|
182
|
+
* patch baselines. Tags enable you to categorize your resources in different ways, for example, by
|
|
183
|
+
* purpose, owner, or environment. Each tag consists of a key and an optional value, both of which
|
|
184
|
+
* you define. For example, you could define a set of tags for your account's managed nodes that
|
|
185
|
+
* helps you track each node's owner and stack level. For example:</p>
|
|
180
186
|
* <ul>
|
|
181
187
|
* <li>
|
|
182
188
|
* <p>
|
|
@@ -245,41 +251,41 @@ export declare class SSM extends SSMClient {
|
|
|
245
251
|
cancelMaintenanceWindowExecution(args: CancelMaintenanceWindowExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CancelMaintenanceWindowExecutionCommandOutput) => void): void;
|
|
246
252
|
/**
|
|
247
253
|
* <p>Generates an activation code and activation ID you can use to register your on-premises
|
|
248
|
-
*
|
|
249
|
-
* possible to manage them using Systems Manager capabilities. You use the activation code and
|
|
250
|
-
* installing SSM Agent on machines in your hybrid environment. For more information about
|
|
251
|
-
* requirements for managing on-premises
|
|
254
|
+
* servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
|
|
255
|
+
* Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
|
|
256
|
+
* ID when installing SSM Agent on machines in your hybrid environment. For more information about
|
|
257
|
+
* requirements for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting up
|
|
252
258
|
* Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
|
|
253
259
|
* <note>
|
|
254
|
-
* <p>
|
|
255
|
-
*
|
|
260
|
+
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called <i>managed
|
|
261
|
+
* nodes</i>.</p>
|
|
256
262
|
* </note>
|
|
257
263
|
*/
|
|
258
264
|
createActivation(args: CreateActivationCommandInput, options?: __HttpHandlerOptions): Promise<CreateActivationCommandOutput>;
|
|
259
265
|
createActivation(args: CreateActivationCommandInput, cb: (err: any, data?: CreateActivationCommandOutput) => void): void;
|
|
260
266
|
createActivation(args: CreateActivationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateActivationCommandOutput) => void): void;
|
|
261
267
|
/**
|
|
262
|
-
* <p>A State Manager association defines the state that you want to maintain on your
|
|
263
|
-
* For example, an association can specify that anti-virus software must be installed and
|
|
264
|
-
* your
|
|
265
|
-
* specifies a schedule for when the configuration is reapplied. For dynamic targets,
|
|
266
|
-
* Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
|
|
267
|
-
* applies the configuration when new
|
|
268
|
-
* specifies actions to take when applying the configuration. For example, an
|
|
269
|
-
* anti-virus software might run once a day. If the software isn't installed, then
|
|
270
|
-
* installs it. If the software is installed, but the service isn't running, then the
|
|
271
|
-
* might instruct State Manager to start the service. </p>
|
|
268
|
+
* <p>A State Manager association defines the state that you want to maintain on your managed
|
|
269
|
+
* nodes. For example, an association can specify that anti-virus software must be installed and
|
|
270
|
+
* running on your managed nodes, or that certain ports must be closed. For static targets, the
|
|
271
|
+
* association specifies a schedule for when the configuration is reapplied. For dynamic targets,
|
|
272
|
+
* such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
|
|
273
|
+
* Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The
|
|
274
|
+
* association also specifies actions to take when applying the configuration. For example, an
|
|
275
|
+
* association for anti-virus software might run once a day. If the software isn't installed, then
|
|
276
|
+
* State Manager installs it. If the software is installed, but the service isn't running, then the
|
|
277
|
+
* association might instruct State Manager to start the service. </p>
|
|
272
278
|
*/
|
|
273
279
|
createAssociation(args: CreateAssociationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAssociationCommandOutput>;
|
|
274
280
|
createAssociation(args: CreateAssociationCommandInput, cb: (err: any, data?: CreateAssociationCommandOutput) => void): void;
|
|
275
281
|
createAssociation(args: CreateAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssociationCommandOutput) => void): void;
|
|
276
282
|
/**
|
|
277
|
-
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified
|
|
278
|
-
* targets.</p>
|
|
279
|
-
* <p>When you associate a document with one or more
|
|
280
|
-
* Amazon Web Services Systems Manager Agent (SSM Agent) running on the
|
|
281
|
-
*
|
|
282
|
-
* <p>If you associate a document with
|
|
283
|
+
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes
|
|
284
|
+
* or targets.</p>
|
|
285
|
+
* <p>When you associate a document with one or more managed nodes using IDs or tags,
|
|
286
|
+
* Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the
|
|
287
|
+
* node as specified.</p>
|
|
288
|
+
* <p>If you associate a document with a managed node that already has an associated document, the
|
|
283
289
|
* system returns the AssociationAlreadyExists exception.</p>
|
|
284
290
|
*/
|
|
285
291
|
createAssociationBatch(args: CreateAssociationBatchCommandInput, options?: __HttpHandlerOptions): Promise<CreateAssociationBatchCommandOutput>;
|
|
@@ -287,7 +293,7 @@ export declare class SSM extends SSMClient {
|
|
|
287
293
|
createAssociationBatch(args: CreateAssociationBatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAssociationBatchCommandOutput) => void): void;
|
|
288
294
|
/**
|
|
289
295
|
* <p>Creates a Amazon Web Services Systems Manager (SSM document). An SSM document defines the actions that Systems Manager performs
|
|
290
|
-
* on your managed
|
|
296
|
+
* on your managed nodes. For more information about SSM documents, including information about
|
|
291
297
|
* supported schemas, features, and syntax, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-ssm-docs.html">Amazon Web Services Systems Manager Documents</a> in the
|
|
292
298
|
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
293
299
|
*/
|
|
@@ -364,29 +370,28 @@ export declare class SSM extends SSMClient {
|
|
|
364
370
|
createResourceDataSync(args: CreateResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateResourceDataSyncCommandOutput) => void): void;
|
|
365
371
|
/**
|
|
366
372
|
* <p>Deletes an activation. You aren't required to delete an activation. If you delete an
|
|
367
|
-
* activation, you can no longer use it to register additional managed
|
|
368
|
-
*
|
|
369
|
-
* instances.</p>
|
|
373
|
+
* activation, you can no longer use it to register additional managed nodes. Deleting an activation
|
|
374
|
+
* doesn't de-register managed nodes. You must manually de-register managed nodes.</p>
|
|
370
375
|
*/
|
|
371
376
|
deleteActivation(args: DeleteActivationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteActivationCommandOutput>;
|
|
372
377
|
deleteActivation(args: DeleteActivationCommandInput, cb: (err: any, data?: DeleteActivationCommandOutput) => void): void;
|
|
373
378
|
deleteActivation(args: DeleteActivationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivationCommandOutput) => void): void;
|
|
374
379
|
/**
|
|
375
|
-
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified
|
|
380
|
+
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed node.
|
|
376
381
|
* If you created the association by using the <code>Targets</code> parameter, then you must delete
|
|
377
382
|
* the association by using the association ID.</p>
|
|
378
|
-
* <p>When you disassociate a document from
|
|
379
|
-
* the
|
|
383
|
+
* <p>When you disassociate a document from a managed node, it doesn't change the configuration of
|
|
384
|
+
* the node. To change the configuration state of a managed node after you disassociate a document,
|
|
380
385
|
* you must create a new document with the desired configuration and associate it with the
|
|
381
|
-
*
|
|
386
|
+
* node.</p>
|
|
382
387
|
*/
|
|
383
388
|
deleteAssociation(args: DeleteAssociationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAssociationCommandOutput>;
|
|
384
389
|
deleteAssociation(args: DeleteAssociationCommandInput, cb: (err: any, data?: DeleteAssociationCommandOutput) => void): void;
|
|
385
390
|
deleteAssociation(args: DeleteAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAssociationCommandOutput) => void): void;
|
|
386
391
|
/**
|
|
387
|
-
* <p>Deletes the Amazon Web Services Systems Manager document (SSM document) and all
|
|
392
|
+
* <p>Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the
|
|
388
393
|
* document.</p>
|
|
389
|
-
* <p>Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all
|
|
394
|
+
* <p>Before you delete the document, we recommend that you use <a>DeleteAssociation</a> to disassociate all managed nodes that are associated with the document.</p>
|
|
390
395
|
*/
|
|
391
396
|
deleteDocument(args: DeleteDocumentCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDocumentCommandOutput>;
|
|
392
397
|
deleteDocument(args: DeleteDocumentCommandInput, cb: (err: any, data?: DeleteDocumentCommandOutput) => void): void;
|
|
@@ -432,15 +437,15 @@ export declare class SSM extends SSMClient {
|
|
|
432
437
|
deletePatchBaseline(args: DeletePatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePatchBaselineCommandOutput) => void): void;
|
|
433
438
|
/**
|
|
434
439
|
* <p>Deletes a resource data sync configuration. After the configuration is deleted, changes to
|
|
435
|
-
* data on managed
|
|
436
|
-
*
|
|
440
|
+
* data on managed nodes are no longer synced to or from the target. Deleting a sync configuration
|
|
441
|
+
* doesn't delete data.</p>
|
|
437
442
|
*/
|
|
438
443
|
deleteResourceDataSync(args: DeleteResourceDataSyncCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceDataSyncCommandOutput>;
|
|
439
444
|
deleteResourceDataSync(args: DeleteResourceDataSyncCommandInput, cb: (err: any, data?: DeleteResourceDataSyncCommandOutput) => void): void;
|
|
440
445
|
deleteResourceDataSync(args: DeleteResourceDataSyncCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceDataSyncCommandOutput) => void): void;
|
|
441
446
|
/**
|
|
442
447
|
* <p>Removes the server or virtual machine from the list of registered servers. You can
|
|
443
|
-
* reregister the
|
|
448
|
+
* reregister the node again at any time. If you don't plan to use Run Command on the server, we
|
|
444
449
|
* suggest uninstalling SSM Agent first.</p>
|
|
445
450
|
*/
|
|
446
451
|
deregisterManagedInstance(args: DeregisterManagedInstanceCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterManagedInstanceCommandOutput>;
|
|
@@ -467,14 +472,14 @@ export declare class SSM extends SSMClient {
|
|
|
467
472
|
/**
|
|
468
473
|
* <p>Describes details about the activation, such as the date and time the activation was
|
|
469
474
|
* created, its expiration date, the Identity and Access Management (IAM) role assigned to
|
|
470
|
-
* the
|
|
475
|
+
* the managed nodes in the activation, and the number of nodes registered by using this
|
|
471
476
|
* activation.</p>
|
|
472
477
|
*/
|
|
473
478
|
describeActivations(args: DescribeActivationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeActivationsCommandOutput>;
|
|
474
479
|
describeActivations(args: DescribeActivationsCommandInput, cb: (err: any, data?: DescribeActivationsCommandOutput) => void): void;
|
|
475
480
|
describeActivations(args: DescribeActivationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeActivationsCommandOutput) => void): void;
|
|
476
481
|
/**
|
|
477
|
-
* <p>Describes the association for the specified target or
|
|
482
|
+
* <p>Describes the association for the specified target or managed node. If you created the
|
|
478
483
|
* association by using the <code>Targets</code> parameter, then you must retrieve the association
|
|
479
484
|
* by using the association ID.</p>
|
|
480
485
|
*/
|
|
@@ -527,7 +532,7 @@ export declare class SSM extends SSMClient {
|
|
|
527
532
|
describeDocumentPermission(args: DescribeDocumentPermissionCommandInput, cb: (err: any, data?: DescribeDocumentPermissionCommandOutput) => void): void;
|
|
528
533
|
describeDocumentPermission(args: DescribeDocumentPermissionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDocumentPermissionCommandOutput) => void): void;
|
|
529
534
|
/**
|
|
530
|
-
* <p>All associations for the
|
|
535
|
+
* <p>All associations for the managed node(s).</p>
|
|
531
536
|
*/
|
|
532
537
|
describeEffectiveInstanceAssociations(args: DescribeEffectiveInstanceAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEffectiveInstanceAssociationsCommandOutput>;
|
|
533
538
|
describeEffectiveInstanceAssociations(args: DescribeEffectiveInstanceAssociationsCommandInput, cb: (err: any, data?: DescribeEffectiveInstanceAssociationsCommandOutput) => void): void;
|
|
@@ -540,20 +545,21 @@ export declare class SSM extends SSMClient {
|
|
|
540
545
|
describeEffectivePatchesForPatchBaseline(args: DescribeEffectivePatchesForPatchBaselineCommandInput, cb: (err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void): void;
|
|
541
546
|
describeEffectivePatchesForPatchBaseline(args: DescribeEffectivePatchesForPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEffectivePatchesForPatchBaselineCommandOutput) => void): void;
|
|
542
547
|
/**
|
|
543
|
-
* <p>The status of the associations for the
|
|
548
|
+
* <p>The status of the associations for the managed node(s).</p>
|
|
544
549
|
*/
|
|
545
550
|
describeInstanceAssociationsStatus(args: DescribeInstanceAssociationsStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstanceAssociationsStatusCommandOutput>;
|
|
546
551
|
describeInstanceAssociationsStatus(args: DescribeInstanceAssociationsStatusCommandInput, cb: (err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void): void;
|
|
547
552
|
describeInstanceAssociationsStatus(args: DescribeInstanceAssociationsStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceAssociationsStatusCommandOutput) => void): void;
|
|
548
553
|
/**
|
|
549
|
-
* <p>Describes one or more of your
|
|
550
|
-
* platform, the version of SSM Agent installed on the
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
+
* <p>Describes one or more of your managed nodes, including information about the operating
|
|
555
|
+
* system platform, the version of SSM Agent installed on the managed node, node status, and so
|
|
556
|
+
* on.</p>
|
|
557
|
+
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes. If
|
|
558
|
+
* you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
559
|
+
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
|
|
554
560
|
* <note>
|
|
555
561
|
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
|
|
556
|
-
* (IAM) role assigned to on-premises
|
|
562
|
+
* (IAM) role assigned to on-premises managed nodes. This call doesn't return the
|
|
557
563
|
* IAM role for EC2 instances.</p>
|
|
558
564
|
* </note>
|
|
559
565
|
*/
|
|
@@ -561,20 +567,20 @@ export declare class SSM extends SSMClient {
|
|
|
561
567
|
describeInstanceInformation(args: DescribeInstanceInformationCommandInput, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void): void;
|
|
562
568
|
describeInstanceInformation(args: DescribeInstanceInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void): void;
|
|
563
569
|
/**
|
|
564
|
-
* <p>Retrieves information about the patches on the specified
|
|
565
|
-
* to the patch baseline being used for the
|
|
570
|
+
* <p>Retrieves information about the patches on the specified managed node and their state relative
|
|
571
|
+
* to the patch baseline being used for the node.</p>
|
|
566
572
|
*/
|
|
567
573
|
describeInstancePatches(args: DescribeInstancePatchesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancePatchesCommandOutput>;
|
|
568
574
|
describeInstancePatches(args: DescribeInstancePatchesCommandInput, cb: (err: any, data?: DescribeInstancePatchesCommandOutput) => void): void;
|
|
569
575
|
describeInstancePatches(args: DescribeInstancePatchesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchesCommandOutput) => void): void;
|
|
570
576
|
/**
|
|
571
|
-
* <p>Retrieves the high-level patch state of one or more
|
|
577
|
+
* <p>Retrieves the high-level patch state of one or more managed nodes.</p>
|
|
572
578
|
*/
|
|
573
579
|
describeInstancePatchStates(args: DescribeInstancePatchStatesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancePatchStatesCommandOutput>;
|
|
574
580
|
describeInstancePatchStates(args: DescribeInstancePatchStatesCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void): void;
|
|
575
581
|
describeInstancePatchStates(args: DescribeInstancePatchStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void): void;
|
|
576
582
|
/**
|
|
577
|
-
* <p>Retrieves the high-level patch state for the
|
|
583
|
+
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch group.</p>
|
|
578
584
|
*/
|
|
579
585
|
describeInstancePatchStatesForPatchGroup(args: DescribeInstancePatchStatesForPatchGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancePatchStatesForPatchGroupCommandOutput>;
|
|
580
586
|
describeInstancePatchStatesForPatchGroup(args: DescribeInstancePatchStatesForPatchGroupCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void): void;
|
|
@@ -619,7 +625,7 @@ export declare class SSM extends SSMClient {
|
|
|
619
625
|
describeMaintenanceWindowSchedule(args: DescribeMaintenanceWindowScheduleCommandInput, cb: (err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void): void;
|
|
620
626
|
describeMaintenanceWindowSchedule(args: DescribeMaintenanceWindowScheduleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMaintenanceWindowScheduleCommandOutput) => void): void;
|
|
621
627
|
/**
|
|
622
|
-
* <p>Retrieves information about the maintenance window targets or tasks that
|
|
628
|
+
* <p>Retrieves information about the maintenance window targets or tasks that a managed node is
|
|
623
629
|
* associated with.</p>
|
|
624
630
|
*/
|
|
625
631
|
describeMaintenanceWindowsForTarget(args: DescribeMaintenanceWindowsForTargetCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMaintenanceWindowsForTargetCommandOutput>;
|
|
@@ -798,14 +804,14 @@ export declare class SSM extends SSMClient {
|
|
|
798
804
|
* <p>Returns detailed information about command execution for an invocation or plugin.</p>
|
|
799
805
|
* <p>
|
|
800
806
|
* <code>GetCommandInvocation</code> only gives the execution status of a plugin in a document.
|
|
801
|
-
* To get the command execution status on a specific
|
|
802
|
-
*
|
|
807
|
+
* To get the command execution status on a specific managed node, use <a>ListCommandInvocations</a>. To get the command execution status across managed nodes,
|
|
808
|
+
* use <a>ListCommands</a>.</p>
|
|
803
809
|
*/
|
|
804
810
|
getCommandInvocation(args: GetCommandInvocationCommandInput, options?: __HttpHandlerOptions): Promise<GetCommandInvocationCommandOutput>;
|
|
805
811
|
getCommandInvocation(args: GetCommandInvocationCommandInput, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void): void;
|
|
806
812
|
getCommandInvocation(args: GetCommandInvocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void): void;
|
|
807
813
|
/**
|
|
808
|
-
* <p>Retrieves the Session Manager connection status for
|
|
814
|
+
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running and
|
|
809
815
|
* ready to receive Session Manager connections.</p>
|
|
810
816
|
*/
|
|
811
817
|
getConnectionStatus(args: GetConnectionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectionStatusCommandOutput>;
|
|
@@ -821,12 +827,12 @@ export declare class SSM extends SSMClient {
|
|
|
821
827
|
getDefaultPatchBaseline(args: GetDefaultPatchBaselineCommandInput, cb: (err: any, data?: GetDefaultPatchBaselineCommandOutput) => void): void;
|
|
822
828
|
getDefaultPatchBaseline(args: GetDefaultPatchBaselineCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDefaultPatchBaselineCommandOutput) => void): void;
|
|
823
829
|
/**
|
|
824
|
-
* <p>Retrieves the current snapshot for the patch baseline the
|
|
830
|
+
* <p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is
|
|
825
831
|
* primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>
|
|
826
832
|
* <note>
|
|
827
833
|
* <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid
|
|
828
834
|
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
|
|
829
|
-
* Amazon Web Services Systems Manager, with an SSM document that enables you to target
|
|
835
|
+
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command.
|
|
830
836
|
* For example, run the command using the <code>AWS-RunShellScript</code> document or the
|
|
831
837
|
* <code>AWS-RunPowerShellScript</code> document.</p>
|
|
832
838
|
* </note>
|
|
@@ -841,7 +847,7 @@ export declare class SSM extends SSMClient {
|
|
|
841
847
|
getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
842
848
|
getDocument(args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
843
849
|
/**
|
|
844
|
-
* <p>Query inventory information. This includes
|
|
850
|
+
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code> or
|
|
845
851
|
* <code>Terminated</code>.</p>
|
|
846
852
|
*/
|
|
847
853
|
getInventory(args: GetInventoryCommandInput, options?: __HttpHandlerOptions): Promise<GetInventoryCommandOutput>;
|
|
@@ -1036,7 +1042,7 @@ export declare class SSM extends SSMClient {
|
|
|
1036
1042
|
labelParameterVersion(args: LabelParameterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LabelParameterVersionCommandOutput) => void): void;
|
|
1037
1043
|
/**
|
|
1038
1044
|
* <p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You
|
|
1039
|
-
* can limit the results to a specific State Manager association document or
|
|
1045
|
+
* can limit the results to a specific State Manager association document or managed node by specifying
|
|
1040
1046
|
* a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
|
|
1041
1047
|
*/
|
|
1042
1048
|
listAssociations(args: ListAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssociationsCommandOutput>;
|
|
@@ -1049,10 +1055,10 @@ export declare class SSM extends SSMClient {
|
|
|
1049
1055
|
listAssociationVersions(args: ListAssociationVersionsCommandInput, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void): void;
|
|
1050
1056
|
listAssociationVersions(args: ListAssociationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void): void;
|
|
1051
1057
|
/**
|
|
1052
|
-
* <p>An invocation is copy of a command sent to a specific
|
|
1053
|
-
* or more
|
|
1054
|
-
* <code>SendCommand</code> against three
|
|
1055
|
-
* requested
|
|
1058
|
+
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to one
|
|
1059
|
+
* or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
|
|
1060
|
+
* <code>SendCommand</code> against three managed nodes, then a command invocation is created for
|
|
1061
|
+
* each requested managed node ID. <code>ListCommandInvocations</code> provide status about command
|
|
1056
1062
|
* execution.</p>
|
|
1057
1063
|
*/
|
|
1058
1064
|
listCommandInvocations(args: ListCommandInvocationsCommandInput, options?: __HttpHandlerOptions): Promise<ListCommandInvocationsCommandOutput>;
|
|
@@ -1180,7 +1186,7 @@ export declare class SSM extends SSMClient {
|
|
|
1180
1186
|
* </li>
|
|
1181
1187
|
* <li>
|
|
1182
1188
|
* <p>ExecutionTime. The time the patch, association, or custom compliance item was applied to
|
|
1183
|
-
* the
|
|
1189
|
+
* the managed node.</p>
|
|
1184
1190
|
* </li>
|
|
1185
1191
|
* <li>
|
|
1186
1192
|
* <p>Id: The patch, association, or custom compliance ID.</p>
|
|
@@ -1226,7 +1232,7 @@ export declare class SSM extends SSMClient {
|
|
|
1226
1232
|
putComplianceItems(args: PutComplianceItemsCommandInput, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void): void;
|
|
1227
1233
|
putComplianceItems(args: PutComplianceItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void): void;
|
|
1228
1234
|
/**
|
|
1229
|
-
* <p>Bulk update custom inventory items on one more
|
|
1235
|
+
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item,
|
|
1230
1236
|
* if it doesn't already exist, or updates an inventory item, if it does exist.</p>
|
|
1231
1237
|
*/
|
|
1232
1238
|
putInventory(args: PutInventoryCommandInput, options?: __HttpHandlerOptions): Promise<PutInventoryCommandOutput>;
|
|
@@ -1293,7 +1299,7 @@ export declare class SSM extends SSMClient {
|
|
|
1293
1299
|
resetServiceSetting(args: ResetServiceSettingCommandInput, cb: (err: any, data?: ResetServiceSettingCommandOutput) => void): void;
|
|
1294
1300
|
resetServiceSetting(args: ResetServiceSettingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResetServiceSettingCommandOutput) => void): void;
|
|
1295
1301
|
/**
|
|
1296
|
-
* <p>Reconnects a session to
|
|
1302
|
+
* <p>Reconnects a session to a managed node after it has been disconnected. Connections can be
|
|
1297
1303
|
* resumed for disconnected sessions, but not terminated sessions.</p>
|
|
1298
1304
|
* <note>
|
|
1299
1305
|
* <p>This command is primarily for use by client machines to automatically reconnect during
|
|
@@ -1311,7 +1317,7 @@ export declare class SSM extends SSMClient {
|
|
|
1311
1317
|
sendAutomationSignal(args: SendAutomationSignalCommandInput, cb: (err: any, data?: SendAutomationSignalCommandOutput) => void): void;
|
|
1312
1318
|
sendAutomationSignal(args: SendAutomationSignalCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendAutomationSignalCommandOutput) => void): void;
|
|
1313
1319
|
/**
|
|
1314
|
-
* <p>Runs commands on one or more managed
|
|
1320
|
+
* <p>Runs commands on one or more managed nodes.</p>
|
|
1315
1321
|
*/
|
|
1316
1322
|
sendCommand(args: SendCommandCommandInput, options?: __HttpHandlerOptions): Promise<SendCommandCommandOutput>;
|
|
1317
1323
|
sendCommand(args: SendCommandCommandInput, cb: (err: any, data?: SendCommandCommandOutput) => void): void;
|
|
@@ -1338,7 +1344,7 @@ export declare class SSM extends SSMClient {
|
|
|
1338
1344
|
startChangeRequestExecution(args: StartChangeRequestExecutionCommandInput, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void): void;
|
|
1339
1345
|
startChangeRequestExecution(args: StartChangeRequestExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void): void;
|
|
1340
1346
|
/**
|
|
1341
|
-
* <p>Initiates a connection to a target (for example,
|
|
1347
|
+
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a
|
|
1342
1348
|
* URL and token that can be used to open a WebSocket connection for sending input and receiving
|
|
1343
1349
|
* outputs.</p>
|
|
1344
1350
|
* <note>
|
|
@@ -1360,7 +1366,7 @@ export declare class SSM extends SSMClient {
|
|
|
1360
1366
|
stopAutomationExecution(args: StopAutomationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopAutomationExecutionCommandOutput) => void): void;
|
|
1361
1367
|
/**
|
|
1362
1368
|
* <p>Permanently ends a session and closes the data connection between the Session Manager client and
|
|
1363
|
-
* SSM Agent on the
|
|
1369
|
+
* SSM Agent on the managed node. A terminated session isn't be resumed.</p>
|
|
1364
1370
|
*/
|
|
1365
1371
|
terminateSession(args: TerminateSessionCommandInput, options?: __HttpHandlerOptions): Promise<TerminateSessionCommandOutput>;
|
|
1366
1372
|
terminateSession(args: TerminateSessionCommandInput, cb: (err: any, data?: TerminateSessionCommandOutput) => void): void;
|
|
@@ -1391,7 +1397,7 @@ export declare class SSM extends SSMClient {
|
|
|
1391
1397
|
updateAssociation(args: UpdateAssociationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAssociationCommandOutput) => void): void;
|
|
1392
1398
|
/**
|
|
1393
1399
|
* <p>Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified
|
|
1394
|
-
*
|
|
1400
|
+
* managed node.</p>
|
|
1395
1401
|
* <p>
|
|
1396
1402
|
* <code>UpdateAssociationStatus</code> is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to
|
|
1397
1403
|
* report status updates about your associations and is only used for associations created with the
|
|
@@ -1528,8 +1534,8 @@ export declare class SSM extends SSMClient {
|
|
|
1528
1534
|
updateMaintenanceWindowTask(args: UpdateMaintenanceWindowTaskCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMaintenanceWindowTaskCommandOutput) => void): void;
|
|
1529
1535
|
/**
|
|
1530
1536
|
* <p>Changes the Identity and Access Management (IAM) role that is assigned to the
|
|
1531
|
-
* on-premises
|
|
1532
|
-
* these hybrid
|
|
1537
|
+
* on-premises server, edge device, or virtual machines (VM). IAM roles are first
|
|
1538
|
+
* assigned to these hybrid nodes during the activation process. For more information, see <a>CreateActivation</a>.</p>
|
|
1533
1539
|
*/
|
|
1534
1540
|
updateManagedInstanceRole(args: UpdateManagedInstanceRoleCommandInput, options?: __HttpHandlerOptions): Promise<UpdateManagedInstanceRoleCommandOutput>;
|
|
1535
1541
|
updateManagedInstanceRole(args: UpdateManagedInstanceRoleCommandInput, cb: (err: any, data?: UpdateManagedInstanceRoleCommandOutput) => void): void;
|
|
@@ -260,13 +260,19 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {
|
|
|
260
260
|
* <p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
|
|
261
261
|
* collecting system inventory, applying operating system (OS) patches, automating the creation of
|
|
262
262
|
* Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
|
|
263
|
-
* Systems Manager lets you remotely and securely manage the configuration of your managed
|
|
264
|
-
* <i>managed
|
|
265
|
-
* on-premises server or virtual machine (VM)
|
|
266
|
-
*
|
|
263
|
+
* Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A
|
|
264
|
+
* <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge
|
|
265
|
+
* device, or on-premises server or virtual machine (VM) that has been configured for
|
|
266
|
+
* Systems Manager. </p>
|
|
267
|
+
* <note>
|
|
268
|
+
* <p>With support for IoT Greengrass Version 2 devices, the phrase <i>managed
|
|
269
|
+
* instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
|
|
270
|
+
* documentation. The Systems Manager console, API
|
|
271
|
+
* calls, error messages, and SSM documents still use the term instance.</p>
|
|
272
|
+
* </note>
|
|
267
273
|
* <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>.</p>
|
|
268
|
-
* <p>To get started, verify prerequisites and configure managed
|
|
269
|
-
*
|
|
274
|
+
* <p>To get started, verify prerequisites and configure managed nodes. For more information, see
|
|
275
|
+
* <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
|
|
270
276
|
* Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
|
|
271
277
|
* <p class="title">
|
|
272
278
|
* <b>Related resources</b>
|
|
@@ -8,11 +8,11 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
|
|
11
|
-
* can assign to your documents, managed
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
11
|
+
* can assign to your documents, managed nodes, maintenance windows, Parameter Store parameters, and
|
|
12
|
+
* patch baselines. Tags enable you to categorize your resources in different ways, for example, by
|
|
13
|
+
* purpose, owner, or environment. Each tag consists of a key and an optional value, both of which
|
|
14
|
+
* you define. For example, you could define a set of tags for your account's managed nodes that
|
|
15
|
+
* helps you track each node's owner and stack level. For example:</p>
|
|
16
16
|
* <ul>
|
|
17
17
|
* <li>
|
|
18
18
|
* <p>
|
|
@@ -64,7 +64,7 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
|
|
|
64
64
|
*
|
|
65
65
|
* @see {@link AddTagsToResourceCommandInput} for command's `input` shape.
|
|
66
66
|
* @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
|
|
67
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
67
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
*/
|
|
70
70
|
export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface AssociateOpsItemRelatedItemCommandOutput extends AssociateOpsIt
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link AssociateOpsItemRelatedItemCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link AssociateOpsItemRelatedItemCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class AssociateOpsItemRelatedItemCommand extends $Command<AssociateOpsItemRelatedItemCommandInput, AssociateOpsItemRelatedItemCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface CancelCommandCommandOutput extends CancelCommandResult, __Metad
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link CancelCommandCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link CancelCommandCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class CancelCommandCommand extends $Command<CancelCommandCommandInput, CancelCommandCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface CancelMaintenanceWindowExecutionCommandOutput extends CancelMai
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link CancelMaintenanceWindowExecutionCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link CancelMaintenanceWindowExecutionCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class CancelMaintenanceWindowExecutionCommand extends $Command<CancelMaintenanceWindowExecutionCommandInput, CancelMaintenanceWindowExecutionCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -8,14 +8,14 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Generates an activation code and activation ID you can use to register your on-premises
|
|
11
|
-
*
|
|
12
|
-
* possible to manage them using Systems Manager capabilities. You use the activation code and
|
|
13
|
-
* installing SSM Agent on machines in your hybrid environment. For more information about
|
|
14
|
-
* requirements for managing on-premises
|
|
11
|
+
* servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
|
|
12
|
+
* Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
|
|
13
|
+
* ID when installing SSM Agent on machines in your hybrid environment. For more information about
|
|
14
|
+
* requirements for managing on-premises machines using Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances.html">Setting up
|
|
15
15
|
* Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
|
|
16
16
|
* <note>
|
|
17
|
-
* <p>
|
|
18
|
-
*
|
|
17
|
+
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called <i>managed
|
|
18
|
+
* nodes</i>.</p>
|
|
19
19
|
* </note>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -29,7 +29,7 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
|
|
|
29
29
|
*
|
|
30
30
|
* @see {@link CreateActivationCommandInput} for command's `input` shape.
|
|
31
31
|
* @see {@link CreateActivationCommandOutput} for command's `response` shape.
|
|
32
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
export declare class CreateActivationCommand extends $Command<CreateActivationCommandInput, CreateActivationCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -7,12 +7,12 @@ export interface CreateAssociationBatchCommandInput extends CreateAssociationBat
|
|
|
7
7
|
export interface CreateAssociationBatchCommandOutput extends CreateAssociationBatchResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified
|
|
11
|
-
* targets.</p>
|
|
12
|
-
* <p>When you associate a document with one or more
|
|
13
|
-
* Amazon Web Services Systems Manager Agent (SSM Agent) running on the
|
|
14
|
-
*
|
|
15
|
-
* <p>If you associate a document with
|
|
10
|
+
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes
|
|
11
|
+
* or targets.</p>
|
|
12
|
+
* <p>When you associate a document with one or more managed nodes using IDs or tags,
|
|
13
|
+
* Amazon Web Services Systems Manager Agent (SSM Agent) running on the managed node processes the document and configures the
|
|
14
|
+
* node as specified.</p>
|
|
15
|
+
* <p>If you associate a document with a managed node that already has an associated document, the
|
|
16
16
|
* system returns the AssociationAlreadyExists exception.</p>
|
|
17
17
|
* @example
|
|
18
18
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,7 +26,7 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
|
|
|
26
26
|
*
|
|
27
27
|
* @see {@link CreateAssociationBatchCommandInput} for command's `input` shape.
|
|
28
28
|
* @see {@link CreateAssociationBatchCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
29
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
export declare class CreateAssociationBatchCommand extends $Command<CreateAssociationBatchCommandInput, CreateAssociationBatchCommandOutput, SSMClientResolvedConfig> {
|
|
@@ -7,16 +7,16 @@ export interface CreateAssociationCommandInput extends CreateAssociationRequest
|
|
|
7
7
|
export interface CreateAssociationCommandOutput extends CreateAssociationResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>A State Manager association defines the state that you want to maintain on your
|
|
11
|
-
* For example, an association can specify that anti-virus software must be installed and
|
|
12
|
-
* your
|
|
13
|
-
* specifies a schedule for when the configuration is reapplied. For dynamic targets,
|
|
14
|
-
* Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
|
|
15
|
-
* applies the configuration when new
|
|
16
|
-
* specifies actions to take when applying the configuration. For example, an
|
|
17
|
-
* anti-virus software might run once a day. If the software isn't installed, then
|
|
18
|
-
* installs it. If the software is installed, but the service isn't running, then the
|
|
19
|
-
* might instruct State Manager to start the service. </p>
|
|
10
|
+
* <p>A State Manager association defines the state that you want to maintain on your managed
|
|
11
|
+
* nodes. For example, an association can specify that anti-virus software must be installed and
|
|
12
|
+
* running on your managed nodes, or that certain ports must be closed. For static targets, the
|
|
13
|
+
* association specifies a schedule for when the configuration is reapplied. For dynamic targets,
|
|
14
|
+
* such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
|
|
15
|
+
* Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The
|
|
16
|
+
* association also specifies actions to take when applying the configuration. For example, an
|
|
17
|
+
* association for anti-virus software might run once a day. If the software isn't installed, then
|
|
18
|
+
* State Manager installs it. If the software is installed, but the service isn't running, then the
|
|
19
|
+
* association might instruct State Manager to start the service. </p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -29,7 +29,7 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
|
|
|
29
29
|
*
|
|
30
30
|
* @see {@link CreateAssociationCommandInput} for command's `input` shape.
|
|
31
31
|
* @see {@link CreateAssociationCommandOutput} for command's `response` shape.
|
|
32
|
-
* @see {@link SSMClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
export declare class CreateAssociationCommand extends $Command<CreateAssociationCommandInput, CreateAssociationCommandOutput, SSMClientResolvedConfig> {
|