Describe Servers

opsworkscm_describe_servers

R Documentation

Lists all configuration management servers that are identified with your account¶

Description¶

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.

Usage¶

opsworkscm_describe_servers(ServerName, NextToken, MaxResults)

Arguments¶

ServerName

Describes the server with the specified ServerName.

NextToken

This is not currently implemented for describe_servers requests.

MaxResults

This is not currently implemented for describe_servers requests.

Value¶

A list with the following syntax:

list(
  Servers = list(
    list(
      AssociatePublicIpAddress = TRUE|FALSE,
      BackupRetentionCount = 123,
      ServerName = "string",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CloudFormationStackArn = "string",
      CustomDomain = "string",
      DisableAutomatedBackup = TRUE|FALSE,
      Endpoint = "string",
      Engine = "string",
      EngineModel = "string",
      EngineAttributes = list(
        list(
          Name = "string",
          Value = "string"
        )
      ),
      EngineVersion = "string",
      InstanceProfileArn = "string",
      InstanceType = "string",
      KeyPair = "string",
      MaintenanceStatus = "SUCCESS"|"FAILED",
      PreferredMaintenanceWindow = "string",
      PreferredBackupWindow = "string",
      SecurityGroupIds = list(
        "string"
      ),
      ServiceRoleArn = "string",
      Status = "BACKING_UP"|"CONNECTION_LOST"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|"HEALTHY"|"RUNNING"|"RESTORING"|"SETUP"|"UNDER_MAINTENANCE"|"UNHEALTHY"|"TERMINATED",
      StatusReason = "string",
      SubnetIds = list(
        "string"
      ),
      ServerArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_servers(
  ServerName = "string",
  NextToken = "string",
  MaxResults = 123
)