AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Classes

NameDescription
Class AccessDeniedException

Lightsail exception

Class AccountSetupInProgressException

Lightsail exception

Class AllocateStaticIpRequest

Container for the parameters to the AllocateStaticIp operation. Allocates a static IP address.

Class AllocateStaticIpResponse

This is the response object from the AllocateStaticIp operation.

Class AttachDiskRequest

Container for the parameters to the AttachDisk operation. Attaches a block storage disk to a running or stopped Lightsail instance and exposes it to the instance with the specified disk name.

Class AttachDiskResponse

This is the response object from the AttachDisk operation.

Class AttachInstancesToLoadBalancerRequest

Container for the parameters to the AttachInstancesToLoadBalancer operation. Attaches one or more Lightsail instances to a load balancer.

Class AttachInstancesToLoadBalancerResponse

This is the response object from the AttachInstancesToLoadBalancer operation.

Class AttachLoadBalancerTlsCertificateRequest

Container for the parameters to the AttachLoadBalancerTlsCertificate operation. Attaches a Transport Layer Security (TLS) certificate to your load balancer.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Class AttachLoadBalancerTlsCertificateResponse

This is the response object from the AttachLoadBalancerTlsCertificate operation.

Class AttachStaticIpRequest

Container for the parameters to the AttachStaticIp operation. Attaches a static IP address to a specific Amazon Lightsail instance.

Class AttachStaticIpResponse

This is the response object from the AttachStaticIp operation.

Class AvailabilityZone

Describes an Availability Zone.

Class Blueprint

Describes a blueprint (a virtual private server image).

Class Bundle

Describes a bundle, which is a set of specs describing your virtual private server (or instance).

Class CloseInstancePublicPortsRequest

Container for the parameters to the CloseInstancePublicPorts operation. Closes the public ports on a specific Amazon Lightsail instance.

Class CloseInstancePublicPortsResponse

This is the response object from the CloseInstancePublicPorts operation.

Class CreateDiskFromSnapshotRequest

Container for the parameters to the CreateDiskFromSnapshot operation. Creates a block storage disk from a disk snapshot that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.

Class CreateDiskFromSnapshotResponse

This is the response object from the CreateDiskFromSnapshot operation.

Class CreateDiskRequest

Container for the parameters to the CreateDisk operation. Creates a block storage disk that can be attached to a Lightsail instance in the same Availability Zone (e.g., us-east-2a). The disk is created in the regional endpoint that you send the HTTP request to. For more information, see Regions and Availability Zones in Lightsail.

Class CreateDiskResponse

This is the response object from the CreateDisk operation.

Class CreateDiskSnapshotRequest

Container for the parameters to the CreateDiskSnapshot operation. 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.

Class CreateDiskSnapshotResponse

This is the response object from the CreateDiskSnapshot operation.

Class CreateDomainEntryRequest

Container for the parameters to the CreateDomainEntry operation. Creates one of the following entry records associated with the domain: A record, CNAME record, TXT record, or MX record.

Class CreateDomainEntryResponse

This is the response object from the CreateDomainEntry operation.

Class CreateDomainRequest

Container for the parameters to the CreateDomain operation. Creates a domain resource for the specified domain (e.g., example.com).

Class CreateDomainResponse

This is the response object from the CreateDomain operation.

Class CreateInstancesFromSnapshotRequest

Container for the parameters to the CreateInstancesFromSnapshot operation. Uses a specific snapshot as a blueprint for creating one or more new instances that are based on that identical configuration.

Class CreateInstancesFromSnapshotResponse

This is the response object from the CreateInstancesFromSnapshot operation.

Class CreateInstanceSnapshotRequest

Container for the parameters to the CreateInstanceSnapshot operation. 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.

Class CreateInstanceSnapshotResponse

This is the response object from the CreateInstanceSnapshot operation.

Class CreateInstancesRequest

Container for the parameters to the CreateInstances operation. Creates one or more Amazon Lightsail virtual private servers, or instances.

Class CreateInstancesResponse

This is the response object from the CreateInstances operation.

Class CreateKeyPairRequest

Container for the parameters to the CreateKeyPair operation. Creates sn SSH key pair.

Class CreateKeyPairResponse

This is the response object from the CreateKeyPair operation.

Class CreateLoadBalancerRequest

Container for the parameters to the CreateLoadBalancer operation. Creates a Lightsail load balancer.

When you create a load balancer, you can specify certificates and port settings. You can create up to 5 load balancers per AWS Region in your account.

Class CreateLoadBalancerResponse

This is the response object from the CreateLoadBalancer operation.

Class CreateLoadBalancerTlsCertificateRequest

Container for the parameters to the CreateLoadBalancerTlsCertificate operation. Creates a Lightsail load balancer TLS certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Class CreateLoadBalancerTlsCertificateResponse

This is the response object from the CreateLoadBalancerTlsCertificate operation.

Class DeleteDiskRequest

Container for the parameters to the DeleteDisk operation. Deletes the specified block storage disk. The disk must be in the available state (not attached to a Lightsail instance).

The disk may remain in the deleting state for several minutes.

Class DeleteDiskResponse

This is the response object from the DeleteDisk operation.

Class DeleteDiskSnapshotRequest

Container for the parameters to the DeleteDiskSnapshot operation. 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.

Class DeleteDiskSnapshotResponse

This is the response object from the DeleteDiskSnapshot operation.

Class DeleteDomainEntryRequest

Container for the parameters to the DeleteDomainEntry operation. Deletes a specific domain entry.

Class DeleteDomainEntryResponse

This is the response object from the DeleteDomainEntry operation.

Class DeleteDomainRequest

Container for the parameters to the DeleteDomain operation. Deletes the specified domain recordset and all of its domain records.

Class DeleteDomainResponse

This is the response object from the DeleteDomain operation.

Class DeleteInstanceRequest

Container for the parameters to the DeleteInstance operation. Deletes a specific Amazon Lightsail virtual private server, or instance.

Class DeleteInstanceResponse

This is the response object from the DeleteInstance operation.

Class DeleteInstanceSnapshotRequest

Container for the parameters to the DeleteInstanceSnapshot operation. Deletes a specific snapshot of a virtual private server (or instance).

Class DeleteInstanceSnapshotResponse

This is the response object from the DeleteInstanceSnapshot operation.

Class DeleteKeyPairRequest

Container for the parameters to the DeleteKeyPair operation. Deletes a specific SSH key pair.

Class DeleteKeyPairResponse

This is the response object from the DeleteKeyPair operation.

Class DeleteLoadBalancerRequest

Container for the parameters to the DeleteLoadBalancer operation. Deletes a Lightsail load balancer.

Class DeleteLoadBalancerResponse

This is the response object from the DeleteLoadBalancer operation.

Class DeleteLoadBalancerTlsCertificateRequest

Container for the parameters to the DeleteLoadBalancerTlsCertificate operation. Deletes a TLS/SSL certificate associated with a Lightsail load balancer.

Class DeleteLoadBalancerTlsCertificateResponse

This is the response object from the DeleteLoadBalancerTlsCertificate operation.

Class DetachDiskRequest

Container for the parameters to the DetachDisk operation. 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.

Class DetachDiskResponse

This is the response object from the DetachDisk operation.

Class DetachInstancesFromLoadBalancerRequest

Container for the parameters to the DetachInstancesFromLoadBalancer operation. Detaches the specified instances from a Lightsail load balancer.

Class DetachInstancesFromLoadBalancerResponse

This is the response object from the DetachInstancesFromLoadBalancer operation.

Class DetachStaticIpRequest

Container for the parameters to the DetachStaticIp operation. Detaches a static IP from the Amazon Lightsail instance to which it is attached.

Class DetachStaticIpResponse

This is the response object from the DetachStaticIp operation.

Class Disk

Describes a system disk or an block storage disk.

Class DiskMap

Describes a block storage disk mapping.

Class DiskSnapshot

Describes a block storage disk snapshot.

Class Domain

Describes a domain where you are storing recordsets in Lightsail.

Class DomainEntry

Describes a domain recordset entry.

Class DownloadDefaultKeyPairRequest

Container for the parameters to the DownloadDefaultKeyPair operation. Downloads the default SSH key pair from the user's account.

Class DownloadDefaultKeyPairResponse

This is the response object from the DownloadDefaultKeyPair operation.

Class GetActiveNamesRequest

Container for the parameters to the GetActiveNames operation. Returns the names of all active (not deleted) resources.

Class GetActiveNamesResponse

This is the response object from the GetActiveNames operation.

Class GetBlueprintsRequest

Container for the parameters to the GetBlueprints operation. Returns the list of available instance images, or blueprints. You can use a blueprint to create a new virtual private server already running a specific operating system, as well as a preinstalled app or development stack. The software each instance is running depends on the blueprint image you choose.

Class GetBlueprintsResponse

This is the response object from the GetBlueprints operation.

Class GetBundlesRequest

Container for the parameters to the GetBundles operation. Returns the list of bundles that are available for purchase. A bundle describes the specs for your virtual private server (or instance).

Class GetBundlesResponse

This is the response object from the GetBundles operation.

Class GetDiskRequest

Container for the parameters to the GetDisk operation. Returns information about a specific block storage disk.

Class GetDiskResponse

This is the response object from the GetDisk operation.

Class GetDiskSnapshotRequest

Container for the parameters to the GetDiskSnapshot operation. Returns information about a specific block storage disk snapshot.

Class GetDiskSnapshotResponse

This is the response object from the GetDiskSnapshot operation.

Class GetDiskSnapshotsRequest

Container for the parameters to the GetDiskSnapshots operation. Returns information about all block storage disk snapshots in your AWS account and region.

If you are describing a long list of disk snapshots, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Class GetDiskSnapshotsResponse

This is the response object from the GetDiskSnapshots operation.

Class GetDisksRequest

Container for the parameters to the GetDisks operation. Returns information about all block storage disks in your AWS account and region.

If you are describing a long list of disks, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Class GetDisksResponse

This is the response object from the GetDisks operation.

Class GetDomainRequest

Container for the parameters to the GetDomain operation. Returns information about a specific domain recordset.

Class GetDomainResponse

This is the response object from the GetDomain operation.

Class GetDomainsRequest

Container for the parameters to the GetDomains operation. Returns a list of all domains in the user's account.

Class GetDomainsResponse

This is the response object from the GetDomains operation.

Class GetInstanceAccessDetailsRequest

Container for the parameters to the GetInstanceAccessDetails operation. Returns temporary SSH keys you can use to connect to a specific virtual private server, or instance.

Class GetInstanceAccessDetailsResponse

This is the response object from the GetInstanceAccessDetails operation.

Class GetInstanceMetricDataRequest

Container for the parameters to the GetInstanceMetricData operation. Returns the data points for the specified Amazon Lightsail instance metric, given an instance name.

Class GetInstanceMetricDataResponse

This is the response object from the GetInstanceMetricData operation.

Class GetInstancePortStatesRequest

Container for the parameters to the GetInstancePortStates operation. Returns the port states for a specific virtual private server, or instance.

Class GetInstancePortStatesResponse

This is the response object from the GetInstancePortStates operation.

Class GetInstanceRequest

Container for the parameters to the GetInstance operation. Returns information about a specific Amazon Lightsail instance, which is a virtual private server.

Class GetInstanceResponse

This is the response object from the GetInstance operation.

Class GetInstanceSnapshotRequest

Container for the parameters to the GetInstanceSnapshot operation. Returns information about a specific instance snapshot.

Class GetInstanceSnapshotResponse

This is the response object from the GetInstanceSnapshot operation.

Class GetInstanceSnapshotsRequest

Container for the parameters to the GetInstanceSnapshots operation. Returns all instance snapshots for the user's account.

Class GetInstanceSnapshotsResponse

This is the response object from the GetInstanceSnapshots operation.

Class GetInstancesRequest

Container for the parameters to the GetInstances operation. Returns information about all Amazon Lightsail virtual private servers, or instances.

Class GetInstancesResponse

This is the response object from the GetInstances operation.

Class GetInstanceStateRequest

Container for the parameters to the GetInstanceState operation. Returns the state of a specific instance. Works on one instance at a time.

Class GetInstanceStateResponse

This is the response object from the GetInstanceState operation.

Class GetKeyPairRequest

Container for the parameters to the GetKeyPair operation. Returns information about a specific key pair.

Class GetKeyPairResponse

This is the response object from the GetKeyPair operation.

Class GetKeyPairsRequest

Container for the parameters to the GetKeyPairs operation. Returns information about all key pairs in the user's account.

Class GetKeyPairsResponse

This is the response object from the GetKeyPairs operation.

Class GetLoadBalancerMetricDataRequest

Container for the parameters to the GetLoadBalancerMetricData operation. Returns information about health metrics for your Lightsail load balancer.

Class GetLoadBalancerMetricDataResponse

This is the response object from the GetLoadBalancerMetricData operation.

Class GetLoadBalancerRequest

Container for the parameters to the GetLoadBalancer operation. Returns information about the specified Lightsail load balancer.

Class GetLoadBalancerResponse

This is the response object from the GetLoadBalancer operation.

Class GetLoadBalancersRequest

Container for the parameters to the GetLoadBalancers operation. Returns information about all load balancers in an account.

If you are describing a long list of load balancers, you can paginate the output to make the list more manageable. You can use the pageToken and nextPageToken values to retrieve the next items in the list.

Class GetLoadBalancersResponse

This is the response object from the GetLoadBalancers operation.

Class GetLoadBalancerTlsCertificatesRequest

Container for the parameters to the GetLoadBalancerTlsCertificates operation. 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).

Class GetLoadBalancerTlsCertificatesResponse

This is the response object from the GetLoadBalancerTlsCertificates operation.

Class GetOperationRequest

Container for the parameters to the GetOperation operation. 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.

Class GetOperationResponse

This is the response object from the GetOperation operation.

Class GetOperationsForResourceRequest

Container for the parameters to the GetOperationsForResource operation. Gets operations for a specific resource (e.g., an instance or a static IP).

Class GetOperationsForResourceResponse

This is the response object from the GetOperationsForResource operation.

Class GetOperationsRequest

Container for the parameters to the GetOperations operation. 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.

Class GetOperationsResponse

This is the response object from the GetOperations operation.

Class GetRegionsRequest

Container for the parameters to the GetRegions operation. 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.

Class GetRegionsResponse

This is the response object from the GetRegions operation.

Class GetStaticIpRequest

Container for the parameters to the GetStaticIp operation. Returns information about a specific static IP.

Class GetStaticIpResponse

This is the response object from the GetStaticIp operation.

Class GetStaticIpsRequest

Container for the parameters to the GetStaticIps operation. Returns information about all static IPs in the user's account.

Class GetStaticIpsResponse

This is the response object from the GetStaticIps operation.

Class ImportKeyPairRequest

Container for the parameters to the ImportKeyPair operation. Imports a public SSH key from a specific key pair.

Class ImportKeyPairResponse

This is the response object from the ImportKeyPair operation.

Class Instance

Describes an instance (a virtual private server).

Class InstanceAccessDetails

The parameters for gaining temporary access to one of your Amazon Lightsail instances.

Class InstanceHardware

Describes the hardware for the instance.

Class InstanceHealthSummary

Describes information about the health of the instance.

Class InstanceNetworking

Describes monthly data transfer rates and port information for an instance.

Class InstancePortInfo

Describes information about the instance ports.

Class InstancePortState

Describes the port state.

Class InstanceSnapshot

Describes the snapshot of the virtual private server, or instance.

Class InstanceState

Describes the virtual private server (or instance) status.

Class InvalidInputException

Lightsail exception

Class IsVpcPeeredRequest

Container for the parameters to the IsVpcPeered operation. Returns a Boolean value indicating whether your Lightsail VPC is peered.

Class IsVpcPeeredResponse

This is the response object from the IsVpcPeered operation.

Class KeyPair

Describes the SSH key pair.

Class LoadBalancer

Describes the Lightsail load balancer.

Class LoadBalancerTlsCertificate

Describes a load balancer TLS/SSL certificate.

TLS is just an updated, more secure version of Secure Socket Layer (SSL).

Class LoadBalancerTlsCertificateDomainValidationOption

Contains information about the domain names on a TLS/SSL certificate that you will use to validate domain ownership.

Class LoadBalancerTlsCertificateDomainValidationRecord

Describes the validation record of each domain name in the TLS/SSL certificate.

Class LoadBalancerTlsCertificateRenewalSummary

Contains information about the status of Lightsail's managed renewal for the certificate.

Class LoadBalancerTlsCertificateSummary

Provides a summary of TLS/SSL certificate metadata.

Class MetricDatapoint

Describes the metric data point.

Class MonthlyTransfer

Describes the monthly data transfer in and out of your virtual private server (or instance).

Class NotFoundException

Lightsail exception

Class OpenInstancePublicPortsRequest

Container for the parameters to the OpenInstancePublicPorts operation. Adds public ports to an Amazon Lightsail instance.

Class OpenInstancePublicPortsResponse

This is the response object from the OpenInstancePublicPorts operation.

Class Operation

Describes the API operation.

Class OperationFailureException

Lightsail exception

Class PasswordData

The password data for the Windows Server-based instance, including the ciphertext and the key pair name.

Class PeerVpcRequest

Container for the parameters to the PeerVpc operation. Tries to peer the Lightsail VPC with the user's default VPC.

Class PeerVpcResponse

This is the response object from the PeerVpc operation.

Class PortInfo

Describes information about the ports on your virtual private server (or instance).

Class PutInstancePublicPortsRequest

Container for the parameters to the PutInstancePublicPorts operation. Sets the specified open ports for an Amazon Lightsail instance, and closes all ports for every protocol not included in the current request.

Class PutInstancePublicPortsResponse

This is the response object from the PutInstancePublicPorts operation.

Class RebootInstanceRequest

Container for the parameters to the RebootInstance operation. Restarts a specific instance. When your Amazon Lightsail instance is finished rebooting, Lightsail assigns a new public IP address. To use the same IP address after restarting, create a static IP address and attach it to the instance.

Class RebootInstanceResponse

This is the response object from the RebootInstance operation.

Class Region

Describes the AWS Region.

Class ReleaseStaticIpRequest

Container for the parameters to the ReleaseStaticIp operation. Deletes a specific static IP from your account.

Class ReleaseStaticIpResponse

This is the response object from the ReleaseStaticIp operation.

Class ResourceLocation

Describes the resource location.

Class ServiceException

Lightsail exception

Class StartInstanceRequest

Container for the parameters to the StartInstance operation. Starts a specific Amazon Lightsail instance from a stopped state. To restart an instance, use the reboot instance operation.

Class StartInstanceResponse

This is the response object from the StartInstance operation.

Class StaticIp

Describes the static IP.

Class StopInstanceRequest

Container for the parameters to the StopInstance operation. Stops a specific Amazon Lightsail instance that is currently running.

Class StopInstanceResponse

This is the response object from the StopInstance operation.

Class UnauthenticatedException

Lightsail exception

Class UnpeerVpcRequest

Container for the parameters to the UnpeerVpc operation. Attempts to unpeer the Lightsail VPC from the user's default VPC.

Class UnpeerVpcResponse

This is the response object from the UnpeerVpc operation.

Class UpdateDomainEntryRequest

Container for the parameters to the UpdateDomainEntry operation. Updates a domain recordset after it is created.

Class UpdateDomainEntryResponse

This is the response object from the UpdateDomainEntry operation.

Class UpdateLoadBalancerAttributeRequest

Container for the parameters to the UpdateLoadBalancerAttribute operation. Updates the specified attribute for a load balancer.

Class UpdateLoadBalancerAttributeResponse

This is the response object from the UpdateLoadBalancerAttribute operation.