Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeServers

Lists all configuration management servers that are identified with your account. Only the stored results from Amazon DynamoDB are returned. AWS OpsWorks CM 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 not valid.

Request Syntax


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

Request Parameters

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

The request accepts the following data in JSON format.

MaxResults

This is not currently implemented for DescribeServers requests.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

NextToken

This is not currently implemented for DescribeServers requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Required: No

ServerName

Describes the server with the specified 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",
         "Engine": "string",
         "EngineAttributes": [ 
            { 
               "Name": "string",
               "Value": "string"
            }
         ],
         "EngineModel": "string",
         "EngineVersion": "string",
         "InstanceProfileArn": "string",
         "InstanceType": "string",
         "KeyPair": "string",
         "MaintenanceStatus": "string",
         "PreferredBackupWindow": "string",
         "PreferredMaintenanceWindow": "string",
         "SecurityGroupIds": [ "string" ],
         "ServerArn": "string",
         "ServerName": "string",
         "ServiceRoleArn": "string",
         "Status": "string",
         "StatusReason": "string",
         "SubnetIds": [ "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

This is not currently implemented for DescribeServers requests.

Type: String

Length Constraints: Maximum length of 10000.

Pattern: (?s).*

Servers

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 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 certificate that is used by the Puppet API over TCP port number 8140. The CA certificate is also used to sign node certificates.
PUPPET_API_CRL, a certificate revocation list. The certificate revocation list is for internal maintenance purposes only. For more information about the Puppet certificate revocation list, see Man Page: puppet certificate_revocation_list in the Puppet documentation.

Type: Array of Server objects

Errors

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

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