Skip to content

Commit 9200504

Browse files
author
awstools
committed
docs(client-ssm): March 2024 doc-only updates for Systems Manager.
1 parent 16debc9 commit 9200504

31 files changed

+196
-214
lines changed

‎clients/client-ssm/src/commands/AddTagsToResourceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult,
7373
* Using a consistent set of tag keys makes it easier for you to manage your resources. You can
7474
* search and filter the resources based on the tags you add. Tags don't have any semantic meaning
7575
* to and are interpreted strictly as a string of characters.</p>
76-
* <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
76+
* <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
7777
* resources</a> in the <i>Amazon EC2 User Guide</i>.</p>
7878
* @example
7979
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ssm/src/commands/CancelCommandCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,14 +70,14 @@ export interface CancelCommandCommandOutput extends CancelCommandResult, __Metad
7070
* <p>You don't have permission to access the managed node.</p>
7171
* </li>
7272
* <li>
73-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
73+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
7474
* running.</p>
7575
* </li>
7676
* <li>
7777
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
7878
* </li>
7979
* <li>
80-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
80+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
8181
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
8282
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
8383
* </li>

‎clients/client-ssm/src/commands/CreateActivationCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
3333
* Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
3434
* ID when installing SSM Agent on machines in your hybrid environment. For more information about
3535
* 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
36-
* Amazon Web Services Systems Manager for hybrid environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
36+
* Amazon Web Services Systems Manager for hybrid and multicloud environments</a> in the
37+
* <i>Amazon Web Services Systems Manager User Guide</i>. </p>
3738
* <note>
3839
* <p>Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are
3940
* configured for Systems Manager are all called <i>managed nodes</i>.</p>

‎clients/client-ssm/src/commands/CreateAssociationBatchCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -326,14 +326,14 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
326326
* <p>You don't have permission to access the managed node.</p>
327327
* </li>
328328
* <li>
329-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
329+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
330330
* running.</p>
331331
* </li>
332332
* <li>
333333
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
334334
* </li>
335335
* <li>
336-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
336+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
337337
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
338338
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
339339
* </li>
@@ -357,7 +357,7 @@ export interface CreateAssociationBatchCommandOutput extends CreateAssociationBa
357357
* <p>TargetMap parameter isn't valid.</p>
358358
*
359359
* @throws {@link UnsupportedPlatformType} (client fault)
360-
* <p>The document doesn't support the platform type of the given managed node ID(s). For example,
360+
* <p>The document doesn't support the platform type of the given managed node IDs. For example,
361361
* you sent an document for a Windows managed node to a Linux node.</p>
362362
*
363363
* @throws {@link SSMServiceException}

‎clients/client-ssm/src/commands/CreateAssociationCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -263,14 +263,14 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
263263
* <p>You don't have permission to access the managed node.</p>
264264
* </li>
265265
* <li>
266-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
266+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
267267
* running.</p>
268268
* </li>
269269
* <li>
270270
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
271271
* </li>
272272
* <li>
273-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
273+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
274274
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
275275
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
276276
* </li>
@@ -297,7 +297,7 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
297297
* <p>TargetMap parameter isn't valid.</p>
298298
*
299299
* @throws {@link UnsupportedPlatformType} (client fault)
300-
* <p>The document doesn't support the platform type of the given managed node ID(s). For example,
300+
* <p>The document doesn't support the platform type of the given managed node IDs. For example,
301301
* you sent an document for a Windows managed node to a Linux node.</p>
302302
*
303303
* @throws {@link SSMServiceException}

‎clients/client-ssm/src/commands/DeleteAssociationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,14 @@ export interface DeleteAssociationCommandOutput extends DeleteAssociationResult,
7474
* <p>You don't have permission to access the managed node.</p>
7575
* </li>
7676
* <li>
77-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
77+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
7878
* running.</p>
7979
* </li>
8080
* <li>
8181
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
8282
* </li>
8383
* <li>
84-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
84+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
8585
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
8686
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
8787
* </li>

‎clients/client-ssm/src/commands/DeleteResourcePolicyCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
4040
* <p>
4141
* <code>Parameter</code> - The resource policy is used to share a parameter with other
4242
* accounts using Resource Access Manager (RAM). For more information about
43-
* cross-account sharing of parameters, see <a href="systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
43+
* cross-account sharing of parameters, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-shared-parameters.html">Working with
4444
* shared parameters</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4545
* </li>
4646
* </ul>

‎clients/client-ssm/src/commands/DeregisterManagedInstanceCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,14 @@ export interface DeregisterManagedInstanceCommandOutput extends DeregisterManage
6262
* <p>You don't have permission to access the managed node.</p>
6363
* </li>
6464
* <li>
65-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
65+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
6666
* running.</p>
6767
* </li>
6868
* <li>
6969
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
7070
* </li>
7171
* <li>
72-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
72+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
7373
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
7474
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
7575
* </li>

‎clients/client-ssm/src/commands/DescribeAssociationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -180,14 +180,14 @@ export interface DescribeAssociationCommandOutput extends DescribeAssociationRes
180180
* <p>You don't have permission to access the managed node.</p>
181181
* </li>
182182
* <li>
183-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
183+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
184184
* running.</p>
185185
* </li>
186186
* <li>
187187
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
188188
* </li>
189189
* <li>
190-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
190+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
191191
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
192192
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
193193
* </li>

‎clients/client-ssm/src/commands/DescribeEffectiveInstanceAssociationsCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface DescribeEffectiveInstanceAssociationsCommandOutput
3737

3838
/**
3939
* @public
40-
* <p>All associations for the managed node(s).</p>
40+
* <p>All associations for the managed nodes.</p>
4141
* @example
4242
* Use a bare-bones client and the command you need to make an API call.
4343
* ```javascript
@@ -81,14 +81,14 @@ export interface DescribeEffectiveInstanceAssociationsCommandOutput
8181
* <p>You don't have permission to access the managed node.</p>
8282
* </li>
8383
* <li>
84-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
84+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
8585
* running.</p>
8686
* </li>
8787
* <li>
8888
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
8989
* </li>
9090
* <li>
91-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
91+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
9292
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
9393
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
9494
* </li>

‎clients/client-ssm/src/commands/DescribeInstanceAssociationsStatusCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface DescribeInstanceAssociationsStatusCommandOutput
3636

3737
/**
3838
* @public
39-
* <p>The status of the associations for the managed node(s).</p>
39+
* <p>The status of the associations for the managed nodes.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript
@@ -92,14 +92,14 @@ export interface DescribeInstanceAssociationsStatusCommandOutput
9292
* <p>You don't have permission to access the managed node.</p>
9393
* </li>
9494
* <li>
95-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
95+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
9696
* running.</p>
9797
* </li>
9898
* <li>
9999
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
100100
* </li>
101101
* <li>
102-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
102+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
103103
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
104104
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
105105
* </li>

‎clients/client-ssm/src/commands/DescribeInstanceInformationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -121,14 +121,14 @@ export interface DescribeInstanceInformationCommandOutput extends DescribeInstan
121121
* <p>You don't have permission to access the managed node.</p>
122122
* </li>
123123
* <li>
124-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
124+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
125125
* running.</p>
126126
* </li>
127127
* <li>
128128
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
129129
* </li>
130130
* <li>
131-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
131+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
132132
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
133133
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
134134
* </li>

‎clients/client-ssm/src/commands/DescribeInstancePatchesCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,14 @@ export interface DescribeInstancePatchesCommandOutput extends DescribeInstancePa
8787
* <p>You don't have permission to access the managed node.</p>
8888
* </li>
8989
* <li>
90-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
90+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
9191
* running.</p>
9292
* </li>
9393
* <li>
9494
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
9595
* </li>
9696
* <li>
97-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
97+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
9898
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
9999
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
100100
* </li>

‎clients/client-ssm/src/commands/DescribeOpsItemsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface DescribeOpsItemsCommandOutput extends DescribeOpsItemsResponse,
3232
* <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3333
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
3434
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
35-
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
35+
* 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
3636
* <i>Amazon Web Services Systems Manager User Guide</i>. </p>
3737
* @example
3838
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ssm/src/commands/GetCommandInvocationCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,14 @@ export interface GetCommandInvocationCommandOutput extends GetCommandInvocationR
9090
* <p>You don't have permission to access the managed node.</p>
9191
* </li>
9292
* <li>
93-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
93+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
9494
* running.</p>
9595
* </li>
9696
* <li>
9797
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
9898
* </li>
9999
* <li>
100-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
100+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
101101
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
102102
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
103103
* </li>

‎clients/client-ssm/src/commands/GetDeployablePatchSnapshotForInstanceCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput
131131
* @throws {@link UnsupportedFeatureRequiredException} (client fault)
132132
* <p>Patching for applications released by Microsoft is only available on EC2 instances and
133133
* advanced instances. To patch applications released by Microsoft on on-premises servers and VMs,
134-
* 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
134+
* 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
135135
* the advanced-instances tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
136136
*
137137
* @throws {@link UnsupportedOperatingSystem} (client fault)

‎clients/client-ssm/src/commands/GetOpsItemCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export interface GetOpsItemCommandOutput extends GetOpsItemResponse, __MetadataB
3333
* up OpsCenter</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3434
* <p>Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and
3535
* remediate operational issues impacting the performance and health of their Amazon Web Services resources. For
36-
* more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter.html">OpsCenter</a> in the
36+
* 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
3737
* <i>Amazon Web Services Systems Manager User Guide</i>. </p>
3838
* @example
3939
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-ssm/src/commands/ListCommandInvocationsCommand.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,14 @@ export interface ListCommandInvocationsCommandOutput extends ListCommandInvocati
126126
* <p>You don't have permission to access the managed node.</p>
127127
* </li>
128128
* <li>
129-
* <p>Amazon Web Services Systems Manager Agent(SSM Agent) isn't running. Verify that SSM Agent is
129+
* <p>Amazon Web Services Systems Manager Agent (SSM Agent) isn't running. Verify that SSM Agent is
130130
* running.</p>
131131
* </li>
132132
* <li>
133133
* <p>SSM Agent isn't registered with the SSM endpoint. Try reinstalling SSM Agent.</p>
134134
* </li>
135135
* <li>
136-
* <p>The managed node isn't in valid state. Valid states are: <code>Running</code>,
136+
* <p>The managed node isn't in a valid state. Valid states are: <code>Running</code>,
137137
* <code>Pending</code>, <code>Stopped</code>, and <code>Stopping</code>. Invalid states are:
138138
* <code>Shutting-down</code> and <code>Terminated</code>.</p>
139139
* </li>

0 commit comments

Comments
 (0)