Skip to content

Commit 211cb53

Browse files
author
awstools
committed
docs(client-opsworks): Documentation-only update for OpsWorks Stacks.
1 parent 96e2acc commit 211cb53

29 files changed

+542
-386
lines changed

‎clients/client-opsworks/README.md

+21-23
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,62 @@
66

77
AWS SDK for JavaScript OpsWorks Client for Node.js, Browser and React Native.
88

9-
<fullname>AWS OpsWorks</fullname>
9+
<fullname>OpsWorks</fullname>
1010

11-
<p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
12-
usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
11+
<p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
12+
and
13+
usage examples for OpsWorks Stacks actions and data types, including common parameters and error
1314
codes. </p>
14-
<p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
15-
overseeing the complete application lifecycle. For information about this product, go to the
16-
<a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
17-
15+
<p>OpsWorks Stacks is an application management service that provides an integrated experience for
16+
managing the complete application lifecycle. For information about OpsWorks, see the
17+
<a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
1818
<p>
1919
<b>SDKs and CLI</b>
2020
</p>
21-
<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>
21+
<p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
22+
Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
2223
<ul>
2324
<li>
2425
<p>
25-
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
26+
<a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
2627
</p>
2728
</li>
2829
<li>
2930
<p>
30-
<a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
31+
<a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
3132
</p>
3233
</li>
3334
<li>
3435
<p>
35-
<a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
36-
.NET</a>
36+
<a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
3737
</p>
3838
</li>
3939
<li>
4040
<p>
41-
<a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
42-
SDK for PHP 2</a>
41+
<a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
4342
</p>
4443
</li>
4544
<li>
4645
<p>
47-
<a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
46+
<a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
4847
</p>
4948
</li>
5049
<li>
5150
<p>
52-
<a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
51+
<a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
5352
</p>
5453
</li>
5554
<li>
5655
<p>
57-
<a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
58-
Python(Boto)</a>
56+
<a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
5957
</p>
6058
</li>
6159
</ul>
62-
6360
<p>
6461
<b>Endpoints</b>
6562
</p>
66-
<p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
67-
can only be accessed or managed within the endpoint in which they are created.</p>
63+
<p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
64+
Stacks can only be accessed or managed within the endpoint in which they are created.</p>
6865
<ul>
6966
<li>
7067
<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.</
7976
<p>opsworks.us-west-2.amazonaws.com</p>
8077
</li>
8178
<li>
82-
<p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
79+
<p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
8380
</li>
8481
<li>
8582
<p>opsworks.eu-west-1.amazonaws.com</p>
@@ -120,7 +117,8 @@ use the <code>ConfigurationManager</code> parameter to specify the Chef version.
120117
The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
121118
see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
122119
<note>
123-
<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>
120+
<p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
121+
to Chef 12 as soon as possible.</p>
124122
</note>
125123

126124
## Installing

‎clients/client-opsworks/src/OpsWorks.ts

+21-23
Original file line numberDiff line numberDiff line change
@@ -1505,64 +1505,61 @@ export interface OpsWorks {
15051505
}
15061506

15071507
/**
1508-
* <fullname>AWS OpsWorks</fullname>
1509-
* <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
1510-
* usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
1508+
* <fullname>OpsWorks</fullname>
1509+
* <p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
1510+
* and
1511+
* usage examples for OpsWorks Stacks actions and data types, including common parameters and error
15111512
* codes. </p>
1512-
* <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
1513-
* overseeing the complete application lifecycle. For information about this product, go to the
1514-
* <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
1515-
*
1513+
* <p>OpsWorks Stacks is an application management service that provides an integrated experience for
1514+
* managing the complete application lifecycle. For information about OpsWorks, see the
1515+
* <a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
15161516
* <p>
15171517
* <b>SDKs and CLI</b>
15181518
* </p>
1519-
* <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>
1519+
* <p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
1520+
* Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
15201521
* <ul>
15211522
* <li>
15221523
* <p>
1523-
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
1524+
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
15241525
* </p>
15251526
* </li>
15261527
* <li>
15271528
* <p>
1528-
* <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
1529+
* <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
15291530
* </p>
15301531
* </li>
15311532
* <li>
15321533
* <p>
1533-
* <a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
1534-
* .NET</a>
1534+
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
15351535
* </p>
15361536
* </li>
15371537
* <li>
15381538
* <p>
1539-
* <a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
1540-
* SDK for PHP 2</a>
1539+
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
15411540
* </p>
15421541
* </li>
15431542
* <li>
15441543
* <p>
1545-
* <a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
1544+
* <a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
15461545
* </p>
15471546
* </li>
15481547
* <li>
15491548
* <p>
1550-
* <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
1549+
* <a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
15511550
* </p>
15521551
* </li>
15531552
* <li>
15541553
* <p>
1555-
* <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
1556-
* Python(Boto)</a>
1554+
* <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
15571555
* </p>
15581556
* </li>
15591557
* </ul>
1560-
*
15611558
* <p>
15621559
* <b>Endpoints</b>
15631560
* </p>
1564-
* <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
1565-
* can only be accessed or managed within the endpoint in which they are created.</p>
1561+
* <p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
1562+
* Stacks can only be accessed or managed within the endpoint in which they are created.</p>
15661563
* <ul>
15671564
* <li>
15681565
* <p>opsworks.us-east-1.amazonaws.com</p>
@@ -1577,7 +1574,7 @@ export interface OpsWorks {
15771574
* <p>opsworks.us-west-2.amazonaws.com</p>
15781575
* </li>
15791576
* <li>
1580-
* <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
1577+
* <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
15811578
* </li>
15821579
* <li>
15831580
* <p>opsworks.eu-west-1.amazonaws.com</p>
@@ -1618,7 +1615,8 @@ export interface OpsWorks {
16181615
* The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
16191616
* see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
16201617
* <note>
1621-
* <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>
1618+
* <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
1619+
* to Chef 12 as soon as possible.</p>
16221620
* </note>
16231621
* @public
16241622
*/

‎clients/client-opsworks/src/OpsWorksClient.ts

+21-23
Original file line numberDiff line numberDiff line change
@@ -546,64 +546,61 @@ export type OpsWorksClientResolvedConfigType = __SmithyResolvedConfiguration<__H
546546
export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConfigType {}
547547

548548
/**
549-
* <fullname>AWS OpsWorks</fullname>
550-
* <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and
551-
* usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error
549+
* <fullname>OpsWorks</fullname>
550+
* <p>Welcome to the <i>OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax,
551+
* and
552+
* usage examples for OpsWorks Stacks actions and data types, including common parameters and error
552553
* codes. </p>
553-
* <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for
554-
* overseeing the complete application lifecycle. For information about this product, go to the
555-
* <a href="http://aws.amazon.com/opsworks/">AWS OpsWorks</a> details page. </p>
556-
*
554+
* <p>OpsWorks Stacks is an application management service that provides an integrated experience for
555+
* managing the complete application lifecycle. For information about OpsWorks, see the
556+
* <a href="http://aws.amazon.com/opsworks/">OpsWorks</a> information page.</p>
557557
* <p>
558558
* <b>SDKs and CLI</b>
559559
* </p>
560-
* <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>
560+
* <p>Use the OpsWorks Stacks API by using the Command Line Interface (CLI) or by using one of the
561+
* Amazon Web Services SDKs to implement applications in your preferred language. For more information, see:</p>
561562
* <ul>
562563
* <li>
563564
* <p>
564-
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">AWS CLI</a>
565+
* <a href="https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html">CLI</a>
565566
* </p>
566567
* </li>
567568
* <li>
568569
* <p>
569-
* <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">AWS SDK for Java</a>
570+
* <a href="https://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html">SDK for Java</a>
570571
* </p>
571572
* </li>
572573
* <li>
573574
* <p>
574-
* <a href="https://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm">AWS SDK for
575-
* .NET</a>
575+
* <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/OpsWorks/NOpsWorks.html">SDK for .NET</a>
576576
* </p>
577577
* </li>
578578
* <li>
579579
* <p>
580-
* <a href="https://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html">AWS
581-
* SDK for PHP 2</a>
580+
* <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/class-Aws.OpsWorks.OpsWorksClient.html">SDK for PHP</a>
582581
* </p>
583582
* </li>
584583
* <li>
585584
* <p>
586-
* <a href="http://docs.aws.amazon.com/sdkforruby/api/">AWS SDK for Ruby</a>
585+
* <a href="http://docs.aws.amazon.com/sdkforruby/api/">SDK for Ruby</a>
587586
* </p>
588587
* </li>
589588
* <li>
590589
* <p>
591-
* <a href="http://aws.amazon.com/documentation/sdkforjavascript/">AWS SDK for Node.js</a>
590+
* <a href="http://aws.amazon.com/documentation/sdkforjavascript/">Amazon Web Services SDK for Node.js</a>
592591
* </p>
593592
* </li>
594593
* <li>
595594
* <p>
596-
* <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">AWS SDK for
597-
* Python(Boto)</a>
595+
* <a href="http://docs.pythonboto.org/en/latest/ref/opsworks.html">SDK for Python (Boto)</a>
598596
* </p>
599597
* </li>
600598
* </ul>
601-
*
602599
* <p>
603600
* <b>Endpoints</b>
604601
* </p>
605-
* <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks
606-
* can only be accessed or managed within the endpoint in which they are created.</p>
602+
* <p>OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints.
603+
* Stacks can only be accessed or managed within the endpoint in which they are created.</p>
607604
* <ul>
608605
* <li>
609606
* <p>opsworks.us-east-1.amazonaws.com</p>
@@ -618,7 +615,7 @@ export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConf
618615
* <p>opsworks.us-west-2.amazonaws.com</p>
619616
* </li>
620617
* <li>
621-
* <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p>
618+
* <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the Amazon Web Services Management Console)</p>
622619
* </li>
623620
* <li>
624621
* <p>opsworks.eu-west-1.amazonaws.com</p>
@@ -659,7 +656,8 @@ export interface OpsWorksClientResolvedConfig extends OpsWorksClientResolvedConf
659656
* The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information,
660657
* see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html">Chef Versions</a>.</p>
661658
* <note>
662-
* <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>
659+
* <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks
660+
* to Chef 12 as soon as possible.</p>
663661
* </note>
664662
* @public
665663
*/

‎clients/client-opsworks/src/commands/AssignInstanceCommand.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ export interface AssignInstanceCommandOutput extends __MetadataBearer {}
3636
* <p>You can assign registered Amazon EC2 instances only to custom layers.</p>
3737
* </li>
3838
* <li>
39-
* <p>You cannot use this action with instances that were created with AWS OpsWorks Stacks.</p>
39+
* <p>You cannot use this action with instances that were created with OpsWorks Stacks.</p>
4040
* </li>
4141
* </ul>
4242
* <p>
43-
* <b>Required Permissions</b>: To use this action, an AWS Identity and Access Management
44-
* (IAM) user must have a Manage permissions
43+
* <b>Required Permissions</b>: To use this action, an Identity and Access Management
44+
* (IAM) user must have a Manage permissions
4545
* level for the stack or an attached policy that explicitly grants permissions. For more
4646
* information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
4747
* Permissions</a>.</p>

‎clients/client-opsworks/src/commands/AssignVolumeCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface AssignVolumeCommandOutput extends __MetadataBearer {}
3232
* volume, you must call <a>UpdateVolume</a> to specify a mount point before calling
3333
* <code>AssignVolume</code>. For more information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource Management</a>.</p>
3434
* <p>
35-
* <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions
35+
* <b>Required Permissions</b>: To use this action, an IAM user must have a Manage
36+
* permissions
3637
* level for the stack, or an attached policy that explicitly grants permissions. For more
3738
* information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
3839
* Permissions</a>.</p>

‎clients/client-opsworks/src/commands/AssociateElasticIpCommand.ts

+2-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ export interface AssociateElasticIpCommandOutput extends __MetadataBearer {}
3232
* information, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/resources.html">Resource
3333
* Management</a>.</p>
3434
* <p>
35-
* <b>Required Permissions</b>: To use this action, an IAM user must have a Manage permissions
35+
* <b>Required Permissions</b>: To use this action, an IAM user must have a
36+
* Manage permissions
3637
* level for the stack, or an attached policy that explicitly grants permissions. For more
3738
* information on user permissions, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html">Managing User
3839
* Permissions</a>.</p>

0 commit comments

Comments
 (0)