@aws-sdk/client-ssm 3.43.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 +11 -0
- package/README.md +12 -6
- package/dist-cjs/commands/UpdateDocumentMetadataCommand.js +2 -1
- package/dist-cjs/models/models_0.js +9 -8
- package/dist-cjs/models/models_1.js +12 -12
- package/dist-cjs/models/models_2.js +7 -1
- package/dist-cjs/protocols/Aws_json1_1.js +2 -0
- package/dist-es/commands/UpdateDocumentMetadataCommand.js +2 -1
- package/dist-es/models/models_0.js +7 -6
- package/dist-es/models/models_1.js +6 -4
- package/dist-es/models/models_2.js +4 -0
- package/dist-es/protocols/Aws_json1_1.js +2 -0
- package/dist-types/SSM.d.ts +87 -81
- package/dist-types/SSMClient.d.ts +12 -6
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +5 -5
- package/dist-types/commands/CreateActivationCommand.d.ts +6 -6
- package/dist-types/commands/CreateAssociationBatchCommand.d.ts +6 -6
- package/dist-types/commands/CreateAssociationCommand.d.ts +10 -10
- package/dist-types/commands/CreateDocumentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteActivationCommand.d.ts +2 -3
- package/dist-types/commands/DeleteAssociationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDocumentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteResourceDataSyncCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterManagedInstanceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeActivationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEffectiveInstanceAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceAssociationsStatusCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstanceInformationCommand.d.ts +7 -6
- package/dist-types/commands/DescribeInstancePatchStatesCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchStatesForPatchGroupCommand.d.ts +1 -1
- package/dist-types/commands/DescribeInstancePatchesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeMaintenanceWindowsForTargetCommand.d.ts +1 -1
- package/dist-types/commands/GetCommandInvocationCommand.d.ts +2 -2
- package/dist-types/commands/GetConnectionStatusCommand.d.ts +1 -1
- package/dist-types/commands/GetDeployablePatchSnapshotForInstanceCommand.d.ts +2 -2
- package/dist-types/commands/GetInventoryCommand.d.ts +1 -1
- package/dist-types/commands/ListAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListCommandInvocationsCommand.d.ts +4 -4
- package/dist-types/commands/PutComplianceItemsCommand.d.ts +1 -1
- package/dist-types/commands/PutInventoryCommand.d.ts +1 -1
- package/dist-types/commands/ResumeSessionCommand.d.ts +1 -1
- package/dist-types/commands/SendCommandCommand.d.ts +1 -1
- package/dist-types/commands/StartSessionCommand.d.ts +1 -1
- package/dist-types/commands/TerminateSessionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAssociationStatusCommand.d.ts +1 -1
- package/dist-types/commands/UpdateDocumentMetadataCommand.d.ts +2 -1
- package/dist-types/commands/UpdateManagedInstanceRoleCommand.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +194 -192
- package/dist-types/models/models_1.d.ts +188 -194
- package/dist-types/models/models_2.d.ts +21 -13
- package/dist-types/ts3.4/commands/UpdateDocumentMetadataCommand.d.ts +2 -1
- package/dist-types/ts3.4/models/models_0.d.ts +10 -5
- package/dist-types/ts3.4/models/models_1.d.ts +6 -7
- package/dist-types/ts3.4/models/models_2.d.ts +6 -0
- package/package.json +1 -1
|
@@ -8,7 +8,7 @@ export interface DeregisterManagedInstanceCommandOutput extends DeregisterManage
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Removes the server or virtual machine from the list of registered servers. You can
|
|
11
|
-
* reregister the
|
|
11
|
+
* reregister the node again at any time. If you don't plan to use Run Command on the server, we
|
|
12
12
|
* suggest uninstalling SSM Agent first.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface DescribeActivationsCommandOutput extends DescribeActivationsRes
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Describes details about the activation, such as the date and time the activation was
|
|
11
11
|
* created, its expiration date, the Identity and Access Management (IAM) role assigned to
|
|
12
|
-
* the
|
|
12
|
+
* the managed nodes in the activation, and the number of nodes registered by using this
|
|
13
13
|
* activation.</p>
|
|
14
14
|
* @example
|
|
15
15
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface DescribeAssociationCommandInput extends DescribeAssociationRequ
|
|
|
7
7
|
export interface DescribeAssociationCommandOutput extends DescribeAssociationResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes the association for the specified target or
|
|
10
|
+
* <p>Describes the association for the specified target or managed node. If you created the
|
|
11
11
|
* association by using the <code>Targets</code> parameter, then you must retrieve the association
|
|
12
12
|
* by using the association ID.</p>
|
|
13
13
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface DescribeEffectiveInstanceAssociationsCommandInput extends Descr
|
|
|
7
7
|
export interface DescribeEffectiveInstanceAssociationsCommandOutput extends DescribeEffectiveInstanceAssociationsResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>All associations for the
|
|
10
|
+
* <p>All associations for the managed node(s).</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ export interface DescribeInstanceAssociationsStatusCommandInput extends Describe
|
|
|
7
7
|
export interface DescribeInstanceAssociationsStatusCommandOutput extends DescribeInstanceAssociationsStatusResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>The status of the associations for the
|
|
10
|
+
* <p>The status of the associations for the managed node(s).</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,14 +7,15 @@ export interface DescribeInstanceInformationCommandInput extends DescribeInstanc
|
|
|
7
7
|
export interface DescribeInstanceInformationCommandOutput extends DescribeInstanceInformationResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Describes one or more of your
|
|
11
|
-
* platform, the version of SSM Agent installed on the
|
|
12
|
-
*
|
|
13
|
-
*
|
|
14
|
-
*
|
|
10
|
+
* <p>Describes one or more of your managed nodes, including information about the operating
|
|
11
|
+
* system platform, the version of SSM Agent installed on the managed node, node status, and so
|
|
12
|
+
* on.</p>
|
|
13
|
+
* <p>If you specify one or more managed node IDs, it returns information for those managed nodes. If
|
|
14
|
+
* you don't specify node IDs, it returns information for all your managed nodes. If you specify
|
|
15
|
+
* a node ID that isn't valid or a node that you don't own, you receive an error.</p>
|
|
15
16
|
* <note>
|
|
16
17
|
* <p>The <code>IamRole</code> field for this API operation is the Identity and Access Management
|
|
17
|
-
* (IAM) role assigned to on-premises
|
|
18
|
+
* (IAM) role assigned to on-premises managed nodes. This call doesn't return the
|
|
18
19
|
* IAM role for EC2 instances.</p>
|
|
19
20
|
* </note>
|
|
20
21
|
* @example
|
|
@@ -7,7 +7,7 @@ export interface DescribeInstancePatchStatesCommandInput extends DescribeInstanc
|
|
|
7
7
|
export interface DescribeInstancePatchStatesCommandOutput extends DescribeInstancePatchStatesResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the high-level patch state of one or more
|
|
10
|
+
* <p>Retrieves the high-level patch state of one or more managed nodes.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ 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
|
|
10
|
+
* <p>Retrieves the high-level patch state for the managed nodes in the specified patch group.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```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
|
|
11
|
-
* to the patch baseline being used for the
|
|
10
|
+
* <p>Retrieves information about the patches on the specified managed node and their state relative
|
|
11
|
+
* 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,7 +7,7 @@ export interface DescribeMaintenanceWindowsForTargetCommandInput extends Describ
|
|
|
7
7
|
export interface DescribeMaintenanceWindowsForTargetCommandOutput extends DescribeMaintenanceWindowsForTargetResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves information about the maintenance window targets or tasks that
|
|
10
|
+
* <p>Retrieves information about the maintenance window targets or tasks that a managed node is
|
|
11
11
|
* associated with.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -10,8 +10,8 @@ export interface GetCommandInvocationCommandOutput extends GetCommandInvocationR
|
|
|
10
10
|
* <p>Returns detailed information about command execution for an invocation or plugin.</p>
|
|
11
11
|
* <p>
|
|
12
12
|
* <code>GetCommandInvocation</code> only gives the execution status of a plugin in a document.
|
|
13
|
-
* To get the command execution status on a specific
|
|
14
|
-
*
|
|
13
|
+
* To get the command execution status on a specific managed node, use <a>ListCommandInvocations</a>. To get the command execution status across managed nodes,
|
|
14
|
+
* use <a>ListCommands</a>.</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,7 +7,7 @@ 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
|
|
10
|
+
* <p>Retrieves the Session Manager connection status for a managed node to determine whether it is running and
|
|
11
11
|
* 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.
|
|
@@ -7,12 +7,12 @@ export interface GetDeployablePatchSnapshotForInstanceCommandInput extends GetDe
|
|
|
7
7
|
export interface GetDeployablePatchSnapshotForInstanceCommandOutput extends GetDeployablePatchSnapshotForInstanceResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the current snapshot for the patch baseline the
|
|
10
|
+
* <p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is
|
|
11
11
|
* primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>
|
|
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
|
|
15
|
+
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or command.
|
|
16
16
|
* 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>
|
|
@@ -8,7 +8,7 @@ export interface GetInventoryCommandInput extends GetInventoryRequest {
|
|
|
8
8
|
export interface GetInventoryCommandOutput extends GetInventoryResult, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Query inventory information. This includes
|
|
11
|
+
* <p>Query inventory information. This includes managed node status, such as <code>Stopped</code> or
|
|
12
12
|
* <code>Terminated</code>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ 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
|
|
11
|
+
* can limit the results to a specific State Manager association document or managed node by specifying
|
|
12
12
|
* 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.
|
|
@@ -7,10 +7,10 @@ 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
|
|
11
|
-
* or more
|
|
12
|
-
* <code>SendCommand</code> against three
|
|
13
|
-
* requested
|
|
10
|
+
* <p>An invocation is copy of a command sent to a specific managed node. A command can apply to one
|
|
11
|
+
* or more managed nodes. A command invocation applies to one managed node. For example, if a user runs
|
|
12
|
+
* <code>SendCommand</code> against three managed nodes, then a command invocation is created for
|
|
13
|
+
* each requested managed node ID. <code>ListCommandInvocations</code> provide status about command
|
|
14
14
|
* execution.</p>
|
|
15
15
|
* @example
|
|
16
16
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,7 +22,7 @@ export interface PutComplianceItemsCommandOutput extends PutComplianceItemsResul
|
|
|
22
22
|
* </li>
|
|
23
23
|
* <li>
|
|
24
24
|
* <p>ExecutionTime. The time the patch, association, or custom compliance item was applied to
|
|
25
|
-
* the
|
|
25
|
+
* the managed node.</p>
|
|
26
26
|
* </li>
|
|
27
27
|
* <li>
|
|
28
28
|
* <p>Id: The patch, association, or custom compliance ID.</p>
|
|
@@ -7,7 +7,7 @@ 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 more
|
|
10
|
+
* <p>Bulk update custom inventory items on one or more managed nodes. The request adds an inventory item,
|
|
11
11
|
* if it doesn't already exist, or updates an inventory item, if it does exist.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface ResumeSessionCommandInput extends ResumeSessionRequest {
|
|
|
7
7
|
export interface ResumeSessionCommandOutput extends ResumeSessionResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Reconnects a session to
|
|
10
|
+
* <p>Reconnects a session to a managed node after it has been disconnected. Connections can be
|
|
11
11
|
* resumed for disconnected sessions, but not terminated sessions.</p>
|
|
12
12
|
* <note>
|
|
13
13
|
* <p>This command is primarily for use by client machines to automatically reconnect during
|
|
@@ -7,7 +7,7 @@ export interface SendCommandCommandInput extends SendCommandRequest {
|
|
|
7
7
|
export interface SendCommandCommandOutput extends SendCommandResult, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Runs commands on one or more managed
|
|
10
|
+
* <p>Runs commands on one or more managed nodes.</p>
|
|
11
11
|
* @example
|
|
12
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
13
13
|
* ```javascript
|
|
@@ -7,7 +7,7 @@ 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,
|
|
10
|
+
* <p>Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a
|
|
11
11
|
* URL and token that can be used to open a WebSocket connection for sending input and receiving
|
|
12
12
|
* outputs.</p>
|
|
13
13
|
* <note>
|
|
@@ -8,7 +8,7 @@ export interface TerminateSessionCommandOutput extends TerminateSessionResponse,
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Permanently ends a session and closes the data connection between the Session Manager client and
|
|
11
|
-
* SSM Agent on the
|
|
11
|
+
* SSM Agent on the managed node. A terminated session isn't be resumed.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
14
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface UpdateAssociationStatusCommandOutput extends UpdateAssociationS
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Updates the status of the Amazon Web Services Systems Manager document (SSM document) associated with the specified
|
|
11
|
-
*
|
|
11
|
+
* managed node.</p>
|
|
12
12
|
* <p>
|
|
13
13
|
* <code>UpdateAssociationStatus</code> is primarily used by the Amazon Web Services Systems Manager Agent (SSM Agent) to
|
|
14
14
|
* report status updates about your associations and is only used for associations created with the
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
2
2
|
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
3
|
-
import { UpdateDocumentMetadataRequest
|
|
3
|
+
import { UpdateDocumentMetadataRequest } from "../models/models_1";
|
|
4
|
+
import { UpdateDocumentMetadataResponse } from "../models/models_2";
|
|
4
5
|
import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient";
|
|
5
6
|
export interface UpdateDocumentMetadataCommandInput extends UpdateDocumentMetadataRequest {
|
|
6
7
|
}
|
|
@@ -8,8 +8,8 @@ export interface UpdateManagedInstanceRoleCommandOutput extends UpdateManagedIns
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Changes the Identity and Access Management (IAM) role that is assigned to the
|
|
11
|
-
* on-premises
|
|
12
|
-
* these hybrid
|
|
11
|
+
* on-premises server, edge device, or virtual machines (VM). IAM roles are first
|
|
12
|
+
* assigned to these hybrid nodes during the activation process. For more information, see <a>CreateActivation</a>.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|