Response Syntax

{ "Attributes": [ {

"Maximum": number, "Name": "string", "Used": number }

] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Attributes (p. 22)

The attributes that are currently set for the account.

Type: Array of AccountAttribute (p. 61) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

DescribeBackups

Describes backups. The results are ordered by time, with newest backups ﬁrst. 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 not valid.

Request Syntax

{ "BackupId": "string", "MaxResults": number, "NextToken": "string", "ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

BackupId (p. 23)

Describes a single backup.

Type: String

Length Constraints: Maximum length of 79.

Pattern: [a-zA-Z][a-zA-Z0-9\-\.\:]*

Required: No MaxResults (p. 23)

This is not currently implemented for DescribeBackups requests.

Type: Integer

Valid Range: Minimum value of 1.

Required: No NextToken (p. 23)

This is not currently implemented for DescribeBackups requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

API Version 2016-11-01 23

Response Syntax

ServerName (p. 23)

Returns backups for the server with the speciﬁed ServerName.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

"PreferredBackupWindow": "string", "PreferredMaintenanceWindow": "string", "S3DataSize": number,

"NextToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Backups (p. 24)

Contains the response to a DescribeBackups request.

Type: Array of Backup (p. 62) objects NextToken (p. 24)

This is not currently implemented for DescribeBackups requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

InvalidNextTokenException

This occurs when the provided nextToken is not valid.

HTTP Status Code: 400 ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400 ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

MaxResults (p. 26)

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.

Type: Integer

Valid Range: Minimum value of 1.

Required: No NextToken (p. 26)

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No ServerName (p. 26)

The name of the server for which you want to view events.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

{ "NextToken": "string", "ServerEvents": [ {

"CreatedAt": number, "LogUrl": "string", "Message": "string", "ServerName": "string"

} ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 27)

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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

ServerEvents (p. 27)

Contains the response to a DescribeEvents request.

Type: Array of ServerEvent (p. 73) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

InvalidNextTokenException

This occurs when the provided nextToken is not valid.

HTTP Status Code: 400

API Version 2016-11-01 27

DescribeNodeAssociationStatus

Returns the current status of an existing association or disassociation request.

A ResourceNotFoundException is thrown when no recent association or disassociation request with the speciﬁed token is found, or when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Request Syntax

{

"NodeAssociationStatusToken": "string", "ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

NodeAssociationStatusToken (p. 29)

The token returned in either the AssociateNodeResponse or the DisassociateNodeResponse.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: Yes ServerName (p. 29)

The name of the server from which to disassociate the node.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

Response Syntax

{

"EngineAttributes": [ {

"Name": "string", "Value": "string"

} ],

"NodeAssociationStatus": "string"

API Version 2016-11-01 29

Response Elements

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EngineAttributes (p. 29)

Attributes speciﬁc to the node association. In Puppet, the attibute PUPPET_NODE_CERT contains the signed certiﬁcate (the result of the CSR).

Type: Array of EngineAttribute (p. 67) objects NodeAssociationStatus (p. 29)

The status of the association or disassociation request.

Possible values:

• SUCCESS: The association or disassociation succeeded.

• FAILED: The association or disassociation failed.

• IN_PROGRESS: The association or disassociation is still in progress.

Type: String

Valid Values: SUCCESS | FAILED | IN_PROGRESS

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400 ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

MaxResults (p. 32)

This is not currently implemented for DescribeServers requests.

Type: Integer

Valid Range: Minimum value of 1.

Required: No NextToken (p. 32)

This is not currently implemented for DescribeServers requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No ServerName (p. 32)

Describes the server with the speciﬁed ServerName.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: No

Response Syntax

{

"NextToken": "string", "Servers": [

{

"AssociatePublicIpAddress": boolean, "BackupRetentionCount": number, "CloudFormationStackArn": "string", "CreatedAt": number,

"CustomDomain": "string",

"DisableAutomatedBackup": boolean, "Endpoint": "string", "PreferredBackupWindow": "string", "PreferredMaintenanceWindow": "string", "SecurityGroupIds": [ "string" ],

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 33)

This is not currently implemented for DescribeServers requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Servers (p. 33)

Contains the response to a DescribeServers request.

For Chef Automate servers: If DescribeServersResponse$Servers$EngineAttributes includes CHEF_MAJOR_UPGRADE_AVAILABLE, you can upgrade the Chef Automate server to Chef

API Version 2016-11-01 33

Errors

Automate 2. To be eligible for upgrade, a server running Chef Automate 1 must have had at least one successful maintenance run after November 1, 2019.

For Puppet servers: DescribeServersResponse$Servers$EngineAttributes contains the following two responses:

• PUPPET_API_CA_CERT, the PEM-encoded CA certiﬁcate that is used by the Puppet API over TCP port number 8140. The CA certiﬁcate is also used to sign node certiﬁcates.

• PUPPET_API_CRL, a certiﬁcate revocation list. The certiﬁcate revocation list is for internal maintenance purposes only. For more information about the Puppet certiﬁcate revocation list, see Man Page: puppet certiﬁcate_revocation_list in the Puppet documentation.

Type: Array of Server (p. 68) objects

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

InvalidNextTokenException

This occurs when the provided nextToken is not valid.

HTTP Status Code: 400 ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400 ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

DisassociateNode

Disassociates a node from an AWS OpsWorks CM server, and removes the node from the server's managed nodes. After a node is disassociated, the node key pair is no longer valid for accessing the conﬁguration manager's API. For more information about how to associate a node, see AssociateNode (p. 3).

A node can can only be disassociated from a server that is in a HEALTHY state. Otherwise, an InvalidStateException is thrown. A ResourceNotFoundException is thrown when the server does not exist. A ValidationException is raised when parameters of the request are not valid.

Request Syntax

{

"EngineAttributes": [ {

"Name": "string", "Value": "string"

} ],

"NodeName": "string", "ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

EngineAttributes (p. 35)

Engine attributes that are used for disassociating the node. No attributes are required for Puppet.

Attributes required in a DisassociateNode request for Chef

• CHEF_ORGANIZATION: The Chef organization with which the node was associated. By default only one organization named default can exist.

Type: Array of EngineAttribute (p. 67) objects Required: No

NodeName (p. 35)

The name of the client node.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: ^[\-\p{Alnum}_:.]+$

Required: Yes ServerName (p. 35)

The name of the server from which to disassociate the node.

API Version 2016-11-01 35

Response Syntax

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

Response Syntax

{

"NodeAssociationStatusToken": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NodeAssociationStatusToken (p. 36)

Contains a token which can be passed to the DescribeNodeAssociationStatus API call to get the status of the disassociation request.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

InvalidStateException

The resource is in a state that does not allow you to perform a speciﬁed action.

HTTP Status Code: 400 ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400 ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

Request Syntax

{ "ExportAttributeName": "string", "InputAttributes": [

{

"Name": "string", "Value": "string"

} ],

"ServerName": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

ExportAttributeName (p. 38)

The name of the export attribute. Currently, the supported export attribute is Userdata. This exports a user data script that includes parameters and values provided in the InputAttributes list.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: Yes InputAttributes (p. 38)

The list of engine attributes. The list type is EngineAttribute. An EngineAttribute list item is a pair that includes an attribute name and its value. For the Userdata ExportAttributeName, the following are supported engine attribute names.

• RunList In Chef, a list of roles or recipes that are run in the speciﬁed order. In Puppet, this parameter is ignored.

• OrganizationName In Chef, an organization name. AWS OpsWorks for Chef Automate always creates the organization default. In Puppet, this parameter is ignored.

• NodeEnvironment In Chef, a node environment (for example, development, staging, or one-box).

In Puppet, this parameter is ignored.

• NodeClientVersion In Chef, the version of the Chef engine (three numbers separated by dots, such as 13.8.5). If this attribute is empty, AWS OpsWorks for Chef Automate uses the most current version. In Puppet, this parameter is ignored.

Type: Array of EngineAttribute (p. 67) objects Required: No

ServerName (p. 38)

The name of the server from which you are exporting the attribute.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Required: Yes

Response Syntax

{

"EngineAttribute": { "Name": "string", "Value": "string"

"ServerName": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EngineAttribute (p. 39)

The requested engine attribute pair with attribute name and value.

Type: EngineAttribute (p. 67) object ServerName (p. 39)

The server name used in the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Pattern: [a-zA-Z][a-zA-Z0-9\-]*

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

InvalidStateException

The resource is in a state that does not allow you to perform a speciﬁed action.

API Version 2016-11-01 39

ListTagsForResource

Returns a list of tags that are applied to the speciﬁed AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise servers or backups.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ResourceArn": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 76).

The request accepts the following data in JSON format.

MaxResults (p. 41)

Type: Integer

Valid Range: Minimum value of 1.

Required: No NextToken (p. 41)

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 ListTagsForResource 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.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No ResourceArn (p. 41)

The Amazon Resource Number (ARN) of an AWS OpsWorks for Chef Automate or OpsWorks for Puppet Enterprise server for which you want to show applied tags. For example,

arn:aws:opsworks-cm:us-west-2:123456789012:server/test-owcm-server/

EXAMPLE-66b0-4196-8274-d1a2bEXAMPLE.

Type: String

API Version 2016-11-01 41

Response Syntax

Pattern: arn:aws.*:opsworks-cm:.*:[0-9]{12}:.*

Required: Yes

Response Syntax

{ "NextToken": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken (p. 42)

A token that you can use as the value of NextToken in subsequent calls to the API to show more results.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Tags (p. 42)

Tags that have been applied to the resource.

Type: Array of Tag (p. 75) objects

Array Members: Minimum number of 0 items. Maximum number of 200 items.

Errors

For information about the errors that are common to all actions, see Common Errors (p. 78).

ResourceNotFoundException

The requested resource does not exist, or access was denied.

HTTP Status Code: 400 ValidationException

One or more of the provided request parameters are not valid.

HTTP Status Code: 400

Response Syntax

Response Elements

Errors

See Also

DescribeBackups

Request Syntax

Request Parameters

Response Elements

Errors

See Also

DescribeEvents

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeNodeAssociationStatus

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

DescribeServers

Request Syntax

Request Parameters

Response Syntax

Errors

See Also

DisassociateNode

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

ExportServerEngineAttribute

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also

ListTagsForResource

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

See Also