Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the AttachLoadBalancerTlsCertificate operation with the non-attached certificate, and it will replace the existing one and become the attached certificate.

operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a ). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail .

Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a ). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail .

Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.

You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.

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.

The domain name (e.g., example.com ) for which you want to create the domain entry.

domainEntry (dict) --

[REQUIRED]

An array of key-value pairs containing information about the domain entry request.

id(string) --

The ID of the domain recordset entry.

name(string) --

The name of the domain.

target(string) --

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: ["MyFirstInstance","MySecondInstance"]

(string) --

availabilityZone (string) --

[REQUIRED]

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 includeavailabilityzones parameter to your request.

customImageName (string) --

(Deprecated) The name for your custom image.

Note

In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.

blueprintId (string) --

[REQUIRED]

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 ).

A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get-yupdate .

Note

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 .

The original disk path exposed to the instance (for example, /dev/sdh ).

newDiskName(string) --

The new disk name (e.g., my-new-disk ).

availabilityZone (string) --

[REQUIRED]

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 includeavailabilityzones parameter to your request.

instanceSnapshotName (string) --

[REQUIRED]

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.

You can create a launch script that configures a server with additional user data. For example, apt-get-yupdate .

Note

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 .

An array of key-value pairs containing information about the new key pair you just created.

name(string) --

The friendly name of the SSH key pair.

arn(string) --

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE ).

supportCode(string) --

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.

The load balancer name where you want to create the SSL/TLS certificate.

certificateName (string) --

[REQUIRED]

The SSL/TLS certificate name.

You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see Limits .

certificateDomainName (string) --

[REQUIRED]

The domain name (e.g., example.com ) for your SSL/TLS certificate.

certificateAlternativeNames (list) --

An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (e.g., *.example.com ).

When you make periodic snapshots of a disk, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the disk.

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.

There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.

Returns the list of available instance images, or blueprints . You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

An array of key-value pairs that contains information about the available blueprints.

(dict) --

Describes a blueprint (a virtual private server image).

blueprintId(string) --

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ).

name(string) --

The friendly name of the blueprint (e.g., AmazonLinux ).

group(string) --

The group name of the blueprint (e.g., amazon-linux ).

type(string) --

The type of the blueprint (e.g., os or app ).

description(string) --

The description of the blueprint.

isActive(boolean) --

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.

minPower(integer) --

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.

version(string) --

The version number of the operating system, application, or stack (e.g., 2016.03.0 ).

versionCode(string) --

The version code.

productUrl(string) --

The product URL to learn more about the image or blueprint.

licenseUrl(string) --

The end-user license agreement URL for the image or blueprint.

platform(string) --

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

nextPageToken(string) --

A token used for advancing to the next page of results from your get blueprints request.

An array of key-value pairs that contains information about the available bundles.

(dict) --

Describes a bundle, which is a set of specs describing your virtual private server (or instance ).

price(float) --

The price in US dollars (e.g., 5.0 ).

cpuCount(integer) --

The number of vCPUs included in the bundle (e.g., 2 ).

diskSizeInGb(integer) --

The size of the SSD (e.g., 30 ).

bundleId(string) --

The bundle ID (e.g., micro_1_0 ).

instanceType(string) --

The Amazon EC2 instance type (e.g., t2.micro ).

isActive(boolean) --

A Boolean value indicating whether the bundle is active.

name(string) --

A friendly name for the bundle (e.g., Micro ).

power(integer) --

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.

ramSizeInGb(float) --

The amount of RAM in GB (e.g., 2.0 ).

transferPerMonthInGb(integer) --

The data transfer rate per month in GB (e.g., 2000 ).

supportedPlatforms(list) --

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.

(string) --

nextPageToken(string) --

A token used for advancing to the next page of results from your get active names request.

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.

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.

createdAt(datetime) --

The date when the disk snapshot was created.

location(dict) --

The AWS Region and Availability Zone where the disk snapshot was created.

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

An array of objects containing information about all block storage disk snapshots.

(dict) --

Describes a block storage disk snapshot.

name(string) --

The name of the disk snapshot (e.g., my-disk-snapshot ).

arn(string) --

The Amazon Resource Name (ARN) of the disk snapshot.

supportCode(string) --

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.

createdAt(datetime) --

The date when the disk snapshot was created.

location(dict) --

The AWS Region and Availability Zone where the disk snapshot was created.

An array of objects containing information about all block storage disks.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

An array of key-value pairs containing information about your get domain request.

name(string) --

The name of the domain.

arn(string) --

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).

supportCode(string) --

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.

createdAt(datetime) --

The date when the domain recordset was created.

location(dict) --

The AWS Region and Availability Zones where the domain recordset was created.

An array of key-value pairs containing information about the domain entries.

(dict) --

Describes a domain recordset entry.

id(string) --

The ID of the domain recordset entry.

name(string) --

The name of the domain.

target(string) --

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

An array of key-value pairs containing information about each of the domain entries in the user's account.

(dict) --

Describes a domain where you are storing recordsets in Lightsail.

name(string) --

The name of the domain.

arn(string) --

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).

supportCode(string) --

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.

createdAt(datetime) --

The date when the domain recordset was created.

location(dict) --

The AWS Region and Availability Zones where the domain recordset was created.

An array of key-value pairs containing information about the domain entries.

(dict) --

Describes a domain recordset entry.

id(string) --

The ID of the domain recordset entry.

name(string) --

The name of the domain.

target(string) --

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

(string) --

(string) --

nextPageToken(string) --

A token used for advancing to the next page of results from your get active names request.

An array of key-value pairs containing information about the specified instance.

name(string) --

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1 ).

arn(string) --

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).

supportCode(string) --

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.

A Boolean value indicating whether this instance has a static IP assigned to it.

privateIpAddress(string) --

The private IP address of the instance.

publicIpAddress(string) --

The public IP address of the instance.

ipv6Address(string) --

The IPv6 address of the instance.

hardware(dict) --

The size of the vCPU and the amount of RAM for the instance.

cpuCount(integer) --

The number of vCPUs the instance has.

disks(list) --

The disks attached to the instance.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

iops(integer) --

The input/output operations per second (IOPS) of the disk.

path(string) --

The disk path.

state(string) --

Describes the status of the disk.

attachedTo(string) --

The resources to which the disk is attached.

isAttached(boolean) --

A Boolean value indicating whether the disk is attached.

attachmentState(string) --

(Deprecated) The attachment state of the disk.

Note

In releases prior to November 14, 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.

gbInUse(integer) --

(Deprecated) The number of GB in use by the disk.

Note

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

ramSizeInGb(float) --

The amount of RAM in GB on the instance (e.g., 1.0 ).

networking(dict) --

Information about the public ports and monthly data transfer rates for the instance.

monthlyTransfer(dict) --

The amount of data in GB allocated for monthly data transfers.

gbPerMonthAllocated(integer) --

The amount allocated per month (in GB).

ports(list) --

An array of key-value pairs containing information about the ports on the instance.

(dict) --

Describes information about the instance ports.

fromPort(integer) --

The first port in the range.

toPort(integer) --

The last port in the range.

protocol(string) --

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.

accessFrom(string) --

The location from which access is allowed (e.g., Anywhere(0.0.0.0/0) ).

accessType(string) --

The type of access (Public or Private ).

commonName(string) --

The common name.

accessDirection(string) --

The access direction (inbound or outbound ).

state(dict) --

The status code and the state (e.g., running ) for the instance.

code(integer) --

The status code for the instance.

name(string) --

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

username(string) --

The user name for connecting to the instance (e.g., ec2-user ).

sshKeyName(string) --

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).

An array of key-value pairs containing information about a get instance access request.

certKey(string) --

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 .

expiresAt(datetime) --

For SSH access, the date on which the temporary keys expire.

ipAddress(string) --

The public IP address of the Amazon Lightsail instance.

password(string) --

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.

Note

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(dict) --

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.

ciphertext(string) --

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.

Note

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.

keyPairName(string) --

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.

privateKey(string) --

For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to tempkey ).

protocol(string) --

The protocol for these Amazon Lightsail instance access details.

instanceName(string) --

The name of this Amazon Lightsail instance.

username(string) --

The user name to use when logging in to the Amazon Lightsail instance.

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.

An array of key-value pairs containing information about the results of your get instance snapshot request.

name(string) --

The name of the snapshot.

arn(string) --

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).

supportCode(string) --

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.

An array of disk objects containing information about all block storage disks.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

An array of key-value pairs containing information about the results of your get instance snapshots request.

(dict) --

Describes the snapshot of the virtual private server, or instance .

name(string) --

The name of the snapshot.

arn(string) --

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).

supportCode(string) --

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.

An array of disk objects containing information about all block storage disks.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

An array of key-value pairs containing information about your instances.

(dict) --

Describes an instance (a virtual private server).

name(string) --

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1 ).

arn(string) --

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).

supportCode(string) --

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.

A Boolean value indicating whether this instance has a static IP assigned to it.

privateIpAddress(string) --

The private IP address of the instance.

publicIpAddress(string) --

The public IP address of the instance.

ipv6Address(string) --

The IPv6 address of the instance.

hardware(dict) --

The size of the vCPU and the amount of RAM for the instance.

cpuCount(integer) --

The number of vCPUs the instance has.

disks(list) --

The disks attached to the instance.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

iops(integer) --

The input/output operations per second (IOPS) of the disk.

path(string) --

The disk path.

state(string) --

Describes the status of the disk.

attachedTo(string) --

The resources to which the disk is attached.

isAttached(boolean) --

A Boolean value indicating whether the disk is attached.

attachmentState(string) --

(Deprecated) The attachment state of the disk.

Note

In releases prior to November 14, 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.

gbInUse(integer) --

(Deprecated) The number of GB in use by the disk.

Note

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

ramSizeInGb(float) --

The amount of RAM in GB on the instance (e.g., 1.0 ).

networking(dict) --

Information about the public ports and monthly data transfer rates for the instance.

monthlyTransfer(dict) --

The amount of data in GB allocated for monthly data transfers.

gbPerMonthAllocated(integer) --

The amount allocated per month (in GB).

ports(list) --

An array of key-value pairs containing information about the ports on the instance.

(dict) --

Describes information about the instance ports.

fromPort(integer) --

The first port in the range.

toPort(integer) --

The last port in the range.

protocol(string) --

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.

accessFrom(string) --

The location from which access is allowed (e.g., Anywhere(0.0.0.0/0) ).

accessType(string) --

The type of access (Public or Private ).

commonName(string) --

The common name.

accessDirection(string) --

The access direction (inbound or outbound ).

state(dict) --

The status code and the state (e.g., running ) for the instance.

code(integer) --

The status code for the instance.

name(string) --

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

username(string) --

The user name for connecting to the instance (e.g., ec2-user ).

sshKeyName(string) --

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).

nextPageToken(string) --

A token used for advancing to the next page of results from your get instances request.

An array of key-value pairs containing information about the key pair.

name(string) --

The friendly name of the SSH key pair.

arn(string) --

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE ).

supportCode(string) --

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.

An array of key-value pairs containing information about the key pairs.

(dict) --

Describes the SSH key pair.

name(string) --

The friendly name of the SSH key pair.

arn(string) --

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE ).

supportCode(string) --

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.

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

**Instance.FailedHealthChecks ** - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

**Lb.InternalError ** - The health checks failed due to an internal error.

If ** instanceHealth ** is unused , the ** instanceHealthReason ** value can be one of the following:

**Instance.NotRegistered ** - The target instance is not registered with the target group.

**Instance.NotInUse ** - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

**Instance.IpUnusable ** - The target IP address is reserved for use by a Lightsail load balancer.

**Instance.InvalidState ** - The target is in the stopped or terminated state.

If ** instanceHealth ** is draining , the ** instanceHealthReason ** value can be one of the following:

**Instance.DeregistrationInProgress ** - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

tlsCertificateSummaries(list) --

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true , the certificate is attached to the load balancer.

(dict) --

Provides a summary of SSL/TLS certificate metadata.

name(string) --

The name of the SSL/TLS certificate.

isAttached(boolean) --

When true , the SSL/TLS certificate is attached to the Lightsail load balancer.

configurationOptions(dict) --

A string to string map of the configuration options for your load balancer. Valid values are listed below.

The metric about which you want to return information. Valid values are listed below, along with the most useful statistics to include in your request.

**ClientTLSNegotiationErrorCount ** - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics : The most useful statistic is Sum .

**HealthyHostCount ** - The number of target instances that are considered healthy. Statistics : The most useful statistic are Average , Minimum , and Maximum .

**UnhealthyHostCount ** - The number of target instances that are considered unhealthy. Statistics : The most useful statistic are Average , Minimum , and Maximum .

**HTTPCode_LB_4XX_Count ** - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_LB_5XX_Count ** - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_2XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_3XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_4XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_5XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**InstanceResponseTime ** - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics : The most useful statistic is Average .

**RejectedConnectionCount ** - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics : The most useful statistic is Sum .

**RequestCount ** - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

period (integer) --

[REQUIRED]

The time period duration for your health data request.

startTime (datetime) --

[REQUIRED]

The start time of the period.

endTime (datetime) --

[REQUIRED]

The end time of the period.

unit (string) --

[REQUIRED]

The unit for the time period request. Valid values are listed below.

statistics (list) --

[REQUIRED]

An array of statistics that you want to request metrics for. Valid values are listed below.

**SampleCount ** - The count (number) of data points used for the statistical calculation.

**Average ** - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum. This comparison helps you to know when to increase or decrease your resources as needed.

**Sum ** - All values submitted for the matching metric added together. This statistic can be useful for determining the total volume of a metric.

**Minimum ** - The lowest value observed during the specified period. You can use this value to determine low volumes of activity for your application.

**Maximum ** - The highest value observed during the specified period. You can use this value to determine high volumes of activity for your application.

The metric about which you are receiving information. Valid values are listed below, along with the most useful statistics to include in your request.

**ClientTLSNegotiationErrorCount ** - The number of TLS connections initiated by the client that did not establish a session with the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics : The most useful statistic is Sum .

**HealthyHostCount ** - The number of target instances that are considered healthy. Statistics : The most useful statistic are Average , Minimum , and Maximum .

**UnhealthyHostCount ** - The number of target instances that are considered unhealthy. Statistics : The most useful statistic are Average , Minimum , and Maximum .

**HTTPCode_LB_4XX_Count ** - The number of HTTP 4XX client error codes that originate from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests have not been received by the target instance. This count does not include any response codes generated by the target instances. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_LB_5XX_Count ** - The number of HTTP 5XX server error codes that originate from the load balancer. This count does not include any response codes generated by the target instances. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_2XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_3XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_4XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**HTTPCode_Instance_5XX_Count ** - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

**InstanceResponseTime ** - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics : The most useful statistic is Average .

**RejectedConnectionCount ** - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics : The most useful statistic is Sum .

**RequestCount ** - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics : The most useful statistic is Sum . Note that Minimum , Maximum , and Average all return 1 .

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

name(string) --

The name of the SSL/TLS certificate (e.g., my-certificate ).

arn(string) --

The Amazon Resource Name (ARN) of the SSL/TLS certificate.

supportCode(string) --

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or SSL/TLS certificate. This code enables our support team to look up your Lightsail information more easily.

createdAt(datetime) --

The time when you created your SSL/TLS certificate.

location(dict) --

The AWS Region and Availability Zone where you created your certificate.

When true , the SSL/TLS certificate is attached to the Lightsail load balancer.

status(string) --

The status of the SSL/TLS certificate. Valid values are below.

domainName(string) --

The domain name for your SSL/TLS certificate.

domainValidationRecords(list) --

An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.

(dict) --

Describes the validation record of each domain name in the SSL/TLS certificate.

name(string) --

A fully qualified domain name in the certificate. For example, example.com .

type(string) --

The type of validation record. For example, CNAME for domain validation.

value(string) --

The value for that type.

validationStatus(string) --

The validation status. Valid values are listed below.

domainName(string) --

The domain name against which your SSL/TLS certificate was validated.

failureReason(string) --

The reason for the SSL/TLS certificate validation failure.

issuedAt(datetime) --

The time when the SSL/TLS certificate was issued.

issuer(string) --

The issuer of the certificate.

keyAlgorithm(string) --

The algorithm that was used to generate the key pair (the public and private key).

notAfter(datetime) --

The timestamp when the SSL/TLS certificate expires.

notBefore(datetime) --

The timestamp when the SSL/TLS certificate is first valid.

renewalSummary(dict) --

An object containing information about the status of Lightsail's managed renewal for the certificate.

renewalStatus(string) --

The status of Lightsail's managed renewal of the certificate. Valid values are listed below.

domainValidationOptions(list) --

Contains information about the validation of each domain name in the certificate, as it pertains to Lightsail's managed renewal. This is different from the initial validation that occurs as a result of the RequestCertificate request.

(dict) --

Contains information about the domain names on an SSL/TLS certificate that you will use to validate domain ownership.

domainName(string) --

The fully qualified domain name in the certificate request.

validationStatus(string) --

The status of the domain validation. Valid values are listed below.

revocationReason(string) --

The reason the certificate was revoked. Valid values are below.

revokedAt(datetime) --

The timestamp when the SSL/TLS certificate was revoked.

serial(string) --

The serial number of the certificate.

signatureAlgorithm(string) --

The algorithm that was used to sign the certificate.

subject(string) --

The name of the entity that is associated with the public key contained in the certificate.

subjectAlternativeNames(list) --

One or more domains or subdomains included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CNAME) of the certificate and additional domain names that can be used to connect to the website, such as example.com , www.example.com , or m.example.com .

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

The support code. Include this code in your email to support when you have questions about your Lightsail load balancer. This code enables our support team to look up your Lightsail information more easily.

**Instance.FailedHealthChecks ** - The health checks failed because the connection to the target instance timed out, the target instance response was malformed, or the target instance failed the health check for an unknown reason.

**Lb.InternalError ** - The health checks failed due to an internal error.

If ** instanceHealth ** is unused , the ** instanceHealthReason ** value can be one of the following:

**Instance.NotRegistered ** - The target instance is not registered with the target group.

**Instance.NotInUse ** - The target group is not used by any load balancer, or the target instance is in an Availability Zone that is not enabled for its load balancer.

**Instance.IpUnusable ** - The target IP address is reserved for use by a Lightsail load balancer.

**Instance.InvalidState ** - The target is in the stopped or terminated state.

If ** instanceHealth ** is draining , the ** instanceHealthReason ** value can be one of the following:

**Instance.DeregistrationInProgress ** - The target instance is in the process of being deregistered and the deregistration delay period has not expired.

tlsCertificateSummaries(list) --

An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the SSL/TLS certificates. For example, if true , the certificate is attached to the load balancer.

(dict) --

Provides a summary of SSL/TLS certificate metadata.

name(string) --

The name of the SSL/TLS certificate.

isAttached(boolean) --

When true , the SSL/TLS certificate is attached to the Lightsail load balancer.

configurationOptions(dict) --

A string to string map of the configuration options for your load balancer. Valid values are listed below.

(string) --

(string) --

nextPageToken(string) --

A token used for advancing to the next page of results from your GetLoadBalancers request.

Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request.

operation_name (string) -- The operation name. This is the same name
as the method name on the client. For example, if the
method name is create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").

Raises OperationNotPageableError

Raised if the operation is not
pageable. You can use the client.can_paginate method to
check if an operation is pageable.

includeAvailabilityZones (boolean) -- 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 .

An array of key-value pairs containing information about the requested static IP.

name(string) --

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE ).

arn(string) --

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).

supportCode(string) --

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.

An array of key-value pairs containing information about your get static IPs request.

(dict) --

Describes the static IP.

name(string) --

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE ).

arn(string) --

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).

supportCode(string) --

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.

Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.

An array of key-value pairs containing information about the domain entry.

id(string) --

The ID of the domain recordset entry.

name(string) --

The name of the domain.

target(string) --

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs that contains information about the available blueprints.

(dict) --

Describes a blueprint (a virtual private server image).

blueprintId(string) --

The ID for the virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ).

name(string) --

The friendly name of the blueprint (e.g., AmazonLinux ).

group(string) --

The group name of the blueprint (e.g., amazon-linux ).

type(string) --

The type of the blueprint (e.g., os or app ).

description(string) --

The description of the blueprint.

isActive(boolean) --

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.

minPower(integer) --

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.

version(string) --

The version number of the operating system, application, or stack (e.g., 2016.03.0 ).

versionCode(string) --

The version code.

productUrl(string) --

The product URL to learn more about the image or blueprint.

licenseUrl(string) --

The end-user license agreement URL for the image or blueprint.

platform(string) --

The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs that contains information about the available bundles.

(dict) --

Describes a bundle, which is a set of specs describing your virtual private server (or instance ).

price(float) --

The price in US dollars (e.g., 5.0 ).

cpuCount(integer) --

The number of vCPUs included in the bundle (e.g., 2 ).

diskSizeInGb(integer) --

The size of the SSD (e.g., 30 ).

bundleId(string) --

The bundle ID (e.g., micro_1_0 ).

instanceType(string) --

The Amazon EC2 instance type (e.g., t2.micro ).

isActive(boolean) --

A Boolean value indicating whether the bundle is active.

name(string) --

A friendly name for the bundle (e.g., Micro ).

power(integer) --

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.

ramSizeInGb(float) --

The amount of RAM in GB (e.g., 2.0 ).

transferPerMonthInGb(integer) --

The data transfer rate per month in GB (e.g., 2000 ).

supportedPlatforms(list) --

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.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs containing information about each of the domain entries in the user's account.

(dict) --

Describes a domain where you are storing recordsets in Lightsail.

name(string) --

The name of the domain.

arn(string) --

The Amazon Resource Name (ARN) of the domain recordset (e.g., arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE ).

supportCode(string) --

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.

createdAt(datetime) --

The date when the domain recordset was created.

location(dict) --

The AWS Region and Availability Zones where the domain recordset was created.

An array of key-value pairs containing information about the domain entries.

(dict) --

Describes a domain recordset entry.

id(string) --

The ID of the domain recordset entry.

name(string) --

The name of the domain.

target(string) --

The target AWS name server (e.g., ns-111.awsdns-22.com. ).

For Lightsail load balancers, the value looks like ab1234c56789c6b86aba6fb203d443bc-123456789.us-east-2.elb.amazonaws.com . Be sure to also set isAlias to true when setting up an A record for a load balancer.

isAlias(boolean) --

When true , specifies whether the domain entry is an alias used by the Lightsail load balancer. You can include an alias (A type) record in your request, which points to a load balancer DNS name and routes traffic to your load balancer

type(string) --

The type of domain entry (e.g., SOA or NS ).

options(dict) --

(Deprecated) The options for the domain entry.

Note

In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs containing information about the results of your get instance snapshots request.

(dict) --

Describes the snapshot of the virtual private server, or instance .

name(string) --

The name of the snapshot.

arn(string) --

The Amazon Resource Name (ARN) of the snapshot (e.g., arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE ).

supportCode(string) --

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.

An array of disk objects containing information about all block storage disks.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs containing information about your instances.

(dict) --

Describes an instance (a virtual private server).

name(string) --

The name the user gave the instance (e.g., Amazon_Linux-1GB-Ohio-1 ).

arn(string) --

The Amazon Resource Name (ARN) of the instance (e.g., arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE ).

supportCode(string) --

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.

A Boolean value indicating whether this instance has a static IP assigned to it.

privateIpAddress(string) --

The private IP address of the instance.

publicIpAddress(string) --

The public IP address of the instance.

ipv6Address(string) --

The IPv6 address of the instance.

hardware(dict) --

The size of the vCPU and the amount of RAM for the instance.

cpuCount(integer) --

The number of vCPUs the instance has.

disks(list) --

The disks attached to the instance.

(dict) --

Describes a system disk or an block storage disk.

name(string) --

The unique name of the disk.

arn(string) --

The Amazon Resource Name (ARN) of the disk.

supportCode(string) --

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.

A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).

iops(integer) --

The input/output operations per second (IOPS) of the disk.

path(string) --

The disk path.

state(string) --

Describes the status of the disk.

attachedTo(string) --

The resources to which the disk is attached.

isAttached(boolean) --

A Boolean value indicating whether the disk is attached.

attachmentState(string) --

(Deprecated) The attachment state of the disk.

Note

In releases prior to November 14, 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.

gbInUse(integer) --

(Deprecated) The number of GB in use by the disk.

Note

In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.

ramSizeInGb(float) --

The amount of RAM in GB on the instance (e.g., 1.0 ).

networking(dict) --

Information about the public ports and monthly data transfer rates for the instance.

monthlyTransfer(dict) --

The amount of data in GB allocated for monthly data transfers.

gbPerMonthAllocated(integer) --

The amount allocated per month (in GB).

ports(list) --

An array of key-value pairs containing information about the ports on the instance.

(dict) --

Describes information about the instance ports.

fromPort(integer) --

The first port in the range.

toPort(integer) --

The last port in the range.

protocol(string) --

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.

accessFrom(string) --

The location from which access is allowed (e.g., Anywhere(0.0.0.0/0) ).

accessType(string) --

The type of access (Public or Private ).

commonName(string) --

The common name.

accessDirection(string) --

The access direction (inbound or outbound ).

state(dict) --

The status code and the state (e.g., running ) for the instance.

code(integer) --

The status code for the instance.

name(string) --

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

username(string) --

The user name for connecting to the instance (e.g., ec2-user ).

sshKeyName(string) --

The name of the SSH key being used to connect to the instance (e.g., LightsailDefaultKeyPair ).

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs containing information about the key pairs.

(dict) --

Describes the SSH key pair.

name(string) --

The friendly name of the SSH key pair.

arn(string) --

The Amazon Resource Name (ARN) of the key pair (e.g., arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE ).

supportCode(string) --

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.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

PageSize(integer) --

The size of each page.

StartingToken(string) --

A token to specify where to start paginating. This is the NextToken from a previous response.

An array of key-value pairs containing information about your get static IPs request.

(dict) --

Describes the static IP.

name(string) --

The name of the static IP (e.g., StaticIP-Ohio-EXAMPLE ).

arn(string) --

The Amazon Resource Name (ARN) of the static IP (e.g., arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE ).

supportCode(string) --

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.