@datafire/amazonaws_lightsail NPM

@datafire/amazonaws_lightsail

Client library for Amazon Lightsail

Installation and Usage

npm install --save @datafire/amazonaws_lightsail

let amazonaws_lightsail = require('@datafire/amazonaws_lightsail').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_lightsail.AllocateStaticIp({
  "staticIpName": ""
}).then(data => {
  console.log(data);
});

Description

Actions

AllocateStaticIp

amazonaws_lightsail.AllocateStaticIp({
  "staticIpName": ""
}, context)

Input

input object
- staticIpName required ResourceName

Output

output AllocateStaticIpResult

AttachDisk

amazonaws_lightsail.AttachDisk({
  "diskName": "",
  "instanceName": "",
  "diskPath": ""
}, context)

Input

input object
- diskName required ResourceName
- diskPath required NonEmptyString
- instanceName required ResourceName

Output

output AttachDiskResult

AttachInstancesToLoadBalancer

amazonaws_lightsail.AttachInstancesToLoadBalancer({
  "loadBalancerName": "",
  "instanceNames": []
}, context)

Input

input object
- instanceNames required ResourceNameList
- loadBalancerName required ResourceName

Output

output AttachInstancesToLoadBalancerResult

AttachLoadBalancerTlsCertificate

amazonaws_lightsail.AttachLoadBalancerTlsCertificate({
  "loadBalancerName": "",
  "certificateName": ""
}, context)

Input

input object
- certificateName required ResourceName
- loadBalancerName required ResourceName

Output

output AttachLoadBalancerTlsCertificateResult

AttachStaticIp

amazonaws_lightsail.AttachStaticIp({
  "staticIpName": "",
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- staticIpName required ResourceName

Output

output AttachStaticIpResult

CloseInstancePublicPorts

amazonaws_lightsail.CloseInstancePublicPorts({
  "portInfo": {},
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- portInfo required PortInfo

Output

output CloseInstancePublicPortsResult

CreateDisk

amazonaws_lightsail.CreateDisk({
  "diskName": "",
  "availabilityZone": "",
  "sizeInGb": 0
}, context)

Input

input object
- availabilityZone required NonEmptyString
- diskName required ResourceName
- sizeInGb required integer

Output

output CreateDiskResult

CreateDiskFromSnapshot

amazonaws_lightsail.CreateDiskFromSnapshot({
  "diskName": "",
  "diskSnapshotName": "",
  "availabilityZone": "",
  "sizeInGb": 0
}, context)

Input

input object
- availabilityZone required NonEmptyString
- diskName required ResourceName
- diskSnapshotName required ResourceName
- sizeInGb required integer

Output

output CreateDiskFromSnapshotResult

CreateDiskSnapshot

amazonaws_lightsail.CreateDiskSnapshot({
  "diskName": "",
  "diskSnapshotName": ""
}, context)

Input

input object
- diskName required ResourceName
- diskSnapshotName required ResourceName

Output

output CreateDiskSnapshotResult

CreateDomain

amazonaws_lightsail.CreateDomain({
  "domainName": ""
}, context)

Input

input object
- domainName required DomainName

Output

output CreateDomainResult

CreateDomainEntry

amazonaws_lightsail.CreateDomainEntry({
  "domainName": "",
  "domainEntry": {}
}, context)

Input

input object
- domainEntry required DomainEntry
- domainName required DomainName

Output

output CreateDomainEntryResult

CreateInstanceSnapshot

amazonaws_lightsail.CreateInstanceSnapshot({
  "instanceSnapshotName": "",
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- instanceSnapshotName required ResourceName

Output

output CreateInstanceSnapshotResult

CreateInstances

amazonaws_lightsail.CreateInstances({
  "instanceNames": [],
  "availabilityZone": "",
  "blueprintId": "",
  "bundleId": ""
}, context)

Input

input object
- availabilityZone required string
- blueprintId required NonEmptyString
- bundleId required NonEmptyString
- customImageName ResourceName
- instanceNames required StringList
- keyPairName ResourceName
- userData string

Output

output CreateInstancesResult

CreateInstancesFromSnapshot

amazonaws_lightsail.CreateInstancesFromSnapshot({
  "instanceNames": [],
  "availabilityZone": "",
  "instanceSnapshotName": "",
  "bundleId": ""
}, context)

Input

input object
- attachedDiskMapping AttachedDiskMap
- availabilityZone required string
- bundleId required NonEmptyString
- instanceNames required StringList
- instanceSnapshotName required ResourceName
- keyPairName ResourceName
- userData string

Output

output CreateInstancesFromSnapshotResult

CreateKeyPair

amazonaws_lightsail.CreateKeyPair({
  "keyPairName": ""
}, context)

Input

input object
- keyPairName required ResourceName

Output

output CreateKeyPairResult

CreateLoadBalancer

amazonaws_lightsail.CreateLoadBalancer({
  "loadBalancerName": "",
  "instancePort": 0
}, context)

Input

input object
- certificateAlternativeNames DomainNameList
- certificateDomainName DomainName
- certificateName ResourceName
- healthCheckPath string
- instancePort required Port
- loadBalancerName required ResourceName

Output

output CreateLoadBalancerResult

CreateLoadBalancerTlsCertificate

amazonaws_lightsail.CreateLoadBalancerTlsCertificate({
  "loadBalancerName": "",
  "certificateName": "",
  "certificateDomainName": ""
}, context)

Input

input object
- certificateAlternativeNames DomainNameList
- certificateDomainName required DomainName
- certificateName required ResourceName
- loadBalancerName required ResourceName

Output

output CreateLoadBalancerTlsCertificateResult

DeleteDisk

amazonaws_lightsail.DeleteDisk({
  "diskName": ""
}, context)

Input

input object
- diskName required ResourceName

Output

output DeleteDiskResult

DeleteDiskSnapshot

amazonaws_lightsail.DeleteDiskSnapshot({
  "diskSnapshotName": ""
}, context)

Input

input object
- diskSnapshotName required ResourceName

Output

output DeleteDiskSnapshotResult

DeleteDomain

amazonaws_lightsail.DeleteDomain({
  "domainName": ""
}, context)

Input

input object
- domainName required DomainName

Output

output DeleteDomainResult

DeleteDomainEntry

amazonaws_lightsail.DeleteDomainEntry({
  "domainName": "",
  "domainEntry": {}
}, context)

Input

input object
- domainEntry required DomainEntry
- domainName required DomainName

Output

output DeleteDomainEntryResult

DeleteInstance

amazonaws_lightsail.DeleteInstance({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output DeleteInstanceResult

DeleteInstanceSnapshot

amazonaws_lightsail.DeleteInstanceSnapshot({
  "instanceSnapshotName": ""
}, context)

Input

input object
- instanceSnapshotName required ResourceName

Output

output DeleteInstanceSnapshotResult

DeleteKeyPair

amazonaws_lightsail.DeleteKeyPair({
  "keyPairName": ""
}, context)

Input

input object
- keyPairName required ResourceName

Output

output DeleteKeyPairResult

DeleteLoadBalancer

amazonaws_lightsail.DeleteLoadBalancer({
  "loadBalancerName": ""
}, context)

Input

input object
- loadBalancerName required ResourceName

Output

output DeleteLoadBalancerResult

DeleteLoadBalancerTlsCertificate

amazonaws_lightsail.DeleteLoadBalancerTlsCertificate({
  "loadBalancerName": "",
  "certificateName": ""
}, context)

Input

input object
- certificateName required ResourceName
- force boolean
- loadBalancerName required ResourceName

Output

output DeleteLoadBalancerTlsCertificateResult

DetachDisk

amazonaws_lightsail.DetachDisk({
  "diskName": ""
}, context)

Input

input object
- diskName required ResourceName

Output

output DetachDiskResult

DetachInstancesFromLoadBalancer

amazonaws_lightsail.DetachInstancesFromLoadBalancer({
  "loadBalancerName": "",
  "instanceNames": []
}, context)

Input

input object
- instanceNames required ResourceNameList
- loadBalancerName required ResourceName

Output

output DetachInstancesFromLoadBalancerResult

DetachStaticIp

amazonaws_lightsail.DetachStaticIp({
  "staticIpName": ""
}, context)

Input

input object
- staticIpName required ResourceName

Output

output DetachStaticIpResult

DownloadDefaultKeyPair

amazonaws_lightsail.DownloadDefaultKeyPair({}, context)

Input

input object

Output

output DownloadDefaultKeyPairResult

GetActiveNames

amazonaws_lightsail.GetActiveNames({}, context)

Input

input object
- pageToken string

Output

output GetActiveNamesResult

GetBlueprints

amazonaws_lightsail.GetBlueprints({}, context)

Input

input object
- includeInactive boolean
- pageToken string

Output

output GetBlueprintsResult

GetBundles

amazonaws_lightsail.GetBundles({}, context)

Input

input object
- includeInactive boolean
- pageToken string

Output

output GetBundlesResult

GetDisk

amazonaws_lightsail.GetDisk({
  "diskName": ""
}, context)

Input

input object
- diskName required ResourceName

Output

output GetDiskResult

GetDiskSnapshot

amazonaws_lightsail.GetDiskSnapshot({
  "diskSnapshotName": ""
}, context)

Input

input object
- diskSnapshotName required ResourceName

Output

output GetDiskSnapshotResult

GetDiskSnapshots

amazonaws_lightsail.GetDiskSnapshots({}, context)

Input

input object
- pageToken string

Output

output GetDiskSnapshotsResult

GetDisks

amazonaws_lightsail.GetDisks({}, context)

Input

input object
- pageToken string

Output

output GetDisksResult

GetDomain

amazonaws_lightsail.GetDomain({
  "domainName": ""
}, context)

Input

input object
- domainName required DomainName

Output

output GetDomainResult

GetDomains

amazonaws_lightsail.GetDomains({}, context)

Input

input object
- pageToken string

Output

output GetDomainsResult

GetInstance

amazonaws_lightsail.GetInstance({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output GetInstanceResult

GetInstanceAccessDetails

amazonaws_lightsail.GetInstanceAccessDetails({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- protocol InstanceAccessProtocol

Output

output GetInstanceAccessDetailsResult

GetInstanceMetricData

amazonaws_lightsail.GetInstanceMetricData({
  "instanceName": "",
  "metricName": "",
  "period": 0,
  "startTime": "",
  "endTime": "",
  "unit": "",
  "statistics": []
}, context)

Input

input object
- endTime required timestamp
- instanceName required ResourceName
- metricName required InstanceMetricName
- period required MetricPeriod
- startTime required timestamp
- statistics required MetricStatisticList
- unit required MetricUnit

Output

output GetInstanceMetricDataResult

GetInstancePortStates

amazonaws_lightsail.GetInstancePortStates({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output GetInstancePortStatesResult

GetInstanceSnapshot

amazonaws_lightsail.GetInstanceSnapshot({
  "instanceSnapshotName": ""
}, context)

Input

input object
- instanceSnapshotName required ResourceName

Output

output GetInstanceSnapshotResult

GetInstanceSnapshots

amazonaws_lightsail.GetInstanceSnapshots({}, context)

Input

input object
- pageToken string

Output

output GetInstanceSnapshotsResult

GetInstanceState

amazonaws_lightsail.GetInstanceState({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output GetInstanceStateResult

GetInstances

amazonaws_lightsail.GetInstances({}, context)

Input

input object
- pageToken string

Output

output GetInstancesResult

GetKeyPair

amazonaws_lightsail.GetKeyPair({
  "keyPairName": ""
}, context)

Input

input object
- keyPairName required ResourceName

Output

output GetKeyPairResult

GetKeyPairs

amazonaws_lightsail.GetKeyPairs({}, context)

Input

input object
- pageToken string

Output

output GetKeyPairsResult

GetLoadBalancer

amazonaws_lightsail.GetLoadBalancer({
  "loadBalancerName": ""
}, context)

Input

input object
- loadBalancerName required ResourceName

Output

output GetLoadBalancerResult

GetLoadBalancerMetricData

amazonaws_lightsail.GetLoadBalancerMetricData({
  "loadBalancerName": "",
  "metricName": "",
  "period": 0,
  "startTime": "",
  "endTime": "",
  "unit": "",
  "statistics": []
}, context)

Input

input object
- endTime required timestamp
- loadBalancerName required ResourceName
- metricName required LoadBalancerMetricName
- period required MetricPeriod
- startTime required timestamp
- statistics required MetricStatisticList
- unit required MetricUnit

Output

output GetLoadBalancerMetricDataResult

GetLoadBalancerTlsCertificates

amazonaws_lightsail.GetLoadBalancerTlsCertificates({
  "loadBalancerName": ""
}, context)

Input

input object
- loadBalancerName required ResourceName

Output

output GetLoadBalancerTlsCertificatesResult

GetLoadBalancers

amazonaws_lightsail.GetLoadBalancers({}, context)

Input

input object
- pageToken string

Output

output GetLoadBalancersResult

GetOperation

amazonaws_lightsail.GetOperation({
  "operationId": ""
}, context)

Input

input object
- operationId required NonEmptyString

Output

output GetOperationResult

GetOperations

amazonaws_lightsail.GetOperations({}, context)

Input

input object
- pageToken string

Output

output GetOperationsResult

GetOperationsForResource

amazonaws_lightsail.GetOperationsForResource({
  "resourceName": ""
}, context)

Input

input object
- pageToken string
- resourceName required ResourceName

Output

output GetOperationsForResourceResult

GetRegions

amazonaws_lightsail.GetRegions({}, context)

Input

input object
- includeAvailabilityZones boolean

Output

output GetRegionsResult

GetStaticIp

amazonaws_lightsail.GetStaticIp({
  "staticIpName": ""
}, context)

Input

input object
- staticIpName required ResourceName

Output

output GetStaticIpResult

GetStaticIps

amazonaws_lightsail.GetStaticIps({}, context)

Input

input object
- pageToken string

Output

output GetStaticIpsResult

ImportKeyPair

amazonaws_lightsail.ImportKeyPair({
  "keyPairName": "",
  "publicKeyBase64": ""
}, context)

Input

input object
- keyPairName required ResourceName
- publicKeyBase64 required Base64

Output

output ImportKeyPairResult

IsVpcPeered

amazonaws_lightsail.IsVpcPeered({}, context)

Input

input object

Output

output IsVpcPeeredResult

OpenInstancePublicPorts

amazonaws_lightsail.OpenInstancePublicPorts({
  "portInfo": {},
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- portInfo required PortInfo

Output

output OpenInstancePublicPortsResult

PeerVpc

amazonaws_lightsail.PeerVpc({}, context)

Input

input object

Output

output PeerVpcResult

PutInstancePublicPorts

amazonaws_lightsail.PutInstancePublicPorts({
  "portInfos": [],
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName
- portInfos required PortInfoList

Output

output PutInstancePublicPortsResult

RebootInstance

amazonaws_lightsail.RebootInstance({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output RebootInstanceResult

ReleaseStaticIp

amazonaws_lightsail.ReleaseStaticIp({
  "staticIpName": ""
}, context)

Input

input object
- staticIpName required ResourceName

Output

output ReleaseStaticIpResult

StartInstance

amazonaws_lightsail.StartInstance({
  "instanceName": ""
}, context)

Input

input object
- instanceName required ResourceName

Output

output StartInstanceResult

StopInstance

amazonaws_lightsail.StopInstance({
  "instanceName": ""
}, context)

Input

input object
- force boolean
- instanceName required ResourceName

Output

output StopInstanceResult

UnpeerVpc

amazonaws_lightsail.UnpeerVpc({}, context)

Input

input object

Output

output UnpeerVpcResult

UpdateDomainEntry

amazonaws_lightsail.UpdateDomainEntry({
  "domainName": "",
  "domainEntry": {}
}, context)

Input

input object
- domainEntry required DomainEntry
- domainName required DomainName

Output

output UpdateDomainEntryResult

UpdateLoadBalancerAttribute

amazonaws_lightsail.UpdateLoadBalancerAttribute({
  "loadBalancerName": "",
  "attributeName": "",
  "attributeValue": ""
}, context)

Input

input object
- attributeName required LoadBalancerAttributeName
- attributeValue required StringMax256
- loadBalancerName required ResourceName

Output

output UpdateLoadBalancerAttributeResult

Definitions

AccessDeniedException

AccessDeniedException object: Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
- code string
- docs string
- message string
- tip string

AccessDirection

AccessDirection string (values: inbound, outbound)

AccountSetupInProgressException

AccountSetupInProgressException object: Lightsail throws this exception when an account is still in the setup in progress state.
- code string
- docs string
- message string
- tip string

AllocateStaticIpRequest

AllocateStaticIpRequest object
- staticIpName required ResourceName

AllocateStaticIpResult

AllocateStaticIpResult object
- operations OperationList

AttachDiskRequest

AttachDiskRequest object
- diskName required ResourceName
- diskPath required NonEmptyString
- instanceName required ResourceName

AttachDiskResult

AttachDiskResult object
- operations OperationList

AttachInstancesToLoadBalancerRequest

AttachInstancesToLoadBalancerRequest object
- instanceNames required ResourceNameList
- loadBalancerName required ResourceName

AttachInstancesToLoadBalancerResult

AttachInstancesToLoadBalancerResult object
- operations OperationList

AttachLoadBalancerTlsCertificateRequest

AttachLoadBalancerTlsCertificateRequest object
- certificateName required ResourceName
- loadBalancerName required ResourceName

AttachLoadBalancerTlsCertificateResult

AttachLoadBalancerTlsCertificateResult object
- operations OperationList

AttachStaticIpRequest

AttachStaticIpRequest object
- instanceName required ResourceName
- staticIpName required ResourceName

AttachStaticIpResult

AttachStaticIpResult object
- operations OperationList

AttachedDiskMap

AttachedDiskMap array
- items object
  - key ResourceName
  - value DiskMapList

AvailabilityZone

AvailabilityZone object: Describes an Availability Zone.
- state NonEmptyString
- zoneName NonEmptyString

AvailabilityZoneList

AvailabilityZoneList array
- items AvailabilityZone

Base64

Base64 string

Blueprint

Blueprint object: Describes a blueprint (a virtual private server image).
- blueprintId NonEmptyString
- description string
- group NonEmptyString
- isActive boolean
- licenseUrl string
- minPower integer
- name ResourceName
- platform InstancePlatform
- productUrl string
- type BlueprintType
- version string
- versionCode string

BlueprintList

BlueprintList array
- items Blueprint

BlueprintType

BlueprintType string (values: os, app)

Bundle

Bundle object: Describes a bundle, which is a set of specs describing your virtual private server (or instance).
- bundleId NonEmptyString
- cpuCount integer
- diskSizeInGb integer
- instanceType string
- isActive boolean
- name string
- power integer
- price float
- ramSizeInGb float
- supportedPlatforms InstancePlatformList
- transferPerMonthInGb integer

BundleList

BundleList array
- items Bundle

CloseInstancePublicPortsRequest

CloseInstancePublicPortsRequest object
- instanceName required ResourceName
- portInfo required PortInfo

CloseInstancePublicPortsResult

CloseInstancePublicPortsResult object
- operation Operation

CreateDiskFromSnapshotRequest

CreateDiskFromSnapshotRequest object
- availabilityZone required NonEmptyString
- diskName required ResourceName
- diskSnapshotName required ResourceName
- sizeInGb required integer

CreateDiskFromSnapshotResult

CreateDiskFromSnapshotResult object
- operations OperationList

CreateDiskRequest

CreateDiskRequest object
- availabilityZone required NonEmptyString
- diskName required ResourceName
- sizeInGb required integer

CreateDiskResult

CreateDiskResult object
- operations OperationList

CreateDiskSnapshotRequest

CreateDiskSnapshotRequest object
- diskName required ResourceName
- diskSnapshotName required ResourceName

CreateDiskSnapshotResult

CreateDiskSnapshotResult object
- operations OperationList

CreateDomainEntryRequest

CreateDomainEntryRequest object
- domainEntry required DomainEntry
- domainName required DomainName

CreateDomainEntryResult

CreateDomainEntryResult object
- operation Operation

CreateDomainRequest

CreateDomainRequest object
- domainName required DomainName

CreateDomainResult

CreateDomainResult object
- operation Operation

CreateInstanceSnapshotRequest

CreateInstanceSnapshotRequest object
- instanceName required ResourceName
- instanceSnapshotName required ResourceName

CreateInstanceSnapshotResult

CreateInstanceSnapshotResult object
- operations OperationList

CreateInstancesFromSnapshotRequest

CreateInstancesFromSnapshotRequest object
- attachedDiskMapping AttachedDiskMap
- availabilityZone required string
- bundleId required NonEmptyString
- instanceNames required StringList
- instanceSnapshotName required ResourceName
- keyPairName ResourceName
- userData string

CreateInstancesFromSnapshotResult

CreateInstancesFromSnapshotResult object
- operations OperationList

CreateInstancesRequest

CreateInstancesRequest object
- availabilityZone required string
- blueprintId required NonEmptyString
- bundleId required NonEmptyString
- customImageName ResourceName
- instanceNames required StringList
- keyPairName ResourceName
- userData string

CreateInstancesResult

CreateInstancesResult object
- operations OperationList

CreateKeyPairRequest

CreateKeyPairRequest object
- keyPairName required ResourceName

CreateKeyPairResult

CreateKeyPairResult object
- keyPair KeyPair
- operation Operation
- privateKeyBase64 Base64
- publicKeyBase64 Base64

CreateLoadBalancerRequest

CreateLoadBalancerRequest object
- certificateAlternativeNames DomainNameList
- certificateDomainName DomainName
- certificateName ResourceName
- healthCheckPath string
- instancePort required Port
- loadBalancerName required ResourceName

CreateLoadBalancerResult

CreateLoadBalancerResult object
- operations OperationList

CreateLoadBalancerTlsCertificateRequest

CreateLoadBalancerTlsCertificateRequest object
- certificateAlternativeNames DomainNameList
- certificateDomainName required DomainName
- certificateName required ResourceName
- loadBalancerName required ResourceName

CreateLoadBalancerTlsCertificateResult

CreateLoadBalancerTlsCertificateResult object
- operations OperationList

DeleteDiskRequest

DeleteDiskRequest object
- diskName required ResourceName

DeleteDiskResult

DeleteDiskResult object
- operations OperationList

DeleteDiskSnapshotRequest

DeleteDiskSnapshotRequest object
- diskSnapshotName required ResourceName

DeleteDiskSnapshotResult

DeleteDiskSnapshotResult object
- operations OperationList

DeleteDomainEntryRequest

DeleteDomainEntryRequest object
- domainEntry required DomainEntry
- domainName required DomainName

DeleteDomainEntryResult

DeleteDomainEntryResult object
- operation Operation

DeleteDomainRequest

DeleteDomainRequest object
- domainName required DomainName

DeleteDomainResult

DeleteDomainResult object
- operation Operation

DeleteInstanceRequest

DeleteInstanceRequest object
- instanceName required ResourceName

DeleteInstanceResult

DeleteInstanceResult object
- operations OperationList

DeleteInstanceSnapshotRequest

DeleteInstanceSnapshotRequest object
- instanceSnapshotName required ResourceName

DeleteInstanceSnapshotResult

DeleteInstanceSnapshotResult object
- operations OperationList

DeleteKeyPairRequest

DeleteKeyPairRequest object
- keyPairName required ResourceName

DeleteKeyPairResult

DeleteKeyPairResult object
- operation Operation

DeleteLoadBalancerRequest

DeleteLoadBalancerRequest object
- loadBalancerName required ResourceName

DeleteLoadBalancerResult

DeleteLoadBalancerResult object
- operations OperationList

DeleteLoadBalancerTlsCertificateRequest

DeleteLoadBalancerTlsCertificateRequest object
- certificateName required ResourceName
- force boolean
- loadBalancerName required ResourceName

DeleteLoadBalancerTlsCertificateResult

DeleteLoadBalancerTlsCertificateResult object
- operations OperationList

DetachDiskRequest

DetachDiskRequest object
- diskName required ResourceName

DetachDiskResult

DetachDiskResult object
- operations OperationList

DetachInstancesFromLoadBalancerRequest

DetachInstancesFromLoadBalancerRequest object
- instanceNames required ResourceNameList
- loadBalancerName required ResourceName

DetachInstancesFromLoadBalancerResult

DetachInstancesFromLoadBalancerResult object
- operations OperationList

DetachStaticIpRequest

DetachStaticIpRequest object
- staticIpName required ResourceName

DetachStaticIpResult

DetachStaticIpResult object
- operations OperationList

Disk

Disk object: Describes a system disk or an block storage disk.
- arn NonEmptyString
- attachedTo ResourceName
- attachmentState string
- createdAt IsoDate
- gbInUse integer
- iops integer
- isAttached boolean
- isSystemDisk boolean
- location ResourceLocation
- name ResourceName
- path string
- resourceType ResourceType
- sizeInGb integer
- state DiskState
- supportCode string

DiskList

DiskList array
- items Disk

DiskMap

DiskMap object: Describes a block storage disk mapping.
- newDiskName ResourceName
- originalDiskPath NonEmptyString

DiskMapList

DiskMapList array
- items DiskMap

DiskSnapshot

DiskSnapshot object: Describes a block storage disk snapshot.
- arn NonEmptyString
- createdAt IsoDate
- fromDiskArn NonEmptyString
- fromDiskName ResourceName
- location ResourceLocation
- name ResourceName
- progress string
- resourceType ResourceType
- sizeInGb integer
- state DiskSnapshotState
- supportCode string

DiskSnapshotList

DiskSnapshotList array
- items DiskSnapshot

DiskSnapshotState

DiskSnapshotState string (values: pending, completed, error, unknown)

DiskState

DiskState string (values: pending, error, available, in-use, unknown)

Domain

Domain object: Describes a domain where you are storing recordsets in Lightsail.
- arn NonEmptyString
- createdAt IsoDate
- domainEntries DomainEntryList
- location ResourceLocation
- name ResourceName
- resourceType ResourceType
- supportCode string

DomainEntry

DomainEntry object: Describes a domain recordset entry.
- id NonEmptyString
- isAlias boolean
- name DomainName
- options DomainEntryOptions
- target string
- type DomainEntryType

DomainEntryList

DomainEntryList array
- items DomainEntry

DomainEntryOptions

DomainEntryOptions array
- items object
  - key DomainEntryOptionsKeys
  - value string

DomainEntryOptionsKeys

DomainEntryOptionsKeys string

DomainEntryType

DomainEntryType string

DomainList

DomainList array
- items Domain

DomainName

DomainName string

DomainNameList

DomainNameList array
- items DomainName

DownloadDefaultKeyPairRequest

DownloadDefaultKeyPairRequest object

DownloadDefaultKeyPairResult

DownloadDefaultKeyPairResult object
- privateKeyBase64 Base64
- publicKeyBase64 Base64

GetActiveNamesRequest

GetActiveNamesRequest object
- pageToken string

GetActiveNamesResult

GetActiveNamesResult object
- activeNames StringList
- nextPageToken string

GetBlueprintsRequest

GetBlueprintsRequest object
- includeInactive boolean
- pageToken string

GetBlueprintsResult

GetBlueprintsResult object
- blueprints BlueprintList
- nextPageToken string

GetBundlesRequest

GetBundlesRequest object
- includeInactive boolean
- pageToken string

GetBundlesResult

GetBundlesResult object
- bundles BundleList
- nextPageToken string

GetDiskRequest

GetDiskRequest object
- diskName required ResourceName

GetDiskResult

GetDiskResult object
- disk Disk

GetDiskSnapshotRequest

GetDiskSnapshotRequest object
- diskSnapshotName required ResourceName

GetDiskSnapshotResult

GetDiskSnapshotResult object
- diskSnapshot DiskSnapshot

GetDiskSnapshotsRequest

GetDiskSnapshotsRequest object
- pageToken string

GetDiskSnapshotsResult

GetDiskSnapshotsResult object
- diskSnapshots DiskSnapshotList
- nextPageToken string

GetDisksRequest

GetDisksRequest object
- pageToken string

GetDisksResult

GetDisksResult object
- disks DiskList
- nextPageToken string

GetDomainRequest

GetDomainRequest object
- domainName required DomainName

GetDomainResult

GetDomainResult object
- domain Domain

GetDomainsRequest

GetDomainsRequest object
- pageToken string

GetDomainsResult

GetDomainsResult object
- domains DomainList
- nextPageToken string

GetInstanceAccessDetailsRequest

GetInstanceAccessDetailsRequest object
- instanceName required ResourceName
- protocol InstanceAccessProtocol

GetInstanceAccessDetailsResult

GetInstanceAccessDetailsResult object
- accessDetails InstanceAccessDetails

GetInstanceMetricDataRequest

GetInstanceMetricDataRequest object
- endTime required timestamp
- instanceName required ResourceName
- metricName required InstanceMetricName
- period required MetricPeriod
- startTime required timestamp
- statistics required MetricStatisticList
- unit required MetricUnit

GetInstanceMetricDataResult

GetInstanceMetricDataResult object
- metricData MetricDatapointList
- metricName InstanceMetricName

GetInstancePortStatesRequest

GetInstancePortStatesRequest object
- instanceName required ResourceName

GetInstancePortStatesResult

GetInstancePortStatesResult object
- portStates InstancePortStateList

GetInstanceRequest

GetInstanceRequest object
- instanceName required ResourceName

GetInstanceResult

GetInstanceResult object
- instance Instance

GetInstanceSnapshotRequest

GetInstanceSnapshotRequest object
- instanceSnapshotName required ResourceName

GetInstanceSnapshotResult

GetInstanceSnapshotResult object
- instanceSnapshot InstanceSnapshot

GetInstanceSnapshotsRequest

GetInstanceSnapshotsRequest object
- pageToken string

GetInstanceSnapshotsResult

GetInstanceSnapshotsResult object
- instanceSnapshots InstanceSnapshotList
- nextPageToken string

GetInstanceStateRequest

GetInstanceStateRequest object
- instanceName required ResourceName

GetInstanceStateResult

GetInstanceStateResult object
- state InstanceState

GetInstancesRequest

GetInstancesRequest object
- pageToken string

GetInstancesResult

GetInstancesResult object
- instances InstanceList
- nextPageToken string

GetKeyPairRequest

GetKeyPairRequest object
- keyPairName required ResourceName

GetKeyPairResult

GetKeyPairResult object
- keyPair KeyPair

GetKeyPairsRequest

GetKeyPairsRequest object
- pageToken string

GetKeyPairsResult

GetKeyPairsResult object
- keyPairs KeyPairList
- nextPageToken string

GetLoadBalancerMetricDataRequest

GetLoadBalancerMetricDataRequest object
- endTime required timestamp
- loadBalancerName required ResourceName
- metricName required LoadBalancerMetricName
- period required MetricPeriod
- startTime required timestamp
- statistics required MetricStatisticList
- unit required MetricUnit

GetLoadBalancerMetricDataResult

GetLoadBalancerMetricDataResult object
- metricData MetricDatapointList
- metricName LoadBalancerMetricName

GetLoadBalancerRequest

GetLoadBalancerRequest object
- loadBalancerName required ResourceName

GetLoadBalancerResult

GetLoadBalancerResult object
- loadBalancer LoadBalancer

GetLoadBalancerTlsCertificatesRequest

GetLoadBalancerTlsCertificatesRequest object
- loadBalancerName required ResourceName

GetLoadBalancerTlsCertificatesResult

GetLoadBalancerTlsCertificatesResult object
- tlsCertificates LoadBalancerTlsCertificateList

GetLoadBalancersRequest

GetLoadBalancersRequest object
- pageToken string

GetLoadBalancersResult

GetLoadBalancersResult object
- loadBalancers LoadBalancerList
- nextPageToken string

GetOperationRequest

GetOperationRequest object
- operationId required NonEmptyString

GetOperationResult

GetOperationResult object
- operation Operation

GetOperationsForResourceRequest

GetOperationsForResourceRequest object
- pageToken string
- resourceName required ResourceName

GetOperationsForResourceResult

GetOperationsForResourceResult object
- nextPageCount string
- nextPageToken string
- operations OperationList

GetOperationsRequest

GetOperationsRequest object
- pageToken string

GetOperationsResult

GetOperationsResult object
- nextPageToken string
- operations OperationList

GetRegionsRequest

GetRegionsRequest object
- includeAvailabilityZones boolean

GetRegionsResult

GetRegionsResult object
- regions RegionList

GetStaticIpRequest

GetStaticIpRequest object
- staticIpName required ResourceName

GetStaticIpResult

GetStaticIpResult object
- staticIp StaticIp

GetStaticIpsRequest

GetStaticIpsRequest object
- pageToken string

GetStaticIpsResult

GetStaticIpsResult object
- nextPageToken string
- staticIps StaticIpList

ImportKeyPairRequest

ImportKeyPairRequest object
- keyPairName required ResourceName
- publicKeyBase64 required Base64

ImportKeyPairResult

ImportKeyPairResult object
- operation Operation

Instance

Instance object: Describes an instance (a virtual private server).
- arn NonEmptyString
- blueprintId NonEmptyString
- blueprintName NonEmptyString
- bundleId NonEmptyString
- createdAt IsoDate
- hardware InstanceHardware
- ipv6Address IpV6Address
- isStaticIp boolean
- location ResourceLocation
- name ResourceName
- networking InstanceNetworking
- privateIpAddress IpAddress
- publicIpAddress IpAddress
- resourceType ResourceType
- sshKeyName ResourceName
- state InstanceState
- supportCode string
- username NonEmptyString

InstanceAccessDetails

InstanceAccessDetails object: The parameters for gaining temporary access to one of your Amazon Lightsail instances.
- certKey string
- expiresAt IsoDate
- instanceName ResourceName
- ipAddress IpAddress
- password string
- passwordData PasswordData
- privateKey string
- protocol InstanceAccessProtocol
- username string

InstanceAccessProtocol

InstanceAccessProtocol string (values: ssh, rdp)

InstanceHardware

InstanceHardware object: Describes the hardware for the instance.
- cpuCount integer
- disks DiskList
- ramSizeInGb float

InstanceHealthReason

InstanceHealthReason string (values: Lb.RegistrationInProgress, Lb.InitialHealthChecking, Lb.InternalError, Instance.ResponseCodeMismatch, Instance.Timeout, Instance.FailedHealthChecks, Instance.NotRegistered, Instance.NotInUse, Instance.DeregistrationInProgress, Instance.InvalidState, Instance.IpUnusable)

InstanceHealthState

InstanceHealthState string (values: initial, healthy, unhealthy, unused, draining, unavailable)

InstanceHealthSummary

InstanceHealthSummary object: Describes information about the health of the instance.
- instanceHealth InstanceHealthState
- instanceHealthReason InstanceHealthReason
- instanceName ResourceName

InstanceHealthSummaryList

InstanceHealthSummaryList array
- items InstanceHealthSummary

InstanceList

InstanceList array
- items Instance

InstanceMetricName

InstanceMetricName string (values: CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, StatusCheckFailed_System)

InstanceNetworking

InstanceNetworking object: Describes monthly data transfer rates and port information for an instance.
- monthlyTransfer MonthlyTransfer
- ports InstancePortInfoList

InstancePlatform

InstancePlatform string (values: LINUX_UNIX, WINDOWS)

InstancePlatformList

InstancePlatformList array
- items InstancePlatform

InstancePortInfo

InstancePortInfo object: Describes information about the instance ports.
- accessDirection AccessDirection
- accessFrom string
- accessType PortAccessType
- commonName string
- fromPort Port
- protocol NetworkProtocol
- toPort Port

InstancePortInfoList

InstancePortInfoList array
- items InstancePortInfo

InstancePortState

InstancePortState object: Describes the port state.
- fromPort Port
- protocol NetworkProtocol
- state PortState
- toPort Port

InstancePortStateList

InstancePortStateList array
- items InstancePortState

InstanceSnapshot

InstanceSnapshot object: Describes the snapshot of the virtual private server, or instance.
- arn NonEmptyString
- createdAt IsoDate
- fromAttachedDisks DiskList
- fromBlueprintId string
- fromBundleId string
- fromInstanceArn NonEmptyString
- fromInstanceName ResourceName
- location ResourceLocation
- name ResourceName
- progress string
- resourceType ResourceType
- sizeInGb integer
- state InstanceSnapshotState
- supportCode string

InstanceSnapshotList

InstanceSnapshotList array
- items InstanceSnapshot

InstanceSnapshotState

InstanceSnapshotState string (values: pending, error, available)

InstanceState

InstanceState object: Describes the virtual private server (or instance) status.
- code integer
- name string

InvalidInputException

InvalidInputException object: Lightsail throws this exception when user input does not conform to the validation rules of an input field. Domain-related APIs are only available in the N. Virginia (us-east-1) Region. Please set your Region configuration to us-east-1 to create, view, or edit these resources.
- code string
- docs string
- message string
- tip string

IpAddress

IpAddress string

IpV6Address

IpV6Address string

IsVpcPeeredRequest

IsVpcPeeredRequest object

IsVpcPeeredResult

IsVpcPeeredResult object
- isPeered boolean

IsoDate

IsoDate string

KeyPair

KeyPair object: Describes the SSH key pair.
- arn NonEmptyString
- createdAt IsoDate
- fingerprint Base64
- location ResourceLocation
- name ResourceName
- resourceType ResourceType
- supportCode string

KeyPairList

KeyPairList array
- items KeyPair

LoadBalancer

LoadBalancer object: Describes the Lightsail load balancer.
- arn NonEmptyString
- configurationOptions LoadBalancerConfigurationOptions
- createdAt IsoDate
- dnsName NonEmptyString
- healthCheckPath NonEmptyString
- instanceHealthSummary InstanceHealthSummaryList
- instancePort integer
- location ResourceLocation
- name ResourceName
- protocol LoadBalancerProtocol
- publicPorts PortList
- resourceType ResourceType
- state LoadBalancerState
- supportCode string
- tlsCertificateSummaries LoadBalancerTlsCertificateSummaryList

LoadBalancerAttributeName

LoadBalancerAttributeName string (values: HealthCheckPath, SessionStickinessEnabled, SessionStickiness_LB_CookieDurationSeconds)

LoadBalancerConfigurationOptions

LoadBalancerConfigurationOptions array
- items object
  - key LoadBalancerAttributeName
  - value string

LoadBalancerList

LoadBalancerList array
- items LoadBalancer

LoadBalancerMetricName

LoadBalancerMetricName string (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)

LoadBalancerProtocol

LoadBalancerProtocol string (values: HTTP_HTTPS, HTTP)

LoadBalancerState

LoadBalancerState string (values: active, provisioning, active_impaired, failed, unknown)

LoadBalancerTlsCertificate

LoadBalancerTlsCertificate object: Describes a load balancer TLS/SSL certificate. TLS is just an updated, more secure version of Secure Socket Layer (SSL).
- arn NonEmptyString
- createdAt IsoDate
- domainName DomainName
- domainValidationRecords LoadBalancerTlsCertificateDomainValidationRecordList
- failureReason LoadBalancerTlsCertificateFailureReason
- isAttached boolean
- issuedAt IsoDate
- issuer NonEmptyString
- keyAlgorithm NonEmptyString
- loadBalancerName ResourceName
- location ResourceLocation
- name ResourceName
- notAfter IsoDate
- notBefore IsoDate
- renewalSummary LoadBalancerTlsCertificateRenewalSummary
- resourceType ResourceType
- revocationReason LoadBalancerTlsCertificateRevocationReason
- revokedAt IsoDate
- serial NonEmptyString
- signatureAlgorithm NonEmptyString
- status LoadBalancerTlsCertificateStatus
- subject NonEmptyString
- subjectAlternativeNames StringList
- supportCode string

LoadBalancerTlsCertificateDomainStatus

LoadBalancerTlsCertificateDomainStatus string (values: PENDING_VALIDATION, FAILED, SUCCESS)

LoadBalancerTlsCertificateDomainValidationOption

LoadBalancerTlsCertificateDomainValidationOption object: Contains information about the domain names on a TLS/SSL certificate that you will use to validate domain ownership.
- domainName DomainName
- validationStatus LoadBalancerTlsCertificateDomainStatus

LoadBalancerTlsCertificateDomainValidationOptionList

LoadBalancerTlsCertificateDomainValidationOptionList array
- items LoadBalancerTlsCertificateDomainValidationOption

LoadBalancerTlsCertificateDomainValidationRecord

LoadBalancerTlsCertificateDomainValidationRecord object: Describes the validation record of each domain name in the TLS/SSL certificate.
- domainName DomainName
- name NonEmptyString
- type NonEmptyString
- validationStatus LoadBalancerTlsCertificateDomainStatus
- value NonEmptyString

LoadBalancerTlsCertificateDomainValidationRecordList

LoadBalancerTlsCertificateDomainValidationRecordList array
- items LoadBalancerTlsCertificateDomainValidationRecord

LoadBalancerTlsCertificateFailureReason

LoadBalancerTlsCertificateFailureReason string (values: NO_AVAILABLE_CONTACTS, ADDITIONAL_VERIFICATION_REQUIRED, DOMAIN_NOT_ALLOWED, INVALID_PUBLIC_DOMAIN, OTHER)

LoadBalancerTlsCertificateList

LoadBalancerTlsCertificateList array
- items LoadBalancerTlsCertificate

LoadBalancerTlsCertificateRenewalStatus

LoadBalancerTlsCertificateRenewalStatus string (values: PENDING_AUTO_RENEWAL, PENDING_VALIDATION, SUCCESS, FAILED)

LoadBalancerTlsCertificateRenewalSummary

LoadBalancerTlsCertificateRenewalSummary object: Contains information about the status of Lightsail's managed renewal for the certificate.
- domainValidationOptions LoadBalancerTlsCertificateDomainValidationOptionList
- renewalStatus LoadBalancerTlsCertificateRenewalStatus

LoadBalancerTlsCertificateRevocationReason

LoadBalancerTlsCertificateRevocationReason string (values: UNSPECIFIED, KEY_COMPROMISE, CA_COMPROMISE, AFFILIATION_CHANGED, SUPERCEDED, CESSATION_OF_OPERATION, CERTIFICATE_HOLD, REMOVE_FROM_CRL, PRIVILEGE_WITHDRAWN, A_A_COMPROMISE)

LoadBalancerTlsCertificateStatus

LoadBalancerTlsCertificateStatus string (values: PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED, UNKNOWN)

LoadBalancerTlsCertificateSummary

LoadBalancerTlsCertificateSummary object: Provides a summary of TLS/SSL certificate metadata.
- isAttached boolean
- name ResourceName

LoadBalancerTlsCertificateSummaryList

LoadBalancerTlsCertificateSummaryList array
- items LoadBalancerTlsCertificateSummary

MetricDatapoint

MetricDatapoint object: Describes the metric data point.
- average double
- maximum double
- minimum double
- sampleCount double
- sum double
- timestamp timestamp
- unit MetricUnit

MetricDatapointList

MetricDatapointList array
- items MetricDatapoint

MetricPeriod

MetricPeriod integer

MetricStatistic

MetricStatistic string (values: Minimum, Maximum, Sum, Average, SampleCount)

MetricStatisticList

MetricStatisticList array
- items MetricStatistic

MetricUnit

MetricUnit string (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)

MonthlyTransfer

MonthlyTransfer object: Describes the monthly data transfer in and out of your virtual private server (or instance).
- gbPerMonthAllocated integer

NetworkProtocol

NetworkProtocol string (values: tcp, all, udp)

NonEmptyString

NonEmptyString string

NotFoundException

NotFoundException object: Lightsail throws this exception when it cannot find a resource.
- code string
- docs string
- message string
- tip string

OpenInstancePublicPortsRequest

OpenInstancePublicPortsRequest object
- instanceName required ResourceName
- portInfo required PortInfo

OpenInstancePublicPortsResult

OpenInstancePublicPortsResult object
- operation Operation

Operation

Operation object: Describes the API operation.
- createdAt IsoDate
- errorCode string
- errorDetails string
- id NonEmptyString
- isTerminal boolean
- location ResourceLocation
- operationDetails string
- operationType OperationType
- resourceName ResourceName
- resourceType ResourceType
- status OperationStatus
- statusChangedAt IsoDate

OperationFailureException

OperationFailureException object: Lightsail throws this exception when an operation fails to execute.
- code string
- docs string
- message string
- tip string

OperationList

OperationList array
- items Operation

OperationStatus

OperationStatus string (values: NotStarted, Started, Failed, Completed)

OperationType

OperationType string (values: DeleteInstance, CreateInstance, StopInstance, StartInstance, RebootInstance, OpenInstancePublicPorts, PutInstancePublicPorts, CloseInstancePublicPorts, AllocateStaticIp, ReleaseStaticIp, AttachStaticIp, DetachStaticIp, UpdateDomainEntry, DeleteDomainEntry, CreateDomain, DeleteDomain, CreateInstanceSnapshot, DeleteInstanceSnapshot, CreateInstancesFromSnapshot, CreateLoadBalancer, DeleteLoadBalancer, AttachInstancesToLoadBalancer, DetachInstancesFromLoadBalancer, UpdateLoadBalancerAttribute, CreateLoadBalancerTlsCertificate, DeleteLoadBalancerTlsCertificate, AttachLoadBalancerTlsCertificate, CreateDisk, DeleteDisk, AttachDisk, DetachDisk, CreateDiskSnapshot, DeleteDiskSnapshot, CreateDiskFromSnapshot)

PasswordData

PasswordData object: The password data for the Windows Server-based instance, including the ciphertext and the key pair name.
- ciphertext string
- keyPairName ResourceName

PeerVpcRequest

PeerVpcRequest object

PeerVpcResult

PeerVpcResult object
- operation Operation

Port

Port integer

PortAccessType

PortAccessType string (values: Public, Private)

PortInfo

PortInfo object: Describes information about the ports on your virtual private server (or instance).
- fromPort Port
- protocol NetworkProtocol
- toPort Port

PortInfoList

PortInfoList array
- items PortInfo

PortList

PortList array
- items Port

PortState

PortState string (values: open, closed)

PutInstancePublicPortsRequest

PutInstancePublicPortsRequest object
- instanceName required ResourceName
- portInfos required PortInfoList

PutInstancePublicPortsResult

PutInstancePublicPortsResult object
- operation Operation

RebootInstanceRequest

RebootInstanceRequest object
- instanceName required ResourceName

RebootInstanceResult

RebootInstanceResult object
- operations OperationList

Region

Region object: Describes the AWS Region.
- availabilityZones AvailabilityZoneList
- continentCode string
- description string
- displayName string
- name RegionName

RegionList

RegionList array
- items Region

RegionName

RegionName string (values: us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-central-1, ap-south-1, ap-southeast-1, ap-southeast-2, ap-northeast-1, ap-northeast-2)