Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

The description of an instance. Currently, Amazon EC2 instances are the only supported instance type.


  • Instance


amiLaunchIndex?: number

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

blockDeviceMappings?: InstanceBlockDeviceMapping[]

Any block device mapping entries for the instance.

cpuOptions?: CpuOptions

The CPU options for the instance.

createdAt?: Date

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?: SecurityGroupIdentifier[]

The security groups for the instance.

The description of the current state of an instance.

updatedAt?: Date

When the instance was last updated.