2016/12/01 - AWS OpsWorks for Chef Automate - 15 new api methods
Changes Update opsworkscm client to latest version
Describes events for a specified server. Results are ordered by time, with newest events first.
This operation is synchronous.
A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.describe_events(
ServerName='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The name of the server for which you want to view events.
string
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 DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
integer
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
dict
Response Syntax
{
'ServerEvents': [
{
'CreatedAt': datetime(2015, 1, 1),
'ServerName': 'string',
'Message': 'string',
'LogUrl': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ServerEvents (list) --
Contains the response to a DescribeEvents request.
(dict) --
An event that is related to the server, such as the start of maintenance or backup.
CreatedAt (datetime) --
The time when the event occurred.
ServerName (string) --
The name of the server on or for which the event occurred.
Message (string) --
A human-readable informational or status message.
LogUrl (string) --
The Amazon S3 URL of the event's log file.
NextToken (string) --
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 DescribeEvents again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks for Chef Automate does not query other services.
This operation is synchronous.
A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.describe_servers(
ServerName='string',
NextToken='string',
MaxResults=123
)
string
Describes the server with the specified ServerName.
string
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 DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
integer
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
dict
Response Syntax
{
'Servers': [
{
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Servers (list) --
Contains the response to a DescribeServers request.
(dict) --
Describes a configuration management server.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef.
EngineModel (string) --
The engine model of the server. The valid value in this release is Single.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_PIVOTAL_KEY: 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.
CHEF_STARTER_KIT: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
NextToken (string) --
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 DescribeServers again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
See also: AWS API Documentation
Request Syntax
client.associate_node(
ServerName='string',
NodeName='string',
EngineAttributes=[
{
'Name': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
string
[REQUIRED]
list
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
dict
Response Syntax
{
'NodeAssociationStatusToken': 'string'
}
Response Structure
(dict) --
NodeAssociationStatusToken (string) --
Creates and immedately starts a new Server. The server can be used once it has reached the HEALTHY state.
This operation is asnychronous.
A LimitExceededException is thrown then the maximum number of server backup is reached. A ResourceAlreadyExistsException is raise when a server with the same name already exists in the account. A ResourceNotFoundException is thrown when a backupId is passed, but the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.
By default 10 servers can be created. A LimitExceededException is raised when the limit is exceeded.
When no security groups are provided by using SecurityGroupIds, AWS OpsWorks creates a new security group. This security group opens the Chef server to the world on TCP port 443. If a KeyName is present, SSH access is enabled. SSH is also open to the world on TCP port 22.
By default, the Chef Server is accessible from any IP address. We recommend that you update your security group rules to allow access from known IP addresses and address ranges only. To edit security group rules, open Security Groups in the navigation pane of the EC2 management console.
See also: AWS API Documentation
Request Syntax
client.create_server(
DisableAutomatedBackup=True|False,
Engine='string',
EngineModel='string',
EngineVersion='string',
EngineAttributes=[
{
'Name': 'string',
'Value': 'string'
},
],
BackupRetentionCount=123,
ServerName='string',
InstanceProfileArn='string',
InstanceType='string',
KeyPair='string',
PreferredMaintenanceWindow='string',
PreferredBackupWindow='string',
SecurityGroupIds=[
'string',
],
ServiceRoleArn='string',
SubnetIds=[
'string',
],
BackupId='string'
)
boolean
Enable or disable scheduled backups. Valid values are true or false. The default value is true.
string
The configuration management engine to use. Valid values include Chef.
string
The engine model, or option. Valid values include Single.
string
The major release version of the engine that you want to use. Values depend on the engine that you choose.
list
Engine attributes on a specified server.
Attributes accepted in a createServer request:
CHEF_PIVOTAL_KEY: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
integer
The number of automated backups that you want to keep. Whenever a new backup is created, AWS OpsWorks for Chef Automate deletes the oldest backups if this number is exceeded. The default value is 1.
string
[REQUIRED]
The name of the server. The server name must be unique within your AWS account, within each region. Server names must start with a letter; then letters, numbers, or hyphens (-) are allowed, up to a maximum of 32 characters.
string
[REQUIRED]
The ARN of the instance profile that your Amazon EC2 instances use. Although the AWS OpsWorks console typically creates the instance profile for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the instance profile you need.
string
The Amazon EC2 instance type to use. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large.
string
The Amazon EC2 key pair to set for the instance. You may specify this parameter to connect to your instances by using SSH.
string
The start time for a one-hour period each week during which AWS OpsWorks for Chef Automate performs maintenance on the instance. Valid values must be specified in the following format: DDD:HH:MM. The specified time is in coordinated universal time (UTC). The default value is a random one-hour period on Tuesday, Wednesday, or Friday. See TimeWindowDefinition for more information.
Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
string
The start time for a one-hour period during which AWS OpsWorks for Chef Automate backs up application-level data on your server if backups are enabled. Valid values must be specified in one of the following formats:
HH:MM for daily backups
DDD:HH:MM for weekly backups
The specified time is in coordinated universal time (UTC). The default value is a random, daily start time.
Example: 08:00, which represents a daily start time of 08:00 UTC.
Example: Mon:08:00, which represents a start time of every Monday at 08:00 UTC. (8:00 a.m.)
list
A list of security group IDs to attach to the Amazon EC2 instance. If you add this parameter, the specified security groups must be within the VPC that is specified by SubnetIds.
If you do not specify this parameter, AWS OpsWorks for Chef Automate creates one new security group that uses TCP ports 22 and 443, open to 0.0.0.0/0 (everyone).
(string) --
string
[REQUIRED]
The service role that the AWS OpsWorks for Chef Automate service backend uses to work with your account. Although the AWS OpsWorks console typically creates the service role for you, in this release of AWS OpsWorks for Chef Automate, run the service-role-creation.yaml AWS CloudFormation template, located at https://s3.amazonaws.com/opsworks-stuff/latest/service-role-creation.yaml. This template creates a stack that includes the service role that you need.
list
The IDs of subnets in which to launch the server EC2 instance.
Amazon EC2-Classic customers: This field is required. All servers must run within a VPC. The VPC must have "Auto Assign Public IP" enabled.
EC2-VPC customers: This field is optional. If you do not specify subnet IDs, your EC2 instances are created in a default subnet that is selected by Amazon EC2. If you specify subnet IDs, the VPC must have "Auto Assign Public IP" enabled.
For more information about supported Amazon EC2 platforms, see Supported Platforms.
(string) --
string
If you specify this field, AWS OpsWorks for Chef Automate creates the server by using the backup represented by BackupId.
dict
Response Syntax
{
'Server': {
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
The server that is created by the request.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef.
EngineModel (string) --
The engine model of the server. The valid value in this release is Single.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_PIVOTAL_KEY: 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.
CHEF_STARTER_KIT: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
Creates an application-level backup of a server. While the server is BACKING_UP, the server can not be modified and no additional backup can be created.
Backups can be created for RUNNING, HEALTHY and UNHEALTHY servers.
This operation is asnychronous.
By default 50 manual backups can be created.
A LimitExceededException is thrown then the maximum number of manual backup is reached. A InvalidStateException is thrown when the server is not in any of RUNNING, HEALTHY, UNHEALTHY. A ResourceNotFoundException is thrown when the server is not found. A ValidationException is thrown when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.create_backup(
ServerName='string',
Description='string'
)
string
[REQUIRED]
The name of the server that you want to back up.
string
A user-defined description of the backup.
dict
Response Syntax
{
'Backup': {
'BackupArn': 'string',
'BackupId': 'string',
'BackupType': 'AUTOMATED'|'MANUAL',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'S3DataSize': 123,
'S3DataUrl': 'string',
'S3LogUrl': 'string',
'SecurityGroupIds': [
'string',
],
'ServerName': 'string',
'ServiceRoleArn': 'string',
'Status': 'IN_PROGRESS'|'OK'|'FAILED'|'DELETING',
'StatusDescription': 'string',
'SubnetIds': [
'string',
],
'ToolsVersion': 'string',
'UserArn': 'string'
}
}
Response Structure
(dict) --
Backup (dict) --
Backup created by request.
BackupArn (string) --
The ARN of the backup.
BackupId (string) --
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
BackupType (string) --
The backup type. Valid values are automated or manual.
CreatedAt (datetime) --
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
Description (string) --
A user-provided description for a manual backup. This field is empty for automated backups.
Engine (string) --
The engine type that is obtained from the server when the backup is created.
EngineModel (string) --
The engine model that is obtained from the server when the backup is created.
EngineVersion (string) --
The engine version that is obtained from the server when the backup is created.
InstanceProfileArn (string) --
The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
InstanceType (string) --
The instance type that is obtained from the server when the backup is created.
KeyPair (string) --
The key pair that is obtained from the server when the backup is created.
PreferredBackupWindow (string) --
The preferred backup period that is obtained from the server when the backup is created.
PreferredMaintenanceWindow (string) --
The preferred maintenance period that is obtained from the server when the backup is created.
S3DataSize (integer) --
The size of the backup, in bytes. The size is returned by the instance in the command results.
S3DataUrl (string) --
The Amazon S3 URL of the backup's tar.gz file.
S3LogUrl (string) --
The Amazon S3 URL of the backup's log file.
SecurityGroupIds (list) --
The security group IDs that are obtained from the server when the backup is created.
(string) --
ServerName (string) --
The name of the server from which the backup was made.
ServiceRoleArn (string) --
The service role ARN that is obtained from the server when the backup is created.
Status (string) --
The status of a backup while in progress.
StatusDescription (string) --
An informational message about backup status.
SubnetIds (list) --
The subnet IDs that are obtained from the server when the backup is created.
(string) --
ToolsVersion (string) --
The version of AWS OpsWorks for Chef Automate-specific tools that is obtained from the server when the backup is created.
UserArn (string) --
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
Updates settings for a server.
This operation is synchronous.
See also: AWS API Documentation
Request Syntax
client.update_server(
DisableAutomatedBackup=True|False,
BackupRetentionCount=123,
ServerName='string',
PreferredMaintenanceWindow='string',
PreferredBackupWindow='string'
)
boolean
Setting DisableAutomatedBackup to true disables automated or scheduled backups. Automated backups are enabled by default.
integer
Sets the number of automated backups that you want to keep.
string
[REQUIRED]
The name of the server to update.
string
DDD:HH:MM (weekly start time) or HH:MM (daily start time).
Time windows always use coordinated universal time (UTC).
Valid strings for day of week ( DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, Sun.
string
DDD:HH:MM (weekly start time) or HH:MM (daily start time).
Time windows always use coordinated universal time (UTC).
Valid strings for day of week ( DDD) are: Mon, Tue, Wed, Thr, Fri, Sat, Sun.
dict
Response Syntax
{
'Server': {
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to a UpdateServer request.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef.
EngineModel (string) --
The engine model of the server. The valid value in this release is Single.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_PIVOTAL_KEY: 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.
CHEF_STARTER_KIT: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
See also: AWS API Documentation
Request Syntax
client.describe_node_association_status(
NodeAssociationStatusToken='string',
ServerName='string'
)
string
[REQUIRED]
string
[REQUIRED]
dict
Response Syntax
{
'NodeAssociationStatus': 'SUCCESS'|'FAILED'|'IN_PROGRESS'
}
Response Structure
(dict) --
NodeAssociationStatus (string) --
Updates engine specific attributes on a specified server. Server will enter the MODIFYING state when this operation is in progress. Only one update can take place at a time.
This operation can be use to reset Chef Server main API key ( CHEF_PIVOTAL_KEY).
This operation is asynchronous.
This operation can only be called for HEALTHY and UNHEALTHY servers. Otherwise a InvalidStateException is raised. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.update_server_engine_attributes(
ServerName='string',
AttributeName='string',
AttributeValue='string'
)
string
[REQUIRED]
The name of the server to update.
string
[REQUIRED]
The name of the engine attribute to update.
string
The value to set for the attribute.
dict
Response Syntax
{
'Server': {
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to an UpdateServerEngineAttributes request.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef.
EngineModel (string) --
The engine model of the server. The valid value in this release is Single.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_PIVOTAL_KEY: 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.
CHEF_STARTER_KIT: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
Describes backups. The results are ordered by time, with newest backups first. If you do not specify a BackupId or ServerName, the command returns all backups.
This operation is synchronous.
A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.describe_backups(
BackupId='string',
ServerName='string',
NextToken='string',
MaxResults=123
)
string
Describes a single backup.
string
Returns backups for the server with the specified ServerName.
string
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 DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
integer
To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.
dict
Response Syntax
{
'Backups': [
{
'BackupArn': 'string',
'BackupId': 'string',
'BackupType': 'AUTOMATED'|'MANUAL',
'CreatedAt': datetime(2015, 1, 1),
'Description': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'PreferredBackupWindow': 'string',
'PreferredMaintenanceWindow': 'string',
'S3DataSize': 123,
'S3DataUrl': 'string',
'S3LogUrl': 'string',
'SecurityGroupIds': [
'string',
],
'ServerName': 'string',
'ServiceRoleArn': 'string',
'Status': 'IN_PROGRESS'|'OK'|'FAILED'|'DELETING',
'StatusDescription': 'string',
'SubnetIds': [
'string',
],
'ToolsVersion': 'string',
'UserArn': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Backups (list) --
Contains the response to a DescribeBackups request.
(dict) --
Describes a single backup.
BackupArn (string) --
The ARN of the backup.
BackupId (string) --
The generated ID of the backup. Example: myServerName-yyyyMMddHHmmssSSS
BackupType (string) --
The backup type. Valid values are automated or manual.
CreatedAt (datetime) --
The time stamp when the backup was created in the database. Example: 2016-07-29T13:38:47.520Z
Description (string) --
A user-provided description for a manual backup. This field is empty for automated backups.
Engine (string) --
The engine type that is obtained from the server when the backup is created.
EngineModel (string) --
The engine model that is obtained from the server when the backup is created.
EngineVersion (string) --
The engine version that is obtained from the server when the backup is created.
InstanceProfileArn (string) --
The EC2 instance profile ARN that is obtained from the server when the backup is created. Because this value is stored, you are not required to provide the InstanceProfileArn again if you restore a backup.
InstanceType (string) --
The instance type that is obtained from the server when the backup is created.
KeyPair (string) --
The key pair that is obtained from the server when the backup is created.
PreferredBackupWindow (string) --
The preferred backup period that is obtained from the server when the backup is created.
PreferredMaintenanceWindow (string) --
The preferred maintenance period that is obtained from the server when the backup is created.
S3DataSize (integer) --
The size of the backup, in bytes. The size is returned by the instance in the command results.
S3DataUrl (string) --
The Amazon S3 URL of the backup's tar.gz file.
S3LogUrl (string) --
The Amazon S3 URL of the backup's log file.
SecurityGroupIds (list) --
The security group IDs that are obtained from the server when the backup is created.
(string) --
ServerName (string) --
The name of the server from which the backup was made.
ServiceRoleArn (string) --
The service role ARN that is obtained from the server when the backup is created.
Status (string) --
The status of a backup while in progress.
StatusDescription (string) --
An informational message about backup status.
SubnetIds (list) --
The subnet IDs that are obtained from the server when the backup is created.
(string) --
ToolsVersion (string) --
The version of AWS OpsWorks for Chef Automate-specific tools that is obtained from the server when the backup is created.
UserArn (string) --
The IAM user ARN of the requester for manual backups. This field is empty for automated backups.
NextToken (string) --
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 DescribeBackups again, and assign the token from the previous results as the value of the nextToken parameter. If there are no more results, the response object's nextToken parameter value is null. Setting a nextToken value that was not returned in your previous results causes an InvalidNextTokenException to occur.
Deletes a backup. You can delete both manual and automated backups.
This operation is asynchronous.
A InvalidStateException is thrown then a backup is already deleting. A ResourceNotFoundException is thrown when the backup does not exist. A ValidationException is thrown when parameters of the request are not valid.
See also: AWS API Documentation
Request Syntax
client.delete_backup(
BackupId='string'
)
string
[REQUIRED]
The ID of the backup to delete. Run the DescribeBackups command to get a list of backup IDs. Backup IDs are in the format ServerName-yyyyMMddHHmmssSSS.
dict
Response Syntax
{}
Response Structure
(dict) --
Restores a backup to a server that is in a RUNNING, FAILED, or HEALTHY 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 all of the server's client devices should continue to work.
This operation is asynchronous.
A InvalidStateException is thrown when the server is not in a valid state. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.restore_server(
BackupId='string',
ServerName='string',
InstanceType='string',
KeyPair='string'
)
string
[REQUIRED]
The ID of the backup that you want to use to restore a server.
string
[REQUIRED]
The name of the server that you want to restore.
string
The type of the instance to create. Valid values must be specified in the following format: ^([cm][34]|t2).* For example, c3.large. If you do not specify this parameter, RestoreServer uses the instance type from the specified backup.
string
The name of the key pair to set on the new EC2 instance. This can be helpful if any of the administrators who manage the server no longer have the SSH key.
dict
Response Syntax
{}
Response Structure
(dict) --
Deletes the server and the underlying AWS CloudFormation stack (including the server's EC2 instance). The server status updated to DELETING. Once the server is successfully deleted, it will no longer be returned by DescribeServer requests. If the AWS CloudFormation stack cannot be deleted, the server cannot be deleted.
This operation is asynchronous.
A InvalidStateException is thrown then a server is already deleting. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.delete_server(
ServerName='string'
)
string
[REQUIRED]
The ID of the server to delete.
dict
Response Syntax
{}
Response Structure
(dict) --
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 will switch to UNDER_MAINTENANCE state, while maintenace is in progress.
Maintenace can only be started for HEALTHY and UNHEALTHY servers. A InvalidStateException is thrown otherwise. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are invalid.
See also: AWS API Documentation
Request Syntax
client.start_maintenance(
ServerName='string'
)
string
[REQUIRED]
The name of the server on which to run maintenance.
dict
Response Syntax
{
'Server': {
'BackupRetentionCount': 123,
'ServerName': 'string',
'CreatedAt': datetime(2015, 1, 1),
'DisableAutomatedBackup': True|False,
'Endpoint': 'string',
'Engine': 'string',
'EngineModel': 'string',
'EngineAttributes': [
{
'Name': 'string',
'Value': 'string'
},
],
'EngineVersion': 'string',
'InstanceProfileArn': 'string',
'InstanceType': 'string',
'KeyPair': 'string',
'MaintenanceStatus': 'SUCCESS'|'FAILED',
'PreferredMaintenanceWindow': 'string',
'PreferredBackupWindow': 'string',
'SecurityGroupIds': [
'string',
],
'ServiceRoleArn': 'string',
'Status': 'BACKING_UP'|'CONNECTION_LOST'|'CREATING'|'DELETING'|'MODIFYING'|'FAILED'|'HEALTHY'|'RUNNING'|'SETUP'|'UNDER_MAINTENANCE'|'UNHEALTHY',
'StatusReason': 'string',
'SubnetIds': [
'string',
],
'ServerArn': 'string'
}
}
Response Structure
(dict) --
Server (dict) --
Contains the response to a StartMaintenance request.
BackupRetentionCount (integer) --
The number of automated backups to keep.
ServerName (string) --
The name of the server.
CreatedAt (datetime) --
Time stamp of server creation. Example 2016-07-29T13:38:47.520Z
DisableAutomatedBackup (boolean) --
Disables automated backups. The number of stored backups is dependent on the value of PreferredBackupCount.
Endpoint (string) --
A DNS name that can be used to access the engine. Example: myserver-asdfghjkl.us-east-1.opsworks.io
Engine (string) --
The engine type of the server. The valid value in this release is Chef.
EngineModel (string) --
The engine model of the server. The valid value in this release is Single.
EngineAttributes (list) --
The response of a createServer() request returns the master credential to access the server in EngineAttributes. These credentials are not stored by AWS OpsWorks for Chef Automate; they are returned only as part of the result of createServer().
Attributes returned in a createServer response:
CHEF_PIVOTAL_KEY: 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.
CHEF_STARTER_KIT: 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.
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
EngineVersion (string) --
The engine version of the server. Because Chef is the engine available in this release, the valid value for EngineVersion is 12.
InstanceProfileArn (string) --
The instance profile ARN of the server.
InstanceType (string) --
The instance type for the server, as specified in the CloudFormation stack. This might not be the same instance type that is shown in the EC2 console.
KeyPair (string) --
The key pair associated with the server.
MaintenanceStatus (string) --
The status of the most recent server maintenance run. Shows SUCCESS or FAILED.
PreferredMaintenanceWindow (string) --
The preferred maintenance period specified for the server.
PreferredBackupWindow (string) --
The preferred backup period specified for the server.
SecurityGroupIds (list) --
The security group IDs for the server, as specified in the CloudFormation stack. These might not be the same security groups that are shown in the EC2 console.
(string) --
ServiceRoleArn (string) --
The service role ARN used to create the server.
Status (string) --
The server's status. This field displays the states of actions in progress, such as creating, running, or backing up the server, as well as server health.
StatusReason (string) --
Depending on the server status, this field has either a human-readable message (such as a create or backup error), or an escaped block of JSON (used for health check results).
SubnetIds (list) --
The subnet IDs specified in a CreateServer request.
(string) --
ServerArn (string) --
The ARN of the server.
Describes your account attributes, and creates requests to increase limits before they are reached or exceeded.
This operation is synchronous.
See also: AWS API Documentation
Request Syntax
client.describe_account_attributes()
dict
Response Syntax
{
'Attributes': [
{
'Name': 'string',
'Maximum': 123,
'Used': 123
},
]
}
Response Structure
(dict) --
Attributes (list) --
The attributes that are currently set for the account.
(dict) --
Stores account attributes.
Name (string) --
The attribute name. The following are supported attribute names.
ServerLimit: The number of servers that currently existing / maximal allowed. By default 10 servers can be created.
ManualBackupLimit: The number of manual backups that currently exist / are maximal allowed. By default 50 manual backups can be created.
Maximum (integer) --
The maximum allowed value.
Used (integer) --
The current usage, such as the current number of servers associated with the account.
See also: AWS API Documentation
Request Syntax
client.disassociate_node(
ServerName='string',
NodeName='string',
EngineAttributes=[
{
'Name': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
string
[REQUIRED]
list
(dict) --
A name/value pair that is specific to the engine of the server.
Name (string) --
The name of the engine attribute.
Value (string) --
The value of the engine attribute.
dict
Response Syntax
{
'NodeAssociationStatusToken': 'string'
}
Response Structure
(dict) --
NodeAssociationStatusToken (string) --