Skip to content

Get Instance State

lightsail_get_instance_state R Documentation

Returns the state of a specific instance

Description

Returns the state of a specific instance. Works on one instance at a time.

Usage

lightsail_get_instance_state(instanceName)

Arguments

instanceName

[required] The name of the instance to get state information about.

Value

A list with the following syntax:

list(
  state = list(
    code = 123,
    name = "string"
  )
)

Request syntax

svc$get_instance_state(
  instanceName = "string"
)