docs(client-opsworks): Documentation-only update for OpsWorks Stacks.

aws · May 23, 2024 · 211cb53 · 211cb53
1 parent 96e2acc
commit 211cb53
Show file tree

Hide file tree

Showing 29 changed files with 542 additions and 386 deletions.
diff --git a/clients/client-opsworks/README.md b/clients/client-opsworks/README.md
@@ -6,65 +6,62 @@
 
 AWS SDK for JavaScript OpsWorks Client for Node.js, Browser and React Native.
 
-<fullname>AWS OpsWorks</fullname>
+<fullname>OpsWorks</fullname>
 
-<p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
-usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
+<p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
+and
+usage examples for OpsWorks Stacks actions and data types, including common parameters and error
 codes. </p>
-<p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
-overseeing the complete application lifecycle. For information about this product, go to the
-<a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
-
+<p>OpsWorks Stacks is an application management service that provides an integrated experience for
+managing the complete application lifecycle. For information about OpsWorks, see the
+<a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
 <p>
 <b>SDKs and CLI</b>
 </p>
-<p>The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:</p>
+<p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
+Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
 <ul>
 <li>
 <p>
-<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
+<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
 </p>
 </li>
 <li>
 <p>
-<a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
+<a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
 </p>
 </li>
 <li>
 <p>
-<a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
-.NET</a>
+<a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
 </p>
 </li>
 <li>
 <p>
-<a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
-SDK for PHP 2</a>
+<a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
 </p>
 </li>
 <li>
 <p>
-<a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
+<a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
 </p>
 </li>
 <li>
 <p>
-<a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
+<a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
 </p>
 </li>
 <li>
 <p>
-<a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
-Python(Boto)</a>
+<a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
 </p>
 </li>
 </ul>
-
 <p>
 <b>Endpoints</b>
 </p>
-<p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
-can only be accessed or managed within the endpoint in which they are created.</p>
+<p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
+Stacks can only be accessed or managed within the endpoint in which they are created.</p>
 <ul>
 <li>
 <p>opsworks.us-east-1.amazonaws.com</p>
@@ -79,7 +76,7 @@ can only be accessed or managed within the endpoint in which they are created.</
 <p>opsworks.us-west-2.amazonaws.com</p>
 </li>
 <li>
-<p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
+<p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
 </li>
 <li>
 <p>opsworks.eu-west-1.amazonaws.com</p>
@@ -120,7 +117,8 @@ use the <code>ConfigurationManager</code> parameter to specify the Chef version.
 The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
 see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
 <note>
-<p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</p>
+<p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
+to Chef 12 as soon as possible.</p>
 </note>
 
 ## Installing

diff --git a/clients/client-opsworks/src/OpsWorks.ts b/clients/client-opsworks/src/OpsWorks.ts
@@ -1505,64 +1505,61 @@ export interface OpsWorks {
 }
 
 /**
- * <fullname>AWS OpsWorks</fullname>
- *          <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
- *       usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
+ * <fullname>OpsWorks</fullname>
+ *          <p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
+ *           and
+ *           usage examples for OpsWorks Stacks actions and data types, including common parameters and error
  *       codes. </p>
- *          <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
- *       overseeing the complete application lifecycle. For information about this product, go to the
- *         <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
- *
+ *          <p>OpsWorks Stacks is an application management service that provides an integrated experience for
+ *           managing the complete application lifecycle. For information about OpsWorks, see the
+ *           <a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
  *          <p>
  *             <b>SDKs and CLI</b>
  *          </p>
- *          <p>The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:</p>
+ *          <p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
+ *           Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
+ *                   <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
+ *                   <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
- *           .NET</a>
+ *                   <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
- *           SDK for PHP 2</a>
+ *                   <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
+ *                   <a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
+ *                   <a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
- *           Python(Boto)</a>
+ *                   <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
  *                </p>
  *             </li>
  *          </ul>
- *
  *          <p>
  *             <b>Endpoints</b>
  *          </p>
- *          <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
- *           can only be accessed or managed within the endpoint in which they are created.</p>
+ *          <p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
+ *           Stacks can only be accessed or managed within the endpoint in which they are created.</p>
  *          <ul>
  *             <li>
  *                <p>opsworks.us-east-1.amazonaws.com</p>
@@ -1577,7 +1574,7 @@ export interface OpsWorks {
  *                <p>opsworks.us-west-2.amazonaws.com</p>
  *             </li>
  *             <li>
- *                <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
+ *                <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
  *             </li>
  *             <li>
  *                <p>opsworks.eu-west-1.amazonaws.com</p>
@@ -1618,7 +1615,8 @@ export interface OpsWorks {
  *       The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
  *       see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
  *          <note>
- *             <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</p>
+ *             <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
+ *           to Chef 12 as soon as possible.</p>
  *          </note>
  * @public
  */

diff --git a/clients/client-opsworks/src/OpsWorksClient.ts b/clients/client-opsworks/src/OpsWorksClient.ts
@@ -546,64 +546,61 @@ export type OpsWorksClientResolvedConfigType = __SmithyResolvedConfiguration<__H
 export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConfigType {}
 
 /**
- * <fullname>AWS OpsWorks</fullname>
- *          <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
- *       usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
+ * <fullname>OpsWorks</fullname>
+ *          <p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
+ *           and
+ *           usage examples for OpsWorks Stacks actions and data types, including common parameters and error
  *       codes. </p>
- *          <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
- *       overseeing the complete application lifecycle. For information about this product, go to the
- *         <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
- *
+ *          <p>OpsWorks Stacks is an application management service that provides an integrated experience for
+ *           managing the complete application lifecycle. For information about OpsWorks, see the
+ *           <a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
  *          <p>
  *             <b>SDKs and CLI</b>
  *          </p>
- *          <p>The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:</p>
+ *          <p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
+ *           Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
  *          <ul>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
+ *                   <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
+ *                   <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
- *           .NET</a>
+ *                   <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
- *           SDK for PHP 2</a>
+ *                   <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
+ *                   <a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
+ *                   <a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
  *                </p>
  *             </li>
  *             <li>
  *                <p>
- *                   <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
- *           Python(Boto)</a>
+ *                   <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
  *                </p>
  *             </li>
  *          </ul>
- *
  *          <p>
  *             <b>Endpoints</b>
  *          </p>
- *          <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
- *           can only be accessed or managed within the endpoint in which they are created.</p>
+ *          <p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
+ *           Stacks can only be accessed or managed within the endpoint in which they are created.</p>
  *          <ul>
  *             <li>
  *                <p>opsworks.us-east-1.amazonaws.com</p>
@@ -618,7 +615,7 @@ export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConf
  *                <p>opsworks.us-west-2.amazonaws.com</p>
  *             </li>
  *             <li>
- *                <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
+ *                <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
  *             </li>
  *             <li>
  *                <p>opsworks.eu-west-1.amazonaws.com</p>
@@ -659,7 +656,8 @@ export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConf
  *       The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
  *       see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
  *          <note>
- *             <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</p>
+ *             <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
+ *           to Chef 12 as soon as possible.</p>
  *          </note>
  * @public
  */

diff --git a/clients/client-opsworks/src/commands/AssignInstanceCommand.ts b/clients/client-opsworks/src/commands/AssignInstanceCommand.ts
@@ -36,12 +36,12 @@ export interface AssignInstanceCommandOutput extends __MetadataBearer {}
  *                <p>You can assign registered Amazon EC2 instances only to custom layers.</p>
  *             </li>
  *             <li>
- *                <p>You cannot use this action with instances that were created with AWS OpsWorks Stacks.</p>
+ *                <p>You cannot use this action with instances that were created with OpsWorks Stacks.</p>
  *             </li>
  *          </ul>
  *          <p>
- *             <b>Required Permissions</b>: To use this action, an AWS Identity and Access Management
- *       (IAM) user must have a Manage permissions
+ *             <b>Required Permissions</b>: To use this action, an Identity and Access Management
+ *           (IAM) user must have a Manage permissions
  *       level for the stack or an attached policy that explicitly grants permissions. For more
  *       information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
  *         Permissions</a>.</p>

diff --git a/clients/client-opsworks/src/commands/AssignVolumeCommand.ts b/clients/client-opsworks/src/commands/AssignVolumeCommand.ts
@@ -32,7 +32,8 @@ export interface AssignVolumeCommandOutput extends __MetadataBearer {}
  *       volume, you must call <a>UpdateVolume</a> to specify a mount point before calling
  *         <code>AssignVolume</code>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>.</p>
  *          <p>
- *             <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions
+ *             <b>Required Permissions</b>: To use this action, an IAM user must have a Manage
+ *           permissions
  *       level for the stack, or an attached policy that explicitly grants permissions. For more
  *       information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
  *         Permissions</a>.</p>

diff --git a/clients/client-opsworks/src/commands/AssociateElasticIpCommand.ts b/clients/client-opsworks/src/commands/AssociateElasticIpCommand.ts
@@ -32,7 +32,8 @@ export interface AssociateElasticIpCommandOutput extends __MetadataBearer {}
  *       information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource
  *         Management</a>.</p>
  *          <p>
- *             <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions
+ *             <b>Required Permissions</b>: To use this action, an IAM user must have a
+ *           Manage permissions
  *       level for the stack, or an attached policy that explicitly grants permissions. For more
  *       information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
  *         Permissions</a>.</p>