1889 lines
105 KiB
JSON
1889 lines
105 KiB
JSON
{
|
|
"version": "2.0",
|
|
"service": "<p>Amazon Lightsail is the easiest way to get started with AWS for developers who just need virtual private servers. Lightsail includes everything you need to launch your project quickly - a virtual machine, SSD-based storage, data transfer, DNS management, and a static IP - for a low, predictable price. You manage those Lightsail servers through the Lightsail console or by using the API or command-line interface (CLI).</p> <p>For more information about Lightsail concepts and tasks, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/all\">Lightsail Dev Guide</a>.</p> <p>To use the Lightsail API or the CLI, you will need to use AWS Identity and Access Management (IAM) to generate access keys. For details about how to set this up, see the <a href=\"http://lightsail.aws.amazon.com/ls/docs/how-to/article/lightsail-how-to-set-up-access-keys-to-use-sdk-api-cli\">Lightsail Dev Guide</a>.</p>",
|
|
"operations": {
|
|
"AllocateStaticIp": "<p>Allocates a static IP address.</p>",
|
|
"AttachDisk": "<p>Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.</p>",
|
|
"AttachInstancesToLoadBalancer": "<p>Attaches one or more Lightsail instances to a load balancer.</p>",
|
|
"AttachLoadBalancerTlsCertificate": "<p>Attaches a Transport Layer Security (TLS) certificate to your load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>",
|
|
"AttachStaticIp": "<p>Attaches a static IP address to a specific Amazon Lightsail instance.</p>",
|
|
"CloseInstancePublicPorts": "<p>Closes the public ports on a specific Amazon Lightsail instance.</p>",
|
|
"CreateDisk": "<p>Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail\">Regions and Availability Zones in Lightsail</a>.</p>",
|
|
"CreateDiskFromSnapshot": "<p>Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., <code>us-east-2a</code>). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/overview/article/understanding-regions-and-availability-zones-in-amazon-lightsail\">Regions and Availability Zones in Lightsail</a>.</p>",
|
|
"CreateDiskSnapshot": "<p>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.</p> <p>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.</p>",
|
|
"CreateDomain": "<p>Creates a domain resource for the specified domain (e.g., example.com).</p>",
|
|
"CreateDomainEntry": "<p>Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.</p>",
|
|
"CreateInstanceSnapshot": "<p>Creates a snapshot of a specific virtual private server, or <i>instance</i>. You can use a snapshot to create a new instance that is based on that snapshot.</p>",
|
|
"CreateInstances": "<p>Creates one or more Amazon Lightsail virtual private servers, or <i>instances</i>.</p>",
|
|
"CreateInstancesFromSnapshot": "<p>Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.</p>",
|
|
"CreateKeyPair": "<p>Creates sn SSH key pair.</p>",
|
|
"CreateLoadBalancer": "<p>Creates a Lightsail load balancer.</p> <p>When you create a load balancer, you can specify certificates and port settings. You can create up to 5 load balancers per AWS Region in your account.</p>",
|
|
"CreateLoadBalancerTlsCertificate": "<p>Creates a Lightsail load balancer TLS certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>",
|
|
"DeleteDisk": "<p>Deletes the specified block storage disk. The disk must be in the <code>available</code> state (not attached to a Lightsail instance).</p> <note> <p>The disk may remain in the <code>deleting</code> state for several minutes.</p> </note>",
|
|
"DeleteDiskSnapshot": "<p>Deletes the specified disk snapshot.</p> <p>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.</p>",
|
|
"DeleteDomain": "<p>Deletes the specified domain recordset and all of its domain records.</p>",
|
|
"DeleteDomainEntry": "<p>Deletes a specific domain entry.</p>",
|
|
"DeleteInstance": "<p>Deletes a specific Amazon Lightsail virtual private server, or <i>instance</i>.</p>",
|
|
"DeleteInstanceSnapshot": "<p>Deletes a specific snapshot of a virtual private server (or <i>instance</i>).</p>",
|
|
"DeleteKeyPair": "<p>Deletes a specific SSH key pair.</p>",
|
|
"DeleteLoadBalancer": "<p>Deletes a Lightsail load balancer.</p>",
|
|
"DeleteLoadBalancerTlsCertificate": "<p>Deletes a TLS/SSL certificate associated with a Lightsail load balancer.</p>",
|
|
"DetachDisk": "<p>Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.</p>",
|
|
"DetachInstancesFromLoadBalancer": "<p>Detaches the specified instances from a Lightsail load balancer.</p>",
|
|
"DetachStaticIp": "<p>Detaches a static IP from the Amazon Lightsail instance to which it is attached.</p>",
|
|
"DownloadDefaultKeyPair": "<p>Downloads the default SSH key pair from the user's account.</p>",
|
|
"GetActiveNames": "<p>Returns the names of all active (not deleted) resources.</p>",
|
|
"GetBlueprints": "<p>Returns the list of available instance images, or <i>blueprints</i>. 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.</p>",
|
|
"GetBundles": "<p>Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or <i>instance</i>).</p>",
|
|
"GetDisk": "<p>Returns information about a specific block storage disk.</p>",
|
|
"GetDiskSnapshot": "<p>Returns information about a specific block storage disk snapshot.</p>",
|
|
"GetDiskSnapshots": "<p>Returns information about all block storage disk snapshots in your AWS account and region.</p> <p>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.</p>",
|
|
"GetDisks": "<p>Returns information about all block storage disks in your AWS account and region.</p> <p>If you are describing a long list of disks, 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.</p>",
|
|
"GetDomain": "<p>Returns information about a specific domain recordset.</p>",
|
|
"GetDomains": "<p>Returns a list of all domains in the user's account.</p>",
|
|
"GetInstance": "<p>Returns information about a specific Amazon Lightsail instance, which is a virtual private server.</p>",
|
|
"GetInstanceAccessDetails": "<p>Returns temporary SSH keys you can use to connect to a specific virtual private server, or <i>instance</i>.</p>",
|
|
"GetInstanceMetricData": "<p>Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.</p>",
|
|
"GetInstancePortStates": "<p>Returns the port states for a specific virtual private server, or <i>instance</i>.</p>",
|
|
"GetInstanceSnapshot": "<p>Returns information about a specific instance snapshot.</p>",
|
|
"GetInstanceSnapshots": "<p>Returns all instance snapshots for the user's account.</p>",
|
|
"GetInstanceState": "<p>Returns the state of a specific instance. Works on one instance at a time.</p>",
|
|
"GetInstances": "<p>Returns information about all Amazon Lightsail virtual private servers, or <i>instances</i>.</p>",
|
|
"GetKeyPair": "<p>Returns information about a specific key pair.</p>",
|
|
"GetKeyPairs": "<p>Returns information about all key pairs in the user's account.</p>",
|
|
"GetLoadBalancer": "<p>Returns information about the specified Lightsail load balancer.</p>",
|
|
"GetLoadBalancerMetricData": "<p>Returns information about health metrics for your Lightsail load balancer.</p>",
|
|
"GetLoadBalancerTlsCertificates": "<p>Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>",
|
|
"GetLoadBalancers": "<p>Returns information about all load balancers in an account.</p> <p>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.</p>",
|
|
"GetOperation": "<p>Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.</p>",
|
|
"GetOperations": "<p>Returns information about all operations.</p> <p>Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to <code>GetOperations</code> use the maximum (last) <code>statusChangedAt</code> value from the previous request.</p>",
|
|
"GetOperationsForResource": "<p>Gets operations for a specific resource (e.g., an instance or a static IP).</p>",
|
|
"GetRegions": "<p>Returns a list of all valid regions for Amazon Lightsail. Use the <code>include availability zones</code> parameter to also return the availability zones in a region.</p>",
|
|
"GetStaticIp": "<p>Returns information about a specific static IP.</p>",
|
|
"GetStaticIps": "<p>Returns information about all static IPs in the user's account.</p>",
|
|
"ImportKeyPair": "<p>Imports a public SSH key from a specific key pair.</p>",
|
|
"IsVpcPeered": "<p>Returns a Boolean value indicating whether your Lightsail VPC is peered.</p>",
|
|
"OpenInstancePublicPorts": "<p>Adds public ports to an Amazon Lightsail instance.</p>",
|
|
"PeerVpc": "<p>Tries to peer the Lightsail VPC with the user's default VPC.</p>",
|
|
"PutInstancePublicPorts": "<p>Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.</p>",
|
|
"RebootInstance": "<p>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.</p>",
|
|
"ReleaseStaticIp": "<p>Deletes a specific static IP from your account.</p>",
|
|
"StartInstance": "<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.</p>",
|
|
"StopInstance": "<p>Stops a specific Amazon Lightsail instance that is currently running.</p>",
|
|
"UnpeerVpc": "<p>Attempts to unpeer the Lightsail VPC from the user's default VPC.</p>",
|
|
"UpdateDomainEntry": "<p>Updates a domain recordset after it is created.</p>",
|
|
"UpdateLoadBalancerAttribute": "<p>Updates the specified attribute for a load balancer.</p>"
|
|
},
|
|
"shapes": {
|
|
"AccessDeniedException": {
|
|
"base": "<p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"AccessDirection": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstancePortInfo$accessDirection": "<p>The access direction (<code>inbound</code> or <code>outbound</code>).</p>"
|
|
}
|
|
},
|
|
"AccountSetupInProgressException": {
|
|
"base": "<p>Lightsail throws this exception when an account is still in the setup in progress state.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"AllocateStaticIpRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AllocateStaticIpResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachDiskRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachDiskResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachInstancesToLoadBalancerRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachInstancesToLoadBalancerResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachLoadBalancerTlsCertificateRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachLoadBalancerTlsCertificateResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachStaticIpRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachStaticIpResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"AttachedDiskMap": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateInstancesFromSnapshotRequest$attachedDiskMapping": "<p>An object containing information about one or more disk mappings.</p>"
|
|
}
|
|
},
|
|
"AvailabilityZone": {
|
|
"base": "<p>Describes an Availability Zone.</p>",
|
|
"refs": {
|
|
"AvailabilityZoneList$member": null
|
|
}
|
|
},
|
|
"AvailabilityZoneList": {
|
|
"base": null,
|
|
"refs": {
|
|
"Region$availabilityZones": "<p>The Availability Zones. Follows the format <code>us-east-2a</code> (case-sensitive).</p>"
|
|
}
|
|
},
|
|
"Base64": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateKeyPairResult$publicKeyBase64": "<p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>",
|
|
"CreateKeyPairResult$privateKeyBase64": "<p>A base64-encoded RSA private key.</p>",
|
|
"DownloadDefaultKeyPairResult$publicKeyBase64": "<p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>",
|
|
"DownloadDefaultKeyPairResult$privateKeyBase64": "<p>A base64-encoded RSA private key.</p>",
|
|
"ImportKeyPairRequest$publicKeyBase64": "<p>A base64-encoded public key of the <code>ssh-rsa</code> type.</p>",
|
|
"KeyPair$fingerprint": "<p>The RSA fingerprint of the key pair.</p>"
|
|
}
|
|
},
|
|
"Blueprint": {
|
|
"base": "<p>Describes a blueprint (a virtual private server image).</p>",
|
|
"refs": {
|
|
"BlueprintList$member": null
|
|
}
|
|
},
|
|
"BlueprintList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetBlueprintsResult$blueprints": "<p>An array of key-value pairs that contains information about the available blueprints.</p>"
|
|
}
|
|
},
|
|
"BlueprintType": {
|
|
"base": null,
|
|
"refs": {
|
|
"Blueprint$type": "<p>The type of the blueprint (e.g., <code>os</code> or <code>app</code>).</p>"
|
|
}
|
|
},
|
|
"Bundle": {
|
|
"base": "<p>Describes a bundle, which is a set of specs describing your virtual private server (or <i>instance</i>).</p>",
|
|
"refs": {
|
|
"BundleList$member": null
|
|
}
|
|
},
|
|
"BundleList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetBundlesResult$bundles": "<p>An array of key-value pairs that contains information about the available bundles.</p>"
|
|
}
|
|
},
|
|
"CloseInstancePublicPortsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CloseInstancePublicPortsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskFromSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskFromSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDiskSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDomainEntryRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDomainEntryResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDomainRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateDomainResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstanceSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstanceSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstancesFromSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstancesFromSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstancesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateInstancesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateKeyPairRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateKeyPairResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateLoadBalancerRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateLoadBalancerResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateLoadBalancerTlsCertificateRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"CreateLoadBalancerTlsCertificateResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDiskRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDiskResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDiskSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDiskSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDomainEntryRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDomainEntryResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDomainRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteDomainResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteInstanceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteInstanceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteInstanceSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteInstanceSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteKeyPairRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteKeyPairResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteLoadBalancerRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteLoadBalancerResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteLoadBalancerTlsCertificateRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DeleteLoadBalancerTlsCertificateResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachDiskRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachDiskResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachInstancesFromLoadBalancerRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachInstancesFromLoadBalancerResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachStaticIpRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DetachStaticIpResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Disk": {
|
|
"base": "<p>Describes a system disk or an block storage disk.</p>",
|
|
"refs": {
|
|
"DiskList$member": null,
|
|
"GetDiskResult$disk": "<p>An object containing information about the disk.</p>"
|
|
}
|
|
},
|
|
"DiskList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetDisksResult$disks": "<p>An array of objects containing information about all block storage disks.</p>",
|
|
"InstanceHardware$disks": "<p>The disks attached to the instance.</p>",
|
|
"InstanceSnapshot$fromAttachedDisks": "<p>An array of disk objects containing information about all block storage disks.</p>"
|
|
}
|
|
},
|
|
"DiskMap": {
|
|
"base": "<p>Describes a block storage disk mapping.</p>",
|
|
"refs": {
|
|
"DiskMapList$member": null
|
|
}
|
|
},
|
|
"DiskMapList": {
|
|
"base": null,
|
|
"refs": {
|
|
"AttachedDiskMap$value": null
|
|
}
|
|
},
|
|
"DiskSnapshot": {
|
|
"base": "<p>Describes a block storage disk snapshot.</p>",
|
|
"refs": {
|
|
"DiskSnapshotList$member": null,
|
|
"GetDiskSnapshotResult$diskSnapshot": "<p>An object containing information about the disk snapshot.</p>"
|
|
}
|
|
},
|
|
"DiskSnapshotList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetDiskSnapshotsResult$diskSnapshots": "<p>An array of objects containing information about all block storage disk snapshots.</p>"
|
|
}
|
|
},
|
|
"DiskSnapshotState": {
|
|
"base": null,
|
|
"refs": {
|
|
"DiskSnapshot$state": "<p>The status of the disk snapshot operation.</p>"
|
|
}
|
|
},
|
|
"DiskState": {
|
|
"base": null,
|
|
"refs": {
|
|
"Disk$state": "<p>Describes the status of the disk.</p>"
|
|
}
|
|
},
|
|
"Domain": {
|
|
"base": "<p>Describes a domain where you are storing recordsets in Lightsail.</p>",
|
|
"refs": {
|
|
"DomainList$member": null,
|
|
"GetDomainResult$domain": "<p>An array of key-value pairs containing information about your get domain request.</p>"
|
|
}
|
|
},
|
|
"DomainEntry": {
|
|
"base": "<p>Describes a domain recordset entry.</p>",
|
|
"refs": {
|
|
"CreateDomainEntryRequest$domainEntry": "<p>An array of key-value pairs containing information about the domain entry request.</p>",
|
|
"DeleteDomainEntryRequest$domainEntry": "<p>An array of key-value pairs containing information about your domain entries.</p>",
|
|
"DomainEntryList$member": null,
|
|
"UpdateDomainEntryRequest$domainEntry": "<p>An array of key-value pairs containing information about the domain entry.</p>"
|
|
}
|
|
},
|
|
"DomainEntryList": {
|
|
"base": null,
|
|
"refs": {
|
|
"Domain$domainEntries": "<p>An array of key-value pairs containing information about the domain entries.</p>"
|
|
}
|
|
},
|
|
"DomainEntryOptions": {
|
|
"base": null,
|
|
"refs": {
|
|
"DomainEntry$options": "<p>(Deprecated) The options for the domain entry.</p> <note> <p>In releases prior to November 29, 2017, this parameter was not included in the API response. It is now deprecated.</p> </note>"
|
|
}
|
|
},
|
|
"DomainEntryOptionsKeys": {
|
|
"base": null,
|
|
"refs": {
|
|
"DomainEntryOptions$key": null
|
|
}
|
|
},
|
|
"DomainEntryType": {
|
|
"base": null,
|
|
"refs": {
|
|
"DomainEntry$type": "<p>The type of domain entry (e.g., <code>SOA</code> or <code>NS</code>).</p>"
|
|
}
|
|
},
|
|
"DomainList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetDomainsResult$domains": "<p>An array of key-value pairs containing information about each of the domain entries in the user's account.</p>"
|
|
}
|
|
},
|
|
"DomainName": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateDomainEntryRequest$domainName": "<p>The domain name (e.g., <code>example.com</code>) for which you want to create the domain entry.</p>",
|
|
"CreateDomainRequest$domainName": "<p>The domain name to manage (e.g., <code>example.com</code>).</p> <note> <p>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.</p> </note>",
|
|
"CreateLoadBalancerRequest$certificateDomainName": "<p>The domain name with which your certificate is associated (e.g., <code>example.com</code>).</p> <p>If you specify <code>certificateDomainName</code>, then <code>certificateName</code> is required (and vice-versa).</p>",
|
|
"CreateLoadBalancerTlsCertificateRequest$certificateDomainName": "<p>The domain name (e.g., <code>example.com</code>) for your TLS/SSL certificate.</p>",
|
|
"DeleteDomainEntryRequest$domainName": "<p>The name of the domain entry to delete.</p>",
|
|
"DeleteDomainRequest$domainName": "<p>The specific domain name to delete.</p>",
|
|
"DomainEntry$name": "<p>The name of the domain.</p>",
|
|
"DomainNameList$member": null,
|
|
"GetDomainRequest$domainName": "<p>The domain name for which your want to return information about.</p>",
|
|
"LoadBalancerTlsCertificate$domainName": "<p>The domain name for your TLS/SSL certificate.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationOption$domainName": "<p>A fully qualified domain name in the certificate request.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationRecord$domainName": "<p>The domain name against which your TLS/SSL certificate was validated.</p>",
|
|
"UpdateDomainEntryRequest$domainName": "<p>The name of the domain recordset to update.</p>"
|
|
}
|
|
},
|
|
"DomainNameList": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateLoadBalancerRequest$certificateAlternativeNames": "<p>The alternative domain names to use with your TLS/SSL certificate (e.g., <code>www.example.com</code>, <code>www.ejemplo.com</code>, <code>ejemplo.com</code>).</p>",
|
|
"CreateLoadBalancerTlsCertificateRequest$certificateAlternativeNames": "<p>An array of strings listing alternative domain names for your TLS/SSL certificate.</p>"
|
|
}
|
|
},
|
|
"DownloadDefaultKeyPairRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"DownloadDefaultKeyPairResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetActiveNamesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetActiveNamesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetBlueprintsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetBlueprintsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetBundlesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetBundlesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskSnapshotsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDiskSnapshotsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDisksRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDisksResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDomainRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDomainResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDomainsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetDomainsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceAccessDetailsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceAccessDetailsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceMetricDataRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceMetricDataResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstancePortStatesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstancePortStatesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceSnapshotRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceSnapshotResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceSnapshotsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceSnapshotsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceStateRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstanceStateResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstancesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetInstancesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetKeyPairRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetKeyPairResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetKeyPairsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetKeyPairsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerMetricDataRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerMetricDataResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerTlsCertificatesRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancerTlsCertificatesResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancersRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetLoadBalancersResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationsForResourceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationsForResourceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetOperationsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetRegionsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetRegionsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetStaticIpRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetStaticIpResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetStaticIpsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"GetStaticIpsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ImportKeyPairRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ImportKeyPairResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Instance": {
|
|
"base": "<p>Describes an instance (a virtual private server).</p>",
|
|
"refs": {
|
|
"GetInstanceResult$instance": "<p>An array of key-value pairs containing information about the specified instance.</p>",
|
|
"InstanceList$member": null
|
|
}
|
|
},
|
|
"InstanceAccessDetails": {
|
|
"base": "<p>The parameters for gaining temporary access to one of your Amazon Lightsail instances.</p>",
|
|
"refs": {
|
|
"GetInstanceAccessDetailsResult$accessDetails": "<p>An array of key-value pairs containing information about a get instance access request.</p>"
|
|
}
|
|
},
|
|
"InstanceAccessProtocol": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceAccessDetailsRequest$protocol": "<p>The protocol to use to connect to your instance. Defaults to <code>ssh</code>.</p>",
|
|
"InstanceAccessDetails$protocol": "<p>The protocol for these Amazon Lightsail instance access details.</p>"
|
|
}
|
|
},
|
|
"InstanceHardware": {
|
|
"base": "<p>Describes the hardware for the instance.</p>",
|
|
"refs": {
|
|
"Instance$hardware": "<p>The size of the vCPU and the amount of RAM for the instance.</p>"
|
|
}
|
|
},
|
|
"InstanceHealthReason": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstanceHealthSummary$instanceHealthReason": "<p>More information about the instance health. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"InstanceHealthState": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstanceHealthSummary$instanceHealth": "<p>Describes the overall instance health. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"InstanceHealthSummary": {
|
|
"base": "<p>Describes information about the health of the instance.</p>",
|
|
"refs": {
|
|
"InstanceHealthSummaryList$member": null
|
|
}
|
|
},
|
|
"InstanceHealthSummaryList": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$instanceHealthSummary": "<p>An array of InstanceHealthSummary objects describing the health of the load balancer.</p>"
|
|
}
|
|
},
|
|
"InstanceList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstancesResult$instances": "<p>An array of key-value pairs containing information about your instances.</p>"
|
|
}
|
|
},
|
|
"InstanceMetricName": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataRequest$metricName": "<p>The metric name to get data about. </p>",
|
|
"GetInstanceMetricDataResult$metricName": "<p>The metric name to return data for.</p>"
|
|
}
|
|
},
|
|
"InstanceNetworking": {
|
|
"base": "<p>Describes monthly data transfer rates and port information for an instance.</p>",
|
|
"refs": {
|
|
"Instance$networking": "<p>Information about the public ports and monthly data transfer rates for the instance.</p>"
|
|
}
|
|
},
|
|
"InstancePlatform": {
|
|
"base": null,
|
|
"refs": {
|
|
"Blueprint$platform": "<p>The operating system platform (either Linux/Unix-based or Windows Server-based) of the blueprint.</p>",
|
|
"InstancePlatformList$member": null
|
|
}
|
|
},
|
|
"InstancePlatformList": {
|
|
"base": null,
|
|
"refs": {
|
|
"Bundle$supportedPlatforms": "<p>The operating system platform (Linux/Unix-based or Windows Server-based) that the bundle supports. You can only launch a <code>WINDOWS</code> bundle on a blueprint that supports the <code>WINDOWS</code> platform. <code>LINUX_UNIX</code> blueprints require a <code>LINUX_UNIX</code> bundle.</p>"
|
|
}
|
|
},
|
|
"InstancePortInfo": {
|
|
"base": "<p>Describes information about the instance ports.</p>",
|
|
"refs": {
|
|
"InstancePortInfoList$member": null
|
|
}
|
|
},
|
|
"InstancePortInfoList": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstanceNetworking$ports": "<p>An array of key-value pairs containing information about the ports on the instance.</p>"
|
|
}
|
|
},
|
|
"InstancePortState": {
|
|
"base": "<p>Describes the port state.</p>",
|
|
"refs": {
|
|
"InstancePortStateList$member": null
|
|
}
|
|
},
|
|
"InstancePortStateList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstancePortStatesResult$portStates": "<p>Information about the port states resulting from your request.</p>"
|
|
}
|
|
},
|
|
"InstanceSnapshot": {
|
|
"base": "<p>Describes the snapshot of the virtual private server, or <i>instance</i>.</p>",
|
|
"refs": {
|
|
"GetInstanceSnapshotResult$instanceSnapshot": "<p>An array of key-value pairs containing information about the results of your get instance snapshot request.</p>",
|
|
"InstanceSnapshotList$member": null
|
|
}
|
|
},
|
|
"InstanceSnapshotList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceSnapshotsResult$instanceSnapshots": "<p>An array of key-value pairs containing information about the results of your get instance snapshots request.</p>"
|
|
}
|
|
},
|
|
"InstanceSnapshotState": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstanceSnapshot$state": "<p>The state the snapshot is in.</p>"
|
|
}
|
|
},
|
|
"InstanceState": {
|
|
"base": "<p>Describes the virtual private server (or <i>instance</i>) status.</p>",
|
|
"refs": {
|
|
"GetInstanceStateResult$state": "<p>The state of the instance.</p>",
|
|
"Instance$state": "<p>The status code and the state (e.g., <code>running</code>) for the instance.</p>"
|
|
}
|
|
},
|
|
"InvalidInputException": {
|
|
"base": "<p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.</p> </note>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"IpAddress": {
|
|
"base": null,
|
|
"refs": {
|
|
"Instance$privateIpAddress": "<p>The private IP address of the instance.</p>",
|
|
"Instance$publicIpAddress": "<p>The public IP address of the instance.</p>",
|
|
"InstanceAccessDetails$ipAddress": "<p>The public IP address of the Amazon Lightsail instance.</p>",
|
|
"StaticIp$ipAddress": "<p>The static IP address.</p>"
|
|
}
|
|
},
|
|
"IpV6Address": {
|
|
"base": null,
|
|
"refs": {
|
|
"Instance$ipv6Address": "<p>The IPv6 address of the instance.</p>"
|
|
}
|
|
},
|
|
"IsVpcPeeredRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"IsVpcPeeredResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"IsoDate": {
|
|
"base": null,
|
|
"refs": {
|
|
"Disk$createdAt": "<p>The date when the disk was created.</p>",
|
|
"DiskSnapshot$createdAt": "<p>The date when the disk snapshot was created.</p>",
|
|
"Domain$createdAt": "<p>The date when the domain recordset was created.</p>",
|
|
"Instance$createdAt": "<p>The timestamp when the instance was created (e.g., <code>1479734909.17</code>).</p>",
|
|
"InstanceAccessDetails$expiresAt": "<p>For SSH access, the date on which the temporary keys expire.</p>",
|
|
"InstanceSnapshot$createdAt": "<p>The timestamp when the snapshot was created (e.g., <code>1479907467.024</code>).</p>",
|
|
"KeyPair$createdAt": "<p>The timestamp when the key pair was created (e.g., <code>1479816991.349</code>).</p>",
|
|
"LoadBalancer$createdAt": "<p>The date when your load balancer was created.</p>",
|
|
"LoadBalancerTlsCertificate$createdAt": "<p>The time when you created your TLS/SSL certificate.</p>",
|
|
"LoadBalancerTlsCertificate$issuedAt": "<p>The time when the TLS/SSL certificate was issued.</p>",
|
|
"LoadBalancerTlsCertificate$notAfter": "<p>The timestamp when the TLS/SSL certificate expires.</p>",
|
|
"LoadBalancerTlsCertificate$notBefore": "<p>The timestamp when the TLS/SSL certificate is first valid.</p>",
|
|
"LoadBalancerTlsCertificate$revokedAt": "<p>The timestamp when the TLS/SSL certificate was revoked.</p>",
|
|
"Operation$createdAt": "<p>The timestamp when the operation was initialized (e.g., <code>1479816991.349</code>).</p>",
|
|
"Operation$statusChangedAt": "<p>The timestamp when the status was changed (e.g., <code>1479816991.349</code>).</p>",
|
|
"StaticIp$createdAt": "<p>The timestamp when the static IP was created (e.g., <code>1479735304.222</code>).</p>"
|
|
}
|
|
},
|
|
"KeyPair": {
|
|
"base": "<p>Describes the SSH key pair.</p>",
|
|
"refs": {
|
|
"CreateKeyPairResult$keyPair": "<p>An array of key-value pairs containing information about the new key pair you just created.</p>",
|
|
"GetKeyPairResult$keyPair": "<p>An array of key-value pairs containing information about the key pair.</p>",
|
|
"KeyPairList$member": null
|
|
}
|
|
},
|
|
"KeyPairList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetKeyPairsResult$keyPairs": "<p>An array of key-value pairs containing information about the key pairs.</p>"
|
|
}
|
|
},
|
|
"LoadBalancer": {
|
|
"base": "<p>Describes the Lightsail load balancer.</p>",
|
|
"refs": {
|
|
"GetLoadBalancerResult$loadBalancer": "<p>An object containing information about your load balancer.</p>",
|
|
"LoadBalancerList$member": null
|
|
}
|
|
},
|
|
"LoadBalancerAttributeName": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerConfigurationOptions$key": null,
|
|
"UpdateLoadBalancerAttributeRequest$attributeName": "<p>The name of the attribute you want to update. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerConfigurationOptions": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$configurationOptions": "<p>A string to string map of the configuration options for your load balancer. Valid values are listed below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetLoadBalancersResult$loadBalancers": "<p>An array of LoadBalancer objects describing your load balancers.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerMetricName": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetLoadBalancerMetricDataRequest$metricName": "<p>The metric about which you want to return information. Valid values are listed below, along with the most useful <code>statistics</code> to include in your request.</p> <ul> <li> <p> <b> <code>ClientTLSNegotiationErrorCount</code> </b> - 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.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> </li> <li> <p> <b> <code>HealthyHostCount</code> </b> - The number of target instances that are considered healthy.</p> <p> <code>Statistics</code>: The most useful statistic are <code>Average</code>, <code>Minimum</code>, and <code>Maximum</code>.</p> </li> <li> <p> <b> <code>UnhealthyHostCount</code> </b> - The number of target instances that are considered unhealthy.</p> <p> <code>Statistics</code>: The most useful statistic are <code>Average</code>, <code>Minimum</code>, and <code>Maximum</code>.</p> </li> <li> <p> <b> <code>HTTPCode_LB_4XX_Count</code> </b> - 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.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>HTTPCode_LB_5XX_Count</code> </b> - 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.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>HTTPCode_Instance_2XX_Count</code> </b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>HTTPCode_Instance_3XX_Count</code> </b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer. </p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>HTTPCode_Instance_4XX_Count</code> </b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>HTTPCode_Instance_5XX_Count</code> </b> - The number of HTTP response codes generated by the target instances. This does not include any response codes generated by the load balancer.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> <li> <p> <b> <code>InstanceResponseTime</code> </b> - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Average</code>.</p> </li> <li> <p> <b> <code>RejectedConnectionCount</code> </b> - The number of connections that were rejected because the load balancer had reached its maximum number of connections.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>.</p> </li> <li> <p> <b> <code>RequestCount</code> </b> - 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.</p> <p> <code>Statistics</code>: The most useful statistic is <code>Sum</code>. Note that <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code> all return <code>1</code>.</p> </li> </ul>",
|
|
"GetLoadBalancerMetricDataResult$metricName": "<p>The metric about which you are receiving information. Valid values are listed below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerProtocol": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$protocol": "<p>The protocol you have enabled for your load balancer. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerState": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$state": "<p>The status of your load balancer. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificate": {
|
|
"base": "<p>Describes a load balancer TLS/SSL certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>",
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateList$member": null
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateDomainStatus": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateDomainValidationOption$validationStatus": "<p>The status of the domain validation. Valid values are listed below.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationRecord$validationStatus": "<p>The validation status. Valid values are listed below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateDomainValidationOption": {
|
|
"base": "<p>Contains information about the domain names on a TLS/SSL certificate that you will use to validate domain ownership.</p>",
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateDomainValidationOptionList$member": null
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateDomainValidationOptionList": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateRenewalSummary$domainValidationOptions": "<p>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.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateDomainValidationRecord": {
|
|
"base": "<p>Describes the validation record of each domain name in the TLS/SSL certificate.</p>",
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateDomainValidationRecordList$member": null
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateDomainValidationRecordList": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificate$domainValidationRecords": "<p>An array of LoadBalancerTlsCertificateDomainValidationRecord objects describing the records.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateFailureReason": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificate$failureReason": "<p>The reason for the TLS/SSL certificate validation failure.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetLoadBalancerTlsCertificatesResult$tlsCertificates": "<p>An array of LoadBalancerTlsCertificate objects describing your TLS/SSL certificates.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateRenewalStatus": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateRenewalSummary$renewalStatus": "<p>The status of Lightsail's managed renewal of the certificate. Valid values are listed below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateRenewalSummary": {
|
|
"base": "<p>Contains information about the status of Lightsail's managed renewal for the certificate.</p>",
|
|
"refs": {
|
|
"LoadBalancerTlsCertificate$renewalSummary": "<p>An object containing information about the status of Lightsail's managed renewal for the certificate.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateRevocationReason": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificate$revocationReason": "<p>The reason the certificate was revoked. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateStatus": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancerTlsCertificate$status": "<p>The status of the TLS/SSL certificate. Valid values are below.</p>"
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateSummary": {
|
|
"base": "<p>Provides a summary of TLS/SSL certificate metadata.</p>",
|
|
"refs": {
|
|
"LoadBalancerTlsCertificateSummaryList$member": null
|
|
}
|
|
},
|
|
"LoadBalancerTlsCertificateSummaryList": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$tlsCertificateSummaries": "<p>An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.</p>"
|
|
}
|
|
},
|
|
"MetricDatapoint": {
|
|
"base": "<p>Describes the metric data point.</p>",
|
|
"refs": {
|
|
"MetricDatapointList$member": null
|
|
}
|
|
},
|
|
"MetricDatapointList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataResult$metricData": "<p>An array of key-value pairs containing information about the results of your get instance metric data request.</p>",
|
|
"GetLoadBalancerMetricDataResult$metricData": "<p>An array of metric datapoint objects.</p>"
|
|
}
|
|
},
|
|
"MetricPeriod": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataRequest$period": "<p>The time period for which you are requesting data.</p>",
|
|
"GetLoadBalancerMetricDataRequest$period": "<p>The time period duration for your health data request.</p>"
|
|
}
|
|
},
|
|
"MetricStatistic": {
|
|
"base": null,
|
|
"refs": {
|
|
"MetricStatisticList$member": null
|
|
}
|
|
},
|
|
"MetricStatisticList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataRequest$statistics": "<p>The instance statistics. </p>",
|
|
"GetLoadBalancerMetricDataRequest$statistics": "<p>An array of statistics that you want to request metrics for. Valid values are listed below.</p>"
|
|
}
|
|
},
|
|
"MetricUnit": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataRequest$unit": "<p>The unit. The list of valid values is below.</p>",
|
|
"GetLoadBalancerMetricDataRequest$unit": "<p>The unit for the time period request. Valid values are listed below.</p>",
|
|
"MetricDatapoint$unit": "<p>The unit. </p>"
|
|
}
|
|
},
|
|
"MonthlyTransfer": {
|
|
"base": "<p>Describes the monthly data transfer in and out of your virtual private server (or <i>instance</i>).</p>",
|
|
"refs": {
|
|
"InstanceNetworking$monthlyTransfer": "<p>The amount of data in GB allocated for monthly data transfers.</p>"
|
|
}
|
|
},
|
|
"NetworkProtocol": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstancePortInfo$protocol": "<p>The protocol being used. Can be one of the following.</p> <ul> <li> <p> <code>tcp</code> - 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.</p> </li> <li> <p> <code>all</code> - All transport layer protocol types. For more general information, see <a href=\"https://en.wikipedia.org/wiki/Transport_layer\">Transport layer</a> on Wikipedia.</p> </li> <li> <p> <code>udp</code> - 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.</p> </li> </ul>",
|
|
"InstancePortState$protocol": "<p>The protocol being used. Can be one of the following.</p> <ul> <li> <p> <code>tcp</code> - 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.</p> </li> <li> <p> <code>all</code> - All transport layer protocol types. For more general information, see <a href=\"https://en.wikipedia.org/wiki/Transport_layer\">Transport layer</a> on Wikipedia.</p> </li> <li> <p> <code>udp</code> - 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.</p> </li> </ul>",
|
|
"PortInfo$protocol": "<p>The protocol. </p>"
|
|
}
|
|
},
|
|
"NonEmptyString": {
|
|
"base": null,
|
|
"refs": {
|
|
"AttachDiskRequest$diskPath": "<p>The disk path to expose to the instance (e.g., <code>/dev/xvdf</code>).</p>",
|
|
"AvailabilityZone$zoneName": "<p>The name of the Availability Zone. The format is <code>us-east-2a</code> (case-sensitive).</p>",
|
|
"AvailabilityZone$state": "<p>The state of the Availability Zone.</p>",
|
|
"Blueprint$blueprintId": "<p>The ID for the virtual private server image (e.g., <code>app_wordpress_4_4</code> or <code>app_lamp_7_0</code>).</p>",
|
|
"Blueprint$group": "<p>The group name of the blueprint (e.g., <code>amazon-linux</code>).</p>",
|
|
"Bundle$bundleId": "<p>The bundle ID (e.g., <code>micro_1_0</code>).</p>",
|
|
"CreateDiskFromSnapshotRequest$availabilityZone": "<p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.</p> <p>Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.</p>",
|
|
"CreateDiskRequest$availabilityZone": "<p>The Availability Zone where you want to create the disk (e.g., <code>us-east-2a</code>). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.</p> <p>Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.</p>",
|
|
"CreateInstancesFromSnapshotRequest$bundleId": "<p>The bundle of specification information for your virtual private server (or <i>instance</i>), including the pricing plan (e.g., <code>micro_1_0</code>).</p>",
|
|
"CreateInstancesRequest$blueprintId": "<p>The ID for a virtual private server image (e.g., <code>app_wordpress_4_4</code> or <code>app_lamp_7_0</code>). Use the get blueprints operation to return a list of available images (or <i>blueprints</i>).</p>",
|
|
"CreateInstancesRequest$bundleId": "<p>The bundle of specification information for your virtual private server (or <i>instance</i>), including the pricing plan (e.g., <code>micro_1_0</code>).</p>",
|
|
"Disk$arn": "<p>The Amazon Resource Name (ARN) of the disk.</p>",
|
|
"DiskMap$originalDiskPath": "<p>The original disk path exposed to the instance (for example, <code>/dev/sdh</code>).</p>",
|
|
"DiskSnapshot$arn": "<p>The Amazon Resource Name (ARN) of the disk snapshot.</p>",
|
|
"DiskSnapshot$fromDiskArn": "<p>The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.</p>",
|
|
"Domain$arn": "<p>The Amazon Resource Name (ARN) of the domain recordset (e.g., <code>arn:aws:lightsail:global:123456789101:Domain/824cede0-abc7-4f84-8dbc-12345EXAMPLE</code>).</p>",
|
|
"DomainEntry$id": "<p>The ID of the domain recordset entry.</p>",
|
|
"GetOperationRequest$operationId": "<p>A GUID used to identify the operation.</p>",
|
|
"Instance$arn": "<p>The Amazon Resource Name (ARN) of the instance (e.g., <code>arn:aws:lightsail:us-east-2:123456789101:Instance/244ad76f-8aad-4741-809f-12345EXAMPLE</code>).</p>",
|
|
"Instance$blueprintId": "<p>The blueprint ID (e.g., <code>os_amlinux_2016_03</code>).</p>",
|
|
"Instance$blueprintName": "<p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>",
|
|
"Instance$bundleId": "<p>The bundle for the instance (e.g., <code>micro_1_0</code>).</p>",
|
|
"Instance$username": "<p>The user name for connecting to the instance (e.g., <code>ec2-user</code>).</p>",
|
|
"InstanceSnapshot$arn": "<p>The Amazon Resource Name (ARN) of the snapshot (e.g., <code>arn:aws:lightsail:us-east-2:123456789101:InstanceSnapshot/d23b5706-3322-4d83-81e5-12345EXAMPLE</code>).</p>",
|
|
"InstanceSnapshot$fromInstanceArn": "<p>The Amazon Resource Name (ARN) of the instance from which the snapshot was created (e.g., <code>arn:aws:lightsail:us-east-2:123456789101:Instance/64b8404c-ccb1-430b-8daf-12345EXAMPLE</code>).</p>",
|
|
"KeyPair$arn": "<p>The Amazon Resource Name (ARN) of the key pair (e.g., <code>arn:aws:lightsail:us-east-2:123456789101:KeyPair/05859e3d-331d-48ba-9034-12345EXAMPLE</code>).</p>",
|
|
"LoadBalancer$arn": "<p>The Amazon Resource Name (ARN) of the load balancer.</p>",
|
|
"LoadBalancer$dnsName": "<p>The DNS name of your Lightsail load balancer.</p>",
|
|
"LoadBalancer$healthCheckPath": "<p>The path you specified to perform your health checks. If no path is specified, the load balancer tries to make a request to the default (root) page.</p>",
|
|
"LoadBalancerTlsCertificate$arn": "<p>The Amazon Resource Name (ARN) of the TLS/SSL certificate.</p>",
|
|
"LoadBalancerTlsCertificate$issuer": "<p>The issuer of the certificate.</p>",
|
|
"LoadBalancerTlsCertificate$keyAlgorithm": "<p>The algorithm that was used to generate the key pair (the public and private key).</p>",
|
|
"LoadBalancerTlsCertificate$serial": "<p>The serial number of the certificate.</p>",
|
|
"LoadBalancerTlsCertificate$signatureAlgorithm": "<p>The algorithm that was used to sign the certificate.</p>",
|
|
"LoadBalancerTlsCertificate$subject": "<p>The name of the entity that is associated with the public key contained in the certificate.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationRecord$name": "<p>A fully qualified domain name in the certificate. For example, <code>example.com</code>.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationRecord$type": "<p>The type of validation record. For example, <code>CNAME</code> for domain validation.</p>",
|
|
"LoadBalancerTlsCertificateDomainValidationRecord$value": "<p>The value for that type.</p>",
|
|
"Operation$id": "<p>The ID of the operation.</p>",
|
|
"StaticIp$arn": "<p>The Amazon Resource Name (ARN) of the static IP (e.g., <code>arn:aws:lightsail:us-east-2:123456789101:StaticIp/9cbb4a9e-f8e3-4dfe-b57e-12345EXAMPLE</code>).</p>"
|
|
}
|
|
},
|
|
"NotFoundException": {
|
|
"base": "<p>Lightsail throws this exception when it cannot find a resource.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"OpenInstancePublicPortsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"OpenInstancePublicPortsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Operation": {
|
|
"base": "<p>Describes the API operation.</p>",
|
|
"refs": {
|
|
"CloseInstancePublicPortsResult$operation": "<p>An array of key-value pairs that contains information about the operation.</p>",
|
|
"CreateDomainEntryResult$operation": "<p>An array of key-value pairs containing information about the operation.</p>",
|
|
"CreateDomainResult$operation": "<p>An array of key-value pairs containing information about the domain resource you created.</p>",
|
|
"CreateKeyPairResult$operation": "<p>An array of key-value pairs containing information about the results of your create key pair request.</p>",
|
|
"DeleteDomainEntryResult$operation": "<p>An array of key-value pairs containing information about the results of your delete domain entry request.</p>",
|
|
"DeleteDomainResult$operation": "<p>An array of key-value pairs containing information about the results of your delete domain request.</p>",
|
|
"DeleteKeyPairResult$operation": "<p>An array of key-value pairs containing information about the results of your delete key pair request.</p>",
|
|
"GetOperationResult$operation": "<p>An array of key-value pairs containing information about the results of your get operation request.</p>",
|
|
"ImportKeyPairResult$operation": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"OpenInstancePublicPortsResult$operation": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"OperationList$member": null,
|
|
"PeerVpcResult$operation": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"PutInstancePublicPortsResult$operation": "<p>Describes metadata about the operation you just executed.</p>",
|
|
"UnpeerVpcResult$operation": "<p>An array of key-value pairs containing information about the request operation.</p>"
|
|
}
|
|
},
|
|
"OperationFailureException": {
|
|
"base": "<p>Lightsail throws this exception when an operation fails to execute.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"OperationList": {
|
|
"base": null,
|
|
"refs": {
|
|
"AllocateStaticIpResult$operations": "<p>An array of key-value pairs containing information about the static IP address you allocated.</p>",
|
|
"AttachDiskResult$operations": "<p>An object describing the API operations.</p>",
|
|
"AttachInstancesToLoadBalancerResult$operations": "<p>An object representing the API operations.</p>",
|
|
"AttachLoadBalancerTlsCertificateResult$operations": "<p>An object representing the API operations.</p>",
|
|
"AttachStaticIpResult$operations": "<p>An array of key-value pairs containing information about your API operations.</p>",
|
|
"CreateDiskFromSnapshotResult$operations": "<p>An object describing the API operations.</p>",
|
|
"CreateDiskResult$operations": "<p>An object describing the API operations.</p>",
|
|
"CreateDiskSnapshotResult$operations": "<p>An object describing the API operations.</p>",
|
|
"CreateInstanceSnapshotResult$operations": "<p>An array of key-value pairs containing information about the results of your create instances snapshot request.</p>",
|
|
"CreateInstancesFromSnapshotResult$operations": "<p>An array of key-value pairs containing information about the results of your create instances from snapshot request.</p>",
|
|
"CreateInstancesResult$operations": "<p>An array of key-value pairs containing information about the results of your create instances request.</p>",
|
|
"CreateLoadBalancerResult$operations": "<p>An object containing information about the API operations.</p>",
|
|
"CreateLoadBalancerTlsCertificateResult$operations": "<p>An object containing information about the API operations.</p>",
|
|
"DeleteDiskResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DeleteDiskSnapshotResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DeleteInstanceResult$operations": "<p>An array of key-value pairs containing information about the results of your delete instance request.</p>",
|
|
"DeleteInstanceSnapshotResult$operations": "<p>An array of key-value pairs containing information about the results of your delete instance snapshot request.</p>",
|
|
"DeleteLoadBalancerResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DeleteLoadBalancerTlsCertificateResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DetachDiskResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DetachInstancesFromLoadBalancerResult$operations": "<p>An object describing the API operations.</p>",
|
|
"DetachStaticIpResult$operations": "<p>An array of key-value pairs containing information about the results of your detach static IP request.</p>",
|
|
"GetOperationsForResourceResult$operations": "<p>An array of key-value pairs containing information about the results of your get operations for resource request.</p>",
|
|
"GetOperationsResult$operations": "<p>An array of key-value pairs containing information about the results of your get operations request.</p>",
|
|
"RebootInstanceResult$operations": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"ReleaseStaticIpResult$operations": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"StartInstanceResult$operations": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"StopInstanceResult$operations": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"UpdateDomainEntryResult$operations": "<p>An array of key-value pairs containing information about the request operation.</p>",
|
|
"UpdateLoadBalancerAttributeResult$operations": "<p>An object describing the API operations.</p>"
|
|
}
|
|
},
|
|
"OperationStatus": {
|
|
"base": null,
|
|
"refs": {
|
|
"Operation$status": "<p>The status of the operation. </p>"
|
|
}
|
|
},
|
|
"OperationType": {
|
|
"base": null,
|
|
"refs": {
|
|
"Operation$operationType": "<p>The type of operation. </p>"
|
|
}
|
|
},
|
|
"PasswordData": {
|
|
"base": "<p>The password data for the Windows Server-based instance, including the ciphertext and the key pair name.</p>",
|
|
"refs": {
|
|
"InstanceAccessDetails$passwordData": "<p>For a Windows Server-based instance, an object with the data you can use to retrieve your password. This is only needed if <code>password</code> 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.</p>"
|
|
}
|
|
},
|
|
"PeerVpcRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"PeerVpcResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Port": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateLoadBalancerRequest$instancePort": "<p>The instance port where you're creating your load balancer.</p>",
|
|
"InstancePortInfo$fromPort": "<p>The first port in the range.</p>",
|
|
"InstancePortInfo$toPort": "<p>The last port in the range.</p>",
|
|
"InstancePortState$fromPort": "<p>The first port in the range.</p>",
|
|
"InstancePortState$toPort": "<p>The last port in the range.</p>",
|
|
"PortInfo$fromPort": "<p>The first port in the range.</p>",
|
|
"PortInfo$toPort": "<p>The last port in the range.</p>",
|
|
"PortList$member": null
|
|
}
|
|
},
|
|
"PortAccessType": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstancePortInfo$accessType": "<p>The type of access (<code>Public</code> or <code>Private</code>).</p>"
|
|
}
|
|
},
|
|
"PortInfo": {
|
|
"base": "<p>Describes information about the ports on your virtual private server (or <i>instance</i>).</p>",
|
|
"refs": {
|
|
"CloseInstancePublicPortsRequest$portInfo": "<p>Information about the public port you are trying to close.</p>",
|
|
"OpenInstancePublicPortsRequest$portInfo": "<p>An array of key-value pairs containing information about the port mappings.</p>",
|
|
"PortInfoList$member": null
|
|
}
|
|
},
|
|
"PortInfoList": {
|
|
"base": null,
|
|
"refs": {
|
|
"PutInstancePublicPortsRequest$portInfos": "<p>Specifies information about the public port(s).</p>"
|
|
}
|
|
},
|
|
"PortList": {
|
|
"base": null,
|
|
"refs": {
|
|
"LoadBalancer$publicPorts": "<p>An array of public port settings for your load balancer.</p>"
|
|
}
|
|
},
|
|
"PortState": {
|
|
"base": null,
|
|
"refs": {
|
|
"InstancePortState$state": "<p>Specifies whether the instance port is <code>open</code> or <code>closed</code>.</p>"
|
|
}
|
|
},
|
|
"PutInstancePublicPortsRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"PutInstancePublicPortsResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"RebootInstanceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"RebootInstanceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"Region": {
|
|
"base": "<p>Describes the AWS Region.</p>",
|
|
"refs": {
|
|
"RegionList$member": null
|
|
}
|
|
},
|
|
"RegionList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetRegionsResult$regions": "<p>An array of key-value pairs containing information about your get regions request.</p>"
|
|
}
|
|
},
|
|
"RegionName": {
|
|
"base": null,
|
|
"refs": {
|
|
"Region$name": "<p>The region name (e.g., <code>us-east-2</code>).</p>",
|
|
"ResourceLocation$regionName": "<p>The AWS Region name.</p>"
|
|
}
|
|
},
|
|
"ReleaseStaticIpRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ReleaseStaticIpResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"ResourceLocation": {
|
|
"base": "<p>Describes the resource location.</p>",
|
|
"refs": {
|
|
"Disk$location": "<p>The AWS Region and Availability Zone where the disk is located.</p>",
|
|
"DiskSnapshot$location": "<p>The AWS Region and Availability Zone where the disk snapshot was created.</p>",
|
|
"Domain$location": "<p>The AWS Region and Availability Zones where the domain recordset was created.</p>",
|
|
"Instance$location": "<p>The region name and availability zone where the instance is located.</p>",
|
|
"InstanceSnapshot$location": "<p>The region name and availability zone where you created the snapshot.</p>",
|
|
"KeyPair$location": "<p>The region name and Availability Zone where the key pair was created.</p>",
|
|
"LoadBalancer$location": "<p>The AWS Region and Availability Zone where your load balancer was created (e.g., <code>us-east-2a</code>).</p>",
|
|
"LoadBalancerTlsCertificate$location": "<p>The AWS Region and Availability Zone where you created your certificate.</p>",
|
|
"Operation$location": "<p>The region and Availability Zone.</p>",
|
|
"StaticIp$location": "<p>The region and Availability Zone where the static IP was created.</p>"
|
|
}
|
|
},
|
|
"ResourceName": {
|
|
"base": null,
|
|
"refs": {
|
|
"AllocateStaticIpRequest$staticIpName": "<p>The name of the static IP address.</p>",
|
|
"AttachDiskRequest$diskName": "<p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>",
|
|
"AttachDiskRequest$instanceName": "<p>The name of the Lightsail instance where you want to utilize the storage disk.</p>",
|
|
"AttachInstancesToLoadBalancerRequest$loadBalancerName": "<p>The name of the load balancer.</p>",
|
|
"AttachLoadBalancerTlsCertificateRequest$loadBalancerName": "<p>The name of the load balancer to which you want to associate the TLS/SSL certificate.</p>",
|
|
"AttachLoadBalancerTlsCertificateRequest$certificateName": "<p>The name of your TLS/SSL certificate.</p>",
|
|
"AttachStaticIpRequest$staticIpName": "<p>The name of the static IP.</p>",
|
|
"AttachStaticIpRequest$instanceName": "<p>The instance name to which you want to attach the static IP address.</p>",
|
|
"AttachedDiskMap$key": null,
|
|
"Blueprint$name": "<p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>",
|
|
"CloseInstancePublicPortsRequest$instanceName": "<p>The name of the instance on which you're attempting to close the public ports.</p>",
|
|
"CreateDiskFromSnapshotRequest$diskName": "<p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>",
|
|
"CreateDiskFromSnapshotRequest$diskSnapshotName": "<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p>",
|
|
"CreateDiskRequest$diskName": "<p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>",
|
|
"CreateDiskSnapshotRequest$diskName": "<p>The unique name of the source disk (e.g., <code>my-source-disk</code>).</p>",
|
|
"CreateDiskSnapshotRequest$diskSnapshotName": "<p>The name of the destination disk snapshot (e.g., <code>my-disk-snapshot</code>) based on the source disk.</p>",
|
|
"CreateInstanceSnapshotRequest$instanceSnapshotName": "<p>The name for your new snapshot.</p>",
|
|
"CreateInstanceSnapshotRequest$instanceName": "<p>The Lightsail instance on which to base your snapshot.</p>",
|
|
"CreateInstancesFromSnapshotRequest$instanceSnapshotName": "<p>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.</p>",
|
|
"CreateInstancesFromSnapshotRequest$keyPairName": "<p>The name for your key pair.</p>",
|
|
"CreateInstancesRequest$customImageName": "<p>(Deprecated) The name for your custom image.</p> <note> <p>In releases prior to June 12, 2017, this parameter was ignored by the API. It is now deprecated.</p> </note>",
|
|
"CreateInstancesRequest$keyPairName": "<p>The name of your key pair.</p>",
|
|
"CreateKeyPairRequest$keyPairName": "<p>The name for your new key pair.</p>",
|
|
"CreateLoadBalancerRequest$loadBalancerName": "<p>The name of your load balancer.</p>",
|
|
"CreateLoadBalancerRequest$certificateName": "<p>The name of the TLS/SSL certificate.</p> <p>If you specify <code>certificateName</code>, then <code>certificateDomainName</code> is required (and vice-versa).</p>",
|
|
"CreateLoadBalancerTlsCertificateRequest$loadBalancerName": "<p>The load balancer name where you want to create the TLS/SSL certificate.</p>",
|
|
"CreateLoadBalancerTlsCertificateRequest$certificateName": "<p>The TLS/SSL certificate name.</p>",
|
|
"DeleteDiskRequest$diskName": "<p>The unique name of the disk you want to delete (e.g., <code>my-disk</code>).</p>",
|
|
"DeleteDiskSnapshotRequest$diskSnapshotName": "<p>The name of the disk snapshot you want to delete (e.g., <code>my-disk-snapshot</code>).</p>",
|
|
"DeleteInstanceRequest$instanceName": "<p>The name of the instance to delete.</p>",
|
|
"DeleteInstanceSnapshotRequest$instanceSnapshotName": "<p>The name of the snapshot to delete.</p>",
|
|
"DeleteKeyPairRequest$keyPairName": "<p>The name of the key pair to delete.</p>",
|
|
"DeleteLoadBalancerRequest$loadBalancerName": "<p>The name of the load balancer you want to delete.</p>",
|
|
"DeleteLoadBalancerTlsCertificateRequest$loadBalancerName": "<p>The load balancer name.</p>",
|
|
"DeleteLoadBalancerTlsCertificateRequest$certificateName": "<p>The TLS/SSL certificate name.</p>",
|
|
"DetachDiskRequest$diskName": "<p>The unique name of the disk you want to detach from your instance (e.g., <code>my-disk</code>).</p>",
|
|
"DetachInstancesFromLoadBalancerRequest$loadBalancerName": "<p>The name of the Lightsail load balancer.</p>",
|
|
"DetachStaticIpRequest$staticIpName": "<p>The name of the static IP to detach from the instance.</p>",
|
|
"Disk$name": "<p>The unique name of the disk.</p>",
|
|
"Disk$attachedTo": "<p>The resources to which the disk is attached.</p>",
|
|
"DiskMap$newDiskName": "<p>The new disk name (e.g., <code>my-new-disk</code>).</p>",
|
|
"DiskSnapshot$name": "<p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>",
|
|
"DiskSnapshot$fromDiskName": "<p>The unique name of the source disk from which you are creating the disk snapshot.</p>",
|
|
"Domain$name": "<p>The name of the domain.</p>",
|
|
"GetDiskRequest$diskName": "<p>The name of the disk (e.g., <code>my-disk</code>).</p>",
|
|
"GetDiskSnapshotRequest$diskSnapshotName": "<p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>",
|
|
"GetInstanceAccessDetailsRequest$instanceName": "<p>The name of the instance to access.</p>",
|
|
"GetInstanceMetricDataRequest$instanceName": "<p>The name of the instance for which you want to get metrics data.</p>",
|
|
"GetInstancePortStatesRequest$instanceName": "<p>The name of the instance.</p>",
|
|
"GetInstanceRequest$instanceName": "<p>The name of the instance.</p>",
|
|
"GetInstanceSnapshotRequest$instanceSnapshotName": "<p>The name of the snapshot for which you are requesting information.</p>",
|
|
"GetInstanceStateRequest$instanceName": "<p>The name of the instance to get state information about.</p>",
|
|
"GetKeyPairRequest$keyPairName": "<p>The name of the key pair for which you are requesting information.</p>",
|
|
"GetLoadBalancerMetricDataRequest$loadBalancerName": "<p>The name of the load balancer.</p>",
|
|
"GetLoadBalancerRequest$loadBalancerName": "<p>The name of the load balancer.</p>",
|
|
"GetLoadBalancerTlsCertificatesRequest$loadBalancerName": "<p>The name of the load balancer where you stored your TLS/SSL certificate.</p>",
|
|
"GetOperationsForResourceRequest$resourceName": "<p>The name of the resource for which you are requesting information.</p>",
|
|
"GetStaticIpRequest$staticIpName": "<p>The name of the static IP in Lightsail.</p>",
|
|
"ImportKeyPairRequest$keyPairName": "<p>The name of the key pair for which you want to import the public key.</p>",
|
|
"Instance$name": "<p>The name the user gave the instance (e.g., <code>Amazon_Linux-1GB-Ohio-1</code>).</p>",
|
|
"Instance$sshKeyName": "<p>The name of the SSH key being used to connect to the instance (e.g., <code>LightsailDefaultKeyPair</code>).</p>",
|
|
"InstanceAccessDetails$instanceName": "<p>The name of this Amazon Lightsail instance.</p>",
|
|
"InstanceHealthSummary$instanceName": "<p>The name of the Lightsail instance for which you are requesting health check data.</p>",
|
|
"InstanceSnapshot$name": "<p>The name of the snapshot.</p>",
|
|
"InstanceSnapshot$fromInstanceName": "<p>The instance from which the snapshot was created.</p>",
|
|
"KeyPair$name": "<p>The friendly name of the SSH key pair.</p>",
|
|
"LoadBalancer$name": "<p>The name of the load balancer (e.g., <code>my-load-balancer</code>).</p>",
|
|
"LoadBalancerTlsCertificate$name": "<p>The name of the TLS/SSL certificate (e.g., <code>my-certificate</code>).</p>",
|
|
"LoadBalancerTlsCertificate$loadBalancerName": "<p>The load balancer name where your TLS/SSL certificate is attached.</p>",
|
|
"LoadBalancerTlsCertificateSummary$name": "<p>The name of the TLS/SSL certificate.</p>",
|
|
"OpenInstancePublicPortsRequest$instanceName": "<p>The name of the instance for which you want to open the public ports.</p>",
|
|
"Operation$resourceName": "<p>The resource name.</p>",
|
|
"PasswordData$keyPairName": "<p>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 (<code>LightsailDefaultKeyPair</code>).</p> <p>If you are using a custom key pair, you need to use your own means of decrypting your password using the <code>ciphertext</code>. Lightsail creates the ciphertext by encrypting your password with the public key part of this key pair.</p>",
|
|
"PutInstancePublicPortsRequest$instanceName": "<p>The Lightsail instance name of the public port(s) you are setting.</p>",
|
|
"RebootInstanceRequest$instanceName": "<p>The name of the instance to reboot.</p>",
|
|
"ReleaseStaticIpRequest$staticIpName": "<p>The name of the static IP to delete.</p>",
|
|
"ResourceNameList$member": null,
|
|
"StartInstanceRequest$instanceName": "<p>The name of the instance (a virtual private server) to start.</p>",
|
|
"StaticIp$name": "<p>The name of the static IP (e.g., <code>StaticIP-Ohio-EXAMPLE</code>).</p>",
|
|
"StaticIp$attachedTo": "<p>The instance where the static IP is attached (e.g., <code>Amazon_Linux-1GB-Ohio-1</code>).</p>",
|
|
"StopInstanceRequest$instanceName": "<p>The name of the instance (a virtual private server) to stop.</p>",
|
|
"UpdateLoadBalancerAttributeRequest$loadBalancerName": "<p>The name of the load balancer that you want to modify.</p>"
|
|
}
|
|
},
|
|
"ResourceNameList": {
|
|
"base": null,
|
|
"refs": {
|
|
"AttachInstancesToLoadBalancerRequest$instanceNames": "<p>An array of strings representing the instance name(s) you want to attach to your load balancer.</p>",
|
|
"DetachInstancesFromLoadBalancerRequest$instanceNames": "<p>An array of strings containing the names of the instances you want to detach from the load balancer.</p>"
|
|
}
|
|
},
|
|
"ResourceType": {
|
|
"base": null,
|
|
"refs": {
|
|
"Disk$resourceType": "<p>The Lightsail resource type (e.g., <code>Disk</code>).</p>",
|
|
"DiskSnapshot$resourceType": "<p>The Lightsail resource type (e.g., <code>DiskSnapshot</code>).</p>",
|
|
"Domain$resourceType": "<p>The resource type. </p>",
|
|
"Instance$resourceType": "<p>The type of resource (usually <code>Instance</code>).</p>",
|
|
"InstanceSnapshot$resourceType": "<p>The type of resource (usually <code>InstanceSnapshot</code>).</p>",
|
|
"KeyPair$resourceType": "<p>The resource type (usually <code>KeyPair</code>).</p>",
|
|
"LoadBalancer$resourceType": "<p>The resource type (e.g., <code>LoadBalancer</code>.</p>",
|
|
"LoadBalancerTlsCertificate$resourceType": "<p>The resource type (e.g., <code>LoadBalancerTlsCertificate</code>.</p>",
|
|
"Operation$resourceType": "<p>The resource type. </p>",
|
|
"StaticIp$resourceType": "<p>The resource type (usually <code>StaticIp</code>).</p>"
|
|
}
|
|
},
|
|
"ServiceException": {
|
|
"base": "<p>A general service exception.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"StartInstanceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"StartInstanceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"StaticIp": {
|
|
"base": "<p>Describes the static IP.</p>",
|
|
"refs": {
|
|
"GetStaticIpResult$staticIp": "<p>An array of key-value pairs containing information about the requested static IP.</p>",
|
|
"StaticIpList$member": null
|
|
}
|
|
},
|
|
"StaticIpList": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetStaticIpsResult$staticIps": "<p>An array of key-value pairs containing information about your get static IPs request.</p>"
|
|
}
|
|
},
|
|
"StopInstanceRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"StopInstanceResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"StringList": {
|
|
"base": null,
|
|
"refs": {
|
|
"CreateInstancesFromSnapshotRequest$instanceNames": "<p>The names for your new instances.</p>",
|
|
"CreateInstancesRequest$instanceNames": "<p>The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: <code>[\"MyFirstInstance\",\"MySecondInstance\"]</code> </p>",
|
|
"GetActiveNamesResult$activeNames": "<p>The list of active names returned by the get active names request.</p>",
|
|
"LoadBalancerTlsCertificate$subjectAlternativeNames": "<p>One or more domain names (subject alternative names) 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 (CN) of the certificate and additional domain names that can be used to connect to the website.</p>"
|
|
}
|
|
},
|
|
"StringMax256": {
|
|
"base": null,
|
|
"refs": {
|
|
"UpdateLoadBalancerAttributeRequest$attributeValue": "<p>The value that you want to specify for the attribute name.</p>"
|
|
}
|
|
},
|
|
"UnauthenticatedException": {
|
|
"base": "<p>Lightsail throws this exception when the user has not been authenticated.</p>",
|
|
"refs": {
|
|
}
|
|
},
|
|
"UnpeerVpcRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"UnpeerVpcResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"UpdateDomainEntryRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"UpdateDomainEntryResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"UpdateLoadBalancerAttributeRequest": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"UpdateLoadBalancerAttributeResult": {
|
|
"base": null,
|
|
"refs": {
|
|
}
|
|
},
|
|
"boolean": {
|
|
"base": null,
|
|
"refs": {
|
|
"Blueprint$isActive": "<p>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.</p>",
|
|
"Bundle$isActive": "<p>A Boolean value indicating whether the bundle is active.</p>",
|
|
"DeleteLoadBalancerTlsCertificateRequest$force": "<p>When <code>true</code>, forces the deletion of a TLS/SSL certificate.</p>",
|
|
"Disk$isSystemDisk": "<p>A Boolean value indicating whether this disk is a system disk (has an operating system loaded on it).</p>",
|
|
"Disk$isAttached": "<p>A Boolean value indicating whether the disk is attached.</p>",
|
|
"DomainEntry$isAlias": "<p>When <code>true</code>, specifies whether the domain entry is an alias used by the Lightsail load balancer.</p>",
|
|
"GetBlueprintsRequest$includeInactive": "<p>A Boolean value indicating whether to include inactive results in your request.</p>",
|
|
"GetBundlesRequest$includeInactive": "<p>A Boolean value that indicates whether to include inactive bundle results in your request.</p>",
|
|
"GetRegionsRequest$includeAvailabilityZones": "<p>A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: e.g., <code>us-east-2a</code>.</p>",
|
|
"Instance$isStaticIp": "<p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>",
|
|
"IsVpcPeeredResult$isPeered": "<p>Returns <code>true</code> if the Lightsail VPC is peered; otherwise, <code>false</code>.</p>",
|
|
"LoadBalancerTlsCertificate$isAttached": "<p>When <code>true</code>, the TLS/SSL certificate is attached to the Lightsail load balancer.</p>",
|
|
"LoadBalancerTlsCertificateSummary$isAttached": "<p>When <code>true</code>, the TLS/SSL certificate is attached to the Lightsail load balancer.</p>",
|
|
"Operation$isTerminal": "<p>A Boolean value indicating whether the operation is terminal.</p>",
|
|
"StaticIp$isAttached": "<p>A Boolean value indicating whether the static IP is attached.</p>",
|
|
"StopInstanceRequest$force": "<p>When set to <code>True</code>, forces a Lightsail instance that is stuck in a <code>stopping</code> state to stop.</p> <important> <p>Only use the <code>force</code> parameter if your instance is stuck in the <code>stopping</code> state. In any other state, your instance should stop normally without adding this parameter to your API request.</p> </important>"
|
|
}
|
|
},
|
|
"double": {
|
|
"base": null,
|
|
"refs": {
|
|
"MetricDatapoint$average": "<p>The average.</p>",
|
|
"MetricDatapoint$maximum": "<p>The maximum.</p>",
|
|
"MetricDatapoint$minimum": "<p>The minimum.</p>",
|
|
"MetricDatapoint$sampleCount": "<p>The sample count.</p>",
|
|
"MetricDatapoint$sum": "<p>The sum.</p>"
|
|
}
|
|
},
|
|
"float": {
|
|
"base": null,
|
|
"refs": {
|
|
"Bundle$price": "<p>The price in US dollars (e.g., <code>5.0</code>).</p>",
|
|
"Bundle$ramSizeInGb": "<p>The amount of RAM in GB (e.g., <code>2.0</code>).</p>",
|
|
"InstanceHardware$ramSizeInGb": "<p>The amount of RAM in GB on the instance (e.g., <code>1.0</code>).</p>"
|
|
}
|
|
},
|
|
"integer": {
|
|
"base": null,
|
|
"refs": {
|
|
"Blueprint$minPower": "<p>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. <code>0</code> indicates that the blueprint runs on all instance sizes. </p>",
|
|
"Bundle$cpuCount": "<p>The number of vCPUs included in the bundle (e.g., <code>2</code>).</p>",
|
|
"Bundle$diskSizeInGb": "<p>The size of the SSD (e.g., <code>30</code>).</p>",
|
|
"Bundle$power": "<p>A numeric value that represents the power of the bundle (e.g., <code>500</code>). 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.</p>",
|
|
"Bundle$transferPerMonthInGb": "<p>The data transfer rate per month in GB (e.g., <code>2000</code>).</p>",
|
|
"CreateDiskFromSnapshotRequest$sizeInGb": "<p>The size of the disk in GB (e.g., <code>32</code>).</p>",
|
|
"CreateDiskRequest$sizeInGb": "<p>The size of the disk in GB (e.g., <code>32</code>).</p>",
|
|
"Disk$sizeInGb": "<p>The size of the disk in GB.</p>",
|
|
"Disk$iops": "<p>The input/output operations per second (IOPS) of the disk.</p>",
|
|
"Disk$gbInUse": "<p>(Deprecated) The number of GB in use by the disk.</p> <note> <p>In releases prior to November 14, 2017, this parameter was not included in the API response. It is now deprecated.</p> </note>",
|
|
"DiskSnapshot$sizeInGb": "<p>The size of the disk in GB.</p>",
|
|
"InstanceHardware$cpuCount": "<p>The number of vCPUs the instance has.</p>",
|
|
"InstanceSnapshot$sizeInGb": "<p>The size in GB of the SSD.</p>",
|
|
"InstanceState$code": "<p>The status code for the instance.</p>",
|
|
"LoadBalancer$instancePort": "<p>The instance port where the load balancer is listening.</p>",
|
|
"MonthlyTransfer$gbPerMonthAllocated": "<p>The amount allocated per month (in GB).</p>"
|
|
}
|
|
},
|
|
"string": {
|
|
"base": null,
|
|
"refs": {
|
|
"AccessDeniedException$code": null,
|
|
"AccessDeniedException$docs": null,
|
|
"AccessDeniedException$message": null,
|
|
"AccessDeniedException$tip": null,
|
|
"AccountSetupInProgressException$code": null,
|
|
"AccountSetupInProgressException$docs": null,
|
|
"AccountSetupInProgressException$message": null,
|
|
"AccountSetupInProgressException$tip": null,
|
|
"Blueprint$description": "<p>The description of the blueprint.</p>",
|
|
"Blueprint$version": "<p>The version number of the operating system, application, or stack (e.g., <code>2016.03.0</code>).</p>",
|
|
"Blueprint$versionCode": "<p>The version code.</p>",
|
|
"Blueprint$productUrl": "<p>The product URL to learn more about the image or blueprint.</p>",
|
|
"Blueprint$licenseUrl": "<p>The end-user license agreement URL for the image or blueprint.</p>",
|
|
"Bundle$instanceType": "<p>The Amazon EC2 instance type (e.g., <code>t2.micro</code>).</p>",
|
|
"Bundle$name": "<p>A friendly name for the bundle (e.g., <code>Micro</code>).</p>",
|
|
"CreateInstancesFromSnapshotRequest$availabilityZone": "<p>The Availability Zone where you want to create your instances. Use the following formatting: <code>us-east-2a</code> (case sensitive). You can get a list of availability zones by using the <a href=\"http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html\">get regions</a> operation. Be sure to add the <code>include availability zones</code> parameter to your request.</p>",
|
|
"CreateInstancesFromSnapshotRequest$userData": "<p>You can create a launch script that configures a server with additional user data. For example, <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"http://lightsail.aws.amazon.com/ls/docs/getting-started/articles/pre-installed-apps\">Dev Guide</a>.</p> </note>",
|
|
"CreateInstancesRequest$availabilityZone": "<p>The Availability Zone in which to create your instance. Use the following format: <code>us-east-2a</code> (case sensitive). You can get a list of availability zones by using the <a href=\"http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html\">get regions</a> operation. Be sure to add the <code>include availability zones</code> parameter to your request.</p>",
|
|
"CreateInstancesRequest$userData": "<p>A launch script you can create that configures a server with additional user data. For example, you might want to run <code>apt-get -y update</code>.</p> <note> <p>Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use <code>yum</code>, Debian and Ubuntu use <code>apt-get</code>, and FreeBSD uses <code>pkg</code>. For a complete list, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/getting-started/article/compare-options-choose-lightsail-instance-image\">Dev Guide</a>.</p> </note>",
|
|
"CreateLoadBalancerRequest$healthCheckPath": "<p>The path you provided to perform the load balancer health check. If you didn't specify a health check path, Lightsail uses the root path of your website (e.g., <code>\"/\"</code>).</p>",
|
|
"Disk$supportCode": "<p>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.</p>",
|
|
"Disk$path": "<p>The disk path.</p>",
|
|
"Disk$attachmentState": "<p>(Deprecated) The attachment state of the disk.</p> <note> <p>In releases prior to November 14, 2017, this parameter returned <code>attached</code> for system disks in the API response. It is now deprecated, but still included in the response. Use <code>isAttached</code> instead.</p> </note>",
|
|
"DiskSnapshot$supportCode": "<p>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.</p>",
|
|
"DiskSnapshot$progress": "<p>The progress of the disk snapshot operation.</p>",
|
|
"Domain$supportCode": "<p>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.</p>",
|
|
"DomainEntry$target": "<p>The target AWS name server (e.g., <code>ns-111.awsdns-22.com.</code>).</p>",
|
|
"DomainEntryOptions$value": null,
|
|
"GetActiveNamesRequest$pageToken": "<p>A token used for paginating results from your get active names request.</p>",
|
|
"GetActiveNamesResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get active names request.</p>",
|
|
"GetBlueprintsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get blueprints request.</p>",
|
|
"GetBlueprintsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get blueprints request.</p>",
|
|
"GetBundlesRequest$pageToken": "<p>A token used for advancing to the next page of results from your get bundles request.</p>",
|
|
"GetBundlesResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get active names request.</p>",
|
|
"GetDiskSnapshotsRequest$pageToken": "<p>A token used for advancing to the next page of results from your GetDiskSnapshots request.</p>",
|
|
"GetDiskSnapshotsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your GetDiskSnapshots request.</p>",
|
|
"GetDisksRequest$pageToken": "<p>A token used for advancing to the next page of results from your GetDisks request.</p>",
|
|
"GetDisksResult$nextPageToken": "<p>A token used for advancing to the next page of results from your GetDisks request.</p>",
|
|
"GetDomainsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get domains request.</p>",
|
|
"GetDomainsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get active names request.</p>",
|
|
"GetInstanceSnapshotsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get instance snapshots request.</p>",
|
|
"GetInstanceSnapshotsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get instance snapshots request.</p>",
|
|
"GetInstancesRequest$pageToken": "<p>A token used for advancing to the next page of results from your get instances request.</p>",
|
|
"GetInstancesResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get instances request.</p>",
|
|
"GetKeyPairsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get key pairs request.</p>",
|
|
"GetKeyPairsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get key pairs request.</p>",
|
|
"GetLoadBalancersRequest$pageToken": "<p>A token used for paginating the results from your GetLoadBalancers request.</p>",
|
|
"GetLoadBalancersResult$nextPageToken": "<p>A token used for advancing to the next page of results from your GetLoadBalancers request.</p>",
|
|
"GetOperationsForResourceRequest$pageToken": "<p>A token used for advancing to the next page of results from your get operations for resource request.</p>",
|
|
"GetOperationsForResourceResult$nextPageCount": "<p>(Deprecated) Returns the number of pages of results that remain.</p> <note> <p>In releases prior to June 12, 2017, this parameter returned <code>null</code> by the API. It is now deprecated, and the API returns the <code>nextPageToken</code> parameter instead.</p> </note>",
|
|
"GetOperationsForResourceResult$nextPageToken": "<p>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.</p>",
|
|
"GetOperationsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get operations request.</p>",
|
|
"GetOperationsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get operations request.</p>",
|
|
"GetStaticIpsRequest$pageToken": "<p>A token used for advancing to the next page of results from your get static IPs request.</p>",
|
|
"GetStaticIpsResult$nextPageToken": "<p>A token used for advancing to the next page of results from your get static IPs request.</p>",
|
|
"Instance$supportCode": "<p>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.</p>",
|
|
"InstanceAccessDetails$certKey": "<p>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 <code>tempkey-cert.pub</code>.</p>",
|
|
"InstanceAccessDetails$password": "<p>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.</p> <note> <p>If you create an instance using any key pair other than the default (<code>LightsailDefaultKeyPair</code>), <code>password</code> will always be an empty string.</p> <p>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.</p> </note>",
|
|
"InstanceAccessDetails$privateKey": "<p>For SSH access, the temporary private key. For OpenSSH clients (e.g., command line SSH), you should save this value to <code>tempkey</code>).</p>",
|
|
"InstanceAccessDetails$username": "<p>The user name to use when logging in to the Amazon Lightsail instance.</p>",
|
|
"InstancePortInfo$accessFrom": "<p>The location from which access is allowed (e.g., <code>Anywhere (0.0.0.0/0)</code>).</p>",
|
|
"InstancePortInfo$commonName": "<p>The common name.</p>",
|
|
"InstanceSnapshot$supportCode": "<p>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.</p>",
|
|
"InstanceSnapshot$progress": "<p>The progress of the snapshot.</p>",
|
|
"InstanceSnapshot$fromBlueprintId": "<p>The blueprint ID from which you created the snapshot (e.g., <code>os_debian_8_3</code>). A blueprint is a virtual private server (or <i>instance</i>) image used to create instances quickly.</p>",
|
|
"InstanceSnapshot$fromBundleId": "<p>The bundle ID from which you created the snapshot (e.g., <code>micro_1_0</code>).</p>",
|
|
"InstanceState$name": "<p>The state of the instance (e.g., <code>running</code> or <code>pending</code>).</p>",
|
|
"InvalidInputException$code": null,
|
|
"InvalidInputException$docs": null,
|
|
"InvalidInputException$message": null,
|
|
"InvalidInputException$tip": null,
|
|
"KeyPair$supportCode": "<p>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.</p>",
|
|
"LoadBalancer$supportCode": "<p>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.</p>",
|
|
"LoadBalancerConfigurationOptions$value": null,
|
|
"LoadBalancerTlsCertificate$supportCode": "<p>The support code. Include this code in your email to support when you have questions about your Lightsail load balancer or TLS/SSL certificate. This code enables our support team to look up your Lightsail information more easily.</p>",
|
|
"NotFoundException$code": null,
|
|
"NotFoundException$docs": null,
|
|
"NotFoundException$message": null,
|
|
"NotFoundException$tip": null,
|
|
"Operation$operationDetails": "<p>Details about the operation (e.g., <code>Debian-1GB-Ohio-1</code>).</p>",
|
|
"Operation$errorCode": "<p>The error code.</p>",
|
|
"Operation$errorDetails": "<p>The error details.</p>",
|
|
"OperationFailureException$code": null,
|
|
"OperationFailureException$docs": null,
|
|
"OperationFailureException$message": null,
|
|
"OperationFailureException$tip": null,
|
|
"PasswordData$ciphertext": "<p>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.</p> <note> <p>If you use the default key pair (<code>LightsailDefaultKeyPair</code>), the decrypted password will be available in the password field.</p> <p>If you are using a custom key pair, you need to use your own means of decryption.</p> <p>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.</p> </note>",
|
|
"Region$continentCode": "<p>The continent code (e.g., <code>NA</code>, meaning North America).</p>",
|
|
"Region$description": "<p>The description of the AWS Region (e.g., <code>This region is recommended to serve users in the eastern United States and eastern Canada</code>).</p>",
|
|
"Region$displayName": "<p>The display name (e.g., <code>Ohio</code>).</p>",
|
|
"ResourceLocation$availabilityZone": "<p>The Availability Zone. Follows the format <code>us-east-2a</code> (case-sensitive).</p>",
|
|
"ServiceException$code": null,
|
|
"ServiceException$docs": null,
|
|
"ServiceException$message": null,
|
|
"ServiceException$tip": null,
|
|
"StaticIp$supportCode": "<p>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.</p>",
|
|
"StringList$member": null,
|
|
"UnauthenticatedException$code": null,
|
|
"UnauthenticatedException$docs": null,
|
|
"UnauthenticatedException$message": null,
|
|
"UnauthenticatedException$tip": null
|
|
}
|
|
},
|
|
"timestamp": {
|
|
"base": null,
|
|
"refs": {
|
|
"GetInstanceMetricDataRequest$startTime": "<p>The start time of the time period.</p>",
|
|
"GetInstanceMetricDataRequest$endTime": "<p>The end time of the time period.</p>",
|
|
"GetLoadBalancerMetricDataRequest$startTime": "<p>The start time of the period.</p>",
|
|
"GetLoadBalancerMetricDataRequest$endTime": "<p>The end time of the period.</p>",
|
|
"MetricDatapoint$timestamp": "<p>The timestamp (e.g., <code>1479816991.349</code>).</p>"
|
|
}
|
|
}
|
|
}
|
|
}
|