docs(client-ssm): Adding doc updates for OpsCenter support in Service…

… Setting actions.
aws · Jul 27, 2022 · 2a18f3a · 2a18f3a
1 parent a5a02f7
commit 2a18f3a
Show file tree

Hide file tree

Showing 9 changed files with 107 additions and 104 deletions.
diff --git a/clients/client-ssm/README.md b/clients/client-ssm/README.md
@@ -9,22 +9,13 @@
 
 AWS SDK for JavaScript SSM Client for Node.js, Browser and React Native.
 
-<p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
-collecting system inventory, applying operating system (OS) patches, automating the creation of
-Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
-Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A
-<i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises
-server or virtual machine (VM) that has been configured for Systems Manager. </p>
-<note>
-<p>With support for IoT Greengrass core devices, the phrase <i>managed
-instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
-documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the
-term <i>instance</i>.</p>
-</note>
+<p>Amazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and
+infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,
+shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services
+resources securely at scale.</p>
 <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>.</p>
-<p>To get started, verify prerequisites and configure managed nodes. For more information, see
-<a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
-Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
+<p>To get started, verify prerequisites. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
+Amazon Web Services Systems Manager</a>.</p>
 <p class="title">
 <b>Related resources</b>
 </p>

diff --git a/clients/client-ssm/src/SSM.ts b/clients/client-ssm/src/SSM.ts
@@ -667,22 +667,13 @@ import {
 import { SSMClient } from "./SSMClient";
 
 /**
- * <p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
- *    collecting system inventory, applying operating system (OS) patches, automating the creation of
- *    Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
- *    Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A
- *     <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises
- *    server or virtual machine (VM) that has been configured for Systems Manager. </p>
- *          <note>
- *             <p>With support for IoT Greengrass core devices, the phrase <i>managed
- *      instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
- *     documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the
- *     term <i>instance</i>.</p>
- *          </note>
+ * <p>Amazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and
+ *    infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,
+ *    shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services
+ *    resources securely at scale.</p>
  *          <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>.</p>
- *          <p>To get started, verify prerequisites and configure managed nodes. For more information, see
- *     <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
- *     Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
+ *          <p>To get started, verify prerequisites. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
+ *     Amazon Web Services Systems Manager</a>.</p>
  *          <p class="title">
  *             <b>Related resources</b>
  *          </p>
@@ -707,12 +698,13 @@ import { SSMClient } from "./SSMClient";
  */
 export class SSM extends SSMClient {
   /**
-   * <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
-   *    can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store
-   *    parameters, and patch baselines. Tags enable you to categorize your resources in different ways,
-   *    for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,
-   *    both of which you define. For example, you could define a set of tags for your account's managed
-   *    nodes that helps you track each node's owner and stack level. For example:</p>
+   * <p>Adds or overwrites one or more tags for the specified resource. <i>Tags</i>
+   *    are metadata that you can assign to your automations, documents, managed nodes, maintenance
+   *    windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your
+   *    resources in different ways, for example, by purpose, owner, or environment. Each tag consists of
+   *    a key and an optional value, both of which you define. For example, you could define a set of
+   *    tags for your account's managed nodes that helps you track each node's owner and stack level. For
+   *    example:</p>
    *          <ul>
    *             <li>
    *                <p>
@@ -4379,7 +4371,7 @@ export class SSM extends SSMClient {
    *      or <code>Failed</code> for associations.</p>
    *             </li>
    *             <li>
-   *                <p>Severity: A patch severity. For example, <code>critical</code>.</p>
+   *                <p>Severity: A patch severity. For example, <code>Critical</code>.</p>
    *             </li>
    *             <li>
    *                <p>DocumentName: An SSM document name. For example, <code>AWS-RunPatchBaseline</code>.</p>

diff --git a/clients/client-ssm/src/SSMClient.ts b/clients/client-ssm/src/SSMClient.ts
@@ -888,22 +888,13 @@ type SSMClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOp
 export interface SSMClientResolvedConfig extends SSMClientResolvedConfigType {}
 
 /**
- * <p>Amazon Web Services Systems Manager is a collection of capabilities that helps you automate management tasks such as
- *    collecting system inventory, applying operating system (OS) patches, automating the creation of
- *    Amazon Machine Images (AMIs), and configuring operating systems (OSs) and applications at scale.
- *    Systems Manager lets you remotely and securely manage the configuration of your managed nodes. A
- *     <i>managed node</i> is any Amazon Elastic Compute Cloud (Amazon EC2) instance, edge device, or on-premises
- *    server or virtual machine (VM) that has been configured for Systems Manager. </p>
- *          <note>
- *             <p>With support for IoT Greengrass core devices, the phrase <i>managed
- *      instance</i> has been changed to <i>managed node</i> in most of the Systems Manager
- *     documentation. The Systems Manager console, API calls, error messages, and SSM documents still use the
- *     term <i>instance</i>.</p>
- *          </note>
+ * <p>Amazon Web Services Systems Manager is a collection of capabilities to help you manage your applications and
+ *    infrastructure running in the Amazon Web Services Cloud;. Systems Manager simplifies application and resource management,
+ *    shortens the time to detect and resolve operational problems, and helps you manage your Amazon Web Services
+ *    resources securely at scale.</p>
  *          <p>This reference is intended to be used with the <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/">Amazon Web Services Systems Manager User Guide</a>.</p>
- *          <p>To get started, verify prerequisites and configure managed nodes. For more information, see
- *     <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
- *     Amazon Web Services Systems Manager</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
+ *          <p>To get started, verify prerequisites. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-setting-up.html">Setting up
+ *     Amazon Web Services Systems Manager</a>.</p>
  *          <p class="title">
  *             <b>Related resources</b>
  *          </p>

diff --git a/clients/client-ssm/src/commands/AddTagsToResourceCommand.ts b/clients/client-ssm/src/commands/AddTagsToResourceCommand.ts
@@ -28,12 +28,13 @@ export interface AddTagsToResourceCommandInput extends AddTagsToResourceRequest
 export interface AddTagsToResourceCommandOutput extends AddTagsToResourceResult, __MetadataBearer {}
 
 /**
- * <p>Adds or overwrites one or more tags for the specified resource. Tags are metadata that you
- *    can assign to your automations, documents, managed nodes, maintenance windows, Parameter Store
- *    parameters, and patch baselines. Tags enable you to categorize your resources in different ways,
- *    for example, by purpose, owner, or environment. Each tag consists of a key and an optional value,
- *    both of which you define. For example, you could define a set of tags for your account's managed
- *    nodes that helps you track each node's owner and stack level. For example:</p>
+ * <p>Adds or overwrites one or more tags for the specified resource. <i>Tags</i>
+ *    are metadata that you can assign to your automations, documents, managed nodes, maintenance
+ *    windows, Parameter Store parameters, and patch baselines. Tags enable you to categorize your
+ *    resources in different ways, for example, by purpose, owner, or environment. Each tag consists of
+ *    a key and an optional value, both of which you define. For example, you could define a set of
+ *    tags for your account's managed nodes that helps you track each node's owner and stack level. For
+ *    example:</p>
  *          <ul>
  *             <li>
  *                <p>

diff --git a/clients/client-ssm/src/commands/PutComplianceItemsCommand.ts b/clients/client-ssm/src/commands/PutComplianceItemsCommand.ts
@@ -56,7 +56,7 @@ export interface PutComplianceItemsCommandOutput extends PutComplianceItemsResul
  *      or <code>Failed</code> for associations.</p>
  *             </li>
  *             <li>
- *                <p>Severity: A patch severity. For example, <code>critical</code>.</p>
+ *                <p>Severity: A patch severity. For example, <code>Critical</code>.</p>
  *             </li>
  *             <li>
  *                <p>DocumentName: An SSM document name. For example, <code>AWS-RunPatchBaseline</code>.</p>

diff --git a/clients/client-ssm/src/models/models_0.ts b/clients/client-ssm/src/models/models_0.ts
@@ -1842,8 +1842,8 @@ export interface CreateDocumentRequest {
 
   /**
    * <p>An optional field specifying the version of the artifact you are creating with the document.
-   *    For example, "Release 12, Update 6". This value is unique across all versions of a document, and
-   *    can't be changed.</p>
+   *    For example, <code>Release12.1</code>. This value is unique across all versions of a document,
+   *    and can't be changed.</p>
    */
   VersionName?: string;
 

diff --git a/clients/client-ssm/src/models/models_1.ts b/clients/client-ssm/src/models/models_1.ts
@@ -3357,17 +3357,22 @@ export interface GetServiceSettingRequest {
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/parameter-store/default-parameter-tier</code>
+   *                   <code>/ssm/managed-instance/activation-tier</code>
    *                </p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/parameter-store/high-throughput-enabled</code>
+   *                   <code>/ssm/opsinsights/opscenter</code>
    *                </p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/managed-instance/activation-tier</code>
+   *                   <code>/ssm/parameter-store/default-parameter-tier</code>
+   *                </p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>/ssm/parameter-store/high-throughput-enabled</code>
    *                </p>
    *             </li>
    *          </ul>
@@ -4330,6 +4335,10 @@ export interface CommandInvocation {
    *                <p>Terminated: The parent command exceeded its MaxErrors limit and subsequent command
    *      invocations were canceled by the system. This is a terminal state.</p>
    *             </li>
+   *             <li>
+   *                <p>Delayed: The system attempted to send the command to the managed node but wasn't
+   *      successful. The system retries again.</p>
+   *             </li>
    *          </ul>
    */
   StatusDetails?: string;
@@ -4464,9 +4473,11 @@ export interface Command {
   Comment?: string;
 
   /**
-   * <p>If this time is reached and the command hasn't already started running, it won't run.
-   *    Calculated based on the <code>ExpiresAfter</code> user input provided as part of the
-   *     <code>SendCommand</code> API operation.</p>
+   * <p>If a command expires, it changes status to <code>DeliveryTimedOut</code> for all invocations
+   *    that have the status <code>InProgress</code>, <code>Pending</code>, or <code>Delayed</code>.
+   *     <code>ExpiresAfter</code> is calculated based on the total timeout for the overall command. For
+   *    more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/monitor-commands.html?icmpid=docs_ec2_console#monitor-about-status-timeouts">Understanding command timeout values</a> in the
+   *    <i>Amazon Web Services Systems Manager User Guide</i>.</p>
    */
   ExpiresAfter?: Date;
 
@@ -4541,6 +4552,10 @@ export interface Command {
    *      limit for pending invocations. The system has canceled the command before running it on any
    *      managed node. This is a terminal state.</p>
    *             </li>
+   *             <li>
+   *                <p>Delayed: The system attempted to send the command to the managed node but wasn't
+   *      successful. The system retries again.</p>
+   *             </li>
    *          </ul>
    */
   StatusDetails?: string;
@@ -4837,8 +4852,9 @@ export interface ListComplianceSummariesRequest {
  */
 export interface SeveritySummary {
   /**
-   * <p>The total number of resources or compliance items that have a severity level of critical.
-   *    Critical severity is determined by the organization that published the compliance items.</p>
+   * <p>The total number of resources or compliance items that have a severity level of
+   *     <code>Critical</code>. Critical severity is determined by the organization that published the
+   *    compliance items.</p>
    */
   CriticalCount?: number;
 
@@ -7443,17 +7459,22 @@ export interface ResetServiceSettingRequest {
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/parameter-store/default-parameter-tier</code>
+   *                   <code>/ssm/managed-instance/activation-tier</code>
    *                </p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/parameter-store/high-throughput-enabled</code>
+   *                   <code>/ssm/opsinsights/opscenter</code>
    *                </p>
    *             </li>
    *             <li>
    *                <p>
-   *                   <code>/ssm/managed-instance/activation-tier</code>
+   *                   <code>/ssm/parameter-store/default-parameter-tier</code>
+   *                </p>
+   *             </li>
+   *             <li>
+   *                <p>
+   *                   <code>/ssm/parameter-store/high-throughput-enabled</code>
    *                </p>
    *             </li>
    *          </ul>
@@ -8160,9 +8181,12 @@ export interface StartSessionRequest {
   Target: string | undefined;
 
   /**
-   * <p>The name of the SSM document to define the parameters and plugin settings for the session.
-   *    For example, <code>SSM-SessionManagerRunShell</code>. You can call the <a>GetDocument</a> API to verify the document exists before attempting to start a session.
-   *    If no document name is provided, a shell to the managed node is launched by default.</p>
+   * <p>The name of the SSM document you want to use to define the type of session, input
+   *    parameters, or preferences for the session. For example, <code>SSM-SessionManagerRunShell</code>.
+   *    You can call the <a>GetDocument</a> API to verify the document exists before
+   *    attempting to start a session. If no document name is provided, a shell to the managed node is
+   *    launched by default. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-sessions-start.html">Start a
+   *     session</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
    */
   DocumentName?: string;