Amazon Lightsail - REST API Reference

1 Amazon LightsailAPI ReferenceAPI Version 2016-11-28 Amazon Lightsail API ReferenceAmazon Lightsail : API ReferenceCopyright 2019 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon 's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon . All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Lightsail API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 AllocateStaticIp.. 5 Request Syntax .. 5 Request Parameters .. 5 Response Syntax .. 5 Response Elements.

2 5 Errors .. 6 See Also.. 6 AttachDisk .. 8 Request Syntax .. 8 Request Parameters .. 8 Response Syntax .. 8 Response Elements .. 9 Errors .. 9 See Also.. 10 AttachInstancesToLoadBalancer .. 11 Request Syntax .. 11 Request Parameters .. 11 Response Syntax .. 11 Response Elements .. 12 Errors .. 12 See Also.. 13 AttachLoadBalancerTlsCertificate .. 14 Request Syntax .. 14 Request Parameters .. 14 Response Syntax .. 14 Response Elements .. 15 Errors .. 15 See Also.. 16 AttachStaticIp .. 17 Request Syntax .. 17 Request Parameters .. 17 Response Syntax .. 17 Response Elements .. 18 Errors .. 18 See Also.. 19 CloseInstancePublicPorts .. 20 Request Syntax .. 20 Request Parameters.

3 20 Response Syntax .. 20 Response Elements .. 21 Errors .. 21 See Also.. 22 CopySnapshot .. 23 Request Syntax .. 23 Request Parameters .. 23 Response Syntax .. 23 Response Elements .. 24 Errors .. 24 See Also.. 25 CreateCloudFormationStack .. 26 Request Syntax .. 26 Request Parameters .. 26 API Version 2016-11-28iiiAmazon Lightsail API ReferenceResponse Syntax .. 26 Response Elements .. 27 Errors .. 27 See Also.. 28 CreateDisk .. 29 Request Syntax .. 29 Request Parameters .. 29 Response Syntax .. 30 Response Elements .. 30 Errors .. 30 See Also.. 31 CreateDiskFromSnapshot .. 32 Request Syntax .. 32 Request Parameters .. 32 Response Syntax .. 33 Response Elements .. 33 Errors.

4 34 See Also.. 34 CreateDiskSnapshot .. 36 Request Syntax .. 36 Request Parameters .. 36 Response Syntax .. 37 Response Elements .. 37 Errors .. 38 See Also.. 38 CreateDomain .. 40 Request Syntax .. 40 Request Parameters .. 40 Response Syntax .. 40 Response Elements .. 41 Errors .. 41 See Also.. 42 CreateDomainEntry .. 43 Request Syntax .. 43 Request Parameters .. 43 Response Syntax .. 43 Response Elements .. 44 Errors .. 44 See Also.. 45 CreateInstances .. 46 Request Syntax .. 46 Request Parameters .. 46 Response Syntax .. 47 Response Elements .. 48 Errors .. 48 See Also.. 49 CreateInstancesFromSnapshot .. 50 Request Syntax .. 50 Request Parameters .. 50 Response Syntax.

5 52 Response Elements .. 52 Errors .. 52 See Also.. 53 CreateInstanceSnapshot .. 54 Request Syntax .. 54 Request Parameters .. 54 Response Syntax .. 55 API Version 2016-11-28ivAmazon Lightsail API ReferenceResponse Elements .. 55 Errors .. 55 See Also.. 56 CreateKeyPair .. 57 Request Syntax .. 57 Request Parameters .. 57 Response Syntax .. 57 Response Elements .. 58 Errors .. 58 See Also.. 59 CreateLoadBalancer .. 61 Request Syntax .. 61 Request Parameters .. 61 Response Syntax .. 62 Response Elements .. 63 Errors .. 63 See Also.. 64 CreateLoadBalancerTlsCertificate .. 65 Request Syntax .. 65 Request Parameters .. 65 Response Syntax .. 66 Response Elements .. 66 Errors .. 67 See Also.

6 67 CreateRelationalDatabase .. 69 Request Syntax .. 69 Request Parameters .. 69 Response Syntax .. 72 Response Elements .. 72 Errors .. 72 See Also.. 73 CreateRelationalDatabaseFromSnapshot .. 74 Request Syntax .. 74 Request Parameters .. 74 Response Syntax .. 76 Response Elements .. 76 Errors .. 77 See Also.. 77 CreateRelationalDatabaseSnapshot .. 79 Request Syntax .. 79 Request Parameters .. 79 Response Syntax .. 80 Response Elements .. 80 Errors .. 80 See Also.. 81 DeleteDisk.. 82 Request Syntax .. 82 Request Parameters .. 82 Response Syntax .. 82 Response Elements .. 83 Errors .. 83 See Also.. 84 DeleteDiskSnapshot.. 85 Request Syntax .. 85 Request Parameters .. 85 Response Syntax.

7 85 Response Elements .. 86 API Version 2016-11-28vAmazon Lightsail API ReferenceErrors .. 86 See Also.. 87 DeleteDomain.. 88 Request Syntax .. 88 Request Parameters .. 88 Response Syntax .. 88 Response Elements .. 88 Errors .. 89 See Also.. 89 DeleteDomainEntry .. 91 Request Syntax .. 91 Request Parameters .. 91 Response Syntax .. 91 Response Elements .. 92 Errors .. 92 See Also.. 93 DeleteInstance .. 94 Request Syntax .. 94 Request Parameters .. 94 Response Syntax .. 94 Response Elements .. 94 Errors .. 95 See Also.. 95 DeleteInstanceSnapshot .. 97 Request Syntax .. 97 Request Parameters .. 97 Response Syntax .. 97 Response Elements .. 98 Errors .. 98 See Also.. 99 DeleteKeyPair.

8 100 Request Syntax .. 100 Request Parameters .. 100 Response Syntax .. 100 Response Elements .. 100 Errors .. 101 See Also.. 101 DeleteLoadBalancer .. 103 Request Syntax .. 103 Request Parameters .. 103 Response Syntax .. 103 Response Elements .. 104 Errors .. 104 See Also.. 105 DeleteLoadBalancerTlsCertificate .. 106 Request Syntax .. 106 Request Parameters .. 106 Response Syntax .. 106 Response Elements .. 107 Errors .. 107 See Also.. 108 DeleteRelationalDatabase .. 109 Request Syntax .. 109 Request Parameters .. 109 Response Syntax .. 110 Response Elements .. 110 Errors .. 110 API Version 2016-11-28viAmazon Lightsail API ReferenceSee Also.. 111 DeleteRelationalDatabaseSnapshot.

9 112 Request Syntax .. 112 Request Parameters .. 112 Response Syntax .. 112 Response Elements .. 113 Errors .. 113 See Also.. 114 DetachDisk.. 115 Request Syntax .. 115 Request Parameters .. 115 Response Syntax .. 115 Response Elements .. 116 Errors .. 116 See Also.. 117 DetachInstancesFromLoadBalancer .. 118 Request Syntax .. 118 Request Parameters .. 118 Response Syntax .. 118 Response Elements .. 119 Errors .. 119 See Also.. 120 DetachStaticIp.. 121 Request Syntax .. 121 Request Parameters .. 121 Response Syntax .. 121 Response Elements .. 121 Errors .. 122 See Also.. 122 DownloadDefaultKeyPair .. 124 Response Syntax .. 124 Response Elements .. 124 Errors .. 124 See Also.

10 125 ExportSnapshot .. 126 Request Syntax .. 126 Request Parameters .. 126 Response Syntax .. 126 Response Elements .. 127 Errors .. 127 See Also.. 128 GetActiveNames .. 129 Request Syntax .. 129 Request Parameters .. 129 Response Syntax .. 129 Response Elements .. 129 Errors .. 129 See Also.. 130 GetBlueprints.. 132 Request Syntax .. 132 Request Parameters .. 132 Response Syntax .. 132 Response Elements .. 133 Errors .. 133 See Also.. 134 GetBundles.. 135 Request Syntax .. 135 API Version 2016-11-28viiAmazon Lightsail API ReferenceRequest Parameters .. 135 Response Syntax .. 135 Response Elements .. 136 Errors .. 136 See Also.. 137 GetCloudFormationStackRecords .. 138 Request Syntax.