"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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":{
"name":"CreateDiskSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDiskSnapshotRequest"},
"output":{"shape":"CreateDiskSnapshotResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<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":{
"name":"CreateInstances",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateInstancesRequest"},
"output":{"shape":"CreateInstancesResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates one or more Amazon Lightsail virtual private servers, or <i>instances</i>.</p>"
"documentation":"<p>Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.</p>"
"documentation":"<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>"
"documentation":"<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":{
"name":"DeleteDisk",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDiskRequest"},
"output":{"shape":"DeleteDiskResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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":{
"name":"DeleteDiskSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDiskSnapshotRequest"},
"output":{"shape":"DeleteDiskSnapshotResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<p>Deletes a TLS/SSL certificate associated with a Lightsail load balancer.</p>"
},
"DetachDisk":{
"name":"DetachDisk",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DetachDiskRequest"},
"output":{"shape":"DetachDiskResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<p>Downloads the default SSH key pair from the user's account.</p>"
},
"GetActiveNames":{
"name":"GetActiveNames",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetActiveNamesRequest"},
"output":{"shape":"GetActiveNamesResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns the names of all active (not deleted) resources.</p>"
},
"GetBlueprints":{
"name":"GetBlueprints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetBlueprintsRequest"},
"output":{"shape":"GetBlueprintsResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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":{
"name":"GetBundles",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetBundlesRequest"},
"output":{"shape":"GetBundlesResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<p>Returns information about a specific block storage disk.</p>"
},
"GetDiskSnapshot":{
"name":"GetDiskSnapshot",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDiskSnapshotRequest"},
"output":{"shape":"GetDiskSnapshotResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Returns information about a specific block storage disk snapshot.</p>"
},
"GetDiskSnapshots":{
"name":"GetDiskSnapshots",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDiskSnapshotsRequest"},
"output":{"shape":"GetDiskSnapshotsResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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":{
"name":"GetDisks",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDisksRequest"},
"output":{"shape":"GetDisksResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<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":{
"name":"GetLoadBalancers",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetLoadBalancersRequest"},
"output":{"shape":"GetLoadBalancersResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<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":{
"name":"GetOperations",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetOperationsRequest"},
"output":{"shape":"GetOperationsResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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":{
"name":"ReleaseStaticIp",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ReleaseStaticIpRequest"},
"output":{"shape":"ReleaseStaticIpResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Deletes a specific static IP from your account.</p>"
},
"StartInstance":{
"name":"StartInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartInstanceRequest"},
"output":{"shape":"StartInstanceResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.</p>"
},
"StopInstance":{
"name":"StopInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopInstanceRequest"},
"output":{"shape":"StopInstanceResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Stops a specific Amazon Lightsail instance that is currently running.</p>"
},
"UnpeerVpc":{
"name":"UnpeerVpc",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UnpeerVpcRequest"},
"output":{"shape":"UnpeerVpcResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Attempts to unpeer the Lightsail VPC from the user's default VPC.</p>"
},
"UpdateDomainEntry":{
"name":"UpdateDomainEntry",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateDomainEntryRequest"},
"output":{"shape":"UpdateDomainEntryResult"},
"errors":[
{"shape":"ServiceException"},
{"shape":"InvalidInputException"},
{"shape":"NotFoundException"},
{"shape":"OperationFailureException"},
{"shape":"AccessDeniedException"},
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Updates a domain recordset after it is created.</p>"
"documentation":"<p>The state of the Availability Zone.</p>"
}
},
"documentation":"<p>Describes an Availability Zone.</p>"
},
"AvailabilityZoneList":{
"type":"list",
"member":{"shape":"AvailabilityZone"}
},
"Base64":{"type":"string"},
"Blueprint":{
"type":"structure",
"members":{
"blueprintId":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"name":{
"shape":"ResourceName",
"documentation":"<p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>"
},
"group":{
"shape":"NonEmptyString",
"documentation":"<p>The group name of the blueprint (e.g., <code>amazon-linux</code>).</p>"
},
"type":{
"shape":"BlueprintType",
"documentation":"<p>The type of the blueprint (e.g., <code>os</code> or <code>app</code>).</p>"
},
"description":{
"shape":"string",
"documentation":"<p>The description of the blueprint.</p>"
},
"isActive":{
"shape":"boolean",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>"
},
"diskSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-snapshot</code>) from which to create the new storage disk.</p>"
},
"availabilityZone":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size of the disk in GB (e.g., <code>32</code>).</p>"
}
}
},
"CreateDiskFromSnapshotResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An object describing the API operations.</p>"
}
}
},
"CreateDiskRequest":{
"type":"structure",
"required":[
"diskName",
"availabilityZone",
"sizeInGb"
],
"members":{
"diskName":{
"shape":"ResourceName",
"documentation":"<p>The unique Lightsail disk name (e.g., <code>my-disk</code>).</p>"
},
"availabilityZone":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size of the disk in GB (e.g., <code>32</code>).</p>"
}
}
},
"CreateDiskResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An object describing the API operations.</p>"
}
}
},
"CreateDiskSnapshotRequest":{
"type":"structure",
"required":[
"diskName",
"diskSnapshotName"
],
"members":{
"diskName":{
"shape":"ResourceName",
"documentation":"<p>The unique name of the source disk (e.g., <code>my-source-disk</code>).</p>"
},
"diskSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name of the destination disk snapshot (e.g., <code>my-disk-snapshot</code>) based on the source disk.</p>"
}
}
},
"CreateDiskSnapshotResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An object describing the API operations.</p>"
"documentation":"<p>The domain name (e.g., <code>example.com</code>) for which you want to create the domain entry.</p>"
},
"domainEntry":{
"shape":"DomainEntry",
"documentation":"<p>An array of key-value pairs containing information about the domain entry request.</p>"
}
}
},
"CreateDomainEntryResult":{
"type":"structure",
"members":{
"operation":{
"shape":"Operation",
"documentation":"<p>An array of key-value pairs containing information about the operation.</p>"
}
}
},
"CreateDomainRequest":{
"type":"structure",
"required":["domainName"],
"members":{
"domainName":{
"shape":"DomainName",
"documentation":"<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>"
}
}
},
"CreateDomainResult":{
"type":"structure",
"members":{
"operation":{
"shape":"Operation",
"documentation":"<p>An array of key-value pairs containing information about the domain resource you created.</p>"
}
}
},
"CreateInstanceSnapshotRequest":{
"type":"structure",
"required":[
"instanceSnapshotName",
"instanceName"
],
"members":{
"instanceSnapshotName":{
"shape":"ResourceName",
"documentation":"<p>The name for your new snapshot.</p>"
},
"instanceName":{
"shape":"ResourceName",
"documentation":"<p>The Lightsail instance on which to base your snapshot.</p>"
}
}
},
"CreateInstanceSnapshotResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of key-value pairs containing information about the results of your create instances snapshot request.</p>"
}
}
},
"CreateInstancesFromSnapshotRequest":{
"type":"structure",
"required":[
"instanceNames",
"availabilityZone",
"instanceSnapshotName",
"bundleId"
],
"members":{
"instanceNames":{
"shape":"StringList",
"documentation":"<p>The names for your new instances.</p>"
"documentation":"<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>"
"documentation":"<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>"
},
"bundleId":{
"shape":"NonEmptyString",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The name for your key pair.</p>"
}
}
},
"CreateInstancesFromSnapshotResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of key-value pairs containing information about the results of your create instances from snapshot request.</p>"
}
}
},
"CreateInstancesRequest":{
"type":"structure",
"required":[
"instanceNames",
"availabilityZone",
"blueprintId",
"bundleId"
],
"members":{
"instanceNames":{
"shape":"StringList",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>",
"documentation":"<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>"
},
"bundleId":{
"shape":"NonEmptyString",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The name of your load balancer.</p>"
},
"instancePort":{
"shape":"Port",
"documentation":"<p>The instance port where you're creating your load balancer.</p>"
},
"healthCheckPath":{
"shape":"string",
"documentation":"<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>"
},
"certificateName":{
"shape":"ResourceName",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<p>The Amazon Resource Name (ARN) of the disk.</p>"
},
"supportCode":{
"shape":"string",
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The date when the disk was created.</p>"
"documentation":"<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>",
"deprecated":true
},
"gbInUse":{
"shape":"integer",
"documentation":"<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>",
"documentation":"<p>The original disk path exposed to the instance (for example, <code>/dev/sdh</code>).</p>"
},
"newDiskName":{
"shape":"ResourceName",
"documentation":"<p>The new disk name (e.g., <code>my-new-disk</code>).</p>"
}
},
"documentation":"<p>Describes a block storage disk mapping.</p>"
},
"DiskMapList":{
"type":"list",
"member":{"shape":"DiskMap"}
},
"DiskSnapshot":{
"type":"structure",
"members":{
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the disk snapshot (e.g., <code>my-disk-snapshot</code>).</p>"
},
"arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the disk snapshot.</p>"
},
"supportCode":{
"shape":"string",
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The date when the disk snapshot was created.</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The AWS Region and Availability Zone where the disk snapshot was created.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The Lightsail resource type (e.g., <code>DiskSnapshot</code>).</p>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size of the disk in GB.</p>"
},
"state":{
"shape":"DiskSnapshotState",
"documentation":"<p>The status of the disk snapshot operation.</p>"
},
"progress":{
"shape":"string",
"documentation":"<p>The progress of the disk snapshot operation.</p>"
},
"fromDiskName":{
"shape":"ResourceName",
"documentation":"<p>The unique name of the source disk from which you are creating the disk snapshot.</p>"
},
"fromDiskArn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the source disk from which you are creating the disk snapshot.</p>"
}
},
"documentation":"<p>Describes a block storage disk snapshot.</p>"
"documentation":"<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>"
},
"supportCode":{
"shape":"string",
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The date when the domain recordset was created.</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The AWS Region and Availability Zones where the domain recordset was created.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type. </p>"
},
"domainEntries":{
"shape":"DomainEntryList",
"documentation":"<p>An array of key-value pairs containing information about the domain entries.</p>"
}
},
"documentation":"<p>Describes a domain where you are storing recordsets in Lightsail.</p>"
},
"DomainEntry":{
"type":"structure",
"members":{
"id":{
"shape":"NonEmptyString",
"documentation":"<p>The ID of the domain recordset entry.</p>"
},
"name":{
"shape":"DomainName",
"documentation":"<p>The name of the domain.</p>"
},
"target":{
"shape":"string",
"documentation":"<p>The target AWS name server (e.g., <code>ns-111.awsdns-22.com.</code>).</p>"
"documentation":"<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>",
"documentation":"<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>",
"deprecated":true
},
"nextPageToken":{
"shape":"string",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the instance was created (e.g., <code>1479734909.17</code>).</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The region name and availability zone where the instance is located.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource (usually <code>Instance</code>).</p>"
},
"blueprintId":{
"shape":"NonEmptyString",
"documentation":"<p>The blueprint ID (e.g., <code>os_amlinux_2016_03</code>).</p>"
},
"blueprintName":{
"shape":"NonEmptyString",
"documentation":"<p>The friendly name of the blueprint (e.g., <code>Amazon Linux</code>).</p>"
},
"bundleId":{
"shape":"NonEmptyString",
"documentation":"<p>The bundle for the instance (e.g., <code>micro_1_0</code>).</p>"
},
"isStaticIp":{
"shape":"boolean",
"documentation":"<p>A Boolean value indicating whether this instance has a static IP assigned to it.</p>"
},
"privateIpAddress":{
"shape":"IpAddress",
"documentation":"<p>The private IP address of the instance.</p>"
},
"publicIpAddress":{
"shape":"IpAddress",
"documentation":"<p>The public IP address of the instance.</p>"
},
"ipv6Address":{
"shape":"IpV6Address",
"documentation":"<p>The IPv6 address of the instance.</p>"
},
"hardware":{
"shape":"InstanceHardware",
"documentation":"<p>The size of the vCPU and the amount of RAM for the instance.</p>"
},
"networking":{
"shape":"InstanceNetworking",
"documentation":"<p>Information about the public ports and monthly data transfer rates for the instance.</p>"
},
"state":{
"shape":"InstanceState",
"documentation":"<p>The status code and the state (e.g., <code>running</code>) for the instance.</p>"
},
"username":{
"shape":"NonEmptyString",
"documentation":"<p>The user name for connecting to the instance (e.g., <code>ec2-user</code>).</p>"
},
"sshKeyName":{
"shape":"ResourceName",
"documentation":"<p>The name of the SSH key being used to connect to the instance (e.g., <code>LightsailDefaultKeyPair</code>).</p>"
}
},
"documentation":"<p>Describes an instance (a virtual private server).</p>"
},
"InstanceAccessDetails":{
"type":"structure",
"members":{
"certKey":{
"shape":"string",
"documentation":"<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>"
},
"expiresAt":{
"shape":"IsoDate",
"documentation":"<p>For SSH access, the date on which the temporary keys expire.</p>"
},
"ipAddress":{
"shape":"IpAddress",
"documentation":"<p>The public IP address of the Amazon Lightsail instance.</p>"
"documentation":"<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>"
},
"passwordData":{
"shape":"PasswordData",
"documentation":"<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>"
"documentation":"<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>"
},
"protocol":{
"shape":"InstanceAccessProtocol",
"documentation":"<p>The protocol for these Amazon Lightsail instance access details.</p>"
},
"instanceName":{
"shape":"ResourceName",
"documentation":"<p>The name of this Amazon Lightsail instance.</p>"
},
"username":{
"shape":"string",
"documentation":"<p>The user name to use when logging in to the Amazon Lightsail instance.</p>"
}
},
"documentation":"<p>The parameters for gaining temporary access to one of your Amazon Lightsail instances.</p>"
},
"InstanceAccessProtocol":{
"type":"string",
"enum":[
"ssh",
"rdp"
]
},
"InstanceHardware":{
"type":"structure",
"members":{
"cpuCount":{
"shape":"integer",
"documentation":"<p>The number of vCPUs the instance has.</p>"
},
"disks":{
"shape":"DiskList",
"documentation":"<p>The disks attached to the instance.</p>"
},
"ramSizeInGb":{
"shape":"float",
"documentation":"<p>The amount of RAM in GB on the instance (e.g., <code>1.0</code>).</p>"
}
},
"documentation":"<p>Describes the hardware for the instance.</p>"
"documentation":"<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>"
"documentation":"<p>The first port in the range.</p>"
},
"toPort":{
"shape":"Port",
"documentation":"<p>The last port in the range.</p>"
},
"protocol":{
"shape":"NetworkProtocol",
"documentation":"<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>"
},
"state":{
"shape":"PortState",
"documentation":"<p>Specifies whether the instance port is <code>open</code> or <code>closed</code>.</p>"
}
},
"documentation":"<p>Describes the port state.</p>"
"documentation":"<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>"
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the snapshot was created (e.g., <code>1479907467.024</code>).</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The region name and availability zone where you created the snapshot.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of resource (usually <code>InstanceSnapshot</code>).</p>"
},
"state":{
"shape":"InstanceSnapshotState",
"documentation":"<p>The state the snapshot is in.</p>"
},
"progress":{
"shape":"string",
"documentation":"<p>The progress of the snapshot.</p>"
"documentation":"<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>"
"documentation":"<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>"
},
"fromBundleId":{
"shape":"string",
"documentation":"<p>The bundle ID from which you created the snapshot (e.g., <code>micro_1_0</code>).</p>"
},
"sizeInGb":{
"shape":"integer",
"documentation":"<p>The size in GB of the SSD.</p>"
}
},
"documentation":"<p>Describes the snapshot of the virtual private server, or <i>instance</i>.</p>"
},
"InstanceSnapshotList":{
"type":"list",
"member":{"shape":"InstanceSnapshot"}
},
"InstanceSnapshotState":{
"type":"string",
"enum":[
"pending",
"error",
"available"
]
},
"InstanceState":{
"type":"structure",
"members":{
"code":{
"shape":"integer",
"documentation":"<p>The status code for the instance.</p>"
},
"name":{
"shape":"string",
"documentation":"<p>The state of the instance (e.g., <code>running</code> or <code>pending</code>).</p>"
}
},
"documentation":"<p>Describes the virtual private server (or <i>instance</i>) status.</p>"
"documentation":"<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>",
"documentation":"<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>"
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the key pair was created (e.g., <code>1479816991.349</code>).</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The region name and Availability Zone where the key pair was created.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type (usually <code>KeyPair</code>).</p>"
},
"fingerprint":{
"shape":"Base64",
"documentation":"<p>The RSA fingerprint of the key pair.</p>"
}
},
"documentation":"<p>Describes the SSH key pair.</p>"
"documentation":"<p>The name of the load balancer (e.g., <code>my-load-balancer</code>).</p>"
},
"arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the load balancer.</p>"
},
"supportCode":{
"shape":"string",
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The date when your load balancer was created.</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The AWS Region and Availability Zone where your load balancer was created (e.g., <code>us-east-2a</code>).</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type (e.g., <code>LoadBalancer</code>.</p>"
},
"dnsName":{
"shape":"NonEmptyString",
"documentation":"<p>The DNS name of your Lightsail load balancer.</p>"
},
"state":{
"shape":"LoadBalancerState",
"documentation":"<p>The status of your load balancer. Valid values are below.</p>"
},
"protocol":{
"shape":"LoadBalancerProtocol",
"documentation":"<p>The protocol you have enabled for your load balancer. Valid values are below.</p>"
},
"publicPorts":{
"shape":"PortList",
"documentation":"<p>An array of public port settings for your load balancer.</p>"
},
"healthCheckPath":{
"shape":"NonEmptyString",
"documentation":"<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>"
},
"instancePort":{
"shape":"integer",
"documentation":"<p>The instance port where the load balancer is listening.</p>"
},
"instanceHealthSummary":{
"shape":"InstanceHealthSummaryList",
"documentation":"<p>An array of InstanceHealthSummary objects describing the health of the load balancer.</p>"
},
"tlsCertificateSummaries":{
"shape":"LoadBalancerTlsCertificateSummaryList",
"documentation":"<p>An array of LoadBalancerTlsCertificateSummary objects that provide additional information about the TLS/SSL certificates.</p>"
},
"configurationOptions":{
"shape":"LoadBalancerConfigurationOptions",
"documentation":"<p>A string to string map of the configuration options for your load balancer. Valid values are listed below.</p>"
}
},
"documentation":"<p>Describes the Lightsail load balancer.</p>"
},
"LoadBalancerAttributeName":{
"type":"string",
"enum":[
"HealthCheckPath",
"SessionStickinessEnabled",
"SessionStickiness_LB_CookieDurationSeconds"
]
},
"LoadBalancerConfigurationOptions":{
"type":"map",
"key":{"shape":"LoadBalancerAttributeName"},
"value":{"shape":"string"}
},
"LoadBalancerList":{
"type":"list",
"member":{"shape":"LoadBalancer"}
},
"LoadBalancerMetricName":{
"type":"string",
"enum":[
"ClientTLSNegotiationErrorCount",
"HealthyHostCount",
"UnhealthyHostCount",
"HTTPCode_LB_4XX_Count",
"HTTPCode_LB_5XX_Count",
"HTTPCode_Instance_2XX_Count",
"HTTPCode_Instance_3XX_Count",
"HTTPCode_Instance_4XX_Count",
"HTTPCode_Instance_5XX_Count",
"InstanceResponseTime",
"RejectedConnectionCount",
"RequestCount"
]
},
"LoadBalancerProtocol":{
"type":"string",
"enum":[
"HTTP_HTTPS",
"HTTP"
]
},
"LoadBalancerState":{
"type":"string",
"enum":[
"active",
"provisioning",
"active_impaired",
"failed",
"unknown"
]
},
"LoadBalancerTlsCertificate":{
"type":"structure",
"members":{
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the TLS/SSL certificate (e.g., <code>my-certificate</code>).</p>"
},
"arn":{
"shape":"NonEmptyString",
"documentation":"<p>The Amazon Resource Name (ARN) of the TLS/SSL certificate.</p>"
},
"supportCode":{
"shape":"string",
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The time when you created your TLS/SSL certificate.</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The AWS Region and Availability Zone where you created your certificate.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type (e.g., <code>LoadBalancerTlsCertificate</code>.</p>"
},
"loadBalancerName":{
"shape":"ResourceName",
"documentation":"<p>The load balancer name where your TLS/SSL certificate is attached.</p>"
},
"isAttached":{
"shape":"boolean",
"documentation":"<p>When <code>true</code>, the TLS/SSL certificate is attached to the Lightsail load balancer.</p>"
},
"status":{
"shape":"LoadBalancerTlsCertificateStatus",
"documentation":"<p>The status of the TLS/SSL certificate. Valid values are below.</p>"
},
"domainName":{
"shape":"DomainName",
"documentation":"<p>The domain name for your TLS/SSL certificate.</p>"
"documentation":"<p>The reason the certificate was revoked. Valid values are below.</p>"
},
"revokedAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the TLS/SSL certificate was revoked.</p>"
},
"serial":{
"shape":"NonEmptyString",
"documentation":"<p>The serial number of the certificate.</p>"
},
"signatureAlgorithm":{
"shape":"NonEmptyString",
"documentation":"<p>The algorithm that was used to sign the certificate.</p>"
},
"subject":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the entity that is associated with the public key contained in the certificate.</p>"
},
"subjectAlternativeNames":{
"shape":"StringList",
"documentation":"<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>"
}
},
"documentation":"<p>Describes a load balancer TLS/SSL certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p>"
"documentation":"<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>"
}
},
"documentation":"<p>Contains information about the status of Lightsail's managed renewal for the certificate.</p>"
},
"LoadBalancerTlsCertificateRevocationReason":{
"type":"string",
"enum":[
"UNSPECIFIED",
"KEY_COMPROMISE",
"CA_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERCEDED",
"CESSATION_OF_OPERATION",
"CERTIFICATE_HOLD",
"REMOVE_FROM_CRL",
"PRIVILEGE_WITHDRAWN",
"A_A_COMPROMISE"
]
},
"LoadBalancerTlsCertificateStatus":{
"type":"string",
"enum":[
"PENDING_VALIDATION",
"ISSUED",
"INACTIVE",
"EXPIRED",
"VALIDATION_TIMED_OUT",
"REVOKED",
"FAILED",
"UNKNOWN"
]
},
"LoadBalancerTlsCertificateSummary":{
"type":"structure",
"members":{
"name":{
"shape":"ResourceName",
"documentation":"<p>The name of the TLS/SSL certificate.</p>"
},
"isAttached":{
"shape":"boolean",
"documentation":"<p>When <code>true</code>, the TLS/SSL certificate is attached to the Lightsail load balancer.</p>"
}
},
"documentation":"<p>Provides a summary of TLS/SSL certificate metadata.</p>"
"documentation":"<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>"
},
"keyPairName":{
"shape":"ResourceName",
"documentation":"<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>"
}
},
"documentation":"<p>The password data for the Windows Server-based instance, including the ciphertext and the key pair name.</p>"
"documentation":"<p>The name of the instance to reboot.</p>"
}
}
},
"RebootInstanceResult":{
"type":"structure",
"members":{
"operations":{
"shape":"OperationList",
"documentation":"<p>An array of key-value pairs containing information about the request operation.</p>"
}
}
},
"Region":{
"type":"structure",
"members":{
"continentCode":{
"shape":"string",
"documentation":"<p>The continent code (e.g., <code>NA</code>, meaning North America).</p>"
},
"description":{
"shape":"string",
"documentation":"<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>"
"documentation":"<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>"
"documentation":"<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>"
},
"createdAt":{
"shape":"IsoDate",
"documentation":"<p>The timestamp when the static IP was created (e.g., <code>1479735304.222</code>).</p>"
},
"location":{
"shape":"ResourceLocation",
"documentation":"<p>The region and Availability Zone where the static IP was created.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type (usually <code>StaticIp</code>).</p>"
"documentation":"<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>"
"documentation":"<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>"