Skip to content

Commit

Permalink
Update models for release
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-sdk-php-automation committed Jan 3, 2019
1 parent a0353c2 commit 2e69023
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
7 changes: 7 additions & 0 deletions .changes/3.82.4
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[
{
"type": "enhancement",
"category": "OpsWorksCM",
"description": "Documentation updates for opsworkscm"
}
]
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## next release

* `Aws\OpsWorksCM` - Documentation updates for opsworkscm

## 3.82.3 - 2018-12-21

* `Aws\ACMPCA` - This release marks the introduction of waiters in ACM PCA, which allow you to control the progression of your code based on the presence or state of certain resources. Waiters can be implemented in the DescribeCertificateAuthorityAuditReport, GetCertificate, and GetCertificateAuthorityCsr API operations.
Expand Down
12 changes: 6 additions & 6 deletions src/data/opsworkscm/2016-11-01/docs-2.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"RestoreServer": "<p> Restores a backup to a server that is in a <code>CONNECTION_LOST</code>, <code>HEALTHY</code>, <code>RUNNING</code>, <code>UNHEALTHY</code>, or <code>TERMINATED</code> state. When you run RestoreServer, the server's EC2 instance is deleted, and a new EC2 instance is configured. RestoreServer maintains the existing server endpoint, so configuration management of the server's client devices (nodes) should continue to work. </p> <p> This operation is asynchronous. </p> <p> An <code>InvalidStateException</code> is thrown when the server is not in a valid state. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>",
"StartMaintenance": "<p> Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying cause of maintenance failure has been resolved. The server is in an <code>UNDER_MAINTENANCE</code> state while maintenance is in progress. </p> <p> Maintenance can only be started on servers in <code>HEALTHY</code> and <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is thrown. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>",
"UpdateServer": "<p> Updates settings for a server. </p> <p> This operation is synchronous. </p>",
"UpdateServerEngineAttributes": "<p> Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's private key (<code>CHEF_PIVOTAL_KEY</code>), a Chef server's admin password (<code>CHEF_DELIVERY_ADMIN_PASSWORD</code>), or a Puppet server's admin password (<code>PUPPET_ADMIN_PASSWORD</code>). </p> <p> This operation is asynchronous. </p> <p> This operation can only be called for servers in <code>HEALTHY</code> or <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is raised. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>"
"UpdateServerEngineAttributes": "<p> Updates engine-specific attributes on a specified server. The server enters the <code>MODIFYING</code> state when this operation is in progress. Only one update can occur at a time. You can use this command to reset a Chef server's private key (<code>CHEF_PIVOTAL_KEY</code>) or a Puppet server's admin password (<code>PUPPET_ADMIN_PASSWORD</code>). </p> <p> This operation is asynchronous. </p> <p> This operation can only be called for servers in <code>HEALTHY</code> or <code>UNHEALTHY</code> states. Otherwise, an <code>InvalidStateException</code> is raised. A <code>ResourceNotFoundException</code> is thrown when the server does not exist. A <code>ValidationException</code> is raised when parameters of the request are not valid. </p>"
},
"shapes": {
"AccountAttribute": {
Expand Down Expand Up @@ -209,7 +209,7 @@
"base": "<p>A name and value pair that is specific to the engine of the server. </p>",
"refs": {
"EngineAttributes$member": null,
"ExportServerEngineAttributeResponse$EngineAttribute": "<p>The requested engine attribute pair with attribute name and value. </p>"
"ExportServerEngineAttributeResponse$EngineAttribute": "<p>The requested engine attribute pair with attribute name and value.</p>"
}
},
"EngineAttributeName": {
Expand All @@ -231,7 +231,7 @@
"CreateServerRequest$EngineAttributes": "<p>Optional engine attributes on a specified server. </p> <p class=\"title\"> <b>Attributes accepted in a Chef createServer request:</b> </p> <ul> <li> <p> <code>CHEF_PIVOTAL_KEY</code>: A base64-encoded RSA private key that is not stored by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API. When no CHEF_PIVOTAL_KEY is set, one is generated and returned in the response. </p> </li> <li> <p> <code>CHEF_DELIVERY_ADMIN_PASSWORD</code>: The password for the administrative user in the Chef Automate GUI. The password length is a minimum of eight characters, and a maximum of 32. The password can contain letters, numbers, and special characters (!/@#$%^&amp;+=_). The password must contain at least one lower case letter, one upper case letter, one number, and one special character. When no CHEF_DELIVERY_ADMIN_PASSWORD is set, one is generated and returned in the response.</p> </li> </ul> <p class=\"title\"> <b>Attributes accepted in a Puppet createServer request:</b> </p> <ul> <li> <p> <code>PUPPET_ADMIN_PASSWORD</code>: To work with the Puppet Enterprise console, a password must use ASCII characters.</p> </li> </ul>",
"DescribeNodeAssociationStatusResponse$EngineAttributes": "<p>Attributes specific to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certificate (the result of the CSR). </p>",
"DisassociateNodeRequest$EngineAttributes": "<p>Engine attributes that are used for disassociating the node. No attributes are required for Puppet. </p> <p class=\"title\"> <b>Attributes required in a DisassociateNode request for Chef</b> </p> <ul> <li> <p> <code>CHEF_ORGANIZATION</code>: The Chef organization with which the node was associated. By default only one organization named <code>default</code> can exist. </p> </li> </ul>",
"ExportServerEngineAttributeRequest$InputAttributes": "<p>The list of engine attributes. The list type is <code>EngineAttribute</code>. <code>EngineAttribute</code> is a pair of attribute name and value. For <code>ExportAttributeName</code> \"Userdata\", currently supported input attribute names are: - \"RunList\": For Chef, an ordered list of roles and/or recipes that are run in the exact order. For Puppet, this parameter is ignored. - \"OrganizationName\": For Chef, an organization name. AWS OpsWorks for Chef Server always creates the organization \"default\". For Puppet, this parameter is ignored. - \"NodeEnvironment\": For Chef, a node environment (eg. development, staging, onebox). For Puppet, this parameter is ignored. - \"NodeClientVersion\": For Chef, version of Chef Engine (3 numbers separated by dots, eg. \"13.8.5\"). If empty, it uses the latest one. For Puppet, this parameter is ignored. </p>",
"ExportServerEngineAttributeRequest$InputAttributes": "<p>The list of engine attributes. The list type is <code>EngineAttribute</code>. An <code>EngineAttribute</code> list item is a pair that includes an attribute name and its value. For the <code>Userdata</code> ExportAttributeName, the following are supported engine attribute names.</p> <ul> <li> <p> <b>RunList</b> In Chef, a list of roles or recipes that are run in the specified order. In Puppet, this parameter is ignored.</p> </li> <li> <p> <b>OrganizationName</b> In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization <code>default</code>. In Puppet, this parameter is ignored.</p> </li> <li> <p> <b>NodeEnvironment</b> In Chef, a node environment (for example, development, staging, or one-box). In Puppet, this parameter is ignored.</p> </li> <li> <p> <b>NodeClientVersion</b> In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.</p> </li> </ul>",
"Server$EngineAttributes": "<p>The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks CM; they are returned only as part of the result of createServer(). </p> <p class=\"title\"> <b>Attributes returned in a createServer response for Chef</b> </p> <ul> <li> <p> <code>CHEF_PIVOTAL_KEY</code>: A base64-encoded RSA private key that is generated by AWS OpsWorks for Chef Automate. This private key is required to access the Chef API.</p> </li> <li> <p> <code>CHEF_STARTER_KIT</code>: A base64-encoded ZIP file. The ZIP file contains a Chef starter kit, which includes a README, a configuration file, and the required RSA private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents. From this directory, you can run Knife commands.</p> </li> </ul> <p class=\"title\"> <b>Attributes returned in a createServer response for Puppet</b> </p> <ul> <li> <p> <code>PUPPET_STARTER_KIT</code>: A base64-encoded ZIP file. The ZIP file contains a Puppet starter kit, including a README and a required private key. Save this file, unzip it, and then change to the directory where you've unzipped the file contents.</p> </li> <li> <p> <code>PUPPET_ADMIN_PASSWORD</code>: An administrator password that you can use to sign in to the Puppet Enterprise console after the server is online.</p> </li> </ul>",
"StartMaintenanceRequest$EngineAttributes": "<p>Engine attributes that are specific to the server on which you want to run maintenance. </p>"
}
Expand Down Expand Up @@ -382,8 +382,8 @@
"DescribeNodeAssociationStatusRequest$ServerName": "<p>The name of the server from which to disassociate the node. </p>",
"DescribeServersRequest$ServerName": "<p>Describes the server with the specified ServerName.</p>",
"DisassociateNodeRequest$ServerName": "<p>The name of the server from which to disassociate the node. </p>",
"ExportServerEngineAttributeRequest$ServerName": "<p>The name of the Server to which the attribute is being exported from </p>",
"ExportServerEngineAttributeResponse$ServerName": "<p>The requested ServerName. </p>",
"ExportServerEngineAttributeRequest$ServerName": "<p>The name of the server from which you are exporting the attribute.</p>",
"ExportServerEngineAttributeResponse$ServerName": "<p>The server name used in the request.</p>",
"RestoreServerRequest$ServerName": "<p> The name of the server that you want to restore. </p>",
"StartMaintenanceRequest$ServerName": "<p>The name of the server on which to run maintenance. </p>",
"UpdateServerEngineAttributesRequest$ServerName": "<p>The name of the server to update. </p>",
Expand Down Expand Up @@ -444,7 +444,7 @@
"DescribeBackupsResponse$NextToken": "<p>This is not currently implemented for <code>DescribeBackups</code> requests.</p>",
"DescribeEventsResponse$NextToken": "<p>NextToken is a string that is returned in some command responses. It indicates that not all entries have been returned, and that you must run at least one more request to get remaining items. To get remaining results, call <code>DescribeEvents</code> again, and assign the token from the previous results as the value of the <code>nextToken</code> parameter. If there are no more results, the response object's <code>nextToken</code> parameter value is <code>null</code>. Setting a <code>nextToken</code> value that was not returned in your previous results causes an <code>InvalidNextTokenException</code> to occur. </p>",
"DescribeServersResponse$NextToken": "<p>This is not currently implemented for <code>DescribeServers</code> requests. </p>",
"ExportServerEngineAttributeRequest$ExportAttributeName": "<p>The name of the export attribute. Currently supported export attribute is \"Userdata\" which exports a userdata script filled out with parameters provided in the <code>InputAttributes</code> list.</p>",
"ExportServerEngineAttributeRequest$ExportAttributeName": "<p>The name of the export attribute. Currently, the supported export attribute is <code>Userdata</code>. This exports a user data script that includes parameters and values provided in the <code>InputAttributes</code> list.</p>",
"InvalidNextTokenException$Message": "<p>Error or informational message that can contain more detail about a nextToken failure. </p>",
"InvalidStateException$Message": "<p>Error or informational message that provides more detail if a resource is in a state that is not valid for performing a specified action. </p>",
"LimitExceededException$Message": "<p>Error or informational message that the maximum allowed number of servers or backups has been exceeded. </p>",
Expand Down
2 changes: 1 addition & 1 deletion src/data/opsworkscm/2016-11-01/docs-2.json.php

Large diffs are not rendered by default.

0 comments on commit 2e69023

Please sign in to comment.