Skip to content

Commit

Permalink
docs(client-ssm): Systems Manager doc-only update for January, 2025.
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Jan 24, 2025
1 parent 2db3a35 commit b54238c
Show file tree
Hide file tree
Showing 17 changed files with 107 additions and 95 deletions.
9 changes: 5 additions & 4 deletions clients/client-ssm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,17 @@ operations at scale.</p>
</p>
<ul>
<li>
<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>
<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
Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
</li>
<li>
<p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
<p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
<i>
<a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
</i>.</p>
</li>
<li>
<p>For information about AppConfig, a capability of Systems Manager, see the <i>
<p>For information about AppConfig, a tool in Systems Manager, see the <i>
<a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
</i>
and the <i>
Expand All @@ -33,7 +34,7 @@ API Reference</a>
</i>.</p>
</li>
<li>
<p>For information about Incident Manager, a capability of Systems Manager, see the <i>
<p>For information about Incident Manager, a tool in Systems Manager, see the <i>
<a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
Guide</a>
</i> and the <i>
Expand Down
9 changes: 5 additions & 4 deletions clients/client-ssm/src/SSM.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3216,16 +3216,17 @@ export interface SSM {
* </p>
* <ul>
* <li>
* <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>
* <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
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
* <i>
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
* </i>.</p>
* </li>
* <li>
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
* </i>
* and the <i>
Expand All @@ -3234,7 +3235,7 @@ export interface SSM {
* </i>.</p>
* </li>
* <li>
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
* Guide</a>
* </i> and the <i>
Expand Down
9 changes: 5 additions & 4 deletions clients/client-ssm/src/SSMClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -991,16 +991,17 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
* </p>
* <ul>
* <li>
* <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>
* <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
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
* <i>
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
* </i>.</p>
* </li>
* <li>
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
* </i>
* and the <i>
Expand All @@ -1009,7 +1010,7 @@ export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
* </i>.</p>
* </li>
* <li>
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
* Guide</a>
* </i> and the <i>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export interface AssociateOpsItemRelatedItemCommandOutput

/**
* <p>Associates a related item to a Systems Manager OpsCenter OpsItem. For example, you can associate an
* Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are capabilities of
* Incident Manager incident or analysis with an OpsItem. Incident Manager and OpsCenter are tools in
* Amazon Web Services Systems Manager.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
4 changes: 2 additions & 2 deletions clients/client-ssm/src/commands/CreateActivationCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ export interface CreateActivationCommandOutput extends CreateActivationResult, _
/**
* <p>Generates an activation code and activation ID you can use to register your on-premises
* servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with
* 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
* Systems Manager makes it possible to manage them using Systems Manager tools. 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-hybrid-multicloud.html">Using Amazon Web Services Systems Manager in
* hybrid and multicloud environments</a> in the <i>Amazon Web Services Systems Manager User Guide</i>. </p>
* <note>
Expand Down
12 changes: 6 additions & 6 deletions clients/client-ssm/src/commands/CreateAssociationCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ export interface CreateAssociationCommandOutput extends CreateAssociationResult,
* nodes. For example, an association can specify that anti-virus software must be installed and
* running on your managed nodes, or that certain ports must be closed. For static targets, the
* association specifies a schedule for when the configuration is reapplied. For dynamic targets,
* such as an Amazon Web Services resource group or an Amazon Web Services autoscaling group, State Manager, a capability of
* Amazon Web Services Systems Manager applies the configuration when new managed nodes are added to the group. The
* association also specifies actions to take when applying the configuration. For example, an
* association for anti-virus software might run once a day. If the software isn't installed, then
* State Manager installs it. If the software is installed, but the service isn't running, then the
* association might instruct State Manager to start the service. </p>
* 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
* applies the configuration when new managed nodes are added to the group. The association also
* specifies actions to take when applying the configuration. For example, an association for
* anti-virus software might run once a day. If the software isn't installed, then State Manager
* installs it. If the software is installed, but the service isn't running, then the association
* might instruct State Manager to start the service. </p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export interface DisassociateOpsItemRelatedItemCommandOutput

/**
* <p>Deletes the association between an OpsItem and a related item. For example, this API
* operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a capability of
* operation can delete an Incident Manager incident from an OpsItem. Incident Manager is a tool in
* Amazon Web Services Systems Manager.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ssm/src/commands/GetCalendarStateCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export interface GetCalendarStateCommandOutput extends GetCalendarStateResponse,
* <p>If you specify more than one calendar in a request, the command returns the status of
* <code>OPEN</code> only if all calendars in the request are open. If one or more calendars in the
* request are closed, the status returned is <code>CLOSED</code>.</p>
* <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>
* <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>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ export interface GetDeployablePatchSnapshotForInstanceCommandOutput
* primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>
* <note>
* <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
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a capability of
* Amazon Web Services Systems Manager, with an SSM document that enables you to target a managed node with a script or
* command. For example, run the command using the <code>AWS-RunShellScript</code> document or the
* 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,
* with an SSM document that enables you to target a managed node with a script or command. For
* example, run the command using the <code>AWS-RunShellScript</code> document or the
* <code>AWS-RunPowerShellScript</code> document.</p>
* </note>
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ export interface GetParametersByPathCommandInput extends GetParametersByPathRequ
export interface GetParametersByPathCommandOutput extends GetParametersByPathResult, __MetadataBearer {}

/**
* <p>Retrieve information about one or more parameters in a specific hierarchy. </p>
* <p>Retrieve information about one or more parameters under a specified level in a hierarchy. </p>
* <p>Request results are returned on a best-effort basis. If you specify <code>MaxResults</code>
* in the request, the response includes information up to the limit specified. The number of items
* returned, however, can be between zero and the value of <code>MaxResults</code>. If the service
Expand Down
2 changes: 1 addition & 1 deletion clients/client-ssm/src/commands/ListAssociationsCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export interface ListAssociationsCommandOutput extends ListAssociationsResult, _
/**
* <p>Returns all State Manager associations in the current Amazon Web Services account and Amazon Web Services Region. You
* can limit the results to a specific State Manager association document or managed node by
* specifying a filter. State Manager is a capability of Amazon Web Services Systems Manager.</p>
* specifying a filter. State Manager is a tool in Amazon Web Services Systems Manager.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export interface ListOpsItemRelatedItemsCommandOutput extends ListOpsItemRelated

/**
* <p>Lists all related-item resources associated with a Systems Manager OpsCenter OpsItem. OpsCenter is a
* capability of Amazon Web Services Systems Manager.</p>
* tool in Amazon Web Services Systems Manager.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
9 changes: 5 additions & 4 deletions clients/client-ssm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,17 @@
* </p>
* <ul>
* <li>
* <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>
* <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
* Systems Manager tools</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
* </li>
* <li>
* <p>For details about predefined runbooks for Automation, a capability of Amazon Web Services Systems Manager, see the
* <p>For details about predefined runbooks for Automation, a tool in Amazon Web Services Systems Manager, see the
* <i>
* <a href="https://docs.aws.amazon.com/systems-manager-automation-runbooks/latest/userguide/automation-runbook-reference.html">Systems Manager Automation runbook reference</a>
* </i>.</p>
* </li>
* <li>
* <p>For information about AppConfig, a capability of Systems Manager, see the <i>
* <p>For information about AppConfig, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/appconfig/latest/userguide/">AppConfig User Guide</a>
* </i>
* and the <i>
Expand All @@ -28,7 +29,7 @@
* </i>.</p>
* </li>
* <li>
* <p>For information about Incident Manager, a capability of Systems Manager, see the <i>
* <p>For information about Incident Manager, a tool in Systems Manager, see the <i>
* <a href="https://docs.aws.amazon.com/incident-manager/latest/userguide/">Systems Manager Incident Manager User
* Guide</a>
* </i> and the <i>
Expand Down
Loading

0 comments on commit b54238c

Please sign in to comment.