Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . lightsail ]

get-instance-state

Description

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-instance-state
--instance-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--instance-name (string)

The name of the instance to get state information about.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To get information about the state of an instance

The following get-instance-state example returns the state of the specified instance.

aws lightsail get-instance-state \
    --instance-name MEAN-1

Output:

{
    "state": {
        "code": 16,
        "name": "running"
    }
}

Output

state -> (structure)

The state of the instance.

code -> (integer)

The status code for the instance.

name -> (string)

The state of the instance (e.g., running or pending ).