Skip to content

Commit b54238c

Browse files
author
awstools
committed
docs(client-ssm): Systems Manager doc-only update for January, 2025.
1 parent 2db3a35 commit b54238c

17 files changed

+107
-95
lines changed

‎clients/client-ssm/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,17 @@ operations at scale.</p>
1515
</p>
1616
<ul>
1717
<li>
18-
<p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
18+
<p>For information about each of the tools that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html">Using
19+
Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1920
</li>
2021
<li>
21-
<p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
22+
<p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
2223
<i>
2324
<a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
2425
</i>.</p>
2526
</li>
2627
<li>
27-
<p>For information about AppConfig, a capability of Systems Manager, see the <i>
28+
<p>For information about AppConfig, a tool in Systems Manager, see the <i>
2829
<a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
2930
</i>
3031
and the <i>
@@ -33,7 +34,7 @@ API Reference</a>
3334
</i>.</p>
3435
</li>
3536
<li>
36-
<p>For information about Incident Manager, a capability of Systems Manager, see the <i>
37+
<p>For information about Incident Manager, a tool in Systems Manager, see the <i>
3738
<a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
3839
Guide</a>
3940
</i> and the <i>

‎clients/client-ssm/src/SSM.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3216,16 +3216,17 @@ export interface SSM {
32163216
* </p>
32173217
* <ul>
32183218
* <li>
3219-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
3219+
* <p>For information about each of the tools that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html">Using
3220+
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
32203221
* </li>
32213222
* <li>
3222-
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
3223+
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
32233224
* <i>
32243225
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
32253226
* </i>.</p>
32263227
* </li>
32273228
* <li>
3228-
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
3229+
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
32293230
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
32303231
* </i>
32313232
* and the <i>
@@ -3234,7 +3235,7 @@ export interface SSM {
32343235
* </i>.</p>
32353236
* </li>
32363237
* <li>
3237-
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
3238+
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
32383239
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
32393240
* Guide</a>
32403241
* </i> and the <i>

‎clients/client-ssm/src/SSMClient.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -991,16 +991,17 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
991991
* </p>
992992
* <ul>
993993
* <li>
994-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
994+
* <p>For information about each of the tools that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html">Using
995+
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
995996
* </li>
996997
* <li>
997-
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
998+
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
998999
* <i>
9991000
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
10001001
* </i>.</p>
10011002
* </li>
10021003
* <li>
1003-
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
1004+
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
10041005
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
10051006
* </i>
10061007
* and the <i>
@@ -1009,7 +1010,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
10091010
* </i>.</p>
10101011
* </li>
10111012
* <li>
1012-
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
1013+
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
10131014
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
10141015
* Guide</a>
10151016
* </i> and the <i>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface AssociateOpsItemRelatedItemCommandOutput
3131

3232
/**
3333
* <p>Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an
34-
* Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of
34+
* Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in
3535
* Amazon Web Services Systems Manager.</p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
3030
/**
3131
* <p>Generates an activation code and activation ID you can use to register your on-premises
3232
* servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
33-
* Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and
34-
* ID when installing SSM Agent on machines in your hybrid environment. For more information about
33+
* Systems Manager makes it possible to manage them using Systems Manager tools. You use the activation code and ID when
34+
* 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-hybrid-multicloud.html">Using Amazon Web Services Systems Manager in
3636
* hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
3737
* <note>

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
3737
* nodes. For example, an association can specify that anti-virus software must be installed and
3838
* running on your managed nodes, or that certain ports must be closed. For static targets, the
3939
* association specifies a schedule for when the configuration is reapplied. For dynamic targets,
40-
* such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
41-
* Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The
42-
* association also specifies actions to take when applying the configuration. For example, an
43-
* association for anti-virus software might run once a day. If the software isn't installed, then
44-
* State Manager installs it. If the software is installed, but the service isn't running, then the
45-
* association might instruct State Manager to start the service. </p>
40+
* such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a tool in Amazon Web Services Systems Manager
41+
* applies the configuration when new managed nodes are added to the group. The association also
42+
* specifies actions to take when applying the configuration. For example, an association for
43+
* anti-virus software might run once a day. If the software isn't installed, then State Manager
44+
* installs it. If the software is installed, but the service isn't running, then the association
45+
* might instruct State Manager to start the service. </p>
4646
* @example
4747
* Use a bare-bones client and the command you need to make an API call.
4848
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface DisassociateOpsItemRelatedItemCommandOutput
3434

3535
/**
3636
* <p>Deletes the association between an OpsItem and a related item. For example, this API
37-
* operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of
37+
* operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in
3838
* Amazon Web Services Systems Manager.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ export interface GetCalendarStateCommandOutput extends GetCalendarStateResponse,
3636
* <p>If you specify more than one calendar in a request, the command returns the status of
3737
* <code>OPEN</code> only if all calendars in the request are open. If one or more calendars in the
3838
* request are closed, the status returned is <code>CLOSED</code>.</p>
39-
* <p>For more information about Change Calendar, a capability of Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
39+
* <p>For more information about Change Calendar, a tool in Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-change-calendar.html">Amazon Web Services Systems Manager Change Calendar</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput
4242
* primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>
4343
* <note>
4444
* <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
45-
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
46-
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
47-
* command. For example, run the command using the <code>AWS-RunShellScript</code> document or the
45+
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager,
46+
* with an SSM document that enables you to target a managed node with a script or command. For
47+
* example, run the command using the <code>AWS-RunShellScript</code> document or the
4848
* <code>AWS-RunPowerShellScript</code> document.</p>
4949
* </note>
5050
* @example

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface GetParametersByPathCommandInput extends GetParametersByPathRequ
3232
export interface GetParametersByPathCommandOutput extends GetParametersByPathResult, __MetadataBearer {}
3333

3434
/**
35-
* <p>Retrieve information about one or more parameters in a specific hierarchy. </p>
35+
* <p>Retrieve information about one or more parameters under a specified level in a hierarchy. </p>
3636
* <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code>
3737
* in the request, the response includes information up to the limit specified. The number of items
3838
* returned, however, can be between zero and the value of <code>MaxResults</code>. If the service

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface ListAssociationsCommandOutput extends ListAssociationsResult, _
3030
/**
3131
* <p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You
3232
* can limit the results to a specific State Manager association document or managed node by
33-
* specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
33+
* specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.</p>
3434
* @example
3535
* Use a bare-bones client and the command you need to make an API call.
3636
* ```javascript

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface ListOpsItemRelatedItemsCommandOutput extends ListOpsItemRelated
2929

3030
/**
3131
* <p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a
32-
* capability of Amazon Web Services Systems Manager.</p>
32+
* tool in Amazon Web Services Systems Manager.</p>
3333
* @example
3434
* Use a bare-bones client and the command you need to make an API call.
3535
* ```javascript

‎clients/client-ssm/src/index.ts

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,17 @@
1010
* </p>
1111
* <ul>
1212
* <li>
13-
* <p>For information about each of the capabilities that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/what-is-systems-manager.html#systems-manager-capabilities">Systems Manager capabilities</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
13+
* <p>For information about each of the tools that comprise Systems Manager, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-tools.html">Using
14+
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
1415
* </li>
1516
* <li>
16-
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
17+
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
1718
* <i>
1819
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
1920
* </i>.</p>
2021
* </li>
2122
* <li>
22-
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
23+
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
2324
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
2425
* </i>
2526
* and the <i>
@@ -28,7 +29,7 @@
2829
* </i>.</p>
2930
* </li>
3031
* <li>
31-
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
32+
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
3233
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
3334
* Guide</a>
3435
* </i> and the <i>

0 commit comments

Comments
 (0)