@aws-sdk/client-ssm 3.46.0 → 3.48.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 +38 -0
- package/README.md +5 -6
- package/dist-cjs/endpoints.js +0 -28
- package/dist-cjs/models/models_0.js +5 -384
- package/dist-cjs/models/models_1.js +5 -348
- package/dist-cjs/models/models_2.js +1 -13
- package/dist-cjs/protocols/Aws_json1_1.js +26 -0
- package/dist-cjs/runtimeConfig.browser.js +7 -2
- package/dist-cjs/runtimeConfig.js +10 -2
- package/dist-es/endpoints.js +0 -28
- package/dist-es/models/models_0.js +0 -252
- package/dist-es/models/models_1.js +0 -228
- package/dist-es/models/models_2.js +0 -8
- package/dist-es/protocols/Aws_json1_1.js +26 -0
- package/dist-es/runtimeConfig.browser.js +12 -3
- package/dist-es/runtimeConfig.js +13 -4
- package/dist-types/SSM.d.ts +48 -39
- package/dist-types/SSMClient.d.ts +10 -7
- package/dist-types/commands/CreateActivationCommand.d.ts +2 -2
- package/dist-types/commands/CreateAssociationBatchCommand.d.ts +3 -3
- package/dist-types/commands/DeleteAssociationCommand.d.ts +3 -3
- package/dist-types/commands/DescribeInstanceInformationCommand.d.ts +2 -2
- package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +2 -1
- package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +2 -2
- package/dist-types/commands/GetConnectionStatusCommand.d.ts +2 -2
- package/dist-types/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +2 -2
- package/dist-types/commands/GetInventoryCommand.d.ts +2 -2
- package/dist-types/commands/ListAssociationsCommand.d.ts +2 -2
- package/dist-types/commands/ListCommandInvocationsCommand.d.ts +5 -5
- package/dist-types/commands/PutInventoryCommand.d.ts +3 -2
- package/dist-types/commands/StartSessionCommand.d.ts +3 -3
- package/dist-types/commands/UpdateAssociationCommand.d.ts +10 -2
- package/dist-types/models/models_0.d.ts +71 -439
- package/dist-types/models/models_1.d.ts +87 -422
- package/dist-types/models/models_2.d.ts +0 -12
- package/dist-types/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/runtimeConfig.d.ts +4 -3
- package/dist-types/runtimeConfig.native.d.ts +1 -0
- package/dist-types/ts3.4/SSMClient.d.ts +3 -1
- package/dist-types/ts3.4/models/models_0.d.ts +4 -252
- package/dist-types/ts3.4/models/models_1.d.ts +0 -228
- package/dist-types/ts3.4/models/models_2.d.ts +0 -8
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +3 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +4 -3
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -0
- package/package.json +36 -36
package/dist-types/SSM.d.ts
CHANGED
|
@@ -140,14 +140,13 @@ import { SSMClient } from "./SSMClient";
|
|
|
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
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
|
-
*
|
|
145
|
-
* Systems Manager. </p>
|
|
143
|
+
* <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises
|
|
144
|
+
* server or virtual machine (VM) that has been configured for Systems Manager. </p>
|
|
146
145
|
* <note>
|
|
147
|
-
* <p>With support for IoT Greengrass
|
|
146
|
+
* <p>With support for IoT Greengrass core devices, the phrase <i>managed
|
|
148
147
|
* instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
|
|
149
|
-
* documentation. The Systems Manager console, API
|
|
150
|
-
*
|
|
148
|
+
* documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the
|
|
149
|
+
* term <i>instance</i>.</p>
|
|
151
150
|
* </note>
|
|
152
151
|
* <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>
|
|
153
152
|
* <p>To get started, verify prerequisites and configure managed nodes. For more information, see
|
|
@@ -257,8 +256,8 @@ export declare class SSM extends SSMClient {
|
|
|
257
256
|
* 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
|
|
258
257
|
* Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
|
|
259
258
|
* <note>
|
|
260
|
-
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
|
|
261
|
-
* nodes</i>.</p>
|
|
259
|
+
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
|
|
260
|
+
* configured for Systems Manager are all called <i>managed nodes</i>.</p>
|
|
262
261
|
* </note>
|
|
263
262
|
*/
|
|
264
263
|
createActivation(args: CreateActivationCommandInput, options?: __HttpHandlerOptions): Promise<CreateActivationCommandOutput>;
|
|
@@ -282,9 +281,9 @@ export declare class SSM extends SSMClient {
|
|
|
282
281
|
/**
|
|
283
282
|
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes
|
|
284
283
|
* or targets.</p>
|
|
285
|
-
* <p>When you associate a document with one or more managed nodes using IDs or tags,
|
|
286
|
-
*
|
|
287
|
-
*
|
|
284
|
+
* <p>When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager
|
|
285
|
+
* Agent (SSM Agent) running on the managed node processes the document and configures the node as
|
|
286
|
+
* specified.</p>
|
|
288
287
|
* <p>If you associate a document with a managed node that already has an associated document, the
|
|
289
288
|
* system returns the AssociationAlreadyExists exception.</p>
|
|
290
289
|
*/
|
|
@@ -377,9 +376,9 @@ export declare class SSM extends SSMClient {
|
|
|
377
376
|
deleteActivation(args: DeleteActivationCommandInput, cb: (err: any, data?: DeleteActivationCommandOutput) => void): void;
|
|
378
377
|
deleteActivation(args: DeleteActivationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteActivationCommandOutput) => void): void;
|
|
379
378
|
/**
|
|
380
|
-
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
|
|
381
|
-
* If you created the association by using the <code>Targets</code> parameter, then you must
|
|
382
|
-
* the association by using the association ID.</p>
|
|
379
|
+
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
|
|
380
|
+
* node. If you created the association by using the <code>Targets</code> parameter, then you must
|
|
381
|
+
* delete the association by using the association ID.</p>
|
|
383
382
|
* <p>When you disassociate a document from a managed node, it doesn't change the configuration of
|
|
384
383
|
* the node. To change the configuration state of a managed node after you disassociate a document,
|
|
385
384
|
* you must create a new document with the desired configuration and associate it with the
|
|
@@ -554,8 +553,8 @@ export declare class SSM extends SSMClient {
|
|
|
554
553
|
* <p>Describes one or more of your managed nodes, including information about the operating
|
|
555
554
|
* system platform, the version of SSM Agent installed on the managed node, node status, and so
|
|
556
555
|
* on.</p>
|
|
557
|
-
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
|
|
558
|
-
* you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
556
|
+
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
|
|
557
|
+
* If you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
559
558
|
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
|
|
560
559
|
* <note>
|
|
561
560
|
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
|
|
@@ -567,8 +566,8 @@ export declare class SSM extends SSMClient {
|
|
|
567
566
|
describeInstanceInformation(args: DescribeInstanceInformationCommandInput, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void): void;
|
|
568
567
|
describeInstanceInformation(args: DescribeInstanceInformationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstanceInformationCommandOutput) => void): void;
|
|
569
568
|
/**
|
|
570
|
-
* <p>Retrieves information about the patches on the specified managed node and their state
|
|
571
|
-
* to the patch baseline being used for the node.</p>
|
|
569
|
+
* <p>Retrieves information about the patches on the specified managed node and their state
|
|
570
|
+
* relative to the patch baseline being used for the node.</p>
|
|
572
571
|
*/
|
|
573
572
|
describeInstancePatches(args: DescribeInstancePatchesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancePatchesCommandOutput>;
|
|
574
573
|
describeInstancePatches(args: DescribeInstancePatchesCommandInput, cb: (err: any, data?: DescribeInstancePatchesCommandOutput) => void): void;
|
|
@@ -580,7 +579,8 @@ export declare class SSM extends SSMClient {
|
|
|
580
579
|
describeInstancePatchStates(args: DescribeInstancePatchStatesCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void): void;
|
|
581
580
|
describeInstancePatchStates(args: DescribeInstancePatchStatesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancePatchStatesCommandOutput) => void): void;
|
|
582
581
|
/**
|
|
583
|
-
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch
|
|
582
|
+
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch
|
|
583
|
+
* group.</p>
|
|
584
584
|
*/
|
|
585
585
|
describeInstancePatchStatesForPatchGroup(args: DescribeInstancePatchStatesForPatchGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancePatchStatesForPatchGroupCommandOutput>;
|
|
586
586
|
describeInstancePatchStatesForPatchGroup(args: DescribeInstancePatchStatesForPatchGroupCommandInput, cb: (err: any, data?: DescribeInstancePatchStatesForPatchGroupCommandOutput) => void): void;
|
|
@@ -811,8 +811,8 @@ export declare class SSM extends SSMClient {
|
|
|
811
811
|
getCommandInvocation(args: GetCommandInvocationCommandInput, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void): void;
|
|
812
812
|
getCommandInvocation(args: GetCommandInvocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCommandInvocationCommandOutput) => void): void;
|
|
813
813
|
/**
|
|
814
|
-
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running
|
|
815
|
-
* ready to receive Session Manager connections.</p>
|
|
814
|
+
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running
|
|
815
|
+
* and ready to receive Session Manager connections.</p>
|
|
816
816
|
*/
|
|
817
817
|
getConnectionStatus(args: GetConnectionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetConnectionStatusCommandOutput>;
|
|
818
818
|
getConnectionStatus(args: GetConnectionStatusCommandInput, cb: (err: any, data?: GetConnectionStatusCommandOutput) => void): void;
|
|
@@ -832,8 +832,8 @@ export declare class SSM extends SSMClient {
|
|
|
832
832
|
* <note>
|
|
833
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
|
|
834
834
|
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
|
|
835
|
-
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
|
|
836
|
-
* For example, run the command using the <code>AWS-RunShellScript</code> document or the
|
|
835
|
+
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
|
|
836
|
+
* command. For example, run the command using the <code>AWS-RunShellScript</code> document or the
|
|
837
837
|
* <code>AWS-RunPowerShellScript</code> document.</p>
|
|
838
838
|
* </note>
|
|
839
839
|
*/
|
|
@@ -847,8 +847,8 @@ export declare class SSM extends SSMClient {
|
|
|
847
847
|
getDocument(args: GetDocumentCommandInput, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
848
848
|
getDocument(args: GetDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDocumentCommandOutput) => void): void;
|
|
849
849
|
/**
|
|
850
|
-
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code>
|
|
851
|
-
*
|
|
850
|
+
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code>
|
|
851
|
+
* or <code>Terminated</code>.</p>
|
|
852
852
|
*/
|
|
853
853
|
getInventory(args: GetInventoryCommandInput, options?: __HttpHandlerOptions): Promise<GetInventoryCommandOutput>;
|
|
854
854
|
getInventory(args: GetInventoryCommandInput, cb: (err: any, data?: GetInventoryCommandOutput) => void): void;
|
|
@@ -1042,8 +1042,8 @@ export declare class SSM extends SSMClient {
|
|
|
1042
1042
|
labelParameterVersion(args: LabelParameterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: LabelParameterVersionCommandOutput) => void): void;
|
|
1043
1043
|
/**
|
|
1044
1044
|
* <p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You
|
|
1045
|
-
* can limit the results to a specific State Manager association document or managed node by
|
|
1046
|
-
* a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
|
|
1045
|
+
* can limit the results to a specific State Manager association document or managed node by
|
|
1046
|
+
* specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
|
|
1047
1047
|
*/
|
|
1048
1048
|
listAssociations(args: ListAssociationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAssociationsCommandOutput>;
|
|
1049
1049
|
listAssociations(args: ListAssociationsCommandInput, cb: (err: any, data?: ListAssociationsCommandOutput) => void): void;
|
|
@@ -1055,11 +1055,11 @@ export declare class SSM extends SSMClient {
|
|
|
1055
1055
|
listAssociationVersions(args: ListAssociationVersionsCommandInput, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void): void;
|
|
1056
1056
|
listAssociationVersions(args: ListAssociationVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAssociationVersionsCommandOutput) => void): void;
|
|
1057
1057
|
/**
|
|
1058
|
-
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to
|
|
1059
|
-
* or more managed nodes. A command invocation applies to one managed node. For example, if a
|
|
1060
|
-
*
|
|
1061
|
-
* each requested managed node ID. <code>ListCommandInvocations</code> provide status
|
|
1062
|
-
* execution.</p>
|
|
1058
|
+
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to
|
|
1059
|
+
* one or more managed nodes. A command invocation applies to one managed node. For example, if a
|
|
1060
|
+
* user runs <code>SendCommand</code> against three managed nodes, then a command invocation is
|
|
1061
|
+
* created for each requested managed node ID. <code>ListCommandInvocations</code> provide status
|
|
1062
|
+
* about command execution.</p>
|
|
1063
1063
|
*/
|
|
1064
1064
|
listCommandInvocations(args: ListCommandInvocationsCommandInput, options?: __HttpHandlerOptions): Promise<ListCommandInvocationsCommandOutput>;
|
|
1065
1065
|
listCommandInvocations(args: ListCommandInvocationsCommandInput, cb: (err: any, data?: ListCommandInvocationsCommandOutput) => void): void;
|
|
@@ -1232,8 +1232,9 @@ export declare class SSM extends SSMClient {
|
|
|
1232
1232
|
putComplianceItems(args: PutComplianceItemsCommandInput, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void): void;
|
|
1233
1233
|
putComplianceItems(args: PutComplianceItemsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutComplianceItemsCommandOutput) => void): void;
|
|
1234
1234
|
/**
|
|
1235
|
-
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an
|
|
1236
|
-
* if it doesn't already exist, or updates an inventory item, if it does
|
|
1235
|
+
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an
|
|
1236
|
+
* inventory item, if it doesn't already exist, or updates an inventory item, if it does
|
|
1237
|
+
* exist.</p>
|
|
1237
1238
|
*/
|
|
1238
1239
|
putInventory(args: PutInventoryCommandInput, options?: __HttpHandlerOptions): Promise<PutInventoryCommandOutput>;
|
|
1239
1240
|
putInventory(args: PutInventoryCommandInput, cb: (err: any, data?: PutInventoryCommandOutput) => void): void;
|
|
@@ -1344,9 +1345,9 @@ export declare class SSM extends SSMClient {
|
|
|
1344
1345
|
startChangeRequestExecution(args: StartChangeRequestExecutionCommandInput, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void): void;
|
|
1345
1346
|
startChangeRequestExecution(args: StartChangeRequestExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartChangeRequestExecutionCommandOutput) => void): void;
|
|
1346
1347
|
/**
|
|
1347
|
-
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
|
1348
|
-
* URL and token that can be used to open a WebSocket connection for sending input and
|
|
1349
|
-
* outputs.</p>
|
|
1348
|
+
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
|
1349
|
+
* Returns a URL and token that can be used to open a WebSocket connection for sending input and
|
|
1350
|
+
* receiving outputs.</p>
|
|
1350
1351
|
* <note>
|
|
1351
1352
|
* <p>Amazon Web Services CLI usage: <code>start-session</code> is an interactive command that requires the Session Manager
|
|
1352
1353
|
* plugin to be installed on the client machine making the call. For information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html">Install
|
|
@@ -1379,7 +1380,14 @@ export declare class SSM extends SSMClient {
|
|
|
1379
1380
|
unlabelParameterVersion(args: UnlabelParameterVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UnlabelParameterVersionCommandOutput) => void): void;
|
|
1380
1381
|
/**
|
|
1381
1382
|
* <p>Updates an association. You can update the association name and version, the document
|
|
1382
|
-
* version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
|
|
1383
|
+
* version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you
|
|
1384
|
+
* call <code>UpdateAssociation</code>, the system drops all optional parameters from the request
|
|
1385
|
+
* and overwrites the association with null values for those parameters. This is by design. You must
|
|
1386
|
+
* specify all optional parameters in the call, even if you are not changing the parameters. This
|
|
1387
|
+
* includes the <code>Name</code> parameter. Before calling this API action, we recommend that you
|
|
1388
|
+
* call the <a>DescribeAssociation</a> API operation and make a note of all optional
|
|
1389
|
+
* parameters required for your <code>UpdateAssociation</code> call.</p>
|
|
1390
|
+
*
|
|
1383
1391
|
* <p>In order to call this API operation, your Identity and Access Management (IAM) user
|
|
1384
1392
|
* account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call
|
|
1385
1393
|
* <code>DescribeAssociation</code>, then you receive the following error: <code>An error occurred
|
|
@@ -1389,7 +1397,8 @@ export declare class SSM extends SSMClient {
|
|
|
1389
1397
|
* </p>
|
|
1390
1398
|
* <important>
|
|
1391
1399
|
* <p>When you update an association, the association immediately runs against the specified
|
|
1392
|
-
* targets
|
|
1400
|
+
* targets. You can add the <code>ApplyOnlyAtCronInterval</code> parameter to run the association
|
|
1401
|
+
* during the next schedule run.</p>
|
|
1393
1402
|
* </important>
|
|
1394
1403
|
*/
|
|
1395
1404
|
updateAssociation(args: UpdateAssociationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAssociationCommandOutput>;
|
|
@@ -4,7 +4,7 @@ import { RetryInputConfig, RetryResolvedConfig } from "@aws-sdk/middleware-retry
|
|
|
4
4
|
import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-signing";
|
|
5
5
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
6
6
|
import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
|
|
7
|
-
import { Client as __Client, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
7
|
+
import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
|
|
8
8
|
import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
|
|
9
9
|
import { AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput } from "./commands/AddTagsToResourceCommand";
|
|
10
10
|
import { AssociateOpsItemRelatedItemCommandInput, AssociateOpsItemRelatedItemCommandOutput } from "./commands/AssociateOpsItemRelatedItemCommand";
|
|
@@ -243,6 +243,10 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
243
243
|
* @internal
|
|
244
244
|
*/
|
|
245
245
|
defaultUserAgentProvider?: Provider<__UserAgent>;
|
|
246
|
+
/**
|
|
247
|
+
* The {@link DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
248
|
+
*/
|
|
249
|
+
defaultsMode?: DefaultsMode | Provider<DefaultsMode>;
|
|
246
250
|
}
|
|
247
251
|
declare type SSMClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointsInputConfig & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig;
|
|
248
252
|
/**
|
|
@@ -261,14 +265,13 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {
|
|
|
261
265
|
* collecting system inventory, applying operating system (OS) patches, automating the creation of
|
|
262
266
|
* Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
|
|
263
267
|
* 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
|
-
*
|
|
266
|
-
* Systems Manager. </p>
|
|
268
|
+
* <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises
|
|
269
|
+
* server or virtual machine (VM) that has been configured for Systems Manager. </p>
|
|
267
270
|
* <note>
|
|
268
|
-
* <p>With support for IoT Greengrass
|
|
271
|
+
* <p>With support for IoT Greengrass core devices, the phrase <i>managed
|
|
269
272
|
* instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
|
|
270
|
-
* documentation. The Systems Manager console, API
|
|
271
|
-
*
|
|
273
|
+
* documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the
|
|
274
|
+
* term <i>instance</i>.</p>
|
|
272
275
|
* </note>
|
|
273
276
|
* <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>
|
|
274
277
|
* <p>To get started, verify prerequisites and configure managed nodes. For more information, see
|
|
@@ -14,8 +14,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
|
|
|
14
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>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
|
|
18
|
-
* nodes</i>.</p>
|
|
17
|
+
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
|
|
18
|
+
* configured for Systems Manager are all called <i>managed 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.
|
|
@@ -9,9 +9,9 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Associates the specified Amazon Web Services Systems Manager document (SSM document) with the specified managed nodes
|
|
11
11
|
* or targets.</p>
|
|
12
|
-
* <p>When you associate a document with one or more managed nodes using IDs or tags,
|
|
13
|
-
*
|
|
14
|
-
*
|
|
12
|
+
* <p>When you associate a document with one or more managed nodes using IDs or tags, Amazon Web Services Systems Manager
|
|
13
|
+
* Agent (SSM Agent) running on the managed node processes the document and configures the node as
|
|
14
|
+
* specified.</p>
|
|
15
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
|
|
@@ -7,9 +7,9 @@ export interface DeleteAssociationCommandInput extends DeleteAssociationRequest
|
|
|
7
7
|
export interface DeleteAssociationCommandOutput extends DeleteAssociationResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
|
|
11
|
-
* If you created the association by using the <code>Targets</code> parameter, then you must
|
|
12
|
-
* the association by using the association ID.</p>
|
|
10
|
+
* <p>Disassociates the specified Amazon Web Services Systems Manager document (SSM document) from the specified managed
|
|
11
|
+
* node. If you created the association by using the <code>Targets</code> parameter, then you must
|
|
12
|
+
* delete the association by using the association ID.</p>
|
|
13
13
|
* <p>When you disassociate a document from a managed node, it doesn't change the configuration of
|
|
14
14
|
* the node. To change the configuration state of a managed node after you disassociate a document,
|
|
15
15
|
* you must create a new document with the desired configuration and associate it with the
|
|
@@ -10,8 +10,8 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan
|
|
|
10
10
|
* <p>Describes one or more of your managed nodes, including information about the operating
|
|
11
11
|
* system platform, the version of SSM Agent installed on the managed node, node status, and so
|
|
12
12
|
* on.</p>
|
|
13
|
-
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
|
|
14
|
-
* you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
13
|
+
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes.
|
|
14
|
+
* If you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
15
15
|
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
|
|
16
16
|
* <note>
|
|
17
17
|
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
|
|
@@ -7,7 +7,8 @@ export interface DescribeInstancePatchStatesForPatchGroupCommandInput extends De
|
|
|
7
7
|
export interface DescribeInstancePatchStatesForPatchGroupCommandOutput extends DescribeInstancePatchStatesForPatchGroupResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch
|
|
10
|
+
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch
|
|
11
|
+
* group.</p>
|
|
11
12
|
* @example
|
|
12
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
14
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface DescribeInstancePatchesCommandInput extends DescribeInstancePat
|
|
|
7
7
|
export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePatchesResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves information about the patches on the specified managed node and their state
|
|
11
|
-
* to the patch baseline being used for the node.</p>
|
|
10
|
+
* <p>Retrieves information about the patches on the specified managed node and their state
|
|
11
|
+
* relative to the patch baseline being used for the node.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -7,8 +7,8 @@ export interface GetConnectionStatusCommandInput extends GetConnectionStatusRequ
|
|
|
7
7
|
export interface GetConnectionStatusCommandOutput extends GetConnectionStatusResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running
|
|
11
|
-
* ready to receive Session Manager connections.</p>
|
|
10
|
+
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running
|
|
11
|
+
* and ready to receive Session Manager connections.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -12,8 +12,8 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput extends GetD
|
|
|
12
12
|
* <note>
|
|
13
13
|
* <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
|
|
14
14
|
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
|
|
15
|
-
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
|
|
16
|
-
* For example, run the command using the <code>AWS-RunShellScript</code> document or the
|
|
15
|
+
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
|
|
16
|
+
* command. For example, run the command using the <code>AWS-RunShellScript</code> document or the
|
|
17
17
|
* <code>AWS-RunPowerShellScript</code> document.</p>
|
|
18
18
|
* </note>
|
|
19
19
|
* @example
|
|
@@ -8,8 +8,8 @@ export interface GetInventoryCommandInput extends GetInventoryRequest {
|
|
|
8
8
|
export interface GetInventoryCommandOutput extends GetInventoryResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code>
|
|
12
|
-
*
|
|
11
|
+
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code>
|
|
12
|
+
* or <code>Terminated</code>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,8 +8,8 @@ export interface ListAssociationsCommandOutput extends ListAssociationsResult, _
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You
|
|
11
|
-
* can limit the results to a specific State Manager association document or managed node by
|
|
12
|
-
* a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
|
|
11
|
+
* can limit the results to a specific State Manager association document or managed node by
|
|
12
|
+
* specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -7,11 +7,11 @@ export interface ListCommandInvocationsCommandInput extends ListCommandInvocatio
|
|
|
7
7
|
export interface ListCommandInvocationsCommandOutput extends ListCommandInvocationsResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to
|
|
11
|
-
* or more managed nodes. A command invocation applies to one managed node. For example, if a
|
|
12
|
-
*
|
|
13
|
-
* each requested managed node ID. <code>ListCommandInvocations</code> provide status
|
|
14
|
-
* execution.</p>
|
|
10
|
+
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to
|
|
11
|
+
* one or more managed nodes. A command invocation applies to one managed node. For example, if a
|
|
12
|
+
* user runs <code>SendCommand</code> against three managed nodes, then a command invocation is
|
|
13
|
+
* created for each requested managed node ID. <code>ListCommandInvocations</code> provide status
|
|
14
|
+
* about command execution.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
17
|
* ```javascript
|
|
@@ -7,8 +7,9 @@ export interface PutInventoryCommandInput extends PutInventoryRequest {
|
|
|
7
7
|
export interface PutInventoryCommandOutput extends PutInventoryResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an
|
|
11
|
-
* if it doesn't already exist, or updates an inventory item, if it does
|
|
10
|
+
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an
|
|
11
|
+
* inventory item, if it doesn't already exist, or updates an inventory item, if it does
|
|
12
|
+
* exist.</p>
|
|
12
13
|
* @example
|
|
13
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
15
|
* ```javascript
|
|
@@ -7,9 +7,9 @@ export interface StartSessionCommandInput extends StartSessionRequest {
|
|
|
7
7
|
export interface StartSessionCommandOutput extends StartSessionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
|
11
|
-
* URL and token that can be used to open a WebSocket connection for sending input and
|
|
12
|
-
* outputs.</p>
|
|
10
|
+
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session.
|
|
11
|
+
* Returns a URL and token that can be used to open a WebSocket connection for sending input and
|
|
12
|
+
* receiving outputs.</p>
|
|
13
13
|
* <note>
|
|
14
14
|
* <p>Amazon Web Services CLI usage: <code>start-session</code> is an interactive command that requires the Session Manager
|
|
15
15
|
* plugin to be installed on the client machine making the call. For information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html">Install
|
|
@@ -8,7 +8,14 @@ export interface UpdateAssociationCommandOutput extends UpdateAssociationResult,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates an association. You can update the association name and version, the document
|
|
11
|
-
* version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output.
|
|
11
|
+
* version, schedule, parameters, and Amazon Simple Storage Service (Amazon S3) output. When you
|
|
12
|
+
* call <code>UpdateAssociation</code>, the system drops all optional parameters from the request
|
|
13
|
+
* and overwrites the association with null values for those parameters. This is by design. You must
|
|
14
|
+
* specify all optional parameters in the call, even if you are not changing the parameters. This
|
|
15
|
+
* includes the <code>Name</code> parameter. Before calling this API action, we recommend that you
|
|
16
|
+
* call the <a>DescribeAssociation</a> API operation and make a note of all optional
|
|
17
|
+
* parameters required for your <code>UpdateAssociation</code> call.</p>
|
|
18
|
+
*
|
|
12
19
|
* <p>In order to call this API operation, your Identity and Access Management (IAM) user
|
|
13
20
|
* account, group, or role must be configured with permission to call the <a>DescribeAssociation</a> API operation. If you don't have permission to call
|
|
14
21
|
* <code>DescribeAssociation</code>, then you receive the following error: <code>An error occurred
|
|
@@ -18,7 +25,8 @@ export interface UpdateAssociationCommandOutput extends UpdateAssociationResult,
|
|
|
18
25
|
* </p>
|
|
19
26
|
* <important>
|
|
20
27
|
* <p>When you update an association, the association immediately runs against the specified
|
|
21
|
-
* targets
|
|
28
|
+
* targets. You can add the <code>ApplyOnlyAtCronInterval</code> parameter to run the association
|
|
29
|
+
* during the next schedule run.</p>
|
|
22
30
|
* </important>
|
|
23
31
|
* @example
|
|
24
32
|
* Use a bare-bones client and the command you need to make an API call.
|