String staticIpName
The name of the static IP address.
String blueprintId
The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
String name
The friendly name of the blueprint (e.g., Amazon Linux).
String group
The group name of the blueprint (e.g., amazon-linux).
String type
The type of the blueprint (e.g., os or app).
String description
The description of the blueprint.
Boolean isActive
A Boolean value indicating whether the blueprint is active. When you update your blueprints, you will inactivate old blueprints and keep the most recent versions active.
Integer minPower
The minimum bundle power required to run this blueprint. For example, you need a bundle with a power value of 500
or more to create an instance that uses a blueprint with a minimum power value of 500. 0 indicates
that the blueprint runs on all instance sizes.
String version
The version number of the operating system, application, or stack (e.g., 2016.03.0).
String versionCode
The version code.
String productUrl
The product URL to learn more about the image or blueprint.
String licenseUrl
The end-user license agreement URL for the image or blueprint.
String platform
The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.
Float price
The price in US dollars (e.g., 5.0).
Integer cpuCount
The number of vCPUs included in the bundle (e.g., 2).
Integer diskSizeInGb
The size of the SSD (e.g., 30).
String bundleId
The bundle ID (e.g., micro_1_0).
String instanceType
The Amazon EC2 instance type (e.g., t2.micro).
Boolean isActive
A Boolean value indicating whether the bundle is active.
String name
A friendly name for the bundle (e.g., Micro).
Integer power
A numeric value that represents the power of the bundle (e.g., 500). You can use the bundle's power
value in conjunction with a blueprint's minimum power value to determine whether the blueprint will run on the
bundle. For example, you need a bundle with a power value of 500 or more to create an instance that uses a
blueprint with a minimum power value of 500.
Float ramSizeInGb
The amount of RAM in GB (e.g., 2.0).
Integer transferPerMonthInGb
The data transfer rate per month in GB (e.g., 2000).
List<E> supportedPlatforms
The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only
launch a WINDOWS bundle on a blueprint that supports the WINDOWS platform.
LINUX_UNIX blueprints require a LINUX_UNIX bundle.
Operation operation
An array of key-value pairs that contains information about the operation.
String diskName
The unique Lightsail disk name (e.g., my-disk).
String diskSnapshotName
The name of the disk snapshot (e.g., my-snapshot) from which to create the new storage disk.
String availabilityZone
The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same
Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
Integer sizeInGb
The size of the disk in GB (e.g., 32).
String diskName
The unique Lightsail disk name (e.g., my-disk).
String availabilityZone
The Availability Zone where you want to create the disk (e.g., us-east-2a). Choose the same
Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
Integer sizeInGb
The size of the disk in GB (e.g., 32).
String domainName
The domain name (e.g., example.com) for which you want to create the domain entry.
DomainEntry domainEntry
An array of key-value pairs containing information about the domain entry request.
Operation operation
An array of key-value pairs containing information about the operation.
String domainName
The domain name to manage (e.g., example.com).
You cannot register a new domain name using Lightsail. You must register a domain name using Amazon Route 53 or another domain name registrar. If you have already registered your domain, you can enter its name in this parameter to manage the DNS records for that domain.
Operation operation
An array of key-value pairs containing information about the domain resource you created.
List<E> instanceNames
The names for your new instances.
Map<K,V> attachedDiskMapping
An object containing information about one or more disk mappings.
String availabilityZone
The Availability Zone where you want to create your instances. Use the following formatting:
us-east-2a (case sensitive). You can get a list of availability zones by using the get regions
operation. Be sure to add the include availability zones parameter to your request.
String instanceSnapshotName
The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots.
String bundleId
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g., micro_1_0).
String userData
You can create a launch script that configures a server with additional user data. For example,
apt-get –y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
complete list, see the Dev Guide.
String keyPairName
The name for your key pair.
List<E> instanceNames
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for
example: ["MyFirstInstance","MySecondInstance"]
String availabilityZone
The Availability Zone in which to create your instance. Use the following format: us-east-2a (case
sensitive). You can get a list of availability zones by using the get regions
operation. Be sure to add the include availability zones parameter to your request.
String customImageName
(Deprecated) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.
String blueprintId
The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0).
Use the get blueprints operation to return a list of available images (or blueprints).
String bundleId
The bundle of specification information for your virtual private server (or instance), including the
pricing plan (e.g., micro_1_0).
String userData
A launch script you can create that configures a server with additional user data. For example, you might want to
run apt-get –y update.
Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and
CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a
complete list, see the Dev Guide.
String keyPairName
The name of your key pair.
String keyPairName
The name for your new key pair.
KeyPair keyPair
An array of key-value pairs containing information about the new key pair you just created.
String publicKeyBase64
A base64-encoded public key of the ssh-rsa type.
String privateKeyBase64
A base64-encoded RSA private key.
Operation operation
An array of key-value pairs containing information about the results of your create key pair request.
String diskName
The unique name of the disk you want to delete (e.g., my-disk).
String diskSnapshotName
The name of the disk snapshot you want to delete (e.g., my-disk-snapshot).
String domainName
The name of the domain entry to delete.
DomainEntry domainEntry
An array of key-value pairs containing information about your domain entries.
Operation operation
An array of key-value pairs containing information about the results of your delete domain entry request.
String domainName
The specific domain name to delete.
Operation operation
An array of key-value pairs containing information about the results of your delete domain request.
String instanceName
The name of the instance to delete.
String instanceSnapshotName
The name of the snapshot to delete.
String keyPairName
The name of the key pair to delete.
Operation operation
An array of key-value pairs containing information about the results of your delete key pair request.
String diskName
The unique name of the disk you want to detach from your instance (e.g., my-disk).
String staticIpName
The name of the static IP to detach from the instance.
String name
The unique name of the disk.
String arn
The Amazon Resource Name (ARN) of the disk.
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the disk was created.
ResourceLocation location
The AWS Region and Availability Zone where the disk is located.
String resourceType
The Lightsail resource type (e.g., Disk).
Integer sizeInGb
The size of the disk in GB.
Boolean isSystemDisk
A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).
Integer iops
The input/output operations per second (IOPS) of the disk.
String path
The disk path.
String state
Describes the status of the disk.
String attachedTo
The resources to which the disk is attached.
Boolean isAttached
A Boolean value indicating whether the disk is attached.
String attachmentState
(Deprecated) The attachment state of the disk.
In releases prior to November 9, 2017, this parameter returned attached for system disks in the API
response. It is now deprecated, but still included in the response. Use isAttached instead.
Integer gbInUse
(Deprecated) The number of GB in use by the disk.
In releases prior to November 9, 2017, this parameter was not included in the API response. It is now deprecated.
String name
The name of the disk snapshot (e.g., my-disk-snapshot).
String arn
The Amazon Resource Name (ARN) of the disk snapshot.
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the disk snapshot was created.
ResourceLocation location
The AWS Region and Availability Zone where the disk snapshot was created.
String resourceType
The Lightsail resource type (e.g., DiskSnapshot).
Integer sizeInGb
The size of the disk in GB.
String state
The status of the disk snapshot operation.
String progress
The progress of the disk snapshot operation.
String fromDiskName
The unique name of the source disk from which you are creating the disk snapshot.
String fromDiskArn
The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.
String name
The name of the domain.
String arn
The Amazon Resource Name (ARN) of the domain recordset (e.g.,
arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The date when the domain recordset was created.
ResourceLocation location
The AWS Region and Availability Zones where the domain recordset was created.
String resourceType
The resource type.
List<E> domainEntries
An array of key-value pairs containing information about the domain entries.
String pageToken
A token used for paginating results from your get active names request.
String diskName
The name of the disk (e.g., my-disk).
Disk disk
An object containing information about the disk.
String diskSnapshotName
The name of the disk snapshot (e.g., my-disk-snapshot).
DiskSnapshot diskSnapshot
An object containing information about the disk snapshot.
String pageToken
A token used for advancing to the next page of results from your GetDiskSnapshots request.
String pageToken
A token used for advancing to the next page of results from your GetDisks request.
String domainName
The domain name for which your want to return information about.
Domain domain
An array of key-value pairs containing information about your get domain request.
String pageToken
A token used for advancing to the next page of results from your get domains request.
InstanceAccessDetails accessDetails
An array of key-value pairs containing information about a get instance access request.
String instanceName
The name of the instance for which you want to get metrics data.
String metricName
The metric name to get data about.
Integer period
The time period for which you are requesting data.
Date startTime
The start time of the time period.
Date endTime
The end time of the time period.
String unit
The unit. The list of valid values is below.
List<E> statistics
The instance statistics.
String instanceName
The name of the instance.
String instanceName
The name of the instance.
Instance instance
An array of key-value pairs containing information about the specified instance.
String instanceSnapshotName
The name of the snapshot for which you are requesting information.
InstanceSnapshot instanceSnapshot
An array of key-value pairs containing information about the results of your get instance snapshot request.
String pageToken
A token used for advancing to the next page of results from your get instance snapshots request.
String pageToken
A token used for advancing to the next page of results from your get instances request.
String instanceName
The name of the instance to get state information about.
InstanceState state
The state of the instance.
String keyPairName
The name of the key pair for which you are requesting information.
KeyPair keyPair
An array of key-value pairs containing information about the key pair.
String pageToken
A token used for advancing to the next page of results from your get key pairs request.
String operationId
A GUID used to identify the operation.
Operation operation
An array of key-value pairs containing information about the results of your get operation request.
List<E> operations
An array of key-value pairs containing information about the results of your get operations for resource request.
String nextPageCount
(Deprecated) Returns the number of pages of results that remain.
In releases prior to June 12, 2017, this parameter returned null by the API. It is now deprecated,
and the API returns the nextPageToken parameter instead.
String nextPageToken
An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
String pageToken
A token used for advancing to the next page of results from your get operations request.
Boolean includeAvailabilityZones
A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability
Zones are indicated with a letter: e.g., us-east-2a.
String staticIpName
The name of the static IP in Lightsail.
StaticIp staticIp
An array of key-value pairs containing information about the requested static IP.
String pageToken
A token used for advancing to the next page of results from your get static IPs request.
Operation operation
An array of key-value pairs containing information about the request operation.
String name
The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1).
String arn
The Amazon Resource Name (ARN) of the instance (e.g.,
arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the instance was created (e.g., 1479734909.17).
ResourceLocation location
The region name and availability zone where the instance is located.
String resourceType
The type of resource (usually Instance).
String blueprintId
The blueprint ID (e.g., os_amlinux_2016_03).
String blueprintName
The friendly name of the blueprint (e.g., Amazon Linux).
String bundleId
The bundle for the instance (e.g., micro_1_0).
Boolean isStaticIp
A Boolean value indicating whether this instance has a static IP assigned to it.
String privateIpAddress
The private IP address of the instance.
String publicIpAddress
The public IP address of the instance.
String ipv6Address
The IPv6 address of the instance.
InstanceHardware hardware
The size of the vCPU and the amount of RAM for the instance.
InstanceNetworking networking
Information about the public ports and monthly data transfer rates for the instance.
InstanceState state
The status code and the state (e.g., running) for the instance.
String username
The user name for connecting to the instance (e.g., ec2-user).
String sshKeyName
The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair).
String certKey
For SSH access, the public key to use when accessing your instance For OpenSSH clients (e.g., command line SSH),
you should save this value to tempkey-cert.pub.
Date expiresAt
For SSH access, the date on which the temporary keys expire.
String ipAddress
The public IP address of the Amazon Lightsail instance.
String password
For RDP access, the password for your Amazon Lightsail instance. Password will be an empty string if the password for your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you create an instance using any key pair other than the default (LightsailDefaultKeyPair),
password will always be an empty string.
If you change the Administrator password on the instance, Lightsail will continue to return the original password value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
PasswordData passwordData
For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only
needed if password is empty and the instance is not new (and therefore the password is not ready
yet). When you create an instance, it can take up to 15 minutes for the instance to be ready.
String privateKey
For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this
value to tempkey).
String protocol
The protocol for these Amazon Lightsail instance access details.
String instanceName
The name of this Amazon Lightsail instance.
String username
The user name to use when logging in to the Amazon Lightsail instance.
MonthlyTransfer monthlyTransfer
The amount of data in GB allocated for monthly data transfers.
List<E> ports
An array of key-value pairs containing information about the ports on the instance.
Integer fromPort
The first port in the range.
Integer toPort
The last port in the range.
String protocol
The protocol being used. Can be one of the following.
tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of
streamed data between applications running on hosts communicating by an IP network. If you have an application
that doesn't require reliable data stream service, use UDP instead.
all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to
other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission
channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides
a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable
data stream service, use TCP instead.
String accessFrom
The location from which access is allowed (e.g., Anywhere (0.0.0.0/0)).
String accessType
The type of access (Public or Private).
String commonName
The common name.
String accessDirection
The access direction (inbound or outbound).
Integer fromPort
The first port in the range.
Integer toPort
The last port in the range.
String protocol
The protocol being used. Can be one of the following.
tcp - Transmission Control Protocol (TCP) provides reliable, ordered, and error-checked delivery of
streamed data between applications running on hosts communicating by an IP network. If you have an application
that doesn't require reliable data stream service, use UDP instead.
all - All transport layer protocol types. For more general information, see Transport layer on Wikipedia.
udp - With User Datagram Protocol (UDP), computer applications can send messages (or datagrams) to
other hosts on an Internet Protocol (IP) network. Prior communications are not required to set up transmission
channels or data paths. Applications that don't require reliable data stream service can use UDP, which provides
a connectionless datagram service that emphasizes reduced latency over reliability. If you do require reliable
data stream service, use TCP instead.
String state
Specifies whether the instance port is open or closed.
String name
The name of the snapshot.
String arn
The Amazon Resource Name (ARN) of the snapshot (e.g.,
arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the snapshot was created (e.g., 1479907467.024).
ResourceLocation location
The region name and availability zone where you created the snapshot.
String resourceType
The type of resource (usually InstanceSnapshot).
String state
The state the snapshot is in.
String progress
The progress of the snapshot.
List<E> fromAttachedDisks
An array of disk objects containing information about all block storage disks.
String fromInstanceName
The instance from which the snapshot was created.
String fromInstanceArn
The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g.,
arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE).
String fromBlueprintId
The blueprint ID from which you created the snapshot (e.g., os_debian_8_3). A blueprint is a virtual
private server (or instance) image used to create instances quickly.
String fromBundleId
The bundle ID from which you created the snapshot (e.g., micro_1_0).
Integer sizeInGb
The size in GB of the SSD.
Boolean isPeered
Returns true if the Lightsail VPC is peered; otherwise, false.
String name
The friendly name of the SSH key pair.
String arn
The Amazon Resource Name (ARN) of the key pair (e.g.,
arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the key pair was created (e.g., 1479816991.349).
ResourceLocation location
The region name and Availability Zone where the key pair was created.
String resourceType
The resource type (usually KeyPair).
String fingerprint
The RSA fingerprint of the key pair.
Integer gbPerMonthAllocated
The amount allocated per month (in GB).
Operation operation
An array of key-value pairs containing information about the request operation.
String id
The ID of the operation.
String resourceName
The resource name.
String resourceType
The resource type.
Date createdAt
The timestamp when the operation was initialized (e.g., 1479816991.349).
ResourceLocation location
The region and Availability Zone.
Boolean isTerminal
A Boolean value indicating whether the operation is terminal.
String operationDetails
Details about the operation (e.g., Debian-1GB-Ohio-1).
String operationType
The type of operation.
String status
The status of the operation.
Date statusChangedAt
The timestamp when the status was changed (e.g., 1479816991.349).
String errorCode
The error code.
String errorDetails
The error details.
String ciphertext
The encrypted password. Ciphertext will be an empty string if access to your new instance is not ready yet. When you create an instance, it can take up to 15 minutes for the instance to be ready.
If you use the default key pair (LightsailDefaultKeyPair), the decrypted password will be available
in the password field.
If you are using a custom key pair, you need to use your own means of decryption.
If you change the Administrator password on the instance, Lightsail will continue to return the original ciphertext value. When accessing the instance using RDP, you need to manually enter the Administrator password after changing it from the default.
String keyPairName
The name of the key pair that you used when creating your instance. If no key pair name was specified when
creating the instance, Lightsail uses the default key pair (LightsailDefaultKeyPair).
If you are using a custom key pair, you need to use your own means of decrypting your password using the
ciphertext. Lightsail creates the ciphertext by encrypting your password with the public key part of
this key pair.
Operation operation
An array of key-value pairs containing information about the request operation.
Operation operation
Describes metadata about the operation you just executed.
String instanceName
The name of the instance to reboot.
String continentCode
The continent code (e.g., NA, meaning North America).
String description
The description of the AWS Region (e.g.,
This region is recommended to serve users in the eastern United States and eastern Canada).
String displayName
The display name (e.g., Ohio).
String name
The region name (e.g., us-east-2).
List<E> availabilityZones
The Availability Zones. Follows the format us-east-2a (case-sensitive).
String staticIpName
The name of the static IP to delete.
String instanceName
The name of the instance (a virtual private server) to start.
String name
The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE).
String arn
The Amazon Resource Name (ARN) of the static IP (e.g.,
arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE).
String supportCode
The support code. Include this code in your email to support when you have questions about an instance or another resource in Lightsail. This code enables our support team to look up your Lightsail information more easily.
Date createdAt
The timestamp when the static IP was created (e.g., 1479735304.222).
ResourceLocation location
The region and Availability Zone where the static IP was created.
String resourceType
The resource type (usually StaticIp).
String ipAddress
The static IP address.
String attachedTo
The instance where the static IP is attached (e.g., Amazon_Linux-1GB-Ohio-1).
Boolean isAttached
A Boolean value indicating whether the static IP is attached.
String instanceName
The name of the instance (a virtual private server) to stop.
Boolean force
When set to True, forces a Lightsail instance that is stuck in a stopping state to
stop.
Only use the force parameter if your instance is stuck in the stopping state. In any
other state, your instance should stop normally without adding this parameter to your API request.
Operation operation
An array of key-value pairs containing information about the request operation.
String domainName
The name of the domain recordset to update.
DomainEntry domainEntry
An array of key-value pairs containing information about the domain entry.
Copyright © 2017. All rights reserved.