docs(client-ssm): March 2024 doc-only updates for Systems Manager.

aws · Mar 12, 2024 · 9200504 · 9200504
1 parent 16debc9
commit 9200504
Show file tree

Hide file tree

Showing 31 changed files with 196 additions and 214 deletions.
diff --git a/clients/client-ssm/src/commands/AddTagsToResourceCommand.ts b/clients/client-ssm/src/commands/AddTagsToResourceCommand.ts
@@ -73,7 +73,7 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
  *    Using a consistent set of tag keys makes it easier for you to manage your resources. You can
  *    search and filter the resources based on the tags you add. Tags don't have any semantic meaning
  *    to and are interpreted strictly as a string of characters.</p>
- *          <p>For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tagging your Amazon EC2
+ *          <p>For more information about using tags with Amazon Elastic Compute Cloud (Amazon EC2) instances, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html">Tag your Amazon EC2
  *     resources</a> in the <i>Amazon EC2 User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ssm/src/commands/CancelCommandCommand.ts b/clients/client-ssm/src/commands/CancelCommandCommand.ts
@@ -70,14 +70,14 @@ export interface CancelCommandCommandOutput extends CancelCommandResult, __Metad
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/CreateActivationCommand.ts b/clients/client-ssm/src/commands/CreateActivationCommand.ts
@@ -33,7 +33,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
  *    Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
  *    ID when installing SSM Agent on machines in your hybrid environment. For more information about
  *    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
- *     Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
+ *     Amazon Web Services Systems Manager for hybrid and multicloud environments</a> in the
+ *     <i>Amazon Web Services Systems Manager User Guide</i>. </p>
  *          <note>
  *             <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 nodes</i>.</p>

diff --git a/clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts b/clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts
@@ -326,14 +326,14 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>
@@ -357,7 +357,7 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
  *  <p>TargetMap parameter isn't valid.</p>
  *
  * @throws {@link UnsupportedPlatformType} (client fault)
- *  <p>The document doesn't support the platform type of the given managed node ID(s). For example,
+ *  <p>The document doesn't support the platform type of the given managed node IDs. For example,
  *    you sent an document for a Windows managed node to a Linux node.</p>
  *
  * @throws {@link SSMServiceException}

diff --git a/clients/client-ssm/src/commands/CreateAssociationCommand.ts b/clients/client-ssm/src/commands/CreateAssociationCommand.ts
@@ -263,14 +263,14 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>
@@ -297,7 +297,7 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
  *  <p>TargetMap parameter isn't valid.</p>
  *
  * @throws {@link UnsupportedPlatformType} (client fault)
- *  <p>The document doesn't support the platform type of the given managed node ID(s). For example,
+ *  <p>The document doesn't support the platform type of the given managed node IDs. For example,
  *    you sent an document for a Windows managed node to a Linux node.</p>
  *
  * @throws {@link SSMServiceException}

diff --git a/clients/client-ssm/src/commands/DeleteAssociationCommand.ts b/clients/client-ssm/src/commands/DeleteAssociationCommand.ts
@@ -74,14 +74,14 @@ export interface DeleteAssociationCommandOutput extends DeleteAssociationResult,
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts b/clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts
@@ -40,7 +40,7 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
  *                <p>
  *                   <code>Parameter</code> - The resource policy is used to share a parameter with other
  *      accounts using Resource Access Manager (RAM). For more information about
- *      cross-account sharing of parameters, see <a href="systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
+ *      cross-account sharing of parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
  *       shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  *             </li>
  *          </ul>

diff --git a/clients/client-ssm/src/commands/DeregisterManagedInstanceCommand.ts b/clients/client-ssm/src/commands/DeregisterManagedInstanceCommand.ts
@@ -62,14 +62,14 @@ export interface DeregisterManagedInstanceCommandOutput extends DeregisterManage
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeAssociationCommand.ts b/clients/client-ssm/src/commands/DescribeAssociationCommand.ts
@@ -180,14 +180,14 @@ export interface DescribeAssociationCommandOutput extends DescribeAssociationRes
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeEffectiveInstanceAssociationsCommand.ts b/clients/client-ssm/src/commands/DescribeEffectiveInstanceAssociationsCommand.ts
@@ -37,7 +37,7 @@ export interface DescribeEffectiveInstanceAssociationsCommandOutput
 
 /**
  * @public
- * <p>All associations for the managed node(s).</p>
+ * <p>All associations for the managed nodes.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -81,14 +81,14 @@ export interface DescribeEffectiveInstanceAssociationsCommandOutput
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeInstanceAssociationsStatusCommand.ts b/clients/client-ssm/src/commands/DescribeInstanceAssociationsStatusCommand.ts
@@ -36,7 +36,7 @@ export interface DescribeInstanceAssociationsStatusCommandOutput
 
 /**
  * @public
- * <p>The status of the associations for the managed node(s).</p>
+ * <p>The status of the associations for the managed nodes.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -92,14 +92,14 @@ export interface DescribeInstanceAssociationsStatusCommandOutput
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts b/clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts
@@ -121,14 +121,14 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts b/clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts
@@ -87,14 +87,14 @@ export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePa
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/DescribeOpsItemsCommand.ts b/clients/client-ssm/src/commands/DescribeOpsItemsCommand.ts
@@ -32,7 +32,7 @@ export interface DescribeOpsItemsCommandOutput extends DescribeOpsItemsResponse,
  *     <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  *          <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
  *    remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
- *    more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
+ *    more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the
  *     <i>Amazon Web Services Systems Manager User Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ssm/src/commands/GetCommandInvocationCommand.ts b/clients/client-ssm/src/commands/GetCommandInvocationCommand.ts
@@ -90,14 +90,14 @@ export interface GetCommandInvocationCommandOutput extends GetCommandInvocationR
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>

diff --git a/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts b/clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts
@@ -131,7 +131,7 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput
  * @throws {@link UnsupportedFeatureRequiredException} (client fault)
  *  <p>Patching for applications released by Microsoft is only available on EC2 instances and
  *    advanced instances. To patch applications released by Microsoft on on-premises servers and VMs,
- *    you must enable advanced instances. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html">Enabling
+ *    you must enable advanced instances. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html">Turning on
  *     the advanced-instances tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  *
  * @throws {@link UnsupportedOperatingSystem} (client fault)

diff --git a/clients/client-ssm/src/commands/GetOpsItemCommand.ts b/clients/client-ssm/src/commands/GetOpsItemCommand.ts
@@ -33,7 +33,7 @@ export interface GetOpsItemCommandOutput extends GetOpsItemResponse, __MetadataB
  *     up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
  *          <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
  *    remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
- *    more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
+ *    more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">Amazon Web Services Systems Manager OpsCenter</a> in the
  *     <i>Amazon Web Services Systems Manager User Guide</i>. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts b/clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts
@@ -126,14 +126,14 @@ export interface ListCommandInvocationsCommandOutput extends ListCommandInvocati
  *                <p>You don't have permission to access the managed node.</p>
  *             </li>
  *             <li>
- *                <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
+ *                <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
  *      running.</p>
  *             </li>
  *             <li>
  *                <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
  *             </li>
  *             <li>
- *                <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
+ *                <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
  *       <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
  *       <code>Shutting-down</code> and <code>Terminated</code>.</p>
  *             </li>