Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amazon-lightsail-api-reference-034	amazon-lightsail-api-reference.pdf	34	for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 135 Amazon Lightsail API Reference CreateInstancesFromSnapshot Creates one or more new instances from a manual or automatic snapshot of an instance. The create instances from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identiﬁed by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOns": [ { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } } ], "attachedDiskMapping": { "string" : [ { "newDiskName": "string", "originalDiskPath": "string" } ] }, "availabilityZone": "string", "bundleId": "string", "instanceNames": [ "string" ], "instanceSnapshotName": "string", "ipAddressType": "string", "keyPairName": "string", "restoreDate": "string", "sourceInstanceName": "string", "tags": [ { "key": "string", "value": "string" CreateInstancesFromSnapshot API Version 2016-11-28 136 Amazon Lightsail } ], "useLatestRestorableAutoSnapshot": boolean, "userData": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. addOns An array of objects representing the add-ons to enable for the new instance. Type: Array of AddOnRequest objects Required: No attachedDiskMapping An object containing information about one or more disk mappings. Type: String to array of DiskMap objects map Key Pattern: \w[\w\-]\w Required: No availabilityZone The Availability Zone where you want to create your instances. Use the following formatting: us-east-2a (case sensitive). You can get a list of Availability Zones by using the get regions operation. Be sure to add the include Availability Zones parameter to your request. Type: String Required: Yes bundleId The bundle of speciﬁcation information for your virtual private server (or instance), including the pricing plan (micro_x_x). Type: String Request Parameters API Version 2016-11-28 137 API Reference Amazon Lightsail Pattern: .\S.* Required: Yes instanceNames The names for your new instances. Type: Array of strings Required: Yes instanceSnapshotName The name of the instance snapshot on which you are basing your new instances. Use the get instance snapshots operation to return information about your existing snapshots. Constraint: • This parameter cannot be deﬁned together with the source instance name parameter. The instance snapshot name and source instance name parameters are mutually exclusive. Type: String Pattern: \w[\w\-]\w Required: No ipAddressType The IP address type for the instance. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value is dualstack. Type: String Valid Values: dualstack \| ipv4 \| ipv6 Required: No keyPairName The name for your key pair. Request Parameters API Version 2016-11-28 138 Amazon Lightsail Type: String Pattern: \w[\w\-]\w Required: No restoreDate API Reference The date of the automatic snapshot to use for the new instance. Use the get auto snapshots operation to identify the dates of the available automatic snapshots. Constraints: • Must be speciﬁed in YYYY-MM-DD format. • This parameter cannot be deﬁned together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive. • Deﬁne this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No sourceInstanceName The name of the source instance from which the source automatic snapshot was created. Constraints: • This parameter cannot be deﬁned together with the instance snapshot name parameter. The source instance name and instance snapshot name parameters are mutually exclusive. • Deﬁne this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: String Required: No tags The tag keys and optional values to add to the resource during create. Request Parameters API Version 2016-11-28 139 Amazon Lightsail API Reference Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No useLatestRestorableAutoSnapshot A Boolean value to indicate whether to use the latest available automatic snapshot. Constraints: • This parameter cannot be deﬁned together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive. • Deﬁne this parameter only when creating a new instance from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide. Type: Boolean Required: No userData You can create a launch script that conﬁgures a server with additional user data. For example, apt-get -y update. Note Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide. Type: String Required: No Response Syntax { Response Syntax API Version 2016-11-28 140 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean,
amazon-lightsail-api-reference-035	amazon-lightsail-api-reference.pdf	35	Amazon Lightsail Developer Guide. Type: Boolean Required: No userData You can create a launch script that conﬁgures a server with additional user data. For example, apt-get -y update. Note Depending on the machine image you choose, the command to get software on your instance varies. Amazon Linux and CentOS use yum, Debian and Ubuntu use apt-get, and FreeBSD uses pkg. For a complete list, see the Amazon Lightsail Developer Guide. Type: String Required: No Response Syntax { Response Syntax API Version 2016-11-28 140 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 141 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 142 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 143 Amazon Lightsail API Reference CreateInstanceSnapshot Creates a snapshot of a speciﬁc virtual private server, or instance. You can use a snapshot to create a new instance that is based on that snapshot. The create instance snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string", "instanceSnapshotName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The Lightsail instance on which to base your snapshot. Type: String Pattern: \w[\w\-]\w Required: Yes instanceSnapshotName The name for your new snapshot. Type: String CreateInstanceSnapshot API Version 2016-11-28 144 Amazon Lightsail Pattern: \w[\w\-]\w Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. API Reference Type: Array of Tag objects Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 145 Amazon Lightsail operations API Reference An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input
amazon-lightsail-api-reference-036	amazon-lightsail-api-reference.pdf	36	such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 146 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 147 Amazon Lightsail CreateKeyPair API Reference Creates a custom SSH key pair that you can use with an Amazon Lightsail instance. Note Use the DownloadDefaultKeyPair action to create a Lightsail default key pair in an AWS Region where a default key pair does not currently exist. The create key pair operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "keyPairName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. keyPairName The name for your new key pair. Type: String Pattern: \w[\w\-]*\w Required: Yes CreateKeyPair API Version 2016-11-28 148 Amazon Lightsail tags API Reference The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No Response Syntax { "keyPair": { "arn": "string", "createdAt": number, "fingerprint": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] }, "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", Response Syntax API Version 2016-11-28 149 Amazon Lightsail API Reference "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number }, "privateKeyBase64": "string", "publicKeyBase64": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. keyPair An array of key-value pairs containing information about the new key pair you just created. Type: KeyPair object operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object privateKeyBase64 A base64-encoded RSA private key. Type: String publicKeyBase64 A base64-encoded public key of the ssh-rsa type. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 150 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 151 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated.
amazon-lightsail-api-reference-037	amazon-lightsail-api-reference.pdf	37	validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 151 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 152 Amazon Lightsail API Reference CreateLoadBalancer Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see Conﬁgure your Lightsail instances for load balancing. You can create up to 5 load balancers per AWS Region in your account. When you create a load balancer, you can specify a unique name and port settings. To change additional load balancer settings, use the UpdateLoadBalancerAttribute operation. The create load balancer operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "certificateAlternativeNames": [ "string" ], "certificateDomainName": "string", "certificateName": "string", "healthCheckPath": "string", "instancePort": number, "ipAddressType": "string", "loadBalancerName": "string", "tags": [ { "key": "string", "value": "string" } ], "tlsPolicyName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateAlternativeNames The optional alternative domains and subdomains to use with your SSL/TLS certiﬁcate (www.example.com, example.com, m.example.com, blog.example.com). CreateLoadBalancer API Version 2016-11-28 153 Amazon Lightsail Type: Array of strings Required: No certiﬁcateDomainName API Reference The domain name with which your certiﬁcate is associated (example.com). If you specify certificateDomainName, then certificateName is required (and vice-versa). Type: String Required: No certiﬁcateName The name of the SSL/TLS certiﬁcate. If you specify certificateName, then certificateDomainName is required (and vice-versa). Type: String Pattern: \w[\w\-]\w Required: No healthCheckPath 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 ("/"). You may want to specify a custom health check path other than the root of your application if your home page loads slowly or has a lot of media or scripting on it. Type: String Required: No instancePort The instance port where you're creating your load balancer. Type: Integer Request Parameters API Version 2016-11-28 154 Amazon Lightsail API Reference Valid Range: Minimum value of -1. Maximum value of 65535. Required: Yes ipAddressType The IP address type for the load balancer. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. The default value is dualstack. Type: String Valid Values: dualstack \| ipv4 \| ipv6 Required: No loadBalancerName The name of your load balancer. Type: String Pattern: \w[\w\-]\w Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No tlsPolicyName The name of the TLS policy to apply to the load balancer. Use the GetLoadBalancerTlsPolicies action to get a list of TLS policy names that you can specify. Request Parameters API Version 2016-11-28 155 Amazon Lightsail API Reference For more information about load balancer TLS policies, see Conﬁguring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide. Type: String Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Response Syntax API Version 2016-11-28 156 Amazon Lightsail API Reference Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be
amazon-lightsail-api-reference-038	amazon-lightsail-api-reference.pdf	38	} ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Response Syntax API Version 2016-11-28 156 Amazon Lightsail API Reference Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 157 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 158 Amazon Lightsail API Reference CreateLoadBalancerTlsCertiﬁcate Creates an SSL/TLS certiﬁcate for an Amazon Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). The CreateLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "certificateAlternativeNames": [ "string" ], "certificateDomainName": "string", "certificateName": "string", "loadBalancerName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateAlternativeNames An array of strings listing alternative domains and subdomains for your SSL/TLS certiﬁcate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (.example.com). Type: Array of strings Required: No CreateLoadBalancerTlsCertiﬁcate API Version 2016-11-28 159 Amazon Lightsail certiﬁcateDomainName API Reference The domain name (example.com) for your SSL/TLS certiﬁcate. Type: String Required: Yes certiﬁcateName The SSL/TLS certiﬁcate name. You can have up to 10 certiﬁcates in your account at one time. Each Lightsail load balancer can have up to 2 certiﬁcates associated with it at one time. There is also an overall limit to the number of certiﬁcates that can be issue in a 365-day period. For more information, see Limits. Type: String Pattern: \w[\w\-]\w Required: Yes loadBalancerName The load balancer name where you want to create the SSL/TLS certiﬁcate. Type: String Pattern: \w[\w\-]*\w Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No Response Syntax { Response Syntax API Version 2016-11-28 160 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 161 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail
amazon-lightsail-api-reference-039	amazon-lightsail-api-reference.pdf	39	describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 161 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 162 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 163 Amazon Lightsail API Reference CreateRelationalDatabase Creates a new database in Amazon Lightsail. The create relational database operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "availabilityZone": "string", "masterDatabaseName": "string", "masterUsername": "string", "masterUserPassword": "string", "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "relationalDatabaseBlueprintId": "string", "relationalDatabaseBundleId": "string", "relationalDatabaseName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. availabilityZone The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request. CreateRelationalDatabase API Version 2016-11-28 164 Amazon Lightsail Type: String Required: No masterDatabaseName API Reference The meaning of this parameter diﬀers according to the database engine you use. MySQL The name of the database to create when the Lightsail database resource is created. If this parameter isn't speciﬁed, no database is created in the database resource. Constraints: • Must contain 1 to 64 letters or numbers. • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9). • Can't be a word reserved by the speciﬁed database engine. For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, and MySQL 8.0. PostgreSQL The name of the database to create when the Lightsail database resource is created. If this parameter isn't speciﬁed, a database named postgres is created in the database resource. Constraints: • Must contain 1 to 63 letters or numbers. • Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0- 9). • Can't be a word reserved by the speciﬁed database engine. For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12. Type: String Required: Yes masterUsername The name for the master user. Request Parameters API Version 2016-11-28 165 Amazon Lightsail MySQL Constraints: • Required for MySQL. API Reference • Must be 1 to 16 letters or numbers. Can contain underscores. • First character must be a letter. • Can't be a reserved word for the chosen database engine. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0. PostgreSQL Constraints: • Required for PostgreSQL. • Must be 1 to 63 letters or numbers. Can contain underscores. • First character must be a letter. • Can't be a reserved word for the chosen database engine. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12. Type: String Required: Yes masterUserPassword The password for the master user. The password can include any printable
amazon-lightsail-api-reference-040	amazon-lightsail-api-reference.pdf	40	MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6, MySQL 5.7, or MySQL 8.0. PostgreSQL Constraints: • Required for PostgreSQL. • Must be 1 to 63 letters or numbers. Can contain underscores. • First character must be a letter. • Can't be a reserved word for the chosen database engine. For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6, PostgreSQL 10, PostgreSQL 11, and PostgreSQL 12. Type: String Required: Yes masterUserPassword The password for the master user. The password can include any printable ASCII character except "/", """, or "@". It cannot contain spaces. MySQL Constraints: Must contain from 8 to 41 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Type: String Request Parameters API Version 2016-11-28 166 Amazon Lightsail Required: No preferredBackupWindow API Reference The daily time range during which automated backups are created for your new database if automated backups are enabled. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. For more information about the preferred backup window time blocks for each region, see the Working With Backups guide in the Amazon Relational Database Service documentation. Constraints: • Must be in the hh24:mi-hh24:mi format. Example: 16:00-16:30 • Speciﬁed in Coordinated Universal Time (UTC). • Must not conﬂict with the preferred maintenance window. • Must be at least 30 minutes. Type: String Required: No preferredMaintenanceWindow The weekly time range during which system maintenance can occur on your new database. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. Constraints: • Must be in the ddd:hh24:mi-ddd:hh24:mi format. • Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. • Must be at least 30 minutes. • Speciﬁed in Coordinated Universal Time (UTC). • Example: Tue:17:00-Tue:17:30 Type: String Request Parameters API Version 2016-11-28 167 Amazon Lightsail Required: No publiclyAccessible API Reference Speciﬁes the accessibility options for your new database. A value of true speciﬁes a database that is available to resources outside of your Lightsail account. A value of false speciﬁes a database that is available only to your Lightsail resources in the same region as your database. Type: Boolean Required: No relationalDatabaseBlueprintId The blueprint ID for your new database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the get relational database blueprints operation. Type: String Required: Yes relationalDatabaseBundleId The bundle ID for your new database. A bundle describes the performance speciﬁcations for your database. You can get a list of database bundle IDs by using the get relational database bundles operation. Type: String Required: Yes relationalDatabaseName The name to use for your new Lightsail database resource. Constraints: • Must contain from 2 to 255 alphanumeric characters, or hyphens. • The ﬁrst and last character must be a letter or number. Type: String Request Parameters API Version 2016-11-28 168 Amazon Lightsail Pattern: \w[\w\-]*\w Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. API Reference Type: Array of Tag objects Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 169 Amazon Lightsail operations API Reference An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 170 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an
amazon-lightsail-api-reference-041	amazon-lightsail-api-reference.pdf	41	exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 170 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 171 Amazon Lightsail API Reference CreateRelationalDatabaseFromSnapshot Creates a new database from an existing database snapshot in Amazon Lightsail. You can create a new database from a snapshot in if something goes wrong with your original database, or to change it to a diﬀerent plan, such as a high availability or standard plan. The create relational database from snapshot operation supports tag-based access control via request tags and resource tags applied to the resource identiﬁed by relationalDatabaseSnapshotName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "availabilityZone": "string", "publiclyAccessible": boolean, "relationalDatabaseBundleId": "string", "relationalDatabaseName": "string", "relationalDatabaseSnapshotName": "string", "restoreTime": number, "sourceRelationalDatabaseName": "string", "tags": [ { "key": "string", "value": "string" } ], "useLatestRestorableTime": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. availabilityZone The Availability Zone in which to create your new database. Use the us-east-2a case-sensitive format. CreateRelationalDatabaseFromSnapshot API Version 2016-11-28 172 Amazon Lightsail API Reference You can get a list of Availability Zones by using the get regions operation. Be sure to add the include relational database Availability Zones parameter to your request. Type: String Required: No publiclyAccessible Speciﬁes the accessibility options for your new database. A value of true speciﬁes a database that is available to resources outside of your Lightsail account. A value of false speciﬁes a database that is available only to your Lightsail resources in the same region as your database. Type: Boolean Required: No relationalDatabaseBundleId The bundle ID for your new database. A bundle describes the performance speciﬁcations for your database. You can get a list of database bundle IDs by using the get relational database bundles operation. When creating a new database from a snapshot, you cannot choose a bundle that is smaller than the bundle of the source database. Type: String Required: No relationalDatabaseName The name to use for your new Lightsail database resource. Constraints: • Must contain from 2 to 255 alphanumeric characters, or hyphens. • The ﬁrst and last character must be a letter or number. Type: String Pattern: \w[\w\-]\w Required: Yes Request Parameters API Version 2016-11-28 173 Amazon Lightsail API Reference relationalDatabaseSnapshotName The name of the database snapshot from which to create your new database. Type: String Pattern: \w[\w\-]\w Required: No restoreTime The date and time to restore your database from. Constraints: • Must be before the latest restorable time for the database. • Cannot be speciﬁed if the use latest restorable time parameter is true. • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use a restore time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the restore time. Type: Timestamp Required: No sourceRelationalDatabaseName The name of the source database. Type: String Pattern: \w[\w\-]*\w Required: No tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Request Parameters API Version 2016-11-28 174 Amazon Lightsail Required: No useLatestRestorableTime API Reference Speciﬁes whether your database is restored from the latest backup time. A value of true restores from the latest backup time. Default: false Constraints: Cannot be speciﬁed if the restore time parameter is provided. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number
amazon-lightsail-api-reference-042	amazon-lightsail-api-reference.pdf	42	TagResource action to tag a resource after it's created. Type: Array of Tag objects Request Parameters API Version 2016-11-28 174 Amazon Lightsail Required: No useLatestRestorableTime API Reference Speciﬁes whether your database is restored from the latest backup time. A value of true restores from the latest backup time. Default: false Constraints: Cannot be speciﬁed if the restore time parameter is provided. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2016-11-28 175 Amazon Lightsail API Reference The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Errors API Version 2016-11-28 176 Amazon Lightsail HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 177 Amazon Lightsail API Reference CreateRelationalDatabaseSnapshot Creates a snapshot of your database in Amazon Lightsail. You can use snapshots for backups, to make copies of a database, and to save data before deleting a database. The create relational database snapshot operation supports tag-based access control via request tags. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseName": "string", "relationalDatabaseSnapshotName": "string", "tags": [ { "key": "string", "value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of the database on which to base your new snapshot. Type: String Pattern: \w[\w\-]\w Required: Yes relationalDatabaseSnapshotName The name for your new database snapshot. Constraints: CreateRelationalDatabaseSnapshot API Version 2016-11-28 178 Amazon Lightsail API Reference • Must contain from 2 to 255 alphanumeric characters, or hyphens. • The ﬁrst and last character must be a letter or number. Type: String Pattern: \w[\w\-]\w Required: Yes tags The tag keys and optional values to add to the resource during create. Use the TagResource action to tag a resource after it's created. Type: Array of Tag objects Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Syntax API Version 2016-11-28 179 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when
amazon-lightsail-api-reference-043	amazon-lightsail-api-reference.pdf	43	operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 180 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 181 Amazon Lightsail API Reference See Also API Version 2016-11-28 182 Amazon Lightsail DeleteAlarm Deletes an alarm. API Reference An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. Request Syntax { "alarmName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. alarmName The name of the alarm to delete. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, DeleteAlarm API Version 2016-11-28 183 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 184 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 185 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 186 Amazon Lightsail API Reference DeleteAutoSnapshot Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "date": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all
amazon-lightsail-api-reference-044	amazon-lightsail-api-reference.pdf	44	C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 185 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 186 Amazon Lightsail API Reference DeleteAutoSnapshot Deletes an automatic snapshot of an instance or disk. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "date": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. date The date of the automatic snapshot to delete in YYYY-MM-DD format. Use the get auto snapshots operation to get the available automatic snapshots for a resource. Type: String Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$ Required: Yes resourceName The name of the source instance or disk from which to delete the automatic snapshot. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { DeleteAutoSnapshot API Version 2016-11-28 187 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 188 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 189 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 190 Amazon Lightsail DeleteBucket Deletes a Amazon Lightsail bucket. Note API Reference When you delete your bucket, the bucket name is released and can be reused for a new bucket in your account or another AWS account. Request Syntax { "bucketName": "string", "forceDelete": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket to delete. Use the GetBuckets action to get a list of bucket names that you can specify. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes forceDelete A Boolean value that indicates whether to force delete the bucket. You must force delete the bucket if it has one of the following conditions: DeleteBucket API Version 2016-11-28 191 Amazon Lightsail API Reference • The bucket is the origin of a distribution. • The bucket has instances that were granted access to it using the SetResourceAccessForBucket action. • The bucket has objects. • The bucket has access keys. Important Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Syntax API Version 2016-11-28 192 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in
amazon-lightsail-api-reference-045	amazon-lightsail-api-reference.pdf	45	keys. Important Force deleting a bucket might impact other resources that rely on the bucket, such as instances, distributions, or software that use the issued access keys. Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Syntax API Version 2016-11-28 192 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Response Elements API Version 2016-11-28 193 Amazon Lightsail HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 194 Amazon Lightsail API Reference DeleteBucketAccessKey Deletes an access key for the speciﬁed Amazon Lightsail bucket. We recommend that you delete an access key if the secret access key is compromised. For more information about access keys, see Creating access keys for a bucket in Amazon Lightsail in the Amazon Lightsail Developer Guide. Request Syntax { "accessKeyId": "string", "bucketName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. accessKeyId The ID of the access key to delete. Use the GetBucketAccessKeys action to get a list of access key IDs that you can specify. Type: String Pattern: .\S. Required: Yes bucketName The name of the bucket that the access key belongs to. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes DeleteBucketAccessKey API Version 2016-11-28 195 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 196 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 197 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++
amazon-lightsail-api-reference-046	amazon-lightsail-api-reference.pdf	46	AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 197 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 198 Amazon Lightsail DeleteCertiﬁcate API Reference Deletes an SSL/TLS certiﬁcate for your Amazon Lightsail content delivery network (CDN) distribution. Certiﬁcates that are currently attached to a distribution cannot be deleted. Use the DetachCertificateFromDistribution action to detach a certiﬁcate from a distribution. Request Syntax { "certificateName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name of the certiﬁcate to delete. Use the GetCertificates action to get a list of certiﬁcate names that you can specify. Type: String Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, DeleteCertiﬁcate API Version 2016-11-28 199 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 200 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2016-11-28 201 Amazon Lightsail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 202 Amazon Lightsail API Reference DeleteContactMethod Deletes a contact method. A contact method is used to send you notiﬁcations about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notiﬁcations in Amazon Lightsail. Request Syntax { "protocol": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. protocol The protocol that will be deleted, such as Email or SMS (text messaging). Note To delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol. Type: String Valid Values: Email \| SMS Required: Yes DeleteContactMethod API Version 2016-11-28 203 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON
amazon-lightsail-api-reference-047	amazon-lightsail-api-reference.pdf	47	delete an Email and an SMS contact method if you added both, you must run separate DeleteContactMethod actions to delete each protocol. Type: String Valid Values: Email \| SMS Required: Yes DeleteContactMethod API Version 2016-11-28 203 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 204 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 205 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 206 Amazon Lightsail API Reference DeleteContainerImage Deletes a container image that is registered to your Amazon Lightsail container service. Request Syntax { "image": "string", "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. image The name of the container image to delete from the container service. Use the GetContainerImages action to get the name of the container images that are registered to a container service. Note Container images sourced from your Lightsail container service, that are registered and stored on your service, start with a colon (:). For example, :container- service-1.mystaticwebsite.1. Container images sourced from a public registry like Docker Hub don't start with a colon. For example, nginx:latest or nginx. Type: String Required: Yes serviceName The name of the container service for which to delete a registered container image. Type: String DeleteContainerImage API Version 2016-11-28 207 Amazon Lightsail API Reference Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. Response Elements API Version 2016-11-28 208 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 209 Amazon
amazon-lightsail-api-reference-048	amazon-lightsail-api-reference.pdf	48	500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 209 Amazon Lightsail API Reference DeleteContainerService Deletes your Amazon Lightsail container service. Request Syntax { "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. serviceName The name of the container service to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. DeleteContainerService API Version 2016-11-28 210 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2016-11-28 211 Amazon Lightsail • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 212 Amazon Lightsail DeleteDisk API Reference Deletes the speciﬁed block storage disk. The disk must be in the available state (not attached to a Lightsail instance). Note The disk may remain in the deleting state for several minutes. The delete disk operation supports tag-based access control via resource tags applied to the resource identiﬁed by disk name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "diskName": "string", "forceDeleteAddOns": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskName The unique name of the disk you want to delete (my-disk). Type: String Pattern: \w[\w\-]*\w Required: Yes forceDeleteAddOns A Boolean value to indicate whether to delete all add-ons for the disk. DeleteDisk API Version 2016-11-28 213 API Reference Amazon Lightsail Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 214 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception
amazon-lightsail-api-reference-049	amazon-lightsail-api-reference.pdf	49	access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 215 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 216 Amazon Lightsail API Reference DeleteDiskSnapshot Deletes the speciﬁed disk snapshot. 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. The delete disk snapshot operation supports tag-based access control via resource tags applied to the resource identiﬁed by disk snapshot name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "diskSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskSnapshotName The name of the disk snapshot you want to delete (my-disk-snapshot). Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { DeleteDiskSnapshot API Version 2016-11-28 217 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 218 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 219 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 220 Amazon Lightsail DeleteDistribution API Reference Deletes your Amazon Lightsail content delivery network (CDN) distribution. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following
amazon-lightsail-api-reference-050	amazon-lightsail-api-reference.pdf	50	Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 220 Amazon Lightsail DeleteDistribution API Reference Deletes your Amazon Lightsail content delivery network (CDN) distribution. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution to delete. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: No Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", DeleteDistribution API Version 2016-11-28 221 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 222 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 223 Amazon Lightsail API Reference See Also API Version 2016-11-28 224 Amazon Lightsail DeleteDomain API Reference Deletes the speciﬁed domain recordset and all of its domain records. The delete domain operation supports tag-based access control via resource tags applied to the resource identiﬁed by domain name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "domainName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. domainName The speciﬁc domain name to delete. Type: String Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, DeleteDomain API Version 2016-11-28 225 Amazon Lightsail API Reference "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 226 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when
amazon-lightsail-api-reference-051	amazon-lightsail-api-reference.pdf	51	uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 226 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 227 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 228 Amazon Lightsail API Reference DeleteDomainEntry Deletes a speciﬁc domain entry. The delete domain entry operation supports tag-based access control via resource tags applied to the resource identiﬁed by domain name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "domainEntry": { "id": "string", "isAlias": boolean, "name": "string", "options": { "string" : "string" }, "target": "string", "type": "string" }, "domainName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. domainEntry An array of key-value pairs containing information about your domain entries. Type: DomainEntry object Required: Yes domainName The name of the domain entry to delete. Type: String DeleteDomainEntry API Version 2016-11-28 229 API Reference Amazon Lightsail Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 230 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 231 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 232 Amazon Lightsail DeleteInstance Deletes an Amazon Lightsail instance. API Reference The delete instance operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "forceDeleteAddOns": boolean, "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. forceDeleteAddOns
amazon-lightsail-api-reference-052	amazon-lightsail-api-reference.pdf	52	• AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 232 Amazon Lightsail DeleteInstance Deletes an Amazon Lightsail instance. API Reference The delete instance operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "forceDeleteAddOns": boolean, "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. forceDeleteAddOns A Boolean value to indicate whether to delete all add-ons for the instance. Type: Boolean Required: No instanceName The name of the instance to delete. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { DeleteInstance API Version 2016-11-28 233 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 234 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 235 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 236 Amazon Lightsail API Reference DeleteInstanceSnapshot Deletes a speciﬁc snapshot of a virtual private server (or instance). The delete instance snapshot operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance snapshot name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceSnapshotName The name of the snapshot to delete. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, DeleteInstanceSnapshot API Version 2016-11-28 237 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 238 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available
amazon-lightsail-api-reference-053	amazon-lightsail-api-reference.pdf	53	Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 238 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 239 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 240 Amazon Lightsail DeleteKeyPair API Reference Deletes the speciﬁed key pair by removing the public key from Amazon Lightsail. You can delete key pairs that were created using the ImportKeyPair and CreateKeyPair actions, as well as the Lightsail default key pair. A new default key pair will not be created unless you launch an instance without specifying a custom key pair, or you call the DownloadDefaultKeyPair API. The delete key pair operation supports tag-based access control via resource tags applied to the resource identiﬁed by key pair name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "expectedFingerprint": "string", "keyPairName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. expectedFingerprint The RSA ﬁngerprint of the Lightsail default key pair to delete. Note The expectedFingerprint parameter is required only when specifying to delete a Lightsail default key pair. Type: String Required: No keyPairName The name of the key pair to delete. DeleteKeyPair API Version 2016-11-28 241 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Response Syntax API Version 2016-11-28 242 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 243 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3
amazon-lightsail-api-reference-054	amazon-lightsail-api-reference.pdf	54	Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 243 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 244 Amazon Lightsail API Reference DeleteKnownHostKeys Deletes the known host key or certiﬁcate used by the Amazon Lightsail browser-based SSH or RDP clients to authenticate an instance. This operation enables the Lightsail browser-based SSH or RDP clients to connect to the instance after a host key mismatch. Important Perform this operation only if you were expecting the host key or certiﬁcate mismatch or if you are familiar with the new host key or certiﬁcate on the instance. For more information, see Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance for which you want to reset the host key or certiﬁcate. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { DeleteKnownHostKeys API Version 2016-11-28 245 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 246 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 247 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 248 Amazon Lightsail API Reference DeleteLoadBalancer Deletes a Lightsail load balancer and all its associated SSL/TLS certiﬁcates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certiﬁcate, and verify domain ownership again. The delete load balancer operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. loadBalancerName The name of the load balancer you want to delete. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", DeleteLoadBalancer API Version 2016-11-28 249 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number
amazon-lightsail-api-reference-055	amazon-lightsail-api-reference.pdf	55	more information, see the Amazon Lightsail Developer Guide. Request Syntax { "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. loadBalancerName The name of the load balancer you want to delete. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", DeleteLoadBalancer API Version 2016-11-28 249 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 250 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 251 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 252 Amazon Lightsail API Reference DeleteLoadBalancerTlsCertiﬁcate Deletes an SSL/TLS certiﬁcate associated with a Lightsail load balancer. The DeleteLoadBalancerTlsCertificate operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "certificateName": "string", "force": boolean, "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The SSL/TLS certiﬁcate name. Type: String Pattern: \w[\w\-]\w Required: Yes force When true, forces the deletion of an SSL/TLS certiﬁcate. There can be two certiﬁcates associated with a Lightsail load balancer: the primary and the backup. The force parameter is required when the primary SSL/TLS certiﬁcate is in use by an instance attached to the load balancer. Type: Boolean DeleteLoadBalancerTlsCertiﬁcate API Version 2016-11-28 253 API Reference Amazon Lightsail Required: No loadBalancerName The load balancer name. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 254 Amazon Lightsail operations API Reference An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to
amazon-lightsail-api-reference-056	amazon-lightsail-api-reference.pdf	56	objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 255 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 256 Amazon Lightsail API Reference DeleteRelationalDatabase Deletes a database in Amazon Lightsail. The delete relational database operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "finalRelationalDatabaseSnapshotName": "string", "relationalDatabaseName": "string", "skipFinalSnapshot": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ﬁnalRelationalDatabaseSnapshotName The name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter. Note Specifying this parameter and also specifying the skip final snapshot parameter to true results in an error. Constraints: • Must contain from 2 to 255 alphanumeric characters, or hyphens. • The ﬁrst and last character must be a letter or number. Type: String Pattern: \w[\w\-]\w DeleteRelationalDatabase API Version 2016-11-28 257 API Reference Amazon Lightsail Required: No relationalDatabaseName The name of the database that you are deleting. Type: String Pattern: \w[\w\-]\w Required: Yes skipFinalSnapshot Determines whether a ﬁnal database snapshot is created before your database is deleted. If true is speciﬁed, no database snapshot is created. If false is speciﬁed, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false. Default: false Type: Boolean Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", Response Syntax API Version 2016-11-28 258 Amazon Lightsail API Reference "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 259 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for
amazon-lightsail-api-reference-057	amazon-lightsail-api-reference.pdf	57	your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 260 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 261 Amazon Lightsail API Reference DeleteRelationalDatabaseSnapshot Deletes a database snapshot in Amazon Lightsail. The delete relational database snapshot operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseSnapshotName The name of the database snapshot that you are deleting. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, DeleteRelationalDatabaseSnapshot API Version 2016-11-28 262 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 263 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 264 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 265 Amazon Lightsail API Reference DetachCertiﬁcateFromDistribution Detaches an SSL/TLS certiﬁcate from your Amazon Lightsail content delivery network (CDN) distribution. After the certiﬁcate is detached, your distribution stops accepting traﬃc for all of the domains that are associated with the certiﬁcate. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution from which to detach the certiﬁcate. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", DetachCertiﬁcateFromDistribution API Version 2016-11-28 266 Amazon Lightsail API Reference "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service.
amazon-lightsail-api-reference-058	amazon-lightsail-api-reference.pdf	58	the distribution from which to detach the certiﬁcate. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", DetachCertiﬁcateFromDistribution API Version 2016-11-28 266 Amazon Lightsail API Reference "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 267 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 268 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 269 Amazon Lightsail DetachDisk API Reference Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any ﬁle systems on the device within your operating system before stopping the instance and detaching the disk. The detach disk operation supports tag-based access control via resource tags applied to the resource identiﬁed by disk name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "diskName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskName The unique name of the disk you want to detach from your instance (my-disk). Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", DetachDisk API Version 2016-11-28 270 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 271 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See
amazon-lightsail-api-reference-059	amazon-lightsail-api-reference.pdf	59	the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 272 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 273 Amazon Lightsail API Reference DetachInstancesFromLoadBalancer Detaches the speciﬁed instances from a Lightsail load balancer. This operation waits until the instances are no longer needed before they are detached from the load balancer. The detach instances from load balancer operation supports tag-based access control via resource tags applied to the resource identiﬁed by load balancer name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceNames": [ "string" ], "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceNames An array of strings containing the names of the instances you want to detach from the load balancer. Type: Array of strings Pattern: \w[\w\-]\w Required: Yes loadBalancerName The name of the Lightsail load balancer. Type: String Pattern: \w[\w\-]\w Required: Yes DetachInstancesFromLoadBalancer API Version 2016-11-28 274 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 275 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 276 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 277 Amazon Lightsail DetachStaticIp API Reference Detaches a static IP from the Amazon Lightsail instance to which it is attached. Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP to detach from the instance. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", DetachStaticIp API Version 2016-11-28 278 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response
amazon-lightsail-api-reference-060	amazon-lightsail-api-reference.pdf	60	it is attached. Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP to detach from the instance. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", DetachStaticIp API Version 2016-11-28 278 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 279 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 280 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 281 Amazon Lightsail DisableAddOn API Reference Disables an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOnType": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. addOnType The add-on type to disable. Type: String Valid Values: AutoSnapshot \| StopInstanceOnIdle Required: Yes resourceName The name of the source resource for which to disable the add-on. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { DisableAddOn API Version 2016-11-28 282 API Reference Amazon Lightsail "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 283 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following:
amazon-lightsail-api-reference-061	amazon-lightsail-api-reference.pdf	61	in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 284 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 285 Amazon Lightsail API Reference DownloadDefaultKeyPair Downloads the regional Amazon Lightsail default key pair. This action also creates a Lightsail default key pair if a default key pair does not currently exist in the AWS Region. Response Syntax { "createdAt": number, "privateKeyBase64": "string", "publicKeyBase64": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. createdAt The timestamp when the default key pair was created. Type: Timestamp privateKeyBase64 A base64-encoded RSA private key. Type: String publicKeyBase64 A base64-encoded public key of the ssh-rsa type. Type: String Errors For information about the errors that are common to all actions, see Common Errors. DownloadDefaultKeyPair API Version 2016-11-28 286 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 287 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 288 Amazon Lightsail EnableAddOn API Reference Enables or modiﬁes an add-on for an Amazon Lightsail resource. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "addOnRequest": { "addOnType": "string", "autoSnapshotAddOnRequest": { "snapshotTimeOfDay": "string" }, "stopInstanceOnIdleRequest": { "duration": "string", "threshold": "string" } }, "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. addOnRequest An array of strings representing the add-on to enable or modify. Type: AddOnRequest object Required: Yes resourceName The name of the source resource for which to enable or modify the add-on. Type: String Pattern: \w[\w\-]*\w Required: Yes EnableAddOn API Version 2016-11-28 289 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 290 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
amazon-lightsail-api-reference-062	amazon-lightsail-api-reference.pdf	62	successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 290 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 291 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 292 Amazon Lightsail ExportSnapshot API Reference Exports an Amazon Lightsail instance or block storage disk snapshot to Amazon Elastic Compute Cloud (Amazon EC2). This operation results in an export snapshot record that can be used with the create cloud formation stack operation to create new Amazon EC2 instances. Exported instance snapshots appear in Amazon EC2 as Amazon Machine Images (AMIs), and the instance system disk appears as an Amazon Elastic Block Store (Amazon EBS) volume. Exported disk snapshots appear in Amazon EC2 as Amazon EBS volumes. Snapshots are exported to the same Amazon Web Services Region in Amazon EC2 as the source Lightsail snapshot. The export snapshot operation supports tag-based access control via resource tags applied to the resource identiﬁed by source snapshot name. For more information, see the Amazon Lightsail Developer Guide. Note Use the get instance snapshots or get disk snapshots operations to get a list of snapshots that you can export to Amazon EC2. Request Syntax { "sourceSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. sourceSnapshotName The name of the instance or disk snapshot to be exported to Amazon EC2. Type: String ExportSnapshot API Version 2016-11-28 293 API Reference Amazon Lightsail Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 294 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 295 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP
amazon-lightsail-api-reference-063	amazon-lightsail-api-reference.pdf	63	rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 295 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 296 Amazon Lightsail GetActiveNames Returns the names of all active (not deleted) resources. API Reference Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetActiveNames request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "activeNames": [ "string" ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetActiveNames API Version 2016-11-28 297 Amazon Lightsail activeNames API Reference The list of active names returned by the get active names request. Type: Array of strings nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetActiveNames request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Errors API Version 2016-11-28 298 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 299 Amazon Lightsail API Reference See Also API Version 2016-11-28 300 Amazon Lightsail GetAlarms API Reference Returns information about the conﬁgured alarms. Specify an alarm name in your request to return information about a speciﬁc alarm, or specify a monitored resource name to return information about all alarms for a speciﬁc resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. Request Syntax { "alarmName": "string", "monitoredResourceName": "string", "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. alarmName The name of the alarm. Specify an alarm name to return information about a speciﬁc alarm.
amazon-lightsail-api-reference-064	amazon-lightsail-api-reference.pdf	64	resource. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. Request Syntax { "alarmName": "string", "monitoredResourceName": "string", "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. alarmName The name of the alarm. Specify an alarm name to return information about a speciﬁc alarm. Type: String Pattern: \w[\w\-]\w Required: No monitoredResourceName The name of the Lightsail resource being monitored by the alarm. Specify a monitored resource name to return information about all alarms for a speciﬁc resource. GetAlarms API Version 2016-11-28 301 Amazon Lightsail Type: String Pattern: \w[\w\-]\w Required: No pageToken API Reference The token to advance to the next page of results from your request. To get a page token, perform an initial GetAlarms request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "alarms": [ { "arn": "string", "comparisonOperator": "string", "contactProtocols": [ "string" ], "createdAt": number, "datapointsToAlarm": number, "evaluationPeriods": number, "location": { "availabilityZone": "string", "regionName": "string" }, "metricName": "string", "monitoredResourceInfo": { "arn": "string", "name": "string", "resourceType": "string" }, "name": "string", "notificationEnabled": boolean, "notificationTriggers": [ "string" ], "period": number, Response Syntax API Version 2016-11-28 302 Amazon Lightsail API Reference "resourceType": "string", "state": "string", "statistic": "string", "supportCode": "string", "threshold": number, "treatMissingData": "string", "unit": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. alarms An array of objects that describe the alarms. Type: Array of Alarm objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetAlarms request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 303 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 304 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 305 Amazon Lightsail GetAutoSnapshots API Reference Returns the available automatic snapshots for an instance or disk. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceName The name of the source instance or disk from which to get automatic snapshot information. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "autoSnapshots": [ { "createdAt": number, "date": "string", "fromAttachedDisks": [ { "path": "string", "sizeInGb": number } ], "status": "string" GetAutoSnapshots API Version 2016-11-28 306 Amazon Lightsail } ], "resourceName": "string", "resourceType": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. autoSnapshots An array of objects that describe the automatic snapshots that are available for the speciﬁed source instance or disk. Type: Array of AutoSnapshotDetails objects resourceName The name of the source instance or disk for the automatic snapshots. Type: String Pattern: \w[\w\-]\w resourceType The
amazon-lightsail-api-reference-065	amazon-lightsail-api-reference.pdf	65	number, "date": "string", "fromAttachedDisks": [ { "path": "string", "sizeInGb": number } ], "status": "string" GetAutoSnapshots API Version 2016-11-28 306 Amazon Lightsail } ], "resourceName": "string", "resourceType": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. autoSnapshots An array of objects that describe the automatic snapshots that are available for the speciﬁed source instance or disk. Type: Array of AutoSnapshotDetails objects resourceName The name of the source instance or disk for the automatic snapshots. Type: String Pattern: \w[\w\-]*\w resourceType The resource type of the automatic snapshot. The possible values are Instance, and Disk. Type: String Valid Values: ContainerService \| Instance \| StaticIp \| KeyPair \| InstanceSnapshot \| Domain \| PeeredVpc \| LoadBalancer \| LoadBalancerTlsCertificate \| Disk \| DiskSnapshot \| RelationalDatabase \| RelationalDatabaseSnapshot \| ExportSnapshotRecord \| CloudFormationStackRecord \| Alarm \| ContactMethod \| Distribution \| Certificate \| Bucket Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 307 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 308 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 309 Amazon Lightsail GetBlueprints API Reference Returns the list of available instance images, or blueprints. You can use a blueprint to create a new instance already running a speciﬁc operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose. Note Use active blueprints when creating new instances. Inactive blueprints are listed to support customers with existing instances and are not necessarily available to create new instances. Blueprints are marked inactive when they become outdated due to operating system updates or new application releases. Request Syntax { "appCategory": "string", "includeInactive": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. appCategory Returns a list of blueprints that are speciﬁc to Lightsail for Research. Important You must use this parameter to view Lightsail for Research blueprints. Type: String Valid Values: LfR GetBlueprints API Version 2016-11-28 310 Amazon Lightsail Required: No includeInactive API Reference A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request. Type: Boolean Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "blueprints": [ { "appCategory": "string", "blueprintId": "string", "description": "string", "group": "string", "isActive": boolean, "licenseUrl": "string", "minPower": number, "name": "string", "platform": "string", "productUrl": "string", "type": "string", "version": "string", "versionCode": "string" } ], Response Syntax API Version 2016-11-28 311 Amazon Lightsail "nextPageToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. blueprints An array of key-value pairs that contains information about the available blueprints. Type: Array of Blueprint objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common
amazon-lightsail-api-reference-066	amazon-lightsail-api-reference.pdf	66	is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. blueprints An array of key-value pairs that contains information about the available blueprints. Type: Array of Blueprint objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBlueprints request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 312 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 313 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 314 Amazon Lightsail API Reference GetBucketAccessKeys Returns the existing access key IDs for the speciﬁed Amazon Lightsail bucket. Important This action does not return the secret access key value of an access key. You can get a secret access key only when you create it from the response of the CreateBucketAccessKey action. If you lose the secret access key, you must create a new access key. Request Syntax { "bucketName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket for which to return access keys. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes Response Syntax { GetBucketAccessKeys API Version 2016-11-28 315 Amazon Lightsail API Reference "accessKeys": [ { "accessKeyId": "string", "createdAt": number, "lastUsed": { "lastUsedDate": number, "region": "string", "serviceName": "string" }, "secretAccessKey": "string", "status": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessKeys An object that describes the access keys for the speciﬁed bucket. Type: Array of AccessKey objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 316 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Examples In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you conﬁgure the tools. When you
amazon-lightsail-api-reference-067	amazon-lightsail-api-reference.pdf	67	Examples In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Get bucket access keys The following example returns the access keys for the bucket named amzn-s3-demo-bucket. The example response shows that the bucket has one access key (i.e., AKIAZEXAMPLE12345PKWV). Examples API Version 2016-11-28 317 Amazon Lightsail Sample Request API Reference POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.GetBucketAccessKeys Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20210616T143306Z Authorization: AUTHPARAMS Content-Length: 49 {"bucketName": "amzn-s3-demo-bucket"} Sample Response HTTP/1.1 200 OK Server: Server Date: Wed, 16 Jun 2021 14:33:07 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 99 x-amzn-RequestId: faebc873-b9cd-4dd1-bd6d-caac46bd5a19 Connection: keep-alive { "accessKeys": [ { "accessKeyId": "AKIAZEXAMPLE12345PKWV", "createdAt": 1.619209369E9, "status": "Active" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2016-11-28 318 API Reference Amazon Lightsail • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 319 Amazon Lightsail GetBucketBundles API Reference Returns the bundles that you can apply to a Amazon Lightsail bucket. The bucket bundle speciﬁes the monthly cost, storage quota, and data transfer quota for a bucket. Use the UpdateBucketBundle action to update the bundle for a bucket. Request Syntax { "includeInactive": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. includeInactive A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request. Type: Boolean Required: No Response Syntax { "bundles": [ { "bundleId": "string", "isActive": boolean, "name": "string", "price": number, "storagePerMonthInGb": number, "transferPerMonthInGb": number GetBucketBundles API Version 2016-11-28 320 API Reference Amazon Lightsail } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. bundles An object that describes bucket bundles. Type: Array of BucketBundle objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Response Elements API Version 2016-11-28 321 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 322 Amazon Lightsail API Reference GetBucketMetricData Returns the data points of a speciﬁc metric for an Amazon Lightsail bucket. Metrics report the utilization of a bucket. View and collect metric data regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects. Request Syntax { "bucketName": "string", "endTime": number, "metricName": "string", "period": number, "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket for which to get metric data. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes endTime The timestamp indicating the
amazon-lightsail-api-reference-068	amazon-lightsail-api-reference.pdf	68	regularly to monitor the number of objects stored in a bucket (including object versions) and the storage space used by those objects. Request Syntax { "bucketName": "string", "endTime": number, "metricName": "string", "period": number, "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket for which to get metric data. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes endTime The timestamp indicating the latest data to be returned. GetBucketMetricData API Version 2016-11-28 323 Amazon Lightsail Type: Timestamp Required: Yes metricName API Reference The metric for which you want to return information. Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. Note These bucket metrics are reported once per day. • BucketSizeBytes - The amount of data in bytes stored in a bucket. This value is calculated by summing the size of all objects in the bucket (including object versions), including the size of all parts for all incomplete multipart uploads to the bucket. Statistics: The most useful statistic is Maximum. Unit: The published unit is Bytes. • NumberOfObjects - The total number of objects stored in a bucket. This value is calculated by counting all objects in the bucket (including object versions) and the total number of parts for all incomplete multipart uploads to the bucket. Statistics: The most useful statistic is Average. Unit: The published unit is Count. Type: String Valid Values: BucketSizeBytes \| NumberOfObjects Required: Yes period The granularity, in seconds, of the returned data points. Request Parameters API Version 2016-11-28 324 Amazon Lightsail Note API Reference Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes startTime The timestamp indicating the earliest data to be returned. Type: Timestamp Required: Yes statistics The statistic for the metric. The following statistics are available: • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - The sum of all values submitted for the matching metric. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Request Parameters API Version 2016-11-28 325 Amazon Lightsail Required: Yes unit The unit for the metric data request. API Reference Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter. Type: String Valid Values: Seconds \| Microseconds \| Milliseconds \| Bytes \| Kilobytes \| Megabytes \| Gigabytes \| Terabytes \| Bits \| Kilobits \| Megabits \| Gigabits \| Terabits \| Percent \| Count \| Bytes/Second \| Kilobytes/Second \| Megabytes/Second \| Gigabytes/Second \| Terabytes/Second \| Bits/Second \| Kilobits/Second \| Megabits/Second \| Gigabits/Second \| Terabits/Second \| Count/Second \| None Required: Yes Response Syntax { "metricData": [ { "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 326 Amazon Lightsail metricData An array of objects that describe the metric data returned. API Reference Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: BucketSizeBytes \| NumberOfObjects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or
amazon-lightsail-api-reference-069	amazon-lightsail-api-reference.pdf	69	MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: BucketSizeBytes \| NumberOfObjects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Errors API Version 2016-11-28 327 Amazon Lightsail HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 328 Amazon Lightsail GetBuckets API Reference Returns information about one or more Amazon Lightsail buckets. The information returned includes the synchronization status of the Amazon Simple Storage Service (Amazon S3) account- level block public access feature for your Lightsail buckets. For more information about buckets, see Buckets in Amazon Lightsail in the Amazon Lightsail Developer Guide. Request Syntax { "bucketName": "string", "includeConnectedResources": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. bucketName The name of the bucket for which to return information. When omitted, the response includes all of your buckets in the AWS Region where the request is made. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: No includeConnectedResources A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the SetResourceAccessForBucket action. GetBuckets API Version 2016-11-28 329 Amazon Lightsail Type: Boolean Required: No pageToken API Reference The token to advance to the next page of results from your request. To get a page token, perform an initial GetBuckets request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "accountLevelBpaSync": { "bpaImpactsLightsail": boolean, "lastSyncedAt": number, "message": "string", "status": "string" }, "buckets": [ { "ableToUpdateBundle": boolean, "accessLogConfig": { "destination": "string", "enabled": boolean, "prefix": "string" }, "accessRules": { "allowPublicOverrides": boolean, "getObject": "string" }, "arn": "string", "bundleId": "string", "createdAt": number, "location": { "availabilityZone": "string", "regionName": "string" Response Syntax API Version 2016-11-28 330 Amazon Lightsail API Reference }, "name": "string", "objectVersioning": "string", "readonlyAccessAccounts": [ "string" ], "resourcesReceivingAccess": [ { "name": "string", "resourceType": "string" } ], "resourceType": "string", "state": { "code": "string", "message": "string" }, "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "url": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accountLevelBpaSync An object that describes the synchronization status of the Amazon S3 account-level block public access feature for your Lightsail buckets. For more information about this feature and how it aﬀects Lightsail buckets, see Block public access for buckets in Amazon Lightsail. Type: AccountLevelBpaSync object Response Elements API Version 2016-11-28 331 Amazon Lightsail buckets An array of objects that describe buckets. Type: Array of Bucket objects nextPageToken API Reference The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBuckets request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Errors API
amazon-lightsail-api-reference-070	amazon-lightsail-api-reference.pdf	70	token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Errors API Version 2016-11-28 332 Amazon Lightsail NotFoundException API Reference Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 333 Amazon Lightsail GetBundles API Reference Returns the bundles that you can apply to an Amazon Lightsail instance when you create it. A bundle describes the speciﬁcations of an instance, such as the monthly cost, amount of memory, the number of vCPUs, amount of storage space, and monthly network data transfer quota. Note Bundles are referred to as instance plans in the Lightsail console. Request Syntax { "appCategory": "string", "includeInactive": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. appCategory Returns a list of bundles that are speciﬁc to Lightsail for Research. Important You must use this parameter to view Lightsail for Research bundles. Type: String Valid Values: LfR Required: No GetBundles API Version 2016-11-28 334 Amazon Lightsail includeInactive API Reference A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request. Type: Boolean Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "bundles": [ { "bundleId": "string", "cpuCount": number, "diskSizeInGb": number, "instanceType": "string", "isActive": boolean, "name": "string", "power": number, "price": number, "publicIpv4AddressCount": number, "ramSizeInGb": number, "supportedAppCategories": [ "string" ], "supportedPlatforms": [ "string" ], "transferPerMonthInGb": number } ], "nextPageToken": "string" } Response Syntax API Version 2016-11-28 335 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. bundles An array of key-value pairs that contains information about the available bundles. Type: Array of Bundle objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetBundles request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 336 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS
amazon-lightsail-api-reference-071	amazon-lightsail-api-reference.pdf	71	view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 337 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 338 Amazon Lightsail GetCertiﬁcates API Reference Returns information about one or more Amazon Lightsail SSL/TLS certiﬁcates. Note To get a summary of a certiﬁcate, omit includeCertificateDetails from your request. The response will include only the certiﬁcate Amazon Resource Name (ARN), certiﬁcate name, domain name, and tags. Request Syntax { "certificateName": "string", "certificateStatuses": [ "string" ], "includeCertificateDetails": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateName The name for the certiﬁcate for which to return information. When omitted, the response includes all of your certiﬁcates in the AWS Region where the request is made. Type: String Required: No certiﬁcateStatuses The status of the certiﬁcates for which to return information. For example, specify ISSUED to return only certiﬁcates with an ISSUED status. GetCertiﬁcates API Version 2016-11-28 339 Amazon Lightsail API Reference When omitted, the response includes all of your certiﬁcates in the AWS Region where the request is made, regardless of their current status. Type: Array of strings Valid Values: PENDING_VALIDATION \| ISSUED \| INACTIVE \| EXPIRED \| VALIDATION_TIMED_OUT \| REVOKED \| FAILED Required: No includeCertiﬁcateDetails Indicates whether to include detailed information about the certiﬁcates in the response. When omitted, the response includes only the certiﬁcate names, Amazon Resource Names (ARNs), domain names, and tags. Type: Boolean Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetCertificates request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "certificates": [ { "certificateArn": "string", "certificateDetail": { "arn": "string", "createdAt": number, "domainName": "string", "domainValidationRecords": [ Response Syntax API Version 2016-11-28 340 API Reference Amazon Lightsail { "dnsRecordCreationState": { "code": "string", "message": "string" }, "domainName": "string", "resourceRecord": { "name": "string", "type": "string", "value": "string" }, "validationStatus": "string" } ], "eligibleToRenew": "string", "inUseResourceCount": number, "issuedAt": number, "issuerCA": "string", "keyAlgorithm": "string", "name": "string", "notAfter": number, "notBefore": number, "renewalSummary": { "domainValidationRecords": [ { "dnsRecordCreationState": { "code": "string", "message": "string" }, "domainName": "string", "resourceRecord": { "name": "string", "type": "string", "value": "string" }, "validationStatus": "string" } ], "renewalStatus": "string", "renewalStatusReason": "string", "updatedAt": number }, "requestFailureReason": "string", "revocationReason": "string", Response Syntax API Version 2016-11-28 341 Amazon Lightsail API Reference "revokedAt": number, "serialNumber": "string", "status": "string", "subjectAlternativeNames": [ "string" ], "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] }, "certificateName": "string", "domainName": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. certiﬁcates An object that describes certiﬁcates. Type: Array of CertiﬁcateSummary objects nextPageToken If NextPageToken is returned there are more results available. The value of NextPageToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Type: String Response Elements API Version 2016-11-28 342 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the
amazon-lightsail-api-reference-072	amazon-lightsail-api-reference.pdf	72	user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 343 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 344 Amazon Lightsail API Reference GetCloudFormationStackRecords Returns the CloudFormation stack record created as a result of the create cloud formation stack operation. An AWS CloudFormation stack is used to create a new Amazon EC2 instance from an exported Lightsail snapshot. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetClouFormationStackRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "cloudFormationStackRecords": [ { "arn": "string", "createdAt": number, GetCloudFormationStackRecords API Version 2016-11-28 345 Amazon Lightsail API Reference "destinationInfo": { "id": "string", "service": "string" }, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "sourceInfo": [ { "arn": "string", "name": "string", "resourceType": "string" } ], "state": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. cloudFormationStackRecords A list of objects describing the CloudFormation stack records. Type: Array of CloudFormationStackRecord objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetCloudFormationStackRecords request and specify the next page token using the pageToken parameter. Response Elements API Version 2016-11-28 346 Amazon Lightsail Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 347 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 348 Amazon Lightsail GetContactMethods API Reference Returns information about the conﬁgured contact methods. Specify a protocol in your request to return information about a speciﬁc contact method. A contact method is used to send you notiﬁcations about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some
amazon-lightsail-api-reference-073	amazon-lightsail-api-reference.pdf	73	• AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 348 Amazon Lightsail GetContactMethods API Reference Returns information about the conﬁgured contact methods. Specify a protocol in your request to return information about a speciﬁc contact method. A contact method is used to send you notiﬁcations about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notiﬁcations in Amazon Lightsail. Request Syntax { "protocols": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. protocols The protocols used to send notiﬁcations, such as Email, or SMS (text messaging). Specify a protocol in your request to return information about a speciﬁc contact method protocol. Type: Array of strings Valid Values: Email \| SMS Required: No Response Syntax { "contactMethods": [ { GetContactMethods API Version 2016-11-28 349 Amazon Lightsail API Reference "arn": "string", "contactEndpoint": "string", "createdAt": number, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "protocol": "string", "resourceType": "string", "status": "string", "supportCode": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. contactMethods An array of objects that describe the contact methods. Type: Array of ContactMethod objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 350 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 351 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 352 Amazon Lightsail API Reference GetContainerAPIMetadata Returns information about Amazon Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. Response Syntax { "metadata": [ { "string" : "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metadata Metadata about Lightsail containers, such as the current version of the Lightsail Control (lightsailctl) plugin. Type: Array of string to string maps Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 ServiceException A general service exception. GetContainerAPIMetadata API Version 2016-11-28 353 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 354 Amazon Lightsail API Reference GetContainerImages Returns the container images that are registered to your Amazon Lightsail container service. Note If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not
amazon-lightsail-api-reference-074	amazon-lightsail-api-reference.pdf	74	• AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 354 Amazon Lightsail API Reference GetContainerImages Returns the container images that are registered to your Amazon Lightsail container service. Note If you created a deployment on your Lightsail container service that uses container images from a public registry like Docker Hub, those images are not returned as part of this action. Those images are not registered to your Lightsail container service. Request Syntax { "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. serviceName The name of the container service for which to return registered container images. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Syntax { "containerImages": [ GetContainerImages API Version 2016-11-28 355 Amazon Lightsail API Reference { "createdAt": number, "digest": "string", "image": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. containerImages An array of objects that describe container images that are registered to the container service. Type: Array of ContainerImage objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 356 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 357 Amazon Lightsail GetContainerLog API Reference Returns the log events of a container of your Amazon Lightsail container service. If your container service has more than one node (i.e., a scale greater than 1), then the log events that are returned for the speciﬁed container are merged from all nodes on your container service. Note Container logs are retained for a certain amount of time. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference. Request Syntax { "containerName": "string", "endTime": number, "filterPattern": "string", "pageToken": "string", "serviceName": "string", "startTime": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. containerName The name of the container that is either running or previously ran on the container service for which to return a log. Type: String Required: Yes endTime The end of the time interval for which to get log data. GetContainerLog API Version 2016-11-28 358 Amazon Lightsail Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. API Reference For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: No ﬁlterPattern The pattern to use to ﬁlter the returned log events to a speciﬁc term. The following are a few examples of ﬁlter patterns that you can specify: • To return all log events, specify a ﬁlter pattern of "". • To exclude log events that contain the ERROR term, and return all other log events, specify a ﬁlter pattern of "-ERROR". • To return log events that contain the ERROR term, specify a ﬁlter pattern of "ERROR". • To return log events that contain both the ERROR and Exception terms, specify a ﬁlter pattern of "ERROR Exception". • To return log events that
amazon-lightsail-api-reference-075	amazon-lightsail-api-reference.pdf	75	use to ﬁlter the returned log events to a speciﬁc term. The following are a few examples of ﬁlter patterns that you can specify: • To return all log events, specify a ﬁlter pattern of "". • To exclude log events that contain the ERROR term, and return all other log events, specify a ﬁlter pattern of "-ERROR". • To return log events that contain the ERROR term, specify a ﬁlter pattern of "ERROR". • To return log events that contain both the ERROR and Exception terms, specify a ﬁlter pattern of "ERROR Exception". • To return log events that contain the ERROR or the Exception term, specify a ﬁlter pattern of "?ERROR ?Exception". Type: String Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetContainerLog request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Request Parameters API Version 2016-11-28 359 API Reference Amazon Lightsail Type: String Required: No serviceName The name of the container service for which to get a container log. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes startTime The start of the time interval for which to get log data. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: No Response Syntax { "logEvents": [ { "createdAt": number, "message": "string" } Response Syntax API Version 2016-11-28 360 Amazon Lightsail API Reference ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. logEvents An array of objects that describe the log events of a container. Type: Array of ContainerServiceLogEvent objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetContainerLog request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 361 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2016-11-28 362 Amazon Lightsail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 363 Amazon Lightsail API Reference GetContainerServiceDeployments Returns the deployments for your Amazon Lightsail container service A deployment speciﬁes the settings, such as the ports and launch command, of containers that are deployed to your container service. The deployments are ordered by version in ascending order. The newest version is listed at the top of the response. Note A set number of deployments are kept before the oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference. Request Syntax { "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. serviceName The name of the container service for which to return deployments. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes GetContainerServiceDeployments API Version 2016-11-28 364 API Reference Amazon Lightsail Response Syntax { "deployments": [ { "containers": { "string" :
amazon-lightsail-api-reference-076	amazon-lightsail-api-reference.pdf	76	oldest one is replaced with the newest one. For more information, see Amazon Lightsail endpoints and quotas in the AWS General Reference. Request Syntax { "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. serviceName The name of the container service for which to return deployments. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes GetContainerServiceDeployments API Version 2016-11-28 364 API Reference Amazon Lightsail Response Syntax { "deployments": [ { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 365 Amazon Lightsail deployments API Reference An array of objects that describe deployments for a container service. Type: Array of ContainerServiceDeployment objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 366 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 367 Amazon Lightsail API Reference GetContainerServiceMetricData Returns the data points of a speciﬁc metric of your Amazon Lightsail container service. Metrics report the utilization of your resources. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. Request Syntax { "endTime": number, "metricName": "string", "period": number, "serviceName": "string", "startTime": number, "statistics": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The end time of the time period. Type: Timestamp Required: Yes metricName The metric for which you want to return information. Valid container service metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. • CPUUtilization - The average percentage of compute units that are currently in use across all nodes of the container service. This metric identiﬁes the processing power required to run containers on each node of the container service. GetContainerServiceMetricData API Version 2016-11-28 368 Amazon Lightsail API Reference Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. • MemoryUtilization - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identiﬁes the memory required to run containers on each node of the container service. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. Type: String Valid Values: CPUUtilization \| MemoryUtilization Required: Yes period The granularity, in seconds, of the returned data points. All container service metric data is available in 5-minute (300 seconds) granularity. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes serviceName The name of the container service for which to get metric data. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes startTime The start time of the time period. Type: Timestamp Request Parameters API Version 2016-11-28 369 Amazon Lightsail Required: Yes statistics The statistic for the metric. The following statistics are available: API Reference • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application.
amazon-lightsail-api-reference-077	amazon-lightsail-api-reference.pdf	77	granularity. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes serviceName The name of the container service for which to get metric data. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes startTime The start time of the time period. Type: Timestamp Request Parameters API Version 2016-11-28 369 Amazon Lightsail Required: Yes statistics The statistic for the metric. The following statistics are available: API Reference • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Required: Yes Response Syntax { "metricData": [ { "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" Response Syntax API Version 2016-11-28 370 API Reference Amazon Lightsail } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: CPUUtilization \| MemoryUtilization Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 371 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 372 Amazon Lightsail API Reference GetContainerServicePowers Returns the list of powers that can be speciﬁed for your Amazon Lightsail container services. The power speciﬁes the amount of memory, the number of vCPUs, and the base price of the container service. Response Syntax { "powers": [ { "cpuCount": number, "isActive": boolean, "name": "string", "powerId": "string", "price": number, "ramSizeInGb": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. powers An array of objects that describe the powers that can be speciﬁed for a container service. Type: Array of ContainerServicePower objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. GetContainerServicePowers API Version 2016-11-28 373 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also
amazon-lightsail-api-reference-078	amazon-lightsail-api-reference.pdf	78	Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2016-11-28 374 Amazon Lightsail • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 375 Amazon Lightsail API Reference GetContainerServices Returns information about one or more of your Amazon Lightsail container services. Request Syntax { "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. serviceName The name of the container service for which to return information. When omitted, the response includes all of your container services in the AWS Region where the request is made. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: No Response Syntax { "containerServices": [ { "arn": "string", "containerServiceName": "string", "createdAt": number, "currentDeployment": { "containers": { "string" : { GetContainerServices API Version 2016-11-28 376 Amazon Lightsail API Reference "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "isDisabled": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "nextDeployment": { "containers": { "string" : { "command": [ "string" ], "environment": { "string" : "string" }, "image": "string", "ports": { "string" : "string" } } }, Response Syntax API Version 2016-11-28 377 Amazon Lightsail API Reference "createdAt": number, "publicEndpoint": { "containerName": "string", "containerPort": number, "healthCheck": { "healthyThreshold": number, "intervalSeconds": number, "path": "string", "successCodes": "string", "timeoutSeconds": number, "unhealthyThreshold": number } }, "state": "string", "version": number }, "power": "string", "powerId": "string", "principalArn": "string", "privateDomainName": "string", "privateRegistryAccess": { "ecrImagePullerRole": { "isActive": boolean, "principalArn": "string" } }, "publicDomainNames": { "string" : [ "string" ] }, "resourceType": "string", "scale": number, "state": "string", "stateDetail": { "code": "string", "message": "string" }, "tags": [ { "key": "string", "value": "string" } ], "url": "string" } Response Syntax API Version 2016-11-28 378 API Reference Amazon Lightsail ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. containerServices An array of objects that describe one or more container services. Type: Array of ContainerService objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Response Elements API Version 2016-11-28 379 Amazon Lightsail HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 380 Amazon Lightsail GetCostEstimate API Reference Retrieves information about the cost estimate for a speciﬁed resource. A cost estimate will not generate for a resource that has been deleted. Request Syntax { "endTime": number, "resourceName": "string", "startTime": number }
amazon-lightsail-api-reference-079	amazon-lightsail-api-reference.pdf	79	following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 380 Amazon Lightsail GetCostEstimate API Reference Retrieves information about the cost estimate for a speciﬁed resource. A cost estimate will not generate for a resource that has been deleted. Request Syntax { "endTime": number, "resourceName": "string", "startTime": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The cost estimate end time. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you want to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: Yes resourceName The resource name. Type: String GetCostEstimate API Version 2016-11-28 381 Amazon Lightsail Pattern: \w[\w\-]\w Required: Yes startTime The cost estimate start time. Constraints: API Reference • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you want to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: Yes Response Syntax { "resourcesBudgetEstimate": [ { "costEstimates": [ { "resultsByTime": [ { "currency": "string", "pricingUnit": "string", "timePeriod": { "end": number, "start": number }, "unit": number, "usageCost": number } ], "usageType": "string" } Response Syntax API Version 2016-11-28 382 Amazon Lightsail API Reference ], "endTime": number, "resourceName": "string", "resourceType": "string", "startTime": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. resourcesBudgetEstimate Returns the estimate's forecasted cost or usage. Type: Array of ResourceBudgetEstimate objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 383 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 384 Amazon Lightsail GetDisk Returns information about a speciﬁc block storage disk. API Reference Request Syntax { "diskName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskName The name of the disk (my-disk). Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "disk": { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" } ], "arn": "string", GetDisk API Version 2016-11-28 385 Amazon Lightsail API Reference "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. disk An object containing information about the disk. Type: Disk object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 386 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid
amazon-lightsail-api-reference-080	amazon-lightsail-api-reference.pdf	80	}, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. disk An object containing information about the disk. Type: Disk object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 386 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 387 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 388 Amazon Lightsail GetDisks API Reference Returns information about all block storage disks in your AWS account and region. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetDisks request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "disks": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" GetDisks API Version 2016-11-28 389 API Reference Amazon Lightsail } ], "arn": "string", "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. disks An array of objects containing information about all block storage disks. Type: Array of Disk objects Response Elements API Version 2016-11-28 390 Amazon Lightsail nextPageToken API Reference The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDisks request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Errors API Version 2016-11-28 391 Amazon Lightsail NotFoundException API Reference Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API
amazon-lightsail-api-reference-081	amazon-lightsail-api-reference.pdf	81	available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Errors API Version 2016-11-28 391 Amazon Lightsail NotFoundException API Reference Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 392 Amazon Lightsail GetDiskSnapshot Returns information about a speciﬁc block storage disk snapshot. API Reference Request Syntax { "diskSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. diskSnapshotName The name of the disk snapshot (my-disk-snapshot). Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "diskSnapshot": { "arn": "string", "createdAt": number, "fromDiskArn": "string", "fromDiskName": "string", "fromInstanceArn": "string", "fromInstanceName": "string", "isFromAutoSnapshot": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, GetDiskSnapshot API Version 2016-11-28 393 Amazon Lightsail API Reference "name": "string", "progress": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. diskSnapshot An object containing information about the disk snapshot. Type: DiskSnapshot object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 394 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 395 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 396 Amazon Lightsail GetDiskSnapshots API Reference Returns information about all block storage disk snapshots in your AWS account and region. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetDiskSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "diskSnapshots": [ { "arn": "string", "createdAt": number, "fromDiskArn": "string", "fromDiskName": "string", "fromInstanceArn": "string", "fromInstanceName": "string", "isFromAutoSnapshot": boolean, GetDiskSnapshots API Version 2016-11-28 397 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "progress": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. diskSnapshots An array of objects containing information about all block storage disk snapshots. Type: Array of DiskSnapshot
amazon-lightsail-api-reference-082	amazon-lightsail-api-reference.pdf	82	{ "arn": "string", "createdAt": number, "fromDiskArn": "string", "fromDiskName": "string", "fromInstanceArn": "string", "fromInstanceName": "string", "isFromAutoSnapshot": boolean, GetDiskSnapshots API Version 2016-11-28 397 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "progress": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. diskSnapshots An array of objects containing information about all block storage disk snapshots. Type: Array of DiskSnapshot objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDiskSnapshots request and specify the next page token using the pageToken parameter. Type: String Response Elements API Version 2016-11-28 398 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 399 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 400 Amazon Lightsail API Reference GetDistributionBundles Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions. A distribution bundle speciﬁes the monthly network transfer quota and monthly cost of your distribution. Response Syntax { "bundles": [ { "bundleId": "string", "isActive": boolean, "name": "string", "price": number, "transferPerMonthInGb": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. bundles An object that describes a distribution bundle. Type: Array of DistributionBundle objects Errors For information about the errors that are common to all actions, see Common Errors. GetDistributionBundles API Version 2016-11-28 401 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 402 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 403 Amazon Lightsail API Reference GetDistributionLatestCacheReset Returns the timestamp and status of the last cache reset of a speciﬁc Amazon Lightsail content delivery network (CDN) distribution. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions,
amazon-lightsail-api-reference-083	amazon-lightsail-api-reference.pdf	83	• AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 403 Amazon Lightsail API Reference GetDistributionLatestCacheReset Returns the timestamp and status of the last cache reset of a speciﬁc Amazon Lightsail content delivery network (CDN) distribution. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution for which to return the timestamp of the last cache reset. Use the GetDistributions action to get a list of distribution names that you can specify. When omitted, the response includes the latest cache reset timestamp of all your distributions. Type: String Pattern: \w[\w\-]\w Required: No Response Syntax { "createTime": number, "status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetDistributionLatestCacheReset API Version 2016-11-28 404 Amazon Lightsail API Reference The following data is returned in JSON format by the service. createTime The timestamp of the last cache reset (1479734909.17) in Unix time format. Type: Timestamp status The status of the last cache reset. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. Errors API Version 2016-11-28 405 Amazon Lightsail HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 406 Amazon Lightsail API Reference GetDistributionMetricData Returns the data points of a speciﬁc metric for an Amazon Lightsail content delivery network (CDN) distribution. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. Request Syntax { "distributionName": "string", "endTime": number, "metricName": "string", "period": number, "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution for which to get metric data. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]\w Required: Yes endTime The end of the time interval for which to get metric data. GetDistributionMetricData API Version 2016-11-28 407 Amazon Lightsail Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. API Reference For example, if you wish to use an end time of October 1, 2018, at 9 PM UTC, specify 1538427600 as the end time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: Yes metricName The metric for which you want to return information. Valid distribution metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests. Statistics: The
amazon-lightsail-api-reference-084	amazon-lightsail-api-reference.pdf	84	statistics to include in your request, and the published unit value. • Requests - The total number of viewer requests received by your Lightsail distribution, for all HTTP methods, and for both HTTP and HTTPS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. • BytesDownloaded - The number of bytes downloaded by viewers for GET, HEAD, and OPTIONS requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. • BytesUploaded - The number of bytes uploaded to your origin by your Lightsail distribution, using POST and PUT requests. Statistics: The most useful statistic is Sum. Unit: The published unit is None. • TotalErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 4xx or 5xx. Request Parameters API Version 2016-11-28 408 Amazon Lightsail API Reference Statistics: The most useful statistic is Average. Unit: The published unit is Percent. • 4xxErrorRate - The percentage of all viewer requests for which the response's HTTP status cod was 4xx. In these cases, the client or client viewer may have made an error. For example, a status code of 404 (Not Found) means that the client requested an object that could not be found. Statistics: The most useful statistic is Average. Unit: The published unit is Percent. • 5xxErrorRate - The percentage of all viewer requests for which the response's HTTP status code was 5xx. In these cases, the origin server did not satisfy the requests. For example, a status code of 503 (Service Unavailable) means that the origin server is currently unavailable. Statistics: The most useful statistic is Average. Unit: The published unit is Percent. Type: String Valid Values: Requests \| BytesDownloaded \| BytesUploaded \| TotalErrorRate \| Http4xxErrorRate \| Http5xxErrorRate Required: Yes period The granularity, in seconds, for the metric data points that will be returned. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes startTime The start of the time interval for which to get metric data. Constraints: Request Parameters API Version 2016-11-28 409 Amazon Lightsail API Reference • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, specify 1538424000 as the start time. You can convert a human-friendly time to Unix time format using a converter like Epoch converter. Type: Timestamp Required: Yes statistics The statistic for the metric. The following statistics are available: • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Required: Yes unit The unit for the metric data request. Request Parameters API Version 2016-11-28 410 Amazon Lightsail API Reference Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter. Type: String Valid Values: Seconds \| Microseconds \| Milliseconds \| Bytes \| Kilobytes \| Megabytes \| Gigabytes \| Terabytes \| Bits \| Kilobits \| Megabits \| Gigabits \| Terabits \| Percent \| Count \| Bytes/Second \| Kilobytes/Second \| Megabytes/Second \| Gigabytes/Second \| Terabytes/Second \| Bits/Second \| Kilobits/Second \| Megabits/Second \| Gigabits/Second \| Terabits/Second \| Count/Second \| None Required: Yes Response Syntax { "metricData": [ { "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Response Syntax API Version 2016-11-28 411 Amazon Lightsail API Reference Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: Requests \| BytesDownloaded \| BytesUploaded \| TotalErrorRate \| Http4xxErrorRate \| Http5xxErrorRate Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated
amazon-lightsail-api-reference-085	amazon-lightsail-api-reference.pdf	85	Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Response Syntax API Version 2016-11-28 411 Amazon Lightsail API Reference Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: Requests \| BytesDownloaded \| BytesUploaded \| TotalErrorRate \| Http4xxErrorRate \| Http5xxErrorRate Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 412 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 413 Amazon Lightsail GetDistributions API Reference Returns information about one or more of your Amazon Lightsail content delivery network (CDN) distributions. Request Syntax { "distributionName": "string", "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution for which to return information. When omitted, the response includes all of your distributions in the AWS Region where the request is made. Type: String Pattern: \w[\w\-]*\w Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetDistributions request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No GetDistributions API Version 2016-11-28 414 API Reference Amazon Lightsail Response Syntax { "distributions": [ { "ableToUpdateBundle": boolean, "alternativeDomainNames": [ "string" ], "arn": "string", "bundleId": "string", "cacheBehaviors": [ { "behavior": "string", "path": "string" } ], "cacheBehaviorSettings": { "allowedHTTPMethods": "string", "cachedHTTPMethods": "string", "defaultTTL": number, "forwardedCookies": { "cookiesAllowList": [ "string" ], "option": "string" }, "forwardedHeaders": { "headersAllowList": [ "string" ], "option": "string" }, "forwardedQueryStrings": { "option": boolean, "queryStringsAllowList": [ "string" ] }, "maximumTTL": number, "minimumTTL": number }, "certificateName": "string", "createdAt": number, "defaultCacheBehavior": { "behavior": "string" }, "domainName": "string", "ipAddressType": "string", "isEnabled": boolean, "location": { Response Syntax API Version 2016-11-28 415 Amazon Lightsail API Reference "availabilityZone": "string", "regionName": "string" }, "name": "string", "origin": { "name": "string", "protocolPolicy": "string", "regionName": "string", "resourceType": "string", "responseTimeout": number }, "originPublicDNS": "string", "resourceType": "string", "status": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "viewerMinimumTlsProtocolVersion": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. distributions An array of objects that describe your distributions. Type: Array of LightsailDistribution objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. Response Elements API Version 2016-11-28 416 Amazon Lightsail API Reference To get the next page of results, perform another GetDistributions request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP
amazon-lightsail-api-reference-086	amazon-lightsail-api-reference.pdf	86	about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 417 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 418 Amazon Lightsail GetDomain Returns information about a speciﬁc domain recordset. API Reference Request Syntax { "domainName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. domainName The domain name for which your want to return information about. Type: String Required: Yes Response Syntax { "domain": { "arn": "string", "createdAt": number, "domainEntries": [ { "id": "string", "isAlias": boolean, "name": "string", "options": { "string" : "string" }, "target": "string", "type": "string" } GetDomain API Version 2016-11-28 419 API Reference Amazon Lightsail ], "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "registeredDomainDelegationInfo": { "nameServersUpdateState": { "code": "string", "message": "string" }, "r53HostedZoneDeletionState": { "code": "string", "message": "string" } }, "resourceType": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. domain An array of key-value pairs containing information about your get domain request. Type: Domain object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 420 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 421 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 422 Amazon Lightsail GetDomains Returns a list of all domains in the user's account. API Reference Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "domains": [ { "arn": "string", "createdAt": number, "domainEntries": [ { "id": "string", "isAlias": boolean, GetDomains API Version 2016-11-28 423 Amazon
amazon-lightsail-api-reference-087	amazon-lightsail-api-reference.pdf	87	Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetDomains request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "domains": [ { "arn": "string", "createdAt": number, "domainEntries": [ { "id": "string", "isAlias": boolean, GetDomains API Version 2016-11-28 423 Amazon Lightsail API Reference "name": "string", "options": { "string" : "string" }, "target": "string", "type": "string" } ], "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "registeredDomainDelegationInfo": { "nameServersUpdateState": { "code": "string", "message": "string" }, "r53HostedZoneDeletionState": { "code": "string", "message": "string" } }, "resourceType": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2016-11-28 424 Amazon Lightsail domains API Reference An array of key-value pairs containing information about each of the domain entries in the user's account. Type: Array of Domain objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetDomains request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Errors API Version 2016-11-28 425 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 426 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 427 Amazon Lightsail API Reference GetExportSnapshotRecords Returns all export snapshot records created as a result of the export snapshot operation. An export snapshot record can be used to create a new Amazon EC2 instance and its related resources with the CreateCloudFormationStack action. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetExportSnapshotRecords request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "exportSnapshotRecords": [ { "arn": "string", "createdAt": number, "destinationInfo": { GetExportSnapshotRecords API Version 2016-11-28 428 Amazon Lightsail API Reference "id": "string", "service": "string" }, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "sourceInfo": { "arn": "string", "createdAt": number, "diskSnapshotInfo": { "sizeInGb": number }, "fromResourceArn": "string", "fromResourceName": "string", "instanceSnapshotInfo": { "fromBlueprintId": "string", "fromBundleId": "string", "fromDiskInfo": [ { "isSystemDisk": boolean, "name": "string", "path": "string", "sizeInGb": number } ] }, "name": "string", "resourceType": "string" }, "state": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2016-11-28 429 Amazon Lightsail exportSnapshotRecords A list of objects describing the export snapshot records. Type: Array of ExportSnapshotRecord objects nextPageToken API Reference The token
amazon-lightsail-api-reference-088	amazon-lightsail-api-reference.pdf	88	{ "arn": "string", "createdAt": number, "diskSnapshotInfo": { "sizeInGb": number }, "fromResourceArn": "string", "fromResourceName": "string", "instanceSnapshotInfo": { "fromBlueprintId": "string", "fromBundleId": "string", "fromDiskInfo": [ { "isSystemDisk": boolean, "name": "string", "path": "string", "sizeInGb": number } ] }, "name": "string", "resourceType": "string" }, "state": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2016-11-28 429 Amazon Lightsail exportSnapshotRecords A list of objects describing the export snapshot records. Type: Array of ExportSnapshotRecord objects nextPageToken API Reference The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetExportSnapshotRecords request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Errors API Version 2016-11-28 430 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 431 Amazon Lightsail API Reference See Also API Version 2016-11-28 432 Amazon Lightsail GetInstance API Reference Returns information about a speciﬁc Amazon Lightsail instance, which is a virtual private server. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "instance": { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" } ], "arn": "string", "blueprintId": "string", GetInstance API Version 2016-11-28 433 Amazon Lightsail API Reference "blueprintName": "string", "bundleId": "string", "createdAt": number, "hardware": { "cpuCount": number, "disks": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" } ], "arn": "string", "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], Response Syntax API Version 2016-11-28 434 Amazon Lightsail API Reference "ramSizeInGb": number }, "ipAddressType": "string", "ipv6Addresses": [ "string" ], "isStaticIp": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "metadataOptions": { "httpEndpoint": "string", "httpProtocolIpv6": "string", "httpPutResponseHopLimit": number, "httpTokens": "string", "state": "string" }, "name": "string", "networking": { "monthlyTransfer": { "gbPerMonthAllocated": number }, "ports": [ { "accessDirection": "string", "accessFrom": "string", "accessType": "string", "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "commonName": "string", "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "toPort": number } ] }, "privateIpAddress": "string", "publicIpAddress": "string", "resourceType": "string", "sshKeyName": "string", "state": { "code": number, "name": "string" }, Response Syntax API Version 2016-11-28 435 Amazon Lightsail API Reference "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. instance An array of key-value pairs containing information about the speciﬁed instance. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still
amazon-lightsail-api-reference-089	amazon-lightsail-api-reference.pdf	89	{ "key": "string", "value": "string" } ], "username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. instance An array of key-value pairs containing information about the speciﬁed instance. Type: Instance object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 436 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 437 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 438 Amazon Lightsail API Reference GetInstanceAccessDetails Returns temporary SSH keys you can use to connect to a speciﬁc virtual private server, or instance. The get instance access details operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string", "protocol": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance to access. Type: String Pattern: \w[\w\-]*\w Required: Yes protocol The protocol to use to connect to your instance. Defaults to ssh. Type: String Valid Values: ssh \| rdp Required: No GetInstanceAccessDetails API Version 2016-11-28 439 API Reference Amazon Lightsail Response Syntax { "accessDetails": { "certKey": "string", "expiresAt": number, "hostKeys": [ { "algorithm": "string", "fingerprintSHA1": "string", "fingerprintSHA256": "string", "notValidAfter": number, "notValidBefore": number, "publicKey": "string", "witnessedAt": number } ], "instanceName": "string", "ipAddress": "string", "ipv6Addresses": [ "string" ], "password": "string", "passwordData": { "ciphertext": "string", "keyPairName": "string" }, "privateKey": "string", "protocol": "string", "username": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. accessDetails An array of key-value pairs containing information about a get instance access request. Type: InstanceAccessDetails object Response Syntax API Version 2016-11-28 440 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 441 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK
amazon-lightsail-api-reference-090	amazon-lightsail-api-reference.pdf	90	Errors API Version 2016-11-28 441 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 442 Amazon Lightsail API Reference GetInstanceMetricData Returns the data points for the speciﬁed Amazon Lightsail instance metric, given an instance name. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. Request Syntax { "endTime": number, "instanceName": "string", "metricName": "string", "period": number, "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The end time of the time period. Type: Timestamp Required: Yes instanceName The name of the instance for which you want to get metrics data. Type: String Pattern: \w[\w\-]*\w GetInstanceMetricData API Version 2016-11-28 443 Amazon Lightsail Required: Yes metricName API Reference The metric for which you want to return information. Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. • BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. • BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%. Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Seconds. • CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identiﬁes the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. Request Parameters API Version 2016-11-28 444 Amazon Lightsail API Reference • NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identiﬁes the volume of incoming network traﬃc to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to ﬁnd Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. • NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identiﬁes the volume of outgoing network traﬃc from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5- minute intervals, divide the reported number by 300 to ﬁnd Bytes/second. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. • StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check.
amazon-lightsail-api-reference-091	amazon-lightsail-api-reference.pdf	91	check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • MetadataNoToken - Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes Request Parameters API Version 2016-11-28 445 Amazon Lightsail API Reference accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. Type: String Valid Values: CPUUtilization \| NetworkIn \| NetworkOut \| StatusCheckFailed \| StatusCheckFailed_Instance \| StatusCheckFailed_System \| BurstCapacityTime \| BurstCapacityPercentage \| MetadataNoToken Required: Yes period The granularity, in seconds, of the returned data points. The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes startTime The start time of the time period. Type: Timestamp Required: Yes statistics The statistic for the metric. The following statistics are available: Request Parameters API Version 2016-11-28 446 Amazon Lightsail API Reference • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Required: Yes unit The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units to specify with each available metric, see the metricName parameter. Type: String Valid Values: Seconds \| Microseconds \| Milliseconds \| Bytes \| Kilobytes \| Megabytes \| Gigabytes \| Terabytes \| Bits \| Kilobits \| Megabits \| Gigabits \| Terabits \| Percent \| Count \| Bytes/Second \| Kilobytes/Second \| Megabytes/Second \| Gigabytes/Second \| Terabytes/Second \| Bits/Second \| Kilobits/Second \| Megabits/Second \| Gigabits/Second \| Terabits/Second \| Count/Second \| None Required: Yes Response Syntax { "metricData": [ { Response Syntax API Version 2016-11-28 447 Amazon Lightsail API Reference "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: CPUUtilization \| NetworkIn \| NetworkOut \| StatusCheckFailed \| StatusCheckFailed_Instance \| StatusCheckFailed_System \| BurstCapacityTime \| BurstCapacityPercentage \| MetadataNoToken Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 448 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400
amazon-lightsail-api-reference-092	amazon-lightsail-api-reference.pdf	92	the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 448 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 449 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 450 Amazon Lightsail API Reference GetInstancePortStates Returns the ﬁrewall port states for a speciﬁc Amazon Lightsail instance, the IP addresses allowed to connect to the instance through the ports, and the protocol. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance for which to return ﬁrewall port states. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "portStates": [ { "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "state": "string", "toPort": number } GetInstancePortStates API Version 2016-11-28 451 Amazon Lightsail ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. portStates An array of objects that describe the ﬁrewall port states for the speciﬁed instance. Type: Array of InstancePortState objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 452 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 453 Amazon Lightsail API Reference See Also API Version 2016-11-28 454 Amazon Lightsail GetInstances API Reference Returns information about all Amazon Lightsail virtual private servers, or instances. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "instances": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" GetInstances API Version 2016-11-28
amazon-lightsail-api-reference-093	amazon-lightsail-api-reference.pdf	93	information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstances request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "instances": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" GetInstances API Version 2016-11-28 455 API Reference Amazon Lightsail } ], "arn": "string", "blueprintId": "string", "blueprintName": "string", "bundleId": "string", "createdAt": number, "hardware": { "cpuCount": number, "disks": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" } ], "arn": "string", "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" Response Syntax API Version 2016-11-28 456 API Reference Amazon Lightsail } ] } ], "ramSizeInGb": number }, "ipAddressType": "string", "ipv6Addresses": [ "string" ], "isStaticIp": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "metadataOptions": { "httpEndpoint": "string", "httpProtocolIpv6": "string", "httpPutResponseHopLimit": number, "httpTokens": "string", "state": "string" }, "name": "string", "networking": { "monthlyTransfer": { "gbPerMonthAllocated": number }, "ports": [ { "accessDirection": "string", "accessFrom": "string", "accessType": "string", "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "commonName": "string", "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "toPort": number } ] }, "privateIpAddress": "string", "publicIpAddress": "string", "resourceType": "string", "sshKeyName": "string", Response Syntax API Version 2016-11-28 457 Amazon Lightsail API Reference "state": { "code": number, "name": "string" }, "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "username": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. instances An array of key-value pairs containing information about your instances. Type: Array of Instance objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstances request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 458 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 459 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Examples In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference. You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you conﬁgure the tools. When you use these tools, you don't need to learn how to sign requests yourself. Get instances The following example returns all instances in the us-west-2 AWS Region. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.GetInstances Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20201019T144314Z Authorization: AUTHPARAMS Signature=AUTHPARAMS Content-Length: 2 {} Sample Response HTTP/1.1 200 OK Server: Server Date: Mon, 22 Apr 2024 14:43:17 GMT Examples API Version 2016-11-28 460 Amazon Lightsail API Reference Content-Type: application/x-amz-json-1.1 Content-Length: 2750 x-amzn-RequestId: aaa1993d-8d60-4a13-899c-bEXAMPLE9bc7 Connection: keep-alive { "instances": [ { "addOns": [ { "name": "AutoSnapshot", "snapshotTimeOfDay": "06:00", "status": "Enabled" } ], "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/93d19bc4- bd2a-4deb-9048-4EXAMPLE4236", "blueprintId": "wordpress", "blueprintName": "WordPress", "bundleId": "micro_3_0", "createdAt": 1.590771192493E9, "hardware":
amazon-lightsail-api-reference-094	amazon-lightsail-api-reference.pdf	94	learn how to sign requests yourself. Get instances The following example returns all instances in the us-west-2 AWS Region. Sample Request POST / HTTP/1.1 Host: lightsail.us-west-2.amazonaws.com Accept-Encoding: identity X-Amz-Target: Lightsail_20161128.GetInstances Content-Type: application/x-amz-json-1.1 User-Agent: AGENT X-Amz-Date: 20201019T144314Z Authorization: AUTHPARAMS Signature=AUTHPARAMS Content-Length: 2 {} Sample Response HTTP/1.1 200 OK Server: Server Date: Mon, 22 Apr 2024 14:43:17 GMT Examples API Version 2016-11-28 460 Amazon Lightsail API Reference Content-Type: application/x-amz-json-1.1 Content-Length: 2750 x-amzn-RequestId: aaa1993d-8d60-4a13-899c-bEXAMPLE9bc7 Connection: keep-alive { "instances": [ { "addOns": [ { "name": "AutoSnapshot", "snapshotTimeOfDay": "06:00", "status": "Enabled" } ], "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/93d19bc4- bd2a-4deb-9048-4EXAMPLE4236", "blueprintId": "wordpress", "blueprintName": "WordPress", "bundleId": "micro_3_0", "createdAt": 1.590771192493E9, "hardware": { "cpuCount": 2, "disks": [ { "attachedTo": "WordPress-1", "attachmentState": "attached", "createdAt": 1.590771192493E9, "iops": 120, "isSystemDisk": true, "path": "/dev/xvda", "sizeInGb": 40 } ], "ramSizeInGb": 1.0 }, "isStaticIp": true, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "name": "WordPress-1", "networking": { "monthlyTransfer": {"gbPerMonthAllocated": 2048}, Examples API Version 2016-11-28 461 Amazon Lightsail "ports": [ { "accessDirection": "inbound", "accessFrom": "Anywhere (0.0.0.0/0)", API Reference "accessType": "public", "cidrListAliases": [], "cidrs": ["0.0.0.0/0"], "commonName": "", "fromPort": 80, "protocol": "tcp", "toPort": 80 }, { "accessDirection": "inbound", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "cidrListAliases": [], "cidrs": ["0.0.0.0/0"], "commonName": "", "fromPort": 22, "protocol": "tcp", "toPort": 22 }, { "accessDirection": "inbound", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "cidrListAliases": [], "cidrs": ["0.0.0.0/0"], "commonName": "", "fromPort": 443, "protocol": "tcp", "toPort": 443 } ] }, "privateIpAddress": "192.0.2.1", "publicIpAddress": "192.0.2.2", "resourceType": "Instance", "sshKeyName": "LightsailDefaultKeyPair", "state": { "code": 16, "name": "running" }, Examples API Version 2016-11-28 462 Amazon Lightsail API Reference "supportCode": "1234567890/i-0dEXAMPLE1abad00e", "tags": [], "username": "bitnami" }, { "arn": "arn:aws:lightsail:us-west-2:111122223333:Instance/ bd08b156-5c35-4b89-9e90-8EXAMPLEd006", "blueprintId": "amazon_linux_2023", "blueprintName": "Amazon Linux 2023", "bundleId": "nano_3_0", "createdAt": 1.591802416964E9, "hardware": { "cpuCount": 2, "disks": [ { "attachedTo": "Amazon_Linux-2023", "attachmentState": "attached", "createdAt": 1.591802416964E9, "iops": 3000, "isSystemDisk": true, "path": "/dev/xvda", "sizeInGb": 20 } ], "ramSizeInGb": 0.5 }, "isStaticIp": true, "location": { "availabilityZone": "us-west-2a", "regionName": "us-west-2" }, "name": "Amazon_Linux-1", "networking": { "monthlyTransfer": {"gbPerMonthAllocated": 1024}, "ports": [ { "accessDirection": "inbound", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "cidrListAliases": [], "cidrs": ["0.0.0.0/0"], "commonName": "", "fromPort": 80, "protocol": "tcp", Examples API Version 2016-11-28 463 Amazon Lightsail API Reference "toPort": 80 }, { "accessDirection": "inbound", "accessFrom": "Anywhere (0.0.0.0/0)", "accessType": "public", "cidrListAliases": [], "cidrs": ["0.0.0.0/0"], "commonName": "", "fromPort": 22, "protocol": "tcp", "toPort": 22 } ] }, "privateIpAddress": "192.0.2.3", "publicIpAddress": "192.0.2.4", "resourceType": "Instance", "sshKeyName": "LightsailDefaultKeyPair", "state": { "code": 16, "name": "running" }, "supportCode": "1234567890/i-0dEXAMPLE1abad00e", "tags": [], "username": "ec2-user" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2016-11-28 464 Amazon Lightsail • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 465 Amazon Lightsail API Reference GetInstanceSnapshot Returns information about a speciﬁc instance snapshot. Request Syntax { "instanceSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceSnapshotName The name of the snapshot for which you are requesting information. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "instanceSnapshot": { "arn": "string", "createdAt": number, "fromAttachedDisks": [ { "addOns": [ { "duration": "string", "name": "string", "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" GetInstanceSnapshot API Version 2016-11-28 466 API Reference Amazon Lightsail } ], "arn": "string", "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "fromBlueprintId": "string", "fromBundleId": "string", "fromInstanceArn": "string", "fromInstanceName": "string", "isFromAutoSnapshot": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "progress": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", Response Syntax API Version 2016-11-28 467 Amazon Lightsail API Reference "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. instanceSnapshot An array of key-value pairs containing information about the results of your get instance snapshot request. Type: InstanceSnapshot object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 468 Amazon
amazon-lightsail-api-reference-095	amazon-lightsail-api-reference.pdf	95	key-value pairs containing information about the results of your get instance snapshot request. Type: InstanceSnapshot object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 468 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 469 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 470 Amazon Lightsail API Reference GetInstanceSnapshots Returns all instance snapshots for the user's account. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetInstanceSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "instanceSnapshots": [ { "arn": "string", "createdAt": number, "fromAttachedDisks": [ { "addOns": [ { "duration": "string", "name": "string", GetInstanceSnapshots API Version 2016-11-28 471 Amazon Lightsail API Reference "nextSnapshotTimeOfDay": "string", "snapshotTimeOfDay": "string", "status": "string", "threshold": "string" } ], "arn": "string", "attachedTo": "string", "attachmentState": "string", "autoMountStatus": "string", "createdAt": number, "gbInUse": number, "iops": number, "isAttached": boolean, "isSystemDisk": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "path": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "fromBlueprintId": "string", "fromBundleId": "string", "fromInstanceArn": "string", "fromInstanceName": "string", "isFromAutoSnapshot": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "progress": "string", Response Syntax API Version 2016-11-28 472 Amazon Lightsail API Reference "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. instanceSnapshots An array of key-value pairs containing information about the results of your get instance snapshots request. Type: Array of InstanceSnapshot objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetInstanceSnapshots request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 473 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 474 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated.
amazon-lightsail-api-reference-096	amazon-lightsail-api-reference.pdf	96	validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 474 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 475 Amazon Lightsail GetInstanceState API Reference Returns the state of a speciﬁc instance. Works on one instance at a time. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance to get state information about. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "state": { "code": number, "name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetInstanceState API Version 2016-11-28 476 Amazon Lightsail state The state of the instance. Type: InstanceState object Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 477 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 478 API Reference Amazon Lightsail GetKeyPair Returns information about a speciﬁc key pair. Request Syntax { "keyPairName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. keyPairName The name of the key pair for which you are requesting information. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "keyPair": { "arn": "string", "createdAt": number, "fingerprint": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "supportCode": "string", GetKeyPair API Version 2016-11-28 479 Amazon Lightsail API Reference "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. keyPair An array of key-value pairs containing information about the key pair. Type: KeyPair object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 480 Amazon Lightsail Note API Reference Domain and distribution APIs
amazon-lightsail-api-reference-097	amazon-lightsail-api-reference.pdf	97	information about the key pair. Type: KeyPair object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 480 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 481 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 482 Amazon Lightsail GetKeyPairs Returns information about all key pairs in the user's account. API Reference Request Syntax { "includeDefaultKeyPair": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. includeDefaultKeyPair A Boolean value that indicates whether to include the default key pair in the response of your request. Type: Boolean Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetKeyPairs request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { GetKeyPairs API Version 2016-11-28 483 API Reference Amazon Lightsail "keyPairs": [ { "arn": "string", "createdAt": number, "fingerprint": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. keyPairs An array of key-value pairs containing information about the key pairs. Type: Array of KeyPair objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetKeyPairs request and specify the next page token using the pageToken parameter. Response Elements API Version 2016-11-28 484 Amazon Lightsail Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 485 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3
amazon-lightsail-api-reference-098	amazon-lightsail-api-reference.pdf	98	A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 486 Amazon Lightsail GetLoadBalancer Returns information about the speciﬁed Lightsail load balancer. API Reference Request Syntax { "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. loadBalancerName The name of the load balancer. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "loadBalancer": { "arn": "string", "configurationOptions": { "string" : "string" }, "createdAt": number, "dnsName": "string", "healthCheckPath": "string", "httpsRedirectionEnabled": boolean, "instanceHealthSummary": [ { "instanceHealth": "string", GetLoadBalancer API Version 2016-11-28 487 Amazon Lightsail API Reference "instanceHealthReason": "string", "instanceName": "string" } ], "instancePort": number, "ipAddressType": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "protocol": "string", "publicPorts": [ number ], "resourceType": "string", "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "tlsCertificateSummaries": [ { "isAttached": boolean, "name": "string" } ], "tlsPolicyName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. loadBalancer An object containing information about your load balancer. Type: LoadBalancer object Response Elements API Version 2016-11-28 488 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 489 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 490 Amazon Lightsail API Reference GetLoadBalancerMetricData Returns information about health metrics for your Lightsail load balancer. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. Request Syntax { "endTime": number, "loadBalancerName": "string", "metricName": "string", "period": number, "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The end time of the period. Type: Timestamp Required: Yes loadBalancerName The name of the load balancer. Type: String Pattern: \w[\w\-]\w GetLoadBalancerMetricData API Version 2016-11-28 491 Amazon Lightsail Required: Yes metricName API Reference The metric for which you want to return information. Valid load balancer metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. • HTTPCode_Instance_2XX_Count - The number of HTTP
amazon-lightsail-api-reference-099	amazon-lightsail-api-reference.pdf	99	statistics to include in your request, and the published unit value. • ClientTLSNegotiationErrorCount - The number of TLS connections initiated by the client that did not establish a session with the load balancer due to a TLS error generated by the load balancer. Possible causes include a mismatch of ciphers or protocols. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • HealthyHostCount - The number of target instances that are considered healthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. • HTTPCode_Instance_2XX_Count - The number of HTTP 2XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • HTTPCode_Instance_3XX_Count - The number of HTTP 3XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • HTTPCode_Instance_4XX_Count - The number of HTTP 4XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Request Parameters API Version 2016-11-28 492 Amazon Lightsail API Reference Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • HTTPCode_Instance_5XX_Count - The number of HTTP 5XX response codes generated by the target instances. This does not include any response codes generated by the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • HTTPCode_LB_4XX_Count - The number of HTTP 4XX client error codes that originated from the load balancer. Client errors are generated when requests are malformed or incomplete. These requests were not received by the target instance. This count does not include response codes generated by the target instances. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • HTTPCode_LB_5XX_Count - The number of HTTP 5XX server error codes that originated from the load balancer. This does not include any response codes generated by the target instance. This metric is reported if there are no healthy instances attached to the load balancer, or if the request rate exceeds the capacity of the instances (spillover) or the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • InstanceResponseTime - The time elapsed, in seconds, after the request leaves the load balancer until a response from the target instance is received. Statistics: The most useful statistic is Average. Unit: The published unit is Seconds. Request Parameters API Version 2016-11-28 493 Amazon Lightsail API Reference • RejectedConnectionCount - The number of connections that were rejected because the load balancer had reached its maximum number of connections. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • RequestCount - The number of requests processed over IPv4. This count includes only the requests with a response generated by a target instance of the load balancer. Statistics: The most useful statistic is Sum. Note that Minimum, Maximum, and Average all return 1. Unit: The published unit is Count. • UnhealthyHostCount - The number of target instances that are considered unhealthy. Statistics: The most useful statistic are Average, Minimum, and Maximum. Unit: The published unit is Count. Type: String Valid Values: 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 Required: Yes period The granularity, in seconds, of the returned data points. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes startTime The start time of the period. Request Parameters API Version 2016-11-28 494 Amazon Lightsail Type: Timestamp Required: Yes statistics The statistic for the metric. The following statistics are available: API Reference • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how
amazon-lightsail-api-reference-100	amazon-lightsail-api-reference.pdf	100	value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Required: Yes unit The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter. Type: String Valid Values: Seconds \| Microseconds \| Milliseconds \| Bytes \| Kilobytes \| Megabytes \| Gigabytes \| Terabytes \| Bits \| Kilobits \| Megabits \| Gigabits \| Terabits \| Percent \| Count \| Bytes/Second \| Kilobytes/Second \| Megabytes/Second \| Gigabytes/Second \| Terabytes/Second \| Bits/Second \| Kilobits/Second \| Megabits/Second \| Gigabits/Second \| Terabits/Second \| Count/Second \| None Request Parameters API Version 2016-11-28 495 API Reference Amazon Lightsail Required: Yes Response Syntax { "metricData": [ { "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: 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 Response Syntax API Version 2016-11-28 496 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 497 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 498 Amazon Lightsail GetLoadBalancers Returns information about all load balancers in an account. API Reference Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetLoadBalancers request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "loadBalancers": [ { "arn": "string", "configurationOptions": { "string" : "string" }, "createdAt": number, "dnsName": "string", "healthCheckPath": "string", GetLoadBalancers API Version 2016-11-28 499 Amazon Lightsail API Reference "httpsRedirectionEnabled": boolean, "instanceHealthSummary": [ { "instanceHealth": "string", "instanceHealthReason": "string", "instanceName": "string" } ], "instancePort": number, "ipAddressType": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "protocol": "string", "publicPorts": [ number ], "resourceType": "string", "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "tlsCertificateSummaries": [ { "isAttached": boolean, "name":
amazon-lightsail-api-reference-101	amazon-lightsail-api-reference.pdf	101	page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "loadBalancers": [ { "arn": "string", "configurationOptions": { "string" : "string" }, "createdAt": number, "dnsName": "string", "healthCheckPath": "string", GetLoadBalancers API Version 2016-11-28 499 Amazon Lightsail API Reference "httpsRedirectionEnabled": boolean, "instanceHealthSummary": [ { "instanceHealth": "string", "instanceHealthReason": "string", "instanceName": "string" } ], "instancePort": number, "ipAddressType": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "protocol": "string", "publicPorts": [ number ], "resourceType": "string", "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ], "tlsCertificateSummaries": [ { "isAttached": boolean, "name": "string" } ], "tlsPolicyName": "string" } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2016-11-28 500 Amazon Lightsail loadBalancers API Reference An array of LoadBalancer objects describing your load balancers. Type: Array of LoadBalancer objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetLoadBalancers request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Errors API Version 2016-11-28 501 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 502 Amazon Lightsail API Reference See Also API Version 2016-11-28 503 Amazon Lightsail API Reference GetLoadBalancerTlsCertiﬁcates Returns information about the TLS certiﬁcates that are associated with the speciﬁed Lightsail load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL). You can have a maximum of 2 certiﬁcates associated with a Lightsail load balancer. One is active and the other is inactive. Request Syntax { "loadBalancerName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. loadBalancerName The name of the load balancer you associated with your SSL/TLS certiﬁcate. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "tlsCertificates": [ { "arn": "string", "createdAt": number, "domainName": "string", "domainValidationRecords": [ { GetLoadBalancerTlsCertiﬁcates API Version 2016-11-28 504 Amazon Lightsail API Reference "dnsRecordCreationState": { "code": "string", "message": "string" }, "domainName": "string", "name": "string", "type": "string", "validationStatus": "string", "value": "string" } ], "failureReason": "string", "isAttached": boolean, "issuedAt": number, "issuer": "string", "keyAlgorithm": "string", "loadBalancerName": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "notAfter": number, "notBefore": number, "renewalSummary": { "domainValidationOptions": [ { "domainName": "string", "validationStatus": "string" } ], "renewalStatus": "string" }, "resourceType": "string", "revocationReason": "string", "revokedAt": number, "serial": "string", "signatureAlgorithm": "string", "status": "string", "subject": "string", "subjectAlternativeNames": [ "string" ], "supportCode": "string", "tags": [ { Response Syntax API Version 2016-11-28 505 Amazon Lightsail API Reference "key": "string", "value": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. tlsCertiﬁcates An array of LoadBalancerTlsCertiﬁcate objects describing your SSL/TLS certiﬁcates. Type: Array of LoadBalancerTlsCertiﬁcate objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in
amazon-lightsail-api-reference-102	amazon-lightsail-api-reference.pdf	102	"value": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. tlsCertiﬁcates An array of LoadBalancerTlsCertiﬁcate objects describing your SSL/TLS certiﬁcates. Type: Array of LoadBalancerTlsCertiﬁcate objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 506 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 507 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 508 Amazon Lightsail API Reference GetLoadBalancerTlsPolicies Returns a list of TLS security policies that you can apply to Lightsail load balancers. For more information about load balancer TLS security policies, see Conﬁguring TLS security policies on your Amazon Lightsail load balancers in the Amazon Lightsail Developer Guide. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetLoadBalancerTlsPolicies request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "tlsPolicies": [ { "ciphers": [ "string" ], "description": "string", "isDefault": boolean, GetLoadBalancerTlsPolicies API Version 2016-11-28 509 Amazon Lightsail API Reference "name": "string", "protocols": [ "string" ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetLoadBalancerTlsPolicies request and specify the next page token using the pageToken parameter. Type: String tlsPolicies An array of objects that describe the TLS security policies that are available. Type: Array of LoadBalancerTlsPolicy objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 510 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2016-11-28 511 Amazon Lightsail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK
amazon-lightsail-api-reference-103	amazon-lightsail-api-reference.pdf	103	exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2016-11-28 511 Amazon Lightsail • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 512 Amazon Lightsail GetOperation API Reference Returns information about a speciﬁc operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on. Request Syntax { "operationId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. operationId A GUID used to identify the operation. Type: String Pattern: .\S. Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, GetOperation API Version 2016-11-28 513 Amazon Lightsail API Reference "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 514 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 515 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 516 Amazon Lightsail GetOperations Returns information about all operations. API Reference Results are returned from oldest to newest, up to a maximum of 200. Results can be paged by making each subsequent call to GetOperations use the maximum (last) statusChangedAt value from the previous request. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperations request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", GetOperations API Version 2016-11-28 517 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another
amazon-lightsail-api-reference-104	amazon-lightsail-api-reference.pdf	104	"string", GetOperations API Version 2016-11-28 517 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperations request and specify the next page token using the pageToken parameter. Type: String operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 518 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 519 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 520 Amazon Lightsail API Reference GetOperationsForResource Gets operations for a speciﬁc resource (an instance or a static IP). Request Syntax { "pageToken": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetOperationsForResource request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No resourceName The name of the resource for which you are requesting information. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { GetOperationsForResource API Version 2016-11-28 521 Amazon Lightsail API Reference "nextPageCount": "string", "nextPageToken": "string", "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageCount This parameter has been deprecated. (Discontinued) Returns the number of pages of results that remain. Note In releases prior to June 12, 2017, this parameter returned null by the API. It is now discontinued, and the API returns the next page token parameter instead. Type: String Response Elements API Version 2016-11-28 522 Amazon Lightsail nextPageToken API Reference The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter. Type: String operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this
amazon-lightsail-api-reference-105	amazon-lightsail-api-reference.pdf	105	get the next page of results, perform another GetOperationsForResource request and specify the next page token using the pageToken parameter. Type: String operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Errors API Version 2016-11-28 523 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 524 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 525 Amazon Lightsail GetRegions API Reference Returns a list of all valid regions for Amazon Lightsail. Use the include availability zones parameter to also return the Availability Zones in a region. Request Syntax { "includeAvailabilityZones": boolean, "includeRelationalDatabaseAvailabilityZones": boolean } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. includeAvailabilityZones A Boolean value indicating whether to also include Availability Zones in your get regions request. Availability Zones are indicated with a letter: us-east-2a. Type: Boolean Required: No includeRelationalDatabaseAvailabilityZones A Boolean value indicating whether to also include Availability Zones for databases in your get regions request. Availability Zones are indicated with a letter (us-east-2a). Type: Boolean Required: No Response Syntax { GetRegions API Version 2016-11-28 526 API Reference Amazon Lightsail "regions": [ { "availabilityZones": [ { "state": "string", "zoneName": "string" } ], "continentCode": "string", "description": "string", "displayName": "string", "name": "string", "relationalDatabaseAvailabilityZones": [ { "state": "string", "zoneName": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. regions An array of key-value pairs containing information about your get regions request. Type: Array of Region objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 527 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 528 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 529 Amazon Lightsail API
amazon-lightsail-api-reference-106	amazon-lightsail-api-reference.pdf	106	has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 528 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 529 Amazon Lightsail API Reference GetRelationalDatabase Returns information about a speciﬁc database in Amazon Lightsail. Request Syntax { "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of the database that you are looking up. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "relationalDatabase": { "arn": "string", "backupRetentionEnabled": boolean, "caCertificateIdentifier": "string", "createdAt": number, "engine": "string", "engineVersion": "string", "hardware": { "cpuCount": number, "diskSizeInGb": number, "ramSizeInGb": number }, "latestRestorableTime": number, GetRelationalDatabase API Version 2016-11-28 530 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "masterDatabaseName": "string", "masterEndpoint": { "address": "string", "port": number }, "masterUsername": "string", "name": "string", "parameterApplyStatus": "string", "pendingMaintenanceActions": [ { "action": "string", "currentApplyDate": number, "description": "string" } ], "pendingModifiedValues": { "backupRetentionEnabled": boolean, "engineVersion": "string", "masterUserPassword": "string" }, "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "relationalDatabaseBlueprintId": "string", "relationalDatabaseBundleId": "string", "resourceType": "string", "secondaryAvailabilityZone": "string", "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Syntax API Version 2016-11-28 531 Amazon Lightsail Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. relationalDatabase An object describing the speciﬁed database. Type: RelationalDatabase object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Response Elements API Version 2016-11-28 532 Amazon Lightsail NotFoundException API Reference Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 533 Amazon Lightsail API Reference GetRelationalDatabaseBlueprints Returns a list of available database blueprints in Amazon Lightsail. A blueprint describes the major engine version of a database. You can use a blueprint ID to create a new database that runs a speciﬁc database engine. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBlueprints request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "blueprints": [ { "blueprintId": "string", "engine": "string", "engineDescription": "string", "engineVersion": "string", GetRelationalDatabaseBlueprints API Version 2016-11-28 534 Amazon Lightsail API Reference "engineVersionDescription": "string", "isEngineDefault": boolean } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. blueprints An object describing the result of your get relational database blueprints request. Type: Array of RelationalDatabaseBlueprint objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display.
amazon-lightsail-api-reference-107	amazon-lightsail-api-reference.pdf	107	{ "blueprintId": "string", "engine": "string", "engineDescription": "string", "engineVersion": "string", GetRelationalDatabaseBlueprints API Version 2016-11-28 534 Amazon Lightsail API Reference "engineVersionDescription": "string", "isEngineDefault": boolean } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. blueprints An object describing the result of your get relational database blueprints request. Type: Array of RelationalDatabaseBlueprint objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBlueprints request and specify the next page token using the pageToken parameter. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 535 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 536 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 537 Amazon Lightsail API Reference GetRelationalDatabaseBundles Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance speciﬁcations for a database. You can use a bundle ID to create a new database with explicit performance speciﬁcations. Request Syntax { "includeInactive": boolean, "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. includeInactive A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request. Type: Boolean Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseBundles request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No GetRelationalDatabaseBundles API Version 2016-11-28 538 API Reference Amazon Lightsail Response Syntax { "bundles": [ { "bundleId": "string", "cpuCount": number, "diskSizeInGb": number, "isActive": boolean, "isEncrypted": boolean, "name": "string", "price": number, "ramSizeInGb": number, "transferPerMonthInGb": number } ], "nextPageToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. bundles An object describing the result of your get relational database bundles request. Type: Array of RelationalDatabaseBundle objects nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseBundles request and specify the next page token using the pageToken parameter. Type: String Response Syntax API Version 2016-11-28 539 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot
amazon-lightsail-api-reference-108	amazon-lightsail-api-reference.pdf	108	exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 540 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 541 Amazon Lightsail API Reference GetRelationalDatabaseEvents Returns a list of events for a speciﬁc database in Amazon Lightsail. Request Syntax { "durationInMinutes": number, "pageToken": "string", "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. durationInMinutes The number of minutes in the past from which to retrieve events. For example, to get all events from the past 2 hours, enter 120. Default: 60 The minimum is 1 and the maximum is 14 days (20160 minutes). Type: Integer Required: No pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseEvents request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String GetRelationalDatabaseEvents API Version 2016-11-28 542 Amazon Lightsail Required: No relationalDatabaseName The name of the database from which to get events. API Reference Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "nextPageToken": "string", "relationalDatabaseEvents": [ { "createdAt": number, "eventCategories": [ "string" ], "message": "string", "resource": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseEvents request and specify the next page token using the pageToken parameter. Type: String Response Syntax API Version 2016-11-28 543 Amazon Lightsail relationalDatabaseEvents API Reference An object describing the result of your get relational database events request. Type: Array of RelationalDatabaseEvent objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 544 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 545 Amazon Lightsail API Reference GetRelationalDatabaseLogEvents Returns a
amazon-lightsail-api-reference-109	amazon-lightsail-api-reference.pdf	109	this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 545 Amazon Lightsail API Reference GetRelationalDatabaseLogEvents Returns a list of log events for a database in Amazon Lightsail. Request Syntax { "endTime": number, "logStreamName": "string", "pageToken": "string", "relationalDatabaseName": "string", "startFromHead": boolean, "startTime": number } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The end of the time interval from which to get log events. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time. Type: Timestamp Required: No logStreamName The name of the log stream. Use the get relational database log streams operation to get a list of available log streams. GetRelationalDatabaseLogEvents API Version 2016-11-28 546 Amazon Lightsail Type: String Required: Yes pageToken API Reference The token to advance to the next or previous page of results from your request. To get a page token, perform an initial GetRelationalDatabaseLogEvents request. If your results are paginated, the response will return a next forward token and/or next backward token that you can specify as the page token in a subsequent request. Type: String Required: No relationalDatabaseName The name of your database for which to get log events. Type: String Pattern: \w[\w\-]*\w Required: Yes startFromHead Parameter to specify if the log should start from head or tail. If true is speciﬁed, the log event starts from the head of the log. If false is speciﬁed, the log event starts from the tail of the log. Note For PostgreSQL, the default value of false is the only option available. Type: Boolean Required: No startTime The start of the time interval from which to get log events. Request Parameters API Version 2016-11-28 547 Amazon Lightsail Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. API Reference For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time. Type: Timestamp Required: No Response Syntax { "nextBackwardToken": "string", "nextForwardToken": "string", "resourceLogEvents": [ { "createdAt": number, "message": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextBackwardToken A token used for advancing to the previous page of results from your get relational database log events request. Type: String nextForwardToken A token used for advancing to the next page of results from your get relational database log events request. Response Syntax API Version 2016-11-28 548 Amazon Lightsail Type: String resourceLogEvents API Reference An object describing the result of your get relational database log events request. Type: Array of LogEvent objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 549 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for
amazon-lightsail-api-reference-110	amazon-lightsail-api-reference.pdf	110	Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 550 Amazon Lightsail API Reference GetRelationalDatabaseLogStreams Returns a list of available log streams for a speciﬁc database in Amazon Lightsail. Request Syntax { "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of your database for which to get log streams. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "logStreams": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. logStreams An object describing the result of your get relational database log streams request. GetRelationalDatabaseLogStreams API Version 2016-11-28 551 Amazon Lightsail Type: Array of strings Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 552 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 553 Amazon Lightsail API Reference GetRelationalDatabaseMasterUserPassword Returns the current, previous, or pending versions of the master user password for a Lightsail database. The GetRelationalDatabaseMasterUserPassword operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. Request Syntax { "passwordVersion": "string", "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. passwordVersion The password version to return. Specifying CURRENT or PREVIOUS returns the current or previous passwords respectively. Specifying PENDING returns the newest version of the password that will rotate to CURRENT. After the PENDING password rotates to CURRENT, the PENDING password is no longer available. Default: CURRENT Type: String Valid Values: CURRENT \| PREVIOUS \| PENDING Required: No relationalDatabaseName The name of your database for which to get the master user password. Type: String GetRelationalDatabaseMasterUserPassword API Version 2016-11-28 554 API Reference Amazon Lightsail Pattern: \w[\w\-]\w Required: Yes Response Syntax { "createdAt": number, "masterUserPassword": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. createdAt The timestamp when the speciﬁed version of the master user password was created. Type: Timestamp masterUserPassword The master user password for the password version speciﬁed. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Syntax API Version 2016-11-28 555 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does
amazon-lightsail-api-reference-111	amazon-lightsail-api-reference.pdf	111	speciﬁed version of the master user password was created. Type: Timestamp masterUserPassword The master user password for the password version speciﬁed. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Syntax API Version 2016-11-28 555 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 556 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 557 Amazon Lightsail API Reference GetRelationalDatabaseMetricData Returns the data points of the speciﬁed metric for a database in Amazon Lightsail. Metrics report the utilization of your resources, and the error counts generated by them. Monitor and collect metric data regularly to maintain the reliability, availability, and performance of your resources. Request Syntax { "endTime": number, "metricName": "string", "period": number, "relationalDatabaseName": "string", "startTime": number, "statistics": [ "string" ], "unit": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. endTime The end of the time interval from which to get metric data. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time. Type: Timestamp Required: Yes GetRelationalDatabaseMetricData API Version 2016-11-28 558 Amazon Lightsail metricName API Reference The metric for which you want to return information. Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity. • CPUUtilization - The percentage of CPU utilization currently in use on the database. Statistics: The most useful statistics are Maximum and Average. Unit: The published unit is Percent. • DatabaseConnections - The number of database connections in use. Statistics: The most useful statistics are Maximum and Sum. Unit: The published unit is Count. • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk. Statistics: The most useful statistic is Sum. Unit: The published unit is Count. • FreeStorageSpace - The amount of available storage space. Statistics: The most useful statistic is Sum. Unit: The published unit is Bytes. • NetworkReceiveThroughput - The incoming (Receive) network traﬃc on the database, including both customer database traﬃc and AWS traﬃc used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second. • NetworkTransmitThroughput - The outgoing (Transmit) network traﬃc on the database, including both customer database traﬃc and AWS traﬃc used for monitoring and replication. Statistics: The most useful statistic is Average. Unit: The published unit is Bytes/Second. Request Parameters API Version 2016-11-28 559 Amazon Lightsail Type: String API Reference Valid Values: CPUUtilization \| DatabaseConnections \| DiskQueueDepth \| FreeStorageSpace \| NetworkReceiveThroughput \| NetworkTransmitThroughput Required: Yes period The granularity, in seconds, of the returned data points. All relational database metric data is available in 1-minute (60 seconds) granularity. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes relationalDatabaseName The name of your database from which to get metric data. Type: String Pattern: \w[\w\-]*\w Required: Yes startTime The start of the time interval from which to get metric data. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at
amazon-lightsail-api-reference-112	amazon-lightsail-api-reference.pdf	112	NetworkTransmitThroughput Required: Yes period The granularity, in seconds, of the returned data points. All relational database metric data is available in 1-minute (60 seconds) granularity. Type: Integer Valid Range: Minimum value of 60. Maximum value of 86400. Required: Yes relationalDatabaseName The name of your database from which to get metric data. Type: String Pattern: \w[\w\-]*\w Required: Yes startTime The start of the time interval from which to get metric data. Constraints: • Speciﬁed in Coordinated Universal Time (UTC). • Speciﬁed in the Unix time format. For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time. Type: Timestamp Required: Yes statistics The statistic for the metric. Request Parameters API Version 2016-11-28 560 Amazon Lightsail API Reference The following statistics are available: • Minimum - The lowest value observed during the speciﬁed period. Use this value to determine low volumes of activity for your application. • Maximum - The highest value observed during the speciﬁed period. Use this value to determine high volumes of activity for your application. • Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric. • Average - The value of Sum / SampleCount during the speciﬁed period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources. • SampleCount - The count, or number, of data points used for the statistical calculation. Type: Array of strings Valid Values: Minimum \| Maximum \| Sum \| Average \| SampleCount Required: Yes unit The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter. Type: String Valid Values: Seconds \| Microseconds \| Milliseconds \| Bytes \| Kilobytes \| Megabytes \| Gigabytes \| Terabytes \| Bits \| Kilobits \| Megabits \| Gigabits \| Terabits \| Percent \| Count \| Bytes/Second \| Kilobytes/Second \| Megabytes/Second \| Gigabytes/Second \| Terabytes/Second \| Bits/Second \| Kilobits/Second \| Megabits/Second \| Gigabits/Second \| Terabits/Second \| Count/Second \| None Required: Yes Response Syntax { "metricData": [ Response Syntax API Version 2016-11-28 561 Amazon Lightsail API Reference { "average": number, "maximum": number, "minimum": number, "sampleCount": number, "sum": number, "timestamp": number, "unit": "string" } ], "metricName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. metricData An array of objects that describe the metric data returned. Type: Array of MetricDatapoint objects metricName The name of the metric returned. Type: String Valid Values: CPUUtilization \| DatabaseConnections \| DiskQueueDepth \| FreeStorageSpace \| NetworkReceiveThroughput \| NetworkTransmitThroughput Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 562 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 563 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 564 Amazon Lightsail API Reference GetRelationalDatabaseParameters Returns all of the runtime parameters oﬀered by the underlying database software, or engine, for a speciﬁc database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether
amazon-lightsail-api-reference-113	amazon-lightsail-api-reference.pdf	113	SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 564 Amazon Lightsail API Reference GetRelationalDatabaseParameters Returns all of the runtime parameters oﬀered by the underlying database software, or engine, for a speciﬁc database in Amazon Lightsail. In addition to the parameter names and values, this operation returns other information about each parameter. This information includes whether changes require a reboot, whether the parameter is modiﬁable, the allowed values, and the data types. Request Syntax { "pageToken": "string", "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseParameters request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No relationalDatabaseName The name of your database for which to get parameters. Type: String Pattern: \w[\w\-]*\w GetRelationalDatabaseParameters API Version 2016-11-28 565 API Reference Amazon Lightsail Required: Yes Response Syntax { "nextPageToken": "string", "parameters": [ { "allowedValues": "string", "applyMethod": "string", "applyType": "string", "dataType": "string", "description": "string", "isModifiable": boolean, "parameterName": "string", "parameterValue": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseParameters request and specify the next page token using the pageToken parameter. Type: String parameters An object describing the result of your get relational database parameters request. Type: Array of RelationalDatabaseParameter objects Response Syntax API Version 2016-11-28 566 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 567 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 568 Amazon Lightsail API Reference GetRelationalDatabases Returns information about all of your databases in Amazon Lightsail. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabases request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "relationalDatabases": [ { "arn": "string", "backupRetentionEnabled": boolean, "caCertificateIdentifier": "string", "createdAt": number, "engine": "string", "engineVersion": "string", "hardware": { GetRelationalDatabases API Version 2016-11-28 569 Amazon Lightsail API Reference "cpuCount": number, "diskSizeInGb": number, "ramSizeInGb": number }, "latestRestorableTime": number, "location": { "availabilityZone": "string", "regionName": "string" }, "masterDatabaseName": "string", "masterEndpoint": { "address": "string", "port": number }, "masterUsername": "string", "name": "string", "parameterApplyStatus": "string", "pendingMaintenanceActions": [ { "action": "string", "currentApplyDate": number, "description": "string" } ], "pendingModifiedValues": { "backupRetentionEnabled": boolean, "engineVersion": "string", "masterUserPassword": "string" }, "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "relationalDatabaseBlueprintId": "string",
amazon-lightsail-api-reference-114	amazon-lightsail-api-reference.pdf	114	page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "relationalDatabases": [ { "arn": "string", "backupRetentionEnabled": boolean, "caCertificateIdentifier": "string", "createdAt": number, "engine": "string", "engineVersion": "string", "hardware": { GetRelationalDatabases API Version 2016-11-28 569 Amazon Lightsail API Reference "cpuCount": number, "diskSizeInGb": number, "ramSizeInGb": number }, "latestRestorableTime": number, "location": { "availabilityZone": "string", "regionName": "string" }, "masterDatabaseName": "string", "masterEndpoint": { "address": "string", "port": number }, "masterUsername": "string", "name": "string", "parameterApplyStatus": "string", "pendingMaintenanceActions": [ { "action": "string", "currentApplyDate": number, "description": "string" } ], "pendingModifiedValues": { "backupRetentionEnabled": boolean, "engineVersion": "string", "masterUserPassword": "string" }, "preferredBackupWindow": "string", "preferredMaintenanceWindow": "string", "publiclyAccessible": boolean, "relationalDatabaseBlueprintId": "string", "relationalDatabaseBundleId": "string", "resourceType": "string", "secondaryAvailabilityZone": "string", "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] Response Syntax API Version 2016-11-28 570 Amazon Lightsail } ] } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabases request and specify the next page token using the pageToken parameter. Type: String relationalDatabases An object describing the result of your get relational databases request. Type: Array of RelationalDatabase objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 571 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 572 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 573 Amazon Lightsail API Reference GetRelationalDatabaseSnapshot Returns information about a speciﬁc database snapshot in Amazon Lightsail. Request Syntax { "relationalDatabaseSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseSnapshotName The name of the database snapshot for which to get information. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "relationalDatabaseSnapshot": { "arn": "string", "createdAt": number, "engine": "string", "engineVersion": "string", "fromRelationalDatabaseArn": "string", "fromRelationalDatabaseBlueprintId": "string", "fromRelationalDatabaseBundleId": "string", "fromRelationalDatabaseName": "string", "location": { "availabilityZone": "string", "regionName": "string" GetRelationalDatabaseSnapshot API Version 2016-11-28 574 Amazon Lightsail API Reference }, "name": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. relationalDatabaseSnapshot An object describing the speciﬁed database snapshot. Type: RelationalDatabaseSnapshot object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 575 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP
amazon-lightsail-api-reference-115	amazon-lightsail-api-reference.pdf	115	in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 575 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 576 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 577 Amazon Lightsail API Reference GetRelationalDatabaseSnapshots Returns information about all of your database snapshots in Amazon Lightsail. Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetRelationalDatabaseSnapshots request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "relationalDatabaseSnapshots": [ { "arn": "string", "createdAt": number, "engine": "string", "engineVersion": "string", "fromRelationalDatabaseArn": "string", "fromRelationalDatabaseBlueprintId": "string", GetRelationalDatabaseSnapshots API Version 2016-11-28 578 Amazon Lightsail API Reference "fromRelationalDatabaseBundleId": "string", "fromRelationalDatabaseName": "string", "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "sizeInGb": number, "state": "string", "supportCode": "string", "tags": [ { "key": "string", "value": "string" } ] } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetRelationalDatabaseSnapshots request and specify the next page token using the pageToken parameter. Type: String relationalDatabaseSnapshots An object describing the result of your get relational database snapshots request. Type: Array of RelationalDatabaseSnapshot objects Response Elements API Version 2016-11-28 579 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 580 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 581 Amazon Lightsail GetSetupHistory API Reference Returns detailed information for ﬁve of the most recent SetupInstanceHttps requests that were ran on the target instance. Request Syntax { "pageToken": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token
amazon-lightsail-api-reference-116	amazon-lightsail-api-reference.pdf	116	v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 581 Amazon Lightsail GetSetupHistory API Reference Returns detailed information for ﬁve of the most recent SetupInstanceHttps requests that were ran on the target instance. Request Syntax { "pageToken": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetSetupHistory request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Length Constraints: Minimum length of 24. Maximum length of 40. Pattern: ^[A-Za-z0-9+/=]+$ Required: No resourceName The name of the resource for which you are requesting information. Type: String Pattern: \w[\w\-]\w Required: Yes GetSetupHistory API Version 2016-11-28 582 API Reference Amazon Lightsail Response Syntax { "nextPageToken": "string", "setupHistory": [ { "executionDetails": [ { "command": "string", "dateTime": number, "name": "string", "standardError": "string", "standardOutput": "string", "status": "string", "version": "string" } ], "operationId": "string", "request": { "certificateProvider": "string", "domainNames": [ "string" ], "instanceName": "string" }, "resource": { "arn": "string", "createdAt": number, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string" }, "status": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 583 Amazon Lightsail nextPageToken API Reference The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetSetupHistory request and specify the next page token using the pageToken parameter. Type: String Length Constraints: Minimum length of 24. Maximum length of 40. Pattern: ^[A-Za-z0-9+/=]+$ setupHistory The historical information that's returned. Type: Array of SetupHistory objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Errors API Version 2016-11-28 584 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 585 Amazon Lightsail GetStaticIp Returns information about an Amazon Lightsail static IP. API Reference Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP in Lightsail. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "staticIp": { "arn": "string", "attachedTo": "string", "createdAt": number, "ipAddress": "string", "isAttached": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "supportCode": "string" GetStaticIp API Version 2016-11-28 586 Amazon Lightsail } } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. staticIp An array of key-value pairs containing information about the requested static IP. Type: StaticIp object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld.
amazon-lightsail-api-reference-117	amazon-lightsail-api-reference.pdf	117	returned in JSON format by the service. staticIp An array of key-value pairs containing information about the requested static IP. Type: StaticIp object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 587 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 588 Amazon Lightsail API Reference See Also API Version 2016-11-28 589 Amazon Lightsail GetStaticIps Returns information about all static IPs in the user's account. API Reference Request Syntax { "pageToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. pageToken The token to advance to the next page of results from your request. To get a page token, perform an initial GetStaticIps request. If your results are paginated, the response will return a next page token that you can specify as the page token in a subsequent request. Type: String Required: No Response Syntax { "nextPageToken": "string", "staticIps": [ { "arn": "string", "attachedTo": "string", "createdAt": number, "ipAddress": "string", "isAttached": boolean, GetStaticIps API Version 2016-11-28 590 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "name": "string", "resourceType": "string", "supportCode": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. nextPageToken The token to advance to the next page of results from your request. A next page token is not returned if there are no more results to display. To get the next page of results, perform another GetStaticIps request and specify the next page token using the pageToken parameter. Type: String staticIps An array of key-value pairs containing information about your get static IPs request. Type: Array of StaticIp objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. Response Elements API Version 2016-11-28 591 Amazon Lightsail HTTP Status Code: 400 AccountSetupInProgressException API Reference Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 592 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 593 API Reference Amazon Lightsail ImportKeyPair Imports a
amazon-lightsail-api-reference-118	amazon-lightsail-api-reference.pdf	118	HTTP Status Code: 400 Errors API Version 2016-11-28 592 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 593 API Reference Amazon Lightsail ImportKeyPair Imports a public SSH key from a speciﬁc key pair. Request Syntax { "keyPairName": "string", "publicKeyBase64": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. keyPairName The name of the key pair for which you want to import the public key. Type: String Pattern: \w[\w\-]*\w Required: Yes publicKeyBase64 A base64-encoded public key of the ssh-rsa type. Type: String Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", ImportKeyPair API Version 2016-11-28 594 Amazon Lightsail API Reference "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 595 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 596 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 597 Amazon Lightsail IsVpcPeered API Reference Returns a Boolean value indicating whether your Lightsail VPC is peered. Response Syntax { "isPeered": boolean } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. isPeered Returns true if the Lightsail VPC is peered; otherwise, false. Type: Boolean Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. IsVpcPeered API Version 2016-11-28 598 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see
amazon-lightsail-api-reference-119	amazon-lightsail-api-reference.pdf	119	only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 599 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 600 Amazon Lightsail API Reference OpenInstancePublicPorts Opens ports for a speciﬁc Amazon Lightsail instance, and speciﬁes the IP addresses allowed to connect to the instance through the ports, and the protocol. The OpenInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identiﬁed by instanceName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string", "portInfo": { "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "toPort": number } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance for which to open ports. Type: String Pattern: \w[\w\-]*\w Required: Yes portInfo An object to describe the ports to open for the speciﬁed instance. OpenInstancePublicPorts API Version 2016-11-28 601 API Reference Amazon Lightsail Type: PortInfo object Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Response Syntax API Version 2016-11-28 602 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 603 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 604 API Reference Amazon Lightsail PeerVpc Peers the Lightsail VPC with the user's default VPC. Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about
amazon-lightsail-api-reference-120	amazon-lightsail-api-reference.pdf	120	Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object Errors For information about the errors that are common to all actions, see Common Errors. PeerVpc API Version 2016-11-28 605 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 606 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 607 Amazon Lightsail PutAlarm API Reference Creates or updates an alarm, and associates it with the speciﬁed metric. An alarm is used to monitor a single metric for one of your resources. When a metric condition is met, the alarm can notify you by email, SMS text message, and a banner displayed on the Amazon Lightsail console. For more information, see Alarms in Amazon Lightsail. When this action creates an alarm, the alarm state is immediately set to INSUFFICIENT_DATA. The alarm is then evaluated and its state is set appropriately. Any actions associated with the new state are then executed. When you update an existing alarm, its state is left unchanged, but the update completely overwrites the previous conﬁguration of the alarm. The alarm is then evaluated with the updated conﬁguration. Request Syntax { "alarmName": "string", "comparisonOperator": "string", "contactProtocols": [ "string" ], "datapointsToAlarm": number, "evaluationPeriods": number, "metricName": "string", "monitoredResourceName": "string", "notificationEnabled": boolean, "notificationTriggers": [ "string" ], "threshold": number, "treatMissingData": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. alarmName The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous conﬁguration of the alarm. PutAlarm API Version 2016-11-28 608 Amazon Lightsail Type: String Pattern: \w[\w\-]*\w Required: Yes comparisonOperator API Reference The arithmetic operation to use when comparing the speciﬁed statistic to the threshold. The speciﬁed statistic value is used as the ﬁrst operand. Type: String Valid Values: GreaterThanOrEqualToThreshold \| GreaterThanThreshold \| LessThanThreshold \| LessThanOrEqualToThreshold Required: Yes contactProtocols The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both. A notiﬁcation is sent via the speciﬁed contact protocol if notiﬁcations are enabled for the alarm, and when the alarm is triggered. A notiﬁcation is not sent if a contact protocol is not speciﬁed, if the speciﬁed contact protocol is not conﬁgured in the AWS Region, or if notiﬁcations are not enabled for the alarm using the notificationEnabled paramater. Use the CreateContactMethod action to conﬁgure a contact protocol in an AWS Region. Type: Array of strings Valid Values: Email \| SMS Required: No datapointsToAlarm The number of data points that must be not within the speciﬁed threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M. Type: Integer Required: No Request Parameters API Version 2016-11-28 609 Amazon Lightsail evaluationPeriods API Reference The number of most recent periods over which data is compared to the speciﬁed threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.
amazon-lightsail-api-reference-121	amazon-lightsail-api-reference.pdf	121	to conﬁgure a contact protocol in an AWS Region. Type: Array of strings Valid Values: Email \| SMS Required: No datapointsToAlarm The number of data points that must be not within the speciﬁed threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M. Type: Integer Required: No Request Parameters API Version 2016-11-28 609 Amazon Lightsail evaluationPeriods API Reference The number of most recent periods over which data is compared to the speciﬁed threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value speciﬁes the rolling period of time in which data points are evaluated. Each evaluation period is ﬁve minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours. You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours). Type: Integer Required: Yes metricName The name of the metric to associate with the alarm. You can conﬁgure up to two alarms per metric. The following metrics are available for each resource type: • Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System. • Load balancers: 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, and RequestCount. • Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput. For more information about these metrics, see Metrics available in Lightsail. Type: String Request Parameters API Version 2016-11-28 610 Amazon Lightsail API Reference Valid Values: CPUUtilization \| NetworkIn \| NetworkOut \| StatusCheckFailed \| StatusCheckFailed_Instance \| StatusCheckFailed_System \| 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 \| DatabaseConnections \| DiskQueueDepth \| FreeStorageSpace \| NetworkReceiveThroughput \| NetworkTransmitThroughput \| BurstCapacityTime \| BurstCapacityPercentage Required: Yes monitoredResourceName The name of the Lightsail resource that will be monitored. Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms. Type: String Pattern: \w[\w\-]*\w Required: Yes notiﬁcationEnabled Indicates whether the alarm is enabled. Notiﬁcations are enabled by default if you don't specify this parameter. Type: Boolean Required: No notiﬁcationTriggers The alarm states that trigger a notiﬁcation. An alarm has the following possible states: • ALARM - The metric is outside of the deﬁned threshold. Request Parameters API Version 2016-11-28 611 Amazon Lightsail API Reference • INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state. • OK - The metric is within the deﬁned threshold. When you specify a notiﬁcation trigger, the ALARM state must be speciﬁed. The INSUFFICIENT_DATA and OK states can be speciﬁed in addition to the ALARM state. • If you specify OK as an alarm trigger, a notiﬁcation is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notiﬁcation. • If you specify INSUFFICIENT_DATA as the alarm trigger, a notiﬁcation is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state. The notiﬁcation trigger defaults to ALARM if you don't specify this parameter. Type: Array of strings Valid Values: OK \| ALARM \| INSUFFICIENT_DATA Required: No threshold The value against which the speciﬁed statistic is compared. Type: Double Required: Yes treatMissingData Sets how this alarm will handle missing data points. An alarm can treat missing data in the following ways: • breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold. • notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold. • ignore - Ignore the missing data. Maintains the current alarm state. • missing - Missing data is treated as missing. Request Parameters API Version 2016-11-28 612 Amazon Lightsail API Reference If treatMissingData is not speciﬁed, the default behavior of missing is used. Type: String Valid Values: breaching \| notBreaching \| ignore \| missing Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status
amazon-lightsail-api-reference-122	amazon-lightsail-api-reference.pdf	122	the default behavior of missing is used. Type: String Valid Values: breaching \| notBreaching \| ignore \| missing Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Response Syntax API Version 2016-11-28 613 Amazon Lightsail API Reference Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 614 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 615 Amazon Lightsail API Reference PutInstancePublicPorts Opens ports for a speciﬁc Amazon Lightsail instance, and speciﬁes the IP addresses allowed to connect to the instance through the ports, and the protocol. This action also closes all currently open ports that are not included in the request. Include all of the ports and the protocols you want to open in your PutInstancePublicPortsrequest. Or use the OpenInstancePublicPorts action to open ports without closing currently open ports. The PutInstancePublicPorts action supports tag-based access control via resource tags applied to the resource identiﬁed by instanceName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string", "portInfos": [ { "cidrListAliases": [ "string" ], "cidrs": [ "string" ], "fromPort": number, "ipv6Cidrs": [ "string" ], "protocol": "string", "toPort": number } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance for which to open ports. Type: String Pattern: \w[\w\-]*\w PutInstancePublicPorts API Version 2016-11-28 616 Amazon Lightsail Required: Yes portInfos API Reference An array of objects to describe the ports to open for the speciﬁed instance. Type: Array of PortInfo objects Required: Yes Response Syntax { "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Response Syntax API Version 2016-11-28 617 Amazon Lightsail Type: Operation object Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail
amazon-lightsail-api-reference-123	amazon-lightsail-api-reference.pdf	123	invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 Errors API Version 2016-11-28 618 Amazon Lightsail ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 619 Amazon Lightsail RebootInstance Restarts a speciﬁc instance. API Reference The reboot instance operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance to reboot. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, RebootInstance API Version 2016-11-28 620 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 621 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 622 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 623 Amazon Lightsail API Reference RebootRelationalDatabase Restarts a speciﬁc database in Amazon Lightsail. The reboot relational database operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of your database to reboot. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, RebootRelationalDatabase API Version 2016-11-28 624 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string"
amazon-lightsail-api-reference-124	amazon-lightsail-api-reference.pdf	124	operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of your database to reboot. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, RebootRelationalDatabase API Version 2016-11-28 624 Amazon Lightsail API Reference "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 Response Elements API Version 2016-11-28 625 Amazon Lightsail InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface See Also API Version 2016-11-28 626 API Reference Amazon Lightsail • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 627 Amazon Lightsail API Reference RegisterContainerImage Registers a container image to your Amazon Lightsail container service. Note This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see Pushing and managing container images on your Amazon Lightsail container services in the Amazon Lightsail Developer Guide. Request Syntax { "digest": "string", "label": "string", "serviceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. digest The digest of the container image to be registered. Type: String Required: Yes label The label for the container image when it's registered to the container service. Use a descriptive label that you can use to track the diﬀerent versions of your registered container images. RegisterContainerImage API Version 2016-11-28 628 Amazon Lightsail API Reference Use the GetContainerImages action to return the container images registered to a Lightsail container service. The label is the <imagelabel> portion of the following image name example: • :container-service-1.<imagelabel>.1 If the name of your container service is mycontainerservice, and the label that you specify is mystaticwebsite, then the name of the registered container image will be :mycontainerservice.mystaticwebsite.1. The number at the end of these image name examples represents the version of the registered container image. If you push and register another container image to the same Lightsail container service, with the same label, then the version number for the new registered container image will be 2. If you push and register another container image, the version number will be 3, and so on. Type: String Length Constraints: Minimum length of 1. Maximum length of 53. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes serviceName The name of the container service for which to register a container image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Syntax { "containerImage": { "createdAt": number, "digest": "string", Response Syntax API Version 2016-11-28 629 Amazon Lightsail "image": "string" } } Response Elements API Reference If the action is successful, the service sends back an HTTP
amazon-lightsail-api-reference-125	amazon-lightsail-api-reference.pdf	125	2. If you push and register another container image, the version number will be 3, and so on. Type: String Length Constraints: Minimum length of 1. Maximum length of 53. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes serviceName The name of the container service for which to register a container image. Type: String Length Constraints: Minimum length of 1. Maximum length of 63. Pattern: ^[a-z0-9]{1,2}\|[a-z0-9][a-z0-9-]+[a-z0-9]$ Required: Yes Response Syntax { "containerImage": { "createdAt": number, "digest": "string", Response Syntax API Version 2016-11-28 629 Amazon Lightsail "image": "string" } } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. containerImage An object that describes a container image that is registered to a Lightsail container service Type: ContainerImage object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 Response Elements API Version 2016-11-28 630 Amazon Lightsail NotFoundException API Reference Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 631 API Reference Amazon Lightsail ReleaseStaticIp Deletes a speciﬁc static IP from your account. Request Syntax { "staticIpName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. staticIpName The name of the static IP to delete. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", ReleaseStaticIp API Version 2016-11-28 632 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 633 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 634 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 635 Amazon Lightsail API Reference ResetDistributionCache Deletes currently cached content from your Amazon Lightsail
amazon-lightsail-api-reference-126	amazon-lightsail-api-reference.pdf	126	more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See Also API Version 2016-11-28 634 Amazon Lightsail • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 635 Amazon Lightsail API Reference ResetDistributionCache Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution. After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin. Request Syntax { "distributionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. distributionName The name of the distribution for which to reset cache. Use the GetDistributions action to get a list of distribution names that you can specify. Type: String Pattern: \w[\w\-]*\w Required: No Response Syntax { "createTime": number, "operation": { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", ResetDistributionCache API Version 2016-11-28 636 Amazon Lightsail API Reference "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number }, "status": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. createTime The timestamp of the reset cache request (1479734909.17) in Unix time format. Type: Timestamp operation An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Operation object status The status of the reset cache request. Type: String Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2016-11-28 637 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 638 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 639 Amazon Lightsail API Reference SendContactMethodVeriﬁcation Sends a veriﬁcation request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be veriﬁed. A contact method is used to send you notiﬁcations about your Amazon Lightsail resources. You can add one email address and one mobile phone number contact method in each AWS Region. However, SMS text messaging is not supported in some AWS Regions, and SMS text messages cannot be sent to some countries/regions. For more information, see Notiﬁcations in Amazon Lightsail. A veriﬁcation request is sent to the contact method when you initially create it. Use this action to send another veriﬁcation request if a previous veriﬁcation request was deleted, or has expired. Important Notiﬁcations are not sent to an email contact method until after it is veriﬁed, and conﬁrmed as valid. Request Syntax { "protocol": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. protocol The protocol to verify, such as Email or SMS (text messaging). Type: String Valid Values: Email Required: Yes SendContactMethodVeriﬁcation API Version 2016-11-28 640 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status":
amazon-lightsail-api-reference-127	amazon-lightsail-api-reference.pdf	127	until after it is veriﬁed, and conﬁrmed as valid. Request Syntax { "protocol": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. protocol The protocol to verify, such as Email or SMS (text messaging). Type: String Valid Values: Email Required: Yes SendContactMethodVeriﬁcation API Version 2016-11-28 640 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 641 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 Errors API Version 2016-11-28 642 Amazon Lightsail See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 643 Amazon Lightsail SetIpAddressType API Reference Sets the IP address type for an Amazon Lightsail resource. Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the speciﬁed resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only. Request Syntax { "acceptBundleUpdate": boolean, "ipAddressType": "string", "resourceName": "string", "resourceType": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. acceptBundleUpdate Required parameter to accept the instance bundle update when changing to, and from, IPv6- only. Note An instance bundle will change when switching from dual-stack or ipv4, to ipv6. It also changes when switching from ipv6, to dual-stack or ipv4. You must include this parameter in the command to update the bundle. For example, if you switch from dual-stack to ipv6, the bundle will be updated, and billing for the IPv6-only instance bundle begins immediately. Type: Boolean Required: No SetIpAddressType API Version 2016-11-28 644 Amazon Lightsail ipAddressType API Reference The IP address type to set for the speciﬁed resource. The possible values are ipv4 for IPv4 only, ipv6 for IPv6 only, and dualstack for IPv4 and IPv6. Type: String Valid Values: dualstack \| ipv4 \| ipv6 Required: Yes resourceName The name of the resource for which to set the IP address type. Type: String Pattern: \w[\w\-]*\w Required: Yes resourceType The resource type. The resource values are Distribution, Instance, and LoadBalancer. Note Distribution-related APIs are available only in the N. Virginia (us-east-1) AWS Region. Set your AWS Region conﬁguration to us-east-1 to create, view, or edit distributions. Type: String Valid Values: ContainerService \| Instance \| StaticIp \| KeyPair \| InstanceSnapshot \| Domain \| PeeredVpc \| LoadBalancer \| LoadBalancerTlsCertificate \| Disk \| DiskSnapshot \| RelationalDatabase \| RelationalDatabaseSnapshot \| ExportSnapshotRecord \| Request Parameters API Version 2016-11-28 645 Amazon Lightsail API Reference CloudFormationStackRecord \| Alarm \| ContactMethod \| Distribution \| Certificate \| Bucket Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by
amazon-lightsail-api-reference-128	amazon-lightsail-api-reference.pdf	128	\| LoadBalancer \| LoadBalancerTlsCertificate \| Disk \| DiskSnapshot \| RelationalDatabase \| RelationalDatabaseSnapshot \| ExportSnapshotRecord \| Request Parameters API Version 2016-11-28 645 Amazon Lightsail API Reference CloudFormationStackRecord \| Alarm \| ContactMethod \| Distribution \| Certificate \| Bucket Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 646 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 647 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 648 Amazon Lightsail API Reference SetResourceAccessForBucket Sets the Amazon Lightsail resources that can access the speciﬁed Lightsail bucket. Lightsail buckets currently support setting access for Lightsail instances in the same AWS Region. Request Syntax { "access": "string", "bucketName": "string", "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. access The access setting. The following access settings are available: • allow - Allows access to the bucket and its objects. • deny - Denies access to the bucket and its objects. Use this setting to remove access for a resource previously set to allow. Type: String Valid Values: allow \| deny Required: Yes bucketName The name of the bucket for which to set access to another Lightsail resource. Type: String Length Constraints: Minimum length of 3. Maximum length of 54. SetResourceAccessForBucket API Version 2016-11-28 649 Amazon Lightsail API Reference Pattern: ^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$ Required: Yes resourceName The name of the Lightsail instance for which to set bucket access. The instance must be in a running or stopped state. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2016-11-28 650 Amazon Lightsail API Reference The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it
amazon-lightsail-api-reference-129	amazon-lightsail-api-reference.pdf	129	Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 651 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 652 Amazon Lightsail SetupInstanceHttps API Reference Creates an SSL/TLS certiﬁcate that secures traﬃc for your website. After the certiﬁcate is created, it is installed on the speciﬁed Lightsail instance. If you provide more than one domain name in the request, at least one name must be less than or equal to 63 characters in length. Request Syntax { "certificateProvider": "string", "domainNames": [ "string" ], "emailAddress": "string", "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. certiﬁcateProvider The certiﬁcate authority that issues the SSL/TLS certiﬁcate. Type: String Valid Values: LetsEncrypt Required: Yes domainNames The name of the domain and subdomains that were speciﬁed for the SSL/TLS certiﬁcate. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 4. Maximum length of 253. SetupInstanceHttps API Version 2016-11-28 653 Amazon Lightsail API Reference Pattern: ^[a-zA-Z0-9\-]{1,63}(\.[a-zA-Z0-9\-]{1,63}){0,8}(\.[a-zA-Z] {2,63})$ Required: Yes emailAddress The contact method for SSL/TLS certiﬁcate renewal alerts. You can enter one email address. Type: String Length Constraints: Minimum length of 6. Maximum length of 254. Pattern: ^[\w!#$%&.'+\/=?^_\x60{\|}~\-]{1,64}@[a-zA-Z0-9\-]{1,63}(\.[a-zA- Z0-9\-]{1,63}){0,8}(\.[a-zA-Z]{2,63})$ Required: Yes instanceName The name of the Lightsail instance. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", Response Syntax API Version 2016-11-28 654 Amazon Lightsail API Reference "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations The available API operations for SetupInstanceHttps. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 655 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 656 Amazon Lightsail StartGUISession API Reference Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common
amazon-lightsail-api-reference-130	amazon-lightsail-api-reference.pdf	130	SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 656 Amazon Lightsail StartGUISession API Reference Initiates a graphical user interface (GUI) session that’s used to access a virtual computer’s operating system and application. The session will be active for 1 hour. Use this action to resume the session after it expires. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceName The resource name. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { StartGUISession API Version 2016-11-28 657 Amazon Lightsail API Reference "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations The available API operations. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Response Elements API Version 2016-11-28 658 Amazon Lightsail Note API Reference Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 See Also API Version 2016-11-28 659 Amazon Lightsail • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2016-11-28 660 Amazon Lightsail StartInstance API Reference Starts a speciﬁc Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation. Note When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. The start instance operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. instanceName The name of the instance (a virtual private server) to start. Type: String Pattern: \w[\w\-]\w Required: Yes StartInstance API Version 2016-11-28 661 API Reference Amazon Lightsail Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 662 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region
amazon-lightsail-api-reference-131	amazon-lightsail-api-reference.pdf	131	are common to all actions, see Common Errors. Response Syntax API Version 2016-11-28 662 Amazon Lightsail AccessDeniedException API Reference Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 Errors API Version 2016-11-28 663 Amazon Lightsail UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 664 Amazon Lightsail API Reference StartRelationalDatabase Starts a speciﬁc database from a stopped state in Amazon Lightsail. To restart a database, use the reboot relational database operation. The start relational database operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of your database to start. Type: String Pattern: \w[\w\-]*\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", StartRelationalDatabase API Version 2016-11-28 665 Amazon Lightsail API Reference "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. Response Elements API Version 2016-11-28 666 Amazon Lightsail HTTP Status Code: 400 InvalidInputException API Reference Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: See Also API Version 2016-11-28 667 API Reference Amazon Lightsail • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 668 Amazon Lightsail StopGUISession API Reference Terminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceName The resource name.
amazon-lightsail-api-reference-132	amazon-lightsail-api-reference.pdf	132	SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 668 Amazon Lightsail StopGUISession API Reference Terminates a web-based Amazon DCV session that’s used to access a virtual computer’s operating system or application. The session will close and any unsaved data will be lost. Request Syntax { "resourceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. resourceName The resource name. Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", StopGUISession API Version 2016-11-28 669 Amazon Lightsail API Reference "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations The available API operations. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. Response Elements API Version 2016-11-28 670 Amazon Lightsail HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. API Reference HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 671 Amazon Lightsail StopInstance API Reference Stops a speciﬁc Amazon Lightsail instance that is currently running. Note When you start a stopped instance, Lightsail assigns a new public IP address to the instance. To use the same IP address after stopping and starting an instance, create a static IP address and attach it to the instance. For more information, see the Amazon Lightsail Developer Guide. The stop instance operation supports tag-based access control via resource tags applied to the resource identiﬁed by instance name. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "force": boolean, "instanceName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. force When set to True, forces a Lightsail instance that is stuck in a stopping state to stop. Important Only use the force parameter if your instance is stuck in the stopping state. In any other state, your instance should stop normally without adding this parameter to your API request. StopInstance API Version 2016-11-28 672 Amazon Lightsail Type: Boolean Required: No instanceName The name of the instance (a virtual private server) to stop. API Reference Type: String Pattern: \w[\w\-]\w Required: Yes Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2016-11-28 673 Amazon Lightsail operations API Reference An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of
amazon-lightsail-api-reference-133	amazon-lightsail-api-reference.pdf	133	the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 Errors API Version 2016-11-28 674 Amazon Lightsail OperationFailureException API Reference Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. HTTP Status Code: 500 UnauthenticatedException Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2016-11-28 675 Amazon Lightsail API Reference StopRelationalDatabase Stops a speciﬁc database that is currently running in Amazon Lightsail. Note If you don't manually start your database instance after it has been stopped for seven consecutive days, Amazon Lightsail automatically starts it for you. This action helps ensure that your database instance doesn't fall behind on any required maintenance updates. The stop relational database operation supports tag-based access control via resource tags applied to the resource identiﬁed by relationalDatabaseName. For more information, see the Amazon Lightsail Developer Guide. Request Syntax { "relationalDatabaseName": "string", "relationalDatabaseSnapshotName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. relationalDatabaseName The name of your database to stop. Type: String Pattern: \w[\w\-]\w Required: Yes relationalDatabaseSnapshotName The name of your new database snapshot to be created before stopping your database. StopRelationalDatabase API Version 2016-11-28 676 API Reference Amazon Lightsail Type: String Pattern: \w[\w\-]\w Required: No Response Syntax { "operations": [ { "createdAt": number, "errorCode": "string", "errorDetails": "string", "id": "string", "isTerminal": boolean, "location": { "availabilityZone": "string", "regionName": "string" }, "operationDetails": "string", "operationType": "string", "resourceName": "string", "resourceType": "string", "status": "string", "statusChangedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. operations An array of objects that describe the result of the action, such as the status of the request, the timestamp of the request, and the resources aﬀected by the request. Type: Array of Operation objects Response Syntax API Version 2016-11-28 677 Amazon Lightsail Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource. HTTP Status Code: 400 AccountSetupInProgressException Lightsail throws this exception when an account is still in the setup in progress state. HTTP Status Code: 400 InvalidInputException Lightsail throws this exception when user input does not conform to the validation rules of an input ﬁeld. Note Domain and distribution APIs are only available in the N. Virginia (us-east-1) AWS Region. Please set your AWS Region conﬁguration to us-east-1 to create, view, or edit these resources. HTTP Status Code: 400 NotFoundException Lightsail throws this exception when it cannot ﬁnd a resource. HTTP Status Code: 400 OperationFailureException Lightsail throws this exception when an operation fails to execute. HTTP Status Code: 400 ServiceException A general service exception. Errors API Version 2016-11-28 678 Amazon Lightsail HTTP Status Code: 500 UnauthenticatedException API Reference Lightsail throws this exception when the user has not been authenticated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.