[ aws . snow-device-management ]

describe-device-ec2-instances

Description

Checks the current state of the Amazon EC2 instances. The output is similar to describeDevice , but the results are sourced from the device cache in the Amazon Web Services Cloud and include a subset of the available fields.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-device-ec2-instances
--instance-ids <value>
--managed-device-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-ids (list)

A list of instance IDs associated with the managed device.

(string)

Syntax:

"string" "string" ...

--managed-device-id (string)

The ID of the managed device.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Output

instances -> (list)

A list of structures containing information about each instance.

(structure)

The details about the instance.

instance -> (structure)

A structure containing details about the instance.

amiLaunchIndex -> (integer)

The Amazon Machine Image (AMI) launch index, which you can use to find this instance in the launch group.

blockDeviceMappings -> (list)

Any block device mapping entries for the instance.

(structure)

The description of a block device mapping.

deviceName -> (string)

The block device name.

ebs -> (structure)

The parameters used to automatically set up Amazon Elastic Block Store (Amazon EBS) volumes when the instance is launched.

attachTime -> (timestamp)

When the attachment was initiated.

deleteOnTermination -> (boolean)

A value that indicates whether the volume is deleted on instance termination.

status -> (string)

The attachment state.

volumeId -> (string)

The ID of the Amazon EBS volume.

cpuOptions -> (structure)

The CPU options for the instance.

coreCount -> (integer)

The number of cores that the CPU can use.

threadsPerCore -> (integer)

The number of threads per core in the CPU.

createdAt -> (timestamp)

When the instance was created.

imageId -> (string)

The ID of the AMI used to launch the instance.

instanceId -> (string)

The ID of the instance.

instanceType -> (string)

The instance type.

privateIpAddress -> (string)

The private IPv4 address assigned to the instance.

publicIpAddress -> (string)

The public IPv4 address assigned to the instance.

rootDeviceName -> (string)

The device name of the root device volume (for example, /dev/sda1 ).

securityGroups -> (list)

The security groups for the instance.

(structure)

Information about the device’s security group.

groupId -> (string)

The security group ID.

groupName -> (string)

The security group name.

state -> (structure)

The description of the current state of an instance.

code -> (integer)

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for the instance state code are all in the range of the low byte. These values are:

• 0 : pending

• 16 : running

• 32 : shutting-down

• 48 : terminated

• 64 : stopping

• 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

name -> (string)

The current state of the instance.

updatedAt -> (timestamp)

When the instance was last updated.

lastUpdatedAt -> (timestamp)

When the instance summary was last updated.