# Actions
The following actions are supported:
+ [AllocateStaticIp](API_AllocateStaticIp.md)
+ [AttachCertificateToDistribution](API_AttachCertificateToDistribution.md)
+ [AttachDisk](API_AttachDisk.md)
+ [AttachInstancesToLoadBalancer](API_AttachInstancesToLoadBalancer.md)
+ [AttachLoadBalancerTlsCertificate](API_AttachLoadBalancerTlsCertificate.md)
+ [AttachStaticIp](API_AttachStaticIp.md)
+ [CloseInstancePublicPorts](API_CloseInstancePublicPorts.md)
+ [CopySnapshot](API_CopySnapshot.md)
+ [CreateBucket](API_CreateBucket.md)
+ [CreateBucketAccessKey](API_CreateBucketAccessKey.md)
+ [CreateCertificate](API_CreateCertificate.md)
+ [CreateCloudFormationStack](API_CreateCloudFormationStack.md)
+ [CreateContactMethod](API_CreateContactMethod.md)
+ [CreateContainerService](API_CreateContainerService.md)
+ [CreateContainerServiceDeployment](API_CreateContainerServiceDeployment.md)
+ [CreateContainerServiceRegistryLogin](API_CreateContainerServiceRegistryLogin.md)
+ [CreateDisk](API_CreateDisk.md)
+ [CreateDiskFromSnapshot](API_CreateDiskFromSnapshot.md)
+ [CreateDiskSnapshot](API_CreateDiskSnapshot.md)
+ [CreateDistribution](API_CreateDistribution.md)
+ [CreateDomain](API_CreateDomain.md)
+ [CreateDomainEntry](API_CreateDomainEntry.md)
+ [CreateGUISessionAccessDetails](API_CreateGUISessionAccessDetails.md)
+ [CreateInstances](API_CreateInstances.md)
+ [CreateInstancesFromSnapshot](API_CreateInstancesFromSnapshot.md)
+ [CreateInstanceSnapshot](API_CreateInstanceSnapshot.md)
+ [CreateKeyPair](API_CreateKeyPair.md)
+ [CreateLoadBalancer](API_CreateLoadBalancer.md)
+ [CreateLoadBalancerTlsCertificate](API_CreateLoadBalancerTlsCertificate.md)
+ [CreateRelationalDatabase](API_CreateRelationalDatabase.md)
+ [CreateRelationalDatabaseFromSnapshot](API_CreateRelationalDatabaseFromSnapshot.md)
+ [CreateRelationalDatabaseSnapshot](API_CreateRelationalDatabaseSnapshot.md)
+ [DeleteAlarm](API_DeleteAlarm.md)
+ [DeleteAutoSnapshot](API_DeleteAutoSnapshot.md)
+ [DeleteBucket](API_DeleteBucket.md)
+ [DeleteBucketAccessKey](API_DeleteBucketAccessKey.md)
+ [DeleteCertificate](API_DeleteCertificate.md)
+ [DeleteContactMethod](API_DeleteContactMethod.md)
+ [DeleteContainerImage](API_DeleteContainerImage.md)
+ [DeleteContainerService](API_DeleteContainerService.md)
+ [DeleteDisk](API_DeleteDisk.md)
+ [DeleteDiskSnapshot](API_DeleteDiskSnapshot.md)
+ [DeleteDistribution](API_DeleteDistribution.md)
+ [DeleteDomain](API_DeleteDomain.md)
+ [DeleteDomainEntry](API_DeleteDomainEntry.md)
+ [DeleteInstance](API_DeleteInstance.md)
+ [DeleteInstanceSnapshot](API_DeleteInstanceSnapshot.md)
+ [DeleteKeyPair](API_DeleteKeyPair.md)
+ [DeleteKnownHostKeys](API_DeleteKnownHostKeys.md)
+ [DeleteLoadBalancer](API_DeleteLoadBalancer.md)
+ [DeleteLoadBalancerTlsCertificate](API_DeleteLoadBalancerTlsCertificate.md)
+ [DeleteRelationalDatabase](API_DeleteRelationalDatabase.md)
+ [DeleteRelationalDatabaseSnapshot](API_DeleteRelationalDatabaseSnapshot.md)
+ [DetachCertificateFromDistribution](API_DetachCertificateFromDistribution.md)
+ [DetachDisk](API_DetachDisk.md)
+ [DetachInstancesFromLoadBalancer](API_DetachInstancesFromLoadBalancer.md)
+ [DetachStaticIp](API_DetachStaticIp.md)
+ [DisableAddOn](API_DisableAddOn.md)
+ [DownloadDefaultKeyPair](API_DownloadDefaultKeyPair.md)
+ [EnableAddOn](API_EnableAddOn.md)
+ [ExportSnapshot](API_ExportSnapshot.md)
+ [GetActiveNames](API_GetActiveNames.md)
+ [GetAlarms](API_GetAlarms.md)
+ [GetAutoSnapshots](API_GetAutoSnapshots.md)
+ [GetBlueprints](API_GetBlueprints.md)
+ [GetBucketAccessKeys](API_GetBucketAccessKeys.md)
+ [GetBucketBundles](API_GetBucketBundles.md)
+ [GetBucketMetricData](API_GetBucketMetricData.md)
+ [GetBuckets](API_GetBuckets.md)
+ [GetBundles](API_GetBundles.md)
+ [GetCertificates](API_GetCertificates.md)
+ [GetCloudFormationStackRecords](API_GetCloudFormationStackRecords.md)
+ [GetContactMethods](API_GetContactMethods.md)
+ [GetContainerAPIMetadata](API_GetContainerAPIMetadata.md)
+ [GetContainerImages](API_GetContainerImages.md)
+ [GetContainerLog](API_GetContainerLog.md)
+ [GetContainerServiceDeployments](API_GetContainerServiceDeployments.md)
+ [GetContainerServiceMetricData](API_GetContainerServiceMetricData.md)
+ [GetContainerServicePowers](API_GetContainerServicePowers.md)
+ [GetContainerServices](API_GetContainerServices.md)
+ [GetCostEstimate](API_GetCostEstimate.md)
+ [GetDisk](API_GetDisk.md)
+ [GetDisks](API_GetDisks.md)
+ [GetDiskSnapshot](API_GetDiskSnapshot.md)
+ [GetDiskSnapshots](API_GetDiskSnapshots.md)
+ [GetDistributionBundles](API_GetDistributionBundles.md)
+ [GetDistributionLatestCacheReset](API_GetDistributionLatestCacheReset.md)
+ [GetDistributionMetricData](API_GetDistributionMetricData.md)
+ [GetDistributions](API_GetDistributions.md)
+ [GetDomain](API_GetDomain.md)
+ [GetDomains](API_GetDomains.md)
+ [GetExportSnapshotRecords](API_GetExportSnapshotRecords.md)
+ [GetInstance](API_GetInstance.md)
+ [GetInstanceAccessDetails](API_GetInstanceAccessDetails.md)
+ [GetInstanceMetricData](API_GetInstanceMetricData.md)
+ [GetInstancePortStates](API_GetInstancePortStates.md)
+ [GetInstances](API_GetInstances.md)
+ [GetInstanceSnapshot](API_GetInstanceSnapshot.md)
+ [GetInstanceSnapshots](API_GetInstanceSnapshots.md)
+ [GetInstanceState](API_GetInstanceState.md)
+ [GetKeyPair](API_GetKeyPair.md)
+ [GetKeyPairs](API_GetKeyPairs.md)
+ [GetLoadBalancer](API_GetLoadBalancer.md)
+ [GetLoadBalancerMetricData](API_GetLoadBalancerMetricData.md)
+ [GetLoadBalancers](API_GetLoadBalancers.md)
+ [GetLoadBalancerTlsCertificates](API_GetLoadBalancerTlsCertificates.md)
+ [GetLoadBalancerTlsPolicies](API_GetLoadBalancerTlsPolicies.md)
+ [GetOperation](API_GetOperation.md)
+ [GetOperations](API_GetOperations.md)
+ [GetOperationsForResource](API_GetOperationsForResource.md)
+ [GetRegions](API_GetRegions.md)
+ [GetRelationalDatabase](API_GetRelationalDatabase.md)
+ [GetRelationalDatabaseBlueprints](API_GetRelationalDatabaseBlueprints.md)
+ [GetRelationalDatabaseBundles](API_GetRelationalDatabaseBundles.md)
+ [GetRelationalDatabaseEvents](API_GetRelationalDatabaseEvents.md)
+ [GetRelationalDatabaseLogEvents](API_GetRelationalDatabaseLogEvents.md)
+ [GetRelationalDatabaseLogStreams](API_GetRelationalDatabaseLogStreams.md)
+ [GetRelationalDatabaseMasterUserPassword](API_GetRelationalDatabaseMasterUserPassword.md)
+ [GetRelationalDatabaseMetricData](API_GetRelationalDatabaseMetricData.md)
+ [GetRelationalDatabaseParameters](API_GetRelationalDatabaseParameters.md)
+ [GetRelationalDatabases](API_GetRelationalDatabases.md)
+ [GetRelationalDatabaseSnapshot](API_GetRelationalDatabaseSnapshot.md)
+ [GetRelationalDatabaseSnapshots](API_GetRelationalDatabaseSnapshots.md)
+ [GetSetupHistory](API_GetSetupHistory.md)
+ [GetStaticIp](API_GetStaticIp.md)
+ [GetStaticIps](API_GetStaticIps.md)
+ [ImportKeyPair](API_ImportKeyPair.md)
+ [IsVpcPeered](API_IsVpcPeered.md)
+ [OpenInstancePublicPorts](API_OpenInstancePublicPorts.md)
+ [PeerVpc](API_PeerVpc.md)
+ [PutAlarm](API_PutAlarm.md)
+ [PutInstancePublicPorts](API_PutInstancePublicPorts.md)
+ [RebootInstance](API_RebootInstance.md)
+ [RebootRelationalDatabase](API_RebootRelationalDatabase.md)
+ [RegisterContainerImage](API_RegisterContainerImage.md)
+ [ReleaseStaticIp](API_ReleaseStaticIp.md)
+ [ResetDistributionCache](API_ResetDistributionCache.md)
+ [SendContactMethodVerification](API_SendContactMethodVerification.md)
+ [SetIpAddressType](API_SetIpAddressType.md)
+ [SetResourceAccessForBucket](API_SetResourceAccessForBucket.md)
+ [SetupInstanceHttps](API_SetupInstanceHttps.md)
+ [StartGUISession](API_StartGUISession.md)
+ [StartInstance](API_StartInstance.md)
+ [StartRelationalDatabase](API_StartRelationalDatabase.md)
+ [StopGUISession](API_StopGUISession.md)
+ [StopInstance](API_StopInstance.md)
+ [StopRelationalDatabase](API_StopRelationalDatabase.md)
+ [TagResource](API_TagResource.md)
+ [TestAlarm](API_TestAlarm.md)
+ [UnpeerVpc](API_UnpeerVpc.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateBucket](API_UpdateBucket.md)
+ [UpdateBucketBundle](API_UpdateBucketBundle.md)
+ [UpdateContainerService](API_UpdateContainerService.md)
+ [UpdateDistribution](API_UpdateDistribution.md)
+ [UpdateDistributionBundle](API_UpdateDistributionBundle.md)
+ [UpdateDomainEntry](API_UpdateDomainEntry.md)
+ [UpdateInstanceMetadataOptions](API_UpdateInstanceMetadataOptions.md)
+ [UpdateLoadBalancerAttribute](API_UpdateLoadBalancerAttribute.md)
+ [UpdateRelationalDatabase](API_UpdateRelationalDatabase.md)
+ [UpdateRelationalDatabaseParameters](API_UpdateRelationalDatabaseParameters.md)
# AllocateStaticIp
Allocates a static IP address.
## Request Syntax
```
{
"staticIpName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [staticIpName](#API_AllocateStaticIp_RequestSyntax) **
The name of the static IP address.
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.
** [operations](#API_AllocateStaticIp_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AllocateStaticIp)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AllocateStaticIp)
# AttachCertificateToDistribution
Attaches an SSL/TLS certificate to your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is attached, your distribution accepts HTTPS traffic for all of the domains that are associated with the certificate.
Use the `CreateCertificate` action to create a certificate that you can attach to your distribution.
**Important**
Only certificates created in the `us-east-1` AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the `us-east-1` Region.
## Request Syntax
```
{
"certificateName": "string",
"distributionName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_AttachCertificateToDistribution_RequestSyntax) **
The name of the certificate to attach to a distribution.
Only certificates with a status of `ISSUED` can be attached to a distribution.
Use the `GetCertificates` action to get a list of certificate names that you can specify.
This is the name of the certificate resource type and is used only to reference the certificate in other API actions. It can be different than the domain name of the certificate. For example, your certificate name might be `WordPress-Blog-Certificate` and the domain name of the certificate might be `example.com`.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [distributionName](#API_AttachCertificateToDistribution_RequestSyntax) **
The name of the distribution that the certificate will be attached to.
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",
"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](#API_AttachCertificateToDistribution_ResponseSyntax) **
An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AttachCertificateToDistribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AttachCertificateToDistribution)
# AttachDisk
Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.
The `attach disk` operation supports tag-based access control via resource tags applied to the resource identified by `disk name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"autoMounting": boolean,
"diskName": "string",
"diskPath": "string",
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [autoMounting](#API_AttachDisk_RequestSyntax) **
A Boolean value used to determine the automatic mounting of a storage volume to a virtual computer. The default value is `False`.
This value only applies to Lightsail for Research resources.
Type: Boolean
Required: No
** [diskName](#API_AttachDisk_RequestSyntax) **
The unique Lightsail disk name (`my-disk`).
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [diskPath](#API_AttachDisk_RequestSyntax) **
The disk path to expose to the instance (`/dev/xvdf`).
Type: String
Pattern: `.*\S.*`
Required: Yes
** [instanceName](#API_AttachDisk_RequestSyntax) **
The name of the Lightsail instance where you want to utilize the storage disk.
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.
** [operations](#API_AttachDisk_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AttachDisk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AttachDisk)
# AttachInstancesToLoadBalancer
Attaches one or more Lightsail instances to a load balancer.
After some time, the instances are attached to the load balancer and the health check status is available.
The `attach instances to load balancer` operation supports tag-based access control via resource tags applied to the resource identified by `load balancer name`. For more information, see the [Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceNames": [ "string" ],
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceNames](#API_AttachInstancesToLoadBalancer_RequestSyntax) **
An array of strings representing the instance name(s) you want to attach to your load balancer.
An instance must be `running` before you can attach it to your load balancer.
There are no additional limits on the number of instances you can attach to your load balancer, aside from the limit of Lightsail instances you can create in your account (20).
Type: Array of strings
Pattern: `\w[\w\-]*\w`
Required: Yes
** [loadBalancerName](#API_AttachInstancesToLoadBalancer_RequestSyntax) **
The name of the load balancer.
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.
** [operations](#API_AttachInstancesToLoadBalancer_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AttachInstancesToLoadBalancer)
# AttachLoadBalancerTlsCertificate
Attaches a Transport Layer Security (TLS) certificate to your load balancer. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
Once you create and validate your certificate, you can attach it to your load balancer. You can also use this API to rotate the certificates on your account. Use the `AttachLoadBalancerTlsCertificate` action with the non-attached certificate, and it will replace the existing one and become the attached certificate.
The `AttachLoadBalancerTlsCertificate` operation supports tag-based access control via resource tags applied to the resource identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"certificateName": "string",
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_AttachLoadBalancerTlsCertificate_RequestSyntax) **
The name of your SSL/TLS certificate.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [loadBalancerName](#API_AttachLoadBalancerTlsCertificate_RequestSyntax) **
The name of the load balancer to which you want to associate the SSL/TLS certificate.
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.
** [operations](#API_AttachLoadBalancerTlsCertificate_ResponseSyntax) **
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 affected by the request.
These SSL/TLS certificates are only usable by Lightsail load balancers. You can't get the certificate and use it for another purpose.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AttachLoadBalancerTlsCertificate)
# AttachStaticIp
Attaches a static IP address to a specific Amazon Lightsail instance.
## Request Syntax
```
{
"instanceName": "string",
"staticIpName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_AttachStaticIp_RequestSyntax) **
The instance name to which you want to attach the static IP address.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [staticIpName](#API_AttachStaticIp_RequestSyntax) **
The name of the static IP.
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.
** [operations](#API_AttachStaticIp_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/AttachStaticIp)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/AttachStaticIp)
# CloseInstancePublicPorts
Closes ports for a specific Amazon Lightsail instance.
The `CloseInstancePublicPorts` action supports tag-based access control via resource tags applied to the resource identified by `instanceName`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_CloseInstancePublicPorts_RequestSyntax) **
The name of the instance for which to close ports.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [portInfo](#API_CloseInstancePublicPorts_RequestSyntax) **
An object to describe the ports to close for the specified instance.
Type: [PortInfo](API_PortInfo.md) 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](#API_CloseInstancePublicPorts_ResponseSyntax) **
An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CloseInstancePublicPorts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CloseInstancePublicPorts)
# CopySnapshot
Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one AWS Region to another in Amazon Lightsail.
When copying a *manual snapshot*, be sure to define the `source region`, `source snapshot name`, and `target snapshot name` parameters.
When copying an *automatic snapshot*, be sure to define the `source region`, `source resource name`, `target snapshot name`, and either the `restore date` or the `use latest restorable auto snapshot` parameters.
## Request Syntax
```
{
"restoreDate": "string",
"sourceRegion": "string",
"sourceResourceName": "string",
"sourceSnapshotName": "string",
"targetSnapshotName": "string",
"useLatestRestorableAutoSnapshot": boolean
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [restoreDate](#API_CopySnapshot_RequestSyntax) **
The date of the source automatic snapshot to copy. Use the `get auto snapshots` operation to identify the dates of the available automatic snapshots.
Constraints:
+ Must be specified in `YYYY-MM-DD` format.
+ This parameter cannot be defined together with the `use latest restorable auto snapshot` parameter. The `restore date` and `use latest restorable auto snapshot` parameters are mutually exclusive.
+ Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots).
Type: String
Required: No
** [sourceRegion](#API_CopySnapshot_RequestSyntax) **
The AWS Region where the source manual or automatic snapshot is located.
Type: String
Valid Values: `us-east-1 | us-east-2 | us-west-1 | us-west-2 | eu-west-1 | eu-west-2 | eu-west-3 | eu-central-1 | eu-north-1 | ca-central-1 | ap-south-1 | ap-southeast-1 | ap-southeast-2 | ap-northeast-1 | ap-northeast-2 | ap-southeast-3 | ap-southeast-5`
Required: Yes
** [sourceResourceName](#API_CopySnapshot_RequestSyntax) **
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
+ Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots).
Type: String
Required: No
** [sourceSnapshotName](#API_CopySnapshot_RequestSyntax) **
The name of the source manual snapshot to copy.
Constraint:
+ Define this parameter only when copying a manual snapshot as another manual snapshot.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [targetSnapshotName](#API_CopySnapshot_RequestSyntax) **
The name of the new manual snapshot to be created as a copy.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [useLatestRestorableAutoSnapshot](#API_CopySnapshot_RequestSyntax) **
A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
+ This parameter cannot be defined together with the `restore date` parameter. The `use latest restorable auto snapshot` and `restore date` parameters are mutually exclusive.
+ Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-keeping-automatic-snapshots).
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](#API_CopySnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) 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)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
### Copy an automatic snapshot
The following example creates a new manual snapshot named `CopiedAutoSnapshot-2019-09-25` as a copy of the existing automatic snapshot named `2019-09-25` from the `WordPress-1` instance 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.CopySnapshot
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20190927T194244Z
Authorization: AUTHPARAMS
Content-Length: 150
{
"sourceResourceName": "WordPress-1",
"restoreDate": "2019-09-25",
"targetSnapshotName": "CopiedAutoSnapshot-2019-09-25",
"sourceRegion": "us-west-2"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
Server: Server
Date: Fri, 27 Sep 2019 19:42:46 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 380
x-amzn-RequestId: 69449102-9023-431e-8a00-7EXAMPLE6970
Connection: keep-alive
{
"operations": [{
"createdAt": 1.56961336589E9,
"id": "0710de23-b848-4146-887d-ec12093c049d",
"isTerminal": false,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"operationDetails": "us-west-2:WordPress-1",
"operationType": "CopySnapshot",
"resourceName": "CopiedAutoSnapshot-2019-09-25",
"resourceType": "InstanceSnapshot",
"status": "Started",
"statusChangedAt": 1.56961336589E9
}]
}
```
### Copy a manual snapshot
The following example creates a new manual snapshot named `CopiedManualSnapshot-2019-09-25` as a copy of the existing manual snapshot named `WordPress-1-1569608575` 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.CopySnapshot
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20190927T195200Z
Authorization: AUTHPARAMS
Content-Length: 134
{
"sourceSnapshotName": "WordPress-1-1569608575",
"targetSnapshotName": "CopiedManualSnapshot-2019-09-25",
"sourceRegion": "us-west-2"
}
```
#### Sample Response
```
HTTP/1.1 200 OK
Server: Server
Date: Fri, 27 Sep 2019 19:52:01 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 395
x-amzn-RequestId: 5e3e211b-0afe-439e-bead-8EXAMPLEb3c8
Connection: keep-alive
{
"operations": [{
"createdAt": 1.569613921044E9,
"id": "0d4f2d2a-78ce-44d1-82fe-33588af9afa0",
"isTerminal": false,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"operationDetails": "us-west-2:WordPress-1-1569608575",
"operationType": "CopySnapshot",
"resourceName": "CopiedManualSnapshot-2019-09-25",
"resourceType": "InstanceSnapshot",
"status": "Started",
"statusChangedAt": 1.569613921044E9
}]
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CopySnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CopySnapshot)
# CreateBucket
Creates an Amazon Lightsail bucket.
A bucket is a cloud storage resource available in the Lightsail object storage service. Use buckets to store objects such as data and its descriptive metadata. For more information about buckets, see [Buckets in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail) in the *Amazon Lightsail Developer Guide*.
## Request Syntax
```
{
"bucketName": "string",
"bundleId": "string",
"enableObjectVersioning": boolean,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_CreateBucket_RequestSyntax) **
The name for the bucket.
For more information about bucket names, see [Bucket naming rules in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/bucket-naming-rules-in-amazon-lightsail) in the *Amazon Lightsail Developer Guide*.
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
** [bundleId](#API_CreateBucket_RequestSyntax) **
The ID of the bundle to use for the bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket.
Use the [GetBucketBundles](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) action to get a list of bundle IDs that you can specify.
Use the [UpdateBucketBundle](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) action to change the bundle after the bucket is created.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [enableObjectVersioning](#API_CreateBucket_RequestSyntax) **
A Boolean value that indicates whether to enable versioning of objects in the bucket.
For more information about versioning, see [Enabling and suspending object versioning in a bucket in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-managing-bucket-object-versioning) in the *Amazon Lightsail Developer Guide*.
Type: Boolean
Required: No
** [tags](#API_CreateBucket_RequestSyntax) **
The tag keys and optional values to add to the bucket during creation.
Use the [TagResource](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_TagResource.html) action to tag the bucket after it's created.
Type: Array of [Tag](API_Tag.md) objects
Required: No
## Response Syntax
```
{
"bucket": {
"ableToUpdateBundle": boolean,
"accessLogConfig": {
"destination": "string",
"enabled": boolean,
"prefix": "string"
},
"accessRules": {
"allowPublicOverrides": boolean,
"getObject": "string"
},
"arn": "string",
"bundleId": "string",
"cors": {
"rules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposeHeaders": [ "string" ],
"id": "string",
"maxAgeSeconds": number
}
]
},
"createdAt": number,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"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"
},
"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.
** [bucket](#API_CreateBucket_ResponseSyntax) **
An object that describes the bucket that is created.
Type: [Bucket](API_Bucket.md) object
** [operations](#API_CreateBucket_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateBucket)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateBucket)
# CreateBucketAccessKey
Creates a new access key for the specified Amazon Lightsail bucket. Access keys consist of an access key ID and corresponding secret access key.
Access keys grant full programmatic access to the specified bucket and its objects. You can have a maximum of two access keys per bucket. Use the [GetBucketAccessKeys](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) action to get a list of current access keys for a specific bucket. For more information about access keys, see [Creating access keys for a bucket in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-bucket-access-keys) in the *Amazon Lightsail Developer Guide*.
**Important**
The `secretAccessKey` value is returned only in response to the `CreateBucketAccessKey` action. You can get a secret access key only when you first create an access key; you cannot get the secret access key later. 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_CreateBucketAccessKey_RequestSyntax) **
The name of the bucket that the new access key will belong to, and grant access 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
## Response Syntax
```
{
"accessKey": {
"accessKeyId": "string",
"createdAt": number,
"lastUsed": {
"lastUsedDate": number,
"region": "string",
"serviceName": "string"
},
"secretAccessKey": "string",
"status": "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.
** [accessKey](#API_CreateBucketAccessKey_ResponseSyntax) **
An object that describes the access key that is created.
Type: [AccessKey](API_AccessKey.md) object
** [operations](#API_CreateBucketAccessKey_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateBucketAccessKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateBucketAccessKey)
# CreateCertificate
Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.
After the certificate is valid, use the `AttachCertificateToDistribution` action to use the certificate and its domains with your distribution. Or use the `UpdateContainerService` action to use the certificate and its domains with your container service.
**Important**
Only certificates created in the `us-east-1` AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the `us-east-1` Region.
## Request Syntax
```
{
"certificateName": "string",
"domainName": "string",
"subjectAlternativeNames": [ "string" ],
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_CreateCertificate_RequestSyntax) **
The name for the certificate.
Type: String
Required: Yes
** [domainName](#API_CreateCertificate_RequestSyntax) **
The domain name (`example.com`) for the certificate.
Type: String
Required: Yes
** [subjectAlternativeNames](#API_CreateCertificate_RequestSyntax) **
An array of strings that specify the alternate domains (`example2.com`) and subdomains (`blog.example.com`) for the certificate.
You can specify a maximum of nine alternate domains (in addition to the primary domain name).
Wildcard domain entries (`*.example.com`) are not supported.
Type: Array of strings
Required: No
** [tags](#API_CreateCertificate_RequestSyntax) **
The tag keys and optional values to add to the certificate during create.
Use the `TagResource` action to tag a resource after it's created.
Type: Array of [Tag](API_Tag.md) objects
Required: No
## Response Syntax
```
{
"certificate": {
"certificateArn": "string",
"certificateDetail": {
"arn": "string",
"createdAt": number,
"domainName": "string",
"domainValidationRecords": [
{
"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",
"revokedAt": number,
"serialNumber": "string",
"status": "string",
"subjectAlternativeNames": [ "string" ],
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"certificateName": "string",
"domainName": "string",
"tags": [
{
"key": "string",
"value": "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.
** [certificate](#API_CreateCertificate_ResponseSyntax) **
An object that describes the certificate created.
Type: [CertificateSummary](API_CertificateSummary.md) object
** [operations](#API_CreateCertificate_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateCertificate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateCertificate)
# CreateCloudFormationStack
Creates an AWS CloudFormation stack, which creates a new Amazon EC2 instance from an exported Amazon Lightsail snapshot. This operation results in a CloudFormation stack record that can be used to track the AWS CloudFormation stack created. Use the `get cloud formation stack records` operation to get a list of the CloudFormation stacks created.
**Important**
Wait until after your new Amazon EC2 instance is created before running the `create cloud formation stack` operation again with the same export snapshot record.
## Request Syntax
```
{
"instances": [
{
"availabilityZone": "string",
"instanceType": "string",
"portInfoSource": "string",
"sourceName": "string",
"userData": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instances](#API_CreateCloudFormationStack_RequestSyntax) **
An array of parameters that will be used to create the new Amazon EC2 instance. You can only pass one instance entry at a time in this array. You will get an invalid parameter error if you pass more than one instance entry in this array.
Type: Array of [InstanceEntry](API_InstanceEntry.md) objects
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](#API_CreateCloudFormationStack_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateCloudFormationStack)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateCloudFormationStack)
# CreateContactMethod
Creates an email or SMS text message contact method.
A contact method is used to send you notifications 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 [Notifications in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications).
The `create contact method` operation supports tag-based access control via request tags. For more information, see the [Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"contactEndpoint": "string",
"protocol": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [contactEndpoint](#API_CreateContactMethod_RequestSyntax) **
The destination of the contact method, such as an email address or a mobile phone number.
Use the E.164 format when specifying a mobile phone number. E.164 is a standard for the phone number structure used for international telecommunication. Phone numbers that follow this format can have a maximum of 15 digits, and they are prefixed with the plus character (\$1) and the country code. For example, a U.S. phone number in E.164 format would be specified as \$11XXX5550100. For more information, see [E.164](https://en.wikipedia.org/wiki/E.164) on *Wikipedia*.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** [protocol](#API_CreateContactMethod_RequestSyntax) **
The protocol of the contact method, such as `Email` or `SMS` (text messaging).
The `SMS` protocol is supported only in the following AWS Regions.
+ US East (N. Virginia) (`us-east-1`)
+ US West (Oregon) (`us-west-2`)
+ Europe (Ireland) (`eu-west-1`)
+ Asia Pacific (Tokyo) (`ap-northeast-1`)
+ Asia Pacific (Singapore) (`ap-southeast-1`)
+ Asia Pacific (Sydney) (`ap-southeast-2`)
For a list of countries/regions where SMS text messages can be sent, and the latest AWS Regions where SMS text messaging is supported, see [Supported Regions and Countries](https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html) in the *Amazon SNS Developer Guide*.
For more information about notifications in Amazon Lightsail, see [Notifications in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications).
Type: String
Valid Values: `Email | SMS`
Required: Yes
** [tags](#API_CreateContactMethod_RequestSyntax) **
The tag keys and optional values to add to the contact method during create.
Use the `TagResource` action to tag a resource after it's created.
Type: Array of [Tag](API_Tag.md) 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.
** [operations](#API_CreateContactMethod_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateContactMethod)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateContactMethod)
# CreateContainerService
Creates an Amazon Lightsail container service.
A Lightsail container service is a compute resource to which you can deploy containers. For more information, see [Container services in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-services) in the *Lightsail Dev Guide*.
## Request Syntax
```
{
"deployment": {
"containers": {
"string" : {
"command": [ "string" ],
"environment": {
"string" : "string"
},
"image": "string",
"ports": {
"string" : "string"
}
}
},
"publicEndpoint": {
"containerName": "string",
"containerPort": number,
"healthCheck": {
"healthyThreshold": number,
"intervalSeconds": number,
"path": "string",
"successCodes": "string",
"timeoutSeconds": number,
"unhealthyThreshold": number
}
}
},
"power": "string",
"privateRegistryAccess": {
"ecrImagePullerRole": {
"isActive": boolean
}
},
"publicDomainNames": {
"string" : [ "string" ]
},
"scale": number,
"serviceName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [deployment](#API_CreateContainerService_RequestSyntax) **
An object that describes a deployment for the container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
Type: [ContainerServiceDeploymentRequest](API_ContainerServiceDeploymentRequest.md) object
Required: No
** [power](#API_CreateContainerService_RequestSyntax) **
The power specification for the container service.
The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The `power` and `scale` of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the `power` with the `scale` (the number of nodes) of the service.
Use the `GetContainerServicePowers` action to get a list of power options that you can specify using this parameter, and their base monthly cost.
Type: String
Valid Values: `nano | micro | small | medium | large | xlarge`
Required: Yes
** [privateRegistryAccess](#API_CreateContainerService_RequestSyntax) **
An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer Guide*.
Type: [PrivateRegistryAccessRequest](API_PrivateRegistryAccessRequest.md) object
Required: No
** [publicDomainNames](#API_CreateContainerService_RequestSyntax) **
The public domain names to use with the container service, such as `example.com` and `www.example.com`.
You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
If you don't specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the `CreateCertificate` action to create a certificate for the public domain names you want to use with your container service.
You can specify public domain names using a string to array map as shown in the example later on this page.
Type: String to array of strings map
Required: No
** [scale](#API_CreateContainerService_RequestSyntax) **
The scale specification for the container service.
The scale specifies the allocated compute nodes of the container service. The `power` and `scale` of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the `power` with the `scale` (the number of nodes) of the service.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: Yes
** [serviceName](#API_CreateContainerService_RequestSyntax) **
The name for the container service.
The name that you specify for your container service will make up part of its default domain. The default domain of a container service is typically `https://...cs.amazonlightsail.com`. If the name of your container service is `container-service-1`, and it's located in the US East (Ohio) AWS Region (`us-east-2`), then the domain for your container service will be like the following example: `https://container-service-1.ur4EXAMPLE2uq.us-east-2.cs.amazonlightsail.com`
The following are the requirements for container service names:
+ Must be unique within each AWS Region in your Lightsail account.
+ Must contain 1 to 63 characters.
+ Must contain only alphanumeric characters and hyphens.
+ A hyphen (-) can separate words but cannot be at the start or end of the name.
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
** [tags](#API_CreateContainerService_RequestSyntax) **
The tag keys and optional values to add to the container service during create.
Use the `TagResource` action to tag a resource after it's created.
For more information about tags in Lightsail, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags).
Type: Array of [Tag](API_Tag.md) objects
Required: No
## Response Syntax
```
{
"containerService": {
"arn": "string",
"containerServiceName": "string",
"createdAt": number,
"currentDeployment": {
"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
},
"isDisabled": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"nextDeployment": {
"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
},
"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 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.
** [containerService](#API_CreateContainerService_ResponseSyntax) **
An object that describes a container service.
Type: [ContainerService](API_ContainerService.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) 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)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
### Create container service
The following example creates a new container service named `container-service-1` in the `us-west-2` AWS Region. It also specifies the `example.com`, `applications.example.com`, `www.example.com`, and `containers.example.com` public domains of the `example-com` SSL/TLS certificate.
#### Sample Request
```
POST / HTTP/1.1
Host: lightsail.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: Lightsail_20161128.CreateContainerService
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20201022T175000Z
Authorization: AUTHPARAMS
Content-Length: 195
{
"serviceName": "container-service-1",
"power": "nano",
"scale": 1,
"publicDomainNames": {
"example-com": [
"example.com",
"applications.example.com",
"www.example.com",
"containers.example.com"
]
}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
Server: Server
Date: Thu, 22 Oct 2020 17:50:03 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 689
x-amzn-RequestId: 0459d37f-f6a7-4786-bc26-9EXAMPLEea99
Connection: keep-alive
{
"containerService": {
"arn": "arn:aws:lightsail:us-west-2:111122223333:ContainerService/9059c34a-f681-482f-b41d-0EXAMPLEc85e",
"containerServiceName": "container-service-1",
"createdAt": 1.603389001E9,
"isDisabled": false,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"power": "nano",
"powerId": "nano-1",
"principalArn": "",
"privateDomainName": "container-service-1.service.local",
"publicDomainNames": {
"example-com": [
"example.com",
"applications.example.com",
"www.example.com",
"containers.example.com"
]
},
"resourceType": "ContainerService",
"scale": 1,
"state": "PENDING",
"tags": [],
"url": "https://container-service-1.ur1EXAMPLE2uq.us-west-2.cs.amazonlightsail.com/"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateContainerService)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateContainerService)
# CreateContainerServiceDeployment
Creates a deployment for your Amazon Lightsail container service.
A deployment specifies the containers that will be launched on the container service and their settings, such as the ports to open, the environment variables to apply, and the launch command to run. It also specifies the container that will serve as the public endpoint of the deployment and its settings, such as the HTTP or HTTPS port to use, and the health check configuration.
You can deploy containers to your container service using container images from a public registry such as Amazon ECR Public, or from your local machine. For more information, see [Creating container images for your Amazon Lightsail container services](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-container-images) in the *Amazon Lightsail Developer Guide*.
## Request Syntax
```
{
"containers": {
"string" : {
"command": [ "string" ],
"environment": {
"string" : "string"
},
"image": "string",
"ports": {
"string" : "string"
}
}
},
"publicEndpoint": {
"containerName": "string",
"containerPort": number,
"healthCheck": {
"healthyThreshold": number,
"intervalSeconds": number,
"path": "string",
"successCodes": "string",
"timeoutSeconds": number,
"unhealthyThreshold": number
}
},
"serviceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [containers](#API_CreateContainerServiceDeployment_RequestSyntax) **
An object that describes the settings of the containers that will be launched on the container service.
Type: String to [Container](API_Container.md) object map
Key Length Constraints: Minimum length of 1. Maximum length of 53.
Key Pattern: `^[a-z0-9]{1,2}|[a-z0-9][a-z0-9-]+[a-z0-9]$`
Required: No
** [publicEndpoint](#API_CreateContainerServiceDeployment_RequestSyntax) **
An object that describes the settings of the public endpoint for the container service.
Type: [EndpointRequest](API_EndpointRequest.md) object
Required: No
** [serviceName](#API_CreateContainerServiceDeployment_RequestSyntax) **
The name of the container service for which to create the deployment.
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
```
{
"containerService": {
"arn": "string",
"containerServiceName": "string",
"createdAt": number,
"currentDeployment": {
"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
},
"isDisabled": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"nextDeployment": {
"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
},
"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 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.
** [containerService](#API_CreateContainerServiceDeployment_ResponseSyntax) **
An object that describes a container service.
Type: [ContainerService](API_ContainerService.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateContainerServiceDeployment)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateContainerServiceDeployment)
# CreateContainerServiceRegistryLogin
Creates a temporary set of log in credentials that you can use to log in to the Docker process on your local machine. After you're logged in, you can use the native Docker commands to push your local container images to the container image registry of your Amazon Lightsail account so that you can use them with your Lightsail container service. The log in credentials expire 12 hours after they are created, at which point you will need to create a new set of log in credentials.
**Note**
You can only push container images to the container service registry of your Lightsail account. You cannot pull container images or perform any other container image management actions on the container service registry.
After you push your container images to the container image registry of your Lightsail account, use the `RegisterContainerImage` action to register the pushed images to a specific 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-pushing-container-images) in the *Amazon Lightsail Developer Guide*.
## Response Syntax
```
{
"registryLogin": {
"expiresAt": number,
"password": "string",
"registry": "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.
** [registryLogin](#API_CreateContainerServiceRegistryLogin_ResponseSyntax) **
An object that describes the log in information for the container service registry of your Lightsail account.
Type: [ContainerServiceRegistryLogin](API_ContainerServiceRegistryLogin.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateContainerServiceRegistryLogin)
# CreateDisk
Creates a block storage disk that can be attached to an Amazon Lightsail instance in the same Availability Zone (`us-east-2a`).
The `create disk` operation supports tag-based access control via request tags. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"addOns": [
{
"addOnType": "string",
"autoSnapshotAddOnRequest": {
"snapshotTimeOfDay": "string"
},
"stopInstanceOnIdleRequest": {
"duration": "string",
"threshold": "string"
}
}
],
"availabilityZone": "string",
"diskName": "string",
"sizeInGb": number,
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOns](#API_CreateDisk_RequestSyntax) **
An array of objects that represent the add-ons to enable for the new disk.
Type: Array of [AddOnRequest](API_AddOnRequest.md) objects
Required: No
** [availabilityZone](#API_CreateDisk_RequestSyntax) **
The Availability Zone where you want to create the disk (`us-east-2a`). Use the same Availability Zone as the Lightsail instance to which you want to attach the disk.
Use the `get regions` operation to list the Availability Zones where Lightsail is currently available.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [diskName](#API_CreateDisk_RequestSyntax) **
The unique Lightsail disk name (`my-disk`).
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [sizeInGb](#API_CreateDisk_RequestSyntax) **
The size of the disk in GB (`32`).
Type: Integer
Required: Yes
** [tags](#API_CreateDisk_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateDisk_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDisk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDisk)
# CreateDiskFromSnapshot
Creates a block storage disk from a manual or automatic snapshot of a disk. The resulting disk can be attached to an Amazon Lightsail instance in the same Availability Zone (`us-east-2a`).
The `create disk from snapshot` operation supports tag-based access control via request tags and resource tags applied to the resource identified by `disk snapshot name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"addOns": [
{
"addOnType": "string",
"autoSnapshotAddOnRequest": {
"snapshotTimeOfDay": "string"
},
"stopInstanceOnIdleRequest": {
"duration": "string",
"threshold": "string"
}
}
],
"availabilityZone": "string",
"diskName": "string",
"diskSnapshotName": "string",
"restoreDate": "string",
"sizeInGb": number,
"sourceDiskName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"useLatestRestorableAutoSnapshot": boolean
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOns](#API_CreateDiskFromSnapshot_RequestSyntax) **
An array of objects that represent the add-ons to enable for the new disk.
Type: Array of [AddOnRequest](API_AddOnRequest.md) objects
Required: No
** [availabilityZone](#API_CreateDiskFromSnapshot_RequestSyntax) **
The Availability Zone where you want to create the disk (`us-east-2a`). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.
Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [diskName](#API_CreateDiskFromSnapshot_RequestSyntax) **
The unique Lightsail disk name (`my-disk`).
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [diskSnapshotName](#API_CreateDiskFromSnapshot_RequestSyntax) **
The name of the disk snapshot (`my-snapshot`) from which to create the new storage disk.
Constraint:
+ This parameter cannot be defined together with the `source disk name` parameter. The `disk snapshot name` and `source disk name` parameters are mutually exclusive.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [restoreDate](#API_CreateDiskFromSnapshot_RequestSyntax) **
The date of the automatic snapshot to use for the new disk. Use the `get auto snapshots` operation to identify the dates of the available automatic snapshots.
Constraints:
+ Must be specified in `YYYY-MM-DD` format.
+ This parameter cannot be defined together with the `use latest restorable auto snapshot` parameter. The `restore date` and `use latest restorable auto snapshot` parameters are mutually exclusive.
+ Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
Type: String
Required: No
** [sizeInGb](#API_CreateDiskFromSnapshot_RequestSyntax) **
The size of the disk in GB (`32`).
Type: Integer
Required: Yes
** [sourceDiskName](#API_CreateDiskFromSnapshot_RequestSyntax) **
The name of the source disk from which the source automatic snapshot was created.
Constraints:
+ This parameter cannot be defined together with the `disk snapshot name` parameter. The `source disk name` and `disk snapshot name` parameters are mutually exclusive.
+ Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
Type: String
Required: No
** [tags](#API_CreateDiskFromSnapshot_RequestSyntax) **
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](API_Tag.md) objects
Required: No
** [useLatestRestorableAutoSnapshot](#API_CreateDiskFromSnapshot_RequestSyntax) **
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
+ This parameter cannot be defined together with the `restore date` parameter. The `use latest restorable auto snapshot` and `restore date` parameters are mutually exclusive.
+ Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
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](#API_CreateDiskFromSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDiskFromSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDiskFromSnapshot)
# CreateDiskSnapshot
Creates a snapshot of a block storage disk. You can use snapshots for backups, to make copies of disks, and to save data before shutting down a Lightsail instance.
You can take a snapshot of an attached disk that is in use; however, snapshots only capture data that has been written to your disk at the time the snapshot command is issued. This may exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the disk long enough to take a snapshot, your snapshot should be complete. Nevertheless, if you cannot pause all file writes to the disk, you should unmount the disk from within the Lightsail instance, issue the create disk snapshot command, and then remount the disk to ensure a consistent and complete snapshot. You may remount and use your disk while the snapshot status is pending.
You can also use this operation to create a snapshot of an instance's system volume. You might want to do this, for example, to recover data from the system volume of a botched instance or to create a backup of the system volume like you would for a block storage disk. To create a snapshot of a system volume, just define the `instance name` parameter when issuing the snapshot command, and a snapshot of the defined instance's system volume will be created. After the snapshot is available, you can create a block storage disk from the snapshot and attach it to a running instance to access the data on the disk.
The `create disk snapshot` operation supports tag-based access control via request tags. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"diskName": "string",
"diskSnapshotName": "string",
"instanceName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskName](#API_CreateDiskSnapshot_RequestSyntax) **
The unique name of the source disk (`Disk-Virginia-1`).
This parameter cannot be defined together with the `instance name` parameter. The `disk name` and `instance name` parameters are mutually exclusive.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [diskSnapshotName](#API_CreateDiskSnapshot_RequestSyntax) **
The name of the destination disk snapshot (`my-disk-snapshot`) based on the source disk.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [instanceName](#API_CreateDiskSnapshot_RequestSyntax) **
The unique name of the source instance (`Amazon_Linux-512MB-Virginia-1`). When this is defined, a snapshot of the instance's system volume is created.
This parameter cannot be defined together with the `disk name` parameter. The `instance name` and `disk name` parameters are mutually exclusive.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [tags](#API_CreateDiskSnapshot_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateDiskSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDiskSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDiskSnapshot)
# CreateDistribution
Creates an Amazon Lightsail content delivery network (CDN) distribution.
A distribution is a globally distributed network of caching servers that improve the performance of your website or web application hosted on a Lightsail instance. For more information, see [Content delivery networks in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-content-delivery-network-distributions).
## Request Syntax
```
{
"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",
"defaultCacheBehavior": {
"behavior": "string"
},
"distributionName": "string",
"ipAddressType": "string",
"origin": {
"name": "string",
"protocolPolicy": "string",
"regionName": "string",
"responseTimeout": number
},
"tags": [
{
"key": "string",
"value": "string"
}
],
"viewerMinimumTlsProtocolVersion": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [bundleId](#API_CreateDistribution_RequestSyntax) **
The bundle ID to use for the distribution.
A distribution bundle describes the specifications of your distribution, such as the monthly cost and monthly network transfer quota.
Use the `GetDistributionBundles` action to get a list of distribution bundle IDs that you can specify.
Type: String
Required: Yes
** [cacheBehaviors](#API_CreateDistribution_RequestSyntax) **
An array of objects that describe the per-path cache behavior for the distribution.
Type: Array of [CacheBehaviorPerPath](API_CacheBehaviorPerPath.md) objects
Required: No
** [cacheBehaviorSettings](#API_CreateDistribution_RequestSyntax) **
An object that describes the cache behavior settings for the distribution.
Type: [CacheSettings](API_CacheSettings.md) object
Required: No
** [certificateName](#API_CreateDistribution_RequestSyntax) **
The name of the SSL/TLS certificate that you want to attach to the distribution.
Use the [GetCertificates](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html) action to get a list of certificate names that you can specify.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [defaultCacheBehavior](#API_CreateDistribution_RequestSyntax) **
An object that describes the default cache behavior for the distribution.
Type: [CacheBehavior](API_CacheBehavior.md) object
Required: Yes
** [distributionName](#API_CreateDistribution_RequestSyntax) **
The name for the distribution.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [ipAddressType](#API_CreateDistribution_RequestSyntax) **
The IP address type for the distribution.
The possible values are `ipv4` for IPv4 only, and `dualstack` for IPv4 and IPv6.
The default value is `dualstack`.
Type: String
Valid Values: `dualstack | ipv4 | ipv6`
Required: No
** [origin](#API_CreateDistribution_RequestSyntax) **
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
Type: [InputOrigin](API_InputOrigin.md) object
Required: Yes
** [tags](#API_CreateDistribution_RequestSyntax) **
The tag keys and optional values to add to the distribution during create.
Use the `TagResource` action to tag a resource after it's created.
Type: Array of [Tag](API_Tag.md) objects
Required: No
** [viewerMinimumTlsProtocolVersion](#API_CreateDistribution_RequestSyntax) **
The minimum TLS protocol version for the SSL/TLS certificate.
Type: String
Valid Values: `TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021`
Required: No
## Response Syntax
```
{
"distribution": {
"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": {
"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"
},
"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.
** [distribution](#API_CreateDistribution_ResponseSyntax) **
An object that describes the distribution created.
Type: [LightsailDistribution](API_LightsailDistribution.md) object
** [operation](#API_CreateDistribution_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDistribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDistribution)
# CreateDomain
Creates a domain resource for the specified domain (example.com).
The `create domain` operation supports tag-based access control via request tags. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"domainName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainName](#API_CreateDomain_RequestSyntax) **
The domain name to manage (`example.com`).
Type: String
Required: Yes
** [tags](#API_CreateDomain_RequestSyntax) **
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](API_Tag.md) objects
Required: No
## 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](#API_CreateDomain_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDomain)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDomain)
# CreateDomainEntry
Creates one of the following domain name system (DNS) records in a domain DNS zone: Address (A), canonical name (CNAME), mail exchanger (MX), name server (NS), start of authority (SOA), service locator (SRV), or text (TXT).
The `create domain entry` operation supports tag-based access control via resource tags applied to the resource identified by `domain name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainEntry](#API_CreateDomainEntry_RequestSyntax) **
An array of key-value pairs containing information about the domain entry request.
Type: [DomainEntry](API_DomainEntry.md) object
Required: Yes
** [domainName](#API_CreateDomainEntry_RequestSyntax) **
The domain name (`example.com`) for which you want to create the domain entry.
Type: String
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](#API_CreateDomainEntry_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateDomainEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateDomainEntry)
# CreateGUISessionAccessDetails
Creates two URLs that are used to access a virtual computer’s graphical user interface (GUI) session. The primary URL initiates a web-based Amazon DCV session to the virtual computer's application. The secondary URL initiates a web-based Amazon DCV session to the virtual computer's operating session.
Use `StartGUISession` to open the session.
## Request Syntax
```
{
"resourceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceName](#API_CreateGUISessionAccessDetails_RequestSyntax) **
The resource name.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
## Response Syntax
```
{
"failureReason": "string",
"percentageComplete": number,
"resourceName": "string",
"sessions": [
{
"isPrimary": boolean,
"name": "string",
"url": "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.
** [failureReason](#API_CreateGUISessionAccessDetails_ResponseSyntax) **
The reason the operation failed.
Type: String
** [percentageComplete](#API_CreateGUISessionAccessDetails_ResponseSyntax) **
The percentage of completion for the operation.
Type: Integer
** [resourceName](#API_CreateGUISessionAccessDetails_ResponseSyntax) **
The resource name.
Type: String
Pattern: `\w[\w\-]*\w`
** [sessions](#API_CreateGUISessionAccessDetails_ResponseSyntax) **
Returns information about the specified Amazon DCV GUI session.
Type: Array of [Session](API_Session.md) objects
** [status](#API_CreateGUISessionAccessDetails_ResponseSyntax) **
The status of the operation.
Type: String
Valid Values: `startExpired | notStarted | started | starting | stopped | stopping | settingUpInstance | failedInstanceCreation | failedStartingGUISession | failedStoppingGUISession`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateGUISessionAccessDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateGUISessionAccessDetails)
# CreateInstances
Creates one or more Amazon Lightsail instances.
The `create instances` operation supports tag-based access control via request tags. For more information, see the [Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"addOns": [
{
"addOnType": "string",
"autoSnapshotAddOnRequest": {
"snapshotTimeOfDay": "string"
},
"stopInstanceOnIdleRequest": {
"duration": "string",
"threshold": "string"
}
}
],
"availabilityZone": "string",
"blueprintId": "string",
"bundleId": "string",
"customImageName": "string",
"instanceNames": [ "string" ],
"ipAddressType": "string",
"keyPairName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"userData": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOns](#API_CreateInstances_RequestSyntax) **
An array of objects representing the add-ons to enable for the new instance.
Type: Array of [AddOnRequest](API_AddOnRequest.md) objects
Required: No
** [availabilityZone](#API_CreateInstances_RequestSyntax) **
The Availability Zone in which to create your instance. Use the following format: `us-east-2a` (case sensitive). You can get a list of Availability Zones by using the [get regions](http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) operation. Be sure to add the `include Availability Zones` parameter to your request.
Type: String
Required: Yes
** [blueprintId](#API_CreateInstances_RequestSyntax) **
The ID for a virtual private server image (`app_wordpress_x_x` or `app_lamp_x_x`). Use the `get blueprints` operation to return a list of available images (or *blueprints*).
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.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [bundleId](#API_CreateInstances_RequestSyntax) **
The bundle of specification information for your virtual private server (or *instance*), including the pricing plan (`medium_x_x`).
Type: String
Pattern: `.*\S.*`
Required: Yes
** [customImageName](#API_CreateInstances_RequestSyntax) **
*This parameter has been deprecated.*
(Discontinued) The name for your custom image.
In releases prior to June 12, 2017, this parameter was ignored by the API. It is now discontinued.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [instanceNames](#API_CreateInstances_RequestSyntax) **
The names to use for your new Lightsail instances. Separate multiple values using quotation marks and commas, for example: `["MyFirstInstance","MySecondInstance"]`
Type: Array of strings
Required: Yes
** [ipAddressType](#API_CreateInstances_RequestSyntax) **
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](#API_CreateInstances_RequestSyntax) **
The name of your key pair.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [tags](#API_CreateInstances_RequestSyntax) **
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](API_Tag.md) objects
Required: No
** [userData](#API_CreateInstances_RequestSyntax) **
A launch script you can create that configures a server with additional user data. For example, you might want to run `apt-get -y update`.
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](https://docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image).
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](#API_CreateInstances_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateInstances)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateInstances)
# 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 identified by `instance snapshot name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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"
}
],
"useLatestRestorableAutoSnapshot": boolean,
"userData": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOns](#API_CreateInstancesFromSnapshot_RequestSyntax) **
An array of objects representing the add-ons to enable for the new instance.
Type: Array of [AddOnRequest](API_AddOnRequest.md) objects
Required: No
** [attachedDiskMapping](#API_CreateInstancesFromSnapshot_RequestSyntax) **
An object containing information about one or more disk mappings.
Type: String to array of [DiskMap](API_DiskMap.md) objects map
Key Pattern: `\w[\w\-]*\w`
Required: No
** [availabilityZone](#API_CreateInstancesFromSnapshot_RequestSyntax) **
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](http://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRegions.html) operation. Be sure to add the `include Availability Zones` parameter to your request.
Type: String
Required: Yes
** [bundleId](#API_CreateInstancesFromSnapshot_RequestSyntax) **
The bundle of specification information for your virtual private server (or *instance*), including the pricing plan (`micro_x_x`).
Type: String
Pattern: `.*\S.*`
Required: Yes
** [instanceNames](#API_CreateInstancesFromSnapshot_RequestSyntax) **
The names for your new instances.
Type: Array of strings
Required: Yes
** [instanceSnapshotName](#API_CreateInstancesFromSnapshot_RequestSyntax) **
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 defined 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](#API_CreateInstancesFromSnapshot_RequestSyntax) **
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](#API_CreateInstancesFromSnapshot_RequestSyntax) **
The name for your key pair.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [restoreDate](#API_CreateInstancesFromSnapshot_RequestSyntax) **
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 specified in `YYYY-MM-DD` format.
+ This parameter cannot be defined together with the `use latest restorable auto snapshot` parameter. The `restore date` and `use latest restorable auto snapshot` parameters are mutually exclusive.
+ Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
Type: String
Required: No
** [sourceInstanceName](#API_CreateInstancesFromSnapshot_RequestSyntax) **
The name of the source instance from which the source automatic snapshot was created.
Constraints:
+ This parameter cannot be defined together with the `instance snapshot name` parameter. The `source instance name` and `instance snapshot name` parameters are mutually exclusive.
+ Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
Type: String
Required: No
** [tags](#API_CreateInstancesFromSnapshot_RequestSyntax) **
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](API_Tag.md) objects
Required: No
** [useLatestRestorableAutoSnapshot](#API_CreateInstancesFromSnapshot_RequestSyntax) **
A Boolean value to indicate whether to use the latest available automatic snapshot.
Constraints:
+ This parameter cannot be defined together with the `restore date` parameter. The `use latest restorable auto snapshot` and `restore date` parameters are mutually exclusive.
+ Define this parameter only when creating a new instance from an automatic snapshot. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
Type: Boolean
Required: No
** [userData](#API_CreateInstancesFromSnapshot_RequestSyntax) **
You can create a launch script that configures a server with additional user data. For example, `apt-get -y update`.
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](https://docs.aws.amazon.com/lightsail/latest/userguide/compare-options-choose-lightsail-instance-image).
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](#API_CreateInstancesFromSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateInstancesFromSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateInstancesFromSnapshot)
# CreateInstanceSnapshot
Creates a snapshot of a specific 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_CreateInstanceSnapshot_RequestSyntax) **
The Lightsail instance on which to base your snapshot.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [instanceSnapshotName](#API_CreateInstanceSnapshot_RequestSyntax) **
The name for your new snapshot.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateInstanceSnapshot_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateInstanceSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateInstanceSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateInstanceSnapshot)
# CreateKeyPair
Creates a custom SSH key pair that you can use with an Amazon Lightsail instance.
**Note**
Use the [DownloadDefaultKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [keyPairName](#API_CreateKeyPair_RequestSyntax) **
The name for your new key pair.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateKeyPair_RequestSyntax) **
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](API_Tag.md) 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",
"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](#API_CreateKeyPair_ResponseSyntax) **
An array of key-value pairs containing information about the new key pair you just created.
Type: [KeyPair](API_KeyPair.md) object
** [operation](#API_CreateKeyPair_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
** [privateKeyBase64](#API_CreateKeyPair_ResponseSyntax) **
A base64-encoded RSA private key.
Type: String
** [publicKeyBase64](#API_CreateKeyPair_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateKeyPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateKeyPair)
# CreateLoadBalancer
Creates a Lightsail load balancer. To learn more about deciding whether to load balance your application, see [Configure your Lightsail instances for load balancing](https://docs.aws.amazon.com/lightsail/latest/userguide/configure-lightsail-instances-for-load-balancing). You can create up to 10 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateAlternativeNames](#API_CreateLoadBalancer_RequestSyntax) **
The optional alternative domains and subdomains to use with your SSL/TLS certificate (`www.example.com`, `example.com`, `m.example.com`, `blog.example.com`).
Type: Array of strings
Required: No
** [certificateDomainName](#API_CreateLoadBalancer_RequestSyntax) **
The domain name with which your certificate is associated (`example.com`).
If you specify `certificateDomainName`, then `certificateName` is required (and vice-versa).
Type: String
Required: No
** [certificateName](#API_CreateLoadBalancer_RequestSyntax) **
The name of the SSL/TLS certificate.
If you specify `certificateName`, then `certificateDomainName` is required (and vice-versa).
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [healthCheckPath](#API_CreateLoadBalancer_RequestSyntax) **
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](#API_CreateLoadBalancer_RequestSyntax) **
The instance port where you're creating your load balancer.
Type: Integer
Valid Range: Minimum value of -1. Maximum value of 65535.
Required: Yes
** [ipAddressType](#API_CreateLoadBalancer_RequestSyntax) **
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](#API_CreateLoadBalancer_RequestSyntax) **
The name of your load balancer.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateLoadBalancer_RequestSyntax) **
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](API_Tag.md) objects
Required: No
** [tlsPolicyName](#API_CreateLoadBalancer_RequestSyntax) **
The name of the TLS policy to apply to the load balancer.
Use the [GetLoadBalancerTlsPolicies](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) action to get a list of TLS policy names that you can specify.
For more information about load balancer TLS policies, see [Configuring TLS security policies on your Amazon Lightsail load balancers](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy) 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](#API_CreateLoadBalancer_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateLoadBalancer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateLoadBalancer)
# CreateLoadBalancerTlsCertificate
Creates an SSL/TLS certificate 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 identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateAlternativeNames](#API_CreateLoadBalancerTlsCertificate_RequestSyntax) **
An array of strings listing alternative domains and subdomains for your SSL/TLS certificate. Lightsail will de-dupe the names for you. You can have a maximum of 9 alternative names (in addition to the 1 primary domain). We do not support wildcards (`*.example.com`).
Type: Array of strings
Required: No
** [certificateDomainName](#API_CreateLoadBalancerTlsCertificate_RequestSyntax) **
The domain name (`example.com`) for your SSL/TLS certificate.
Type: String
Required: Yes
** [certificateName](#API_CreateLoadBalancerTlsCertificate_RequestSyntax) **
The SSL/TLS certificate name.
You can have up to 10 certificates in your account at one time. Each Lightsail load balancer can have up to 2 certificates associated with it at one time. There is also an overall limit to the number of certificates that can be issue in a 365-day period. For more information, see [Limits](http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [loadBalancerName](#API_CreateLoadBalancerTlsCertificate_RequestSyntax) **
The load balancer name where you want to create the SSL/TLS certificate.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateLoadBalancerTlsCertificate_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateLoadBalancerTlsCertificate_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateLoadBalancerTlsCertificate)
# 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [availabilityZone](#API_CreateRelationalDatabase_RequestSyntax) **
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.
Type: String
Required: No
** [masterDatabaseName](#API_CreateRelationalDatabase_RequestSyntax) **
The meaning of this parameter differs 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 specified, 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 specified database engine.
For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for [MySQL 5.6](https://dev.mysql.com/doc/refman/5.6/en/keywords.html), [MySQL 5.7](https://dev.mysql.com/doc/refman/5.7/en/keywords.html), and [MySQL 8.0](https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
**PostgreSQL**
The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, 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 specified database engine.
For more information about reserved words in PostgreSQL, see the SQL Key Words articles for [PostgreSQL 9.6](https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), [PostgreSQL 10](https://www.postgresql.org/docs/10/sql-keywords-appendix.html), [PostgreSQL 11](https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and [PostgreSQL 12](https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
Type: String
Required: Yes
** [masterUsername](#API_CreateRelationalDatabase_RequestSyntax) **
The name for the master user.
**MySQL**
Constraints:
+ Required for MySQL.
+ 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](https://dev.mysql.com/doc/refman/5.6/en/keywords.html), [MySQL 5.7](https://dev.mysql.com/doc/refman/5.7/en/keywords.html), or [MySQL 8.0](https://dev.mysql.com/doc/refman/8.0/en/keywords.html).
**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](https://www.postgresql.org/docs/9.6/sql-keywords-appendix.html), [PostgreSQL 10](https://www.postgresql.org/docs/10/sql-keywords-appendix.html), [PostgreSQL 11](https://www.postgresql.org/docs/11/sql-keywords-appendix.html), and [PostgreSQL 12](https://www.postgresql.org/docs/12/sql-keywords-appendix.html).
Type: String
Required: Yes
** [masterUserPassword](#API_CreateRelationalDatabase_RequestSyntax) **
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
Required: No
** [preferredBackupWindow](#API_CreateRelationalDatabase_RequestSyntax) **
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](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) guide in the Amazon Relational Database Service documentation.
Constraints:
+ Must be in the `hh24:mi-hh24:mi` format.
Example: `16:00-16:30`
+ Specified in Coordinated Universal Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String
Required: No
** [preferredMaintenanceWindow](#API_CreateRelationalDatabase_RequestSyntax) **
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.
+ Specified in Coordinated Universal Time (UTC).
+ Example: `Tue:17:00-Tue:17:30`
Type: String
Required: No
** [publiclyAccessible](#API_CreateRelationalDatabase_RequestSyntax) **
Specifies the accessibility options for your new database. A value of `true` specifies a database that is available to resources outside of your Lightsail account. A value of `false` specifies a database that is available only to your Lightsail resources in the same region as your database.
Type: Boolean
Required: No
** [relationalDatabaseBlueprintId](#API_CreateRelationalDatabase_RequestSyntax) **
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](#API_CreateRelationalDatabase_RequestSyntax) **
The bundle ID for your new database. A bundle describes the performance specifications 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](#API_CreateRelationalDatabase_RequestSyntax) **
The name to use for your new Lightsail database resource.
Constraints:
+ Must contain from 2 to 255 alphanumeric characters, or hyphens.
+ The first and last character must be a letter or number.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateRelationalDatabase_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateRelationalDatabase)
# 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 different 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 identified by relationalDatabaseSnapshotName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [availabilityZone](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
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.
Type: String
Required: No
** [publiclyAccessible](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
Specifies the accessibility options for your new database. A value of `true` specifies a database that is available to resources outside of your Lightsail account. A value of `false` specifies a database that is available only to your Lightsail resources in the same region as your database.
Type: Boolean
Required: No
** [relationalDatabaseBundleId](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
The bundle ID for your new database. A bundle describes the performance specifications 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](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
The name to use for your new Lightsail database resource.
Constraints:
+ Must contain from 2 to 255 alphanumeric characters, or hyphens.
+ The first and last character must be a letter or number.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [relationalDatabaseSnapshotName](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
The name of the database snapshot from which to create your new database.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [restoreTime](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
The date and time to restore your database from.
Constraints:
+ Must be before the latest restorable time for the database.
+ Cannot be specified if the `use latest restorable time` parameter is `true`.
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
The name of the source database.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [tags](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
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](API_Tag.md) objects
Required: No
** [useLatestRestorableTime](#API_CreateRelationalDatabaseFromSnapshot_RequestSyntax) **
Specifies 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 specified 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.
The following data is returned in JSON format by the service.
** [operations](#API_CreateRelationalDatabaseFromSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateRelationalDatabaseFromSnapshot)
# 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_CreateRelationalDatabaseSnapshot_RequestSyntax) **
The name of the database on which to base your new snapshot.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [relationalDatabaseSnapshotName](#API_CreateRelationalDatabaseSnapshot_RequestSyntax) **
The name for your new database snapshot.
Constraints:
+ Must contain from 2 to 255 alphanumeric characters, or hyphens.
+ The first and last character must be a letter or number.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_CreateRelationalDatabaseSnapshot_RequestSyntax) **
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](API_Tag.md) 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.
** [operations](#API_CreateRelationalDatabaseSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/CreateRelationalDatabaseSnapshot)
# DeleteAlarm
Deletes an alarm.
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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms).
## Request Syntax
```
{
"alarmName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [alarmName](#API_DeleteAlarm_RequestSyntax) **
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,
"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](#API_DeleteAlarm_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteAlarm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteAlarm)
# DeleteAutoSnapshot
Deletes an automatic snapshot of an instance or disk. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
## Request Syntax
```
{
"date": "string",
"resourceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [date](#API_DeleteAutoSnapshot_RequestSyntax) **
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](#API_DeleteAutoSnapshot_RequestSyntax) **
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
```
{
"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](#API_DeleteAutoSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteAutoSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteAutoSnapshot)
# DeleteBucket
Deletes a Amazon Lightsail bucket.
**Note**
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_DeleteBucket_RequestSyntax) **
The name of the bucket to delete.
Use the [GetBuckets](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) 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](#API_DeleteBucket_RequestSyntax) **
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:
+ The bucket is the origin of a distribution.
+ The bucket has instances that were granted access to it using the [SetResourceAccessForBucket](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) action.
+ The bucket has objects.
+ The bucket has access keys.
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 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](#API_DeleteBucket_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteBucket)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteBucket)
# DeleteBucketAccessKey
Deletes an access key for the specified 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-creating-bucket-access-keys) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [accessKeyId](#API_DeleteBucketAccessKey_RequestSyntax) **
The ID of the access key to delete.
Use the [GetBucketAccessKeys](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketAccessKeys.html) action to get a list of access key IDs that you can specify.
Type: String
Pattern: `.*\S.*`
Required: Yes
** [bucketName](#API_DeleteBucketAccessKey_RequestSyntax) **
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
## 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](#API_DeleteBucketAccessKey_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteBucketAccessKey)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteBucketAccessKey)
# DeleteCertificate
Deletes an SSL/TLS certificate for your Amazon Lightsail content delivery network (CDN) distribution.
Certificates that are currently attached to a distribution cannot be deleted. Use the `DetachCertificateFromDistribution` action to detach a certificate from a distribution.
## Request Syntax
```
{
"certificateName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_DeleteCertificate_RequestSyntax) **
The name of the certificate to delete.
Use the `GetCertificates` action to get a list of certificate names that you can specify.
Type: String
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](#API_DeleteCertificate_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteCertificate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteCertificate)
# DeleteContactMethod
Deletes a contact method.
A contact method is used to send you notifications 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 [Notifications in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications).
## Request Syntax
```
{
"protocol": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [protocol](#API_DeleteContactMethod_RequestSyntax) **
The protocol that will be deleted, such as `Email` or `SMS` (text messaging).
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
## 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](#API_DeleteContactMethod_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteContactMethod)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteContactMethod)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [image](#API_DeleteContainerImage_RequestSyntax) **
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.
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](#API_DeleteContainerImage_RequestSyntax) **
The name of the container service for which to delete a registered 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 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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteContainerImage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteContainerImage)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [serviceName](#API_DeleteContainerService_RequestSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteContainerService)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteContainerService)
# DeleteDisk
Deletes the specified 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 identified by `disk name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"diskName": "string",
"forceDeleteAddOns": boolean
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskName](#API_DeleteDisk_RequestSyntax) **
The unique name of the disk you want to delete (`my-disk`).
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [forceDeleteAddOns](#API_DeleteDisk_RequestSyntax) **
A Boolean value to indicate whether to delete all add-ons for the disk.
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](#API_DeleteDisk_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteDisk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteDisk)
# DeleteDiskSnapshot
Deletes the specified 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 identified by `disk snapshot name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"diskSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskSnapshotName](#API_DeleteDiskSnapshot_RequestSyntax) **
The name of the disk snapshot you want to delete (`my-disk-snapshot`).
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.
** [operations](#API_DeleteDiskSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteDiskSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteDiskSnapshot)
# DeleteDistribution
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_DeleteDistribution_RequestSyntax) **
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",
"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](#API_DeleteDistribution_ResponseSyntax) **
An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteDistribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteDistribution)
# DeleteDomain
Deletes the specified domain recordset and all of its domain records.
The `delete domain` operation supports tag-based access control via resource tags applied to the resource identified by `domain name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"domainName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainName](#API_DeleteDomain_RequestSyntax) **
The specific 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"
},
"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](#API_DeleteDomain_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteDomain)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteDomain)
# DeleteDomainEntry
Deletes a specific domain entry.
The `delete domain entry` operation supports tag-based access control via resource tags applied to the resource identified by `domain name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainEntry](#API_DeleteDomainEntry_RequestSyntax) **
An array of key-value pairs containing information about your domain entries.
Type: [DomainEntry](API_DomainEntry.md) object
Required: Yes
** [domainName](#API_DeleteDomainEntry_RequestSyntax) **
The name of the domain entry to delete.
Type: String
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](#API_DeleteDomainEntry_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteDomainEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteDomainEntry)
# DeleteInstance
Deletes an Amazon Lightsail instance.
The `delete instance` operation supports tag-based access control via resource tags applied to the resource identified by `instance name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"forceDeleteAddOns": boolean,
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [forceDeleteAddOns](#API_DeleteInstance_RequestSyntax) **
A Boolean value to indicate whether to delete all add-ons for the instance.
Type: Boolean
Required: No
** [instanceName](#API_DeleteInstance_RequestSyntax) **
The name of the instance 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",
"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](#API_DeleteInstance_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteInstance)
# DeleteInstanceSnapshot
Deletes a specific 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 identified by `instance snapshot name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceSnapshotName](#API_DeleteInstanceSnapshot_RequestSyntax) **
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,
"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](#API_DeleteInstanceSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteInstanceSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteInstanceSnapshot)
# DeleteKeyPair
Deletes the specified key pair by removing the public key from Amazon Lightsail.
You can delete key pairs that were created using the [ImportKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_ImportKeyPair.html) and [CreateKeyPair](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateKeyPair.html) 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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_DownloadDefaultKeyPair.html) API.
The `delete key pair` operation supports tag-based access control via resource tags applied to the resource identified by `key pair name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"expectedFingerprint": "string",
"keyPairName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [expectedFingerprint](#API_DeleteKeyPair_RequestSyntax) **
The RSA fingerprint of the Lightsail default key pair to delete.
The `expectedFingerprint` parameter is required only when specifying to delete a Lightsail default key pair.
Type: String
Required: No
** [keyPairName](#API_DeleteKeyPair_RequestSyntax) **
The name of the key pair to delete.
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](#API_DeleteKeyPair_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteKeyPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteKeyPair)
# DeleteKnownHostKeys
Deletes the known host key or certificate 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 certificate mismatch or if you are familiar with the new host key or certificate on the instance. For more information, see [Troubleshooting connection issues when using the Amazon Lightsail browser-based SSH or RDP client](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-troubleshooting-browser-based-ssh-rdp-client-connection).
## Request Syntax
```
{
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_DeleteKnownHostKeys_RequestSyntax) **
The name of the instance for which you want to reset the host key or certificate.
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.
** [operations](#API_DeleteKnownHostKeys_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteKnownHostKeys)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteKnownHostKeys)
# DeleteLoadBalancer
Deletes a Lightsail load balancer and all its associated SSL/TLS certificates. Once the load balancer is deleted, you will need to create a new load balancer, create a new certificate, and verify domain ownership again.
The `delete load balancer` operation supports tag-based access control via resource tags applied to the resource identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [loadBalancerName](#API_DeleteLoadBalancer_RequestSyntax) **
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",
"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](#API_DeleteLoadBalancer_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteLoadBalancer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteLoadBalancer)
# DeleteLoadBalancerTlsCertificate
Deletes an SSL/TLS certificate associated with a Lightsail load balancer.
The `DeleteLoadBalancerTlsCertificate` operation supports tag-based access control via resource tags applied to the resource identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"certificateName": "string",
"force": boolean,
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_DeleteLoadBalancerTlsCertificate_RequestSyntax) **
The SSL/TLS certificate name.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [force](#API_DeleteLoadBalancerTlsCertificate_RequestSyntax) **
When `true`, forces the deletion of an SSL/TLS certificate.
There can be two certificates associated with a Lightsail load balancer: the primary and the backup. The `force` parameter is required when the primary SSL/TLS certificate is in use by an instance attached to the load balancer.
Type: Boolean
Required: No
** [loadBalancerName](#API_DeleteLoadBalancerTlsCertificate_RequestSyntax) **
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.
** [operations](#API_DeleteLoadBalancerTlsCertificate_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteLoadBalancerTlsCertificate)
# DeleteRelationalDatabase
Deletes a database in Amazon Lightsail.
The `delete relational database` operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"finalRelationalDatabaseSnapshotName": "string",
"relationalDatabaseName": "string",
"skipFinalSnapshot": boolean
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [finalRelationalDatabaseSnapshotName](#API_DeleteRelationalDatabase_RequestSyntax) **
The name of the database snapshot created if `skip final snapshot` is `false`, which is the default value for that parameter.
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 first and last character must be a letter or number.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [relationalDatabaseName](#API_DeleteRelationalDatabase_RequestSyntax) **
The name of the database that you are deleting.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [skipFinalSnapshot](#API_DeleteRelationalDatabase_RequestSyntax) **
Determines whether a final database snapshot is created before your database is deleted. If `true` is specified, no database snapshot is created. If `false` is specified, 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",
"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](#API_DeleteRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteRelationalDatabase)
# 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 identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"relationalDatabaseSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseSnapshotName](#API_DeleteRelationalDatabaseSnapshot_RequestSyntax) **
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,
"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](#API_DeleteRelationalDatabaseSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DeleteRelationalDatabaseSnapshot)
# DetachCertificateFromDistribution
Detaches an SSL/TLS certificate from your Amazon Lightsail content delivery network (CDN) distribution.
After the certificate is detached, your distribution stops accepting traffic for all of the domains that are associated with the certificate.
## Request Syntax
```
{
"distributionName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_DetachCertificateFromDistribution_RequestSyntax) **
The name of the distribution from which to detach the certificate.
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",
"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](#API_DetachCertificateFromDistribution_ResponseSyntax) **
An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DetachCertificateFromDistribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DetachCertificateFromDistribution)
# DetachDisk
Detaches a stopped block storage disk from a Lightsail instance. Make sure to unmount any file systems on the device within your operating system before stopping the instance and detaching the disk.
The `detach disk` operation supports tag-based access control via resource tags applied to the resource identified by `disk name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"diskName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskName](#API_DetachDisk_RequestSyntax) **
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",
"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](#API_DetachDisk_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DetachDisk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DetachDisk)
# DetachInstancesFromLoadBalancer
Detaches the specified 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 identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceNames": [ "string" ],
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceNames](#API_DetachInstancesFromLoadBalancer_RequestSyntax) **
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](#API_DetachInstancesFromLoadBalancer_RequestSyntax) **
The name of the Lightsail load balancer.
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.
** [operations](#API_DetachInstancesFromLoadBalancer_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DetachInstancesFromLoadBalancer)
# DetachStaticIp
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [staticIpName](#API_DetachStaticIp_RequestSyntax) **
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",
"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](#API_DetachStaticIp_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DetachStaticIp)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DetachStaticIp)
# DisableAddOn
Disables an add-on for an Amazon Lightsail resource. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
## Request Syntax
```
{
"addOnType": "string",
"resourceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOnType](#API_DisableAddOn_RequestSyntax) **
The add-on type to disable.
Type: String
Valid Values: `AutoSnapshot | StopInstanceOnIdle`
Required: Yes
** [resourceName](#API_DisableAddOn_RequestSyntax) **
The name of the source resource for which to disable the add-on.
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.
** [operations](#API_DisableAddOn_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DisableAddOn)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DisableAddOn)
# 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](#API_DownloadDefaultKeyPair_ResponseSyntax) **
The timestamp when the default key pair was created.
Type: Timestamp
** [privateKeyBase64](#API_DownloadDefaultKeyPair_ResponseSyntax) **
A base64-encoded RSA private key.
Type: String
** [publicKeyBase64](#API_DownloadDefaultKeyPair_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/DownloadDefaultKeyPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/DownloadDefaultKeyPair)
# EnableAddOn
Enables or modifies an add-on for an Amazon Lightsail resource. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [addOnRequest](#API_EnableAddOn_RequestSyntax) **
An array of strings representing the add-on to enable or modify.
Type: [AddOnRequest](API_AddOnRequest.md) object
Required: Yes
** [resourceName](#API_EnableAddOn_RequestSyntax) **
The name of the source resource for which to enable or modify the add-on.
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.
** [operations](#API_EnableAddOn_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/EnableAddOn)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/EnableAddOn)
# ExportSnapshot
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 identified by `source snapshot name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
**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](CommonParameters.md).
The request accepts the following data in JSON format.
** [sourceSnapshotName](#API_ExportSnapshot_RequestSyntax) **
The name of the instance or disk snapshot to be exported to Amazon EC2.
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.
** [operations](#API_ExportSnapshot_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/ExportSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/ExportSnapshot)
# GetActiveNames
Returns the names of all active (not deleted) resources.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetActiveNames_RequestSyntax) **
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.
** [activeNames](#API_GetActiveNames_ResponseSyntax) **
The list of active names returned by the get active names request.
Type: Array of strings
** [nextPageToken](#API_GetActiveNames_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetActiveNames)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetActiveNames)
# GetAlarms
Returns information about the configured alarms. Specify an alarm name in your request to return information about a specific alarm, or specify a monitored resource name to return information about all alarms for a specific 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms).
## Request Syntax
```
{
"alarmName": "string",
"monitoredResourceName": "string",
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [alarmName](#API_GetAlarms_RequestSyntax) **
The name of the alarm.
Specify an alarm name to return information about a specific alarm.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [monitoredResourceName](#API_GetAlarms_RequestSyntax) **
The name of the Lightsail resource being monitored by the alarm.
Specify a monitored resource name to return information about all alarms for a specific resource.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [pageToken](#API_GetAlarms_RequestSyntax) **
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,
"resourceType": "string",
"state": "string",
"statistic": "string",
"supportCode": "string",
"tags": [
{
"key": "string",
"value": "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](#API_GetAlarms_ResponseSyntax) **
An array of objects that describe the alarms.
Type: Array of [Alarm](API_Alarm.md) objects
** [nextPageToken](#API_GetAlarms_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetAlarms)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetAlarms)
# GetAutoSnapshots
Returns the available automatic snapshots for an instance or disk. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-automatic-snapshots).
## Request Syntax
```
{
"resourceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceName](#API_GetAutoSnapshots_RequestSyntax) **
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"
}
],
"resourceName": "string",
"resourceType": "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.
** [autoSnapshots](#API_GetAutoSnapshots_ResponseSyntax) **
An array of objects that describe the automatic snapshots that are available for the specified source instance or disk.
Type: Array of [AutoSnapshotDetails](API_AutoSnapshotDetails.md) objects
** [resourceName](#API_GetAutoSnapshots_ResponseSyntax) **
The name of the source instance or disk for the automatic snapshots.
Type: String
Pattern: `\w[\w\-]*\w`
** [resourceType](#API_GetAutoSnapshots_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetAutoSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetAutoSnapshots)
# GetBlueprints
Returns the list of available instance images, or *blueprints*. You can use a blueprint to create a new instance already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.
**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](CommonParameters.md).
The request accepts the following data in JSON format.
** [appCategory](#API_GetBlueprints_RequestSyntax) **
Returns a list of blueprints that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research blueprints.
Type: String
Valid Values: `LfR`
Required: No
** [includeInactive](#API_GetBlueprints_RequestSyntax) **
A Boolean value that indicates whether to include inactive (unavailable) blueprints in the response of your request.
Type: Boolean
Required: No
** [pageToken](#API_GetBlueprints_RequestSyntax) **
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"
}
],
"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](#API_GetBlueprints_ResponseSyntax) **
An array of key-value pairs that contains information about the available blueprints.
Type: Array of [Blueprint](API_Blueprint.md) objects
** [nextPageToken](#API_GetBlueprints_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBlueprints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBlueprints)
# GetBucketAccessKeys
Returns the existing access key IDs for the specified 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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateBucketAccessKey.html) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_GetBucketAccessKeys_RequestSyntax) **
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
```
{
"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](#API_GetBucketAccessKeys_ResponseSyntax) **
An object that describes the access keys for the specified bucket.
Type: Array of [AccessKey](API_AccessKey.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) 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)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure 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`).
#### Sample Request
```
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBucketAccessKeys)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBucketAccessKeys)
# GetBucketBundles
Returns the bundles that you can apply to a Amazon Lightsail bucket.
The bucket bundle specifies the monthly cost, storage quota, and data transfer quota for a bucket.
Use the [UpdateBucketBundle](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_UpdateBucketBundle.html) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [includeInactive](#API_GetBucketBundles_RequestSyntax) **
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
}
]
}
```
## 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](#API_GetBucketBundles_ResponseSyntax) **
An object that describes bucket bundles.
Type: Array of [BucketBundle](API_BucketBundle.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBucketBundles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBucketBundles)
# GetBucketMetricData
Returns the data points of a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_GetBucketMetricData_RequestSyntax) **
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](#API_GetBucketMetricData_RequestSyntax) **
The timestamp indicating the latest data to be returned.
Type: Timestamp
Required: Yes
** [metricName](#API_GetBucketMetricData_RequestSyntax) **
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.
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](#API_GetBucketMetricData_RequestSyntax) **
The granularity, in seconds, of the returned data points.
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](#API_GetBucketMetricData_RequestSyntax) **
The timestamp indicating the earliest data to be returned.
Type: Timestamp
Required: Yes
** [statistics](#API_GetBucketMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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](#API_GetBucketMetricData_RequestSyntax) **
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": [
{
"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](#API_GetBucketMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetBucketMetricData_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBucketMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBucketMetricData)
# GetBuckets
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](https://docs.aws.amazon.com/lightsail/latest/userguide/buckets-in-amazon-lightsail) in the *Amazon Lightsail Developer Guide*.
## Request Syntax
```
{
"bucketName": "string",
"includeConnectedResources": boolean,
"includeCors": boolean,
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_GetBuckets_RequestSyntax) **
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](#API_GetBuckets_RequestSyntax) **
A Boolean value that indicates whether to include Lightsail instances that were given access to the bucket using the [SetResourceAccessForBucket](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_SetResourceAccessForBucket.html) action.
Type: Boolean
Required: No
** [includeCors](#API_GetBuckets_RequestSyntax) **
A Boolean value that indicates whether to include Lightsail bucket CORS configuration in the response. For more information, see [Configuring cross-origin resource sharing (CORS)](https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html).
This parameter is only supported when getting a single bucket with `bucketName` specified. The default value for this parameter is `False`.
Type: Boolean
Required: No
** [pageToken](#API_GetBuckets_RequestSyntax) **
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",
"cors": {
"rules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposeHeaders": [ "string" ],
"id": "string",
"maxAgeSeconds": number
}
]
},
"createdAt": number,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"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](#API_GetBuckets_ResponseSyntax) **
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 affects Lightsail buckets, see [Block public access for buckets in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-block-public-access-for-buckets).
Type: [AccountLevelBpaSync](API_AccountLevelBpaSync.md) object
** [buckets](#API_GetBuckets_ResponseSyntax) **
An array of objects that describe buckets.
Type: Array of [Bucket](API_Bucket.md) objects
** [nextPageToken](#API_GetBuckets_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBuckets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBuckets)
# GetBundles
Returns the bundles that you can apply to an Amazon Lightsail instance when you create it.
A bundle describes the specifications 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [appCategory](#API_GetBundles_RequestSyntax) **
Returns a list of bundles that are specific to Lightsail for Research.
You must use this parameter to view Lightsail for Research bundles.
Type: String
Valid Values: `LfR`
Required: No
** [includeInactive](#API_GetBundles_RequestSyntax) **
A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.
Type: Boolean
Required: No
** [pageToken](#API_GetBundles_RequestSyntax) **
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 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](#API_GetBundles_ResponseSyntax) **
An array of key-value pairs that contains information about the available bundles.
Type: Array of [Bundle](API_Bundle.md) objects
** [nextPageToken](#API_GetBundles_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetBundles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetBundles)
# GetCertificates
Returns information about one or more Amazon Lightsail SSL/TLS certificates.
**Note**
To get a summary of a certificate, omit `includeCertificateDetails` from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateName](#API_GetCertificates_RequestSyntax) **
The name for the certificate for which to return information.
When omitted, the response includes all of your certificates in the AWS Region where the request is made.
Type: String
Required: No
** [certificateStatuses](#API_GetCertificates_RequestSyntax) **
The status of the certificates for which to return information.
For example, specify `ISSUED` to return only certificates with an `ISSUED` status.
When omitted, the response includes all of your certificates 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
** [includeCertificateDetails](#API_GetCertificates_RequestSyntax) **
Indicates whether to include detailed information about the certificates in the response.
When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.
Type: Boolean
Required: No
** [pageToken](#API_GetCertificates_RequestSyntax) **
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": [
{
"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",
"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.
** [certificates](#API_GetCertificates_ResponseSyntax) **
An object that describes certificates.
Type: Array of [CertificateSummary](API_CertificateSummary.md) objects
** [nextPageToken](#API_GetCertificates_ResponseSyntax) **
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
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetCertificates)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetCertificates)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetCloudFormationStackRecords_RequestSyntax) **
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,
"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](#API_GetCloudFormationStackRecords_ResponseSyntax) **
A list of objects describing the CloudFormation stack records.
Type: Array of [CloudFormationStackRecord](API_CloudFormationStackRecord.md) objects
** [nextPageToken](#API_GetCloudFormationStackRecords_ResponseSyntax) **
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.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetCloudFormationStackRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetCloudFormationStackRecords)
# GetContactMethods
Returns information about the configured contact methods. Specify a protocol in your request to return information about a specific contact method.
A contact method is used to send you notifications 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 [Notifications in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications).
## Request Syntax
```
{
"protocols": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [protocols](#API_GetContactMethods_RequestSyntax) **
The protocols used to send notifications, such as `Email`, or `SMS` (text messaging).
Specify a protocol in your request to return information about a specific contact method protocol.
Type: Array of strings
Valid Values: `Email | SMS`
Required: No
## Response Syntax
```
{
"contactMethods": [
{
"arn": "string",
"contactEndpoint": "string",
"createdAt": number,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"name": "string",
"protocol": "string",
"resourceType": "string",
"status": "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.
** [contactMethods](#API_GetContactMethods_ResponseSyntax) **
An array of objects that describe the contact methods.
Type: Array of [ContactMethod](API_ContactMethod.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContactMethods)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContactMethods)
# 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](#API_GetContainerAPIMetadata_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** AccessDeniedException **
Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerAPIMetadata)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerAPIMetadata)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [serviceName](#API_GetContainerImages_RequestSyntax) **
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": [
{
"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](#API_GetContainerImages_ResponseSyntax) **
An array of objects that describe container images that are registered to the container service.
Type: Array of [ContainerImage](API_ContainerImage.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerImages)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerImages)
# GetContainerLog
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 specified 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](https://docs.aws.amazon.com/general/latest/gr/lightsail.html) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [containerName](#API_GetContainerLog_RequestSyntax) **
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](#API_GetContainerLog_RequestSyntax) **
The end of the time interval for which to get log data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified in the Unix time format.
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](https://www.epochconverter.com/).
Type: Timestamp
Required: No
** [filterPattern](#API_GetContainerLog_RequestSyntax) **
The pattern to use to filter the returned log events to a specific term.
The following are a few examples of filter patterns that you can specify:
+ To return all log events, specify a filter pattern of `""`.
+ To exclude log events that contain the `ERROR` term, and return all other log events, specify a filter pattern of `"-ERROR"`.
+ To return log events that contain the `ERROR` term, specify a filter pattern of `"ERROR"`.
+ To return log events that contain both the `ERROR` and `Exception` terms, specify a filter pattern of `"ERROR Exception"`.
+ To return log events that contain the `ERROR` *or* the `Exception` term, specify a filter pattern of `"?ERROR ?Exception"`.
Type: String
Required: No
** [pageToken](#API_GetContainerLog_RequestSyntax) **
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.
Type: String
Required: No
** [serviceName](#API_GetContainerLog_RequestSyntax) **
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](#API_GetContainerLog_RequestSyntax) **
The start of the time interval for which to get log data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](https://www.epochconverter.com/).
Type: Timestamp
Required: No
## Response Syntax
```
{
"logEvents": [
{
"createdAt": number,
"message": "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.
** [logEvents](#API_GetContainerLog_ResponseSyntax) **
An array of objects that describe the log events of a container.
Type: Array of [ContainerServiceLogEvent](API_ContainerServiceLogEvent.md) objects
** [nextPageToken](#API_GetContainerLog_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerLog)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerLog)
# GetContainerServiceDeployments
Returns the deployments for your Amazon Lightsail container service
A deployment specifies 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](https://docs.aws.amazon.com/general/latest/gr/lightsail.html) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [serviceName](#API_GetContainerServiceDeployments_RequestSyntax) **
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
## 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.
** [deployments](#API_GetContainerServiceDeployments_ResponseSyntax) **
An array of objects that describe deployments for a container service.
Type: Array of [ContainerServiceDeployment](API_ContainerServiceDeployment.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerServiceDeployments)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerServiceDeployments)
# GetContainerServiceMetricData
Returns the data points of a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetContainerServiceMetricData_RequestSyntax) **
The end time of the time period.
Type: Timestamp
Required: Yes
** [metricName](#API_GetContainerServiceMetricData_RequestSyntax) **
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 identifies the processing power 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`.
+ `MemoryUtilization` - The average percentage of available memory that is currently in use across all nodes of the container service. This metric identifies 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](#API_GetContainerServiceMetricData_RequestSyntax) **
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](#API_GetContainerServiceMetricData_RequestSyntax) **
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](#API_GetContainerServiceMetricData_RequestSyntax) **
The start time of the time period.
Type: Timestamp
Required: Yes
** [statistics](#API_GetContainerServiceMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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 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](#API_GetContainerServiceMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetContainerServiceMetricData_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerServiceMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerServiceMetricData)
# GetContainerServicePowers
Returns the list of powers that can be specified for your Amazon Lightsail container services.
The power specifies 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](#API_GetContainerServicePowers_ResponseSyntax) **
An array of objects that describe the powers that can be specified for a container service.
Type: Array of [ContainerServicePower](API_ContainerServicePower.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerServicePowers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerServicePowers)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [serviceName](#API_GetContainerServices_RequestSyntax) **
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" : {
"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"
}
}
},
"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 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](#API_GetContainerServices_ResponseSyntax) **
An array of objects that describe one or more container services.
Type: Array of [ContainerService](API_ContainerService.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetContainerServices)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetContainerServices)
# GetCostEstimate
Retrieves information about the cost estimate for a specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetCostEstimate_RequestSyntax) **
The cost estimate end time.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](https://www.epochconverter.com/).
Type: Timestamp
Required: Yes
** [resourceName](#API_GetCostEstimate_RequestSyntax) **
The resource name.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [startTime](#API_GetCostEstimate_RequestSyntax) **
The cost estimate start time.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](https://www.epochconverter.com/).
Type: Timestamp
Required: Yes
## Response Syntax
```
{
"resourcesBudgetEstimate": [
{
"costEstimates": [
{
"resultsByTime": [
{
"currency": "string",
"pricingUnit": "string",
"timePeriod": {
"end": number,
"start": number
},
"unit": number,
"usageCost": number
}
],
"usageType": "string"
}
],
"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](#API_GetCostEstimate_ResponseSyntax) **
Returns the estimate's forecasted cost or usage.
Type: Array of [ResourceBudgetEstimate](API_ResourceBudgetEstimate.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetCostEstimate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetCostEstimate)
# GetDisk
Returns information about a specific block storage disk.
## Request Syntax
```
{
"diskName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskName](#API_GetDisk_RequestSyntax) **
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",
"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](#API_GetDisk_ResponseSyntax) **
An object containing information about the disk.
Type: [Disk](API_Disk.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDisk)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDisk)
# GetDisks
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetDisks_RequestSyntax) **
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"
}
],
"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](#API_GetDisks_ResponseSyntax) **
An array of objects containing information about all block storage disks.
Type: Array of [Disk](API_Disk.md) objects
** [nextPageToken](#API_GetDisks_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDisks)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDisks)
# GetDiskSnapshot
Returns information about a specific block storage disk snapshot.
## Request Syntax
```
{
"diskSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [diskSnapshotName](#API_GetDiskSnapshot_RequestSyntax) **
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"
},
"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](#API_GetDiskSnapshot_ResponseSyntax) **
An object containing information about the disk snapshot.
Type: [DiskSnapshot](API_DiskSnapshot.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDiskSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDiskSnapshot)
# GetDiskSnapshots
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetDiskSnapshots_RequestSyntax) **
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,
"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](#API_GetDiskSnapshots_ResponseSyntax) **
An array of objects containing information about all block storage disk snapshots.
Type: Array of [DiskSnapshot](API_DiskSnapshot.md) objects
** [nextPageToken](#API_GetDiskSnapshots_ResponseSyntax) **
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
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDiskSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDiskSnapshots)
# GetDistributionBundles
Returns the bundles that can be applied to your Amazon Lightsail content delivery network (CDN) distributions.
A distribution bundle specifies 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](#API_GetDistributionBundles_ResponseSyntax) **
An object that describes a distribution bundle.
Type: Array of [DistributionBundle](API_DistributionBundle.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDistributionBundles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDistributionBundles)
# GetDistributionLatestCacheReset
Returns the timestamp and status of the last cache reset of a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_GetDistributionLatestCacheReset_RequestSyntax) **
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.
The following data is returned in JSON format by the service.
** [createTime](#API_GetDistributionLatestCacheReset_ResponseSyntax) **
The timestamp of the last cache reset (`1479734909.17`) in Unix time format.
Type: Timestamp
** [status](#API_GetDistributionLatestCacheReset_ResponseSyntax) **
The status of the last cache reset.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDistributionLatestCacheReset)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDistributionLatestCacheReset)
# GetDistributionMetricData
Returns the data points of a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_GetDistributionMetricData_RequestSyntax) **
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](#API_GetDistributionMetricData_RequestSyntax) **
The end of the time interval for which to get metric data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified in the Unix time format.
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](https://www.epochconverter.com/).
Type: Timestamp
Required: Yes
** [metricName](#API_GetDistributionMetricData_RequestSyntax) **
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 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.
`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](#API_GetDistributionMetricData_RequestSyntax) **
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](#API_GetDistributionMetricData_RequestSyntax) **
The start of the time interval for which to get metric data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](https://www.epochconverter.com/).
Type: Timestamp
Required: Yes
** [statistics](#API_GetDistributionMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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](#API_GetDistributionMetricData_RequestSyntax) **
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": [
{
"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](#API_GetDistributionMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetDistributionMetricData_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDistributionMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDistributionMetricData)
# GetDistributions
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_GetDistributions_RequestSyntax) **
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](#API_GetDistributions_RequestSyntax) **
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
## 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": {
"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](#API_GetDistributions_ResponseSyntax) **
An array of objects that describe your distributions.
Type: Array of [LightsailDistribution](API_LightsailDistribution.md) objects
** [nextPageToken](#API_GetDistributions_ResponseSyntax) **
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 `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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDistributions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDistributions)
# GetDomain
Returns information about a specific domain recordset.
## Request Syntax
```
{
"domainName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainName](#API_GetDomain_RequestSyntax) **
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"
}
],
"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](#API_GetDomain_ResponseSyntax) **
An array of key-value pairs containing information about your get domain request.
Type: [Domain](API_Domain.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDomain)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDomain)
# GetDomains
Returns a list of all domains in the user's account.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetDomains_RequestSyntax) **
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,
"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.
** [domains](#API_GetDomains_ResponseSyntax) **
An array of key-value pairs containing information about each of the domain entries in the user's account.
Type: Array of [Domain](API_Domain.md) objects
** [nextPageToken](#API_GetDomains_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetDomains)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetDomains)
# 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](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_CreateCloudFormationStack.html) action.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetExportSnapshotRecords_RequestSyntax) **
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": {
"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.
** [exportSnapshotRecords](#API_GetExportSnapshotRecords_ResponseSyntax) **
A list of objects describing the export snapshot records.
Type: Array of [ExportSnapshotRecord](API_ExportSnapshotRecord.md) objects
** [nextPageToken](#API_GetExportSnapshotRecords_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetExportSnapshotRecords)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetExportSnapshotRecords)
# GetInstance
Returns information about a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_GetInstance_RequestSyntax) **
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",
"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"
}
]
}
],
"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"
},
"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](#API_GetInstance_ResponseSyntax) **
An array of key-value pairs containing information about the specified instance.
Type: [Instance](API_Instance.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstance)
# GetInstanceAccessDetails
Returns temporary SSH keys you can use to connect to a specific virtual private server, or *instance*.
The `get instance access details` operation supports tag-based access control via resource tags applied to the resource identified by `instance name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceName": "string",
"protocol": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_GetInstanceAccessDetails_RequestSyntax) **
The name of the instance to access.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [protocol](#API_GetInstanceAccessDetails_RequestSyntax) **
The protocol to use to connect to your instance. Defaults to `ssh`.
Type: String
Valid Values: `ssh | rdp`
Required: No
## 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](#API_GetInstanceAccessDetails_ResponseSyntax) **
An array of key-value pairs containing information about a get instance access request.
Type: [InstanceAccessDetails](API_InstanceAccessDetails.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstanceAccessDetails)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstanceAccessDetails)
# GetInstanceMetricData
Returns the data points for the specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetInstanceMetricData_RequestSyntax) **
The end time of the time period.
Type: Timestamp
Required: Yes
** [instanceName](#API_GetInstanceMetricData_RequestSyntax) **
The name of the instance for which you want to get metrics data.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [metricName](#API_GetInstanceMetricData_RequestSyntax) **
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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity).
`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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-viewing-instance-burst-capacity).
`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 identifies 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`.
+ ** `NetworkIn` ** - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic 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 find 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 identifies the volume of outgoing network traffic 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 find 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. 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 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](#API_GetInstanceMetricData_RequestSyntax) **
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](#API_GetInstanceMetricData_RequestSyntax) **
The start time of the time period.
Type: Timestamp
Required: Yes
** [statistics](#API_GetInstanceMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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](#API_GetInstanceMetricData_RequestSyntax) **
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": [
{
"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](#API_GetInstanceMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetInstanceMetricData_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstanceMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstanceMetricData)
# GetInstancePortStates
Returns the firewall port states for a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_GetInstancePortStates_RequestSyntax) **
The name of the instance for which to return firewall 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
}
]
}
```
## 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.
** [portStates](#API_GetInstancePortStates_ResponseSyntax) **
An array of objects that describe the firewall port states for the specified instance.
Type: Array of [InstancePortState](API_InstancePortState.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstancePortStates)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstancePortStates)
# GetInstances
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetInstances_RequestSyntax) **
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"
}
],
"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"
}
]
}
],
"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"
},
"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](#API_GetInstances_ResponseSyntax) **
An array of key-value pairs containing information about your instances.
Type: Array of [Instance](API_Instance.md) objects
** [nextPageToken](#API_GetInstances_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) 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)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure 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
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},
"ports": [
{
"accessDirection": "inbound",
"accessFrom": "Anywhere (0.0.0.0/0)",
"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"
},
"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",
"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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstances)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstances)
# GetInstanceSnapshot
Returns information about a specific instance snapshot.
## Request Syntax
```
{
"instanceSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceSnapshotName](#API_GetInstanceSnapshot_RequestSyntax) **
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"
}
],
"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",
"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](#API_GetInstanceSnapshot_ResponseSyntax) **
An array of key-value pairs containing information about the results of your get instance snapshot request.
Type: [InstanceSnapshot](API_InstanceSnapshot.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstanceSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstanceSnapshot)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetInstanceSnapshots_RequestSyntax) **
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",
"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",
"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](#API_GetInstanceSnapshots_ResponseSyntax) **
An array of key-value pairs containing information about the results of your get instance snapshots request.
Type: Array of [InstanceSnapshot](API_InstanceSnapshot.md) objects
** [nextPageToken](#API_GetInstanceSnapshots_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstanceSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstanceSnapshots)
# GetInstanceState
Returns the state of a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_GetInstanceState_RequestSyntax) **
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.
** [state](#API_GetInstanceState_ResponseSyntax) **
The state of the instance.
Type: [InstanceState](API_InstanceState.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetInstanceState)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetInstanceState)
# GetKeyPair
Returns information about a specific key pair.
## Request Syntax
```
{
"keyPairName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [keyPairName](#API_GetKeyPair_RequestSyntax) **
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",
"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](#API_GetKeyPair_ResponseSyntax) **
An array of key-value pairs containing information about the key pair.
Type: [KeyPair](API_KeyPair.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetKeyPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetKeyPair)
# GetKeyPairs
Returns information about all key pairs in the user's account.
## Request Syntax
```
{
"includeDefaultKeyPair": boolean,
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [includeDefaultKeyPair](#API_GetKeyPairs_RequestSyntax) **
A Boolean value that indicates whether to include the default key pair in the response of your request.
Type: Boolean
Required: No
** [pageToken](#API_GetKeyPairs_RequestSyntax) **
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
```
{
"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](#API_GetKeyPairs_ResponseSyntax) **
An array of key-value pairs containing information about the key pairs.
Type: Array of [KeyPair](API_KeyPair.md) objects
** [nextPageToken](#API_GetKeyPairs_ResponseSyntax) **
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.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetKeyPairs)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetKeyPairs)
# GetLoadBalancer
Returns information about the specified Lightsail load balancer.
## Request Syntax
```
{
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [loadBalancerName](#API_GetLoadBalancer_RequestSyntax) **
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",
"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](#API_GetLoadBalancer_ResponseSyntax) **
An object containing information about your load balancer.
Type: [LoadBalancer](API_LoadBalancer.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetLoadBalancer)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetLoadBalancer)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetLoadBalancerMetricData_RequestSyntax) **
The end time of the period.
Type: Timestamp
Required: Yes
** [loadBalancerName](#API_GetLoadBalancerMetricData_RequestSyntax) **
The name of the load balancer.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [metricName](#API_GetLoadBalancerMetricData_RequestSyntax) **
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 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.
`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`.
+ ** `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](#API_GetLoadBalancerMetricData_RequestSyntax) **
The granularity, in seconds, of the returned data points.
Type: Integer
Valid Range: Minimum value of 60. Maximum value of 86400.
Required: Yes
** [startTime](#API_GetLoadBalancerMetricData_RequestSyntax) **
The start time of the period.
Type: Timestamp
Required: Yes
** [statistics](#API_GetLoadBalancerMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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](#API_GetLoadBalancerMetricData_RequestSyntax) **
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": [
{
"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](#API_GetLoadBalancerMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetLoadBalancerMetricData_ResponseSyntax) **
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`
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetLoadBalancerMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetLoadBalancerMetricData)
# GetLoadBalancers
Returns information about all load balancers in an account.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetLoadBalancers_RequestSyntax) **
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",
"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.
** [loadBalancers](#API_GetLoadBalancers_ResponseSyntax) **
An array of LoadBalancer objects describing your load balancers.
Type: Array of [LoadBalancer](API_LoadBalancer.md) objects
** [nextPageToken](#API_GetLoadBalancers_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetLoadBalancers)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetLoadBalancers)
# GetLoadBalancerTlsCertificates
Returns information about the TLS certificates that are associated with the specified Lightsail load balancer.
TLS is just an updated, more secure version of Secure Socket Layer (SSL).
You can have a maximum of 2 certificates 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [loadBalancerName](#API_GetLoadBalancerTlsCertificates_RequestSyntax) **
The name of the load balancer you associated with your SSL/TLS certificate.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
## Response Syntax
```
{
"tlsCertificates": [
{
"arn": "string",
"createdAt": number,
"domainName": "string",
"domainValidationRecords": [
{
"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": [
{
"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.
** [tlsCertificates](#API_GetLoadBalancerTlsCertificates_ResponseSyntax) **
An array of LoadBalancerTlsCertificate objects describing your SSL/TLS certificates.
Type: Array of [LoadBalancerTlsCertificate](API_LoadBalancerTlsCertificate.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetLoadBalancerTlsCertificates)
# 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 [Configuring TLS security policies on your Amazon Lightsail load balancers](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configure-load-balancer-tls-security-policy) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetLoadBalancerTlsPolicies_RequestSyntax) **
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,
"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](#API_GetLoadBalancerTlsPolicies_ResponseSyntax) **
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](#API_GetLoadBalancerTlsPolicies_ResponseSyntax) **
An array of objects that describe the TLS security policies that are available.
Type: Array of [LoadBalancerTlsPolicy](API_LoadBalancerTlsPolicy.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetLoadBalancerTlsPolicies)
# GetOperation
Returns information about a specific operation. Operations include events such as when you create an instance, allocate a static IP, attach a static IP, and so on.
## Request Syntax
```
{
"operationId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [operationId](#API_GetOperation_RequestSyntax) **
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"
},
"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](#API_GetOperation_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetOperation)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetOperation)
# GetOperations
Returns information about all operations.
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetOperations_RequestSyntax) **
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",
"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](#API_GetOperations_ResponseSyntax) **
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](#API_GetOperations_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetOperations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetOperations)
# GetOperationsForResource
Gets operations for a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetOperationsForResource_RequestSyntax) **
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](#API_GetOperationsForResource_RequestSyntax) **
The name of the resource for which you are requesting information.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
## Response Syntax
```
{
"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](#API_GetOperationsForResource_ResponseSyntax) **
*This parameter has been deprecated.*
(Discontinued) Returns the number of pages of results that remain.
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
** [nextPageToken](#API_GetOperationsForResource_ResponseSyntax) **
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](#API_GetOperationsForResource_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetOperationsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetOperationsForResource)
# GetRegions
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [includeAvailabilityZones](#API_GetRegions_RequestSyntax) **
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](#API_GetRegions_RequestSyntax) **
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
```
{
"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](#API_GetRegions_ResponseSyntax) **
An array of key-value pairs containing information about your get regions request.
Type: Array of [Region](API_Region.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRegions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRegions)
# GetRelationalDatabase
Returns information about a specific database in Amazon Lightsail.
## Request Syntax
```
{
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_GetRelationalDatabase_RequestSyntax) **
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,
"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 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.
** [relationalDatabase](#API_GetRelationalDatabase_ResponseSyntax) **
An object describing the specified database.
Type: [RelationalDatabase](API_RelationalDatabase.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabase)
# 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 specific database engine.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetRelationalDatabaseBlueprints_RequestSyntax) **
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",
"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](#API_GetRelationalDatabaseBlueprints_ResponseSyntax) **
An object describing the result of your get relational database blueprints request.
Type: Array of [RelationalDatabaseBlueprint](API_RelationalDatabaseBlueprint.md) objects
** [nextPageToken](#API_GetRelationalDatabaseBlueprints_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseBlueprints)
# GetRelationalDatabaseBundles
Returns the list of bundles that are available in Amazon Lightsail. A bundle describes the performance specifications for a database.
You can use a bundle ID to create a new database with explicit performance specifications.
## Request Syntax
```
{
"includeInactive": boolean,
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [includeInactive](#API_GetRelationalDatabaseBundles_RequestSyntax) **
A Boolean value that indicates whether to include inactive (unavailable) bundles in the response of your request.
Type: Boolean
Required: No
** [pageToken](#API_GetRelationalDatabaseBundles_RequestSyntax) **
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
## 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](#API_GetRelationalDatabaseBundles_ResponseSyntax) **
An object describing the result of your get relational database bundles request.
Type: Array of [RelationalDatabaseBundle](API_RelationalDatabaseBundle.md) objects
** [nextPageToken](#API_GetRelationalDatabaseBundles_ResponseSyntax) **
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
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseBundles)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseBundles)
# GetRelationalDatabaseEvents
Returns a list of events for a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [durationInMinutes](#API_GetRelationalDatabaseEvents_RequestSyntax) **
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](#API_GetRelationalDatabaseEvents_RequestSyntax) **
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
Required: No
** [relationalDatabaseName](#API_GetRelationalDatabaseEvents_RequestSyntax) **
The name of the database from which to get events.
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](#API_GetRelationalDatabaseEvents_ResponseSyntax) **
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
** [relationalDatabaseEvents](#API_GetRelationalDatabaseEvents_ResponseSyntax) **
An object describing the result of your get relational database events request.
Type: Array of [RelationalDatabaseEvent](API_RelationalDatabaseEvent.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseEvents)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
The end of the time interval from which to get log events.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
The name of the log stream.
Use the `get relational database log streams` operation to get a list of available log streams.
Type: String
Required: Yes
** [pageToken](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
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](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
The name of your database for which to get log events.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [startFromHead](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
Parameter to specify if the log should start from head or tail. If `true` is specified, the log event starts from the head of the log. If `false` is specified, the log event starts from the tail of the log.
For PostgreSQL, the default value of `false` is the only option available.
Type: Boolean
Required: No
** [startTime](#API_GetRelationalDatabaseLogEvents_RequestSyntax) **
The start of the time interval from which to get log events.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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: 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](#API_GetRelationalDatabaseLogEvents_ResponseSyntax) **
A token used for advancing to the previous page of results from your get relational database log events request.
Type: String
** [nextForwardToken](#API_GetRelationalDatabaseLogEvents_ResponseSyntax) **
A token used for advancing to the next page of results from your get relational database log events request.
Type: String
** [resourceLogEvents](#API_GetRelationalDatabaseLogEvents_ResponseSyntax) **
An object describing the result of your get relational database log events request.
Type: Array of [LogEvent](API_LogEvent.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseLogEvents)
# GetRelationalDatabaseLogStreams
Returns a list of available log streams for a specific database in Amazon Lightsail.
## Request Syntax
```
{
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_GetRelationalDatabaseLogStreams_RequestSyntax) **
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](#API_GetRelationalDatabaseLogStreams_ResponseSyntax) **
An object describing the result of your get relational database log streams request.
Type: Array of strings
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseLogStreams)
# 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 identified by relationalDatabaseName.
## Request Syntax
```
{
"passwordVersion": "string",
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [passwordVersion](#API_GetRelationalDatabaseMasterUserPassword_RequestSyntax) **
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](#API_GetRelationalDatabaseMasterUserPassword_RequestSyntax) **
The name of your database for which to get the master user password.
Type: String
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](#API_GetRelationalDatabaseMasterUserPassword_ResponseSyntax) **
The timestamp when the specified version of the master user password was created.
Type: Timestamp
** [masterUserPassword](#API_GetRelationalDatabaseMasterUserPassword_ResponseSyntax) **
The master user password for the `password version` specified.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseMasterUserPassword)
# GetRelationalDatabaseMetricData
Returns the data points of the specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [endTime](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
The end of the time interval from which to get metric data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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
** [metricName](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
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 traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
`Statistics`: The most useful statistic is `Average`.
`Unit`: The published unit is `Bytes/Second`.
+ ** `NetworkTransmitThroughput` ** - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.
`Statistics`: The most useful statistic is `Average`.
`Unit`: The published unit is `Bytes/Second`.
Type: String
Valid Values: `CPUUtilization | DatabaseConnections | DiskQueueDepth | FreeStorageSpace | NetworkReceiveThroughput | NetworkTransmitThroughput`
Required: Yes
** [period](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
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](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
The name of your database from which to get metric data.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [startTime](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
The start of the time interval from which to get metric data.
Constraints:
+ Specified in Coordinated Universal Time (UTC).
+ Specified 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](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
The statistic for the metric.
The following statistics are available:
+ `Minimum` - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
+ `Maximum` - The highest value observed during the specified 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 specified 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](#API_GetRelationalDatabaseMetricData_RequestSyntax) **
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": [
{
"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](#API_GetRelationalDatabaseMetricData_ResponseSyntax) **
An array of objects that describe the metric data returned.
Type: Array of [MetricDatapoint](API_MetricDatapoint.md) objects
** [metricName](#API_GetRelationalDatabaseMetricData_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseMetricData)
# GetRelationalDatabaseParameters
Returns all of the runtime parameters offered by the underlying database software, or engine, for a specific 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 modifiable, 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetRelationalDatabaseParameters_RequestSyntax) **
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](#API_GetRelationalDatabaseParameters_RequestSyntax) **
The name of your database for which to get parameters.
Type: String
Pattern: `\w[\w\-]*\w`
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](#API_GetRelationalDatabaseParameters_ResponseSyntax) **
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](#API_GetRelationalDatabaseParameters_ResponseSyntax) **
An object describing the result of your get relational database parameters request.
Type: Array of [RelationalDatabaseParameter](API_RelationalDatabaseParameter.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseParameters)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetRelationalDatabases_RequestSyntax) **
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": {
"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 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](#API_GetRelationalDatabases_ResponseSyntax) **
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](#API_GetRelationalDatabases_ResponseSyntax) **
An object describing the result of your get relational databases request.
Type: Array of [RelationalDatabase](API_RelationalDatabase.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabases)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabases)
# GetRelationalDatabaseSnapshot
Returns information about a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseSnapshotName](#API_GetRelationalDatabaseSnapshot_RequestSyntax) **
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"
},
"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](#API_GetRelationalDatabaseSnapshot_ResponseSyntax) **
An object describing the specified database snapshot.
Type: [RelationalDatabaseSnapshot](API_RelationalDatabaseSnapshot.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshot)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetRelationalDatabaseSnapshots_RequestSyntax) **
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",
"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](#API_GetRelationalDatabaseSnapshots_ResponseSyntax) **
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](#API_GetRelationalDatabaseSnapshots_ResponseSyntax) **
An object describing the result of your get relational database snapshots request.
Type: Array of [RelationalDatabaseSnapshot](API_RelationalDatabaseSnapshot.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetRelationalDatabaseSnapshots)
# GetSetupHistory
Returns detailed information for five 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetSetupHistory_RequestSyntax) **
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](#API_GetSetupHistory_RequestSyntax) **
The name of the resource for which you are requesting information.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
## 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.
** [nextPageToken](#API_GetSetupHistory_ResponseSyntax) **
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](#API_GetSetupHistory_ResponseSyntax) **
The historical information that's returned.
Type: Array of [SetupHistory](API_SetupHistory.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetSetupHistory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetSetupHistory)
# GetStaticIp
Returns information about an Amazon Lightsail static IP.
## Request Syntax
```
{
"staticIpName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [staticIpName](#API_GetStaticIp_RequestSyntax) **
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"
}
}
```
## 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.
** [staticIp](#API_GetStaticIp_ResponseSyntax) **
An array of key-value pairs containing information about the requested static IP.
Type: [StaticIp](API_StaticIp.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetStaticIp)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetStaticIp)
# GetStaticIps
Returns information about all static IPs in the user's account.
## Request Syntax
```
{
"pageToken": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [pageToken](#API_GetStaticIps_RequestSyntax) **
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,
"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](#API_GetStaticIps_ResponseSyntax) **
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](#API_GetStaticIps_ResponseSyntax) **
An array of key-value pairs containing information about your get static IPs request.
Type: Array of [StaticIp](API_StaticIp.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/GetStaticIps)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/GetStaticIps)
# ImportKeyPair
Imports a public SSH key from a specific key pair.
## Request Syntax
```
{
"keyPairName": "string",
"publicKeyBase64": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [keyPairName](#API_ImportKeyPair_RequestSyntax) **
The name of the key pair for which you want to import the public key.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [publicKeyBase64](#API_ImportKeyPair_RequestSyntax) **
A base64-encoded public key of the `ssh-rsa` type.
Type: String
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](#API_ImportKeyPair_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/ImportKeyPair)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/ImportKeyPair)
# IsVpcPeered
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](#API_IsVpcPeered_ResponseSyntax) **
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 Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/IsVpcPeered)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/IsVpcPeered)
# OpenInstancePublicPorts
Opens ports for a specific Amazon Lightsail instance, and specifies 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 identified by `instanceName`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_OpenInstancePublicPorts_RequestSyntax) **
The name of the instance for which to open ports.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [portInfo](#API_OpenInstancePublicPorts_RequestSyntax) **
An object to describe the ports to open for the specified instance.
Type: [PortInfo](API_PortInfo.md) 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](#API_OpenInstancePublicPorts_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/OpenInstancePublicPorts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/OpenInstancePublicPorts)
# 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](#API_PeerVpc_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/PeerVpc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/PeerVpc)
# PutAlarm
Creates or updates an alarm, and associates it with the specified 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms).
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 configuration of the alarm. The alarm is then evaluated with the updated configuration.
The `put alarm` operation supports tag-based access control via request tags. For more information, see the [Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"alarmName": "string",
"comparisonOperator": "string",
"contactProtocols": [ "string" ],
"datapointsToAlarm": number,
"evaluationPeriods": number,
"metricName": "string",
"monitoredResourceName": "string",
"notificationEnabled": boolean,
"notificationTriggers": [ "string" ],
"tags": [
{
"key": "string",
"value": "string"
}
],
"threshold": number,
"treatMissingData": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [alarmName](#API_PutAlarm_RequestSyntax) **
The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [comparisonOperator](#API_PutAlarm_RequestSyntax) **
The arithmetic operation to use when comparing the specified statistic to the threshold. The specified statistic value is used as the first operand.
Type: String
Valid Values: `GreaterThanOrEqualToThreshold | GreaterThanThreshold | LessThanThreshold | LessThanOrEqualToThreshold`
Required: Yes
** [contactProtocols](#API_PutAlarm_RequestSyntax) **
The contact protocols to use for the alarm, such as `Email`, `SMS` (text messaging), or both.
A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.
A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the AWS Region, or if notifications are not enabled for the alarm using the `notificationEnabled` paramater.
Use the `CreateContactMethod` action to configure a contact protocol in an AWS Region.
Type: Array of strings
Valid Values: `Email | SMS`
Required: No
** [datapointsToAlarm](#API_PutAlarm_RequestSyntax) **
The number of data points that must be not within the specified 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
** [evaluationPeriods](#API_PutAlarm_RequestSyntax) **
The number of most recent periods over which data is compared to the specified 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 specifies the rolling period of time in which data points are evaluated.
Each evaluation period is five 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](#API_PutAlarm_RequestSyntax) **
The name of the metric to associate with the alarm.
You can configure 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-resource-health-metrics#available-metrics).
Type: String
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](#API_PutAlarm_RequestSyntax) **
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
** [notificationEnabled](#API_PutAlarm_RequestSyntax) **
Indicates whether the alarm is enabled.
Notifications are enabled by default if you don't specify this parameter.
Type: Boolean
Required: No
** [notificationTriggers](#API_PutAlarm_RequestSyntax) **
The alarm states that trigger a notification.
An alarm has the following possible states:
+ `ALARM` - The metric is outside of the defined threshold.
+ `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 defined threshold.
When you specify a notification trigger, the `ALARM` state must be specified. The `INSUFFICIENT_DATA` and `OK` states can be specified in addition to the `ALARM` state.
+ If you specify `OK` as an alarm trigger, a notification 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 notification.
+ If you specify `INSUFFICIENT_DATA` as the alarm trigger, a notification is sent when the alarm switches from an `OK` or `ALARM` alarm state to an `INSUFFICIENT_DATA` state.
The notification trigger defaults to `ALARM` if you don't specify this parameter.
Type: Array of strings
Valid Values: `OK | ALARM | INSUFFICIENT_DATA`
Required: No
** [tags](#API_PutAlarm_RequestSyntax) **
The tag keys and optional values to add to the alarm during create.
Use the `TagResource` action to tag a resource after it's created.
Type: Array of [Tag](API_Tag.md) objects
Required: No
** [threshold](#API_PutAlarm_RequestSyntax) **
The value against which the specified statistic is compared.
Type: Double
Required: Yes
** [treatMissingData](#API_PutAlarm_RequestSyntax) **
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.
If `treatMissingData` is not specified, 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](#API_PutAlarm_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/PutAlarm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/PutAlarm)
# PutInstancePublicPorts
Opens ports for a specific Amazon Lightsail instance, and specifies 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 `PutInstancePublicPorts`request. 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 identified by `instanceName`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_PutInstancePublicPorts_RequestSyntax) **
The name of the instance for which to open ports.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [portInfos](#API_PutInstancePublicPorts_RequestSyntax) **
An array of objects to describe the ports to open for the specified instance.
Type: Array of [PortInfo](API_PortInfo.md) 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](#API_PutInstancePublicPorts_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/PutInstancePublicPorts)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/PutInstancePublicPorts)
# RebootInstance
Restarts a specific instance.
The `reboot instance` operation supports tag-based access control via resource tags applied to the resource identified by `instance name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_RebootInstance_RequestSyntax) **
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,
"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](#API_RebootInstance_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/RebootInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/RebootInstance)
# RebootRelationalDatabase
Restarts a specific database in Amazon Lightsail.
The `reboot relational database` operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_RebootRelationalDatabase_RequestSyntax) **
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,
"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](#API_RebootRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/RebootRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/RebootRelationalDatabase)
# 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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-pushing-container-images) 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [digest](#API_RegisterContainerImage_RequestSyntax) **
The digest of the container image to be registered.
Type: String
Required: Yes
** [label](#API_RegisterContainerImage_RequestSyntax) **
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 different versions of your registered container images.
Use the `GetContainerImages` action to return the container images registered to a Lightsail container service. The label is the `` portion of the following image name example:
+ `:container-service-1..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](#API_RegisterContainerImage_RequestSyntax) **
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",
"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.
** [containerImage](#API_RegisterContainerImage_ResponseSyntax) **
An object that describes a container image that is registered to a Lightsail container service
Type: [ContainerImage](API_ContainerImage.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/RegisterContainerImage)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/RegisterContainerImage)
# ReleaseStaticIp
Deletes a specific 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [staticIpName](#API_ReleaseStaticIp_RequestSyntax) **
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",
"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](#API_ReleaseStaticIp_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/ReleaseStaticIp)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/ReleaseStaticIp)
# 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [distributionName](#API_ResetDistributionCache_RequestSyntax) **
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",
"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](#API_ResetDistributionCache_ResponseSyntax) **
The timestamp of the reset cache request (`1479734909.17`) in Unix time format.
Type: Timestamp
** [operation](#API_ResetDistributionCache_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
** [status](#API_ResetDistributionCache_ResponseSyntax) **
The status of the reset cache request.
Type: String
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/ResetDistributionCache)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/ResetDistributionCache)
# SendContactMethodVerification
Sends a verification request to an email contact method to ensure it's owned by the requester. SMS contact methods don't need to be verified.
A contact method is used to send you notifications 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 [Notifications in Amazon Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-notifications).
A verification request is sent to the contact method when you initially create it. Use this action to send another verification request if a previous verification request was deleted, or has expired.
**Important**
Notifications are not sent to an email contact method until after it is verified, and confirmed as valid.
## Request Syntax
```
{
"protocol": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [protocol](#API_SendContactMethodVerification_RequestSyntax) **
The protocol to verify, such as `Email` or `SMS` (text messaging).
Type: String
Valid Values: `Email`
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](#API_SendContactMethodVerification_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/SendContactMethodVerification)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/SendContactMethodVerification)
# SetIpAddressType
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 specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [acceptBundleUpdate](#API_SetIpAddressType_RequestSyntax) **
Required parameter to accept the instance bundle update when changing to, and from, IPv6-only.
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
** [ipAddressType](#API_SetIpAddressType_RequestSyntax) **
The IP address type to set for the specified 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](#API_SetIpAddressType_RequestSyntax) **
The name of the resource for which to set the IP address type.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [resourceType](#API_SetIpAddressType_RequestSyntax) **
The resource type.
The resource values are `Distribution`, `Instance`, and `LoadBalancer`.
Distribution-related APIs are available only in the N. Virginia (`us-east-1`) AWS Region. Set your AWS Region configuration 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 | 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](#API_SetIpAddressType_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/SetIpAddressType)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/SetIpAddressType)
# SetResourceAccessForBucket
Sets the Amazon Lightsail resources that can access the specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [access](#API_SetResourceAccessForBucket_RequestSyntax) **
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](#API_SetResourceAccessForBucket_RequestSyntax) **
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.
Pattern: `^[a-z0-9][a-z0-9-]{1,52}[a-z0-9]$`
Required: Yes
** [resourceName](#API_SetResourceAccessForBucket_RequestSyntax) **
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.
The following data is returned in JSON format by the service.
** [operations](#API_SetResourceAccessForBucket_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/SetResourceAccessForBucket)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/SetResourceAccessForBucket)
# SetupInstanceHttps
Creates an SSL/TLS certificate that secures traffic for your website. After the certificate is created, it is installed on the specified 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [certificateProvider](#API_SetupInstanceHttps_RequestSyntax) **
The certificate authority that issues the SSL/TLS certificate.
Type: String
Valid Values: `LetsEncrypt`
Required: Yes
** [domainNames](#API_SetupInstanceHttps_RequestSyntax) **
The name of the domain and subdomains that were specified for the SSL/TLS certificate.
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.
Pattern: `^[a-zA-Z0-9\-]{1,63}(\.[a-zA-Z0-9\-]{1,63}){0,8}(\.[a-zA-Z]{2,63})$`
Required: Yes
** [emailAddress](#API_SetupInstanceHttps_RequestSyntax) **
The contact method for SSL/TLS certificate 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](#API_SetupInstanceHttps_RequestSyntax) **
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",
"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](#API_SetupInstanceHttps_ResponseSyntax) **
The available API operations for `SetupInstanceHttps`.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/SetupInstanceHttps)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/SetupInstanceHttps)
# StartGUISession
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceName](#API_StartGUISession_RequestSyntax) **
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",
"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](#API_StartGUISession_ResponseSyntax) **
The available API operations.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StartGUISession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StartGUISession)
# StartInstance
Starts a specific 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](https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-create-static-ip).
The `start instance` operation supports tag-based access control via resource tags applied to the resource identified by `instance name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [instanceName](#API_StartInstance_RequestSyntax) **
The name of the instance (a virtual private server) to start.
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.
** [operations](#API_StartInstance_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StartInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StartInstance)
# StartRelationalDatabase
Starts a specific 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 identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_StartRelationalDatabase_RequestSyntax) **
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",
"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](#API_StartRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StartRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StartRelationalDatabase)
# StopGUISession
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](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceName](#API_StopGUISession_RequestSyntax) **
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",
"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](#API_StopGUISession_ResponseSyntax) **
The available API operations.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StopGUISession)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StopGUISession)
# StopInstance
Stops a specific 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](https://docs.aws.amazon.com/lightsail/latest/userguide/lightsail-create-static-ip).
The `stop instance` operation supports tag-based access control via resource tags applied to the resource identified by `instance name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"force": boolean,
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [force](#API_StopInstance_RequestSyntax) **
When set to `True`, forces a Lightsail instance that is stuck in a `stopping` state to stop.
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.
Type: Boolean
Required: No
** [instanceName](#API_StopInstance_RequestSyntax) **
The name of the instance (a virtual private server) to stop.
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.
** [operations](#API_StopInstance_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StopInstance)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StopInstance)
# StopRelationalDatabase
Stops a specific 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 identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"relationalDatabaseName": "string",
"relationalDatabaseSnapshotName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [relationalDatabaseName](#API_StopRelationalDatabase_RequestSyntax) **
The name of your database to stop.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [relationalDatabaseSnapshotName](#API_StopRelationalDatabase_RequestSyntax) **
The name of your new database snapshot to be created before stopping your database.
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](#API_StopRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/StopRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/StopRelationalDatabase)
# TagResource
Adds one or more tags to the specified Amazon Lightsail resource. Each resource can have a maximum of 50 tags. Each tag consists of a key and an optional value. Tag keys must be unique per resource. For more information about tags, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-tags).
The `tag resource` operation supports tag-based access control via request tags and resource tags applied to the resource identified by `resource name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"resourceArn": "string",
"resourceName": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceArn](#API_TagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource to which you want to add a tag.
Type: String
Pattern: `^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$`
Required: No
** [resourceName](#API_TagResource_RequestSyntax) **
The name of the resource to which you are adding tags.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tags](#API_TagResource_RequestSyntax) **
The tag key and optional value.
Type: Array of [Tag](API_Tag.md) objects
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](#API_TagResource_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/TagResource)
# TestAlarm
Tests an alarm by displaying a banner on the Amazon Lightsail console. If a notification trigger is configured for the specified alarm, the test also sends a notification to the notification protocol (`Email` and/or `SMS`) configured for the alarm.
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](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-alarms).
## Request Syntax
```
{
"alarmName": "string",
"state": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [alarmName](#API_TestAlarm_RequestSyntax) **
The name of the alarm to test.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [state](#API_TestAlarm_RequestSyntax) **
The alarm state to test.
An alarm has the following possible states that can be tested:
+ `ALARM` - The metric is outside of the defined threshold.
+ `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 defined threshold.
Type: String
Valid Values: `OK | ALARM | INSUFFICIENT_DATA`
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](#API_TestAlarm_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/TestAlarm)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/TestAlarm)
# UnpeerVpc
Unpeers the Lightsail VPC from 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](#API_UnpeerVpc_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UnpeerVpc)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UnpeerVpc)
# UntagResource
Deletes the specified set of tag keys and their values from the specified Amazon Lightsail resource.
The `untag resource` operation supports tag-based access control via request tags and resource tags applied to the resource identified by `resource name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"resourceArn": "string",
"resourceName": "string",
"tagKeys": [ "string" ]
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [resourceArn](#API_UntagResource_RequestSyntax) **
The Amazon Resource Name (ARN) of the resource from which you want to remove a tag.
Type: String
Pattern: `^arn:(aws[^:]*):([a-zA-Z0-9-]+):([a-z0-9-]+):([0-9]+):([a-zA-Z]+)/([a-zA-Z0-9-]+)$`
Required: No
** [resourceName](#API_UntagResource_RequestSyntax) **
The name of the resource from which you are removing a tag.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [tagKeys](#API_UntagResource_RequestSyntax) **
The tag keys to delete from the specified resource.
Type: Array of strings
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](#API_UntagResource_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UntagResource)
# UpdateBucket
Updates an existing Amazon Lightsail bucket.
Use this action to update the configuration of an existing bucket, such as versioning, public accessibility, and the AWS accounts that can access the bucket.
## Request Syntax
```
{
"accessLogConfig": {
"destination": "string",
"enabled": boolean,
"prefix": "string"
},
"accessRules": {
"allowPublicOverrides": boolean,
"getObject": "string"
},
"bucketName": "string",
"cors": {
"rules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposeHeaders": [ "string" ],
"id": "string",
"maxAgeSeconds": number
}
]
},
"readonlyAccessAccounts": [ "string" ],
"versioning": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [accessLogConfig](#API_UpdateBucket_RequestSyntax) **
An object that describes the access log configuration for the bucket.
Type: [BucketAccessLogConfig](API_BucketAccessLogConfig.md) object
Required: No
** [accessRules](#API_UpdateBucket_RequestSyntax) **
An object that sets the public accessibility of objects in the specified bucket.
Type: [AccessRules](API_AccessRules.md) object
Required: No
** [bucketName](#API_UpdateBucket_RequestSyntax) **
The name of the bucket to update.
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
** [cors](#API_UpdateBucket_RequestSyntax) **
Sets the cross-origin resource sharing (CORS) configuration for your bucket. If a CORS configuration exists, it is replaced with the specified configuration. For AWS CLI operations, this parameter can also be passed as a file. For more information, see [Configuring cross-origin resource sharing (CORS)](https://docs.aws.amazon.com/lightsail/latest/userguide/configure-cors.html).
CORS information is only returned in a response when you update the CORS policy.
Type: [BucketCorsConfig](API_BucketCorsConfig.md) object
Required: No
** [readonlyAccessAccounts](#API_UpdateBucket_RequestSyntax) **
An array of strings to specify the AWS account IDs that can access the bucket.
You can give a maximum of 10 AWS accounts access to a bucket.
Type: Array of strings
Array Members: Maximum number of 10 items.
Pattern: `.*\S.*`
Required: No
** [versioning](#API_UpdateBucket_RequestSyntax) **
Specifies whether to enable or suspend versioning of objects in the bucket.
The following options can be specified:
+ `Enabled` - Enables versioning of objects in the specified bucket.
+ `Suspended` - Suspends versioning of objects in the specified bucket. Existing object versions are retained.
Type: String
Pattern: `.*\S.*`
Required: No
## Response Syntax
```
{
"bucket": {
"ableToUpdateBundle": boolean,
"accessLogConfig": {
"destination": "string",
"enabled": boolean,
"prefix": "string"
},
"accessRules": {
"allowPublicOverrides": boolean,
"getObject": "string"
},
"arn": "string",
"bundleId": "string",
"cors": {
"rules": [
{
"allowedHeaders": [ "string" ],
"allowedMethods": [ "string" ],
"allowedOrigins": [ "string" ],
"exposeHeaders": [ "string" ],
"id": "string",
"maxAgeSeconds": number
}
]
},
"createdAt": number,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"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"
},
"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.
** [bucket](#API_UpdateBucket_ResponseSyntax) **
An object that describes the bucket that is updated.
Type: [Bucket](API_Bucket.md) object
** [operations](#API_UpdateBucket_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateBucket)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateBucket)
# UpdateBucketBundle
Updates the bundle, or storage plan, of an existing Amazon Lightsail bucket.
A bucket bundle specifies the monthly cost, storage space, and data transfer quota for a bucket. You can update a bucket's bundle only one time within a monthly AWS billing cycle. To determine if you can update a bucket's bundle, use the [GetBuckets](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBuckets.html) action. The `ableToUpdateBundle` parameter in the response will indicate whether you can currently update a bucket's bundle.
Update a bucket's bundle if it's consistently going over its storage space or data transfer quota, or if a bucket's usage is consistently in the lower range of its storage space or data transfer quota. Due to the unpredictable usage fluctuations that a bucket might experience, we strongly recommend that you update a bucket's bundle only as a long-term strategy, instead of as a short-term, monthly cost-cutting measure. Choose a bucket bundle that will provide the bucket with ample storage space and data transfer for a long time to come.
## Request Syntax
```
{
"bucketName": "string",
"bundleId": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [bucketName](#API_UpdateBucketBundle_RequestSyntax) **
The name of the bucket for which to update the bundle.
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
** [bundleId](#API_UpdateBucketBundle_RequestSyntax) **
The ID of the new bundle to apply to the bucket.
Use the [GetBucketBundles](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetBucketBundles.html) action to get a list of bundle IDs that you can specify.
Type: String
Pattern: `.*\S.*`
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](#API_UpdateBucketBundle_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateBucketBundle)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateBucketBundle)
# UpdateContainerService
Updates the configuration of your Amazon Lightsail container service, such as its power, scale, and public domain names.
## Request Syntax
```
{
"isDisabled": boolean,
"power": "string",
"privateRegistryAccess": {
"ecrImagePullerRole": {
"isActive": boolean
}
},
"publicDomainNames": {
"string" : [ "string" ]
},
"scale": number,
"serviceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [isDisabled](#API_UpdateContainerService_RequestSyntax) **
A Boolean value to indicate whether the container service is disabled.
Type: Boolean
Required: No
** [power](#API_UpdateContainerService_RequestSyntax) **
The power for the container service.
The power specifies the amount of memory, vCPUs, and base monthly cost of each node of the container service. The `power` and `scale` of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the `power` with the `scale` (the number of nodes) of the service.
Use the `GetContainerServicePowers` action to view the specifications of each power option.
Type: String
Valid Values: `nano | micro | small | medium | large | xlarge`
Required: No
** [privateRegistryAccess](#API_UpdateContainerService_RequestSyntax) **
An object to describe the configuration for the container service to access private container image repositories, such as Amazon Elastic Container Registry (Amazon ECR) private repositories.
For more information, see [Configuring access to an Amazon ECR private repository for an Amazon Lightsail container service](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-container-service-ecr-private-repo-access) in the *Amazon Lightsail Developer Guide*.
Type: [PrivateRegistryAccessRequest](API_PrivateRegistryAccessRequest.md) object
Required: No
** [publicDomainNames](#API_UpdateContainerService_RequestSyntax) **
The public domain names to use with the container service, such as `example.com` and `www.example.com`.
You can specify up to four public domain names for a container service. The domain names that you specify are used when you create a deployment with a container configured as the public endpoint of your container service.
If you don't specify public domain names, then you can use the default domain of the container service.
You must create and validate an SSL/TLS certificate before you can use public domain names with your container service. Use the `CreateCertificate` action to create a certificate for the public domain names you want to use with your container service.
You can specify public domain names using a string to array map as shown in the example later on this page.
Type: String to array of strings map
Required: No
** [scale](#API_UpdateContainerService_RequestSyntax) **
The scale for the container service.
The scale specifies the allocated compute nodes of the container service. The `power` and `scale` of a container service makes up its configured capacity. To determine the monthly price of your container service, multiply the base price of the `power` with the `scale` (the number of nodes) of the service.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 20.
Required: No
** [serviceName](#API_UpdateContainerService_RequestSyntax) **
The name of the container service to update.
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
```
{
"containerService": {
"arn": "string",
"containerServiceName": "string",
"createdAt": number,
"currentDeployment": {
"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
},
"isDisabled": boolean,
"location": {
"availabilityZone": "string",
"regionName": "string"
},
"nextDeployment": {
"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
},
"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 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.
** [containerService](#API_UpdateContainerService_ResponseSyntax) **
An object that describes a container service.
Type: [ContainerService](API_ContainerService.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) 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)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.
### Update container service
The following example updates an existing container service named `container-service-1` in the `us-west-2` AWS Region by adding the `example.com`, `applications.example.com`, `www.example.com`, and `containers.example.com` public domains of the `example-com` SSL/TLS certificate.
#### Sample Request
```
POST / HTTP/1.1
Host: lightsail.us-west-2.amazonaws.com
Accept-Encoding: identity
X-Amz-Target: Lightsail_20161128.UpdateContainerService
Content-Type: application/x-amz-json-1.1
User-Agent: AGENT
X-Amz-Date: 20201022T203059Z
Authorization: AUTHPARAMS
Content-Length: 192
{
"serviceName": "myservice",
"isDisabled": false,
"publicDomainNames": {
"example-com": [
"example.com",
"applications.example.com",
"www.example.com",
"containers.example.com"
]
}
}
```
#### Sample Response
```
HTTP/1.1 200 OK
Server: Server
Date: Thu, 22 Oct 2020 20:31:00 GMT
Content-Type: application/x-amz-json-1.1
Content-Length: 1178
x-amzn-RequestId: d198e00c-70c7-47e4-afa7-2EXAMPLE6f5a
Connection: keep-alive
{
"containerService": {
"arn": "arn:aws:lightsail:us-west-2:111122223333:ContainerService/1724babe-944a-4c49-887a-e7EXAMPLEe34",
"containerServiceName": "myservice",
"createdAt": 1.602859922E9,
"currentDeployment": {
"containers": {
"mystaticwebsite": {
"command": [],
"environment": {},
"image": "httpd",
"ports": {"80": "HTTP"}
}
},
"createdAt": 1.603393327E9,
"publicEndpoint": {
"containerName": "mystaticwebsite",
"containerPort": 80,
"healthCheck": {
"healthyThreshold": 2,
"intervalSeconds": 5,
"path": "/",
"successCodes": "200-499",
"timeoutSeconds": 2,
"unhealthyThreshold": 2
}
},
"state": "ACTIVE",
"version": 5
},
"isDisabled": false,
"location": {
"availabilityZone": "all",
"regionName": "us-west-2"
},
"power": "nano",
"powerId": "nano-1",
"principalArn": "arn:aws:iam::111122223333:role/amazon/lightsail/us-west-2/containers/myservice/1blaioEXAMPLEa1td8sgmnvhmoEXAMPLE8tetach1pcir6773v4g",
"privateDomainName": "myservice.service.local",
"publicDomainNames": {
"example-com": [
"example.com",
"applications.example.com",
"www.example.com",
"containers.example.com"
]
},
"resourceType": "ContainerService",
"scale": 1,
"state": "UPDATING",
"tags": [],
"url": "https://myservice.urEXAMPLE1234.us-west-2.cs.amazonlightsail.com/"
}
}
```
## See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateContainerService)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateContainerService)
# UpdateDistribution
Updates an existing Amazon Lightsail content delivery network (CDN) distribution.
Use this action to update the configuration of your existing distribution.
## Request Syntax
```
{
"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",
"defaultCacheBehavior": {
"behavior": "string"
},
"distributionName": "string",
"isEnabled": boolean,
"origin": {
"name": "string",
"protocolPolicy": "string",
"regionName": "string",
"responseTimeout": number
},
"useDefaultCertificate": boolean,
"viewerMinimumTlsProtocolVersion": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [cacheBehaviors](#API_UpdateDistribution_RequestSyntax) **
An array of objects that describe the per-path cache behavior for the distribution.
Type: Array of [CacheBehaviorPerPath](API_CacheBehaviorPerPath.md) objects
Required: No
** [cacheBehaviorSettings](#API_UpdateDistribution_RequestSyntax) **
An object that describes the cache behavior settings for the distribution.
The `cacheBehaviorSettings` specified in your `UpdateDistributionRequest` will replace your distribution's existing settings.
Type: [CacheSettings](API_CacheSettings.md) object
Required: No
** [certificateName](#API_UpdateDistribution_RequestSyntax) **
The name of the SSL/TLS certificate that you want to attach to the distribution.
Only certificates with a status of `ISSUED` can be attached to a distribution.
Use the [GetCertificates](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetCertificates.html) action to get a list of certificate names that you can specify.
Type: String
Pattern: `\w[\w\-]*\w`
Required: No
** [defaultCacheBehavior](#API_UpdateDistribution_RequestSyntax) **
An object that describes the default cache behavior for the distribution.
Type: [CacheBehavior](API_CacheBehavior.md) object
Required: No
** [distributionName](#API_UpdateDistribution_RequestSyntax) **
The name of the distribution to update.
Use the `GetDistributions` action to get a list of distribution names that you can specify.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [isEnabled](#API_UpdateDistribution_RequestSyntax) **
Indicates whether to enable the distribution.
Type: Boolean
Required: No
** [origin](#API_UpdateDistribution_RequestSyntax) **
An object that describes the origin resource for the distribution, such as a Lightsail instance, bucket, or load balancer.
The distribution pulls, caches, and serves content from the origin.
Type: [InputOrigin](API_InputOrigin.md) object
Required: No
** [useDefaultCertificate](#API_UpdateDistribution_RequestSyntax) **
Indicates whether the default SSL/TLS certificate is attached to the distribution. The default value is `true`. When `true`, the distribution uses the default domain name such as `d111111abcdef8.cloudfront.net`.
Set this value to `false` to attach a new certificate to the distribution.
Type: Boolean
Required: No
** [viewerMinimumTlsProtocolVersion](#API_UpdateDistribution_RequestSyntax) **
Use this parameter to update the minimum TLS protocol version for the SSL/TLS certificate that's attached to the distribution.
Type: String
Valid Values: `TLSv1.1_2016 | TLSv1.2_2018 | TLSv1.2_2019 | TLSv1.2_2021`
Required: No
## 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](#API_UpdateDistribution_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateDistribution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateDistribution)
# UpdateDistributionBundle
Updates the bundle of your Amazon Lightsail content delivery network (CDN) distribution.
A distribution bundle specifies the monthly network transfer quota and monthly cost of your distribution.
Update your distribution's bundle if your distribution is going over its monthly network transfer quota and is incurring an overage fee.
You can update your distribution's bundle only one time within your monthly AWS billing cycle. To determine if you can update your distribution's bundle, use the `GetDistributions` action. The `ableToUpdateBundle` parameter in the result will indicate whether you can currently update your distribution's bundle.
## Request Syntax
```
{
"bundleId": "string",
"distributionName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [bundleId](#API_UpdateDistributionBundle_RequestSyntax) **
The bundle ID of the new bundle to apply to your distribution.
Use the `GetDistributionBundles` action to get a list of distribution bundle IDs that you can specify.
Type: String
Required: No
** [distributionName](#API_UpdateDistributionBundle_RequestSyntax) **
The name of the distribution for which to update the bundle.
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",
"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](#API_UpdateDistributionBundle_ResponseSyntax) **
An object that describes the result of the action, such as the status of the request, the timestamp of the request, and the resources affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find 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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateDistributionBundle)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateDistributionBundle)
# UpdateDomainEntry
Updates a domain recordset after it is created.
The `update domain entry` operation supports tag-based access control via resource tags applied to the resource identified by `domain name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## 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](CommonParameters.md).
The request accepts the following data in JSON format.
** [domainEntry](#API_UpdateDomainEntry_RequestSyntax) **
An array of key-value pairs containing information about the domain entry.
Type: [DomainEntry](API_DomainEntry.md) object
Required: Yes
** [domainName](#API_UpdateDomainEntry_RequestSyntax) **
The name of the domain recordset to update.
Type: String
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](#API_UpdateDomainEntry_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateDomainEntry)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateDomainEntry)
# UpdateInstanceMetadataOptions
Modifies the Amazon Lightsail instance metadata parameters on a running or stopped instance. When you modify the parameters on a running instance, the `GetInstance` or `GetInstances` API operation initially responds with a state of `pending`. After the parameter modifications are successfully applied, the state changes to `applied` in subsequent `GetInstance` or `GetInstances` API calls. For more information, see [Use IMDSv2 with an Amazon Lightsail instance](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-configuring-instance-metadata-service) in the *Amazon Lightsail Developer Guide*.
## Request Syntax
```
{
"httpEndpoint": "string",
"httpProtocolIpv6": "string",
"httpPutResponseHopLimit": number,
"httpTokens": "string",
"instanceName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [httpEndpoint](#API_UpdateInstanceMetadataOptions_RequestSyntax) **
Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of `disabled`, you cannot access your instance metadata.
Type: String
Valid Values: `disabled | enabled`
Required: No
** [httpProtocolIpv6](#API_UpdateInstanceMetadataOptions_RequestSyntax) **
Enables or disables the IPv6 endpoint for the instance metadata service. This setting applies only when the HTTP metadata endpoint is enabled.
This parameter is available only for instances in the Europe (Stockholm) AWS Region (`eu-north-1`).
Type: String
Valid Values: `disabled | enabled`
Required: No
** [httpPutResponseHopLimit](#API_UpdateInstanceMetadataOptions_RequestSyntax) **
The desired HTTP PUT response hop limit for instance metadata requests. A larger number means that the instance metadata requests can travel farther. If no parameter is specified, the existing state is maintained.
Type: Integer
Required: No
** [httpTokens](#API_UpdateInstanceMetadataOptions_RequestSyntax) **
The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is `optional`.
If the state is `optional`, you can choose whether to retrieve instance metadata with a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials by using a valid signed token, the version 2.0 role credentials are returned.
If the state is `required`, you must send a signed token header with all instance metadata retrieval requests. In this state, retrieving the IAM role credential always returns the version 2.0 credentials. The version 1.0 credentials are not available.
Type: String
Valid Values: `optional | required`
Required: No
** [instanceName](#API_UpdateInstanceMetadataOptions_RequestSyntax) **
The name of the instance for which to update metadata parameters.
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](#API_UpdateInstanceMetadataOptions_ResponseSyntax) **
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 affected by the request.
Type: [Operation](API_Operation.md) object
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateInstanceMetadataOptions)
# UpdateLoadBalancerAttribute
Updates the specified attribute for a load balancer. You can only update one attribute at a time.
The `update load balancer attribute` operation supports tag-based access control via resource tags applied to the resource identified by `load balancer name`. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"attributeName": "string",
"attributeValue": "string",
"loadBalancerName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [attributeName](#API_UpdateLoadBalancerAttribute_RequestSyntax) **
The name of the attribute you want to update.
Type: String
Valid Values: `HealthCheckPath | SessionStickinessEnabled | SessionStickiness_LB_CookieDurationSeconds | HttpsRedirectionEnabled | TlsPolicyName`
Required: Yes
** [attributeValue](#API_UpdateLoadBalancerAttribute_RequestSyntax) **
The value that you want to specify for the attribute name.
The following values are supported depending on what you specify for the `attributeName` request parameter:
+ If you specify `HealthCheckPath` for the `attributeName` request parameter, then the `attributeValue` request parameter must be the path to ping on the target (for example, `/weather/us/wa/seattle`).
+ If you specify `SessionStickinessEnabled` for the `attributeName` request parameter, then the `attributeValue` request parameter must be `true` to activate session stickiness or `false` to deactivate session stickiness.
+ If you specify `SessionStickiness_LB_CookieDurationSeconds` for the `attributeName` request parameter, then the `attributeValue` request parameter must be an interger that represents the cookie duration in seconds.
+ If you specify `HttpsRedirectionEnabled` for the `attributeName` request parameter, then the `attributeValue` request parameter must be `true` to activate HTTP to HTTPS redirection or `false` to deactivate HTTP to HTTPS redirection.
+ If you specify `TlsPolicyName` for the `attributeName` request parameter, then the `attributeValue` request parameter must be the name of the TLS policy.
Use the [GetLoadBalancerTlsPolicies](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetLoadBalancerTlsPolicies.html) action to get a list of TLS policy names that you can specify.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
** [loadBalancerName](#API_UpdateLoadBalancerAttribute_RequestSyntax) **
The name of the load balancer that you want to modify (`my-load-balancer`.
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.
** [operations](#API_UpdateLoadBalancerAttribute_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateLoadBalancerAttribute)
# UpdateRelationalDatabase
Allows the update of one or more attributes of a database in Amazon Lightsail.
Updates are applied immediately, or in cases where the updates could result in an outage, are applied during the database's predefined maintenance window.
The `update relational database` operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"applyImmediately": boolean,
"caCertificateIdentifier": "string",
"disableBackupRetention": boolean,
"enableBackupRetention": boolean,
"masterUserPassword": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"publiclyAccessible": boolean,
"relationalDatabaseBlueprintId": "string",
"relationalDatabaseName": "string",
"rotateMasterUserPassword": boolean
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [applyImmediately](#API_UpdateRelationalDatabase_RequestSyntax) **
When `true`, applies changes immediately. When `false`, applies changes during the preferred maintenance window. Some changes may cause an outage.
Default: `false`
Type: Boolean
Required: No
** [caCertificateIdentifier](#API_UpdateRelationalDatabase_RequestSyntax) **
Indicates the certificate that needs to be associated with the database.
Type: String
Required: No
** [disableBackupRetention](#API_UpdateRelationalDatabase_RequestSyntax) **
When `true`, disables automated backup retention for your database.
Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database using the `create relational database snapshot` operation.
Updates are applied during the next maintenance window because this can result in an outage.
Type: Boolean
Required: No
** [enableBackupRetention](#API_UpdateRelationalDatabase_RequestSyntax) **
When `true`, enables automated backup retention for your database.
Updates are applied during the next maintenance window because this can result in an outage.
Type: Boolean
Required: No
** [masterUserPassword](#API_UpdateRelationalDatabase_RequestSyntax) **
The password for the master user. The password can include any printable ASCII character except "/", """, or "@".
My**SQL**
Constraints: Must contain from 8 to 41 characters.
**PostgreSQL**
Constraints: Must contain from 8 to 128 characters.
Type: String
Required: No
** [preferredBackupWindow](#API_UpdateRelationalDatabase_RequestSyntax) **
The daily time range during which automated backups are created for your database if automated backups are enabled.
Constraints:
+ Must be in the `hh24:mi-hh24:mi` format.
Example: `16:00-16:30`
+ Specified in Coordinated Universal Time (UTC).
+ Must not conflict with the preferred maintenance window.
+ Must be at least 30 minutes.
Type: String
Required: No
** [preferredMaintenanceWindow](#API_UpdateRelationalDatabase_RequestSyntax) **
The weekly time range during which system maintenance can occur on your 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.
+ Specified in Coordinated Universal Time (UTC).
+ Example: `Tue:17:00-Tue:17:30`
Type: String
Required: No
** [publiclyAccessible](#API_UpdateRelationalDatabase_RequestSyntax) **
Specifies the accessibility options for your database. A value of `true` specifies a database that is available to resources outside of your Lightsail account. A value of `false` specifies a database that is available only to your Lightsail resources in the same region as your database.
Type: Boolean
Required: No
** [relationalDatabaseBlueprintId](#API_UpdateRelationalDatabase_RequestSyntax) **
This parameter is used to update the major version of the database. Enter the `blueprintId` for the major version that you want to update to.
Use the [GetRelationalDatabaseBlueprints](https://docs.aws.amazon.com/lightsail/2016-11-28/api-reference/API_GetRelationalDatabaseBlueprints.html) action to get a list of available blueprint IDs.
Type: String
Required: No
** [relationalDatabaseName](#API_UpdateRelationalDatabase_RequestSyntax) **
The name of your Lightsail database resource to update.
Type: String
Pattern: `\w[\w\-]*\w`
Required: Yes
** [rotateMasterUserPassword](#API_UpdateRelationalDatabase_RequestSyntax) **
When `true`, the master user password is changed to a new strong password generated by Lightsail.
Use the `get relational database master user password` operation to get the new password.
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](#API_UpdateRelationalDatabase_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateRelationalDatabase)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateRelationalDatabase)
# UpdateRelationalDatabaseParameters
Allows the update of one or more parameters of a database in Amazon Lightsail.
Parameter updates don't cause outages; therefore, their application is not subject to the preferred maintenance window. However, there are two ways in which parameter updates are applied: `dynamic` or `pending-reboot`. Parameters marked with a `dynamic` apply type are applied immediately. Parameters marked with a `pending-reboot` apply type are applied only after the database is rebooted using the `reboot relational database` operation.
The `update relational database parameters` operation supports tag-based access control via resource tags applied to the resource identified by relationalDatabaseName. For more information, see the [Amazon Lightsail Developer Guide](https://docs.aws.amazon.com/lightsail/latest/userguide/amazon-lightsail-controlling-access-using-tags).
## Request Syntax
```
{
"parameters": [
{
"allowedValues": "string",
"applyMethod": "string",
"applyType": "string",
"dataType": "string",
"description": "string",
"isModifiable": boolean,
"parameterName": "string",
"parameterValue": "string"
}
],
"relationalDatabaseName": "string"
}
```
## Request Parameters
For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).
The request accepts the following data in JSON format.
** [parameters](#API_UpdateRelationalDatabaseParameters_RequestSyntax) **
The database parameters to update.
Type: Array of [RelationalDatabaseParameter](API_RelationalDatabaseParameter.md) objects
Required: Yes
** [relationalDatabaseName](#API_UpdateRelationalDatabaseParameters_RequestSyntax) **
The name of your database for which to update parameters.
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.
** [operations](#API_UpdateRelationalDatabaseParameters_ResponseSyntax) **
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 affected by the request.
Type: Array of [Operation](API_Operation.md) objects
## Errors
For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).
** 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 field.
Domain and distribution APIs are only available in the N. Virginia (`us-east-1`) AWS Region. Please set your AWS Region configuration to `us-east-1` to create, view, or edit these resources.
HTTP Status Code: 400
** NotFoundException **
Lightsail throws this exception when it cannot find a resource.
HTTP Status Code: 400
** OperationFailureException **
Lightsail throws this exception when an operation fails to execute.
HTTP Status Code: 400
** RegionSetupInProgressException **
Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.
** docs **
[Regions and Availability Zones for Lightsail](https://docs.aws.amazon.com/lightsail/latest/userguide/understanding-regions-and-availability-zones-in-amazon-lightsail.html)
** tip **
Opt-in Regions typically take a few minutes to finish setting up before you can work with them. Wait a few minutes and try again.
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-specific AWS SDKs, see the following:
+ [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/lightsail-2016-11-28/UpdateRelationalDatabaseParameters)