- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
GetInstanceStateCommand
Returns the state of a specific instance. Works on one instance at a time.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LightsailClient, GetInstanceStateCommand } from "@aws-sdk/client-lightsail"; // ES Modules import
// const { LightsailClient, GetInstanceStateCommand } = require("@aws-sdk/client-lightsail"); // CommonJS import
const client = new LightsailClient(config);
const input = { // GetInstanceStateRequest
instanceName: "STRING_VALUE", // required
};
const command = new GetInstanceStateCommand(input);
const response = await client.send(command);
// { // GetInstanceStateResult
// state: { // InstanceState
// code: Number("int"),
// name: "STRING_VALUE",
// },
// };
GetInstanceStateCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
instanceNameRequired | string | undefined | The name of the instance to get state information about. |
GetInstanceStateCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
state | InstanceState | undefined | The state of the instance. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. |
| AccountSetupInProgressException | client | Lightsail throws this exception when an account is still in the setup in progress state. |
| InvalidInputException | client | Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain and distribution APIs are only available in the N. Virginia ( |
| NotFoundException | client | Lightsail throws this exception when it cannot find a resource. |
| OperationFailureException | client | Lightsail throws this exception when an operation fails to execute. |
| ServiceException | server | A general service exception. |
| UnauthenticatedException | client | Lightsail throws this exception when the user has not been authenticated. |
| LightsailServiceException | Base exception class for all service exceptions from Lightsail service. |